doing 2.1.30 → 2.1.31pre

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doing (2.1.30)
+    doing (2.1.31pre)
       chronic (~> 0.10, >= 0.10.2)
       deep_merge (~> 1.2, >= 1.2.1)
       gli (~> 2.20, >= 2.20.1)

data/README.md

@@ -8,7 +8,7 @@ _If you're one of the rare people like me who find this useful, feel free to
 
 <!--README-->
 
-The current version of `doing` is <!--VER-->2.1.29<!--END VER-->.
+The current version of `doing` is <!--VER-->2.1.30<!--END VER-->.
 
 Find all of the documentation in the [doing wiki][wiki].
 

data/bin/commands/again.rb

@@ -39,7 +39,7 @@ command %i[again resume] do |c|
 
     if options[:back]
       options[:date] = options[:back]
-      raise InvalidTimeExpression, 'Unable to parse date string for --back' if date.nil?
+      raise InvalidTimeExpression, 'Unable to parse date string for --back' if options[:date].nil?
 
     else
       options[:date] = Time.now

data/bin/commands/archive.rb

@@ -5,9 +5,9 @@ desc 'Move entries between sections'
 long_desc %(Argument can be a section name to move all entries from a section,
 or start with an "@" to move entries matching a tag.
 
-Default with no argument moves items from the "#{@settings['current_section']}" section to Archive.)
+Default with no argument moves items from the "#{Doing.setting('current_section')}" section to Archive.)
 arg_name 'SECTION_OR_TAG'
-default_value @settings['current_section']
+default_value Doing.setting('current_section')
 command %i[archive move] do |c|
   c.example 'doing archive Currently', desc: 'Move all entries in the Currently section to Archive section'
   c.example 'doing archive @done', desc: 'Move all entries tagged @done to Archive'
@@ -33,7 +33,7 @@ command %i[archive move] do |c|
   c.action do |_global_options, options, args|
     options[:fuzzy] = false
     section, tags = if args.empty?
-                      [@settings['current_section'], []]
+                      [Doing.setting('current_section'), []]
                     elsif args[0] =~ /^all/i
                       ['all', []]
                     elsif args[0] =~ /^@\S+/

data/bin/commands/cancel.rb

@@ -30,7 +30,7 @@ command :cancel do |c|
     options[:section] = if options[:section]
                           @wwid.guess_section(options[:section]) || options[:section].cap_first
                         else
-                          @settings['current_section']
+                          Doing.setting('current_section')
                         end
 
     raise InvalidArgument, 'Only one argument allowed' if args.length > 1

data/bin/commands/commands.rb

@@ -15,8 +15,8 @@ command :commands do |c|
   c.arg_name 'COMMAND [COMMAND...]'
   c.command %i[add enable] do |add|
     add.action do |_global, _options, args|
-      cfg = @settings
-      custom_dir = @settings.dig('plugins', 'command_path')
+      cfg = Doing.settings
+      custom_dir = cfg.dig('plugins', 'command_path')
 
       available = cfg['disabled_commands']
       raise UserCancelled, 'No commands available to enable' unless args.good? || available.good?
@@ -45,8 +45,8 @@ command :commands do |c|
 
       cfg.deep_set(['disabled_commands'], available)
 
-      Doing::Util.write_to_file(@config.config_file, YAML.dump(cfg), backup: true)
-      Doing.logger.warn('Config:', "#{@config.config_file} updated")
+      Doing::Util.write_to_file(Doing.config.config_file, YAML.dump(cfg), backup: true)
+      Doing.logger.warn('Config:', "#{Doing.config.config_file} updated")
     end
   end
 
@@ -55,8 +55,8 @@ command :commands do |c|
   c.command %i[remove disable] do |remove|
     remove.action do |_global, _options, args|
       available = Dir.glob(File.join(File.dirname(__FILE__), '*.rb')).map { |cmd| File.basename(cmd, '.rb') }
-      cfg = @settings
-      custom_dir = @settings.dig('plugins', 'command_path')
+      cfg = Doing.settings
+      custom_dir = cfg.dig('plugins', 'command_path')
       custom_commands = Dir.glob(File.join(File.expand_path(custom_dir), '*.rb'))
       available.concat(custom_commands.map { |cmd| File.basename(cmd, '.rb') })
       disabled = cfg['disabled_commands']
