na 1.2.29 → 1.2.31

data/bin/commands/next.rb

@@ -1,143 +1,147 @@
 # frozen_string_literal: true
 
-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.
-
-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'
-  c.example 'na next -d 3', desc: 'display the next actions from the current directory, traversing 3 levels deep'
-  c.example 'na next marked', desc: 'display next actions for a project you visited in the past'
-
-  c.desc 'Recurse to depth'
-  c.arg_name 'DEPTH'
-  c.flag %i[d depth], type: :integer, must_match: /^[1-9]$/
-
-  c.desc 'Display matches from a known todo file'
-  c.arg_name 'TODO_FILE'
-  c.flag %i[in todo], multiple: true
-
-  c.desc 'Alternate tag to search for'
-  c.arg_name 'TAG'
-  c.flag %i[t tag]
-
-  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 'Filter results using search terms'
-  c.arg_name 'QUERY'
-  c.flag %i[search], multiple: true
-
-  c.desc 'Search query is regular expression'
-  c.switch %i[regex], negatable: false
-
-  c.desc 'Search query is exact text match (not tokens)'
-  c.switch %i[exact], negatable: false
-
-  c.desc 'Include notes in output'
-  c.switch %i[notes], negatable: true, default_value: false
-
-  c.desc 'Include @done actions'
-  c.switch %i[done]
-
-  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.action do |global_options, options, args|
-    if global_options[:add]
-      cmd = ['add']
-      cmd.push('--note') if global_options[:note]
-      cmd.concat(['--priority', global_options[:priority]]) if global_options[:priority]
-      cmd.push(NA.command_line) if NA.command_line.count > 1
-      cmd.unshift(*NA.globals)
-      exit run(cmd)
-    end
+class App
+  extend GLI::App
+  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.
+
+  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'
+    c.example 'na next -d 3', desc: 'display the next actions from the current directory, traversing 3 levels deep'
+    c.example 'na next marked', desc: 'display next actions for a project you visited in the past'
+
+    c.desc 'Recurse to depth'
+    c.arg_name 'DEPTH'
+    c.flag %i[d depth], type: :integer, must_match: /^[1-9]$/
+
+    c.desc 'Display matches from a known todo file'
+    c.arg_name 'TODO_FILE'
+    c.flag %i[in todo], multiple: true
+
+    c.desc 'Alternate tag to search for'
+    c.arg_name 'TAG'
+    c.flag %i[t tag]
+
+    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 'Filter results using search terms'
+    c.arg_name 'QUERY'
+    c.flag %i[search], multiple: true
+
+    c.desc 'Search query is regular expression'
+    c.switch %i[regex], negatable: false
+
+    c.desc 'Search query is exact text match (not tokens)'
+    c.switch %i[exact], negatable: false
+
+    c.desc 'Include notes in output'
+    c.switch %i[notes], negatable: true, default_value: false
+
+    c.desc 'Include @done actions'
+    c.switch %i[done]
+
+    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.action do |global_options, options, args|
+      if global_options[:add]
+        cmd = ['add']
+        cmd.push('--note') if global_options[:note]
+        cmd.concat(['--priority', global_options[:priority]]) if global_options[:priority]
+        cmd.push(NA.command_line) if NA.command_line.count > 1
+        cmd.unshift(*NA.globals)
+        exit run(cmd)
+      end
 
-    options[:nest] = true if options[:omnifocus]
-
-    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
-
-    all_req = options[:tagged].join(' ') !~ /[+!\-]/ && !options[:or]
-    tags = []
-    options[:tagged].join(',').split(/ *, */).each do |arg|
-      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'] =~ /[!\-]/
-                })
-    end
+      options[:nest] = true if options[:omnifocus]
+
+      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
+
+      all_req = options[:tagged].join(' ') !~ /[+!\-]/ && !options[:or]
+      tags = []
+      options[:tagged].join(',').split(/ *, */).each do |arg|
+        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'] =~ /[!\-]/
+                  })
+      end
 
