doing 2.0.25 → 2.1.0pre

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 18 16:39:11 2021 by
+  Generated on Sat Nov 27 10:06:03 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>

data/doing.gemspec

@@ -31,10 +31,13 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency 'redcarpet', '~> 3.5', '>= 3.5.1'
   s.add_development_dependency 'github-markup', '~> 4.0', '>= 4.0.0'
   s.add_development_dependency 'parallel_tests', '~> 3.7', '>= 3.7.3'
+  s.add_development_dependency 'tty-spinner', '~> 0.9', '>= 0.9.3'
   s.add_runtime_dependency('tty-progressbar', '~> 0.18', '>= 0.18.2')
   s.add_runtime_dependency('gli', '~> 2.19', '>= 2.19.2')
   s.add_runtime_dependency('haml','~>5.0.0', '>= 5.0.0')
   s.add_runtime_dependency('chronic','~> 0.10', '>= 0.10.2')
   s.add_runtime_dependency('deep_merge', '~> 1.2', '>= 1.2.1')
+  s.add_runtime_dependency('tty-link', '~> 0.1', '>= 0.1.1')
+  s.add_runtime_dependency('tty-which', '~> 0.5', '>= 0.5.0')
   # s.add_runtime_dependency('amatch', '~> 0.4', '>= 0.4.0')
 end

data/doing.rdoc

@@ -5,7 +5,7 @@ record of what you've been doing, complete with tag-based time tracking. The
 command line tool allows you to add entries, annotate with tags and notes, and
 view your entries with myriad options, with a focus on a "natural" language syntax.
 
-v2.0.25
+v2.1.0pre
 
 === Global Options
 === --config_file arg
@@ -42,6 +42,11 @@ Show this message
 
 
 
+=== --no
+Answer all yes/no menus with no
+
+
+
 === --[no-]notes
 Output notes if included in the template
 
@@ -72,6 +77,11 @@ Exclude auto tags and default tags
 
 
 
+=== --yes
+Answer all yes/no menus with yes
+
+
+
 === Commands
 ==== Command: <tt>add_section  SECTION_NAME</tt>
 Add a new section to the "doing" file
@@ -414,14 +424,14 @@ Open config file in editor
 
 
 ======= Options
-======= -a APP_NAME
+======= -a|--app APP_NAME
 
 Application to use
 
 [Default Value] None
 
 
-======= -b BUNDLE_ID
+======= -b|--bundle_id BUNDLE_ID
 
 Application bundle id to use
 
@@ -435,7 +445,7 @@ Editor to use
 [Default Value] None
 
 
-======= -x
+======= -x|--[no-]default
 Use the config_editor_app defined in ~/.config/doing/config.yml (config_editor_app not set)
 
 
@@ -453,10 +463,21 @@ Format for output (json|yaml|raw)
 [Must Match] (?-mix:^(?:y(?:aml)?|j(?:son)?|r(?:aw)?)$)
 
 
+====== Command: <tt>list </tt>
+List configuration paths, including .doingrc files in the current and parent directories
+
+Config files are listed in order of precedence (if there are multiple configs detected).
+  Values defined in the top item in the list will override values in configutations below it.
 ====== Command: <tt>set </tt>
 Set a key's value in the config file
 
 
+======= Options
+======= -r|--remove
+Delete specified key
+
+
+
 ====== Command: <tt>undo </tt>
 Undo the last change to a config file
 
@@ -479,9 +500,9 @@ Set finish date to specific date/time (natural langauge parsed, e.g. --at=1:30pm
 [Default Value] None
 
 
-===== -b|--back DATE_STRING
+===== -b|--back|--started DATE_STRING
 
-Backdate start date by interval [4pm|20m|2h|yesterday noon]
+Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]
 
 [Default Value] None
 
@@ -734,7 +755,7 @@ List commands one per line, to assist with shell completion
 ==== Command: <tt>import  PATH</tt>
 Import entries from an external source
 
