na 1.2.28 → 1.2.30

data/bin/commands/archive.rb

@@ -1,56 +1,59 @@
 # frozen_string_literal: true
 
-desc 'Mark an action as @done and archive'
-arg_name 'ACTION'
-command %i[archive] do |c|
-  c.example 'na archive "An existing task"',
-            desc: 'Find "An existing task", mark @done if needed, and move to archive'
-
-  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 'Archive all done tasks'
-  c.switch %i[done], negatable: false
-
-  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|
-    if options[:done]
-      options[:tagged] = ['done']
-      options[:all] = true
+class App
+  extend GLI::App
+  desc 'Mark an action as @done and archive'
+  arg_name 'ACTION'
+  command %i[archive] do |c|
+    c.example 'na archive "An existing task"',
+              desc: 'Find "An existing task", mark @done if needed, and move to archive'
+
+    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 'Archive all done tasks'
+    c.switch %i[done], negatable: false
+
+    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|
+      if options[:done]
+        options[:tagged] = ['done']
+        options[:all] = true
+      end
+
+      options[:done] = true
+      options[:finish] = true
+      options[:project] = 'Archive'
+      options[:archive] = true
+      options[:a] = true
+
+      cmd = commands[:update]
+      action = cmd.send(:get_action, nil)
+      action.call(global, options, args)
     end
-
-    options[:done] = true
-    options[:finish] = true
-    options[:project] = 'Archive'
-    options[:archive] = true
-    options[:a] = true
-
-    cmd = commands[:update]
-    action = cmd.send(:get_action, nil)
-    action.call(global, options, args)
   end
 end

