doing 2.1.26 → 2.1.27

data/bin/commands/tags.rb

@@ -18,41 +18,14 @@ command :tags do |c|
 
   c.desc 'Sort order (asc/desc)'
   c.arg_name 'ORDER'
-  c.flag %i[o order], must_match: REGEX_SORT_ORDER, default_value: 'asc'
-
-  c.desc 'Get tags for entries matching tags. Combine multiple tags with a comma. Wildcards allowed (*, ?)'
-  c.arg_name 'TAG'
-  c.flag [:tag]
-
-  c.desc 'Get tags for items matching search. Surround with
-  slashes for regex (e.g. "/query/"), start with a single quote for exact match ("\'query").'
-  c.arg_name 'QUERY'
-  c.flag [:search]
-
-  c.desc 'Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool'
-  c.arg_name 'QUERY'
-  c.flag [:val], multiple: true, must_match: REGEX_VALUE_QUERY
-
-  # c.desc '[DEPRECATED] Use alternative fuzzy matching for search string'
-  # c.switch [:fuzzy], default_value: false, negatable: false
-
-  c.desc 'Force exact search string matching (case sensitive)'
-  c.switch %i[x exact], default_value: @config.exact_match?, negatable: @config.exact_match?
-
-  c.desc 'Get tags from items that *don\'t* match search/tag filters'
-  c.switch [:not], default_value: false, negatable: false
-
-  c.desc 'Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]'
-  c.arg_name 'TYPE'
-  c.flag [:case], must_match: /^[csi]/, default_value: @settings.dig('search', 'case')
-
-  c.desc 'Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans'
-  c.arg_name 'BOOLEAN'
-  c.flag [:bool], must_match: REGEX_BOOL, default_value: 'PATTERN'
+  c.flag %i[o order], must_match: REGEX_SORT_ORDER, default_value: :asc, type: OrderSymbol
 
   c.desc 'Select items to scan from a menu of matching entries'
   c.switch %i[i interactive], negatable: false, default_value: false
 
+  add_options(:search, c)
+  add_options(:tag_filter, c)
+
   c.action do |_global, options, args|
     section = @wwid.guess_section(options[:section]) || options[:section].cap_first
     options[:count] = args.count.positive? ? args[0].to_i : 0
@@ -78,7 +51,7 @@ command :tags do |c|
       tags = tags.sort_by { |tag, count| count }
     end
 
-    tags.reverse! if options[:order].normalize_order == 'desc'
+    tags.reverse! if options[:order] == :desc
 
     if options[:counts]
       tags.each { |t, c| puts "#{t} (#{c})" }

data/bin/commands/today.rb

@@ -22,10 +22,9 @@ command :today do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = 'time'
-  default = @settings['tag_sort'] || 'name'
+  default = @settings['tag_sort'].normalize_tag_sort || :name
   c.arg_name 'KEY'
-  c.flag [:tag_sort], must_match: /^(?:name|time)$/i, default_value: default
+  c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 
   c.desc "Output to export format (#{Doing::Plugins.plugin_names(type: :export)})"
   c.arg_name 'FORMAT'
@@ -57,7 +56,7 @@ command :today do |c|
     raise DoingRuntimeError, %(Invalid output type "#{options[:output]}") if options[:output] && options[:output] !~ Doing::Plugins.plugin_regex(type: :export)
 
     options[:times] = true if options[:totals]
-    options[:sort_tags] = options[:tag_sort] =~ /^n/i
+    options[:sort_tags] = options[:tag_sort]
     filter_options = %i[after before duration from section sort_tags totals template config_template].each_with_object({}) { |k, hsh| hsh[k] = options[k] }
 
     Doing::Pager.page @wwid.today(options[:times], options[:output], filter_options).chomp

data/bin/commands/view.rb

@@ -21,7 +21,7 @@ command :view do |c|
 
   c.desc 'Age (oldest|newest)'
   c.arg_name 'AGE'
-  c.flag %i[age], default_value: 'newest'
+  c.flag %i[age], default_value: :newest, type: AgeSymbol
 
   c.desc 'Show time intervals on @done tasks'
   c.switch %i[t times], default_value: true, negatable: true
@@ -35,64 +35,16 @@ command :view do |c|
   c.desc 'Include colors in output'
   c.switch [:color], default_value: true, negatable: true
 