-Imports entries from other sources. Available plugins: calendar, doing, timing
+Imports entries from other sources. Available plugins: calendar, capturething, doing, timing
 ===== Options
 ===== --after DATE_STRING
 
@@ -797,7 +818,7 @@ Tag all imported entries
 
 ===== --type TYPE
 
-Import type (calendar|doing|timing)
+Import type (calendar|capturething|doing|timing)
 
 [Default Value] doing
 
@@ -1110,9 +1131,9 @@ A parenthetical at the end of the entry will be converted to a note.
 
 Run with no argument to create a new entry using vim.
 ===== Options
-===== -b|--back DATE_STRING
+===== -b|--back|--started DATE_STRING
 
-Backdate start time [4pm|20m|2h|yesterday noon]
+Backdate start time [4pm|20m|2h|"yesterday noon"]
 
 [Default Value] None
 
@@ -1199,6 +1220,13 @@ Open with app bundle id
 [Default Value] None
 
 
+===== -e|--editor COMMAND
+
+Open with editor command (e.g. vim, mate)
+
+[Default Value] None
+
+
 ==== Command: <tt>plugins </tt>
 List installed plugins
 
@@ -1808,7 +1836,7 @@ Output HTML, CSS, and Markdown (ERB) templates for customization
 Templates are printed to STDOUT for piping to a file.
   Save them and use them in the configuration file under export_templates.
 ===== Options
-===== -c
+===== -c|--[no-]column
 List in single column for completion
 
 
@@ -1874,7 +1902,7 @@ Show time totals at the end of output
 
 
 ==== Command: <tt>undo </tt>
-Undo the last change to the doing_file
+Undo the last change to the Doing file
 
 
 ===== Options

data/example_plugin.rb

@@ -136,9 +136,9 @@ module Doing
       # or :map to generate output.
       i = items[-1]
 
-      # Format the item. Items are a hash with 4 keys: date,
-      # title, section (parent section), and note. Start
-      # time is in item.date. The wwid object has some
+      # Format the item. Items are an object with 4 methods:
+      # date, title, section (parent section), and note.
+      # Start time is in item.date. The wwid object has some
       # methods for calculation and formatting, including
       # wwid.item.end_date to convert the @done timestamp to
       # an end date.

data/lib/completion/_doing.zsh

