Merge pull request #138 from hackberrydev/every-last-weekday

Command for scheduling task on every last week day

Author: strika

src/commands/schedule_tasks.janet

@@ -30,6 +30,7 @@
         (string "every year on " (remove-year formatted-date)) true
         (string "on " formatted-date) true
         "every last day" (date/last-day-of-month? date)
+        "every last weekday" (date/last-weekday-of-month? date)
         "every last Friday" (date/last-friday-of-month? date)))
 
 (defn- missed-on-day [plan task date]

src/date.janet

@@ -123,6 +123,14 @@
  [d1 d2]
  (>= (to-time d1) (to-time d2)))
 
+(defn weekday?
+  ```
+  Returns true if the date is a week day (Monday-Friday).
+  ```
+  [date]
+  (has-value? ["Monday" "Tuesday" "Wednesday" "Thursday" "Friday"]
+              (date :week-day)))
+
 (defn last-day-of-month?
   ```
   Returns true if the date is the last day of a month.
@@ -139,3 +147,11 @@
   (def next-week (+days date 7))
   (and (= (date :week-day) "Friday")
        (not= (date :month) (next-week :month))))
+
+(defn last-weekday-of-month?
+  ```
+  Return true if the date is the last week day of a month.
+  ```
+  [date]
+  (or (and (weekday? date) (last-day-of-month? date))
+      (last-friday-of-month? date)))

test/commands/schedule_tasks_test.janet

@@ -83,6 +83,22 @@
   (test (scheduled-for? task (d/date 2023 1 31)) true)
   (test (not (scheduled-for? task (d/date 2022 1 30))) true))
 
+(deftest "every last weekday"
+  (def task (task/build-scheduled-task 42 "Review logs" "every last weekday"))
+  (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)
+  (test (scheduled-for? task (d/date 2022 4 29)) true)
+  (test (scheduled-for? task (d/date 2022 5 31)) true)
+  (test (scheduled-for? task (d/date 2022 6 30)) true)
+  (test (scheduled-for? task (d/date 2022 7 29)) true)
+  (test (scheduled-for? task (d/date 2022 8 31)) true)
+  (test (scheduled-for? task (d/date 2022 9 30)) true)
+  (test (scheduled-for? task (d/date 2022 10 31)) true)
+  (test (scheduled-for? task (d/date 2022 11 30)) true)
+  (test (scheduled-for? task (d/date 2022 12 30)) true)
+  (test (not (scheduled-for? task (d/date 2022 1 30))) true))
+
 (deftest "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/date_test.janet

@@ -68,6 +68,18 @@
   (test (d/after-or-eq? (d/date 2021 7 1) (d/date 2021 7 1)) true)
   (test (not (d/after-or-eq? (d/date 2021 7 1) (d/date 2021 7 15))) true))
 
+## —————————————————————————————————————————————————————————————————————————————————————————————————
+## Test weekday?
+
+(deftest "returns true if the date is a weekday"
+  (test (d/weekday? (d/date 2022 1 3)) true)
+  (test (d/weekday? (d/date 2022 1 4)) true)
+  (test (d/weekday? (d/date 2022 1 5)) true)
+  (test (d/weekday? (d/date 2022 1 6)) true)
+  (test (d/weekday? (d/date 2022 1 7)) true)
+  (test (d/weekday? (d/date 2022 1 8)) false)
+  (test (d/weekday? (d/date 2022 1 9)) false))
+
 ## —————————————————————————————————————————————————————————————————————————————————————————————————
 ## Test last-day-of-month?
 
@@ -88,7 +100,25 @@
   (test (not (d/last-day-of-month? (d/date 2022 1 30))) true))
 
 ## —————————————————————————————————————————————————————————————————————————————————————————————————
-## Test last-Friday-of-month?
+## Test last-weekday-of-month?
+
+(deftest "returns true when the date is the last week day of the month"
+  (test (d/last-weekday-of-month? (d/date 2022 1 31)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 2 28)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 3 31)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 4 29)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 5 31)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 6 30)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 7 29)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 8 31)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 9 30)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 10 31)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 11 30)) true)
+  (test (d/last-weekday-of-month? (d/date 2022 12 30)) true)
+  (test (not (d/last-weekday-of-month? (d/date 2022 1 30))) true))
+
+## —————————————————————————————————————————————————————————————————————————————————————————————————
+## Test last-friday-of-month?
 
 (deftest "returns true when the date is the last friday of the month"
   (test (d/last-friday-of-month? (d/date 2022 1 28)) true)

test/schedule_parser_test.janet

@@ -18,10 +18,11 @@
     - Martha's birthday (every 05-24)
     - Meeting with Jack (on 2022-05-03)
     - Review logs (every last day)
+    - Send invoice (every last weekday)
     ```)
   (def result (schedule_parser/parse schedule-string))
   (def scheduled-tasks (result :tasks))
-  (test (length scheduled-tasks) 7)
+  (test (length scheduled-tasks) 8)
   (let [task (scheduled-tasks 0)]
     (test (task :title) "Weekly Meeting")
     (test (task :done) false)
@@ -34,7 +35,10 @@
     (test (task :schedule) "on 2022-05-03"))
   (let [task (scheduled-tasks 6)]
     (test (task :title) "Review logs")
-    (test (task :schedule) "every last day")))
+    (test (task :schedule) "every last day"))
+  (let [task (scheduled-tasks 7)]
+    (test (task :title) "Send invoice")
+    (test (task :schedule) "every last weekday")))
 
 (deftest "returns an error when the schedule can't be parsed"
   (def schedule-string