doing 2.1.41 → 2.1.42

data/docs/doc/top-level-namespace.html

@@ -150,12 +150,20 @@
   <div class="discussion">
     <p>Add presets of flags and switches to a command.</p>
 
+<p>:output_template =&gt; --output, --config_template, --template</p>
+
 <p>:add_entry =&gt; --noauto, --note, --ask, --editor, --back</p>
 
+<p>:finish_entry =&gt; --at/finished, --from, --took</p>
+
+<p>:time_display =&gt; --times, --duration, --totals, --tag_sort, --tag_order, --only_timed</p>
+
 <p>:search =&gt; --search, --case, --exact</p>
 
 <p>:tag_filter =&gt; --tag, --bool, --not, --val</p>
 
+<p>:time_filter =&gt; --before, --after, --from</p>
+
 <p>:date_filter =&gt; --before, --after, --from</p>
 
 
@@ -206,7 +214,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 16 09:42:15 2022 by
+  Generated on Fri Mar 18 12:56:57 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-3.0.1).
 </div>

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.1.41
+v2.1.42
 
 === Global Options
 === --config_file arg
@@ -435,8 +435,8 @@ Display a formatted list of changes in recent versions.
 ===== -l|--lookup VERSION
 
 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. Wildcards (*?) accepted unless using < or >.
