Update for Nim 2.x. No longer building pit_api.

`pit_api` cannot be built for Nim 2.x without a non-trivial refactor due
to the enforcement of gc-safety. See the `pit_api.nim` source for
details.

.tool-versions

@@ -0,0 +1 @@
+nim 2.2.0

nimble.lock

@@ -1,174 +0,0 @@
-{
-  "version": 2,
-  "packages": {
-    "asynctools": {
-      "version": "0.1.1",
-      "vcsRevision": "0e6bdc3ed5bae8c7cc9e03cfbf66b7c882a908a7",
-      "url": "https://github.com/cheatfate/asynctools",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "54314dceabb06b20908ecb0f2c007e9ff3aaa054"
-      }
-    },
-    "isaac": {
-      "version": "0.1.3",
-      "vcsRevision": "45a5cbbd54ff59ba3ed94242620c818b9aad1b5b",
-      "url": "https://github.com/pragmagic/isaac/",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "05c3583a954715d84b0bf1be97f9a503249e9cdf"
-      }
-    },
-    "uuids": {
-      "version": "0.1.11",
-      "vcsRevision": "8cb8720b567c6bcb261bd1c0f7491bdb5209ad06",
-      "url": "https://github.com/pragmagic/uuids/",
-      "downloadMethod": "git",
-      "dependencies": [
-        "isaac"
-      ],
-      "checksums": {
-        "sha1": "393f5fcefbc8ad3cf167e59760144208ff8f9f76"
-      }
-    },
-    "unicodedb": {
-      "version": "0.11.2",
-      "vcsRevision": "c70f8bc8c7373265670e0575bc5eda36fe3761b0",
-      "url": "https://github.com/nitely/nim-unicodedb",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "612c5955f91bd90a263ce914d1d5de74a33af3c6"
-      }
-    },
-    "regex": {
-      "version": "0.20.1",
-      "vcsRevision": "66f144f935cc73977c61185fab15a3147bf117ff",
-      "url": "https://github.com/nitely/nim-regex",
-      "downloadMethod": "git",
-      "dependencies": [
-        "unicodedb"
-      ],
-      "checksums": {
-        "sha1": "ea9b6600443e73b1ea89a477c7a5d1fce742c9da"
-      }
-    },
-    "docopt": {
-      "version": "0.7.0",
-      "vcsRevision": "17803d1205f9e752cce03a66b0a29b710520398e",
-      "url": "https://github.com/docopt/docopt.nim",
-      "downloadMethod": "git",
-      "dependencies": [
-        "regex"
-      ],
-      "checksums": {
-        "sha1": "21150284640b882fa91147181c52da3e5bb44df8"
-      }
-    },
-    "filetype": {
-      "version": "0.9.0",
-      "vcsRevision": "1fe1e7d988cd802abc26505efb5a91891bd6f53e",
-      "url": "https://github.com/jiro4989/filetype",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "d2242b94eeb0f6d3810a8c71af4664f28853e1be"
-      }
-    },
-    "zero_functional": {
-      "version": "1.3.0",
-      "vcsRevision": "edf3b7f59119f75706da435c2b7f080a0cf4960c",
-      "url": "https://github.com/zero-functional/zero-functional",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "2dc01ca0925ac1c2dcb46a0c6d9c93c57a9cddec"
-      }
-    },
-    "update_nim_package_version": {
-      "version": "0.2.0",
-      "vcsRevision": "5a78579fd7f88014263aed38c60327c85f6f8bcf",
-      "url": "https://git.jdb-software.com/jdb/update-nim-package-version",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "37052b7ce30d5493ef24253a82a6087350b4eabb"
-      }
-    },
-    "data_uri": {
-      "version": "1.0.2",
-      "vcsRevision": "f43ac66e44c37edd3cc7282d75d6fa2fa031b2ec",
-      "url": "",
-      "downloadMethod": "git",
-      "dependencies": [
-        "docopt",
-        "filetype",
-        "zero_functional",
-        "update_nim_package_version"
-      ],
-      "checksums": {
-        "sha1": "949c11ffab4e85ff538b0bd3e5bb193f118b56d7"
-      }
-    },
-    "timeutils": {
-      "version": "0.5.4",
-      "vcsRevision": "a9308cbaf3c89496b5832ddd18404dc0debe66a2",
-      "url": "https://git.jdb-software.com/jdb/nim-time-utils.git",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "9ecd1020f5644bc59acb2f44ca9d30f4c7f066d3"
-      }
-    },
-    "cliutils": {
-      "version": "0.8.0",
-      "vcsRevision": "b1cc4fbe51d5e617789363efe716793ebe5bc5f1",
-      "url": "https://git.jdb-software.com/jdb/nim-cli-utils",
-      "downloadMethod": "git",
-      "dependencies": [
-        "docopt"
-      ],
-      "checksums": {
-        "sha1": "5b114094c314007fa6f15e62852d62a58a3cbb62"
-      }
-    },
-    "langutils": {
-      "version": "0.4.0",
-      "vcsRevision": "8122660da3fc78132b823e76c9e990fd92802b0e",
-      "url": "https://git.jdb-software.com/jdb/nim-lang-utils.git",
-      "downloadMethod": "git",
-      "dependencies": [],
-      "checksums": {
-        "sha1": "2da09deb0e0bfc186000f0d941d06dd974bf6e58"
-      }
-    },
-    "httpbeast": {
-      "version": "0.4.1",
-      "vcsRevision": "abc13d11c210b614960fe8760e581d44cfb2e3e9",
-      "url": "https://github.com/dom96/httpbeast",
-      "downloadMethod": "git",
-      "dependencies": [
-        "asynctools"
-      ],
-      "checksums": {
-        "sha1": "b23e57a401057dcb9b7fae1fb8279a6a2ce1d0b8"
-      }
-    },
-    "jester": {
-      "version": "0.5.0",
-      "vcsRevision": "a21b36a02b7745d6cdcda32d4ab3fba328cda17a",
-      "url": "https://github.com/dom96/jester/",
-      "downloadMethod": "git",
-      "dependencies": [
-        "httpbeast",
-        "asynctools"
-      ],
-      "checksums": {
-        "sha1": "a192ca25bfc05d5de5c9a5fafca3b0cee47d82d2"
-      }
-    }
-  },
-  "tasks": {}
-}