data/bin/commands/changes.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
-desc 'Display the changelog'
-command %i[changes changelog] do |c|
-  c.action do |_, _, _|
-    changelog = File.expand_path(File.join(File.dirname(__FILE__), '..', 'CHANGELOG.md'))
-    pagers = [
-      'mdless',
-      'mdcat',
-      'bat',
-      ENV['PAGER'],
-      'less -FXr',
-      ENV['GIT_PAGER'],
-      'more -r'
-    ]
-    pager = pagers.find { |cmd| TTY::Which.exist?(cmd.split.first) }
-    system %(#{pager} "#{changelog}")
+class App
+  extend GLI::App
+  desc 'Display the changelog'
+  command %i[changes changelog] do |c|
+    c.action do |_, _, _|
+      changelog = File.expand_path(File.join(File.dirname(__FILE__), '..', 'CHANGELOG.md'))
+      pagers = [
+        'mdless',
+        'mdcat',
+        'bat',
+        ENV['PAGER'],
+        'less -FXr',
+        ENV['GIT_PAGER'],
+        'more -r'
+      ]
+      pager = pagers.find { |cmd| TTY::Which.exist?(cmd.split.first) }
+      system %(#{pager} "#{changelog}")
+    end
   end
 end

data/bin/commands/complete.rb

@@ -1,51 +1,54 @@
 # frozen_string_literal: true
 
-desc 'Find and mark an action as @done'
-arg_name 'ACTION'
-command %i[complete finish] do |c|
-  c.example 'na complete "An existing task"',
-            desc: 'Find "An existing task" and mark @done'
-  c.example 'na finish "An existing task"',
-            desc: 'Alias for complete'
-
-  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 'Add a @done tag to action and move to Archive'
-  c.switch %i[a archive], negatable: false
-
-  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[:finish] = true
-    options[:f] = true
-    options[:project] = 'Archive' if options[:archive]
-
-    cmd = commands[:update]
-    action = cmd.send(:get_action, nil)
-    action.call(global, options, args)
+class App
+  extend GLI::App
+  desc 'Find and mark an action as @done'
+  arg_name 'ACTION'
+  command %i[complete finish] do |c|
+    c.example 'na complete "An existing task"',
+              desc: 'Find "An existing task" and mark @done'
+    c.example 'na finish "An existing task"',
+              desc: 'Alias for complete'
+
+    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 'Add a @done tag to action and move to Archive'
+    c.switch %i[a archive], negatable: false
+
+    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[:finish] = true
+      options[:f] = true
+      options[:project] = 'Archive' if options[:archive]
+
+      cmd = commands[:update]
+      action = cmd.send(:get_action, nil)
+      action.call(global, options, args)
+    end
   end
 end

data/bin/commands/completed.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+class App
+  extend GLI::App
+  desc 'Display completed actions'
+  long_desc 'Search tokens are separated by spaces. Actions matching all tokens in the pattern will be shown
+    (partial matches allowed). Add a + before a token to make it required, e.g. `na completed +feature +maybe`,
+    add a - or ! to ignore matches containing that token.'
+  arg_name 'PATTERN', optional: true, multiple: true
+  command %i[completed finished] do |c|
+    c.example 'na completed', desc: 'display completed actions'
+    c.example 'na completed --before "2 days ago"',
+              desc: 'display actions completed more than two days ago'
+    c.example 'na completed --on yesterday',
+              desc: 'display actions completed yesterday'
+    c.example 'na completed --after "1 week ago"',
+              desc: 'display actions completed in the last week'
+    c.example 'na completed feature',
+              desc: 'display completed actions matcning "feature"'
+
+    c.desc 'Display actions completed before (natural language) date string'
+    c.arg_name 'DATE_STRING'
+    c.flag %i[b before]
+
+    c.desc 'Display actions completed on (natural language) date string'
+    c.arg_name 'DATE_STRING'
+    c.flag %i[on]
+
+    c.desc 'Display actions completed after (natural language) date string'
+    c.arg_name 'DATE_STRING'
+    c.flag %i[a after]
+
+    c.desc 'Combine before, on, and/or after with OR, displaying actions matching ANY of the ranges'
+    c.switch %i[o or], negatable: false
+
+    c.desc 'Recurse to depth'
+    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. May use wildcards (* and ?)'
+    c.arg_name 'TODO_PATH'
+    c.flag %i[in]
+
+    c.desc 'Include notes in output'
+    c.switch %i[notes], negatable: true, default_value: false
+
+    c.desc 'Show actions from a specific project'
+    c.arg_name 'PROJECT[/SUBPROJECT]'
+    c.flag %i[proj project]
+
+    c.desc 'Match actions containing tag. Allows value comparisons'
+    c.arg_name 'TAG'
+    c.flag %i[tagged], multiple: true
+
+    c.desc 'Output actions nested by file'
+    c.switch %[nest], negatable: false
+
+    c.desc 'Output actions nested by file and project'
+    c.switch %[omnifocus], 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|
+      tag_string = []
+      if options[:before] || options[:on] || options[:after]
+        tag_string << "done<#{options[:before]}" if options[:before]
+        tag_string << "done=#{options[:on]}" if options[:on]
+        tag_string << "done>#{options[:after]}" if options[:after]
+      else
+        tag_string << 'done'
+      end
+
+      tag_string.concat(options[:tagged]) if options[:tagged]
+
+      if args.empty?
+        cmd_string = %(tagged --done "#{tag_string.join(',')}")
+      else
+        cmd_string = %(find --tagged "#{tag_string.join(',')}" --done #{args.join(' ')})
+      end
+
+      cmd_string += ' --or' if options[:or]
+      cmd_string += %( --in "#{options[:in]}") if options[:in]
+      cmd_string += %( --project "#{options[:project]}") if options[:project]
+      cmd_string += %( --depth #{options[:depth]}) if options[:depth]
+      cmd_string += ' --nest' if options[:nest]
+      cmd_string += ' --omnifocus' if options[:omnifocus]
+      cmd_string += " --#{options[:notes] ? 'notes' : 'no-notes' }"
+
+      if options[:save]
+        title = options[:save].gsub(/[^a-z0-9]/, '_').gsub(/_+/, '_')
+        NA.save_search(title, cmd_string)
+      end
+
+      exit run(Shellwords.shellsplit(cmd_string))
+    end
+  end
+end

data/bin/commands/edit.rb

@@ -1,45 +1,48 @@
 # frozen_string_literal: true
 
-desc 'Open a todo file in the default editor'
-long_desc 'Let the system choose the defualt, (e.g. TaskPaper), or specify a command line utility (e.g. vim).
-           If more than one todo file is found, a menu is displayed.'
-command %i[edit] do |c|
-  c.example 'na edit', desc: 'Open the main todo file in the default editor'
-  c.example 'na edit -d 3 -a vim', desc: 'Display a menu of all todo files three levels deep from the
-             current directory, open selection in vim.'
+class App
+  extend GLI::App
+  desc 'Open a todo file in the default editor'
+  long_desc 'Let the system choose the defualt, (e.g. TaskPaper), or specify a command line utility (e.g. vim).
+             If more than one todo file is found, a menu is displayed.'
+  command %i[edit] do |c|
+    c.example 'na edit', desc: 'Open the main todo file in the default editor'
+    c.example 'na edit -d 3 -a vim', desc: 'Display a menu of all todo files three levels deep from the
+               current directory, open selection in vim.'
 
-  c.desc 'Recurse to depth'
-  c.arg_name 'DEPTH'
-  c.default_value 1
-  c.flag %i[d depth], type: :integer, must_match: /^\d+$/
+    c.desc 'Recurse to depth'
+    c.arg_name 'DEPTH'
+    c.default_value 1
+    c.flag %i[d depth], type: :integer, must_match: /^\d+$/
 
-  c.desc 'Specify an editor CLI'
-  c.arg_name 'EDITOR'
-  c.flag %i[e editor]
+    c.desc 'Specify an editor CLI'
+    c.arg_name 'EDITOR'
+    c.flag %i[e editor]
 
-  c.desc 'Specify a Mac app'
-  c.arg_name 'EDITOR'
-  c.flag %i[a app]
+    c.desc 'Specify a Mac app'
+    c.arg_name 'EDITOR'
+    c.flag %i[a app]
 
-  c.action do |global_options, options, args|
-    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
-    files = NA.find_files(depth: depth)
-    files.delete_if { |f| f !~ /.*?(#{args.join('|')}).*?.#{NA.extension}/ } if args.count.positive?
+    c.action do |global_options, options, args|
+      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
+      files = NA.find_files(depth: depth)
+      files.delete_if { |f| f !~ /.*?(#{args.join('|')}).*?.#{NA.extension}/ } if args.count.positive?
 
-    file = if files.count > 1
-             NA.select_file(files)
-           else
-             files[0]
-           end
+      file = if files.count > 1
+               NA.select_file(files)
+             else
+               files[0]
+             end
 
-    if options[:editor]
-      system options[:editor], file
-    else
-      NA.edit_file(file: file, app: options[:app])
+      if options[:editor]
+        system options[:editor], file
+      else
+        NA.edit_file(file: file, app: options[:app])
+      end
     end
   end
 end