na 1.1.21 → 1.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0430897c007446c9ad1a1e3463ddc3d8e192a43e8d60a46a9669745086ea45f3'
-  data.tar.gz: e33799f49bbaf623d188c64f549e71dcea41b317b95b3b5d0f72f8a378a3f9fd
+  metadata.gz: 584d55c84c26fddeb65bf537b4743b5cac4308f39d796d336d95c900fc966deb
+  data.tar.gz: 73ea4289a1e43ce0b67f66f803a0db07359fe3f077358328a58c172c06daa107
 SHA512:
-  metadata.gz: d8c9a03b08abf20cb826e452ad75478b0f58dc0309ce51bee29e3b31b6c37de8e99cdd22926aef1ffe10183b151b54b6047196ce5c8987c32b0fa013942d5673
-  data.tar.gz: 7bb18376e8b53aa2c283206058c48dce786576d3a50d6e9567a0958011cab7f2f7203fecf0142cc49f3d5abc49a0342a4a3c20ff19318f79ac2d26ca00af206b
+  metadata.gz: 89945d2a8df1c1ea11360da4258c09f9b5c8ad38f41ca5ef98a68b99c33b41fb0b718919cc680eb356903f284cef8dd4271acea94af7f8c4adca031d445a6a26
+  data.tar.gz: 7c3f8c30bf5a4c69270641aadfb036303c42ee8678a09c2e8b5faad7883aff0ac0139caf465f9d37b84cf170ed4ee072ad20d4872b8c760b97d0e2ca1f3b6e2e

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+### 1.1.22
+
+2022-10-07 05:58
+
+#### IMPROVED
+
+- Help output and code documentation
+- Allow wildcards (* and ?) when matching todo history
+- Allow multiple todo queries separated by comma
+
+#### FIXED
+
+- Remove file extension when matching todo history
+- Todo history query failed on exact match
+
 ### 1.1.21
 
 2022-10-07 04:26

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.1.21)
+    na (1.1.22)
       chronic (~> 0.10, >= 0.10.2)
       gli (~> 2.21.0)
       tty-reader (~> 0.9, >= 0.9.0)

data/README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is 1.1.21
+The current version of `na` is 1.1.22
 .
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
@@ -59,7 +59,7 @@ SYNOPSIS
     na [global options] command [command options] [arguments...]
 
 VERSION
-    1.1.21
+    1.1.22
 
 GLOBAL OPTIONS
     -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
@@ -171,7 +171,7 @@ DESCRIPTION
 COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: none)
     -e, --regex                            - Interpret search pattern as regular expression
-    --in=TODO_PATH                         - Show actions from a specific todo file in history (default: none)
+    --in=TODO_PATH                         - Show actions from a specific todo file in history. May use wildcards (* and ?) (default: none)
     -o, --or                               - Combine search tokens with OR, displaying actions matching ANY of the terms
     --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
     -v, --invert                           - Show actions not matching search pattern
@@ -209,9 +209,9 @@ EXAMPLES
 
 Examples:
 