-    args.concat(options[:in])
-    if args.count.positive?
-      all_req = args.join(' ') !~ /[+!\-]/
-
-      tokens = []
-      args.each do |arg|
-        arg.split(/ *, */).each do |a|
-          m = a.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
-          tokens.push({
-                        token: m['tok'],
-                        required: !m['req'].nil? && m['req'] == '+',
-                        negate: !m['req'].nil? && m['req'] =~ /[!\-]/
-                      })
+      args.concat(options[:in])
+      if args.count.positive?
+        all_req = args.join(' ') !~ /[+!\-]/
+
+        tokens = []
+        args.each do |arg|
+          arg.split(/ *, */).each do |a|
+            m = a.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
+            tokens.push({
+                          token: m['tok'],
+                          required: !m['req'].nil? && m['req'] == '+',
+                          negate: !m['req'].nil? && m['req'] =~ /[!\-]/
+                        })
+          end
         end
       end
-    end
 
-    search = nil
-    if options[:search]
-      if options[:exact]
-        search = options[:search].join(' ')
-      elsif options[:regex]
-        search = Regexp.new(options[:search].join(' '), Regexp::IGNORECASE)
-      else
-        search = []
-        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'] =~ /[!\-]/
-                      })
+      search = nil
+      if options[:search]
+        if options[:exact]
+          search = options[:search].join(' ')
+        elsif options[:regex]
+          search = Regexp.new(options[:search].join(' '), Regexp::IGNORECASE)
+        else
+          search = []
+          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'] =~ /[!\-]/
+                        })
+          end
         end
       end
-    end
-
-    NA.na_tag = options[:tag] unless options[:tag].nil?
-    require_na = true
 
-    tag = [{ tag: NA.na_tag, value: nil }, { tag: 'done', value: nil, negate: true }]
-    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])
+      NA.na_tag = options[:tag] unless options[:tag].nil?
+      require_na = true
+
+      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])
+    end
   end
 end

data/bin/commands/projects.rb

@@ -1,34 +1,37 @@
 # frozen_string_literal: true
 
-desc 'Show list of projects for a file'
-long_desc 'Arguments will be interpreted as a query for a known todo file,
-fuzzy matched. Separate directories with /, :, or a space, e.g. `na projects code/marked`'
-arg_name 'QUERY', optional: true
-command %i[projects] do |c|
-  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
+class App
+  extend GLI::App
+  desc 'Show list of projects for a file'
+  long_desc 'Arguments will be interpreted as a query for a known todo file,
+  fuzzy matched. Separate directories with /, :, or a space, e.g. `na projects code/marked`'
+  arg_name 'QUERY', optional: true
+  command %i[projects] do |c|
+    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 'Output projects as paths instead of hierarchy'
-  c.switch %i[p paths], negatable: false
+    c.desc 'Output projects as paths instead of hierarchy'
+    c.switch %i[p paths], negatable: false
 
-  c.action do |_global_options, options, args|
-    if args.count.positive?
-      all_req = args.join(' ') !~ /[+!-]/
+    c.action do |_global_options, options, args|
+      if args.count.positive?
+        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>.*?)$/)
-          tokens.push({
-                        token: m['tok'],
-                        required: all_req || (!m['req'].nil? && m['req'] == '+'),
-                        negate: !m['req'].nil? && m['req'] =~ /[!-]/
-                      })
+        tokens = [{ token: '*', required: all_req, negate: false }]
+        args.each do |arg|
+          arg.split(/ *, */).each do |a|
+            m = a.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
+            tokens.push({
+                          token: m['tok'],
+                          required: all_req || (!m['req'].nil? && m['req'] == '+'),
+                          negate: !m['req'].nil? && m['req'] =~ /[!-]/
+                        })
+          end
         end
       end
-    end
 
-    NA.list_projects(query: tokens, depth: options[:depth], paths: options[:paths])
+      NA.list_projects(query: tokens, depth: options[:depth], paths: options[:paths])
+    end
   end
 end

data/bin/commands/prompt.rb

@@ -1,48 +1,51 @@
 # frozen_string_literal: true
 
-desc 'Show or install prompt hooks for the current shell'
-long_desc 'Installing the prompt hook allows you to automatically
-list next actions when you cd into a directory'
-command %i[prompt] do |c|
-  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.command %i[show] do |s|
-    s.action do |_global_options, _options, args|
-      shell = if args.count.positive?
-                args[0]
-              else
-                File.basename(ENV['SHELL'])
-              end
+class App
+  extend GLI::App
+  desc 'Show or install prompt hooks for the current shell'
+  long_desc 'Installing the prompt hook allows you to automatically
+  list next actions when you cd into a directory'
+  command %i[prompt] do |c|
+    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.command %i[show] do |s|
+      s.action do |_global_options, _options, args|
+        shell = if args.count.positive?
+                  args[0]
+                else
+                  File.basename(ENV['SHELL'])
+                end
 