@@ -82,8 +82,8 @@ command :commands do |c|
 
       cfg.deep_set(['disabled_commands'], disabled.concat(to_disable))
 
-      Doing::Util.write_to_file(@config.config_file, YAML.dump(cfg), backup: true)
-      Doing.logger.warn('Config:', "#{@config.config_file} updated")
+      Doing::Util.write_to_file(Doing.config.config_file, YAML.dump(cfg), backup: true)
+      Doing.logger.warn('Config:', "#{Doing.config.config_file} updated")
     end
   end
 end

data/bin/commands/completion.rb

@@ -1,27 +1,69 @@
 # frozen_string_literal: true
 
+SHELLS = %w[zsh bash fish all].freeze
+SHELL_RX = /^(?:[bzf](?:[ai]?sh)?|all)$/i.freeze
+
 # @@completion
-desc 'Generate shell completion scripts'
+desc 'Generate shell completion scripts for doing'
 long_desc 'Generates the necessary scripts to add command line completion to various shells,
 so typing \'doing\' and hitting tab will offer completions of subcommands and their options.'
 command :completion do |c|
-  c.example 'doing completion', desc: 'Output zsh (default) to STDOUT'
-  c.example 'doing completion --type zsh --file ~/.zsh-completions/_doing.zsh',
-            desc: 'Output zsh completions to file'
-  c.example 'doing completion --type fish --file ~/.config/fish/completions/doing.fish',
-            desc: 'Output fish completions to file'
-  c.example 'doing completion --type bash --file ~/.bash_it/completion/enabled/doing.bash',
-            desc: 'Output bash completions to file'
-
-  c.desc 'Shell to generate for (bash, zsh, fish)'
-  c.arg_name 'SHELL'
-  c.flag %i[t type], must_match: /^(?:[bzf](?:[ai]?sh)?|all)$/i, default_value: 'zsh'
-
-  c.desc 'File to write output to'
-  c.arg_name 'PATH'
-  c.flag %i[f file], default_value: 'STDOUT'
-
-  c.action do |_global_options, options, _args|
-    Doing::Completion.generate_completion(type: options[:type], file: options[:file])
+  c.example 'doing completion install zsh',
+            desc: 'Install the default zsh completion script and link it to the zsh autolaod directory.'
+  c.example 'doing completion generate zsh', desc: 'Generate zsh (default) script to default file, offer to symlink'
+  c.example 'doing completion generate fish --file ~/doing.fish',
+            desc: 'Generate fish completions to alternative file'
+
+  c.desc 'Deprecated, specify shell as argument to subcommand'
+  c.flag %i[t type], must_match: SHELL_RX
+
+  c.desc 'Generate completion scripts, including custom plugins and command options'
+  c.long_desc "Argument specifies which shell to install for: #{SHELLS.join(', ')}"
+  c.arg_name "[#{SHELLS.join('|')}]"
+  c.command :generate do |gen|
+    gen.example 'doing completion generate fish', desc: 'Generate fish completion script and link to autoload directory'
+    gen.example 'doing completion generate zsh --file ~/.zsh-completions/doing.zsh', desc: 'Generate zsh completion script and save to alternative file'
+
+    gen.desc 'Alternative file to write output to'
+    gen.arg_name 'PATH'
+    gen.flag %i[f file]
+
+    gen.desc 'Output result to STDOUT only'
+    gen.switch [:stdout], negatable: false
+
+    gen.action do |_global_options, options, args|
+      args = [options[:type]] if options[:type] && args.count.zero?
+
+      raise MissingArgument, "Specify a shell (#{SHELLS.join('|')})" unless args.count.positive?
+
+      file = options[:stdout] ? 'stdout' : options[:file] || :default
+
+      raise InvalidArgument, '--file can not be used with multiple arguments' if options[:file] && args.count > 1
+
+      args.each do |shell|
+        type = Doing::Completion.normalize_type(shell)
+        raise InvalidArgument, "Unknown shell #{shell}" if type == :invalid
+
+        Doing::Completion.generate_completion(type: type, file: file)
+      end
+    end
+  end
+
+  c.desc 'Install default completion scripts'
+  c.long_desc 'Argument specifies which shell to install for: zsh, bash, fish, or all'
+  c.arg_name '[zsh|bash|fish]'
+  c.command :install do |install|
+    install.example 'doing completion install zsh', desc: 'Install and link zsh completion script'
+
+    # install.flag %i[t type], must_match: /^(?:[bzf](?:[ai]?sh)?|all)$/i
+
+    install.action do |_global_options, options, args|
+      type = options[:type] || args[0]&.strip || 'zsh'
+      raise InvalidArgument, "Unknown shell #{type}" unless type =~ SHELL_RX
+
+      Doing::Completion.link_default(type)
+    end
   end
