Add sub-command notes to list all notes descending by creation UTC

Author: ad-si

tasklite-core/package.yaml

@@ -103,6 +103,7 @@ tests:
       - aeson
       - hourglass
       - hspec >= 2.11 && < 3.0
+      - MissingH >= 1.4 && < 1.7
       - neat-interpolation >= 0.5 && < 0.6
       - sqlite-simple
       - tasklite-core

tasklite-core/source/Cli.hs

@@ -171,6 +171,7 @@ import Lib (
   infoTask,
   listAll,
   listNoTag,
+  listNotes,
   listOldTasks,
   listProjects,
   listReady,
@@ -314,6 +315,7 @@ data Command
   -- \| Views -- List all available views
   | Tags -- List all used tags
   | Projects -- List all active tags
+  | Notes -- List all notes
   | Stats -- List statistics about tasks
   {- Unset -}
   | -- \| Active -- Started tasks
@@ -796,6 +798,9 @@ commandParser conf =
     <> command "projects" (toParserInfo (pure Projects)
         "List all active tags (a.k.a projects) and their progress")
 
+    <> command "notes" (toParserInfo (pure Notes)
+        "List all notes descending by creation UTC")
+
     <> command "stats" (toParserInfo (pure Stats)
         "Show statistics about tasks")
 
@@ -1173,6 +1178,7 @@ executeCLiCommand conf now connection progName args = do
         RunFilter expressions -> runFilter conf now connection expressions
         Tags -> listTags conf connection
         Projects -> listProjects conf connection
+        Notes -> listNotes conf connection
         Stats -> getStats conf connection
         ImportFile filePath -> importFile conf connection filePath
         ImportJson -> importJson conf connection

tasklite-core/source/Lib.hs

@@ -2915,6 +2915,51 @@ listProjects conf connection = do
   pure $ formatTags conf tags
 
 
+listNotes :: Config -> Connection -> IO (Doc AnsiStyle)
+listNotes conf connection = do
+  (notes :: [TaskToNote]) <-
+    query_
+      connection
+      [sql|
+        SELECT ulid, task_ulid, note
+        FROM task_to_note
+        ORDER BY ulid DESC
+      |]
+
+  let
+    taskIdWidth = 7 -- TODO: Use dynamic width
+    noteWidth = getIdLength $ fromIntegral $ P.length notes
+    docHeader =
+      annotate
+        (idStyle conf <> bold <> underlined)
+        (fill taskIdWidth "Task ID")
+        <++> annotate
+          (idStyle conf <> bold <> underlined)
+          (fill noteWidth "ID")
+        <++> annotate (dateStyle conf <> bold <> underlined) "Created UTC"
+        <++> annotate (bold <> underlined) "Note"
+        <++> line
+
+    showNote note =
+      annotate
+        (idStyle conf)
+        (fill 7 $ pretty $ T.takeEnd taskIdWidth note.task_ulid)
+        <++> annotate
+          (idStyle conf)
+          (fill noteWidth $ pretty $ T.takeEnd noteWidth note.ulid)
+        <++> annotate
+          (dateStyle conf)
+          ( note.ulid
+              & ulidTextToDateTime
+              <&> timePrint ISO8601_Date
+              & pretty
+          )
+        <++> pretty note.note
+        <> line
+
+  pure $ docHeader <> vsep (notes <&> showNote)
+
+
 getStats :: Config -> Connection -> IO (Doc AnsiStyle)
 getStats _ connection = do
   [NumRows numOfTasksTotal] <-

tasklite-core/tasklite-core.cabal

@@ -137,7 +137,8 @@ test-suite tasklite-test
       UndecidableInstances
   ghc-options: -Wall -Wcompat -Wincomplete-record-updates -Wincomplete-uni-patterns -Wno-orphans -Wredundant-constraints -Wunused-packages
   build-depends:
-      aeson
+      MissingH >=1.4 && <1.7
+    , aeson
     , base >=4.18 && <5
     , hourglass
     , hspec >=2.11 && <3.0

tasklite-core/test/LibSpec.hs

@@ -1,16 +1,21 @@
 module LibSpec where
 
 import Protolude (
+  Bool (True),
   Maybe (..),
   Text,
   pure,
   show,
   ($),
+  (&),
+  (<),
   (<>),
  )
 import Protolude qualified as P
 
-import Config (defaultConfig)
+import Data.Hourglass (DateTime)
+import Data.List.Utils (subIndex)
+import Data.Text qualified as T
 import Test.Hspec (
   Spec,
   describe,
@@ -21,8 +26,7 @@ import Test.Hspec (
   shouldNotContain,
  )
 
-import Data.Hourglass (DateTime)
-import Data.Text qualified as T
+import Config (defaultConfig)
 import ImportExport (PreEdit (ApplyPreEdit), editTaskByTask)
 import Lib (
   addTag,
@@ -31,27 +35,28 @@ import Lib (
   infoTask,
   insertRecord,
   insertTags,
+  listNotes,
   newTasks,
  )
 import Task (Task (body, closed_utc, state, ulid), TaskState (Done), zeroTask)
-import TaskToNote (TaskToNote (TaskToNote))
+import TaskToNote (TaskToNote (TaskToNote, ulid))
 import TaskToNote qualified
 import TestUtils (withMemoryDb)
 
 
 task1 :: Task
 task1 =
   zeroTask
-    { ulid = "01hs68z7mdg4ktpxbv0yfafznq"
-    , body = "New task 1"
+    { Task.ulid = "01hs68z7mdg4ktpxbv0yfafznq"
+    , Task.body = "New task 1"
     }
 
 
 taskMultiLine :: Task
 taskMultiLine =
   zeroTask
-    { ulid = "01hx48cnjhp18mts3c44zk3gen"
-    , body =
+    { Task.ulid = "01hx48cnjhp18mts3c44zk3gen"
+    , Task.body =
         "New task\n\
         \with several lines\n\
         \and line breaks"
@@ -66,8 +71,8 @@ spec now = do
         let
           task2 =
             zeroTask
-              { ulid = "01hs690f9hkzk9z7zews9j2k1d"
-              , body = "New task 2"
+              { Task.ulid = "01hs690f9hkzk9z7zews9j2k1d"
+              , Task.body = "New task 2"
               }
 
         count0 <- countTasks defaultConfig memConn P.mempty
@@ -93,10 +98,10 @@ spec now = do
         let
           task2 =
             zeroTask
-              { ulid = "01hs6zsf3c0vqx6egfnmbqtmvy"
-              , body = "New task 2"
-              , closed_utc = Just "2024-04-10T18:54:10Z"
-              , state = Just Done
+              { Task.ulid = "01hs6zsf3c0vqx6egfnmbqtmvy"
+              , Task.body = "New task 2"
+              , Task.closed_utc = Just "2024-04-10T18:54:10Z"
+              , Task.state = Just Done
               }
 
         insertRecord "tasks" memConn task1
@@ -141,6 +146,40 @@ spec now = do
                           \with several lines\n\
                           \and line breaks"
 
+    it "lists all notes descending by creation UTC" $ do
+      withMemoryDb defaultConfig $ \memConn -> do
+        insertRecord "tasks" memConn task1
+        let
+          taskToNote1 =
+            TaskToNote
+              { TaskToNote.ulid = "01hx4eyxxvs5b75ynxrztcz87f"
+              , TaskToNote.task_ulid = task1.ulid
+              , TaskToNote.note = "The first note"
+              }
+          note1Id = taskToNote1.ulid & T.takeEnd 3 & T.unpack
+          taskToNote2 =
+            TaskToNote
+              { TaskToNote.ulid = "01hx4f3f764sma7n8bahvwjeed"
+              , TaskToNote.task_ulid = task1.ulid
+              , TaskToNote.note = "The second note"
+              }
+          note2Id = taskToNote2.ulid & T.takeEnd 3 & T.unpack
+
+        insertRecord "task_to_note" memConn taskToNote1
+        insertRecord "task_to_note" memConn taskToNote2
+
+        cliOutput <- listNotes defaultConfig memConn
+
+        show cliOutput `shouldContain` note1Id
+        show cliOutput `shouldContain` note2Id
+
+        let
+          posUlid1 = subIndex note1Id (show cliOutput)
+          posUlid2 = subIndex note2Id (show cliOutput)
+
+        --  Newer notes should be listed first
+        (posUlid2 < posUlid1) `shouldBe` True
+
     it "lets you delete a note" $ do
       withMemoryDb defaultConfig $ \memConn -> do
         insertRecord "tasks" memConn task1