na 1.2.33 → 1.2.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77588ce09a5a3cfc680b1866081dba5f56e75c8b51301cf0e1efee60c32f8f7
-  data.tar.gz: 06d73082ad5371cda4760df90c929c74963d76843b7b979dde59e46fdb933389
+  metadata.gz: 1f8982f5720115576a78ab96a430d1d83f501bb1b477b2cff1a694648a186afc
+  data.tar.gz: 86dd520a3265473471b6d09fc05136dd07b53ded24ab2c82936074fa50595b67
 SHA512:
-  metadata.gz: 07ee85d5f2f95ba2542ff15ca3b6c3736bd85d4a5b1bd9c76a7099296b3976d9b0e2478d6e2b8b84a824787c9fc05050b89153c316b7878c9743e3cd4cad3a8a
-  data.tar.gz: 0af252e545f390a539279747f7d89e87b5efaceb82db3adfa57ce037cd6e4b139e18aa2d90340dec14d9eb90f78c3b8963c5f7e92d59258f1711ea1dbb76462c
+  metadata.gz: 7ea9bb861c82251c1ec52925d6527f0e4efa1eef0175d268b8a8bb307fafcc407dc888e5e5cd6d588e5e4a500a96ae64765106f23d9c4acda6e0667c71247d62
+  data.tar.gz: e5f603160851411f66dd50ae47a65369aaa1e51352cf2eb6313674d95d64db8914d3a870f816dcc4303fbd5b4e675f213020fa6a7fd93805af4692f04eb99aed

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+### 1.2.35
+
+2023-08-30 11:59
+
+#### IMPROVED
+
+- If a search string contains @tags and --exact or --regex isn't specified, the @tags will be extracted and passed as a --tagged search.
+- Tag handling (including values and comparisons) in tags extracted from search strings
+- `na complete --project PROJ` flag to move to a specific project
+- `na restore --project PROJ` flag to move restored action to
+- Exit gracefully if tagged command is run with invalid
+- Display action affected when using update command
+
+#### FIXED
+
+- Escape search for tokens to allow parenthesis and other
+
+### 1.2.34
+
+2023-08-30 09:22
+
+#### NEW
+
+- `na restore SEARCH` to remove @done tag from result(s) (aliased as `unfinish`)
+
 ### 1.2.33
 
 2023-08-29 13:45

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.2.33)
+    na (1.2.35)
       chronic (~> 0.10, >= 0.10.2)
       gli (~> 2.21.0)
       mdless (~> 1.0, >= 1.0.32)

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.2.33
+The current version of `na` is 1.2.35
 .
 
 `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. 
@@ -77,7 +77,7 @@ SYNOPSIS
     na [global options] command [command options] [arguments...]
 
 VERSION
-    1.2.33
+    1.2.35
 
 GLOBAL OPTIONS
     -a, --add               - Add a next action (deprecated, for backwards compatibility)
@@ -104,7 +104,7 @@ COMMANDS
     complete, finish    - Find and mark an action as @done
     completed, finished - Display completed actions
     edit                - Edit an existing action
-    find, grep          - Find actions matching a search pattern
+    find, grep, search  - Find actions matching a search pattern
     help                - Shows a list of commands or help for one command
     init, create        - Create a new todo file in the current directory
     initconfig          - Initialize the config file using current global options
@@ -112,6 +112,7 @@ COMMANDS
     open                - Open a todo file in the default editor
     projects            - Show list of projects for a file
     prompt              - Show or install prompt hooks for the current shell
+    restore, unfinish   - Find and remove @done tag from an action
     saved               - Execute a saved search
     tagged              - Find actions matching a tag
     todos               - Show list of known todo files

data/bin/commands/complete.rb

@@ -20,6 +20,10 @@ class App
     c.desc 'Add a @done tag to action and move to Archive'
     c.switch %i[a archive], negatable: false
 
+    c.desc 'Move action to specific project'
+    c.arg_name 'PROJECT'
+    c.flag %i[to project proj]
+
     c.desc 'Specify the file to search for the task'
     c.arg_name 'PATH'
     c.flag %i[file]
@@ -44,7 +48,7 @@ class App
     c.action do |global, options, args|
       options[:finish] = true
       options[:f] = true
-      options[:project] = 'Archive' if options[:archive]
+      options[:project] = 'Archive' if options[:archive] && !options[:project]
 
       cmd = commands[:update]
       action = cmd.send(:get_action, nil)

data/bin/commands/find.rb

@@ -7,7 +7,7 @@ class App
   (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`,
   add a - or ! to ignore matches containing that token.'
   arg_name 'PATTERN'
