na 1.2.35 → 1.2.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f8982f5720115576a78ab96a430d1d83f501bb1b477b2cff1a694648a186afc
-  data.tar.gz: 86dd520a3265473471b6d09fc05136dd07b53ded24ab2c82936074fa50595b67
+  metadata.gz: 35e6d784b55e397b8843663130837bcebb9041640a7833d650cedc9b783289e2
+  data.tar.gz: a1ba45d7ba0d77e122667bc5c93629832dc379ee5d2275076182849055c8d72e
 SHA512:
-  metadata.gz: 7ea9bb861c82251c1ec52925d6527f0e4efa1eef0175d268b8a8bb307fafcc407dc888e5e5cd6d588e5e4a500a96ae64765106f23d9c4acda6e0667c71247d62
-  data.tar.gz: e5f603160851411f66dd50ae47a65369aaa1e51352cf2eb6313674d95d64db8914d3a870f816dcc4303fbd5b4e675f213020fa6a7fd93805af4692f04eb99aed
+  metadata.gz: 1ee63a7b2bfd58496bf2047cd80a16f30bf255ca1edc8b0aa5a84a9abc8e4d1ccdd8082cd8f01fb8db60d5b73c7e2014f4f847369ac0d39274b5929ef8173f07
+  data.tar.gz: d0321cddedf590c96a18cbd1096c7982240cb8c172c9f3491e0569ecfdf8882955898056ff3fd56d9e529d91be2a9ca56f3003bdbf6f1517a9658d08a302ca30

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+### 1.2.37
+
+2023-09-01 12:42
+
+#### NEW
+
+- `na undo` command to undo last change or last change to file specified in arguments
+
+#### IMPROVED
+
+- Disable pagination when using --omnifocus
+- Refactoring codebase
+- `--in TODO` option for `na complete`
+
+### 1.2.36
+
+2023-09-01 12:41
+
+#### NEW
+
+- `na undo` command to undo last change or last change to file specified in arguments
+
+#### IMPROVED
+
+- Disable pagination when using --omnifocus
+- Refactoring codebase
+- `--in TODO` option for `na complete`
+
 ### 1.2.35
 
 2023-08-30 11:59

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.2.35)
+    na (1.2.36)
       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.35
+The current version of `na` is 1.2.37
 .
 
 `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.35
+    1.2.37
 
 GLOBAL OPTIONS
     -a, --add               - Add a next action (deprecated, for backwards compatibility)
@@ -116,6 +116,7 @@ COMMANDS
     saved               - Execute a saved search
     tagged              - Find actions matching a tag
     todos               - Show list of known todo files
+    undo                - Undo the last change
     update              - Update an existing action
 ```
 