+
+  c.default_command :generate
 end

data/bin/commands/config.rb

@@ -30,8 +30,8 @@ command :config do |c|
   Values defined in the top item in the list will override values in configutations below it.'
   c.command :list do |list|
     list.action do |global, options, args|
-      puts @config.additional_configs.join("\n")
-      puts @config.config_file
+      puts Doing.config.additional_configs.join("\n")
+      puts Doing.config.config_file
     end
   end
 
@@ -74,7 +74,7 @@ command :config do |c|
         return
       end
 
-      config_file = @config.choose_config
+      config_file = Doing.config.choose_config
 
       if Sys::Platform.mac?
         if options[:default]
@@ -118,7 +118,7 @@ command :config do |c|
   c.desc 'Update default config file, adding any missing keys'
   c.command %i[update refresh] do |update|
     update.action do |_global, options, args|
-      @config.configure({rewrite: true, ignore_local: true})
+      Doing.config.configure({rewrite: true, ignore_local: true})
       Doing.logger.warn('Config:', 'config refreshed')
     end
   end
@@ -127,7 +127,7 @@ command :config do |c|
   c.desc 'Undo the last change to a config file'
   c.command :undo do |undo|
     undo.action do |_global, options, args|
-      config_file = @config.choose_config
+      config_file = Doing.config.choose_config
       Doing::Util::Backup.restore_last_backup(config_file, count: 1)
     end
   end
@@ -148,8 +148,8 @@ command :config do |c|
     dump.action do |_global, options, args|
 
       keypath = args.join('.')
-      cfg = @config.value_for_key(keypath)
-      real_path = @config.resolve_key_path(keypath)
+      cfg = Doing.config.value_for_key(keypath)
+      real_path = Doing.config.resolve_key_path(keypath)
 
       if cfg
         val = cfg.map {|k, v| v }[0]
@@ -201,7 +201,7 @@ command :config do |c|
 
       value = options[:remove] ? nil : args.pop
       keypath = args.join('.')
-      real_path = @config.resolve_key_path(keypath, create: true)
+      real_path = Doing.config.resolve_key_path(keypath, create: true)
       old_value = @settings.dig(*real_path)
       old_type = old_value&.class.to_s || nil
 
@@ -216,7 +216,7 @@ command :config do |c|
 
       end
 
-      config_file = @config.choose_config(create: true)
+      config_file = Doing.config.choose_config(create: true)
 
       cfg = Doing::Util.safe_load_file(config_file) || {}
 

data/bin/commands/done.rb

@@ -98,7 +98,7 @@ command %i[done did] do |c|
     if options[:section]
       section = @wwid.guess_section(options[:section]) || options[:section].cap_first
     else
-      section = @settings['current_section']
+      section = Doing.setting('current_section')
     end
 
 

data/bin/commands/flag.rb

@@ -34,7 +34,7 @@ command %i[mark flag] do |c|
 
   c.action do |_global_options, options, _args|
     options[:fuzzy] = false
-    mark = @settings['marker_tag'] || 'flagged'
+    mark = Doing.setting('marker_tag', 'flagged')
 
     raise InvalidArgument, '--search and --tag can not be used together' if options[:search] && options[:tag]
 

data/bin/commands/grep.rb

@@ -38,7 +38,7 @@ command %i[grep search] do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'].normalize_tag_sort || :name
+  default = Doing.setting('tag_sort').normalize_tag_sort || :name
   c.arg_name 'KEY'
   c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 
@@ -49,7 +49,7 @@ command %i[grep search] do |c|
   # c.switch [:fuzzy], default_value: false, negatable: false
 
   c.desc 'Force exact string matching (case sensitive)'
-  c.switch %i[x exact], default_value: @config.exact_match?, negatable: @config.exact_match?
+  c.switch %i[x exact], default_value: Doing.config.exact_match?, negatable: Doing.config.exact_match?
 
   c.desc 'Show items that *don\'t* match search string'
   c.switch [:not], default_value: false, negatable: false
