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"

pit.nimble

@@ -1,6 +1,6 @@
 # Package
 
-version       = "4.17.0"
+version       = "4.19.0"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"
@@ -19,8 +19,8 @@ requires @[
   "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"
+  "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'"

src/pit.nim

@@ -7,10 +7,9 @@ import algorithm, cliutils, data_uri, docopt, json, logging, options, os,
 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
@@ -168,6 +167,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
 
@@ -200,7 +209,13 @@ 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
@@ -237,7 +252,12 @@ 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:
@@ -246,6 +266,7 @@ proc list(ctx: CliContext, filter: Option[IssueFilter], states: Option[seq[Issue
     for s in [Pending, Todo]:
       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))
 
@@ -255,16 +276,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
@@ -272,8 +291,8 @@ when isMainModule:
   if args["--echo-args"]: stderr.writeLine($args)
 
   if args["help"]:
-    stderr.writeLine(usage & "\n")
-    stderr.writeLine(onlineHelp)
+    stderr.writeLine(USAGE & "\n")
+    stderr.writeLine(ONLINE_HELP)
     quit()
 
   let ctx = initContext(args)
@@ -281,6 +300,7 @@ when isMainModule:
   trace "context initiated"
 
   var propertiesOption = none(TableRef[string,string])
+  var exclPropsOption = none(TableRef[string,seq[string]])
   var tagsOption = none(seq[string])
 
   if args["--properties"] or args["--context"]:
@@ -293,6 +313,20 @@ 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))
 
   ## Actual command runners
@@ -440,6 +474,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"]))
@@ -464,6 +503,7 @@ when isMainModule:
        filter.properties["context"] == "all":
 
       filter.properties.del("context")
+      filter.exclProperties.del("context")
 
     var listContexts = false
     var statesOption = none(seq[IssueState])
@@ -501,9 +541,13 @@ when isMainModule:
     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>"]))

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)."
 

src/pitpkg/cliconstants.nim

@@ -1,4 +1,79 @@
-Issue States:
+const PIT_VERSION* = "4.19.0"
+
+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>
+  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.
+
+  -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.
+
+  -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:
 
@@ -91,3 +166,4 @@ Issue Properties:
 
       If present, expected to be a comma-delimited list of text tags. The -g
       option is a short-hand for '-p tags:<tags-value>'.
+"""

src/pitpkg/private/libpit.nim

@@ -24,6 +24,7 @@ type
     fullMatch*, summaryMatch*: Option[Regex]
     hasTags*: seq[string]
     properties*: TableRef[string, string]
+    exclProperties*: TableRef[string, seq[string]]
 
   PitConfig* = ref object
     tasksDir*: string
@@ -114,7 +115,8 @@ proc initFilter*(): IssueFilter =
     fullMatch: none(Regex),
     summaryMatch: none(Regex),
     hasTags: @[],
-    properties: newTable[string, string]())
+    properties: newTable[string, string](),
+    exclProperties: newTable[string,seq[string]]())
 
 proc propsFilter*(props: TableRef[string, string]): IssueFilter =
   if isNil(props):
@@ -347,6 +349,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(

src/pitpkg/version.nim

@@ -1 +0,0 @@
-const PIT_VERSION* = "4.17.0"

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.