Update timeutils version to include support for the shorter ISO8601 date format.

Add find utility method for searching for issues among multiple issue states.
Move issue loading logic into the publicly-exposed library methods.
2023-02-28 23:29:06 -06:00 · 2023-02-17 12:12:13 -06:00 · 2023-02-16 11:07:09 -06:00 · 2023-02-16 09:07:02 -06:00 · 2023-02-13 08:48:40 -06:00 · 2022-07-31 20:01:39 -05:00
9 changed files with 554 additions and 242 deletions
--- a/nimble.lock
+++ b/nimble.lock
@ -0,0 +1,174 @@
+{
+  "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,26 +1,30 @@
 # Package

-version       = "4.16.0"
+version       = "4.22.2"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"
 srcDir        = "src"
+installExt    = @["nim"]
 bin           = @["pit", "pit_api"]

 # Dependencies

 requires @[
  "nim >= 1.4.0",
-  "docopt 0.6.8",
-  "jester 0.5.0",
-  "uuids 0.1.10",
+  "docopt >= 0.6.8",
+  "jester >= 0.5.0",
+  "uuids >= 0.1.10"
+]

-  "https://git.jdb-software.com/jdb/nim-cli-utils.git >= 0.6.4",
-  "https://git.jdb-software.com/jdb/nim-lang-utils.git >= 0.4.0",
-  "https://git.jdb-software.com/jdb/nim-time-utils.git >= 0.4.0",
-  "https://git.jdb-software.com/jdb/nim-data-uri.git >= 1.0.0",
-  "https://git.jdb-software.com/jdb/update-nim-package-version"
+# Dependencies from git.jdb-software.com/nim-jdb/packages
+requires @[
+  "cliutils >= 0.6.4",
+  "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"
 ]

 task updateVersion, "Update the version of this package.":
-  exec "update_nim_package_version pit 'src/pitpkg/version.nim'"
+  exec "update_nim_package_version pit 'src/pitpkg/cliconstants.nim'"
--- a/src/online-help.txt
+++ b/src/online-help.txt
@ -1,93 +0,0 @@
-Issue States:
-
-  PIT organizes issues around their state, which is one of:
-
-    current     - issues actively being worked
-    todo-today  - issues planned for today
-    pending     - issues that are blocked by some third-party
-    done        - issues that have been completely resolved
-    todo        - issues that need to be done in the future
-    dormant     - issues that are low-priority, to be tracked, but hidden
-                  by default
-
-Issue Properties:
-
-  PIT supports adding arbitrary properties to any issue to track any metadata
-  about the issue the user may wish. There are several properties that have
-  special behavior attached to them. They are:
-
-    created
-
-      If present, expected to be an ISO 8601-formatted date that represents the
-      time when the issue was created.
-
-    completed
-
-      If present, expected to be an ISO 8601-formatted date that represents the
-      time when the issue moved to the "done" state.  PIT will add this
-      property automatically when you use the "done" command, and can filter on
-      this value.
-
-    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.
-
-    delegated-to
-
-      When an issue now belongs to someone else, but needs to be monitored for
-      completion, this allows you to keep the issue in its current state but
-      note how it has been delegated. When present PIT will prepend this value
-      to the issue summary with an accent color.
-
-    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.
-
-    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.
-
-    recurrence
-
-      When an issue is moved to the "done" state, if the issue has a valid
-      "recurrence" property, PIT will create a new issue and set the
-      "hide-until" property for that new issue depending on the recurrence
-      definition.
-
-      A valid recurrence value has a time value and optionally has an source
-      issue ID. For example:
-
-        every 5 days, 10a544
-
-      The first word, "every", is expected to be either "every" or "after".
-
-      The second portion is expected to be a time period. Supported time units
-      are "hour", "day", "week", "month", an "year", along with the plural
-      forms (e.g. "5 days", "8 hours", etc.).
-
-      The final portion is the source issue ID. This is optional. When a source
-      issue ID is given, the new issue is created as a clone of the given
-      issue. When not given, the issue being closed is used for cloning.
-
-      The "every" and "after" keywords allow the user to choose whether the new
-      issue is created based on the creation time ("every") or the completion
-      time ("after") of the issue being closed based.
-
-      Examples:
-
-        every day
-        every 2 days
-        after 2 days
-        every week
-        after 12 hours
-        every 2 weeks, 10a544
-
-    tags
-
-      If present, expected to be a comma-delimited list of text tags. The -g
-      option is a short-hand for '-p tags:<tags-value>'.
--- a/src/pit.nim
+++ b/src/pit.nim
@ -1,22 +1,21 @@
 ## Personal Issue Tracker CLI interface
 ## ====================================

-import algorithm, cliutils, data_uri, docopt, json, logging, options, os,
-  sequtils, std/wordwrap, tables, terminal, times, timeutils, unicode, uuids
+import std/algorithm, std/logging, std/options, std/os, std/sequtils,
+  std/wordwrap, std/tables, std/terminal, std/times, std/unicode
+import cliutils, data_uri, docopt, json, timeutils, uuids

 from nre import re
 import strutils except alignLeft, capitalize, strip, toUpper, toLower
 import pitpkg/private/libpit
+import pitpkg/cliconstants
 export libpit

-include "pitpkg/version.nim"
-
 type
  CliContext = ref object
    cfg*: PitConfig
    contexts*: TableRef[string, string]
    defaultContext*: Option[string]
-    tasksDir*: string
    issues*: TableRef[IssueState, seq[Issue]]
    termWidth*: int
    triggerPtk*, verbose*: bool
@ -43,7 +42,6 @@ proc initContext(args: Table[string, Value]): CliContext =
      else: some(cliJson["defaultContext"].getStr()),
    verbose: parseBool(cliCfg.getVal("verbose", "false")) and not args["--quiet"],
    issues: newTable[IssueState, seq[Issue]](),
-    tasksDir: pitCfg.tasksDir,
    termWidth: parseInt(cliCfg.getVal("termWidth", "80")),
    triggerPtk: cliJson.getOrDefault("triggerPtk").getBool(false))