@@ -57,11 +57,11 @@ command %i[grep search] do |c|
   c.desc 'Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]'
   c.arg_name 'TYPE'
   c.flag [:case], must_match: REGEX_CASE,
-                  default_value: @settings.dig('search', 'case').normalize_case,
+                  default_value: Doing.settings.dig('search', 'case').normalize_case,
                   type: CaseSymbol
 
   c.desc "Highlight search matches in output. Only affects command line output"
-  c.switch %i[h hilite], default_value: @settings.dig('search', 'highlight')
+  c.switch %i[h hilite], default_value: Doing.settings.dig('search', 'highlight')
 
   c.desc "Edit matching entries with #{Doing::Util.default_editor}"
   c.switch %i[e editor], negatable: false, default_value: false
@@ -88,7 +88,7 @@ command %i[grep search] do |c|
     options[:fuzzy] = false
     raise DoingRuntimeError, %(Invalid output type "#{options[:output]}") if options[:output] && options[:output] !~ Doing::Plugins.plugin_regex(type: :export)
 
-    template = @settings['templates'][options[:config_template]].deep_merge(@settings)
+    template = Doing.setting(['templates', options[:config_template]]).deep_merge(Doing.settings)
     tags_color = template.key?('tags_color') ? template['tags_color'] : nil
 
     section = @wwid.guess_section(options[:section]) if options[:section]

data/bin/commands/last.rb

@@ -30,7 +30,7 @@ command :last do |c|
   c.flag [:template]
 
   c.desc "Highlight search matches in output. Only affects command line output"
-  c.switch %i[h hilite], default_value: @settings.dig('search', 'highlight')
+  c.switch %i[h hilite], default_value: Doing.settings.dig('search', 'highlight')
 
   c.desc 'Show elapsed time if entry is not tagged @done'
   c.switch [:duration]

data/bin/commands/meanwhile.rb

@@ -34,7 +34,7 @@ command :meanwhile do |c|
     if options[:section]
       section = @wwid.guess_section(options[:section]) || options[:section].cap_first
     else
-      section = @settings['current_section']
+      section = Doing.setting('current_section')
     end
     input = ''
 

data/bin/commands/now.rb

@@ -54,7 +54,7 @@ command %i[now next] do |c|
     section = if options[:section]
                 @wwid.guess_section(options[:section]) || options[:section].cap_first
               else
-                @settings['current_section']
+                Doing.setting('current_section')
               end
 
     ask_note = if options[:ask] && !options[:editor] && args.count.positive?

data/bin/commands/on.rb

@@ -23,7 +23,7 @@ command :on do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'].normalize_tag_sort || :name
+  default = Doing.setting('tag_sort').normalize_tag_sort || :name
   c.arg_name 'KEY'
   c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 

data/bin/commands/open.rb

@@ -1,7 +1,7 @@
 # @@open
 desc 'Open the "doing" file in an editor'
 long_desc "`doing open` defaults to using the editors.doing_file setting
-in #{@config.config_file} (#{Doing::Util.find_default_editor('doing_file')})."
+in #{Doing.config.config_file} (#{Doing::Util.find_default_editor('doing_file')})."
 command :open do |c|
   c.example 'doing open', desc: 'Open the doing file in the default editor'
   c.desc 'Open with editor command (e.g. vim, mate)'

data/bin/commands/recent.rb

@@ -30,7 +30,7 @@ command :recent do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'].normalize_tag_sort || :name
+  default = Doing.setting('tag_sort').normalize_tag_sort || :name
   c.arg_name 'KEY'
   c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 
@@ -41,8 +41,8 @@ command :recent do |c|
     section = @wwid.guess_section(options[:section]) || options[:section].cap_first
 
     unless global_options[:version]
-      if @settings['templates']['recent'].key?('count')
-        config_count = @settings['templates']['recent']['count'].to_i
+      if Doing.setting('templates.recent.count')
+        config_count = Doing.setting('templates.recent.count').to_i
       else
         config_count = 10
       end
@@ -56,7 +56,7 @@ command :recent do |c|
       options[:times] = true if options[:totals]
       options[:sort_tags] = options[:tag_sort]
 
