na 1.1.21 → 1.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0430897c007446c9ad1a1e3463ddc3d8e192a43e8d60a46a9669745086ea45f3'
-  data.tar.gz: e33799f49bbaf623d188c64f549e71dcea41b317b95b3b5d0f72f8a378a3f9fd
+  metadata.gz: c8bee2cada1590cdc80fe9943947c719649d441ed15a6c51228fa0bebe4e94eb
+  data.tar.gz: 3dfc5a53bb88952243388b86e853af744b76938cbc69ef3b6f6ac8e58c03a9fc
 SHA512:
-  metadata.gz: d8c9a03b08abf20cb826e452ad75478b0f58dc0309ce51bee29e3b31b6c37de8e99cdd22926aef1ffe10183b151b54b6047196ce5c8987c32b0fa013942d5673
-  data.tar.gz: 7bb18376e8b53aa2c283206058c48dce786576d3a50d6e9567a0958011cab7f2f7203fecf0142cc49f3d5abc49a0342a4a3c20ff19318f79ac2d26ca00af206b
+  metadata.gz: 0603c3187363e3c5895f9e49af6deab11779cbf47442f4f76b7b5ad2608e4676d0cb337368e2a0d6a5f9bad7f5aff957d63e986cefe1997c671a6b6b5193e3e4
+  data.tar.gz: e570fe4a32d7e45b4bd2171c73bee68adb6017ae22901c92486ccbe1bdb2461a50dac988d8ed862aa85237c070ebb305d3b6c2c61afc920826568c628d630faf

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+### 1.1.23
+
+2022-10-07 10:02
+
+#### NEW
+
+- Saved searches. Add `--save TITLE` to `tagged` or `find` commands to save the parameters for use with `na saved TITLE`
+
+#### FIXED
+
+- Restore wildcard capability of tag searches
+
+### 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.23)
       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.23
 .
 
 `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.23
 
 GLOBAL OPTIONS
     -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
@@ -82,6 +82,7 @@ COMMANDS
     initconfig   - Initialize the config file using current global options
     next, show   - Show next actions
     prompt       - Show or install prompt hooks for the current shell
+    saved        - Execute a saved search
     tagged       - Find actions matching a tag
     todos        - Show list of known todo files
 ```
@@ -171,9 +172,10 @@ 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)
+    --save=TITLE                           - Save this search for future use (default: none)
     -v, --invert                           - Show actions not matching search pattern
     -x, --exact                            - Match pattern exactly
 
@@ -209,9 +211,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 +224,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 +258,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]
 
@@ -265,7 +271,16 @@ class App
     c.desc 'Show actions not matching search pattern'
     c.switch %i[v invert], negatable: false
 
+    c.desc 'Save this search for future use'
+    c.arg_name 'TITLE'
+    c.flag %i[save]
+
     c.action do |global_options, options, args|
+      if options[:save]
+        title = options[:save].gsub(/[^a-z0-9]/, '_').gsub(/_+/, '_')
+        NA.save_search(title, "find #{NA.command_line.map { |c| "\"#{c}\"" }.join(' ')}")
+      end
+
       depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
                 3
               else
@@ -292,10 +307,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 +354,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]
 
@@ -349,7 +368,16 @@ class App
     c.desc 'Show actions not matching tags'
     c.switch %i[v invert], negatable: false
 
+    c.desc 'Save this search for future use'
+    c.arg_name 'TITLE'
+    c.flag %i[save]
+
     c.action do |global_options, options, args|
+      if options[:save]
+        title = options[:save].gsub(/[^a-z0-9]/, '_').gsub(/_+/, '_')
+        NA.save_search(title, "tagged #{NA.command_line.map { |cmd| "\"#{cmd}\"" }.join(' ')}")
+      end
+
       depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
                 3
               else
@@ -361,9 +389,10 @@ class App
       all_req = args.join(' ') !~ /[+!\-]/ && !options[:or]
       args.join(',').split(/ *, */).each do |arg|
         # TODO: <> comparisons do nothing right now