@@ -512,6 +513,82 @@ EXAMPLES
     na update --archive My cool action
 ```
 
+##### changelog
+
+View recent changes with `na changelog` or `na changes`.
+
+```
+NAME
+    changes - Display the changelog
+
+SYNOPSIS
+
+    na [global options] changes
+```
+
+##### complete
+
+Mark an action as complete, shortcut for `na update --finish`.
+
+```
+NAME
+    complete - Find and mark an action as @done
+
+SYNOPSIS
+
+    na [global options] complete [command options] ACTION
+
+COMMAND OPTIONS
+    -a, --archive                   - Add a @done tag to action and move to Archive
+    --all                           - Act on all matches immediately (no menu)
+    -d, --depth=DEPTH               - Search for files X directories deep (default: 1)
+    -e, --regex                     - Interpret search pattern as regular expression
+    --file=PATH                     - Specify the file to search for the task (default: none)
+    --in, --todo=TODO_FILE          - Use a known todo file, partial matches allowed (default: none)
+    -n, --note                      - 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.
+    -o, --overwrite                 - Overwrite note instead of appending
+    --tagged=TAG                    - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
+    --to, --project, --proj=PROJECT - Move action to specific project (default: none)
+    -x, --exact                     - Match pattern exactly
+
+EXAMPLES
+
+    # Find "An existing task" and mark @done
+    na complete "An existing task"
+
+    # Alias for complete
+    na finish "An existing task"
+```
+
+##### archive
+
+Mark an action as complete and move to archive, shortcut for `na update --archive`.
+
+```
+NAME
+    archive - Mark an action as @done and archive
+
+SYNOPSIS
+
+    na [global options] archive [command options] ACTION
+
+COMMAND OPTIONS
+    --all             - Act on all matches immediately (no menu)
+    -d, --depth=DEPTH - Search for files X directories deep (default: 1)
+    --done            - Archive all done tasks
+    -e, --regex       - Interpret search pattern as regular expression
+    --file=PATH       - Specify the file to search for the task (default: none)
+    -n, --note        - 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.
+    -o, --overwrite   - Overwrite note instead of appending
+    --tagged=TAG      - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
+    -x, --exact       - Match pattern exactly
+
+EXAMPLE
+
+    # Find "An existing task", mark @done if needed, and move to archive
+    na archive "An existing task"
+```
+
 ### Configuration
 
 Global options such as todo extension and default next action tag can be stored permanently by using the `na initconfig` command. Run na with the global options you'd like to set, and add `initconfig` at the end of the command. A file will be written to `~/.na.rc`. You can edit this manually, or just update it using the `initconfig --force` command to overwrite it with new settings.

data/bin/commands/complete.rb

@@ -28,6 +28,10 @@ class App
     c.arg_name 'PATH'
     c.flag %i[file]
 
+    c.desc 'Use a known todo file, partial matches allowed'
+    c.arg_name 'TODO_FILE'
+    c.flag %i[in todo]
+
     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

data/bin/commands/edit.rb

@@ -140,11 +140,12 @@ class App
       NA.notify('{r}No search terms provided', exit_code: 1) if tokens.nil? && options[:tagged].empty?
 
       targets.each do |target|
-        NA.update_action(target, tokens,
-                                 done: options[:done],
-                                 edit: options[:edit],
-                                 project: target_proj,
-                                 tagged: tags)
+        NA.update_action(target,
+                         tokens,
+                         done: options[:done],
+                         edit: options[:edit],
+                         project: target_proj,
+                         tagged: tags)
       end
     end
   end

data/bin/commands/find.rb

@@ -112,47 +112,55 @@ class App
         tokens = Regexp.new(search, Regexp::IGNORECASE)
       else
         tokens = []
-        all_req = search !~ /[+!\-]/ && !options[:or]
+        all_req = search !~ /[+!-]/ && !options[:or]
 
         search.split(/ /).each do |arg|
           m = arg.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
           tokens.push({
                         token: Regexp.escape(m['tok']),
                         required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                        negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                        negate: !m['req'].nil? && m['req'] =~ /[!-]/
                       })
         end
       end
 
-      todo = nil
+      todos = nil
       if options[:in]
-        todo = []
+        todos = []
         options[:in].split(/ *, */).each do |a|
           m = a.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
-          todo.push({
-                      token: m['tok'],
-                      required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                      negate: !m['req'].nil? && m['req'] =~ /[!\-]/
-                    })
+          todos.push({
+                       token: m['tok'],
+                       required: all_req || (!m['req'].nil? && m['req'] == '+'),
+                       negate: !m['req'].nil? && m['req'] =~ /[!-]/
+                     })
         end
       end
 
-      files, actions, = NA.parse_actions(depth: depth,
-                                         done: options[:done],
-                                         query: todo,
-                                         search: tokens,
-                                         tag: tags,
-                                         negate: options[:invert],
-                                         regex: options[:regex],
-                                         project: options[:project],
-                                         require_na: false)
+      todo = NA::Todo.new({
+                            depth: depth,
+                            done: options[:done],
+                            query: todos,
+                            search: tokens,
+                            tag: tags,
+                            negate: options[:invert],
+                            regex: options[:regex],
+                            project: options[:project],
+                            require_na: false
+                          })
+
       regexes = if tokens.is_a?(Array)
                   tokens.delete_if { |token| token[:negate] }.map { |token| token[:token] }
                 else
                   [tokens]
                 end
 
-      NA.output_actions(actions, depth, files: files, regexes: regexes, notes: options[:notes], nest: options[:nest], nest_projects: options[:omnifocus])
+      todo.actions.output(depth,
+                          files: todo.files,
+                          regexes: regexes,
+                          notes: options[:notes],
+                          nest: options[:nest],
+                          nest_projects: options[:omnifocus])
     end
   end
 end

data/bin/commands/next.rb

@@ -52,10 +52,10 @@ class App
     c.switch %i[done]
 
     c.desc 'Output actions nested by file'
-    c.switch %[nest], negatable: false
+    c.switch %i[nest], negatable: false
 
     c.desc 'Output actions nested by file and project'
-    c.switch %[omnifocus], negatable: false
+    c.switch %i[omnifocus], negatable: false
 
     c.action do |global_options, options, args|
       if global_options[:add]
@@ -75,23 +75,23 @@ class App
                 options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
               end
 
-      all_req = options[:tagged].join(' ') !~ /[+!\-]/ && !options[:or]
+      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,
                     comp: m['op'],
                     value: m['val'],
                     required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                    negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                    negate: !m['req'].nil? && m['req'] =~ /[!-]/
                   })
       end
 
       args.concat(options[:in])
       if args.count.positive?
-        all_req = args.join(' ') !~ /[+!\-]/
+        all_req = args.join(' ') !~ /[+!-]/
 
         tokens = []
         args.each do |arg|
@@ -100,7 +100,7 @@ class App
             tokens.push({
                           token: m['tok'],
                           required: !m['req'].nil? && m['req'] == '+',
-                          negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                          negate: !m['req'].nil? && m['req'] =~ /[!-]/
                         })
           end
         end
@@ -114,14 +114,14 @@ class App
           search = Regexp.new(options[:search].join(' '), Regexp::IGNORECASE)
         else
           search = []
-          all_req = options[:search].join(' ') !~ /[+!\-]/ && !options[:or]
+          all_req = options[:search].join(' ') !~ /[+!-]/ && !options[:or]
 
           options[:search].join(' ').split(/ /).each do |arg|
             m = arg.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
             search.push({
                           token: m['tok'],
                           required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                          negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                          negate: !m['req'].nil? && m['req'] =~ /[!-]/
                         })
           end
         end
@@ -133,15 +133,19 @@ class App
       tag = [{ tag: NA.na_tag, value: nil }]
       tag << { tag: 'done', value: nil, negate: true } unless options[:done]
       tag.concat(tags)
-      files, actions, = NA.parse_actions(depth: depth,
-                                         done: options[:done],
-                                         query: tokens,
-                                         tag: tag,
-                                         search: search,
-                                         project: options[:project],
-                                         require_na: require_na)
-
-      NA.output_actions(actions, depth, files: files, notes: options[:notes], nest: options[:nest], nest_projects: options[:omnifocus])
+      todo = NA::Todo.new({ depth: depth,
+                            done: options[:done],
+                            query: tokens,
+                            tag: tag,
+                            search: search,
+                            project: options[:project],
+                            require_na: require_na })
+      NA::Pager.paginate = false if options[:omnifocus]
+      todo.actions.output(depth,
+                          files: todo.files,
+                          notes: options[:notes],
+                          nest: options[:nest],
+                          nest_projects: options[:omnifocus])
     end
   end
 end

data/bin/commands/prompt.rb

@@ -9,6 +9,8 @@ class App
     c.desc 'Output the prompt hook for the current shell to STDOUT. Pass an argument to
             specify a shell (zsh, bash, fish)'
     c.arg_name 'SHELL', optional: true
+    c.default_command :show
+
     c.command %i[show] do |s|
       s.action do |_global_options, _options, args|
         shell = if args.count.positive?

data/bin/commands/tagged.rb

@@ -57,17 +57,18 @@ class App
     c.flag %i[save]
 
     c.desc 'Output actions nested by file'
-    c.switch %[nest], negatable: false
+    c.switch %i[nest], negatable: false
 
     c.desc 'Output actions nested by file and project'
-    c.switch %[omnifocus], negatable: false
+    c.switch %i[omnifocus], negatable: false
 
     c.action do |global_options, options, args|
       options[:nest] = true if options[:omnifocus]
 
       if options[:save]
         title = options[:save].gsub(/[^a-z0-9]/, '_').gsub(/_+/, '_')
-        NA.save_search(title, "#{NA.command_line.join(' ').sub(/ --save[= ]*\S+/, '').split(' ').map { |t| %("#{t}") }.join(' ')}")
+        cmd = NA.command_line.join(' ').sub(/ --save[= ]*\S+/, '').split(' ').map { |t| %("#{t}") }.join(' ')
+        NA.save_search(title, cmd)
       end
 
       depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
@@ -78,7 +79,7 @@ class App
 
       tags = []
 
-      all_req = args.join(' ') !~ /[+!\-]/ && !options[:or]
+      all_req = args.join(' ') !~ /[+!-]/ && !options[:or]
       args.join(',').split(/ *, */).each do |arg|
         m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>$\^]+?) *(?:(?<op>[=<>]{1,2}|[*$\^]=) *(?<val>.*?))?$/)
         next if m.nil?
@@ -88,13 +89,13 @@ class App
                     comp: m['op'],
                     value: m['val'],
                     required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                    negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                    negate: !m['req'].nil? && m['req'] =~ /[!-]/
                   })
       end
 
       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 || options[:done]
+      tags.push({ tag: 'done', value: nil, negate: true }) unless search_for_done || options[:done]
       options[:done] = true if search_for_done
 
       tokens = nil
@@ -105,49 +106,55 @@ class App
           tokens = Regexp.new(options[:search].join(' '), Regexp::IGNORECASE)
         else
           tokens = []
-          all_req = options[:search].join(' ') !~ /[+!\-]/ && !options[:or]
+          all_req = options[:search].join(' ') !~ /[+!-]/ && !options[:or]
 
           options[:search].join(' ').split(/ /).each do |arg|
             m = arg.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
             tokens.push({
                           token: m['tok'],
                           required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                          negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                          negate: !m['req'].nil? && m['req'] =~ /[!-]/
                         })
           end
         end
       end
 
-      todo = nil
+      todos = nil
       if options[:in]
-        todo = []
+        todos = []
+        all_req = options[:in] !~ /[+!-]/ && !options[:or]
         options[:in].split(/ *, */).each do |a|
           m = a.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
-          todo.push({
-                      token: m['tok'],
-                      required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                      negate: !m['req'].nil? && m['req'] =~ /[!\-]/
-                    })
+          todos.push({
+                       token: m['tok'],
+                       required: all_req || (!m['req'].nil? && m['req'] == '+'),
+                       negate: !m['req'].nil? && m['req'] =~ /[!-]/
+                     })
         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,
-                                         search: tokens,
-                                         tag: tags,
-                                         negate: options[:invert],
-                                         project: options[:project],
-                                         require_na: false)
-      # regexes = tags.delete_if { |token| token[:negate] }.map { |token| token[:token] }
+      todo = NA::Todo.new({ depth: depth,
+                            done: options[:done],
+                            query: todos,
+                            search: tokens,
+                            tag: tags,
+                            negate: options[:invert],
+                            project: options[:project],
+                            require_na: false })
+
       regexes = if tokens.is_a?(Array)
                   tokens.delete_if { |token| token[:negate] }.map { |token| token[:token] }
                 else
                   [tokens]
                 end
-      NA.output_actions(actions, depth, files: files, regexes: regexes, notes: options[:notes], nest: options[:nest], nest_projects: options[:omnifocus])
+      todo.actions.output(depth,
+                          files: todo.files,
+                          regexes: regexes,
+                          notes: options[:notes],
+                          nest: options[:nest],
+                          nest_projects: options[:omnifocus])
     end
   end
 end

data/bin/commands/todos.rb

@@ -10,16 +10,16 @@ class App
   command %i[todos] do |c|
     c.action do |_global_options, _options, args|
       if args.count.positive?
-        all_req = args.join(' ') !~ /[+!\-]/
+        all_req = args.join(' ') !~ /[+!-]/
 
         tokens = [{ token: '*', required: all_req, negate: false }]
         args.each do |arg|
           arg.split(/ *, */).each do |a|
-            m = a.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
+            m = a.match(/^(?<req>[+!-])?(?<tok>.*?)$/)
             tokens.push({
                           token: m['tok'],
                           required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                          negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                          negate: !m['req'].nil? && m['req'] =~ /[!-]/
                         })
           end
         end

data/bin/commands/undo.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class App
+  extend GLI::App
+  desc 'Undo the last change'
+  long_desc 'Run without argument to undo most recent change'
+  arg_name 'FILE', optional: true, multiple: true
+  command %i[undo] do |c|
+    c.example 'na undo', desc: 'Undo the last change'
+    c.example 'na undo myproject', desc: 'Undo the last change to a file matching "myproject"'
+
+    c.action do |_global_options, options, args|
+      if args.empty?
+        NA.restore_last_modified_file
+      else
+        args.each do |arg|
+          NA.restore_last_modified_file(search: arg)
+        end
+      end
+    end
+  end
+end

data/bin/commands/update.rb

@@ -63,7 +63,7 @@ class App
     c.desc 'Delete an action'
     c.switch %i[delete], negatable: false
 
-    c.desc "Open action in editor (#{NA.default_editor}).
+    c.desc "Open action in editor (#{NA::Editor.default_editor}).
             Natural language dates will be parsed and converted in date-based tags."
     c.switch %i[edit], negatable: false
 
@@ -97,6 +97,8 @@ class App
         options[:tagged] << '+done'
       elsif !options[:remove].nil? && !options[:remove].empty?
         options[:tagged].concat(options[:remove])
+      elsif options[:finish]
+        options[:tagged] << '-done'
       end
 
       action = if args.count.positive?
@@ -211,7 +213,15 @@ class App
 
         end
       else
-        files = NA.find_files(depth: options[:depth])
+        files = NA.find_files_matching({
+                                        depth: options[:depth],
+                                        done: options[:done],
+                                        project: target_proj,
+                                        regex: options[:regex],
+                                        require_na: false,
+                                        search: tokens,
+                                        tag: tags
+                                      })
         NA.notify('{r}No todo file found', exit_code: 1) if files.count.zero?
 
         targets = files.count > 1 ? NA.select_file(files, multiple: true) : [files[0]]

data/lib/na/action.rb

@@ -18,6 +18,32 @@ module NA
       @note = note
     end
 
+    def process(priority: 0, finish: false, add_tag: [], remove_tag: [], note: [])
+      string = @action.dup
+
+      if priority&.positive?
+        string.gsub!(/(?<=\A| )@priority\(\d+\)/, '').strip!
+        string += " @priority(#{priority})"
+      end
+
+      add_tag.each do |tag|
+        string.gsub!(/(?<=\A| )@#{tag.gsub(/([()*?])/, '\\\\1')}(\(.*?\))?/, '')
+        string.strip!
+        string += " @#{tag}"
+      end
+
+      remove_tag.each do |tag|
+        string.gsub!(/(?<=\A| )@#{tag.gsub(/([()*?])/, '\\\\1')}(\(.*?\))?/, '')
+        string.strip!
+      end
+
+      string = "#{string.strip} @done(#{Time.now.strftime('%Y-%m-%d %H:%M')})" if finish && string !~ /(?<=\A| )@done/
+
+      @action = string
+      @action.expand_date_tags
+      @note = note unless note.empty?
+    end
+
     def to_s
       note = if @note.count.positive?
                "\n#{@note.join("\n")}"
@@ -179,7 +205,7 @@ module NA
           date = Time.parse(date.strftime('%Y-%m-%d 12:00'))
         end
 
-        puts "Comparing #{tag_date} #{tag[:comp]} #{date}" if NA.verbose
+        # NA.notify("{dw}Comparing #{tag_date} #{tag[:comp]} #{date}{x}", debug: true)
 
         case tag[:comp]
         when /^>$/