-  c.desc 'Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?)'
-  c.arg_name 'TAG'
-  c.flag [:tag]
-
-  c.desc 'Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool'
-  c.arg_name 'QUERY'
-  c.flag [:val], multiple: true, must_match: REGEX_VALUE_QUERY
-
-  c.desc 'Tag boolean (AND,OR,NOT). Use PATTERN to parse + and - as booleans'
-  c.arg_name 'BOOLEAN'
-  c.flag %i[b bool], must_match: REGEX_BOOL, default_value: 'PATTERN'
-
-  c.desc 'Search filter, surround with slashes for regex (/query/), start with single quote for exact match ("\'query")'
-  c.arg_name 'QUERY'
-  c.flag [:search]
-
   c.desc "Highlight search matches in output. Only affects command line output"
   c.switch %i[h hilite], default_value: @settings.dig('search', 'highlight')
 
-  # c.desc '[DEPRECATED] Use alternative fuzzy matching for search string'
-  # c.switch [:fuzzy], default_value: false, negatable: false
-
-  c.desc 'Force exact search string matching (case sensitive)'
-  c.switch %i[x exact], default_value: @config.exact_match?, negatable: @config.exact_match?
-
-  c.desc 'Show items that *don\'t* match search string'
-  c.switch [:not], default_value: false, negatable: false
-
-  c.desc 'Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]'
-  c.arg_name 'TYPE'
-  c.flag [:case], must_match: /^[csi]/, default_value: @settings.dig('search', 'case')
-
   c.desc 'Sort tags by (name|time)'
   c.arg_name 'KEY'
-  c.flag [:tag_sort], must_match: /^(?:name|time)$/i
+  c.flag [:tag_sort], must_match: REGEX_TAG_SORT, type: TagSortSymbol
 
   c.desc 'Tag sort direction (asc|desc)'
   c.arg_name 'DIRECTION'
-  c.flag [:tag_order], must_match: REGEX_SORT_ORDER
-
-  c.desc 'View entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day'
-  c.arg_name 'DATE_STRING'
-  c.flag [:before], type: DateBeginString
-
-  c.desc 'View entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day'
-  c.arg_name 'DATE_STRING'
-  c.flag [:after], type: DateEndString
-
-  c.desc %(
-      Date range to show, or a single day to filter date on.
-      Date range argument should be quoted. Date specifications can be natural language.
-      To specify a range, use "to" or "through": `doing view --from "monday 8am to friday 5pm" view_name`.
-
-      If values are only time(s) (6am to noon) all dates will be included, but entries will be filtered
-      by time of day.
-    )
-  c.arg_name 'DATE_OR_RANGE'
-  c.flag [:from], type: DateRangeString
+  c.flag [:tag_order], must_match: REGEX_SORT_ORDER, type: OrderSymbol
 
   c.desc 'Only show items with recorded time intervals (override view settings)'
   c.switch [:only_timed], default_value: false, negatable: false
@@ -100,9 +52,16 @@ command :view do |c|
   c.desc 'Select from a menu of matching entries to perform additional operations'
   c.switch %i[i interactive], negatable: false, default_value: false
 
+  add_options(:search, c)
+  add_options(:tag_filter, c)
+  add_options(:date_filter, c)
+
   c.action do |global_options, options, args|
     options[:fuzzy] = false
-    raise DoingRuntimeError, %(Invalid output type "#{options[:output]}") if options[:output] && options[:output] !~ Doing::Plugins.plugin_regex(type: :export)
+    if options[:output] && options[:output] !~ Doing::Plugins.plugin_regex(type: :export)
+      raise DoingRuntimeError, %(Invalid output type "#{options[:output]}")
+
+    end
 
     raise InvalidArgument, '--tag and --search can not be used together' if options[:tag] && options[:search]
 
@@ -111,20 +70,20 @@ command :view do |c|
             else
               begin
                 @wwid.guess_view(args[0])
-              rescue WrongCommand => exception
+              rescue WrongCommand
                 cmd = commands[:show]
-                options[:sort] = 'asc'
-                options[:tag_order] = 'asc'
+                options[:sort] = :asc
+                options[:tag_order] = :asc
                 action = cmd.send(:get_action, nil)
                 return action.call(global_options, options, args)
               end
             end
 
-    if options[:section]
-      section = @wwid.guess_section(options[:section]) || options[:section].cap_first
-    else
-      section = @settings['current_section']
-    end
+    section = if options[:section]
+                @wwid.guess_section(options[:section]) || options[:section].cap_first
+              else
+                @settings['current_section']
+              end
 
     view = @wwid.get_view(title)
 