pit.nimble

@@ -1,30 +1,30 @@
 # Package
 
-version       = "4.23.0"
+version       = "4.26.0"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"
 srcDir        = "src"
 installExt    = @["nim"]
-bin           = @["pit", "pit_api"]
+bin           = @["pit"]
 
 # Dependencies
 
 requires @[
   "nim >= 1.4.0",
-  "docopt >= 0.6.8",
+  "docopt >= 0.7.1",
-  "jester >= 0.5.0",
+  "jester >= 0.6.0",
   "uuids >= 0.1.10",
   "zero_functional"
 ]
 
-# Dependencies from git.jdb-software.com/nim-jdb/packages
+# Dependencies from git.jdb-software.com/jdb/nim-packages
 requires @[
-  "cliutils >= 0.6.4",
+  "cliutils >= 0.9.1",
   "langutils >= 0.4.0",
   "timeutils >= 0.5.4",
   "data_uri > 1.0.0",
-  "https://git.jdb-software.com/jdb/update-nim-package-version >= 0.2.0"
+  "update_nim_package_version >= 0.2.0"
 ]
 
 task updateVersion, "Update the version of this package.":

src/pit.nim

@@ -51,7 +51,7 @@ proc getIssueContextDisplayName(ctx: CliContext, context: string): string =
     else: return context.capitalize()
   return ctx.contexts[context]
 
-proc formatIssue(ctx: CliContext, issue: Issue): string =
+proc formatIssue*(issue: Issue): string =
   result = ($issue.id).withColor(fgBlack, true) & "\n"&
            issue.summary.withColor(fgWhite) & "\n"
 