@ -72,46 +70,68 @@ proc formatIssue(ctx: CliContext, issue: Issue): string =

  result &= termReset

-proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
-                verbose = false): string =
-
-  result = ""
-
-  var showDetails = not issue.details.isEmptyOrWhitespace and verbose
-
-  var prefixLen = 0
-  var summaryIndentLen = indent.len + 7
-
-  if issue.hasProp("delegated-to"): prefixLen += issue["delegated-to"].len + 2 # space for the ':' and ' '
-
-  # Wrap and write the summary.
-  var wrappedSummary = ("+".repeat(prefixLen) & issue.summary).wrapWords(width - summaryIndentLen).indent(summaryIndentLen)
-
-  wrappedSummary = wrappedSummary[(prefixLen + summaryIndentLen)..^1]
+proc formatSectionIssue(
+    ctx: CliContext,
+    issue: Issue,
+    width: int,
+    indent = "",
+    verbose = false): string =

  result = (indent & ($issue.id)[0..<6]).withColor(fgBlack, true) & " "

-  if issue.hasProp("delegated-to"):
-    result &= (issue["delegated-to"] & ": ").withColor(fgGreen)
+  let showDetails = not issue.details.isEmptyOrWhitespace and verbose

-  result &= wrappedSummary.withColor(fgWhite)
+  let summaryIndentLen = indent.len + 7
+  let summaryWidth = width - summaryIndentLen
+
+  let summaryLines = issue.summary
+    .wrapWords(summaryWidth)
+    .splitLines
+
+  result &= summaryLines[0].withColor(fgWhite)
+
+  for line in summaryLines[1..^1]:
+    result &= "\p" & line.indent(summaryIndentLen)
+
+  var lastLineLen = summaryLines[^1].len
+
+  if issue.hasProp("delegated-to"):
+    if lastLineLen + issue["delegated-to"].len + 1 < summaryWidth:
+      result &= " " & issue["delegated-to"].withColor(fgMagenta)
+      lastLineLen += issue["delegated-to"].len + 1
+    else:
+      result &= "\p" & issue["delegated-to"]
+        .withColor(fgMagenta)
+        .indent(summaryIndentLen)
+      lastLineLen = issue["delegated-to"].len

  if issue.tags.len > 0:
-    let tagsStr = "(" & issue.tags.join(", ") & ")"
-    if (result.splitLines[^1].len + tagsStr.len + 1) > (width - 2):
-      result &= "\n" & indent
-    result &= " " & tagsStr.withColor(fgGreen)
+    let tagsStrLines = ("(" & issue.tags.join(", ") & ")")
+      .wrapWords(summaryWidth)
+      .splitLines

+    if tagsStrLines.len == 1 and
+       (lastLineLen + tagsStrLines[0].len + 1) < summaryWidth:
+      result &= " " & tagsStrLines[0].withColor(fgGreen)
+      lastLineLen += tagsStrLines[0].len + 1
+    else:
+      result &= "\p" & tagsStrLines
+        .mapIt(it.indent(summaryIndentLen))
+        .join("\p")
+        .withColor(fgGreen)
+      lastLineLen = tagsStrLines[^1].len

  if issue.hasProp("pending"):