@@ -143,7 +102,7 @@ command :view do |c|
       tag_filter = false
       if options[:tag]
         tag_filter = { 'tags' => [], 'bool' => 'OR' }
-        bool = options[:bool].normalize_bool
+        bool = options[:bool]
         tag_filter['bool'] = bool
         tag_filter['tags'] = if bool == :pattern
                                options[:tag]
@@ -164,41 +123,45 @@ command :view do |c|
       # If the -o/--output flag was specified, override any default in the view template
       options[:output] ||= view.key?('output_format') ? view['output_format'] : 'template'
 
-      count = options[:count] ? options[:count] : view.key?('count') ? view['count'] : 10
+      count = if options[:count]
+                options[:count]
+              elsif view.key?('count')
+                view['count']
+              else
+                10
+              end
 
       section = if options[:section]
                   section
                 else
                   view['section'] || @settings['current_section']
                 end
-      order = view['order']&.normalize_order || 'asc'
+      order = if view.key?('order')
+                view['order'].normalize_order
+              else
+                :asc
+              end
 
       totals = if options[:totals]
                  true
                else
                  view['totals'] || false
                end
-      tag_order = if options[:tag_order]
-                    options[:tag_order].normalize_order
-                  else
-                    view['tag_order']&.normalize_order || 'asc'
-                  end
+      tag_order = options[:tag_order] || view['tag_order']&.normalize_order || :asc
 
       options[:times] = true if totals
       output_format = options[:output]&.downcase || 'template'
 
       options[:sort_tags] = if options[:tag_sort]
-                              options[:tag_sort] =~ /^n/i ? true : false
+                              options[:tag_sort]
                             elsif view.key?('tag_sort')
-                              view['tag_sort'] =~ /^n/i ? true : false
+                              view['tag_sort'].normalize_tag_sort
                             else
                               false
                             end
 
       %w[before after from duration].each { |k| options[k.to_sym] = view[k] if view.key?(k) && !options[k.to_sym] }
 
-      options[:case] = options[:case].normalize_case
-
       search = nil
 
       if options[:search]
@@ -209,7 +172,7 @@ command :view do |c|
       options[:age] ||= :newest
 
       opts = options.clone
-      opts[:age] = options[:age].normalize_age(:newest)
+      opts[:age] = options[:age]
       opts[:count] = count
       opts[:format] = date_format
       opts[:highlight] = options[:color]

data/bin/commands/yesterday.rb

@@ -33,9 +33,9 @@ command :yesterday do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'] || 'name'
+  default = @settings['tag_sort'].normalize_tag_sort || :name
   c.arg_name 'KEY'
-  c.flag [:tag_sort], must_match: /^(?:name|time)$/i, default_value: default
+  c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 
   c.desc 'View entries before specified time (e.g. 8am, 12:30pm, 15:00)'
   c.arg_name 'TIME_STRING'
@@ -51,12 +51,12 @@ command :yesterday do |c|
 
   c.desc 'Tag sort direction (asc|desc)'
   c.arg_name 'DIRECTION'
-  c.flag [:tag_order], must_match: REGEX_SORT_ORDER, default_value: 'asc'
+  c.flag [:tag_order], must_match: REGEX_SORT_ORDER, default_value: :asc, type: OrderSymbol
 
   c.action do |_global_options, options, _args|
     raise DoingRuntimeError, %(Invalid output type "#{options[:output]}") if options[:output] && options[:output] !~ Doing::Plugins.plugin_regex(type: :export)
 