-      case shell
-      when /^f/i
-        NA::Prompt.show_prompt_hook(:fish)
-      when /^z/i
-        NA::Prompt.show_prompt_hook(:zsh)
-      when /^b/i
-        NA::Prompt.show_prompt_hook(:bash)
+        case shell
+        when /^f/i
+          NA::Prompt.show_prompt_hook(:fish)
+        when /^z/i
+          NA::Prompt.show_prompt_hook(:zsh)
+        when /^b/i
+          NA::Prompt.show_prompt_hook(:bash)
+        end
       end
     end
-  end
 
-  c.desc 'Install the hook for the current shell to the appropriate startup file.'
-  c.arg_name 'SHELL', optional: true
-  c.command %i[install] do |s|
-    s.action do |_global_options, _options, args|
-      shell = if args.count.positive?
-                args[0]
-              else
-                File.basename(ENV['SHELL'])
-              end
+    c.desc 'Install the hook for the current shell to the appropriate startup file.'
+    c.arg_name 'SHELL', optional: true
+    c.command %i[install] do |s|
+      s.action do |_global_options, _options, args|
+        shell = if args.count.positive?
+                  args[0]
+                else
+                  File.basename(ENV['SHELL'])
+                end
 
-      case shell
-      when /^f/i
-        NA::Prompt.install_prompt_hook(:fish)
-      when /^z/i
-        NA::Prompt.install_prompt_hook(:zsh)
-      when /^b/i
-        NA::Prompt.install_prompt_hook(:bash)
+        case shell
+        when /^f/i
+          NA::Prompt.install_prompt_hook(:fish)
+        when /^z/i
+          NA::Prompt.install_prompt_hook(:zsh)
+        when /^b/i
+          NA::Prompt.install_prompt_hook(:bash)
+        end
       end
     end
   end

data/bin/commands/saved.rb

@@ -1,39 +1,47 @@
 # frozen_string_literal: true
 
-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.example 'na tagged "+maybe,+priority<=3" --save maybelater', description: 'save a search called "maybelater"'
-  c.example 'na saved maybelater', description: 'perform the search named "maybelater"'
-  c.example 'na saved maybe',
-            description: 'perform the search named "maybelater", assuming no other searches match "maybe"'
-  c.example 'na maybe',
-            description: 'na run with no command and a single argument automatically performs a matching saved search'
-  c.example 'na saved', description: 'list available searches'
-
-  c.desc 'Open the saved search file in $EDITOR'
-  c.switch %i[e edit], negatable: false
-
-  c.desc 'Delete the specified search definition'
-  c.switch %i[d delete], negatable: false
-
-  c.action do |_global_options, options, args|
-    NA.edit_searches if options[:edit]
-
-    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
-      NA.delete_search(args) if options[:delete]
-
-      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)
+class App
+  extend GLI::App
+  desc 'Execute a saved search'
+  long_desc 'Run without argument to list saved searches'
+  arg_name 'SEARCH_TITLE', optional: true, multiple: true
+  command %i[saved] do |c|
+    c.example 'na tagged "+maybe,+priority<=3" --save maybelater', desc: 'save a search called "maybelater"'
+    c.example 'na saved maybelater', desc: 'perform the search named "maybelater"'
+    c.example 'na saved maybe',
+              desc: 'perform the search named "maybelater", assuming no other searches match "maybe"'
+    c.example 'na maybe',
+              desc: 'na run with no command and a single argument automatically performs a matching saved search'
+    c.example 'na saved', desc: 'list available searches'
+
+    c.desc 'Open the saved search file in $EDITOR'
+    c.switch %i[e edit], negatable: false
+
+    c.desc 'Delete the specified search definition'
+    c.switch %i[d delete], negatable: false
+
+    c.action do |_global_options, options, args|
+      NA.edit_searches if options[:edit]
+
+      if args.empty?
+        searches = NA.load_searches
+        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
+        args.each do |arg|
+          searches = NA.load_searches
+
+          NA.delete_search(arg) if options[:delete]
+
+          keys = searches.keys.delete_if { |k| k !~ /#{arg}/ }
+          NA.notify("{r}Search #{arg} not found", exit_code: 1) if keys.empty?
+
+          key = keys[0]
+          cmd = Shellwords.shellsplit(searches[key])
+          run(cmd)
+        end
+        exit
+      end
     end
   end
 end