Merge pull request #115 from hackberrydev/refactor-parsers

Refactor parsers

Author: strika

src/contact/parser.janet

@@ -12,10 +12,11 @@
                       (? (* (constant :last-contact) :last-contact)))
                    ,contact/build-contact)
     :name (* "# " (? (some :d)) (replace (capture (some (if-not "\n" 1))) ,string/trim) "\n")
-    :detail (+ :category :birthday :other-detail)
-    :category (* "- Category: " (constant :category) (capture (+ "A" "a" "B" "b" "C" "c" "D" "d")) "\n")
-    :birthday (* "- Birthday: " (constant :birthday) (capture (* :d :d "-" :d :d)) "\n")
-    :other-detail (* "- " (some (if-not ":" 1)) ": " (some (if-not "\n" 1)) "\n")
+    :detail
+      {:main (+ :category :birthday :other-detail)
+       :category (* "- Category: " (constant :category) (capture (+ "A" "a" "B" "b" "C" "c" "D" "d")) "\n")
+       :birthday (* "- Birthday: " (constant :birthday) (capture (* :d :d "-" :d :d)) "\n")
+       :other-detail (* "- " (some (if-not ":" 1)) ": " (some (if-not "\n" 1)) "\n")}
     :last-contact (* "## " (replace :date ,d/parse))
     :date (capture (* :d :d :d :d "-" :d :d "-" :d :d))})
 

src/plan/parser.janet

@@ -15,32 +15,42 @@
                    ,plan/build-plan)
     :title (* "# " :text-line "\n")
     :text-line (capture (some (if-not "\n" 1)))