@@ -48,7 +48,7 @@ function _doing() {
                   'template:Output HTML'
                   'test:Test Stuff'
                   'today:List entries from today'
-                  'undo:Undo the last change to the doing_file'
+                  'undo:Undo the last change to the Doing file'
                   'view:Display a user-created view'
                   'views:List available custom views'
                   'wiki:Output a tag wiki'

data/lib/completion/doing.bash

@@ -81,9 +81,9 @@ _doing_config() {
 _doing_done() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--archive --at --back --date --editor --note --remove --section --took --unfinished' -- $token ) )
+    COMPREPLY=( $( compgen -W '--archive --at --started --date --editor --note --remove --section --took --unfinished' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-a -b -e -n -r -s -t -u --archive --at --back --date --editor --note --remove --section --took --unfinished' -- $token ) )
+    COMPREPLY=( $( compgen -W '-a -e -n -r -s -t -u --archive --at --started --date --editor --note --remove --section --took --unfinished' -- $token ) )
   
   fi
 }
@@ -181,9 +181,9 @@ _doing_note() {
 _doing_now() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--back --editor --finish_last --note --section' -- $token ) )
+    COMPREPLY=( $( compgen -W '--started --editor --finish_last --note --section' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-b -e -f -n -s --back --editor --finish_last --note --section' -- $token ) )
+    COMPREPLY=( $( compgen -W '-e -f -n -s --started --editor --finish_last --note --section' -- $token ) )
   
   fi
 }
@@ -201,9 +201,9 @@ _doing_on() {
 _doing_open() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--app --bundle_id' -- $token ) )
+    COMPREPLY=( $( compgen -W '--app --bundle_id --editor' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-a -b --app --bundle_id' -- $token ) )
+    COMPREPLY=( $( compgen -W '-a -b -e --app --bundle_id --editor' -- $token ) )
   
   fi
 }
@@ -321,9 +321,9 @@ _doing_tag() {
 _doing_template() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--list' -- $token ) )
+    COMPREPLY=( $( compgen -W '--column --list' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-l --list' -- $token ) )
+    COMPREPLY=( $( compgen -W '-c -l --column --list' -- $token ) )
   
   fi
 }

data/lib/completion/doing.fish

@@ -91,7 +91,7 @@ complete -xc doing -n '__fish_doing_needs_command' -a 'tag' -d Add\ tag\(s\)\ to
 complete -xc doing -n '__fish_doing_needs_command' -a 'template' -d Output\ HTML
 complete -xc doing -n '__fish_doing_needs_command' -a 'test' -d Test\ Stuff
 complete -xc doing -n '__fish_doing_needs_command' -a 'today' -d List\ entries\ from\ today
-complete -xc doing -n '__fish_doing_needs_command' -a 'undo' -d Undo\ the\ last\ change\ to\ the\ doing_file
+complete -xc doing -n '__fish_doing_needs_command' -a 'undo' -d Undo\ the\ last\ change\ to\ the\ Doing\ file
 complete -xc doing -n '__fish_doing_needs_command' -a 'view' -d Display\ a\ user-created\ view
 complete -xc doing -n '__fish_doing_needs_command' -a 'views' -d List\ available\ custom\ views
 complete -xc doing -n '__fish_doing_needs_command' -a 'wiki' -d Output\ a\ tag\ wiki

data/lib/doing/array.rb

@@ -5,17 +5,53 @@ module Doing
   ## Array helpers
   ##
   class ::Array
+    # Convert strings to @tags
+    #
+    # @example `['one', '@two', 'three'].to_tags`
+    # @example `=> ['@one', '@two', '@three']`
+    # @return     [Array] Array of @tags
+    #
     def to_tags
       map { |t| t.sub(/^@?/, '@') }
     end
 
+    def to_tags!
+      replace to_tags
+    end
+
+    ##
+    ## Hightlight @tags in string for console output
+    ##
+    ## @param      color  [String] the color to highlight
+    ##                    with
+    ##
+    ## @return     [String] string with @tags highlighted
+    ##
     def highlight_tags(color = 'cyan')
       tag_color = Doing::Color.send(color)
       to_tags.map { |t| "#{tag_color}#{t}" }
     end
 
+    ##
+    ## Tag array for logging
+    ##
+    ## @return     [String] Highlighted tag array joined with comma
+    ##
     def log_tags
       highlight_tags.join(', ')
     end
+
+    ##
+    ## Convert array to nested hash, setting last key to value
+    ##
+    ## @param      value  The value to set
+    ##
+    def nested_hash(value)
+      raise StandardError, 'Value can not be nil' if value.nil?
+
+      hsh = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+      hsh.dig(*self[0..-2])[self.fetch(-1)] = value
+      hsh
+    end
   end
 end

data/lib/doing/colors.rb

@@ -1,64 +1,65 @@
+# frozen_string_literal: true
+
 # Cribbed from <https://github.com/flori/term-ansicolor>
 module Doing
+  # Terminal color functions
   module Color
-
     # :stopdoc:
     ATTRIBUTES = [
-      [ :clear              ,   0 ],     # String#clear is already used to empty string in Ruby 1.9
-      [ :reset              ,   0 ],     # synonym for :clear
-      [ :bold               ,   1 ],
-      [ :dark               ,   2 ],
-      [ :italic             ,   3 ],     # not widely implemented
-      [ :underline          ,   4 ],
-      [ :underscore         ,   4 ],     # synonym for :underline
-      [ :blink              ,   5 ],
-      [ :rapid_blink        ,   6 ],     # not widely implemented
-      [ :negative           ,   7 ],     # no reverse because of String#reverse
-      [ :concealed          ,   8 ],
-      [ :strikethrough      ,   9 ],     # not widely implemented
-      [ :black              ,  30 ],
-      [ :red                ,  31 ],
-      [ :green              ,  32 ],
-      [ :yellow             ,  33 ],
-      [ :blue               ,  34 ],
-      [ :magenta            ,  35 ],
-      [ :cyan               ,  36 ],
-      [ :white              ,  37 ],
-      [ :bgblack            ,  40 ],
-      [ :bgred              ,  41 ],
-      [ :bggreen            ,  42 ],
-      [ :bgyellow           ,  43 ],
-      [ :bgblue             ,  44 ],
-      [ :bgmagenta          ,  45 ],
-      [ :bgcyan             ,  46 ],
-      [ :bgwhite            ,  47 ],
-      [ :boldblack          ,  90 ],    # High intensity, aixterm (works in OS X)
-      [ :boldred            ,  91 ],
-      [ :boldgreen          ,  92 ],
-      [ :boldyellow         ,  93 ],
-      [ :boldblue           ,  94 ],
-      [ :boldmagenta        ,  95 ],
-      [ :boldcyan           ,  96 ],
-      [ :boldwhite          ,  97 ],
-      [ :boldbgblack        , 100 ],    # High intensity background, aixterm (works in OS X)
-      [ :boldbgred          , 101 ],
-      [ :boldbggreen        , 102 ],
-      [ :boldbgyellow       , 103 ],
-      [ :boldbgblue         , 104 ],
-      [ :boldbgmagenta      , 105 ],
-      [ :boldbgcyan         , 106 ],
-      [ :boldbgwhite        , 107 ],
-      [ :softpurple    , '0;35;40'],
-      [ :hotpants      , '7;34;40'],
-      [ :knightrider   , '7;30;40'],
-      [ :flamingo      , '7;31;47'],
-      [ :yeller        , '1;37;43'],
-      [ :whiteboard    , '1;30;47'],
-      [ :default         , '0;39' ]
-    ]
+      [:clear,   0],     # String#clear is already used to empty string in Ruby 1.9
+      [:reset,   0],     # synonym for :clear
+      [:bold,   1],
+      [:dark,   2],
+      [:italic, 3], # not widely implemented
+      [:underline, 4],
+      [:underscore, 4], # synonym for :underline
+      [:blink, 5],
+      [:rapid_blink, 6], # not widely implemented
+      [:negative, 7], # no reverse because of String#reverse
+      [:concealed, 8],
+      [:strikethrough, 9], # not widely implemented
+      [:black, 30],
+      [:red, 31],
+      [:green, 32],
+      [:yellow, 33],
+      [:blue, 34],
+      [:magenta, 35],
+      [:cyan, 36],
+      [:white, 37],
+      [:bgblack, 40],
+      [:bgred, 41],
+      [:bggreen, 42],
+      [:bgyellow, 43],
+      [:bgblue, 44],
+      [:bgmagenta, 45],
+      [:bgcyan, 46],
+      [:bgwhite, 47],
+      [:boldblack, 90], # High intensity, aixterm (works in OS X)
+      [:boldred, 91],
+      [:boldgreen, 92],
+      [:boldyellow, 93],
+      [:boldblue, 94],
+      [:boldmagenta, 95],
+      [:boldcyan, 96],
+      [:boldwhite, 97],
+      [:boldbgblack, 100], # High intensity background, aixterm (works in OS X)
+      [:boldbgred, 101],
+      [:boldbggreen, 102],
+      [:boldbgyellow, 103],
+      [:boldbgblue, 104],
+      [:boldbgmagenta, 105],
+      [:boldbgcyan, 106],
+      [:boldbgwhite, 107],
+      [:softpurple, '0;35;40'],
+      [:hotpants, '7;34;40'],
+      [:knightrider, '7;30;40'],
+      [:flamingo, '7;31;47'],
+      [:yeller, '1;37;43'],
+      [:whiteboard, '1;30;47'],
+      [:default, '0;39']
+    ].map(&:freeze).freeze
 
     ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
-    # :startdoc:
 
     # Returns true if Doing::Color supports the +feature+.
     #
@@ -72,19 +73,23 @@ module Doing
         !String.instance_methods(false).map(&:to_sym).include?(:clear)
       end
     end
-    # Returns true, if the coloring function of this module
-    # is switched on, false otherwise.
-    def self.coloring?
-      @coloring
-    end
 
-    # Turns the coloring on or off globally, so you can easily do
-    # this for example:
-    #  Doing::Color::coloring = STDOUT.isatty
-    def self.coloring=(val)
-      @coloring = val
+    class << self
+      # Returns true, if the coloring function of this module
+      # is switched on, false otherwise.
+      def coloring?
+        @coloring
+      end
+
+      # Turns the coloring on or off globally, so you can easily do
+      # this for example:
+      #  Doing::Color::coloring = STDOUT.isatty
+      attr_writer :coloring
+
+      def coloring
+        @coloring ||= true
+      end
     end
-    self.coloring = true
 
     ATTRIBUTES.each do |c, v|
       eval <<-EOT
@@ -133,4 +138,3 @@ module Doing
     extend self
   end
 end
-

data/lib/doing/completion.rb

@@ -12,6 +12,12 @@ module Doing
   # Completion script generator
   module Completion
     class << self
+      # Generate a completion script and output to file or
+      # stdout
+      #
+      # @param      type  [String] shell to generate for (zsh|bash|fish)
+      # @param      file  [String] Path to save to, or 'stdout'
+      #
       def generate_completion(type: 'zsh', file: 'stdout')
 
         generator = case type.to_s

data/lib/doing/configuration.rb

@@ -99,6 +99,10 @@ module Doing
       @config_file ||= default_config_file
     end
 
+    def config_file=(file)
+      @config_file = file
+    end
+
     def config_dir
       @config_dir ||= File.join(Util.user_home, '.config', 'doing')
       # @config_dir ||= Util.user_home
@@ -116,20 +120,20 @@ module Doing
       File.join(config_dir, 'config.yml')
     end
 
-    def config_file=(file)
-      @config_file = file
-    end
-
-
     def additional_configs
       @additional_configs ||= find_local_config
     end
 
+    ##
+    ## Present a menu if there are multiple configs found
+    ##
+    ## @return     [String] file path
+    ##
     def choose_config
       if @additional_configs.count.positive?
         choices = [@config_file]
         choices.concat(@additional_configs)
-        res = Doing::WWID.new.choose_from(choices.uniq.sort.reverse, sorted: false, prompt: 'Local configs found, select which to update > ')
+        res = Doing::Prompt.choose_from(choices.uniq.sort.reverse, sorted: false, prompt: 'Local configs found, select which to update > ')
 
         raise UserCancelled, 'Cancelled' unless res
 
@@ -139,6 +143,16 @@ module Doing
       end
     end
 
+    ##
+    ## Resolve a fuzzy-matched key path
+    ##
+    ## @param      keypath  [String] A dot-separated key
+    ##                      path, e.g.
+    ##                      "plugins.plugin_path". Will also
+    ##                      work with "plug.path" (fuzzy
+    ##                      matched, first match wins)
+    ## @return     [Array] ordered array of resolved keys
+    ##
     def resolve_key_path(keypath)
       cfg = @settings
       real_path = []
@@ -166,12 +180,22 @@ module Doing
       real_path
     end
 
+    ##
+    ## Get the value for a fuzzy-matched key path
+    ##
+    ## @param      keypath  [String] A dot-separated key
+    ##                      path, e.g.
+    ##                      "plugins.plugin_path". Will also
+    ##                      work with "plug.path" (fuzzy
+    ##                      matched, first match wins)
+    ## @return     [Hash] Config value
+    ##
     def value_for_key(keypath = '')
       cfg = @settings
       real_path = ['config']
       unless keypath =~ /^[.*]?$/
         real_path = resolve_key_path(keypath)
-        return nil unless real_path && real_path.count.positive?
+        return nil unless real_path&.count&.positive?
 
         cfg = cfg.dig(*real_path)
       end
@@ -188,6 +212,9 @@ module Doing
       Util.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
     end
 
+    ##
+    ## Method for transitioning from ~/.doingrc to ~/.config/doing/config.yml
+    ##
     def update_deprecated_config
       # return # Until further notice
       return if File.exist?(default_config_file)
@@ -199,22 +226,23 @@ module Doing
       Doing.logger.log_now(:warn, 'Deprecated:', "main config file location has changed to #{config_file}")
       res = wwid.yn("Move #{old_file} to new location, preserving settings?", default_response: true)
 
-      if res
-        if File.exist?(default_config_file)
-          res = wwid.yn("#{default_config_file} already exists, overwrite it?", default_response: false)
+      return unless res
 
-          unless res
-            @config_file = old_file
-            return
-          end
-        end
+      if File.exist?(default_config_file)
+        res = wwid.yn("#{default_config_file} already exists, overwrite it?", default_response: false)
 
-        FileUtils.mv old_file, default_config_file, force: true
-        Doing.logger.log_now(:warn, 'Config:', "Config file moved to #{default_config_file}")
-        Doing.logger.log_now(:warn, 'Config:', %(If ~/.config/doing/config.yml exists in the future, it will be considered a local
-                             config and its values will override the default configuration.))
-        Process.exit 0
+        unless res
+          @config_file = old_file
+          return
+        end
       end
+
+      FileUtils.mv old_file, default_config_file, force: true
+      Doing.logger.log_now(:warn, 'Config:', "Config file moved to #{default_config_file}")
+      Doing.logger.log_now(:warn, 'Config:', %(If ~/.doingrc exists in the future,
+                           it will be considered a local config and its values will override the
+                           default configuration.))
+      Process.exit 0
     end
 
     ##
@@ -261,8 +289,23 @@ module Doing
       config
     end
 
+    # @private
+    def inspect
+      %(<Doing::Configuration #{@settings.hash}>)
+    end
+
+    # @private
+    def to_s
+      YAML.dump(@settings)
+    end
+
     private
 
+    ##
+    ## Test for deprecated config keys
+    ##
+    ## @param      config  The configuration
+    ##
     def find_deprecations(config)
       deprecated = false
       if config.key?('editor')
@@ -276,14 +319,16 @@ module Doing
         deprecated = true
         config['editors']['config'] = config['config_editor_app']
         config.delete('config_editor_app')
-        Doing.logger.debug('Deprecated:', "config key 'config_editor_app' is now 'editors->config', please update your config.")
+        Doing.logger.debug('Deprecated:',
+                           "config key 'config_editor_app' is now 'editors->config', please update your config.")
       end
 
       if config.key?('editor_app') && !config['editors']['doing_file']
         deprecated = true
         config['editors']['doing_file'] = config['editor_app']
         config.delete('editor_app')
-        Doing.logger.debug('Deprecated:', "config key 'editor_app' is now 'editors->doing_file', please update your config.")
+        Doing.logger.debug('Deprecated:',
+                           "config key 'editor_app' is now 'editors->doing_file', please update your config.")
       end
 
       Doing.logger.warn('Deprecated:', 'outdated keys found, please run `doing config --update`.') if deprecated
@@ -327,7 +372,7 @@ module Doing
     ##
     def read_config
       unless File.exist?(config_file)
-        Doing.logger.info('Config:', 'Config file doesn\'t exist, using default configuration' )
+        Doing.logger.info('Config:', 'Config file doesn\'t exist, using default configuration')
         return {}.deep_merge(DEFAULTS)
       end
 
@@ -372,11 +417,7 @@ module Doing
     end
 
     def load_plugins(add_dir = nil)
-      begin
-        FileUtils.mkdir_p(add_dir) if add_dir && !File.exist?(add_dir)
-      rescue
-        nil
-      end
+      FileUtils.mkdir_p(add_dir) if add_dir && !File.exist?(add_dir)
 
       Plugins.load_plugins(add_dir)
     end