-    let startIdx = "Pending: ".len
-    var pendingText = issue["pending"].wrapWords(width - startIdx - summaryIndentLen)
-                                      .indent(startIdx)
-    pendingText = ("Pending: " & pendingText[startIdx..^1]).indent(summaryIndentLen)
-    result &= "\n" & pendingText.withColor(fgCyan)
+    result &= "\p" & ("Pending: " & issue["pending"])
+      .wrapwords(summaryWidth)
+      .withColor(fgCyan)
+      .indent(summaryIndentLen)

  if showDetails:
-    result &= "\n" & issue.details.strip.indent(indent.len + 2).withColor(fgCyan)
+    result &= "\p" & issue.details
+      .strip
+      .withColor(fgBlack, bright = true)
+      .indent(summaryIndentLen)

  result &= termReset

@ -147,15 +167,14 @@ proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
  else: result &= ctx.formatSectionIssueList(issues, innerWidth, indent, verbose)

 proc loadIssues(ctx: CliContext, state: IssueState) =
-  ctx.issues[state] = loadIssues(ctx.tasksDir / $state)
+  ctx.issues[state] = loadIssues(ctx.cfg.tasksDir, state)

 proc loadOpenIssues(ctx: CliContext) =
  ctx.issues = newTable[IssueState, seq[Issue]]()
  for state in [Current, TodoToday, Todo, Pending, Todo]: ctx.loadIssues(state)

 proc loadAllIssues(ctx: CliContext) =
-  ctx.issues = newTable[IssueState, seq[Issue]]()
-  for state in IssueState: ctx.loadIssues(state)
+  ctx.issues = ctx.cfg.tasksDir.loadAllIssues()

 proc filterIssues(ctx: CliContext, filter: IssueFilter) =
  for state, issueList in ctx.issues:
@ -168,6 +187,16 @@ proc parsePropertiesOption(propsOpt: string): TableRef[string, string] =
    if pair.len == 1: result[pair[0]] = "true"
    else: result[pair[0]] = pair[1]

+proc parseExclPropertiesOption(propsOpt: string): TableRef[string, seq[string]] =
+  result = newTable[string, seq[string]]()
+  for propText in propsOpt.split(";"):
+    let pair = propText.split(":", 1)
+    let val =
+      if pair.len == 1: "true"
+      else: pair[1]
+    if result.hasKey(pair[0]): result[pair[0]].add(val)
+    else: result[pair[0]] = @[val]
+
 proc sameDay(a, b: DateTime): bool =
  result = a.year == b.year and a.yearday == b.yearday

@ -182,7 +211,7 @@ proc reorder(ctx: CliContext, state: IssueState) =

  # load the issues to make sure the order file contains all issues in the state.
  ctx.loadIssues(state)
-  discard os.execShellCmd(EDITOR & " '" & (ctx.tasksDir / $state / "order.txt") & "' </dev/tty >/dev/tty")
+  discard os.execShellCmd(EDITOR & " '" & (ctx.cfg.tasksDir / $state / "order.txt") & "' </dev/tty >/dev/tty")

 proc edit(issue: Issue) =

@ -200,17 +229,26 @@ proc edit(issue: Issue) =
      getCurrentExceptionMsg()
    issue.store()

-proc list(ctx: CliContext, filter: Option[IssueFilter], states: Option[seq[IssueState]], showToday, showFuture, verbose: bool) =
+proc list(
+    ctx: CliContext,
+    filter: Option[IssueFilter],
+    states: Option[seq[IssueState]],
+    showToday, showFuture,
+    showHidden = false,
+    verbose: bool) =

  if states.isSome:
    trace "listing issues for " & $states.get
    for state in states.get:
      ctx.loadIssues(state)
      if filter.isSome: ctx.filterIssues(filter.get)
+
+      # Show Done for just today if requested
      if state == Done and showToday:
        ctx.issues[Done] = ctx.issues[Done].filterIt(
          it.hasProp("completed") and
          sameDay(getTime().local, it.getDateTime("completed")))
+
      stdout.write ctx.formatSection(ctx.issues[state], state, "", verbose)
    trace "listing complete"
    return