-    options[:sort_tags] = options[:tag_sort] =~ /^n/i
+    options[:sort_tags] = options[:tag_sort]
 
     if options[:from]
       options[:from] = options[:from].split(/#{REGEX_RANGE_INDICATOR}/).map do |time|
@@ -65,7 +65,6 @@ command :yesterday do |c|
     end
 
     opt = options.clone
-    opt[:tag_order] = options[:tag_order].normalize_order
     opt[:order] = @settings.dig('templates', options[:config_template], 'order')
 
     Doing::Pager.page @wwid.yesterday(options[:section], options[:times], options[:output], opt).chomp

data/bin/doing

@@ -38,11 +38,11 @@ env_log_level = nil
 if ENV['DOING_LOG_LEVEL'] || ENV['DOING_DEBUG'] || ENV['DOING_QUIET'] || ENV['DOING_VERBOSE'] || ENV['DOING_PLUGIN_DEBUG']
   env_log_level = true
   # Quiet always wins
-  if ENV['DOING_QUIET'] && ENV['DOING_QUIET'].truthy?
+  if ENV['DOING_QUIET']&.truthy?
     Doing.logger.log_level = :error
-  elsif (ENV['DOING_PLUGIN_DEBUG'] && ENV['DOING_PLUGIN_DEBUG'].truthy?)
+  elsif ENV['DOING_PLUGIN_DEBUG']&.truthy?
     Doing.logger.log_level = :debug
-  elsif (ENV['DOING_DEBUG'] && ENV['DOING_DEBUG'].truthy?)
+  elsif ENV['DOING_DEBUG']&.truthy?
     Doing.logger.log_level = :debug
   elsif ENV['DOING_LOG_LEVEL']
     Doing.logger.log_level = ENV['DOING_LOG_LEVEL']
@@ -51,11 +51,8 @@ end
 
 Doing.logger.benchmark(:total, :start)
 
-if ENV['DOING_CONFIG']
-  Doing.config_with(ENV['DOING_CONFIG'], { ignore_local: true })
-end
-
 Doing.logger.benchmark(:configure, :start)
+Doing.config_with(ENV['DOING_CONFIG'], { ignore_local: true }) if ENV['DOING_CONFIG']
 @config = Doing.config
 Doing.logger.benchmark(:configure, :finish)
 
@@ -63,8 +60,30 @@ Doing.logger.benchmark(:configure, :finish)
 @settings = @config.settings
 @wwid.config = @settings
 
-if @settings.dig('plugins', 'command_path')
-  commands_from File.expand_path(@settings.dig('plugins', 'command_path'))
+commands_from File.expand_path(@settings.dig('plugins', 'command_path')) if @settings.dig('plugins', 'command_path')
+
+accept BooleanSymbol do |value|
+  value.normalize_bool(:pattern)
+end
+
+accept CaseSymbol do |value|
+  value.normalize_case(@config.fetch('search', 'case', :smart))
+end
+
+accept AgeSymbol do |value|
+  value.normalize_age(:newest)
+end
+
+accept OrderSymbol do |value|
+  value.normalize_order(:asc)
+end
+
+accept MatchingSymbol do |value|
+  value.normalize_matching(:pattern)
+end
+
+accept TagSortSymbol do |value|
+  value.normalize_tag_sort(@config.fetch('tag_sort', :name))
 end
 
 accept TemplateName do |value|
@@ -119,7 +138,123 @@ accept DateIntervalString do |value|
 end
 
 accept TagArray do |value|
-  value.gsub(/[, ]+/, ' ').split(' ').map { |tag| tag.sub(/^@/, '')}.map(&:strip)
+  value.gsub(/[, ]+/, ' ').split(' ').map { |tag| tag.sub(/^@/, '') }.map(&:strip)
+end
+
+##
+## Add presets of flags and switches to a command.
+##
+## :add_entry => --noauto, --note, --ask, --editor, --back
+##
+## :search => --search, --case, --exact
+##
+## :tag_filter => --tag, --bool, --not, --val
+##
+## :date_filter => --before, --after, --from
+##
+## @param      type  [Symbol] The type
+## @param      cmd   The GLI command to which the options will be added
+##
+def add_options(type, cmd)
+  cmd_name = cmd.name.to_s
+  action = case cmd_name
+           when /again/
+             'Repeat'
+           when /grep/
+             'Search'
+           when /mark/
+             'Flag'
+           when /(last|tags|view)/
+             'Show'
+           else
+             cmd_name.capitalize
+           end
+
+  case type
+  when :add_entry
+    cmd.desc 'Exclude auto tags and default tags'
+    cmd.switch %i[X noauto], default_value: false, negatable: false
+
+    cmd.desc 'Include a note'
+    cmd.arg_name 'TEXT'
+    cmd.flag %i[n note]
+
+    cmd.desc 'Prompt for note via multi-line input'
+    cmd.switch %i[ask], negatable: false, default_value: false
+
+    cmd.desc "Edit entry with #{Doing::Util.default_editor}"
+    cmd.switch %i[e editor], negatable: false, default_value: false
+
+    cmd.desc 'Backdate start date for new entry to date string [4pm|20m|2h|yesterday noon]'
+    cmd.arg_name 'DATE_STRING'
+    cmd.flag %i[b back started], type: DateBeginString
+  when :search
+    cmd.desc 'Filter entries using a search query, surround with slashes for regex (e.g. "/query.*/"),
+            start with single quote for exact match ("\'query")'
+    cmd.arg_name 'QUERY'
+    cmd.flag [:search]
+
+    cmd.desc 'Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]'
+    cmd.arg_name 'TYPE'
+    cmd.flag [:case], must_match: REGEX_CASE,
+                      default_value: @settings.dig('search', 'case').normalize_case,
+                      type: CaseSymbol
+
+    cmd.desc 'Force exact search string matching (case sensitive)'
+    cmd.switch %i[x exact], default_value: @config.exact_match?, negatable: @config.exact_match?
+  when :tag_filter
+    cmd.desc 'Filter entries by tag. Combine multiple tags with a comma. Wildcards allowed (*, ?)'
+    cmd.arg_name 'TAG'
+    cmd.flag [:tag], type: TagArray
+
+    cmd.desc 'Perform a tag value query ("@done > two hours ago" or "@progress < 50").
+            May be used multiple times, combined with --bool'
+    cmd.arg_name 'QUERY'
+    cmd.flag [:val], multiple: true, must_match: REGEX_VALUE_QUERY
+
+    cmd.desc "#{action} items that *don't* match search/tag filters"
+    cmd.switch [:not], default_value: false, negatable: false
+
+    cmd.desc 'Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans'
+    cmd.arg_name 'BOOLEAN'
+    cmd.flag [:bool], must_match: REGEX_BOOL,
+                      default_value: :pattern,
+                      type: BooleanSymbol
+  when :date_filter
+    if action =~ /Archive/
+      cmd.desc 'Archive entries older than date (natural language).'
+    else
+      cmd.desc "#{action} entries older than date (natural language). If this is only a time (8am, 1:30pm, 15:00), all
+              dates will be included, but entries will be filtered by time of day"
+    end
+    cmd.arg_name 'DATE_STRING'
+    cmd.flag [:before], type: DateBeginString
+
+    if action =~ /Archive/
+      cmd.desc 'Archive entries newer than date (natural language).'
+    else
+      cmd.desc "#{action} entries newer than date (natural language). If this is only a time (8am, 1:30pm, 15:00), all
+              dates will be included, but entries will be filtered by time of day"
+    end
+    cmd.arg_name 'DATE_STRING'
+    cmd.flag [:after], type: DateEndString
+
+    if action =~ /Archive/
+      cmd.desc %(
+          Date range (natural language) to archive: `doing archive --from "1/1/21 to 12/31/21"`.
+        )
+    else
+      cmd.desc %(
+        Date range (natural language) to #{action.downcase}, or a single day to filter on.
+        To specify a range, use "to": `doing #{cmd_name} --from "monday 8am to friday 5pm"`.
+
+        If values are only time(s) (6am to noon) all dates will be included, but entries will be filtered
+        by time of day.
+      )
+    end
+    cmd.arg_name 'DATE_OR_RANGE'
+    cmd.flag [:from], type: DateRangeString
+  end
 end
 
 program_desc 'A CLI for a What Was I Doing system'
@@ -192,7 +327,6 @@ add_commands(%w[commands_accepting install_fzf])
 ## Optional commands
 add_commands(%w[again cancel flag meanwhile reset tags today yesterday since add_section tag_dir colors completion plugins sections template views changes])
 
-
 pre do |global, _command, _options, _args|
   # global[:pager] ||= @settings['paginate']
   Doing::Pager.paginate = global[:pager]
@@ -232,6 +366,7 @@ post do |global, _command, _options, _args|
 end
 
 around do |global, command, options, arguments, code|
+  Doing.logger.benchmark("command_#{command.name.to_s}".to_sym, :start)
   # Doing.logger.debug('Pager:', "Global: #{global[:pager]}, Config: #{@settings['paginate']}, Pager: #{Doing::Pager.paginate}")
   if env_log_level.nil?
     Doing.logger.adjust_verbosity(global)
@@ -242,10 +377,10 @@ around do |global, command, options, arguments, code|
   end
 
   if global[:yes]
-    Doing::Prompt.force_answer = true
+    Doing::Prompt.force_answer = :yes
     Doing.config.force_answer = true
   elsif global[:no]
-    Doing::Prompt.force_answer = false
+    Doing::Prompt.force_answer = :no
     Doing.config.force_answer = false
   else
     Doing::Prompt.default_answer = if $stdout.isatty
@@ -281,6 +416,8 @@ around do |global, command, options, arguments, code|
   global[:wwid] = @wwid
 
   code.call
+
+  Doing.logger.benchmark("command_#{command.name.to_s}".to_sym, :finish)
 end
 
 exit run(ARGV)