-  command %i[find grep] do |c|
+  command %i[find grep search] do |c|
     c.example 'na find feature idea swift', desc: 'Find all actions containing feature, idea, and swift'
     c.example 'na find feature idea -swift', desc: 'Find all actions containing feature and idea but NOT swift'
     c.example 'na find -x feature idea', desc: 'Find all actions containing the exact text "feature idea"'
@@ -64,17 +64,33 @@ class App
         NA.save_search(title, "#{NA.command_line.join(' ').sub(/ --save[= ]*\S+/, '').split(' ').map { |t| %("#{t}") }.join(' ')}")
       end
 
-
       depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
                 3
               else
                 options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
               end
 
+      if options[:exact] || options[:regex]
+        search = args.join(' ')
+      else
+        search = args.join(' ').gsub(/(?<=\A|[ ,])(?<req>[+\-!])?@(?<tag>[^ *=<>$\^,@(]+)(?:\((?<value>.*?)\)| *(?<op>[=<>]{1,2}|[*$\^]=) *(?<val>.*?(?=\Z|[,@])))?/) do |arg|
+          m = Regexp.last_match
+          string = if m['value']
+                     "#{m['req']}#{m['tag']}=#{m['value']}"
+                   else
+                     m[0]
+                   end
+          options[:tagged] << string.sub(/@/, '')
+          ''
+        end
+      end
+
+      search = search.gsub(/ +/, ' ').strip
+
       all_req = options[:tagged].join(' ') !~ /[+!\-]/ && !options[:or]
       tags = []
       options[:tagged].join(',').split(/ *, */).each do |arg|
-        m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>$\^]+?)(?:(?<op>[=<>]{1,2}|[*$\^]=)(?<val>.*?))?$/)
+        m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>$\^]+?) *(?:(?<op>[=<>]{1,2}|[*$\^]=) *(?<val>.*?))?$/)
 
         tags.push({
                     tag: m['tag'].wildcard_to_rx,
@@ -85,19 +101,23 @@ class App
                   })
       end
 
+      search_for_done = false
+      tags.each { |tag| search_for_done = true if tag[:tag] =~ /done/ }
+      options[:done] = true if search_for_done
+
       tokens = nil
       if options[:exact]
-        tokens = args.join(' ')
+        tokens = search
       elsif options[:regex]
-        tokens = Regexp.new(args.join(' '), Regexp::IGNORECASE)
+        tokens = Regexp.new(search, Regexp::IGNORECASE)
       else
         tokens = []
-        all_req = args.join(' ') !~ /[+!\-]/ && !options[:or]
+        all_req = search !~ /[+!\-]/ && !options[:or]
 
-        args.join(' ').split(/ /).each do |arg|
+        search.split(/ /).each do |arg|
           m = arg.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
           tokens.push({
-                        token: m['tok'],
+                        token: Regexp.escape(m['tok']),
                         required: all_req || (!m['req'].nil? && m['req'] == '+'),
                         negate: !m['req'].nil? && m['req'] =~ /[!\-]/
                       })