@ -234,15 +272,25 @@ proc list(ctx: CliContext, filter: Option[IssueFilter], states: Option[seq[Issue

    for s in [Current, TodoToday, Pending]:
      if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
-        stdout.write ctx.formatSection(ctx.issues[s], s, indent, verbose)
+        let visibleIssues = ctx.issues[s].filterIt(
+          showHidden or
+          not (it.hasProp("hide-until") and
+               it.getDateTime("hide-until") > getTime().local))
+
+        stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)

  # Future items
  if future:
    if today: ctx.writeHeader("Future")

-    for s in [Pending, Todo]:
+    let futureCategories =
+      if showToday: @[Todo]
+      else: @[Pending, Todo]
+
+    for s in futureCategories:
      if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
        let visibleIssues = ctx.issues[s].filterIt(
+          showHidden or
          not (it.hasProp("hide-until") and
               it.getDateTime("hide-until") > getTime().local))

@ -252,16 +300,14 @@ proc list(ctx: CliContext, filter: Option[IssueFilter], states: Option[seq[Issue

 when isMainModule:
 try:
-  const usage = readFile("src/usage.txt")
-  const onlineHelp = readFile("src/online-help.txt")

  let consoleLogger = newConsoleLogger(
    levelThreshold=lvlInfo,
-    fmtStr="$app - $levelname: ")
+    fmtStr="pit - $levelname: ")
  logging.addHandler(consoleLogger)

  # Parse arguments
-  let args = docopt(usage, version = PIT_VERSION)
+  let args = docopt(USAGE, version = PIT_VERSION)

  if args["--debug"]:
    consoleLogger.levelThreshold = lvlDebug
@ -269,8 +315,8 @@ when isMainModule:
  if args["--echo-args"]: stderr.writeLine($args)

  if args["help"]:
-    stderr.writeLine(usage & "\n")
-    stderr.writeLine(onlineHelp)
+    stderr.writeLine(USAGE & "\p")
+    stderr.writeLine(ONLINE_HELP)
    quit()

  let ctx = initContext(args)
@ -278,7 +324,9 @@ when isMainModule:
  trace "context initiated"

  var propertiesOption = none(TableRef[string,string])
+  var exclPropsOption = none(TableRef[string,seq[string]])
  var tagsOption = none(seq[string])
+  var exclTagsOption = none(seq[string])

  if args["--properties"] or args["--context"]:

@ -290,8 +338,25 @@ when isMainModule:

    propertiesOption = some(props)

+  if args["--excl-properties"] or args["--excl-context"]:
+
+    var exclProps =
+      if args["--excl-properties"]:
+        parseExclPropertiesOption($args["--excl-properties"])
+      else: newTable[string,seq[string]]()
+
+    if args["--excl-context"]:
+      if not exclProps.hasKey("context"): exclProps["context"] = @[]
+      let exclContexts = split($args["--excl-context"], ",")
+      exclProps["context"] = exclProps["context"].concat(exclContexts)
+
+    exclPropsOption = some(exclProps)
+
  if args["--tags"]: tagsOption = some(($args["--tags"]).split(",").mapIt(it.strip))

+  if args["--excl-tags"]: exclTagsOption =
+    some(($args["--excl-tags"]).split(",").mapIt(it.strip))
+
  ## Actual command runners
  if args["new"] or args["add"]:
    let state =
@ -309,10 +374,10 @@ when isMainModule:
      summary: $args["<summary>"],
      properties: issueProps,
      tags:
-        if args["--tags"]: ($args["--tags"]).split(",").mapIt(it.strip)
+        if tagsOption.isSome: tagsOption.get
        else: newSeq[string]())

-    ctx.tasksDir.store(issue, state)
+    ctx.cfg.tasksDir.store(issue, state)

    stdout.writeLine ctx.formatIssue(issue)

@ -332,25 +397,25 @@ when isMainModule:
        ctx.loadIssues(state)
        for issue in ctx.issues[state]: edit(issue)

-      else: edit(ctx.tasksDir.loadIssueById(editRef))
+      else: edit(ctx.cfg.tasksDir.loadIssueById(editRef))

  elif args["tag"]:
-    if not args["--tags"]: raise newException(Exception, "no tags given")
+    if tagsOption.isNone: raise newException(Exception, "no tags given")

-    let newTags = ($args["--tags"]).split(",").mapIt(it.strip)
+    let newTags = tagsOption.get

    for id in @(args["<id>"]):
-      var issue = ctx.tasksDir.loadIssueById(id)
+      var issue = ctx.cfg.tasksDir.loadIssueById(id)
      issue.tags = deduplicate(issue.tags & newTags)
      issue.store()

  elif args["untag"]:
    let tagsToRemove: seq[string] =
-      if args["--tags"]: ($args["--tags"]).split(",").mapIt(it.strip)
+      if tagsOption.isSome: tagsOption.get
      else: @[]

    for id in @(args["<id>"]):
-      var issue = ctx.tasksDir.loadIssueById(id)
+      var issue = ctx.cfg.tasksDir.loadIssueById(id)
      if tagsToRemove.len > 0:
        issue.tags = issue.tags.filter(
          proc (tag: string): bool = not tagsToRemove.anyIt(it == tag))
@ -369,21 +434,24 @@ when isMainModule:
    elif args["suspend"]: targetState = Dormant

    for id in @(args["<id>"]):
-      var issue = ctx.tasksDir.loadIssueById(id)
+      var issue = ctx.cfg.tasksDir.loadIssueById(id)
      if propertiesOption.isSome:
        for k,v in propertiesOption.get:
          issue[k] = v
      if targetState == Done:
        issue["completed"] = getTime().local.formatIso8601
        if issue.hasProp("recurrence") and issue.getRecurrence.isSome:
-          let nextIssue = ctx.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
-          ctx.tasksDir.store(nextIssue, Todo)
+          let nextIssue = ctx.cfg.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
+          ctx.cfg.tasksDir.store(nextIssue, Todo)
+          info "created the next recurrence:"
+          stdout.writeLine ctx.formatIssue(nextIssue)

-      issue.changeState(ctx.tasksDir, targetState)
+
+      issue.changeState(ctx.cfg.tasksDir, targetState)

    if ctx.triggerPtk or args["--ptk"]:
      if targetState == Current:
-        let issue = ctx.tasksDir.loadIssueById($(args["<id>"][0]))
+        let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"][0]))
        var cmd = "ptk start"
        if issue.tags.len > 0 or issue.hasProp("context"):
          let tags = concat(
@ -400,14 +468,14 @@ when isMainModule:

  elif args["hide-until"]:

-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
    issue.setDateTime("hide-until", parseDate($args["<date>"]))

    issue.store()

  elif args["delegate"]:

-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
    issue["delegated-to"] = $args["<delegated-to>"]

    issue.store()
@ -415,7 +483,7 @@ when isMainModule:
  elif args["delete"] or args["rm"]:
    for id in @(args["<id>"]):

-      let issue = ctx.tasksDir.loadIssueById(id)
+      let issue = ctx.cfg.tasksDir.loadIssueById(id)

      if not args["--yes"]:
        stderr.write("Delete '" & issue.summary & "' (y/n)? ")
@ -434,6 +502,11 @@ when isMainModule:
      filter.properties = propertiesOption.get
      filterOption = some(filter)

+    # Add property exclusions (if given)
+    if exclPropsOption.isSome:
+      filter.exclProperties = exclPropsOption.get
+      filterOption = some(filter)
+
    # If they supplied text matches, add that to the filter.
    if args["--match"]:
      filter.summaryMatch = some(re("(?i)" & $args["--match"]))
@ -449,8 +522,12 @@ when isMainModule:
      filter.properties["context"] = ctx.defaultContext.get
      filterOption = some(filter)

-    if args["--tags"]:
-      filter.hasTags = ($args["--tags"]).split(',')
+    if tagsOption.isSome:
+      filter.hasTags = tagsOption.get
+      filterOption = some(filter)
+
+    if exclTagsOption.isSome:
+      filter.exclTags = exclTagsOption.get
      filterOption = some(filter)

    # Finally, if the "context" is "all", don't filter on context
@ -458,6 +535,7 @@ when isMainModule:
       filter.properties["context"] == "all":

      filter.properties.del("context")
+      filter.exclProperties.del("context")

    var listContexts = false
    var statesOption = none(seq[IssueState])
@ -488,19 +566,23 @@ when isMainModule:
    # List a specific issue
    elif issueIdsOption.isSome:
      for issueId in issueIdsOption.get:
-        let issue = ctx.tasksDir.loadIssueById(issueId)
+        let issue = ctx.cfg.tasksDir.loadIssueById(issueId)
        stdout.writeLine ctx.formatIssue(issue)

    # List all issues
    else:
      trace "listing all issues"
      let showBoth = args["--today"] == args["--future"]
-      ctx.list(filterOption, statesOption, showBoth or args["--today"],
-                                          showBoth or args["--future"],
-                                          ctx.verbose)
+      ctx.list(
+        filter = filterOption,
+        states = statesOption,
+        showToday = showBoth or args["--today"],
+        showFuture = showBoth or args["--future"],
+        showHidden = args["--show-hidden"],
+        verbose = ctx.verbose)

  elif args["add-binary-property"]:
-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))

    let propIn =
      if $(args["<propSource>"]) == "-": stdin
@ -512,7 +594,7 @@ when isMainModule:
    issue.store()

  elif args["get-binary-property"]:
-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))

    if not issue.hasProp($(args["<propName>"])):
      raise newException(Exception,
--- a/src/pit_api.nim
+++ b/src/pit_api.nim
@ -5,8 +5,7 @@ import asyncdispatch, cliutils, docopt, jester, json, logging, options, sequtils
 import nre except toSeq

 import pitpkg/private/libpit
-
-include "pitpkg/version.nim"
+import pitpkg/cliconstants

 type
  PitApiCfg* = object
@ -40,10 +39,10 @@ template checkAuth(cfg: PitApiCfg) =
  var authed {.inject.} = false

  try:
-    if not request.headers.hasKey("Authorization"):
+    if not headers(request).hasKey("Authorization"):
      raiseEx "No auth token."

-    let headerVal = request.headers["Authorization"]
+    let headerVal = headers(request)["Authorization"]
    if not headerVal.startsWith("Bearer "):
      raiseEx "Invalid Authentication type (only 'Bearer' is supported)."

--- a/src/pitpkg/cliconstants.nim
+++ b/src/pitpkg/cliconstants.nim
@ -0,0 +1,175 @@
+const PIT_VERSION* = "4.22.2"
+
+const USAGE* = """Usage:
+  pit ( new | add) <summary> [<state>] [options]
+  pit list contexts [options]
+  pit list [<stateOrId>...] [options]
+  pit ( start | done | pending | todo-today | todo | suspend ) <id>... [options]
+  pit edit <ref>... [options]
+  pit tag <id>... [options]
+  pit untag <id>... [options]
+  pit reorder <state> [options]
+  pit delegate <id> <delegated-to> [options]
+  pit hide-until <id> <date> [options]
+  pit ( delete | rm ) <id>... [options]
+  pit add-binary-property <id> <propName> <propSource> [options]
+  pit get-binary-property <id> <propName> <propDest> [options]
+  pit help [options]
+
+Options:
+
+  -h, --help                Print this usage and help information.
+
+  -p, --properties <props>  Specify properties. Formatted as "key:val;key:val"
+                            When used with the list command this option applies
+                            a filter to the issues listed, only allowing those
+                            which have all of the given properties.
+
+  -P, --excl-properties <props>
+                            When used with the list command, exclude issues
+                            that contain properties with the given value. This
+                            parameter is formatted the same as the --properties
+                            parameter: "key:val;key:val"
+
+  -c, --context <ctx>       Shorthand for '-p context:<ctx>'
+
+  -C, --excl-context <ctx>  Don't show issues from the given context(s).
+                            Multiple contexts can be excluded using a ',' to
+                            separate names. For example: -C ctx1,ctx2
+                            Shorthand for '-P context:<ctx>'
+
+  -g, --tags <tags>         Specify tags for an issue. Tags are specified as a
+                            comma-delimited list. For example: -g tag1,tag2
+
+  -G, --excl-tags <tags>    When used with the list command, exclude issues
+                            that contain any of the provided tags. Tags are
+                            specified as a comma-delimited list.
+                            For example: -G tag1,tag2
+
+  -T, --today               Limit to today's issues.
+
+  -F, --future              Limit to future issues.
+
+  -H, --show-hidden         Show all matching issues, ignoring any 'hide-until'
+                            properties set.
+
+  -m, --match <pattern>     Limit to issues whose summaries match the given
+                            pattern (PCRE regex supported).
+
+  -M, --match-all <pat>     Limit to the issues whose summaries or details
+                            match the given pattern (PCRE regex supported).
+
+  -v, --verbose             Show issue details when listing issues.
+
+  -q, --quiet               Suppress verbose output.
+
+  -y, --yes                 Automatically answer "yes" to any prompts.
+
+  --config <cfgFile>        Location of the config file (defaults to $HOME/.pitrc)
+
+  -E, --echo-args           Echo arguments (for debug purposes).
+
+  -d, --tasks-dir           Path to the tasks directory (defaults to the value
+                            configured in the .pitrc file)
+
+  --term-width <width>      Manually set the terminal width to use.
+
+  --ptk                     Enable PTK integration for this command.
+
+  --debug                   Enable debug-level log output.
+"""
+
+const ONLINE_HELP* = """Issue States:
+
+  PIT organizes issues around their state, which is one of:
+
+    current     - issues actively being worked
+    todo-today  - issues planned for today
+    pending     - issues that are blocked by some third-party
+    done        - issues that have been completely resolved
+    todo        - issues that need to be done in the future
+    dormant     - issues that are low-priority, to be tracked, but hidden
+                  by default
+
+Issue Properties:
+
+  PIT supports adding arbitrary properties to any issue to track any metadata
+  about the issue the user may wish. There are several properties that have
+  special behavior attached to them. They are:
+
+    created
+
+      If present, expected to be an ISO 8601-formatted date that represents the
+      time when the issue was created.
+
+    completed
+
+      If present, expected to be an ISO 8601-formatted date that represents the
+      time when the issue moved to the "done" state.  PIT will add this
+      property automatically when you use the "done" command, and can filter on
+      this value.
+
+    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.
+
+    delegated-to
+
+      When an issue now belongs to someone else, but needs to be monitored for
+      completion, this allows you to keep the issue in its current state but
+      note how it has been delegated. When present PIT will prepend this value
+      to the issue summary with an accent color.
+
+    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.
+
+    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.
+
+    recurrence
+
+      When an issue is moved to the "done" state, if the issue has a valid
+      "recurrence" property, PIT will create a new issue and set the
+      "hide-until" property for that new issue depending on the recurrence
+      definition.
+
+      A valid recurrence value has a time value and optionally has an source
+      issue ID. For example:
+
+        every 5 days, 10a544
+
+      The first word, "every", is expected to be either "every" or "after".
+
+      The second portion is expected to be a time period. Supported time units
+      are "hour", "day", "week", "month", an "year", along with the plural
+      forms (e.g. "5 days", "8 hours", etc.).
+
+      The final portion is the source issue ID. This is optional. When a source
+      issue ID is given, the new issue is created as a clone of the given
+      issue. When not given, the issue being closed is used for cloning.
+
+      The "every" and "after" keywords allow the user to choose whether the new
+      issue is created based on the creation time ("every") or the completion
+      time ("after") of the issue being closed based.
+
+      Examples:
+
+        every day
+        every 2 days
+        after 2 days
+        every week
+        after 12 hours
+        every 2 weeks, 10a544
+
+    tags
+
+      If present, expected to be a comma-delimited list of text tags. The -g
+      option is a short-hand for '-p tags:<tags-value>'.
+"""
--- a/src/pitpkg/private/libpit.nim
+++ b/src/pitpkg/private/libpit.nim
@ -1,5 +1,6 @@
-import cliutils, docopt, json, logging, langutils, options, os,
-  sequtils, strformat, strutils, tables, times, timeutils, uuids
+import std/json, std/logging, std/options, std/os, std/sequtils, std/strformat,
+  std/strutils, std/tables, std/times
+import cliutils, docopt, langutils, timeutils, uuids

 import nre except toSeq

@ -23,7 +24,9 @@ type
    completedRange*: Option[tuple[b, e: DateTime]]
    fullMatch*, summaryMatch*: Option[Regex]
    hasTags*: seq[string]
+    exclTags*: seq[string]
    properties*: TableRef[string, string]
+    exclProperties*: TableRef[string, seq[string]]

  PitConfig* = ref object
    tasksDir*: string
@ -114,7 +117,9 @@ proc initFilter*(): IssueFilter =
    fullMatch: none(Regex),
    summaryMatch: none(Regex),
    hasTags: @[],
-    properties: newTable[string, string]())
+    exclTags: @[],
+    properties: newTable[string, string](),
+    exclProperties: newTable[string,seq[string]]())

 proc propsFilter*(props: TableRef[string, string]): IssueFilter =
  if isNil(props):