-- `na show` (list all next actions in the current directory)
-- `na show -d 3` (list all next actions in the current directory and look for additional files 3 levels deep from there)
-- `na show marked2` (show next actions from another directory you've previously used na on)
+- `na next` (list all next actions in the current directory)
+- `na next -d 3` (list all next actions in the current directory and look for additional files 3 levels deep from there)
+- `na next marked2` (show next actions from another directory you've previously used na on)
 
 ```
 NAME
@@ -222,7 +222,7 @@ SYNOPSIS
     na [global options] next [command options] [QUERY]
 
 DESCRIPTION
-    Next actions are actions which contain the next action tag (default @na),   do not contain @done, and are not in the Archive project. 
+    Next actions are actions which contain the next action tag (default @na),   do not contain @done, and are not in the Archive project.   Arguments will target a todo file from history, whether it's in the current   directory or not. Todo file queries can include path components separated by /   or :, and may use wildcards (`*` to match any text, `?` to match a single character). Multiple queries allowed (separate arguments or separated by comma). 
 
 COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: 2)
@@ -256,7 +256,7 @@ SYNOPSIS
     na [global options] next [command options] [QUERY]
 
 DESCRIPTION
-    Next actions are actions which contain the next action tag (default @na),   do not contain @done, and are not in the Archive project. 
+    Next actions are actions which contain the next action tag (default @na),   do not contain @done, and are not in the Archive project.   Arguments will target a todo file from history, whether it's in the current   directory or not. Todo file queries can include path components separated by /   or :, and may use wildcards (`*` to match any text, `?` to match a single character). Multiple queries allowed (separate arguments or separated by comma). 
 
 COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: 2)

data/bin/na

@@ -54,8 +54,12 @@ class App
   switch %i[debug]
 
   desc 'Show next actions'
-  long_desc "Next actions are actions which contain the next action tag (default @na),
-  do not contain @done, and are not in the Archive project."
+  long_desc 'Next actions are actions which contain the next action tag (default @na),
+  do not contain @done, and are not in the Archive project.
+
+  Arguments will target a todo file from history, whether it\'s in the current
+  directory or not. Todo file queries can include path components separated by /
+  or :, and may use wildcards (`*` to match any text, `?` to match a single character). Multiple queries allowed (separate arguments or separated by comma).'
   arg_name 'QUERY', optional: true
   command %i[next show] do |c|
     c.example 'na next', desc: 'display the next actions from any todo files in the current directory'
@@ -93,11 +97,13 @@ class App
       if args.count.positive?
         tokens = []
         args.each do |arg|
-          m = arg.match(/^(?<req>\+)?(?<tok>.*?)$/)
-          tokens.push({
-                        token: m['tok'],
-                        required: !m['req'].nil?
-                      })
+          arg.split(/ *, */).each do |a|
+            m = a.match(/^(?<req>\+)?(?<tok>.*?)$/)
+            tokens.push({
+                          token: m['tok'],
+                          required: !m['req'].nil?
+                        })
+          end
         end
       end
 
@@ -251,7 +257,7 @@ class App
     c.arg_name 'DEPTH'
     c.flag %i[d depth], type: :integer, must_match: /^\d+$/
 
-    c.desc 'Show actions from a specific todo file in history'
+    c.desc 'Show actions from a specific todo file in history. May use wildcards (* and ?)'
     c.arg_name 'TODO_PATH'
     c.flag %i[in]
 
@@ -292,10 +298,14 @@ class App
 
       todo = nil
       if options[:in]
-        todo = [{
-          token: options[:in],
-          required: true
-        }]
+        todo = []
+        options[:in].split(/ *, */).each do |a|
+          m = a.match(/^(?<req>\+)?(?<tok>.*?)$/)
+          todo.push({
+                        token: m['tok'],
+                        required: !m['req'].nil?
+                      })
+        end
       end
 
       files, actions = NA.parse_actions(depth: depth,
@@ -335,7 +345,7 @@ class App
     c.default_value 1
     c.flag %i[d depth], type: :integer, must_match: /^\d+$/
 
-    c.desc 'Show actions from a specific todo file in history'
+    c.desc 'Show actions from a specific todo file in history. May use wildcards (* and ?)'
     c.arg_name 'TODO_PATH'
     c.flag %i[in]
 
@@ -373,10 +383,14 @@ class App
 
       todo = nil
       if options[:in]
-        todo = [{
-          token: options[:in],
-          required: true
-        }]
+        todo = []
+        options[:in].split(/ *, */).each do |a|
+          m = a.match(/^(?<req>\+)?(?<tok>.*?)$/)
+          todo.push({
+                        token: m['tok'],
+                        required: !m['req'].nil?
+                      })
+        end
       end
 
       files, actions = NA.parse_actions(depth: depth,
@@ -469,11 +483,13 @@ class App
       if args.count.positive?
         tokens = []
         args.each do |arg|
-          m = arg.match(/^(?<req>\+)?(?<tok>.*?)$/)
-          tokens.push({
-                        token: m['tok'],
-                        required: !m['req'].nil?
-                      })
+          arg.split(/ *, */).each do |a|
+            m = a.match(/^(?<req>\+)?(?<tok>.*?)$/)
+            tokens.push({
+                          token: m['tok'],
+                          required: !m['req'].nil?
+                        })
+          end
         end
       end
 

data/lib/na/next_action.rb

@@ -379,18 +379,18 @@ module NA
     ##                       between characters
     ##
     def match_working_dir(search, distance: 1)
-      search = search.map { |t| t[:token] }.join('/')
-      optional = [search]
-      required = [search]
-
       file = database_path
       notify('{r}No na database found', exit_code: 1) unless File.exist?(file)
 
       dirs = IO.read(file).split("\n")
 
-      NA.notify("{bw}Directory regex: {x}#{required.map(&:dir_to_rx)}", debug: true)
+      optional = search.map { |t| t[:token] }
+      required = search.filter { |s| s[:required] }.map { |t| t[:token] }
+
+      NA.notify("{bw}Optional directory regex: {x}#{optional.map(&:dir_to_rx)}", debug: true)
+      NA.notify("{bw}Required directory regex: {x}#{required.map(&:dir_to_rx)}", debug: true)
 
-      dirs.delete_if { |d| !d.dir_matches(any: optional, all: required) }
+      dirs.delete_if { |d| !d.sub(/\.#{NA.extension}$/, '').dir_matches(any: optional, all: required) }
       dirs.sort.uniq
     end
 

data/lib/na/string.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
+# String helpers
 class ::String
+  ##
+  ## Determine indentation level of line
+  ##
+  ## @return     [Number] number of indents detected
+  ##
   def indent_level
     prefix = match(/(^[ \t]+)/)
     return 0 if prefix.nil?
@@ -11,7 +17,13 @@ class ::String
   ##
   ## Colorize @tags with ANSI escapes
   ##
-  ## @param      color  [String] color (see #Color)
+  ## @param      color       [String] color (see #Color)
+  ## @param      value       [String] The value color
+  ##                         template
+  ## @param      parens      [String] The parens color
+  ##                         template
+  ## @param      last_color  [String] Color to restore after
+  ##                         tag highlight
   ##
   ## @return     [String] string with @tags highlighted
   ##
@@ -23,6 +35,16 @@ class ::String
          "\\1#{tag_color}\\2#{paren_color}\\3#{value_color}\\4#{paren_color}\\5#{last_color}")
   end
 
+  ##
+  ## Highlight search results
+  ##
+  ## @param      regexes     [Array] The regexes for the
+  ##                         search
+  ## @param      color       [String] The highlight color
+  ##                         template
+  ## @param      last_color  [String] Color to restore after
+  ##                         highlight
+  ##
   def highlight_search(regexes, color: '{y}', last_color: '{xg}')
     string = dup
     color = NA::Color.template(color)
@@ -42,12 +64,13 @@ class ::String
 
   # Returns the last escape sequence from a string.
   #
-  # Actually returns all escape codes, with the assumption
-  # that the result of inserting them will generate the
-  # same color as was set at the end of the string.
-  # Because you can send modifiers like dark and bold
-  # separate from color codes, only using the last code
-  # may not render the same style.
+  # @note       Actually returns all escape codes, with the
+  #             assumption that the result of inserting them
+  #             will generate the same color as was set at
+  #             the end of the string. Because you can send
+  #             modifiers like dark and bold separate from
+  #             color codes, only using the last code may
+  #             not render the same style.
   #
   # @return     [String]  All escape codes in string
   #
@@ -55,8 +78,18 @@ class ::String
     scan(/\e\[[\d;]+m/).join('').gsub(/\e\[0m/, '')
   end
 
+  ##
+  ## Convert a directory path to a regular expression
+  ##
+  ## @note       Splits at / or :, adds variable distance
+  ##             between characters, joins segments with
+  ##             slashes and requires that last segment
+  ##             match last segment of target path
+  ##
+  ## @param      distance  The distance
+  ##
   def dir_to_rx(distance: 2)
-    "#{split(%r{[/:]}).map { |comp| comp.split('').join(".{0,#{distance}}") }.join('.*?/.*?')}[^/]+$"
+    "#{split(%r{[/:]}).map { |comp| comp.split('').join(".{0,#{distance}}").gsub(/\*/, '[^ ]*?') }.join('.*?/.*?')}[^/]*?$"
   end
 
   def dir_matches(any: [], all: [])
@@ -67,6 +100,11 @@ class ::String
     matches_any(any) && matches_all(all) && matches_none(none)
   end
 
+  ##
+  ## Convert wildcard characters to regular expressions
+  ##
+  ## @return     [String] Regex string
+  ##
   def wildcard_to_rx
     gsub(/\./, '\\.').gsub(/\*/, '[^ ]*?').gsub(/\?/, '.')
   end
@@ -75,6 +113,12 @@ class ::String
     replace cap_first
   end
 
+  ##
+  ## Capitalize first character, leaving other
+  ## capitalization in place
+  ##
+  ## @return     [String] capitalized string
+  ##
   def cap_first
     sub(/^([a-z])(.*)$/) do
       m = Regexp.last_match

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.1.21'
+  VERSION = '1.1.22'
 end

data/src/README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is <!--VER-->1.1.20<!--END VER-->.
+The current version of `na` is <!--VER-->1.1.21<!--END VER-->.
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
 
@@ -92,9 +92,9 @@ Unless `--exact` is specified, search is tokenized and combined with AND, so `na
 
 Examples:
 
-- `na show` (list all next actions in the current directory)
-- `na show -d 3` (list all next actions in the current directory and look for additional files 3 levels deep from there)
-- `na show marked2` (show next actions from another directory you've previously used na on)
+- `na next` (list all next actions in the current directory)
+- `na next -d 3` (list all next actions in the current directory and look for additional files 3 levels deep from there)
+- `na next marked2` (show next actions from another directory you've previously used na on)
 
 ```
 @cli(bundle exec bin/na help next)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.1.21
+  version: 1.1.22
 platform: ruby
 authors:
 - Brett Terpstra