data/bin/commands/restore.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class App
+  extend GLI::App
+  desc 'Find and remove @done tag from an action'
+  arg_name 'PATTERN'
+  command %i[restore unfinish] do |c|
+    c.example 'na restore "An existing task"',
+              desc: 'Find "An existing task" and remove @done'
+    c.example 'na unfinish "An existing task"',
+              desc: 'Alias for restore'
+
+    c.desc 'Prompt for additional notes. Input will be appended to any existing note.
+    If STDIN input (piped) is detected, it will be used as a note.'
+    c.switch %i[n note], negatable: false
+
+    c.desc 'Overwrite note instead of appending'
+    c.switch %i[o overwrite], negatable: false
+
+    c.desc 'Move action to specific project'
+    c.arg_name 'PROJECT'
+    c.flag %i[to project proj]
+
+    c.desc 'Specify the file to search for the task'
+    c.arg_name 'PATH'
+    c.flag %i[file]
+
+    c.desc 'Search for files X directories deep'
+    c.arg_name 'DEPTH'
+    c.flag %i[d depth], must_match: /^[1-9]$/, type: :integer, default_value: 1
+
+    c.desc 'Match actions containing tag. Allows value comparisons'
+    c.arg_name 'TAG'
+    c.flag %i[tagged], multiple: true
+
+    c.desc 'Act on all matches immediately (no menu)'
+    c.switch %i[all], negatable: false
+
+    c.desc 'Interpret search pattern as regular expression'
+    c.switch %i[e regex], negatable: false
+
+    c.desc 'Match pattern exactly'
+    c.switch %i[x exact], negatable: false
+
+    c.action do |global, options, args|
+      options[:remove] = ['done']
+      options[:done] = true
+      options[:finish] = false
+      options[:f] = false
+
+      cmd = commands[:update]
+      action = cmd.send(:get_action, nil)
+      action.call(global, options, args)
+    end
+  end
+end

data/bin/commands/tagged.rb

@@ -80,10 +80,11 @@ class App
 
       all_req = args.join(' ') !~ /[+!\-]/ && !options[:or]
       args.join(',').split(/ *, */).each do |arg|
