doing 2.1.22 → 2.1.26

data/bin/commands/flag.rb

@@ -0,0 +1,126 @@
+# @@mark @@flag
+desc 'Mark last entry as flagged'
+command %i[mark flag] do |c|
+  c.example 'doing flag', desc: 'Add @flagged to the last entry created'
+  c.example 'doing mark', desc: 'mark is an alias for flag'
+  c.example 'doing flag --tag project1 --count 2', desc: 'Add @flagged to the last 2 entries tagged @project1'
+  c.example 'doing flag --interactive --search "/(develop|cod)ing/"', desc: 'Find entries matching regular expression and create a menu allowing multiple selections, selected items will be @flagged'
+
+  c.desc 'Section'
+  c.arg_name 'SECTION_NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  c.desc 'How many recent entries to tag (0 for all)'
+  c.arg_name 'COUNT'
+  c.flag %i[c count], default_value: 1, must_match: /^\d+$/, type: Integer
+
+  c.desc 'Don\'t ask permission to flag all entries when count is 0'
+  c.switch %i[force], negatable: false, default_value: false
+
+  c.desc 'Include current date/time with tag'
+  c.switch %i[d date], negatable: false, default_value: false
+
+  c.desc 'Remove flag'
+  c.switch %i[r remove], negatable: false, default_value: false
+
+  c.desc 'Flag last entry (or entries) not marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
+  c.desc 'Flag the last entry containing TAG.
+  Separate multiple tags with comma (--tag=tag1,tag2), combine with --bool. Wildcards allowed (*, ?).'
+  c.arg_name 'TAG'
+  c.flag [:tag], type: TagArray
+
+  c.desc 'Flag the last entry 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 'Flag items that *don\'t* match search/tag/date 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 (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 'Select item(s) to flag 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
+    mark = @settings['marker_tag'] || 'flagged'
+
+    raise InvalidArgument, '--search and --tag can not be used together' if options[:search] && options[:tag]
+
+    section = 'All'
+
+    if options[:section]
+      section = @wwid.guess_section(options[:section]) || options[:section].cap_first
+    end
+
+    if options[:tag].nil?
+      search_tags = []
+    else
+      search_tags = options[:tag]
+    end
+
+    if options[:interactive]
+      count = 0
+      options[:force] = true
+    else
+      count = options[:count].to_i
+    end
+
+    options[:case] = options[:case].normalize_case
+
+    if options[:search]
+      search = options[:search]
+      search.sub!(/^'?/, "'") if options[:exact]
+      options[:search] = search
+    end
+
+    if count.zero? && !options[:force]
+      if options[:search]
+        section_q = ' matching your search terms'
+      elsif options[:tag]
+        section_q = ' matching your tag search'
+      elsif section == 'All'
+        section_q = ''
+      else
+        section_q = " in section #{section}"
+      end
+
+
+      question = if options[:remove]
+                   "Are you sure you want to unflag all entries#{section_q}"
+                 else
+                   "Are you sure you want to flag all records#{section_q}"
+                 end
+
+      res = Doing::Prompt.yn(question, default_response: false)
+
+      exit_now! 'Cancelled' unless res
+    end
+
+    options[:count] = count
+    options[:section] = section
+    options[:tag] = search_tags
+    options[:tags] = [mark]
+    options[:tag_bool] = options[:bool].normalize_bool
+
+    @wwid.tag_last(options)
+  end
+end

data/bin/commands/grep.rb

@@ -0,0 +1,124 @@
+# @@grep @@search
+desc 'Search for entries'
+long_desc %(
+Search all sections (or limit to a single section) for entries matching text or regular expression. Normal strings are fuzzy matched.
+
+To search with regular expressions, single quote the string and surround with slashes: `doing search '/\bm.*?x\b/'`
+)
+arg_name 'SEARCH_PATTERN'
+command %i[grep search] do |c|
+  c.example 'doing grep "doing wiki"', desc: 'Find entries containing "doing wiki" using fuzzy matching'
+  c.example 'doing search "\'search command"', desc: 'Find entries containing "search command" using exact matching (search is an alias for grep)'
+  c.example 'doing grep "/do.*?wiki.*?@done/"', desc: 'Find entries matching regular expression'
+  c.example 'doing search --before 12/21 "doing wiki"', desc: 'Find entries containing "doing wiki" with entry dates before 12/21 of the current year'
+
+  c.desc 'Section'
+  c.arg_name 'NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  c.desc 'Search 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 'Search 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 search --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.
+    )
+  c.arg_name 'DATE_OR_RANGE'
+  c.flag [:from], type: DateRangeString
+
+  c.desc "Output to export format (#{Doing::Plugins.plugin_names(type: :export)})"
+  c.arg_name 'FORMAT'
+  c.flag %i[o output]
+
+  c.desc "Output using a template from configuration"
+  c.arg_name 'TEMPLATE_KEY'
+  c.flag [:config_template], type: TemplateName, default_value: 'default'
+
+  c.desc 'Override output format with a template string containing %placeholders'
+  c.arg_name 'TEMPLATE_STRING'
+  c.flag [:template]
+
+  c.desc 'Show time intervals on @done tasks'
+  c.switch %i[t times], default_value: true, negatable: true
+
+  c.desc 'Show elapsed time on entries without @done tag'
+  c.switch [:duration]
+
+  c.desc 'Show intervals with totals at the end of output'
+  c.switch [:totals], default_value: false, negatable: false
+
+  c.desc 'Sort tags by (name|time)'
+  default = 'time'
+  default = @settings['tag_sort'] || 'name'
+  c.arg_name 'KEY'
+  c.flag [:tag_sort], must_match: /^(?:name|time)$/i, default_value: default
+
+  c.desc 'Only show items with recorded time intervals'
+  c.switch [:only_timed], default_value: false, negatable: false
+
+  # c.desc '[DEPRECATED] Use alternative fuzzy matching for search string'
+  # 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.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 "Highlight search matches in output. Only affects command line output"
+  c.switch %i[h hilite], default_value: @settings.dig('search', 'highlight')
+
+  c.desc "Edit matching entries with #{Doing::Util.default_editor}"
+  c.switch %i[e editor], negatable: false, default_value: false
+
+  c.desc "Delete matching entries"
+  c.switch %i[d delete], negatable: false, default_value: false
+
+  c.desc 'Display an interactive menu of results to perform further operations'
+  c.switch %i[i interactive], default_value: false, negatable: false
+
+  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 'Combine multiple tags or value queries using AND, OR, or NOT'
+  c.flag [:bool], must_match: REGEX_BOOL, default_value: 'AND'
+
+  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)
+
+    template = @settings['templates'][options[:config_template]].deep_merge(@settings)
+    tags_color = template.key?('tags_color') ? template['tags_color'] : nil
+
+    section = @wwid.guess_section(options[:section]) if options[:section]
+
+    options[:case] = options[:case].normalize_case
+    options[:bool] = options[:bool].normalize_bool
+
+    search = args.join(' ')
+    search.sub!(/^'?/, "'") if options[:exact]
+
+    options[:times] = true if options[:totals]
+    options[:sort_tags] = options[:tag_sort] =~ /^n/i
+    options[:highlight] = true
+    options[:search] = search
+    options[:section] = section
+    options[:tags_color] = tags_color
+
+    Doing::Pager.page @wwid.list_section(options)
+  end
+end

data/bin/commands/import.rb

@@ -0,0 +1,101 @@
+# @@import
+desc 'Import entries from an external source'
+long_desc "Imports entries from other sources. Available plugins: #{Doing::Plugins.plugin_names(type: :import, separator: ', ')}"
+arg_name 'PATH'
+command :import do |c|
+  c.example 'doing import --type timing "~/Desktop/All Activities.json"', desc: 'Import a Timing.app JSON report'
+  c.example 'doing import --type doing --tag imported --no-autotag ~/doing_backup.md', desc: 'Import an Doing archive, tag all entries with @imported, skip autotagging'
+  c.example 'doing import --type doing --from "10/1 to 10/15" ~/doing_backup.md', desc: 'Import a Doing archive, only importing entries between two dates'
+
+  c.desc "Import type (#{Doing::Plugins.plugin_names(type: :import)})"
+  c.arg_name 'TYPE'
+  c.flag :type, default_value: 'doing'
+
+  c.desc 'Only import items matching search. Surround with slashes for regex (/query/), start with single quote for exact match ("\'query")'
+  c.arg_name 'QUERY'
+  c.flag [:search]
+
+  # 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 'Import items that *don\'t* match search/tag/date 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 'Only import items with recorded time intervals'
+  c.switch [:only_timed], default_value: false, negatable: false
+
+  c.desc 'Target section'
+  c.arg_name 'NAME'
+  c.flag %i[s section]
+
+  c.desc 'Tag all imported entries'
+  c.arg_name 'TAGS'
+  c.flag %i[t tag]
+
+  c.desc 'Autotag entries'
+  c.switch :autotag, negatable: true, default_value: true
+
+  c.desc 'Prefix entries with'
+  c.arg_name 'PREFIX'
+  c.flag :prefix
+
+  # TODO: Allow time range filtering
+  c.desc 'Import entries older than date'
+  c.arg_name 'DATE_STRING'
+  c.flag [:before], type: DateBeginString
+
+  c.desc 'Import entries newer than date'
+  c.arg_name 'DATE_STRING'
+  c.flag [:after], type: DateEndString
+
+  c.desc %(
+    Date range to import. Date range argument should be quoted. Date specifications can be natural language.
+    To specify a range, use "to" or "through": `--from "monday to friday"` or `--from 10/1 to 10/31`.
+    Has no effect unless the import plugin has implemented date range filtering.
+  )
+  c.arg_name 'DATE_OR_RANGE'
+  c.flag %i[f from], type: DateRangeString
+
+  c.desc 'Allow entries that overlap existing times'
+  c.switch [:overlap], negatable: true
+
+  c.action do |_global_options, options, args|
+    options[:fuzzy] = false
+    if options[:section]
+      options[:section] = @wwid.guess_section(options[:section]) || options[:section].cap_first
+    end
+
+    if options[:search]
+      search = options[:search]
+      search.sub!(/^'?/, "'") if options[:exact]
+      options[:search] = search
+    end
+
+    if options[:from]
+      options[:date_filter] = options[:from]
+
+      raise InvalidTimeExpression, 'Unrecognized date string' unless options[:date_filter][0]
+    elsif options[:before] || options[:after]
+      options[:date_filter] = [nil, nil]
+      options[:date_filter][1] = options[:before] || Time.now + (1 << 64)
+      options[:date_filter][0] = options[:after] || Time.now - (1 << 64)
+    end
+
+    options[:case] = options[:case].normalize_case
+
+    if options[:type] =~ Doing::Plugins.plugin_regex(type: :import)
+      options[:no_overlap] = !options[:overlap]
+      @wwid.import(args, options)
+      @wwid.write(@wwid.doing_file)
+    else
+      raise InvalidPluginType, "Invalid import type: #{options[:type]}"
+    end
+  end
+end

data/bin/commands/install_fzf.rb

@@ -0,0 +1,17 @@
+# @@install_fzf
+command :install_fzf do |c|
+  c.desc 'Force reinstall'
+  c.switch %i[r reinstall], default_value: false
+
+  c.desc 'Uninstall'
+  c.switch %i[u uninstall], default_value: false, negatable: false
+
+  c.action do |g, o, a|
+    if o[:uninstall]
+      Doing::Prompt.uninstall_fzf
+    else
+      Doing.logger.warn('fzf:', 'force reinstall') if o[:reinstall]
+      res = Doing::Prompt.install_fzf(force: o[:reinstall])
+    end
+  end
+end

data/bin/commands/last.rb

@@ -0,0 +1,114 @@
+# @@last
+desc 'Show the last entry, optionally edit'
+long_desc 'Shows the last entry. Using --search and --tag filters, you can view/edit the last entry matching a filter,
+allowing `doing last` to target historical entries.'
+command :last do |c|
+  c.example 'doing last', desc: 'Show the most recent entry in all sections'
+  c.example 'doing last -s Later', desc: 'Show the most recent entry in the Later section'
+  c.example 'doing last --tag project1,work --bool AND', desc: 'Show most recent entry tagged @project1 and @work'
+  c.example 'doing last --search "side hustle"', desc: 'Show most recent entry containing "side hustle" (fuzzy matching)'
+  c.example 'doing last --search "\'side hustle"', desc: 'Show most recent entry containing "side hustle" (exact match)'
+  c.example 'doing last --edit', desc: 'Open the most recent entry in an editor for modifications'
+  c.example 'doing last --search "\'side hustle" --edit', desc: 'Open most recent entry containing "side hustle" (exact match) in editor'
+
+  c.desc 'Specify a section'
+  c.arg_name 'NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  c.desc "Edit entry with #{Doing::Util.default_editor}"
+  c.switch %i[e editor], negatable: false, default_value: false
+
+  c.desc "Delete the last entry"
+  c.switch %i[d delete], negatable: false, default_value: false
+
+  c.desc 'Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?)'
+  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, surround with slashes for regex (/query/), start with single quote for exact match ("\'query")'
+  c.arg_name 'QUERY'
+  c.flag [:search]
+
+  c.desc "Output using a template from configuration"
+  c.arg_name 'TEMPLATE_KEY'
+  c.flag [:config_template], type: TemplateName, default_value: 'last'
+
+  c.desc 'Override output format with a template string containing %placeholders'
+  c.arg_name 'TEMPLATE_STRING'
+  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.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 'Show elapsed time if entry is not tagged @done'
+  c.switch [:duration]
+
+  # 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 or tag filter'
+  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.action do |global_options, options, _args|
+    options[:fuzzy] = false
+    raise InvalidArgument, '--tag and --search can not be used together' if options[:tag] && options[:search]
+
+    if options[:tag].nil?
+      options[:tag] = []
+    else
+      options[:tag] = options[:tag]
+      options[:bool] = options[:bool].normalize_bool
+    end
+
+    options[:case] = options[:case].normalize_case
+
+    options[:search] = options[:search].sub(/^'?/, "'") if options[:search] && options[:exact]
+
+    if options[:editor]
+      @wwid.edit_last(section: options[:section],
+                     options: {
+                       search: options[:search],
+                       fuzzy: options[:fuzzy],
+                       case: options[:case],
+                       tag: options[:tag],
+                       tag_bool: options[:bool],
+                       not: options[:not],
+                       val: options[:val],
+                       bool: options[:bool]
+                     })
+    else
+      last = @wwid.last(times: true, section: options[:section],
+                     options: {
+                        config_template: options[:config_template],
+                        template: options[:template],
+                        duration: options[:duration],
+                        search: options[:search],
+                        fuzzy: options[:fuzzy],
+                        case: options[:case],
+                        hilite: options[:hilite],
+                        negate: options[:not],
+                        tag: options[:tag],
+                        tag_bool: options[:bool],
+                        delete: options[:delete],
+                        bool: options[:bool],
+                        val: options[:val]
+                      })
+      Doing::Pager::page last.strip if last
+    end
+  end
+end

data/bin/commands/meanwhile.rb

@@ -0,0 +1,86 @@
+# @@meanwhile
+desc 'Finish any running @meanwhile tasks and optionally create a new one'
+long_desc 'The @meanwhile tag allows you to have long-running entries that encompass smaller entries.
+This command makes it easy to start and stop these overarching entries. Just run `doing meanwhile Starting work on this
+big project` to start a @meanwhile entry, add other entries as you work on the project, then use `doing meanwhile` by
+itself to mark the entry as @done.'
+arg_name 'ENTRY', optional: true
+command :meanwhile do |c|
+  c.example 'doing meanwhile "Long task that will have others after it before it\'s done"', desc: 'Add a new long-running entry, completing any current @meanwhile entry'
+  c.example 'doing meanwhile', desc: 'Finish any open @meanwhile entry'
+  c.example 'doing meanwhile --archive', desc: 'Finish any open @meanwhile entry and archive it'
+  c.example 'doing meanwhile --back 2h "Something I\'ve been working on for a while', desc: 'Add a @meanwhile entry with a start date 2 hours ago'
+
+  c.desc 'Section'
+  c.arg_name 'NAME'
+  c.flag %i[s section]
+
+  c.desc "Edit entry with #{Doing::Util.default_editor}"
+  c.switch %i[e editor], negatable: false, default_value: false
+
+  c.desc 'Archive previous @meanwhile entry'
+  c.switch %i[a archive], negatable: false, default_value: false
+
+  c.desc 'Backdate start date for new entry to date string [4pm|20m|2h|yesterday noon]'
+  c.arg_name 'DATE_STRING'
+  c.flag %i[b back started], type: DateBeginString
+
+  c.desc '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.action do |_global_options, options, args|
+    if options[:back]
+      date = options[:back]
+
+      raise InvalidTimeExpression, 'Unable to parse date string' if date.nil?
+    else
+      date = Time.now
+    end
+
+    if options[:section]
+      section = @wwid.guess_section(options[:section]) || options[:section].cap_first
+    else
+      section = @settings['current_section']
+    end
+    input = ''
+
+    ask_note = options[:ask] ? Doing::Prompt.read_lines(prompt: 'Add a note') : []
+
+    if options[:editor]
+      raise MissingEditor, 'No EDITOR variable defined in environment' if Doing::Util.default_editor.nil?
+      input += date.strftime('%F %R | ')
+      input += args.join(' ') unless args.empty?
+      input += "\n#{options[:note]}" if options[:note]
+      input += "\n#{ask_note}" unless ask_note.good?
+
+      input = @wwid.fork_editor(input).strip
+    elsif !args.empty?
+      input = args.join(' ')
+    elsif $stdin.stat.size.positive?
+      input = $stdin.read.strip
+    end
+
+    if input.good?
+      d, input, note = @wwid.format_input(input)
+      unless d.nil?
+        Doing.logger.debug('Parser:', 'Date detected in input, overriding command line values')
+        date = d
+      end
+    else
+      input = nil
+      note = []
+    end
+
+    unless options[:editor]
+      note.add(options[:note]) if options[:note]
+      note.add(ask_note) if ask_note.good?
+    end
+
+    @wwid.stop_start('meanwhile', { new_item: input, back: date, section: section, archive: options[:archive], note: note })
+    @wwid.write(@wwid.doing_file)
+  end
+end