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.
Use update_nim_package_version from the package repository.
2024-11-30 08:08:40 -06:00 · 2024-11-30 07:56:55 -06:00 · 2024-08-12 10:52:51 -05:00 · 2024-05-10 11:58:35 -05:00 · 2024-01-01 12:55:01 -06:00 · 2024-01-01 12:47:43 -06:00
7 changed files with 83 additions and 195 deletions
--- a/.tool-versions
+++ b/.tool-versions
@ -0,0 +1 @@
+nim 2.2.0
--- a/nimble.lock
+++ b/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": {}
-}
--- a/pit.nimble
+++ b/pit.nimble
@ -1,30 +1,30 @@
 # Package

-version       = "4.23.4"
+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",
-  "jester >= 0.5.0",
+  "docopt >= 0.7.1",
+  "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.8.1",
+  "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.":
--- a/src/pit.nim
+++ b/src/pit.nim
@ -70,6 +70,24 @@ proc formatIssue*(issue: Issue): string =

  result &= termReset

+proc formatPlainIssueSummary*(issue: Issue): string =
+
+  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 = 80,
@ -251,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

@ -279,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:
@ -296,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"

@ -444,7 +482,7 @@ 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 formatIssue(nextIssue)

@ -463,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")
--- a/src/pit_api.nim
+++ b/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
--- a/src/pitpkg/cliconstants.nim
+++ b/src/pitpkg/cliconstants.nim
@ -1,4 +1,4 @@
-const PIT_VERSION* = "4.23.4"
+const PIT_VERSION* = "4.26.0"

 const USAGE* = """Usage:
  pit ( new | add) <summary> [<state>] [options]
@ -101,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

@ -110,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
@ -123,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
@ -144,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".

@ -162,12 +174,12 @@ Issue Properties:

      Examples:

-        every day
-        every 2 days
-        after 2 days
-        every week
-        after 12 hours
-        every 2 weeks, 10a544
+          every day
+          every 2 days
+          after 2 days
+          every week
+          after 12 hours
+          every 2 weeks, 10a544

    tags

--- a/src/pitpkg/private/libpit.nim
+++ b/src/pitpkg/private/libpit.nim
@ -328,11 +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)
Author	SHA1	Message	Date
Jonathan Bernard	587e3c4509	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.	2024-11-30 08:08:40 -06:00
Jonathan Bernard	f6a97c384a	Use update_nim_package_version from the package repository.	2024-11-30 07:56:55 -06:00
Jonathan Bernard	0c3d73dc2b	Add debug logging when changing the state of an issue.	2024-08-12 10:52:51 -05:00
Jonathan Bernard	9a0bf35882	Add asdf tool-versions definitions pinning this to Nim 1.6	2024-05-10 11:58:35 -05:00
Jonathan Bernard	be7c099b7b	Format listed issues plainly when STDOUT is not a TTY	2024-01-01 12:55:01 -06:00
Jonathan Bernard	d04797460c	Format listed issues plainly when STDIN is not a TTY When calling pit from other programs or as part of a pipe, the display style typically used to format listed issues contains a lot of unwanted output (ANSI escape code, headings, etc.). Now when STDIN is not a TTY, a plain and consistently formatted version of the issues is listed without any additional formatting, one issue per line of output.	2024-01-01 12:47:43 -06:00
Jonathan Bernard	8cf0bf5d98	Change how time entries based on PIT issues are logged when using --ptk.	2023-12-17 07:32:46 -06:00
Jonathan Bernard	ddad90ddef	Add examples to the online help for all special properties.	2023-12-15 21:34:38 -06:00
Jonathan Bernard	34ce2b61b9	When creating new recurrences, put them in the TodoToday state, not Todo.	2023-07-06 08:07:22 -05:00