+               and PATCH are optional. Use > or < to see all changes since or prior
+               to a version. Wildcards (*?) accepted unless using < or >.
 
 [Default Value] None
 [Must Match] (?-mix:^(?:(?:(?:[<>=]+|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[0-9.*?]{1,10} *)+|(?:[\d.]+ *(?:-|to)+ *[0-9.]{1,10}))$)
@@ -445,7 +445,7 @@ Look up a specific version. Specify versions as "MAJ.MIN.PATCH", MIN
 ===== -s|--search arg
 
 Show changelogs matching search terms (uses pattern-based searching).
-           Add slashes to search with regular expressions, e.g. `--search "/output.*flag/"`
+               Add slashes to search with regular expressions, e.g. `--search "/output.*flag/"`
 
 [Default Value] None
 
@@ -816,8 +816,8 @@ Archive entries
 
 ===== --auto
 Auto-generate finish dates from next entry's start time.
-  Automatically generate completion dates 1 minute before next item (in any section) began.
-  --auto overrides the --date and --back parameters.
+      Automatically generate completion dates 1 minute before next item (in any section) began.
+      --auto overrides the --date and --back parameters.
 
 
 
@@ -1482,7 +1482,7 @@ Backdate start date for new entry to date string [4pm|20m|2h|yesterday noon]
 ===== --from TIME_RANGE
 
 Set a start and optionally end time as a date range ("from 1pm to 2:30pm").
-        If an end time is provided, a dated @done tag will be added
+            If an end time is provided, a dated @done tag will be added
 
 [Default Value] None
 

data/lib/doing/add_options.rb

@@ -3,12 +3,20 @@
 ##
 ## Add presets of flags and switches to a command.
 ##
+## :output_template => --output, --config_template, --template
+##
 ## :add_entry => --noauto, --note, --ask, --editor, --back
 ##
+## :finish_entry => --at/finished, --from, --took
+##
+## :time_display => --times, --duration, --totals, --tag_sort, --tag_order, --only_timed
+##
 ## :search => --search, --case, --exact
 ##
 ## :tag_filter => --tag, --bool, --not, --val
 ##
+## :time_filter => --before, --after, --from
+##
 ## :date_filter => --before, --after, --from
 ##
 ## @param      type  [Symbol] The type

data/lib/doing/array/array.rb

@@ -2,11 +2,13 @@
 
 require_relative 'tags'
 require_relative 'nested_hash'
+require_relative 'cleanup'
 
 module Doing
   class ::Array
     include ArrayTags
     include ArrayNestedHash
+    include ArrayCleanup
     ##
     ## Force UTF-8 encoding of strings in array
     ##

data/lib/doing/array/cleanup.rb

@@ -0,0 +1,31 @@
+module Doing
+  module ArrayCleanup
+    ##
+    ## Like Array#compact -- removes nil items, but also
+    ## removes empty strings, zero or negative numbers and FalseClass items
+    ##
+    ## @return     [Array] Array without "bad" elements
+    ##
+    def remove_bad
+      compact.map { |x| x.is_a?(String) ? x.strip : x }.select(&:good?)
+    end
+
+    def remove_bad!
+      replace remove_empty
+    end
+
+    ##
+    ## Like Array#compact -- removes nil items, but also
+    ## removes empty elements
+    ##
+    ## @return     [Array] Array without empty elements
+    ##
+    def remove_empty
+      compact.map { |x| x.is_a?(String) ? x.strip : x }.reject { |x| x.is_a?(String) ? x.empty? : false }
+    end
+
+    def remove_empty!
+      replace remove_empty
+    end
+  end
+end

data/lib/doing/configuration.rb

@@ -23,7 +23,8 @@ module Doing
       'editors' => {
         'default' => ENV['DOING_EDITOR'] || ENV['GIT_EDITOR'] || ENV['EDITOR'],
         'doing_file' => nil,
-        'config' => nil
+        'config' => nil,
+        'pager' => nil
       },
       'plugins' => {
         'plugin_path' => File.join(Util.user_home, '.config', 'doing', 'plugins'),
@@ -204,6 +205,7 @@ module Doing
       real_path = []
       unless keypath =~ /^[.*]?$/
         paths = keypath.split(/[:.]/)
+        element_count = paths.count
         while paths.length.positive? && !cfg.nil?
           path = paths.shift
           new_cfg = nil
@@ -220,6 +222,8 @@ module Doing
           end
 
           if new_cfg.nil?
+            return real_path if real_path[-1] == path && real_path.count == element_count
+
             if distance < 5 && !create
               return resolve_key_path(keypath, create: false, distance: distance + 1)
             else
@@ -228,12 +232,12 @@ module Doing
 
             resolved = real_path.count.positive? ? "Resolved #{real_path.join('.')}, but " : ''
             Doing.logger.log_now(:warn, "#{resolved}#{path} is unknown")
-            new_path = [*real_path, path, *paths].join('.')
+            new_path = [*real_path, path, *paths].compact.join('.')
             Doing.logger.log_now(:warn, "Continuing will create the path #{new_path}")
             res = Prompt.yn('Key path not found, create it?', default_response: true)
             raise InvalidArgument, 'Invalid key path' unless res
 
-            real_path.push(path).concat(paths)
+            real_path.push(path).concat(paths).compact!
             Doing.logger.debug('Config:', "translated key path #{keypath} to #{real_path.join('.')}")
             return real_path
           end

data/lib/doing/note.rb

@@ -20,7 +20,7 @@ module Doing
     ##
     ## Add note contents, optionally replacing existing note
     ##
-    ## @param      note     [Array] The note to add, can be
+    ## @param      note     [Array|String|Note] The note to add, can be
     ##                      String, Array, or Note
     ## @param      replace  [Boolean] replace existing
     ##                      content

data/lib/doing/pager.rb

@@ -70,14 +70,20 @@ module Doing
       end
 
       def pagers
-        [ENV['GIT_PAGER'], ENV['PAGER'], git_pager,
-         'bat -p --pager="less -Xr"', 'less -Xr', 'more -r'].compact
+        [
+          Doing.setting('editors.pager'),
+          ENV['PAGER'],
+          'less -Xr',
+          ENV['GIT_PAGER'],
+          git_pager,
+          'more -r'
+        ].remove_bad
       end
 
       def find_executable(*commands)
         execs = commands.empty? ? pagers : commands
         execs
-          .compact.map(&:strip).reject(&:empty?).uniq
+          .remove_bad.uniq
           .find { |cmd| TTY::Which.exist?(cmd.split.first) }
       end
 

data/lib/doing/plugin_manager.rb

@@ -4,10 +4,17 @@ module Doing
   # Plugin handling
   module Plugins
     class << self
+      # Return the user's home directory
       def user_home
         @user_home ||= Util.user_home
       end
 
+      # Storage for registered plugins. Hash with :import
+      # and :export keys containing hashes of available
+      # plugins.
+      #
+      # @return     [Hash] registered plugins
+      #
       def plugins
         @plugins ||= {
           import: {},
@@ -81,6 +88,17 @@ module Doing
         Doing.logger.debug('Plugin Manager:', "Registered #{type} plugin \"#{title}\"")
       end
 
+      ##
+      ## Verifies that a plugin is properly configured with
+      ## necessary methods for its type. If the plugin fails
+      ## validation, a PluginUncallable exception will be
+      ## raised.
+      ##
+      ## @param      title  [String] The title
+      ## @param      type   [Symbol] type, :import or
+      ##                    :export
+      ## @param      klass  [Class] Plugin class
+      ##
       def validate_plugin(title, type, klass)
         type = valid_type(type)
         if type == :import && !klass.respond_to?(:import)
@@ -122,8 +140,10 @@ module Doing
       ##
       ## List available plugins to stdout
       ##
-      ## @param      options  { type, separator }
+      ## @param      options  [Hash] additional options
       ##
+      ## @option options :column [Boolean] display results in a single column
+      ## @option options :type [String] Plugin type: all, import, or export
       def list_plugins(options = {})
         separator = options[:column] ? "\n" : "\t"
         type = options[:type].nil? || options[:type] =~ /all/i ? 'all' : valid_type(options[:type])
@@ -144,9 +164,9 @@ module Doing
       ##
       ## Return array of available plugin names
       ##
-      ## @param      type  Plugin type (:import, :export)
+      ## @param      type  [Symbol] Plugin type (:import, :export)
       ##
-      ## @return     [Array<String>] plugin names
+      ## @return     [Array] Array of plugin names (String)
       ##
       def available_plugins(type: :export)
         type = valid_type(type)
@@ -159,7 +179,7 @@ module Doing
       ## @param      type       Plugin type (:import, :export)
       ## @param      separator  The separator to join names with
       ##
-      ## @return     [String]   Plugin names
+      ## @return     [String]   Plugin names joined with separator
       ##
       def plugin_names(type: :export, separator: '|')
         type = valid_type(type)
@@ -190,7 +210,7 @@ module Doing
       ## @param      type  [Symbol] Plugin type (:import,
       ##                   :export)
       ##
-      ## @return     [Array<String>] template names
+      ## @return     [Array] Array of template names (String)
       ##
       def plugin_templates(type: :export)
         type = valid_type(type)
@@ -236,6 +256,9 @@ module Doing
       ## @param      trigger  [String] The trigger to test
       ## @param      type     [Symbol] the plugin type
       ##                      (:import, :export)
+      ## @param      save_to  [String] if a path is
+      ##                      specified, write the template
+      ##                      to that path. Nil for STDOUT
       ##
       ## @return     [String] string content of template for trigger
       ##
@@ -255,6 +278,8 @@ module Doing
         raise Errors::InvalidArgument, "No template type matched \"#{trigger}\""
       end
 
+      private
+
       def save_template(tpl, dir, filename)
         dir = File.expand_path(dir)
         FileUtils.mkdir_p(dir) unless File.exist?(dir)

data/lib/doing/prompt/choose.rb

@@ -104,8 +104,8 @@ module Doing
 
         fzf_args.concat([%(--filter="#{query}"), opt.fetch(:sort) ? '' : '--no-sort'])
       end
-
       res = `echo #{Shellwords.escape(options.join("\n"))}|#{fzf} #{fzf_args.join(' ')}`
+
       selected = []
       res.split(/\n/).each do |item|
         idx = item.match(/^ *(\d+)\)/)[1].to_i

data/lib/doing/prompt/input.rb

@@ -94,7 +94,7 @@ module Doing
           res << line.chomp
         end
       rescue Interrupt
-        raise UserCancelled
+        return nil
       end
 
       res.join("\n").strip

data/lib/doing/string/transform.rb

@@ -164,5 +164,11 @@ module Doing
         end
       end
     end
+
+    def titlecase
+      tr('_', ' ').
+      gsub(/\s+/, ' ').
+      gsub(/\b\w/){ $`[-1,1] == "'" ? $& : $&.upcase }
+    end
   end
 end

data/lib/doing/util.rb

@@ -47,13 +47,13 @@ module Doing
       end
     end
 
-    # Non-destructive version of deep_merge_hashes! See that
-    # method.
+    # Non-destructive version of deep_merge_hashes!
+    # @see        {deep_merge_hashes!}
     #
     # @return     the merged hashes.
     #
-    # @param      [Hash] master_hash  The master hash
-    # @param      [Hash] other_hash   The other hash
+    # @param      master_hash  [Hash]  The master hash
+    # @param      other_hash   [Hash]    The other hash
     #
     def deep_merge_hashes(master_hash, other_hash)
       deep_merge_hashes!(master_hash.clone, other_hash)
@@ -61,13 +61,19 @@ module Doing
 
     # Merges a master hash with another hash, recursively.
     #
-    # master_hash - the "parent" hash whose values will be overridden
-    # other_hash  - the other hash whose values will be persisted after the merge
+    # @param      target     [Hash] the "parent" hash whose
+    #                        values will be overridden
+    # @param      overwrite  [Hash] the other hash whose
+    #                        values will be persisted after
+    #                        the merge
     #
     # This code was lovingly stolen from some random gem:
     # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
     #
     # Thanks to whoever made it.
+    #
+    # @return     [Hash] merged hashes
+    #
     def deep_merge_hashes!(target, overwrite)
       merge_values(target, overwrite)
       merge_default_proc(target, overwrite)

data/lib/doing/util_backup.rb

@@ -24,19 +24,6 @@ module Doing
         clear_redo(filename)
       end
 
-      ##
-      ## Delete all redo files
-      ##
-      ## @param      filename  [String] The filename
-      ##
-      def clear_redo(filename)
-        filename ||= Doing.setting('doing_file')
-        backups = Dir.glob("undone*___#{File.basename(filename)}", base: backup_dir).sort.reverse
-        backups.each do |file|
-          FileUtils.rm(File.join(backup_dir, file))
-        end
-      end
-
       ##
       ## Retrieve the most recent backup
       ##
@@ -65,7 +52,8 @@ module Doing
         raise HistoryLimitError, 'End of undo history' if backup_file.nil?
 
         save_undone(filename)
-        FileUtils.mv(backup_file, filename)
+        move_backup(backup_file, filename)
+
         prune_backups_after(File.basename(backup_file))
         Doing.logger.warn('File update:', "restored from #{backup_file}")
         Doing.logger.benchmark(:restore_backup, :finish)
@@ -78,7 +66,7 @@ module Doing
       ##
       def redo_backup(filename = nil, count: 1)
         filename ||= Doing.setting('doing_file')
-        # redo_file = File.join(backup_dir, "undone___#{File.basename(filename)}")
+
         undones = Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).sort.reverse
         total = undones.count
         count = total if count > total
@@ -90,7 +78,7 @@ module Doing
 
         redo_file = File.join(backup_dir, undone)
 
-        FileUtils.move(redo_file, filename)
+        move_backup(redo_file, filename)
 
         skipped.each do |f|
           FileUtils.mv(File.join(backup_dir, f), File.join(backup_dir, f.sub(/^undone/, '')))
@@ -100,14 +88,6 @@ module Doing
         Doing.logger.debug('Backup:', "#{total - skipped.count - 1} redos remaining")
       end
 
-      def clear_undone(filename = nil)
-        filename ||= Doing.setting('doing_file')
-        # redo_file = File.join(backup_dir, "undone___#{File.basename(filename)}")
-        Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).each do |f|
-          FileUtils.rm(File.join(backup_dir, f))
-        end
-      end
-
       ##
       ## Select from recent undos. If a filename is
       ## provided, only backups of that filename will be used.
@@ -136,7 +116,7 @@ module Doing
 
         redo_file = File.join(backup_dir, undone)
 
-        FileUtils.move(redo_file, filename)
+        move_backup(redo_file, filename)
 
         skipped.each do |f|
           FileUtils.mv(File.join(backup_dir, f), File.join(backup_dir, f.sub(/^undone/, '')))
@@ -165,11 +145,47 @@ module Doing
 
         backup_file = show_menu(options, filename)
         Util.write_to_file(File.join(backup_dir, "undone___#{File.basename(filename)}"), IO.read(filename), backup: false)
-        FileUtils.mv(backup_file, filename)
+        move_backup(backup_file, filename)
         prune_backups_after(File.basename(backup_file))
         Doing.logger.warn('File update:', "restored from #{backup_file}")
       end
 
+      ##
+      ## Writes a copy of the content to a dated backup file
+      ## in a hidden directory
+      ##
+      ## @param      filename  [String] The filename
+      ##
+      def write_backup(filename = nil)
+        Doing.logger.benchmark(:_write_backup, :start)
+        filename ||= Doing.setting('doing_file')
+
+        unless File.exist?(filename)
+          Doing.logger.debug('Backup:', "original file doesn't exist (#{filename})")
+          return
+        end
+
+        backup_file = File.join(backup_dir, "#{timestamp_filename}___#{File.basename(filename)}")
+        # compressed = Zlib::Deflate.deflate(content)
+        # Zlib::GzipWriter.open(backup_file + '.gz') do |gz|
+        #   gz.write(IO.read(filename))
+        # end
+
+        FileUtils.cp(filename, backup_file)
+
+        prune_backups(filename, Doing.setting('history_size').to_i)
+        clear_undone(filename)
+        Doing.logger.benchmark(:_write_backup, :finish)
+      end
+
+      private
+
+      def move_backup(source, dest)
+        Hooks.trigger :pre_write, WWID.new, dest
+        FileUtils.mv(source, dest)
+        Hooks.trigger :post_write, dest
+      end
+
       def show_menu(options, filename)
         if TTY::Which.which('colordiff')
           preview = 'colordiff -U 1'
@@ -209,36 +225,27 @@ module Doing
         result.strip.split(/\t/).last
       end
 
+      def clear_undone(filename = nil)
+        filename ||= Doing.setting('doing_file')
+        # redo_file = File.join(backup_dir, "undone___#{File.basename(filename)}")
+        Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).each do |f|
+          FileUtils.rm(File.join(backup_dir, f))
+        end
+      end
+
       ##
-      ## Writes a copy of the content to a dated backup file
-      ## in a hidden directory
+      ## Delete all redo files
       ##
       ## @param      filename  [String] The filename
       ##
-      def write_backup(filename = nil)
-        Doing.logger.benchmark(:_write_backup, :start)
+      def clear_redo(filename)
         filename ||= Doing.setting('doing_file')
-
-        unless File.exist?(filename)
-          Doing.logger.debug('Backup:', "original file doesn't exist (#{filename})")
-          return
+        backups = Dir.glob("undone*___#{File.basename(filename)}", base: backup_dir).sort.reverse
+        backups.each do |file|
+          FileUtils.rm(File.join(backup_dir, file))
         end
-
-        backup_file = File.join(backup_dir, "#{timestamp_filename}___#{File.basename(filename)}")
-        # compressed = Zlib::Deflate.deflate(content)
-        # Zlib::GzipWriter.open(backup_file + '.gz') do |gz|
-        #   gz.write(IO.read(filename))
-        # end
-
-        FileUtils.cp(filename, backup_file)
-
-        prune_backups(filename, Doing.setting('history_size').to_i)
-        clear_undone(filename)
-        Doing.logger.benchmark(:_write_backup, :finish)
       end
 
-      private
-
       def timestamp_filename
         Time.now.strftime('%Y-%m-%d_%H.%M.%S')
       end

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.41'
+  VERSION = '2.1.42'
 end

data/lib/doing/wwid/editor.rb

@@ -12,7 +12,7 @@ module Doing
 
       raise MissingEditor, 'No EDITOR variable defined in environment' if Util.default_editor.nil?
 
-      tmpfile = Tempfile.new(['doing', '.txt'])
+      tmpfile = Tempfile.new(['doing_temp', '.doing'])
 
       File.open(tmpfile.path, 'w+') do |f|
         f.puts input
@@ -134,14 +134,15 @@ module Doing
       end
       divider = "-----------"
       notice =<<~EONOTICE
+
       # - You may delete entries, but leave all divider lines (---) in place.
       # - Start and @done dates replaced with a time string (yesterday 3pm) will
       #   be parsed automatically. Do not delete the pipe (|) between start date
       #   and entry title.
       EONOTICE
-      input =  "#{editable_items.map(&:strip).join("\n#{divider}\n")}\n\n#{notice}"
+      input =  "#{editable_items.map(&:strip).join("\n#{divider}\n")}\n"
 
-      new_items = fork_editor(input).split(/^#{divider}/).map(&:strip)
+      new_items = fork_editor(input, message: notice).split(/^#{divider}/).map(&:strip)
 
       new_items.each_with_index do |new_item, i|
         input_lines = new_item.split(/[\n\r]+/).delete_if(&:ignore?)
@@ -190,6 +191,8 @@ module Doing
       content = ["#{item.date.strftime('%F %R')} | #{item.title.dup}"]
       content << item.note.strip_lines.join("\n") unless item.note.empty?
       new_item = fork_editor(content.join("\n"))
+      raise UserCancelled, 'No change' if new_item.strip == content.join("\n").strip
+
       date, title, note = format_input(new_item)
       date ||= item.date
 

data/lib/doing/wwid/interactive.rb

@@ -92,22 +92,21 @@ module Doing
 
         actions.concat(['resume/repeat', 'begin/reset']) if items.count == 1
 
-        choice = Prompt.choose_from(actions,
+        choice = Prompt.choose_from(actions.map(&:titlecase),
                                     prompt: 'What do you want to do with the selected items? > ',
                                     multiple: true,
                                     sorted: false,
                                     fzf_args: ["--height=#{actions.count + 3}", '--tac', '--no-sort', '--info=hidden'])
         return unless choice
 
-        to_do = choice.strip.split(/\n/)
+        to_do = choice.strip.split(/\n/).map(&:downcase)
+
         to_do.each do |action|
           case action
-          when /resume/
-            opt[:resume] = true
-          when /reset/
-            opt[:reset] = true
-          when /autotag/
-            opt[:autotag] = true
+          when /(resume|reset|autotag|archive|delete|finish|cancel|flag)/
+            opt[action.to_sym] = true
+          when /edit/
+            opt[:editor] = true
           when /(add|remove) tag/
             type = action =~ /^add/ ? 'add' : 'remove'
             raise InvalidArgument, "'add tag' and 'remove tag' can not be used together" if opt[:tag]
@@ -149,21 +148,9 @@ module Doing
 
               opt[:save_to] = filename
             end
-          when /archive/
-            opt[:archive] = true
-          when /delete/
-            opt[:delete] = true
-          when /edit/
-            opt[:editor] = true
-          when /finish/
-            opt[:finish] = true
-          when /cancel/
-            opt[:cancel] = true
           when /move/
             section = choose_section.strip
             opt[:move] = section.strip unless section =~ /^ *$/
-          when /flag/
-            opt[:flag] = true
           end
         end
       end
@@ -263,6 +250,9 @@ module Doing
       write(@doing_file)
 
       if opt[:editor]
+        sleep 2 # This seems to be necessary between running fzf
+                # and forking the editor, otherwise vim gets all
+                # screwy and I can't figure out why
         edit_items(items) # hooked
 
         write(@doing_file)

data/lib/doing/wwid/modify.rb

@@ -509,6 +509,8 @@ module Doing
             new_tag = r
 
             m.to_a.slice(1, m.length - 1).each_with_index do |v, idx|
+              next if v.nil?
+
               new_tag.gsub!("\\#{idx + 1}", v)
             end
             # Replace original tag if /r