doing 2.1.24 → 2.1.28

data/bin/commands/tag.rb

@@ -0,0 +1,149 @@
+# @@tag
+desc 'Add tag(s) to last entry'
+long_desc 'Add (or remove) tags from the last entry, or from multiple entries
+          (with `--count`), entries matching a search (with `--search`), or entries
+          containing another tag (with `--tag`).
+
+          When removing tags with `-r`, wildcards are allowed (`*` to match
+          multiple characters, `?` to match a single character). With `--regex`,
+          regular expressions will be interpreted instead of wildcards.
+
+          For all tag removals the match is case insensitive by default, but if
+          the tag search string contains any uppercase letters, the match will
+          become case sensitive automatically.
+
+          Tag name arguments do not need to be prefixed with @.'
+arg_name 'TAG', :multiple
+command :tag do |c|
+  c.example 'doing tag mytag', desc: 'Add @mytag to the last entry created'
+  c.example 'doing tag --remove mytag', desc: 'Remove @mytag from the last entry created'
+  c.example 'doing tag --rename "other*" --count 10 newtag', desc: 'Rename tags beginning with "other" (wildcard) to @newtag on the last 10 entries'
+  c.example 'doing tag --search "developing" coding', desc: 'Add @coding to the last entry containing string "developing" (fuzzy matching)'
+  c.example 'doing tag --interactive --tag project1 coding', desc: 'Create an interactive menu from entries tagged @project1, selection(s) will be tagged with @coding'
+
+  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 'Replace existing tag with tag argument, wildcards (*,?) allowed, or use with --regex'
+  c.arg_name 'ORIG_TAG'
+  c.flag %i[rename]
+
+  c.desc 'Include a value, e.g. @tag(value)'
+  c.arg_name 'VALUE'
+  c.flag %i[v value]
+
+  c.desc 'Don\'t ask permission to tag 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 given tag(s)'
+  c.switch %i[r remove], negatable: false, default_value: false
+
+  c.desc 'Interpret tag string as regular expression (with --remove)'
+  c.switch %i[regex], negatable: false, default_value: false
+
+  c.desc 'Tag last entry (or entries) not marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
+  c.desc 'Autotag entries based on autotag configuration in ~/.config/doing/config.yml'
+  c.switch %i[a autotag], negatable: false, default_value: false
+
+  c.desc 'Select item(s) to tag 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, options, args|
+    options[:fuzzy] = false
+    # raise MissingArgument, 'You must specify at least one tag' if args.empty? && !options[:autotag]
+
+    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[:autotag]
+      tags = []
+    else
+      if args.empty?
+        tags = []
+      else
+        tags = if args.join('') =~ /,/
+                 args.join('').split(/ *, */)
+               else
+                 args.join(' ').split(' ') # in case tags are quoted as one arg
+               end
+      end
+
+      tags.map! { |tag| tag.sub(/^@/, '').strip }
+    end
+
+    if options[:interactive]
+      count = 0
+      options[:force] = true
+    else
+      count = options[:count].to_i
+    end
+
+    if options[:search]
+      search = options[:search]
+      search.sub!(/^'?/, "'") if options[:exact]
+      options[:search] = search
+    end
+
+    options[:count] = count
+    options[:section] = section
+    options[:tag] = search_tags
+    options[:tags] = tags
+    options[:tag_bool] = options[:bool]
+
+    if count.zero? && !options[:force]
+      matches = @wwid.filter_items([], opt: options).count
+
+      if matches > 5
+        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[:autotag]
+                     "Are you sure you want to autotag #{matches} records#{section_q}"
+                   elsif options[:remove]
+                     "Are you sure you want to remove #{tags.join(' and ')} from #{matches} records#{section_q}"
+                   else
+                     "Are you sure you want to add #{tags.join(' and ')} to #{matches} records#{section_q}"
+                   end
+
+        res = Doing::Prompt.yn(question, default_response: false)
+
+        raise UserCancelled unless res
+      end
+    end
+
+    @wwid.tag_last(options)
+  end
+end

data/bin/commands/tag_dir.rb

@@ -0,0 +1,29 @@
+# @@tag_dir
+desc 'Set the default tags for the current directory'
+long_desc 'Adds default_tags to a .doingrc file in the current directory. Any entry created in this directory or its
+subdirectories will be tagged with the default tags. You can modify these any time using the `config set` commnand or
+manually editing the .doingrc file.'
+arg_name 'TAG [TAG..]'
+command :tag_dir do |c|
+  c.example 'doing tag_dir project1 project2', desc: 'Add @project1 and @project to to any entries in the current directory'
+  c.example 'doing tag_dir --remove', desc: 'Clear the default tags for the directory'
+
+  c.desc 'Remove all default_tags from the local .doingrc'
+  c.switch %i[r remove], negatable: false
+
+  c.action do |global, options, args|
+    tags = args.join(' ').gsub(/ *, */, ' ').split(' ')
+
+    cfg_cmd = commands[:config]
+    set_cmd = cfg_cmd.commands[:set]
+    set_options = {}
+    if options[:remove]
+      set_args = ['default_tags']
+      set_options[:remove] = true
+    else
+      set_args = ['default_tags', tags.join(',')]
+    end
+    action = set_cmd.send(:get_action, nil)
+    return action.call(global, set_options, set_args)
+  end
+end

data/bin/commands/tags.rb

@@ -0,0 +1,66 @@
+# @@tags
+desc 'List all tags in the current Doing file'
+arg_name 'MAX_COUNT', optional: true, type: Integer
+command :tags do |c|
+  c.desc 'Section'
+  c.arg_name 'SECTION_NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  c.desc 'Show count of occurrences'
+  c.switch %i[c counts]
+
+  c.desc 'Output in a single line with @ symbols. Ignored if --counts is specified.'
+  c.switch %i[l line]
+
+  c.desc 'Sort by name or count'
+  c.arg_name 'SORT_ORDER'
+  c.flag %i[sort], default_value: 'name', must_match: /^(?:n(?:ame)?|c(?:ount)?)$/
+
+  c.desc 'Sort order (asc/desc)'
+  c.arg_name 'ORDER'
+  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
+
+    items = @wwid.filter_items([], opt: options)
+
+    if options[:interactive]
+      items = Doing::Prompt.choose_from_items(items, include_section: options[:section].nil?,
+        menu: true,
+        header: '',
+        prompt: 'Select entries to scan > ',
+        multiple: true,
+        sort: true,
+        show_if_single: true)
+    end
+
+    # items = @wwid.content.in_section(section)
+    tags = @wwid.all_tags(items, counts: true)
+
+    if options[:sort] =~ /^n/i
+      tags = tags.sort_by { |tag, count| tag }
+    else
+      tags = tags.sort_by { |tag, count| count }
+    end
+
+    tags.reverse! if options[:order] == :desc
+
+    if options[:counts]
+      tags.each { |t, c| puts "#{t} (#{c})" }
+    else
+      if options[:line]
+        puts tags.map { |t, c| t }.to_tags.join(' ')
+      else
+        tags.each { |t, c| puts "#{t}" }
+      end
+    end
+  end
+end

data/bin/commands/template.rb

@@ -0,0 +1,61 @@
+# @@template
+desc 'Output HTML, CSS, and Markdown (ERB) templates for customization'
+long_desc %(
+  Templates are printed to STDOUT for piping to a file.
+  Save them and use them in the configuration file under export_templates.
+)
+arg_name 'TYPE', must_match: Doing::Plugins.template_regex
+command :template do |c|
+  c.example 'doing template haml > ~/styles/my_doing.haml', desc: 'Output the haml template and save it to a file'
+
+  c.desc 'List all available templates'
+  c.switch %i[l list], negatable: false
+
+  c.desc 'List in single column for completion'
+  c.switch %i[c column]
+
+  c.desc 'Save template to file instead of STDOUT'
+  c.switch %i[s save], default_value: false, negatable: false
+
+  c.desc 'Save template to alternate location'
+  c.arg_name 'DIRECTORY'
+  c.flag %i[p path], default_value: File.join(Doing::Util.user_home, '.config', 'doing', 'templates')
+
+  c.action do |_global_options, options, args|
+    if options[:list] || options[:column]
+      if options[:column]
+        $stdout.print Doing::Plugins.plugin_templates.join("\n")
+      else
+        $stdout.puts "Available templates: #{Doing::Plugins.plugin_templates.join(', ')}"
+      end
+      return
+    end
+
+    if args.empty?
+      type = Doing::Prompt.choose_from(Doing::Plugins.plugin_templates, sorted: false, prompt: 'Select template type > ')
+      type.sub!(/ \(.*?\)$/, '').strip!
+      options[:save] = Doing::Prompt.yn("Save to #{options[:path]}? (No outputs to STDOUT)", default_response: false)
+    else
+      type = args[0]
+    end
+
+    raise InvalidPluginType, "No type specified, use `doing template [#{Doing::Plugins.plugin_templates.join('|')}]`" unless type
+
+    if options[:save]
+      Doing::Plugins.template_for_trigger(type, save_to: options[:path])
+    else
+      $stdout.puts Doing::Plugins.template_for_trigger(type, save_to: nil)
+    end
+
+    # case args[0]
+    # when /html|haml/i
+    #   $stdout.puts @wwid.haml_template
+    # when /css/i
+    #   $stdout.puts @wwid.css_template
+    # when /markdown|md|erb/i
+    #   $stdout.puts @wwid.markdown_template
+    # else
+    #   exit_now! 'Invalid type specified, must be HAML or CSS'
+    # end
+  end
+end

data/bin/commands/today.rb

@@ -0,0 +1,64 @@
+# @@today
+desc 'List entries from today'
+long_desc 'List entries from the current day. Use --before, --after, and
+--from to specify time ranges.'
+command :today do |c|
+  c.example 'doing today', desc: 'List all entries with start dates between 12am and 11:59PM for the current day'
+  c.example 'doing today --section Later', desc: 'List today\'s entries in the Later section'
+  c.example 'doing today --before 3pm --after 12pm', desc: 'List entries with start dates between 12pm and 3pm today'
+  c.example 'doing today --output json', desc: 'Output entries from today in JSON format'
+
+  c.desc 'Specify a section'
+  c.arg_name 'NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  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 time totals at the end of output'
+  c.switch [:totals], default_value: false, negatable: false
+
+  c.desc 'Sort tags by (name|time)'
+  default = @settings['tag_sort'].normalize_tag_sort || :name
+  c.arg_name 'KEY'
+  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'
+  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: 'today'
+
+  c.desc 'Override output format with a template string containing %placeholders'
+  c.arg_name 'TEMPLATE_STRING'
+  c.flag [:template]
+
+  c.desc 'View entries before specified time (e.g. 8am, 12:30pm, 15:00)'
+  c.arg_name 'TIME_STRING'
+  c.flag [:before]
+
+  c.desc 'View entries after specified time (e.g. 8am, 12:30pm, 15:00)'
+  c.arg_name 'TIME_STRING'
+  c.flag [:after]
+
+  c.desc %(
+    Time range to show `doing today --from "12pm to 4pm"`
+  )
+  c.arg_name 'TIME_RANGE'
+  c.flag [:from], type: DateRangeString
+
+  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[:times] = true if options[:totals]
+    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
+  end
+end

data/bin/commands/undo.rb

@@ -0,0 +1,49 @@
+# @@undo
+desc 'Undo the last X changes to the Doing file'
+long_desc 'Reverts the last X commands that altered the doing file.
+All changes performed by a single command are undone at once.
+
+Specify a number to jump back multiple revisions, or use --select for an interactive menu.'
+arg_name 'COUNT'
+command :undo do |c|
+  c.example 'doing undo', desc: 'Undo the most recent change to the doing file'
+  c.example 'doing undo 5', desc: 'Undo the last 5 changes to the doing file'
+  c.example 'doing undo --interactive', desc: 'Select from a menu of available revisions'
+  c.example 'doing undo --redo', desc: 'Undo the last undo command'
+
+  c.desc 'Specify alternate doing file'
+  c.arg_name 'PATH'
+  c.flag %i[f file], default_value: @wwid.doing_file
+
+  c.desc 'Select from recent backups'
+  c.switch %i[i interactive], negatable: false
+
+  c.desc 'Remove old backups, retaining X files'
+  c.arg_name 'COUNT'
+  c.flag %i[p prune], type: Integer
+
+  c.desc 'Redo last undo. Note: you cannot undo a redo'
+  c.switch %i[r redo]
+
+  c.action do |_global_options, options, args|
+    file = options[:file] || @wwid.doing_file
+    count = args.empty? ? 1 : args[0].to_i
+    raise InvalidArgument, "Invalid count specified for undo" unless count&.positive?
+
+    if options[:prune]
+      Doing::Util::Backup.prune_backups(file, options[:prune])
+    elsif options[:redo]
+      if options[:interactive]
+        Doing::Util::Backup.select_redo(file)
+      else
+        Doing::Util::Backup.redo_backup(file, count: count)
+      end
+    else
+      if options[:interactive]
+        Doing::Util::Backup.select_backup(file)
+      else
+        Doing::Util::Backup.restore_last_backup(file, count: count)
+      end
+    end
+  end
+end

data/bin/commands/view.rb

@@ -0,0 +1,201 @@
+# @@view
+desc 'Display a user-created view'
+long_desc 'Views are defined in your configuration (use `doing config` to edit).
+Command line options override view configuration.'
+arg_name 'VIEW_NAME'
+command :view do |c|
+  c.example 'doing view color', desc: 'Display entries according to config for view "color"'
+  c.example 'doing view color --section Archive --count 10', desc: 'Display view "color", overriding some configured settings'
+
+  c.desc 'Section'
+  c.arg_name 'NAME'
+  c.flag %i[s section]
+
+  c.desc 'Count to display'
+  c.arg_name 'COUNT'
+  c.flag %i[c count], must_match: /^\d+$/, type: Integer
+
+  c.desc "Output to export format (#{Doing::Plugins.plugin_names(type: :export)})"
+  c.arg_name 'FORMAT'
+  c.flag %i[o output]
+
+  c.desc 'Age (oldest|newest)'
+  c.arg_name 'AGE'
+  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
+
+  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 'Include colors in output'
+  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.desc 'Sort tags by (name|time)'
+  c.arg_name 'KEY'
+  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, type: OrderSymbol
+
+  c.desc 'Only show items with recorded time intervals (override view settings)'
+  c.switch [:only_timed], default_value: false, negatable: false
+
+  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
+    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]
+
+    title = if args.empty?
+              @wwid.choose_view
+            else
+              begin
+                @wwid.guess_view(args[0])
+              rescue WrongCommand
+                cmd = commands[:show]
+                options[:sort] = :asc
+                options[:tag_order] = :asc
+                action = cmd.send(:get_action, nil)
+                return action.call(global_options, options, args)
+              end
+            end
+
+    section = if options[:section]
+                @wwid.guess_section(options[:section]) || options[:section].cap_first
+              else
+                @settings['current_section']
+              end
+
+    view = @wwid.get_view(title)
+
+    if view
+      page_title = view['title'] || title.cap_first
+      only_timed = if (view.key?('only_timed') && view['only_timed']) || options[:only_timed]
+                     true
+                   else
+                     false
+                   end
+
+      template = view['template'] || nil
+      date_format = view['date_format'] || nil
+
+      tags_color = view['tags_color'] || nil
+      tag_filter = false
+      if options[:tag]
+        tag_filter = { 'tags' => [], 'bool' => 'OR' }
+        bool = options[:bool]
+        tag_filter['bool'] = bool
+        tag_filter['tags'] = if bool == :pattern
+                               options[:tag]
+                             else
+                               options[:tag].gsub(/[, ]+/, ' ').split(' ').map(&:strip)
+                             end
+      elsif view.key?('tags') && view['tags'].good?
+        tag_filter = { 'tags' => [], 'bool' => 'OR' }
+        bool = view.key?('tags_bool') && !view['tags_bool'].nil? ? view['tags_bool'].normalize_bool : :pattern
+        tag_filter['bool'] = bool
+        tag_filter['tags'] = if view['tags'].instance_of?(Array)
+                               bool == :pattern ? view['tags'].join(' ').strip : view['tags'].map(&:strip)
+                             else
+                               bool == :pattern ? view['tags'].strip : view['tags'].gsub(/[, ]+/, ' ').split(' ').map(&:strip)
+                             end
+      end
+
+      # 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 = 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 = if view.key?('order')
+                view['order'].normalize_order
+              else
+                :asc
+              end
+
+      totals = if options[:totals]
+                 true
+               else
+                 view['totals'] || false
+               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]
+                            elsif view.key?('tag_sort')
+                              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] }
+
+      search = nil
+
+      if options[:search]
+        search = options[:search]
+        search.sub!(/^'?/, "'") if options[:exact]
+      end
+
+      options[:age] ||= :newest
+
+      opts = options.clone
+      opts[:age] = options[:age]
+      opts[:count] = count
+      opts[:format] = date_format
+      opts[:highlight] = options[:color]
+      opts[:hilite] = options[:hilite]
+      opts[:only_timed] = only_timed
+      opts[:order] = order
+      opts[:output] = options[:interactive] ? nil : options[:output]
+      opts[:output] = output_format
+      opts[:page_title] = page_title
+      opts[:search] = search
+      opts[:section] = section
+      opts[:tag_filter] = tag_filter
+      opts[:tag_order] = tag_order
+      opts[:tags_color] = tags_color
+      opts[:template] = template
+      opts[:totals] = totals
+      opts[:view_template] = title
+
+      Doing::Pager.page @wwid.list_section(opts)
+    elsif title.instance_of?(FalseClass)
+      raise UserCancelled, 'Cancelled'
+    else
+      raise InvalidView, "View #{title} not found in config"
+    end
+  end
+end

data/bin/commands/views.rb

@@ -0,0 +1,11 @@
+# @@views
+desc 'List available custom views'
+command :views do |c|
+  c.desc 'List in single column'
+  c.switch %i[c column], default_value: false
+
+  c.action do |_global_options, options, _args|
+    joiner = options[:column] ? "\n" : "\t"
+    print @wwid.views.join(joiner)
+  end
+end