@ -301,6 +306,13 @@ proc loadIssues*(path: string): seq[Issue] =
  # Finally, save current order
  result.storeOrder(path)

+proc loadIssues*(tasksDir: string, state: IssueState): seq[Issue] =
+  loadIssues(tasksDir / $state)
+
+proc loadAllIssues*(tasksDir: string): TableRef[IssueState, seq[Issue]] =
+  result = newTable[IssueState, seq[Issue]]()
+  for state in IssueState: result[state] = tasksDir.loadIssues(state)
+
 proc changeState*(issue: Issue, tasksDir: string, newState: IssueState) =
  let oldFilepath = issue.filepath
  if newState == Done: issue.setDateTime("completed", getTime().local)
@ -315,8 +327,8 @@ proc nextRecurrence*(tasksDir: string, rec: Recurrence, defaultIssue: Issue): Is

  let newProps = newTable[string,string]()
  for k, v in baseIssue.properties:
-    if k != "created" and k != "completed":
-      newProps[k] = v
+    if k != "completed": newProps[k] = v
+  newProps["prev-recurrence"] = $baseIssue.id

  result = Issue(
    id: genUUID(),
@ -347,6 +359,12 @@ proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
  for k,v in filter.properties:
    result = result.filterIt(it.hasProp(k) and it[k] == v)

+  for k,v in filter.exclProperties:
+    result = result.filter(proc (iss: Issue): bool =
+      not iss.hasProp(k) or
+      not v.anyIt(it == iss[k])
+    )
+
  if filter.completedRange.isSome:
    let range = filter.completedRange.get
    result = result.filterIt(
@ -364,6 +382,17 @@ proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
  for tag in filter.hasTags:
    result = result.filterIt(it.tags.find(tag) >= 0)

+  for exclTag in filter.exclTags:
+    result = result.filterIt(it.tags.find(exclTag) < 0)
+
+proc find*(
+    issues: TableRef[IssueState, seq[Issue]],
+    filter: IssueFilter
+  ): seq[Issue] =
+
+  result = @[]
+  for stateIssues in issues.values: result &= stateIssues.filter(filter)
+
 ### Configuration utilities
 proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitConfig =
  let pitrcLocations = @[
--- a/src/pitpkg/version.nim
+++ b/src/pitpkg/version.nim
@ -1 +0,0 @@
-const PIT_VERSION* = "4.16.0"
--- a/src/usage.txt
+++ b/src/usage.txt
@ -1,57 +0,0 @@
-Usage:
-  pit ( new | add) <summary> [<state>] [options]
-  pit list contexts [options]
-  pit list [<stateOrId>...] [options]
-  pit ( start | done | pending | todo-today | todo | suspend ) <id>... [options]
-  pit edit <ref>... [options]
-  pit tag <id>... [options]
-  pit untag <id>... [options]
-  pit reorder <state> [options]
-  pit delegate <id> <delegated-to>
-  pit hide-until <id> <date> [options]
-  pit ( delete | rm ) <id>... [options]
-  pit add-binary-property <id> <propName> <propSource> [options]
-  pit get-binary-property <id> <propName> <propDest> [options]
-  pit help
-
-Options:
-
-  -h, --help                Print this usage and help information.
-
-  -p, --properties <props>  Specify properties. Formatted as "key:val;key:val"
-                            When used with the list command this option applies
-                            a filter to the issues listed, only allowing those
-                            which have all of the given properties.
-
-  -c, --context <ctxName>   Shorthand for '-p context:<ctxName>'
-
-  -g, --tags <tags>         Specify tags for an issue.
-
-  -T, --today               Limit to today's issues.
-
-  -F, --future              Limit to future issues.
-
-  -m, --match <pattern>     Limit to issues whose summaries match the given
-                            pattern (PCRE regex supported).
-
-  -M, --match-all <pat>     Limit to the issues whose summaries or details
-                            match the given pattern (PCRE regex supported).
-
-  -v, --verbose             Show issue details when listing issues.
-
-  -q, --quiet               Suppress verbose output.
-
-  -y, --yes                 Automatically answer "yes" to any prompts.
-
-  -C, --config <cfgFile>    Location of the config file (defaults to $HOME/.pitrc)
-
-  -E, --echo-args           Echo arguments (for debug purposes).
-
-  -d, --tasks-dir           Path to the tasks directory (defaults to the value
-                            configured in the .pitrc file)
-
-  --term-width <width>      Manually set the terminal width to use.
-
-  --ptk                     Enable PTK integration for this command.
-
-  --debug                   Enable debug-level log output.
Author	SHA1	Message	Date
Jonathan Bernard	d01d6e37f4	Update timeutils version to include support for the shorter ISO8601 date format.	2023-02-28 23:29:06 -06:00
Jonathan Bernard	b98596574d	Add find utility method for searching for issues among multiple issue states.	2023-02-17 12:12:13 -06:00
Jonathan Bernard	ea9f8ea7ac	Move issue loading logic into the publicly-exposed library methods.	2023-02-16 11:07:09 -06:00
Jonathan Bernard	ae4a943e82	Allow access to pit functionality as a Nim libaray.	2023-02-16 09:07:02 -06:00
Jonathan Bernard	58a5321d95	Rework dependencies using JDB Softwar package repo instead of URLs.	2023-02-13 08:48:40 -06:00
Jonathan Bernard	7215b4969b	Re-design output to make skimming easier. - We now always protect the left margin when printing task details (including tags) to make it easier to skim down that line. - Also made the actual summary always follow immediately after the ID, to align to that skimmable line. - Moved the information about the delegatee to the end of the summary, next to the tags, and changed the color of the delegatee to make it easier to distinguish. - Added the `-G` option, to allow filtering out issues matching any of the provided tags. - We now allow options to be passed to both the `delegate` and `help` command. Any options are ignored, but this allows the use of tools like `cmd_shell` which always wrap commands with the pre-given options.	2022-07-31 20:01:39 -05:00
Jonathan Bernard	c7891de310	Show Pending in either Today's list of the Future list, but not both at the same time.	2022-07-28 10:48:51 -05:00
Jonathan Bernard	a373af0658	Add support for filtering based on property exclusion. For example, allow commands like: # exclude issues from context "abc" pit list -C abc # exclude issues delegated to John Doe pit list -P "delgated-to:John Doe"	2022-07-22 10:39:13 -05:00
Jonathan Bernard	de3ee05680	Change logging format.	2022-01-22 10:31:58 -06:00
Jonathan Bernard	59440d2c9d	Remove unused, old copies of usage and outline text.	2022-01-21 15:01:07 -06:00
Jonathan Bernard	6226ff21c5	Fix compile-time message includes when installing via Nimble.	2022-01-21 14:59:22 -06:00
Jonathan Bernard	71e035fdbe	Add --show-hidden to ignore hide-until properties.	2022-01-04 22:27:08 -06:00
Jonathan Bernard	df854f864c	When completing an issue, print info about any new issue created by recurrence.	2021-09-21 10:14:49 -05:00