-        m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>*$\^]+)(?:(?<op>[=<>*$\^]+)(?<val>.*?))?$/)
+        m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>$\^]+?)(?:(?<op>[=<>]{1,2}|[*$\^]=)(?<val>.*?))?$/)
+
         tags.push({
-                    tag: m['tag'],
+                    tag: m['tag'].wildcard_to_rx,
                     comp: m['op'],
                     value: m['val'],
                     required: all_req || (!m['req'].nil? && m['req'] == '+'),
@@ -373,10 +402,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 +502,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
 
@@ -529,6 +564,26 @@ class App
     end
   end
 
+  desc 'Execute a saved search'
+  long_desc 'Run without argument to list saved searches'
+  arg_name 'SEARCH_TITLE', optional: true
+  command %i[saved] do |c|
+    c.action do |_global_options, _options, args|
+      searches = NA.load_searches
+      if args.empty?
+        NA.notify("{bg}Saved searches stored in {bw}#{NA.database_path(file: 'saved_searches.yml')}")
+        NA.notify(searches.map { |k, v| "{y}#{k}: {w}#{v}" }.join("\n"), exit_code: 0)
+      else
+        keys = searches.keys.delete_if { |k| k !~ /#{args[0]}/ }
+        NA.notify("{r}Search #{args[0]} not found", exit_code: 1) if keys.empty?
+
+        key = keys[0]
+        cmd = Shellwords.shellsplit(searches[key])
+        exit run(cmd)
+      end
+    end
+  end
+
   pre do |global, _command, _options, _args|
     NA.verbose = global[:debug]
     NA.extension = global[:ext]
@@ -558,6 +613,7 @@ class App
   end
 end
 
+NA.command_line = ARGV
 @command = ARGV[0]
 $first_arg = ARGV[1]
 

data/lib/na/action.rb

@@ -127,11 +127,14 @@ module NA
     end
 
     def compare_tag(tag)
-      return false unless @tags.key?(tag[:tag])
+      keys = @tags.keys.delete_if { |k| k !~ Regexp.new(tag[:tag], Regexp::IGNORECASE) }
+      return false if keys.empty?
+
+      key = keys[0]
 
       return true if tag[:comp].nil?
 
-      tag_val = @tags[tag[:tag]]
+      tag_val = @tags[key]
       val = tag[:value]
 
       return false if tag_val.nil?

data/lib/na/next_action.rb

@@ -3,7 +3,7 @@
 # Next Action methods
 module NA
   class << self
-    attr_accessor :verbose, :extension, :na_tag
+    attr_accessor :verbose, :extension, :na_tag, :command_line
 
     ##
     ## Output to STDERR
@@ -15,11 +15,57 @@ module NA
       return if debug && !@verbose
 
       $stderr.puts NA::Color.template("{x}#{msg}{x}")
-      if exit_code && exit_code.is_a?(Number)
+      if exit_code
         Process.exit exit_code
       end
     end
 
+    ##
+    ## Display and read a Yes/No prompt
+    ##
+    ## @param      prompt   [String] The prompt string
+    ## @param      default  [Boolean] default value if
+    ##                      return is pressed or prompt is
+    ##                      skipped
+    ##
+    ## @return     [Boolean] result
+    ##
+    def yn(prompt, default: true)
+      return default unless $stdout.isatty
+
+      tty_state = `stty -g`
+      system 'stty raw -echo cbreak isig'
+      yn = color_single_options(default ? %w[Y n] : %w[y N])
+      $stdout.syswrite "\e[1;37m#{prompt} #{yn}\e[1;37m? \e[0m"
+      res = $stdin.sysread 1
+      res.chomp!
+      puts
+      system 'stty cooked'
+      system "stty #{tty_state}"
+      res.empty? ? default : res =~ /y/i
+    end
+
+    ##
+    ## Helper function to colorize the Y/N prompt
+    ##
+    ## @param      choices  [Array] The choices with
+    ##                      default capitalized
+    ##
+    ## @return     [String] colorized string
+    ##
+    def color_single_options(choices = %w[y n])
+      out = []
+      choices.each do |choice|
+        case choice
+        when /[A-Z]/
+          out.push(NA::Color.template("{bw}#{choice}{x}"))
+        else
+          out.push(NA::Color.template("{dw}#{choice}{xg}"))
+        end
+      end
+      NA::Color.template("{xg}[#{out.join('/')}{xg}]{x}")
+    end
+
     ##
     ## Create a new todo file
     ##
@@ -308,6 +354,50 @@ module NA
       puts NA::Color.template(dirs.join("\n"))
     end
 
+    def save_search(title, search)
+      file = database_path(file: 'saved_searches.yml')
+      searches = load_searches
+      title = title.gsub(/[^a-z0-9]/, '_').gsub(/_+/, '_')
+
+      if searches.key?(title)
+        res = yn('Overwrite existing definition?', default: true)
+        notify('{r}Cancelled', exit_code: 0) unless res
+
+      end
+
+      searches[title] = search
+      File.open(file, 'w') { |f| f.puts(YAML.dump(searches)) }
+      NA.notify("{y}Search #{title} saved", exit_code: 0)
+    end
+
+    def load_searches
+      file = database_path(file: 'saved_searches.yml')
+      if File.exist?(file)
+        searches = YAML.safe_load(IO.read(file))
+      else
+        searches = {
+          'soon' => 'tagged "due<in 2 days,due>yesterday"',
+          'overdue' => 'tagged "due<now"',
+          'high' => 'tagged "prio>3"',
+          'maybe' => 'tagged "maybe"'
+        }
+        File.open(file, 'w') { |f| f.puts(YAML.dump(searches)) }
+      end
+      searches
+    end
+
+    ##
+    ## Get path to database of known todo files
+    ##
+    ## @return     [String] File path
+    ##
+    def database_path(file: 'tdlist.txt')
+      db_dir = File.expand_path('~/.local/share/na')
+      # Create directory if needed
+      FileUtils.mkdir_p(db_dir) unless File.directory?(db_dir)
+      File.join(db_dir, file)
+    end
+
     private
 
     ##
@@ -356,19 +446,6 @@ module NA
       [optional, required, negated]
     end
 
-    ##
-    ## Get path to database of known todo files
-    ##
-    ## @return     [String] File path
-    ##
-    def database_path
-      db_dir = File.expand_path('~/.local/share/na')
-      # Create directory if needed
-      FileUtils.mkdir_p(db_dir) unless File.directory?(db_dir)
-      db_file = 'tdlist.txt'
-      File.join(db_dir, db_file)
-    end
-
     ##
     ## Find a matching path using semi-fuzzy matching.
     ## Search tokens can include ! and + to negate or make
@@ -379,18 +456,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,14 +100,25 @@ 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(/\?/, '.')
+    gsub(/\./, '\\.').gsub(/\?/, '.').gsub(/\*/, '[^ ]*?')
   end
 
   def cap_first!
     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.23'
 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.22<!--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.23
 platform: ruby
 authors:
 - Brett Terpstra