-      template = @settings['templates']['recent'].deep_merge(@settings['templates']['default'])
+      template = Doing.setting('templates.recent').deep_merge(Doing.setting('templates.default'))
       tags_color = template.key?('tags_color') ? template['tags_color'] : nil
 
       opts = {

data/bin/commands/show.rb

@@ -27,7 +27,7 @@ command :show do |c|
   c.flag %i[a age], default_value: :newest, type: AgeSymbol
 
   c.desc "Highlight search matches in output. Only affects command line output"
-  c.switch %i[h hilite], default_value: @settings.dig('search', 'highlight')
+  c.switch %i[h hilite], default_value: Doing.settings.dig('search', 'highlight')
 
   c.desc 'Sort order (asc/desc)'
   c.arg_name 'ORDER'
@@ -43,7 +43,7 @@ command :show do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'].normalize_tag_sort || :name
+  default = Doing.setting('tag_sort').normalize_tag_sort || :name
   c.arg_name 'KEY'
   c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 
@@ -118,7 +118,7 @@ command :show do |c|
         end
       end
     else
-      section = options[:menu] ? @wwid.choose_section(include_all: true) : @settings['current_section']
+      section = options[:menu] ? @wwid.choose_section(include_all: true) : Doing.setting('current_section')
       section ||= 'All'
     end
 
@@ -126,11 +126,11 @@ command :show do |c|
 
     options[:times] = true if options[:totals]
 
-    template = @settings['templates'][options[:config_template]].deep_merge({
-                                                    'wrap_width' => @settings['wrap_width'] || 0,
-                                                    'date_format' => @settings['default_date_format'],
-                                                    'order' => @settings['order']&.normalize_order || :asc,
-                                                    'tags_color' => @settings['tags_color']
+    template = Doing.setting(['templates', options[:config_template]]).deep_merge({
+                                                    'wrap_width' => Doing.setting('wrap_width') || 0,
+                                                    'date_format' => Doing.setting('default_date_format'),
+                                                    'order' => Doing.setting('order')&.normalize_order || :asc,
+                                                    'tags_color' => Doing.setting('tags_color')
                                                   })
 
     if options[:search]

data/bin/commands/since.rb

@@ -21,7 +21,7 @@ command :since do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'].normalize_tag_sort || :name
+  default = Doing.setting('tag_sort').normalize_tag_sort || :name
   c.arg_name 'KEY'
   c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 

data/bin/commands/today.rb

@@ -22,7 +22,7 @@ command :today do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'].normalize_tag_sort || :name
+  default = Doing.setting('tag_sort').normalize_tag_sort || :name
   c.arg_name 'KEY'
   c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 

data/bin/commands/view.rb

@@ -36,7 +36,7 @@ command :view do |c|
   c.switch [:color], default_value: true, negatable: true
 
   c.desc "Highlight search matches in output. Only affects command line output"
-  c.switch %i[h hilite], default_value: @settings.dig('search', 'highlight')
+  c.switch %i[h hilite], default_value: Doing.settings.dig('search', 'highlight')
 
   c.desc 'Sort tags by (name|time)'
   c.arg_name 'KEY'
@@ -82,7 +82,7 @@ command :view do |c|
     section = if options[:section]
                 @wwid.guess_section(options[:section]) || options[:section].cap_first
               else
-                @settings['current_section']
+                Doing.setting('current_section')
               end
 
     view = @wwid.get_view(title)
@@ -134,7 +134,7 @@ command :view do |c|
       section = if options[:section]
                   section
                 else
-                  view['section'] || @settings['current_section']
+                  view['section'] || Doing.setting('current_section')
                 end
       order = if view.key?('order')
                 view['order'].normalize_order

data/bin/commands/yesterday.rb

@@ -33,7 +33,7 @@ command :yesterday do |c|
   c.switch [:totals], default_value: false, negatable: false
 
   c.desc 'Sort tags by (name|time)'
-  default = @settings['tag_sort'].normalize_tag_sort || :name
+  default = Doing.setting('tag_sort').normalize_tag_sort || :name
   c.arg_name 'KEY'
   c.flag [:tag_sort], must_match: REGEX_TAG_SORT, default_value: default, type: TagSortSymbol
 
@@ -65,7 +65,7 @@ command :yesterday do |c|
     end
 
     opt = options.clone
-    opt[:order] = @settings.dig('templates', options[:config_template], 'order')
+    opt[:order] = Doing.setting(['templates', options[:config_template], 'order'])
 
     Doing::Pager.page @wwid.yesterday(options[:section], options[:times], options[:output], opt).chomp
   end