@@ -70,10 +70,27 @@ proc formatIssue(ctx: CliContext, issue: Issue): string =
 
   result &= termReset
 
-proc formatSectionIssue(
+proc formatPlainIssueSummary*(issue: Issue): string =
-    ctx: CliContext,
+
+  result = "$#: $# $#" % [
+    $issue.state,
+    ($issue.id)[0..<6],
+    issue.summary ]
+
+  if issue.hasProp("delegated-to") or issue.hasProp("pending"):
+    var parts = newSeq[string]()
+
+    if issue.hasProp("delegated-to"):
+      parts.add("delegated to " & issue["delegated-to"])
+
+    if issue.hasProp("pending"):
+      parts.add("pendin: " & issue["pending"])
+
+    result &= "($#)" % [ parts.join("; ") ]
+
+proc formatSectionIssue*(
     issue: Issue,
-    width: int,
+    width: int = 80,
     indent = "",
     verbose = false): string =
 
@@ -135,12 +152,15 @@ proc formatSectionIssue(
 
   result &= termReset
 
-proc formatSectionIssueList(ctx: CliContext, issues: seq[Issue], width: int,
+proc formatSectionIssueList*(
-        indent: string, verbose: bool): string =
+    issues: seq[Issue],
+    width: int = 80,
+    indent: string = "",
+    verbose: bool = false): string =
 
   result = ""
   for i in issues:
-    var issueText = ctx.formatSectionIssue(i, width, indent, verbose)
+    var issueText = formatSectionIssue(i, width, indent, verbose)
     result &= issueText & "\n"
 
 proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
@@ -161,10 +181,10 @@ proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
         indent & ctx.getIssueContextDisplayName(context) & ":" &
         termReset & "\n\n"
 
-      result &= ctx.formatSectionIssueList(ctxIssues, innerWidth - 2, indent & "  ", verbose)
+      result &= formatSectionIssueList(ctxIssues, innerWidth - 2, indent & "  ", verbose)
       result &= "\n"
 
-  else: result &= ctx.formatSectionIssueList(issues, innerWidth, indent, verbose)
+  else: result &= formatSectionIssueList(issues, innerWidth, indent, verbose)
 
 proc loadIssues(ctx: CliContext, state: IssueState) =
   ctx.issues[state] = loadIssues(ctx.cfg.tasksDir, state)
@@ -224,7 +244,7 @@ proc edit(issue: Issue) =
     # Try to parse the newly-edited issue to make sure it was successful.
     let editedIssue = loadIssue(issue.filepath)
     editedIssue.store()
-  except:
+  except CatchableError:
     fatal "updated issue is invalid (ignoring edits): \n\t" &
       getCurrentExceptionMsg()
     issue.store()
@@ -249,7 +269,15 @@ proc list(
           it.hasProp("completed") and
           sameDay(getTime().local, it.getDateTime("completed")))
 
-      stdout.write ctx.formatSection(ctx.issues[state], state, "", verbose)
+      if isatty(stdout):
+        stdout.write ctx.formatSection(ctx.issues[state], state, "", verbose)
+
+      else:
+        stdout.writeLine ctx.issues[state]
+          .mapIt(formatPlainIssueSummary(it))
+          .join("\n")
+
+
     trace "listing complete"
     return
 
@@ -277,7 +305,13 @@ proc list(
           not (it.hasProp("hide-until") and
                it.getDateTime("hide-until") > getTime().local))
 
-        stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+        if isatty(stdout):
+          stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+
+        else:
+          stdout.writeLine visibleIssues
+            .mapIt(formatPlainIssueSummary(it))
+            .join("\n")
 
   # Future items
   if future:
@@ -294,7 +328,13 @@ proc list(
           not (it.hasProp("hide-until") and
                it.getDateTime("hide-until") > getTime().local))
 
-        stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+        if isatty(stdout):
+          stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+
+        else:
+          stdout.writeLine visibleIssues
+            .mapIt(formatPlainIssueSummary(it))
+            .join("\n")
 
   trace "listing complete"
 
@@ -379,7 +419,7 @@ when isMainModule:
 
     ctx.cfg.tasksDir.store(issue, state)
 
-    stdout.writeLine ctx.formatIssue(issue)
+    stdout.writeLine formatIssue(issue)
 
   elif args["reorder"]:
     ctx.reorder(parseEnum[IssueState]($args["<state>"]))
@@ -390,7 +430,7 @@ when isMainModule:
       var stateOption = none(IssueState)
 
       try: stateOption = some(parseEnum[IssueState](editRef))
-      except: discard
+      except CatchableError: discard
 
       if stateOption.isSome:
         let state = stateOption.get
@@ -442,9 +482,9 @@ when isMainModule:
         issue["completed"] = getTime().local.formatIso8601
         if issue.hasProp("recurrence") and issue.getRecurrence.isSome:
           let nextIssue = ctx.cfg.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
-          ctx.cfg.tasksDir.store(nextIssue, Todo)
+          ctx.cfg.tasksDir.store(nextIssue, TodoToday)
           info "created the next recurrence:"
-          stdout.writeLine ctx.formatIssue(nextIssue)
+          stdout.writeLine formatIssue(nextIssue)
 
 
       issue.changeState(ctx.cfg.tasksDir, targetState)
@@ -461,7 +501,7 @@ when isMainModule:
           )
           cmd &= " -g \"" & tags.join(",") & "\""
         cmd &= " -n \"pit-id: " & $issue.id & "\""
-        cmd &= " \"" & issue.summary & "\""
+        cmd &= " \"[" & ($issue.id)[0..<6] & "] " & issue.summary & "\""
         discard execShellCmd(cmd)
       elif targetState == Done or targetState == Pending:
         discard execShellCmd("ptk stop")
@@ -543,8 +583,12 @@ when isMainModule:
 
     if args["contexts"]: listContexts = true
     elif args["<stateOrId>"]:
-      try: statesOption = some(args["<stateOrId>"].mapIt(parseEnum[IssueState]($it)))
+      try:
-      except: issueIdsOption = some(args["<stateOrId>"].mapIt($it))
+        statesOption =
+          some(args["<stateOrId>"].
+          mapIt(parseEnum[IssueState]($it)))
+      except CatchableError:
+        issueIdsOption = some(args["<stateOrId>"].mapIt($it))
 
     # List the known contexts
     if listContexts:
@@ -567,7 +611,7 @@ when isMainModule:
     elif issueIdsOption.isSome:
       for issueId in issueIdsOption.get:
         let issue = ctx.cfg.tasksDir.loadIssueById(issueId)
-        stdout.writeLine ctx.formatIssue(issue)
+        stdout.writeLine formatIssue(issue)
 
     # List all issues
     else:
@@ -608,7 +652,23 @@ when isMainModule:
     try: write(propOut, decodeDataUri(issue[$(args["<propName>"])]))
     finally: close(propOut)
 
- except:
+  elif args["show-dupes"]:
+    ctx.loadAllIssues()
+
+    var idsToPaths = newTable[string, var seq[string]]()
+    for (state, issues) in pairs(ctx.issues):
+      for issue in issues:
+        let issueId = $issue.id
+
+        if idsToPaths.hasKey(issueId): idsToPaths[issueId].add(issue.filepath)
+        else: idsToPaths[issueId] = @[issue.filepath]
+
+    for (issueId, issuePaths) in pairs(idsToPaths):
+      if issuePaths.len < 2: continue
+      stdout.writeLine(issueId & ":\p  " & issuePaths.join("\p  ") & "\p\p")
+
+ except CatchableError:
   fatal getCurrentExceptionMsg()
+  debug getCurrentException().getStackTrace()
   #raise getCurrentException()
   quit(QuitFailure)

src/pit_api.nim

@@ -1,5 +1,11 @@
 ## Personal Issue Tracker API Interface
 ## ====================================
+#
+# **NOTE** This is currently not being built as it no longer works under Nim
+# 2.x due to the inability to call system calls (invoke pit via cli) in a
+# gc-safe manner. It should be rewritten to use the functionality exposed by
+# libpit directly rather than calling the pit cli executable. Unfortunately
+# this would require a non-trivial rewrite.
 
 import asyncdispatch, cliutils, docopt, jester, json, logging, options, sequtils, strutils
 import nre except toSeq

src/pitpkg/cliconstants.nim

@@ -1,4 +1,4 @@
-const PIT_VERSION* = "4.23.0"
+const PIT_VERSION* = "4.26.0"
 
 const USAGE* = """Usage:
   pit ( new | add) <summary> [<state>] [options]
@@ -14,6 +14,7 @@ const USAGE* = """Usage:
   pit ( delete | rm ) <id>... [options]
   pit add-binary-property <id> <propName> <propSource> [options]
   pit get-binary-property <id> <propName> <propDest> [options]
+  pit show-dupes
   pit help [options]
 
 Options:
@@ -100,7 +101,9 @@ Issue Properties:
     created
 
       If present, expected to be an ISO 8601-formatted date that represents the
-      time when the issue was created.
+      time when the issue was created. E.g.:
+
+          created: 2023-07-13T13:28:41-05:00
 
     completed
 
@@ -109,12 +112,16 @@ Issue Properties:
       property automatically when you use the "done" command, and can filter on
       this value.
 
+          completed: 2023-04-27T11:52:28-05:00
+
     context
 
       Allows issues to be organized into contexts. The -c option is short-hand
       for '-p context:<context-name>' and the 'list contexts' command will show
       all values of 'context' set in existing issues.
 
+          context: family
+
     delegated-to
 
       When an issue now belongs to someone else, but needs to be monitored for
@@ -122,17 +129,23 @@ Issue Properties:
       note how it has been delegated. When present PIT will prepend this value
       to the issue summary with an accent color.
 
+          delegated-to: Bob Ross
+
     hide-until
 
       When present, expected to be an ISO 8601-formatted date and used to
       supress the display of the issue until on or after the given date.
 
+          hide-until: 2024-01-01T13:45:00-05:00
+
     pending
 
       When an issue is blocked by a third party, this property can be used to
       capture details about the dependency When present PIT will display this
       value after the issue summary.
 
+          pending: Results of WCAG analysis.
+
     recurrence
 
       When an issue is moved to the "done" state, if the issue has a valid
@@ -143,7 +156,7 @@ Issue Properties:
       A valid recurrence value has a time value and optionally has an source
       issue ID. For example:
 
-        every 5 days, 10a544
+          recurrence: every 5 days, 10a544
 
       The first word, "every", is expected to be either "every" or "after".
 
@@ -161,12 +174,12 @@ Issue Properties:
 
       Examples:
 
-        every day
+          every day
-        every 2 days
+          every 2 days
-        after 2 days
+          after 2 days
-        every week
+          every week
-        after 12 hours
+          after 12 hours
-        every 2 weeks, 10a544
+          every 2 weeks, 10a544
 
     tags
 

src/pitpkg/private/libpit.nim

@@ -41,6 +41,7 @@ type
     isFromCompletion*: bool
 
 const DONE_FOLDER_FORMAT* = "yyyy-MM"
+const ISO8601_MS = "yyyy-MM-dd'T'HH:mm:ss'.'fffzzz"
 
 let ISSUE_FILE_PATTERN = re"[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}\.txt"
 let RECURRENCE_PATTERN = re"(every|after) ((\d+) )?((hour|day|week|month|year)s?)(, ([0-9a-fA-F]+))?"
@@ -167,7 +168,7 @@ proc parseDate*(d: string): DateTime =
   var errMsg = ""
   for df in DATE_FORMATS:
     try: return d.parse(df)
-    except:
+    except CatchableError:
       errMsg &= "\n\tTried " & df & " with " & d
       continue
   raise newException(ValueError, "Unable to parse input as a date: " & d & errMsg)
@@ -219,12 +220,17 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
 
 proc toStorageFormat*(issue: Issue, withComments = false): string =
   var lines: seq[string] = @[]
+
   if withComments: lines.add("# Summary (one line):")
   lines.add(issue.summary)
+
   if withComments: lines.add("# Properties (\"key:value\" per line):")
+  issue.properties["last-updated"] = now().format(ISO8601_MS)
   for key, val in issue.properties:
     if not val.isEmptyOrWhitespace: lines.add(key & ": " & val)
+
   if issue.tags.len > 0: lines.add("tags: " & issue.tags.join(","))
+
   if not isEmptyOrWhitespace(issue.details) or withComments:
     if withComments: lines.add("# Details go below the \"--------\"")
     lines.add("--------")
@@ -322,10 +328,16 @@ proc loadAllIssues*(tasksDir: string): TableRef[IssueState, seq[Issue]] =
   for state in IssueState: result[state] = tasksDir.loadIssues(state)
 
 proc changeState*(issue: Issue, tasksDir: string, newState: IssueState) =
+  var dbgInfo = "[$#] changing state: $# → $#" %
+    [ ($issue.id)[0..<6], $issue.state, $newState ]
+
   let oldFilepath = issue.filepath
   if newState == Done: issue.setDateTime("completed", getTime().local)
   tasksDir.store(issue, newState)
   if oldFilePath != issue.filepath: removeFile(oldFilepath)
+  dbgInfo &= "\n\told path: $#\n\tnew path: $#" % [oldFilePath, issue.filepath]
+  issue.state = newState
+  debug dbgInfo
 
 proc delete*(issue: Issue) = removeFile(issue.filepath)
 
@@ -406,14 +418,12 @@ proc find*(
 
 ### Configuration utilities
 proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitConfig =
-  let pitrcLocations = @[
+  var pitrcFilename: string
-    if args["--config"]: $args["--config"] else: "",
-    ".pitrc", $getEnv("PITRC"), $getEnv("HOME") & "/.pitrc"]
 
-  var pitrcFilename: string =
+  try:
-    pitrcLocations --> fold("", if fileExists(it): it else: a)
+    pitrcFilename = findConfigFile(".pitrc",
-
+      if args["--config"]: @[$args["--config"]] else: @[])
-  if not fileExists(pitrcFilename):
+  except ValueError:
     warn "could not find .pitrc file: " & pitrcFilename
     if isEmptyOrWhitespace(pitrcFilename):
       pitrcFilename = $getEnv("HOME") & "/.pitrc"
@@ -421,25 +431,19 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
     try:
       cfgFile = open(pitrcFilename, fmWrite)
       cfgFile.write("{\"tasksDir\": \"/path/to/tasks\"}")
-    except: warn "could not write default .pitrc to " & pitrcFilename
+    except CatchableError: warn "could not write default .pitrc to " & pitrcFilename
     finally: close(cfgFile)
 
-  var cfgJson: JsonNode
+  debug "loading config from '$#'" % [pitrcFilename]
-  try: cfgJson = parseFile(pitrcFilename)
+  let cfg = initCombinedConfig(pitrcFilename, args)
-  except: raise newException(IOError,
-    "unable to read config file: " & pitrcFilename &
-    "\x0D\x0A" & getCurrentExceptionMsg())
-
-  let cfg = CombinedConfig(docopt: args, json: cfgJson)
 
   result = PitConfig(
     cfg: cfg,
     contexts: newTable[string,string](),
     tasksDir: cfg.getVal("tasks-dir", ""))
 
-  if cfgJson.hasKey("contexts"):
+  for k, v in cfg.getJson("contexts", newJObject()):
-    for k, v in cfgJson["contexts"]:
+    result.contexts[k] = v.getStr()
-      result.contexts[k] = v.getStr()
 
   if isEmptyOrWhitespace(result.tasksDir):
     raise newException(Exception, "no tasks directory configured")