Merge pull request #143 from hackberrydev/task-state

Replace :done with :state in task

Author: strika

src/commands/insert_task.janet

@@ -20,7 +20,7 @@
   task-title - Task title.
   ```
   [plan date task-title]
-  (def task (task/build-task task-title false))
+  (def task (task/build-task task-title :open))
   (def day (plan/day-with-date plan date))
   (if day
     (day/add-task day task))

src/plan.janet

@@ -114,10 +114,10 @@
   (tasks-from-days (days-between plan start-date end-date)))
 
 (defn completed-tasks [plan]
-  (filter (fn [t] (t :done)) (all-tasks plan)))
+  (filter (fn [t] (= (t :state) :checked)) (all-tasks plan)))
 
 (defn pending-tasks [plan]
-  (filter (fn [t] (not (t :done))) (all-tasks plan)))
+  (filter (fn [t] (= (t :state) :open)) (all-tasks plan)))
 
 (defn has-task-after?
   ```

src/plan/parser.janet

@@ -39,7 +39,7 @@
     :tasks
       {:main (group (any :task))
        :task
-         {:main (replace (* (constant :done) :task-begin
+         {:main (replace (* (constant :state) :task-begin
                             " "
                             (constant :title) (capture (some (if-not (+ "\n" " (missed on") 1)))
                             (? :task-missed-on-date)
@@ -51,8 +51,8 @@
             {:main (* "- " :checkbox)
              :checkbox
                {:main (+ :checkbox-done :checkbox-pending)
-                :checkbox-done (* (+ "[x]" "[X]") (constant true))
-                :checkbox-pending (* "[ ]" (constant false))}}
+                :checkbox-done (* (+ "[x]" "[X]") (constant :checked))
+                :checkbox-pending (* "[ ]" (constant :open))}}
           :task-missed-on-date (* " (missed on " (constant :missed-on) :date ")")
           :task-body
             {:main (group (any :task-body-line))

src/plan/serializer.janet

@@ -8,8 +8,8 @@
 (defn- plan-title [plan]
   (string "# " (plan :title)))
 
-(defn- checkbox [done]
-  (if done "[X]" "[ ]"))
+(defn- checkbox [task]
+  (if (= (task :state) :checked) "[X]" "[ ]"))
 
 (defn- serialize-event-title [event]
   (string "- " (event :title)))
@@ -34,7 +34,7 @@
     ""))
 
 (defn- serialize-task-title [task]
-  (string "- " (checkbox (task :done)) " " (task :title) (task-mark task)))
+  (string "- " (checkbox task) " " (task :title) (task-mark task)))
 
 (defn- serialize-task-body [task]
   (def body (task :body))

src/task.janet

@@ -3,20 +3,25 @@
 
 (import ./date)
 
-(defn build-task [title done &opt body]
+(def states [:open :checked])
+
+(defn build-task [title state &opt body]
   (default body @[])
-  {:title title :body body :done done})
+  (if (index-of state states)
+    {:title title :body body :state state}
+    (error (string "task doesn't support the state '" state "'"))))
 
 (defn build-scheduled-task [line title schedule]
-  {:line line :title title :done false :schedule schedule})
+  (def task (build-task title :open))
+  (merge task {:line line :schedule schedule}))
 
 (defn build-missed-task [title date &opt body]
-  (default body @[])
-  {:title title :body body :done false :missed-on date})
+  (def task (build-task title :open body))
+  (merge task {:missed-on date}))
 
 (defn build-contact-task [title contact &opt body]
-  (default body @[])
-  {:title title :body body :done false :contact contact})
+  (def task (build-task title :open body))
+  (merge task {:contact contact}))
 
 (defn mark-as-missed
   ```

test/commands/insert_task_test.janet

@@ -25,7 +25,7 @@
 (deftest "when the task already exists"
   (def day (day/build-day (d/date 2020 8 10)
                           @[]
-                          @[(task/build-task "Upgrade OS" false)]))
+                          @[(task/build-task "Upgrade OS" :open)]))
   (def plan (plan/build-plan :days @[day]))
   (def new-plan (insert-task plan (d/date 2020 8 10) "Upgrade OS"))
   (def new-day (first (new-plan :days)))

test/commands/remove_empty_days_test.janet

@@ -16,7 +16,7 @@
               (day/build-day (d/date 2020 8 5))
               (day/build-day (d/date 2020 8 4))
               (day/build-day (d/date 2020 8 3) @[]
-                             @[(task/build-task "Buy milk" true)])]))
+                             @[(task/build-task "Buy milk" :checked)])]))
   (def new-plan (remove-empty-days plan (d/date 2020 8 6)))
   (test (length (new-plan :days)) 2)
   (test (((new-plan :days) 0) :date)

test/commands/report_test.janet

@@ -13,15 +13,15 @@
   (def plan
     (plan/build-plan
       :days @[(day/build-day (d/date 2020 8 7) @[]
-                             @[(task/build-task "Task 1" true)])
+                             @[(task/build-task "Task 1" :checked)])
               (day/build-day (d/date 2020 8 6) @[]
-                             @[(task/build-task "Task 2" true)
-                               (task/build-task "Task 3" true)])
+                             @[(task/build-task "Task 2" :checked)
+                               (task/build-task "Task 3" :checked)])
               (day/build-day (d/date 2020 8 5) @[]
-                             @[(task/build-task "Task 3" true)
-                               (task/build-task "Task 4" true)])
+                             @[(task/build-task "Task 3" :checked)
+                               (task/build-task "Task 4" :checked)])
               (day/build-day (d/date 2020 8 4) @[]
-                             @([(task/build-task "Task 5" true)]))]))
+                             @([(task/build-task "Task 5" :checked)]))]))
   (def tasks (report plan (d/date 2020 8 7) 2))
   (test (length tasks) 3)
   (test ((tasks 0) :title) "Task 2")

test/commands/schedule_contacts_test.janet

@@ -17,7 +17,7 @@
   (let [day ((plan :days) 0)
         task ((day :tasks) 0)]
     (test (task :title) "Contact John Doe")
-    (test (task :done) false)
+    (test (task :state) :open)
     (test (empty? (task :body)) true)))
 
 (deftest "schedules contacts for future"
@@ -33,7 +33,7 @@
   (if (= 1 (length (day-2 :tasks)))
     (let [task ((day-2 :tasks) 0)]
       (test (task :title) "Contact John Doe")
-      (test (task :done) false)
+      (test (task :state) :open)
       (test (empty? (task :body)) true))))
 
 (deftest "schedules contacts with birthday"
@@ -46,7 +46,7 @@
   (let [day ((plan :days) 0)
         task ((day :tasks) 0)]
     (test (task :title) "Congratulate birthday to John Doe")
-    (test (task :done) false)
+    (test (task :state) :open)
     (test (empty? (task :body)) true)))
 
 (deftest "schedules contacts with missed birthday"
@@ -70,7 +70,7 @@
   (def day-1 (day/build-day (d/date 2022 4 26)))
   (def day-2 (day/build-day (d/date 2022 4 25)
                             @[]
-                            @[(task/build-task "Weekly meeting" false)]))
+                            @[(task/build-task "Weekly meeting" :open)]))
   (def plan (plan/build-plan :days @[day-1 day-2]))
   (schedule-contacts plan @[contact] (d/date 2022 4 26))
   (test (not (empty? (day-1 :tasks))) true)
@@ -103,10 +103,10 @@
   (def day-1 (day/build-day (d/date 2022 4 27)))
   (def day-2 (day/build-day (d/date 2022 4 26)
                             @[]
-                            @[(task/build-task "Congratulate birthday to John Doe" true)]))
+                            @[(task/build-task "Congratulate birthday to John Doe" :checked)]))
   (def day-3 (day/build-day (d/date 2022 4 25)
                             @[]
-                            @[(task/build-task "Weekly meeting" false)]))
+                            @[(task/build-task "Weekly meeting" :open)]))
   (def plan (plan/build-plan :days @[day-1 day-2 day-3]))
   (schedule-contacts plan @[contact] (d/date 2022 4 27))
   (test (empty? (day-1 :tasks)) true))

test/commands/schedule_tasks_test.janet

@@ -144,7 +144,7 @@
   (def plan (plan/build-plan
               :days @[(day/build-day (d/date 2022 8 2)
                                      @[]
-                                     @[(task/build-task "Weekly meeting" true)])
+                                     @[(task/build-task "Weekly meeting" :checked)])
                       (day/build-day (d/date 2022 8 1))]))
   (test (not (missed? plan scheduled-task (d/date 2022 8 3))) true))
 
@@ -170,7 +170,7 @@
   (let [day ((plan :days) 1)
         task ((day :tasks) 0)]
     (test (task :title) "Weekly meeting")
-    (test (task :done) false)
+    (test (task :state) :open)
     (test (task :schedule) "every Monday")))
 
 (deftest "doesn't insert duplicate tasks"
@@ -194,7 +194,7 @@
       (let [task ((day :tasks) 0)]
         (test (task :title) "Weekly meeting")
         (test (d/equal? (d/date 2022 1 17) (task :missed-on)) true)
-        (test (task :done) false)
+        (test (task :state) :open)
         (test (task :schedule) "every Monday")))))
 
 (deftest "schedules missed monthly tasks"
@@ -221,7 +221,7 @@
     (if (not (empty? (day :tasks)))
       (let [task ((day :tasks) 0)]
         (test (task :title) "Weekly meeting")
-        (test (task :done) false)
+        (test (task :state) :open)
         (test (task :schedule) "every Monday")))))
 
 (deftest "doesn't schedule tasks that are not scheduled for future day that is not in the plan"