-    :inbox (* :inbox-title (? "\n") :tasks (? "\n"))
-    :inbox-title (* "## Inbox" (? "\n"))
-    :days (group (any :day))
-    :day (replace (* :day-title (? "\n") :events :tasks (? "\n")) ,day/build-day)
-    :day-title (* "## " :date ", " :week-day (? "\n"))
-    :date (replace (capture (* :d :d :d :d "-" :d :d "-" :d :d)) ,d/parse)
-    :week-day (+ "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday")
-    :events (group (any :event))
-    :event (replace (* :event-begin :text-line (? "\n")) ,event/build-event)
-    :event-begin (* "- " (if-not "[" 0))
-    :tasks (group (any :task))
-    :task (replace (* (constant :done) :task-begin
-                      " "
-                      (constant :title) (capture (some (if-not (+ "\n" " (missed on") 1)))
-                      (? :task-missed-on-date)
-                      (? "\n")
-                      (constant :body) :task-body
-                      (? "\n"))
-                   ,struct)
-    :task-begin (* "- " :checkbox)
-    :checkbox (+ :checkbox-done :checkbox-pending)
-    :checkbox-done (* (+ "[x]" "[X]") (constant true))
-    :checkbox-pending (* "[ ]" (constant false))
-    :task-body (group (any :task-body-line))
-    :task-body-line (* "  " :text-line (? "\n"))
-    :task-missed-on-date (* " (missed on " (constant :missed-on) :date ")")})
+    :inbox
+      {:main (* :inbox-title (? "\n") :tasks (? "\n"))
+       :inbox-title (* "## Inbox" (? "\n"))}
+    :days
+      {:main (group (any :day))
+       :day
+         {:main (replace (* :day-title (? "\n") :events :tasks (? "\n")) ,day/build-day)
+          :day-title (* "## " :date ", " :week-day (? "\n"))
+          :week-day (+ "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday")
+          :events
+            {:main (group (any :event))
+             :event
+               {:main (replace (* :event-begin :text-line (? "\n")) ,event/build-event)
+                :event-begin (* "- " (if-not "[" 0))}}}}
+    :tasks
+      {:main (group (any :task))
+       :task
+         {:main (replace (* (constant :done) :task-begin
+                            " "
+                            (constant :title) (capture (some (if-not (+ "\n" " (missed on") 1)))
+                            (? :task-missed-on-date)
+                            (? "\n")
+                            (constant :body) :task-body
+                            (? "\n"))
+                         ,struct)
+          :task-begin
+            {:main (* "- " :checkbox)
+             :checkbox
+               {:main (+ :checkbox-done :checkbox-pending)
+                :checkbox-done (* (+ "[x]" "[X]") (constant true))
+                :checkbox-pending (* "[ ]" (constant false))}}
+          :task-missed-on-date (* " (missed on " (constant :missed-on) :date ")")
+          :task-body
+            {:main (group (any :task-body-line))
+             :task-body-line (* "  " :text-line (? "\n"))}}}
+    :date (replace (capture (* :d :d :d :d "-" :d :d "-" :d :d)) ,d/parse)})
 
 (defn- lines-count [plan-string &opt options]
   (default options {:ignore-whitespace true})

src/schedule_parser.janet

@@ -7,10 +7,13 @@
 (def schedule-grammar
   ~{:main (* (drop :title) :tasks)
     :title (* "# " (some (+ :w+ :s+)))
-    :tasks (group (any :task))
-    :task (replace (* "- " :task-title :task-schedule (? "\n")) ,task/build-scheduled-task)
-    :task-title (replace (capture (some (if-not (+ "(" "\n") 1))) ,string/trim)
-    :task-schedule (* "(" (replace (capture (some (+ :w+ :s+ "-"))) ,string/trim) ")")})
+    :tasks
+      {:main (group (any :task))
+       :task
+         {:main (replace (* "- " (line) :task-title :task-schedule (? "\n"))
+                         ,task/build-scheduled-task)
+          :task-title (replace (capture (some (if-not (+ "(" "\n") 1))) ,string/trim)
+          :task-schedule (* "(" (replace (capture (some (+ :w+ :s+ "-"))) ,string/trim) ")")}}})
 
 (defn- task-lines-count
   ```
@@ -41,5 +44,7 @@
               {:tasks tasks}
               {:errors [(string "Schedule can not be parsed - last parsed task is \""
                                 ((last tasks) :title)
-                                "\"")]}))))
+                                "\""
+                                " on line "
+                                ((last tasks) :line))]}))))
       {:errors ["Schedule can not be parsed"]})))

src/task.janet

@@ -7,9 +7,8 @@
   (default body @[])
   {:title title :body body :done done})
 
-(defn build-scheduled-task [title schedule &opt body]
-  (default body @[])
-  {:title title :body body :done false :schedule schedule})
+(defn build-scheduled-task [line title schedule]
+  {:line line :title title :done false :schedule schedule})
 
 (defn build-missed-task [title date &opt body]
   (default body @[])

test/commands/schedule_tasks_test.janet

@@ -10,24 +10,24 @@
 ## Test scheduled-for?
 
 (deftest "every Monday"
-  (def task (task/build-scheduled-task "Weekly meeting" "every Monday"))
+  (def task (task/build-scheduled-task 42 "Weekly meeting" "every Monday"))
   (test (scheduled-for? task (d/date 2022 1 24)) true)
   (test (not (scheduled-for? task (d/date 2022 1 25))) true))
 
 (deftest "every Tuesday"
-  (def task (task/build-scheduled-task "Weekly meeting" "every Tuesday"))
+  (def task (task/build-scheduled-task 42 "Weekly meeting" "every Tuesday"))
   (test (not (scheduled-for? task (d/date 2022 1 24))) true)
   (test (scheduled-for? task (d/date 2022 1 25)) true))
 
 (deftest "every month"
-  (def task (task/build-scheduled-task "Review logs" "every month"))
+  (def task (task/build-scheduled-task 42 "Review logs" "every month"))
   (test (scheduled-for? task (d/date 2022 1 1)) true)
   (test (not (scheduled-for? task (d/date 2022 1 2))) true)
   (test (scheduled-for? task (d/date 2022 6 1)) true)
   (test (not (scheduled-for? task (d/date 2022 6 15))) true))
 
 (deftest "every 3 months"
-  (def task (task/build-scheduled-task "Review logs" "every 3 months"))
+  (def task (task/build-scheduled-task 42 "Review logs" "every 3 months"))
   (test (scheduled-for? task (d/date 2022 1 1)) true)
   (test (not (scheduled-for? task (d/date 2022 2 1))) true)
   (test (not (scheduled-for? task (d/date 2022 3 1))) true)
@@ -40,7 +40,7 @@
   (test (scheduled-for? task (d/date 2022 10 1)) true))
 
 (deftest "every weekday"
-  (def task (task/build-scheduled-task "Review logs" "every weekday"))
+  (def task (task/build-scheduled-task 42 "Review logs" "every weekday"))
   (test (scheduled-for? task (d/date 2022 1 24)) true)        # Monday
   (test (scheduled-for? task (d/date 2022 1 25)) true)        # Tuesday
   (test (scheduled-for? task (d/date 2022 1 26)) true)        # Wednesday
@@ -50,7 +50,7 @@
   (test (not (scheduled-for? task (d/date 2022 1 30))) true)) # Sunday
 
 (deftest "every year on some date"
-  (def task (task/build-scheduled-task "Review logs" "every year on 01-27"))
+  (def task (task/build-scheduled-task 42 "Review logs" "every year on 01-27"))
   (test (scheduled-for? task (d/date 2022 1 27)) true)
   (test (scheduled-for? task (d/date 2023 1 27)) true)
   (test (scheduled-for? task (d/date 2024 1 27)) true)
@@ -59,15 +59,15 @@
   (test (not (scheduled-for? task (d/date 2022 2 1))) true))
 
 (deftest "on some date"
-  (def task (task/build-scheduled-task "Review logs" "on 2022-01-27"))
+  (def task (task/build-scheduled-task 42 "Review logs" "on 2022-01-27"))
   (test (scheduled-for? task (d/date 2022 1 27)) true)
   (test (not (scheduled-for? task (d/date 2022 1 26))) true)
   (test (not (scheduled-for? task (d/date 2022 1 28))) true)
   (test (not (scheduled-for? task (d/date 2022 2 1))) true)
   (test (not (scheduled-for? task (d/date 2023 1 27))) true))
 
 (deftest "every last day"
-  (def task (task/build-scheduled-task "Review logs" "every last day"))
+  (def task (task/build-scheduled-task 42 "Review logs" "every last day"))
   (test (scheduled-for? task (d/date 2022 1 31)) true)
   (test (scheduled-for? task (d/date 2022 2 28)) true)
   (test (scheduled-for? task (d/date 2022 3 31)) true)
@@ -84,7 +84,7 @@
   (test (not (scheduled-for? task (d/date 2022 1 30))) true))
 
 (deftest "every last Friday"
-  (def task (task/build-scheduled-task "Review logs" "every last Friday"))
+  (def task (task/build-scheduled-task 42 "Review logs" "every last Friday"))
   (test (scheduled-for? task (d/date 2022 1 28)) true)
   (test (scheduled-for? task (d/date 2022 2 25)) true)
   (test (scheduled-for? task (d/date 2022 3 25)) true)
@@ -95,7 +95,7 @@
 ## —————————————————————————————————————————————————————————————————————————————————————————————————
 ## Test missed?
 
-(def scheduled-task (task/build-scheduled-task "Weekly meeting" "on 2022-08-01"))
+(def scheduled-task (task/build-scheduled-task 42 "Weekly meeting" "on 2022-08-01"))
 
 (deftest "returns true when the task is missed"
   (def plan (plan/build-plan
@@ -127,8 +127,8 @@
 ## Test schedule-tasks
 
 (def scheduled-tasks
-  @[(task/build-scheduled-task "Weekly meeting" "every Monday")
-    (task/build-scheduled-task "Check logs" "every Wednesday")])
+  @[(task/build-scheduled-task 42 "Weekly meeting" "every Monday")
+    (task/build-scheduled-task 42 "Check logs" "every Wednesday")])
 
 (deftest "schedules tasks scheduled on specific weekdays"
   (def plan (plan/build-plan
@@ -168,7 +168,7 @@
 
 (deftest "schedules missed monthly tasks"
   (def scheduled-tasks
-    @[(task/build-scheduled-task "Review logs" "every month")])
+    @[(task/build-scheduled-task 42 "Review logs" "every month")])
   (def day-1 (day/build-day (d/date 2022 7 5)))
   (def day-2 (day/build-day (d/date 2022 6 15)))
   (def plan (plan/build-plan :days @[day-1 day-2]))

test/schedule_parser_test.janet

@@ -57,7 +57,7 @@
     ```)
   (def result (schedule_parser/parse schedule-string))
   (test (first (result :errors))
-        "Schedule can not be parsed - last parsed task is \"Weekly Meeting\""))
+        "Schedule can not be parsed - last parsed task is \"Weekly Meeting\" on line 3"))
 
 
 (deftest "returns an error when the schedule is empty"