-        m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>$\^]+?)(?:(?<op>[=<>]{1,2}|[*$\^]=)(?<val>.*?))?$/)
+        m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>$\^]+?) *(?:(?<op>[=<>]{1,2}|[*$\^]=) *(?<val>.*?))?$/)
+        next if m.nil?
 
         tags.push({
-                    tag: m['tag'].wildcard_to_rx,
+                    tag: m['tag'].sub(/^@/, '').wildcard_to_rx,
                     comp: m['op'],
                     value: m['val'],
                     required: all_req || (!m['req'].nil? && m['req'] == '+'),
@@ -93,7 +94,8 @@ class App
 
       search_for_done = false
       tags.each { |tag| search_for_done = true if tag[:tag] =~ /done/ }
-      tags.push({ tag: 'done', value: nil, negate: true}) unless search_for_done
+      tags.push({ tag: 'done', value: nil, negate: true}) unless search_for_done || options[:done]
+      options[:done] = true if search_for_done
 
       tokens = nil
       if options[:search]
@@ -129,6 +131,8 @@ class App
         end
       end
 
+      NA.notify('{br}No actions matched search', exit_code: 1) if tags.empty? && tokens.empty?
+
       files, actions, = NA.parse_actions(depth: depth,
                                          done: options[:done],
                                          query: todo,

data/lib/na/action.rb

@@ -37,7 +37,18 @@ module NA
       EOINSPECT
     end
 
+    ##
+    ## Pretty print an action
+    ##
+    ## @param      extension  [String] The file extension
+    ## @param      template   [Hash] The template to use for
+    ##                        colorization
+    ## @param      regexes    [Array] The regexes to
+    ##                        highlight (searches)
+    ## @param      notes      [Boolean] Include notes
+    ##
     def pretty(extension: 'taskpaper', template: {}, regexes: [], notes: false)
+      # Default colorization, can be overridden with full or partial template variable
       default_template = {
         file: '{xbk}',
         parent: '{c}',
@@ -51,32 +62,38 @@ module NA
         note: '{dw}'
       }
       template = default_template.merge(template)
-
+      # Create the hierarchical parent string
       parents = @parent.map do |par|
         NA::Color.template("#{template[:parent]}#{par}")
       end.join(NA::Color.template(template[:parent_divider]))
       parents = "{dc}[{x}#{parents}{dc}]{x} "
 
+      # Create the project string
       project = NA::Color.template("#{template[:project]}#{@project}{x} ")
 
+      # Create the source filename string, substituting ~ for HOME and removing extension
       file = @file.sub(%r{^\./}, '').sub(/#{ENV['HOME']}/, '~')
       file = file.sub(/\.#{extension}$/, '')
+      # colorize the basename
       file = file.sub(/#{File.basename(@file, ".#{extension}")}$/, "{dw}#{File.basename(@file, ".#{extension}")}{x}")
       file_tpl = "#{template[:file]}#{file} {x}"
       filename = NA::Color.template(file_tpl)
 
+      # Add notes if needed
       note = if notes && @note.count.positive?
                NA::Color.template("\n#{@note.map { |l| "  #{template[:note]}• #{l}{x}" }.join("\n")}")
              else
                ''
              end
 
+      # colorize the action and highlight tags
       action = NA::Color.template("#{template[:action]}#{@action.sub(/ @#{NA.na_tag}\b/, '')}{x}")
       action = action.highlight_tags(color: template[:tags],
                                      parens: template[:value_parens],
                                      value: template[:values],
                                      last_color: template[:action])
 
+      # Replace variables in template string and output colorized
       NA::Color.template(template[:output].gsub(/%filename/, filename)
                           .gsub(/%project/, project)
                           .gsub(/%parents?/, parents)

data/lib/na/next_action.rb

@@ -420,7 +420,7 @@ module NA
                         projects.select { |proj| proj.project =~ /^#{action.parent.join(':')}$/ }.first
                       end
 
-        NA.notify("{r}Error parsing project #{target_proj}", exit_code: 1) if target_proj.nil?
+        NA.notify("{r}Error parsing project #{target}", exit_code: 1) if target_proj.nil?
 
         indent = "\t" * target_proj.indent
         note = note.split("\n") unless note.is_a?(Array)
@@ -450,6 +450,8 @@ module NA
         end
 
         contents.insert(target_line, "#{indent}\t- #{action.action}#{note}")
+
+        notify(action.pretty)
       else
         _, actions = find_actions(target, search, tagged, done: done, all: all)
 
@@ -502,7 +504,10 @@ module NA
             target_line = target_proj.line + 1
           end
 
+
           contents.insert(target_line, "#{indent}\t- #{action.action}#{note}")
+
+          notify(action.pretty)
         end
       end
 
@@ -692,6 +697,9 @@ module NA
       negated_tag = []
       projects = []
 
+      notify("{dw}Tags: #{tag}", debug:true)
+      notify("{dw}Search: #{search}", debug:true)
+
       tag&.each do |t|
         unless t[:tag].nil?
           if negate
@@ -706,7 +714,7 @@ module NA
         end
       end
 
-      unless search.nil?
+      unless search.nil? || search.empty?
         if regex || search.is_a?(String)
           if negate
             negated.push(search)

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.2.33'
+  VERSION = '1.2.35'
 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.2.32<!--END VER-->.
+The current version of `na` is <!--VER-->1.2.34<!--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. 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.2.33
+  version: 1.2.35
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -218,6 +218,7 @@ files:
 - bin/commands/open.rb
 - bin/commands/projects.rb
 - bin/commands/prompt.rb
+- bin/commands/restore.rb
 - bin/commands/saved.rb
 - bin/commands/tagged.rb
 - bin/commands/todos.rb