doing 2.1.25 → 2.1.26

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doing (2.1.25)
+    doing (2.1.26)
       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.24<!--END VER-->.
+The current version of `doing` is <!--VER-->2.1.25<!--END VER-->.
 
 Find all of the documentation in the [doing wiki][wiki].
 

data/bin/commands/add_section.rb

@@ -0,0 +1,13 @@
+# @@add_section
+desc 'Add a new section to the "doing" file'
+arg_name 'SECTION_NAME'
+command :add_section do |c|
+  c.example 'doing add_section Ideas', desc: 'Add a section called Ideas to the doing file'
+
+  c.action do |_global_options, _options, args|
+    raise InvalidArgument, "Section #{args[0]} already exists" if @wwid.sections.include?(args[0])
+
+    @wwid.content.add_section(args.join(' ').cap_first, log: true)
+    @wwid.write(@wwid.doing_file)
+  end
+end

data/bin/commands/again.rb

@@ -0,0 +1,99 @@
+# @@again @@resume
+desc 'Repeat last entry as new entry'
+long_desc 'This command is designed to allow multiple time intervals to be created for an entry by duplicating it with a new start (and end, eventually) time'
+command %i[again resume] do |c|
+  c.example 'doing resume', desc: 'Duplicate the most recent entry with a new start time, removing any @done tag'
+  c.example 'doing again', desc: 'again is an alias for resume'
+  c.example 'doing resume --editor', desc: 'Repeat the last entry, opening the new entry in the default editor'
+  c.example 'doing resume --tag project1 --in Projects', desc: 'Repeat the last entry tagged @project1, creating the new entry in the Projects section'
+  c.example 'doing resume --interactive', desc: 'Select the entry to repeat from a menu'
+
+  c.desc 'Get last entry from a specific section'
+  c.arg_name 'NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  c.desc 'Add new entry to section (default: same section as repeated entry)'
+  c.arg_name 'SECTION_NAME'
+  c.flag [:in]
+
+  c.desc 'Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]'
+  c.arg_name 'DATE_STRING'
+  c.flag %i[b back started], type: DateBeginString
+
+  c.desc 'Repeat last entry matching tags. Combine multiple tags with a comma. Wildcards allowed (*, ?)'
+  c.arg_name 'TAG'
+  c.flag [:tag], type: TagArray
+
+  c.desc 'Repeat last entry 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 'Resume 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.desc "Edit duplicated entry with #{Doing::Util.default_editor} before adding"
+  c.switch %i[e editor], negatable: false, default_value: false
+
+  c.desc 'Add a note'
+  c.arg_name 'TEXT'
+  c.flag %i[n note]
+
+  c.desc 'Prompt for note via multi-line input'
+  c.switch %i[ask], negatable: false, default_value: false
+
+  c.desc 'Select item to resume from a menu of matching entries'
+  c.switch %i[i interactive], negatable: false, default_value: false
+
+  c.action do |_global_options, options, _args|
+    options[:fuzzy] = false
+    tags = options[:tag].nil? ? [] : options[:tag]
+
+    options[:case] = options[:case].normalize_case
+
+    if options[:search]
+      search = options[:search]
+      search.sub!(/^'?/, "'") if options[:exact]
+      options[:search] = search
+    end
+
+    if options[:back]
+      date = options[:back]
+      raise InvalidTimeExpression, 'Unable to parse date string for --back' if date.nil?
+    else
+      date = Time.now
+    end
+
+    note = Doing::Note.new(options[:note])
+    note.add(Doing::Prompt.read_lines(prompt: 'Add a note')) if options[:ask]
+
+    options[:note] = note
+
+    opts = options.clone
+
+    opts[:tag] = tags
+    opts[:tag_bool] = options[:bool].normalize_bool
+    opts[:interactive] = options[:interactive]
+    opts[:date] = date
+
+    @wwid.repeat_last(opts)
+  end
+end

data/bin/commands/archive.rb

@@ -0,0 +1,96 @@
+# @@archive @@move
+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.)
+arg_name 'SECTION_OR_TAG'
+default_value @settings['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'
+  c.example 'doing archive --to Later @project1', desc: 'Move all entries tagged @project1 to Later section'
+  c.example 'doing move Later --tag project1 --to Currently', desc: 'Move entries in Later tagged @project1 to Currently (move is an alias for archive)'
+
+  c.desc 'How many items to keep (ignored if archiving by tag or search)'
+  c.arg_name 'X'
+  c.flag %i[k keep], must_match: /^\d+$/, type: Integer
+
+  c.desc 'Move entries to'
+  c.arg_name 'SECTION_NAME'
+  c.flag %i[t to], default_value: 'Archive'
+
+  c.desc 'Label moved items with @from(SECTION_NAME)'
+  c.switch [:label], default_value: true, negatable: true
+
+  c.desc 'Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?). Added for compatibility with other commands'
+  c.arg_name 'TAG'
+  c.flag [:tag], type: TagArray
+
+  c.desc 'Tag boolean (AND|OR|NOT). Use PATTERN to parse + and - as booleans'
+  c.arg_name 'BOOLEAN'
+  c.flag [:bool], must_match: REGEX_BOOL, default_value: 'PATTERN'
+
+  c.desc 'Search filter'
+  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 '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 'Archive entries older than date
+    (Flexible date format, e.g. 1/27/2021, 2020-07-19, or Monday 3pm)'
+  c.arg_name 'DATE_STRING'
+  c.flag [:before], type: DateEndString
+
+  c.action do |_global_options, options, args|
+    options[:fuzzy] = false
+    if args.empty?
+      section = @settings['current_section']
+      tags = []
+    elsif args[0] =~ /^all/i
+      section = 'all'
+    elsif args[0] =~ /^@\S+/
+      section = 'all'
+      tags = args.map { |t| t.sub(/^@/, '').strip }
+    else
+      section = args[0].cap_first
+      tags = args.length > 1 ? args[1..].map { |t| t.sub(/^@/, '').strip } : []
+    end
+
+    raise InvalidArgument, '--keep and --count can not be used together' if options[:keep] && options[:count]
+
+    tags.concat(options[:tag]) if options[:tag]
+
+    search = nil
+
+    options[:case] = options[:case].normalize_case
+
+    if options[:search]
+      search = options[:search]
+      search.sub!(/^'?/, "'") if options[:exact]
+    end
+
+    opts = options.clone
+    opts[:search] = search
+    opts[:bool] = options[:bool].normalize_bool
+    opts[:destination] = options[:to]
+    opts[:tags] = tags
+
+    @wwid.archive(section, opts)
+  end
+end

data/bin/commands/cancel.rb

@@ -0,0 +1,102 @@
+# @@cancel
+desc 'End last X entries with no time tracked'
+long_desc 'Adds @done tag without datestamp so no elapsed time is recorded. Alias for `doing finish --no-date`'
+arg_name 'COUNT'
+command :cancel do |c|
+  c.example 'doing cancel', desc: 'Cancel the last entry'
+  c.example 'doing cancel --tag project1 -u 5', desc: 'Cancel the last 5 unfinished entries containing @project1'
+
+  c.desc 'Archive entries'
+  c.switch %i[a archive], negatable: false, default_value: false
+
+  c.desc 'Section'
+  c.arg_name 'NAME'
+  c.flag %i[s section]
+
+  c.desc 'Cancel the last X entries containing TAG. Separate multiple tags with comma (--tag=tag1,tag2). Wildcards allowed (*, ?)'
+  c.arg_name 'TAG'
+  c.flag [:tag], type: TagArray
+
+  c.desc 'Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans'
+  c.arg_name 'BOOLEAN'
+  c.flag [:bool], must_match: REGEX_BOOL, default_value: 'PATTERN'
+
+  c.desc 'Cancel the last X entries matching search filter, surround with slashes for regex (e.g. "/query.*/"), start with 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 'Finish 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 'Cancel last entry (or entries) not already marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
+  c.desc 'Select item(s) to cancel from a menu of matching entries'
+  c.switch %i[i interactive], negatable: false, default_value: false
+
+  c.action do |_global_options, options, args|
+    options[:fuzzy] = false
+    if options[:section]
+      section = @wwid.guess_section(options[:section]) || options[:section].cap_first
+    else
+      section = @settings['current_section']
+    end
+
+    if options[:tag].nil?
+      tags = []
+    else
+      tags = options[:tag]
+    end
+
+    raise InvalidArgument, 'Only one argument allowed' if args.length > 1
+
+    raise InvalidArgument, 'Invalid argument (specify number of recent items to mark @done)' unless args.empty? || args[0] =~ /\d+/
+
+    if options[:interactive]
+      count = 0
+    else
+      count = args[0] ? args[0].to_i : 1
+    end
+
+    search = nil
+
+    if options[:search]
+      search = options[:search]
+      search.sub!(/^'?/, "'") if options[:exact]
+    end
+
+    opts = {
+      archive: options[:archive],
+      case: options[:case].normalize_case,
+      count: count,
+      date: false,
+      fuzzy: options[:fuzzy],
+      interactive: options[:interactive],
+      not: options[:not],
+      search: search,
+      section: section,
+      sequential: false,
+      tag: tags,
+      tag_bool: options[:bool].normalize_bool,
+      tags: ['done'],
+      unfinished: options[:unfinished],
+      val: options[:val]
+    }
+
+    @wwid.tag_last(opts)
+  end
+end

data/bin/commands/changes.rb

@@ -0,0 +1,42 @@
+# @@changelog @@changes
+desc 'List recent changes in Doing'
+long_desc %(Display a formatted list of changes in recent versions.
+
+            Without flags, displays only the most recent version.
+            Use --lookup or --all for history.)
+command %i[changes changelog] do |c|
+  c.desc 'Display all versions'
+  c.switch %i[a all], default_value: false, negatable: false
+
+  c.desc %(Look up a specific version. Specify versions as "MAJ.MIN.PATCH", MIN
+           and PATCH are optional. Use > or < to see all changes since or prior
+           to a version.)
+  c.arg_name 'VERSION'
+  c.flag %i[l lookup], must_match: /^(?:(?:(?:[<>=]|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[\d.*?]+ *)+|(?:[\d.]+ *-+ *[\d.]+))$/
+
+  c.desc %(Show changelogs matching search terms (uses pattern-based searching).
+           Add slashes to search with regular expressions, e.g. `--search "/output.*flag/"`)
+  c.flag %i[s search]
+
+  c.example 'doing changes', desc: 'View changes in the current version'
+  c.example 'doing changes --all', desc: 'See the entire changelog'
+  c.example 'doing changes --lookup 2.0.21', desc: 'See changes from version 2.0.21'
+  c.example 'doing changes --lookup "> 2.1"', desc: 'See all changes since 2.1.0'
+  c.example 'doing changes --search "tags +bool"', desc: 'See all changes containing "tags" and "bool"'
+  c.example 'doing changes -l "> 2.1" -s "pattern"', desc: 'Lookup and search can be combined'
+
+
+  c.action do |_global_options, options, args|
+    cl = Doing::Changes.new(lookup: options[:lookup], search: options[:search])
+
+    content = if options[:all] || options[:search] || options[:lookup]
+                cl.to_s
+              else
+                cl.latest
+              end
+
+    parsed = TTY::Markdown.parse(content, width: 80, symbols: {override: {bullet: "•"}})
+    Doing::Pager.paginate = true
+    Doing::Pager.page parsed
+  end
+end

data/bin/commands/choose.rb

@@ -0,0 +1,9 @@
+# @@choose
+desc 'Select a section to display from a menu'
+command :choose do |c|
+  c.action do |_global_options, _options, _args|
+    section = @wwid.choose_section
+
+    Doing::Pager.page @wwid.list_section({ section: section.cap_first, count: 0 }) if section
+  end
+end

data/bin/commands/colors.rb

@@ -0,0 +1,19 @@
+# @@colors
+desc 'List available color variables for configuration templates and views'
+command :colors do |c|
+  c.action do |_global_options, _options, _args|
+    bgs = []
+    fgs = []
+    @colors::attributes.each do |color|
+      if color.to_s =~ /bg/
+        bgs.push("#{@colors.send(color, "    ")}#{@colors.default} <-- #{color.to_s}")
+      else
+        fgs.push("#{@colors.send(color, "XXXX")}#{@colors.default} <-- #{color.to_s}")
+      end
+    end
+    out = []
+    out << fgs.join("\n")
+    out << bgs.join("\n")
+    Doing::Pager.page out.join("\n")
+  end
+end

data/bin/commands/commands.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# @@commands
+desc 'Enable and disable Doing commands'
+command :commands do |c|
+  c.example 'doing commands add', desc: 'Get a menu of available commands'
+  c.example 'doing commands add COMMAND', desc: 'Specify a command to enable'
+  c.example 'doing commands remove COMMAND', desc: 'Specify a command to disable'
+
+  c.default_command :add
+
+  # @@commands.enable
+  c.desc 'Enable Doing commands'
+  c.long_desc 'Run without arguments to select commands from a list.'
+  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')
+
+      available = cfg['disabled_commands']
+      raise UserCancelled, 'No commands available to enable' unless args.good? || available.good?
+
+      to_enable = if args.good?
+                    args
+                  else
+                    Doing::Prompt.choose_from(available,
+                                              prompt: 'Select commands to enable',
+                                              multiple: true,
+                                              sorted: true).strip.split("\n")
+                  end
+      to_enable.each do |cmd|
+        default_command = File.join(File.dirname(__FILE__), "#{cmd}.rb")
+        custom_command = File.join(File.expand_path(custom_dir), "#{cmd}.rb")
+        unless File.exist?(default_command) || File.exist?(custom_command)
+          raise InvalidArgument, "Command #{cmd} not found"
+        end
+
+        raise InvalidArgument, "Command #{cmd} is not disabled" unless available.include?(cmd)
+
+        available.delete(cmd)
+      end
+
+      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")
+    end
+  end
+
+  # @@commands.disable
+  c.desc 'Disable Doing commands'
+  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')
+      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']
+      disabled.each { |cmd| available.delete(cmd) }
+      to_disable = if args.good?
+                     args
+                   else
+                     Doing::Prompt.choose_from(available,
+                                               prompt: 'Select commands to enable',
+                                               multiple: true,
+                                               sorted: true).strip.split("\n")
+                   end
+      to_disable.each do |cmd|
+        default_command = File.join(File.dirname(__FILE__), "#{cmd}.rb")
+        custom_command = File.join(File.expand_path(custom_dir), "#{cmd}.rb")
+        unless File.exist?(default_command) || File.exist?(custom_command)
+          raise InvalidArgument, "Command #{cmd} not found"
+
+        end
+
+        raise InvalidArgument, "Command #{cmd} is not enabled" unless available.include?(cmd)
+      end
+
+      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")
+    end
+  end
+end

data/bin/commands/commands_accepting.rb

@@ -0,0 +1,25 @@
+# @@commands_accepting
+arg_name 'OPTION'
+command :commands_accepting do |c|
+  c.desc 'Output in single column for completion'
+  c.switch %i[c column]
+
+  c.action do |g, o, a|
+    a.each do |option|
+      cmds = []
+      commands.each do |cmd, v|
+        v.flags.merge(v.switches).each do |n, flag|
+          if flag.name == option.to_sym || flag.aliases&.include?(option.to_sym)
+            cmds.push(cmd)
+          end
+        end
+      end
+
+      if o[:column]
+        puts cmds.sort
+      else
+        puts "Commands accepting --#{option}: #{cmds.sort.join(', ')}"
+      end
+    end
+  end
+end

data/bin/commands/completion.rb

@@ -0,0 +1,24 @@
+# @@completion
+desc 'Generate shell completion scripts'
+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|
+    script_dir = File.join(File.dirname(__FILE__), '..', 'scripts')
+
+    Doing::Completion.generate_completion(type: options[:type], file: options[:file])
+  end
+end