doing 2.1.6pre → 2.1.9

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

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 20 15:39:45 2021 by
+  Generated on Tue Dec 21 12:36:35 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/docs/index.md

@@ -6,7 +6,7 @@ _If you're one of the rare people like me who find this useful, feel free to [bu
 
 
 
-The current version of `doing` is 2.1.4.
+The current version of `doing` is 2.1.5.
 
 Find all of the documentation in the [doing wiki](https://github.com/ttscoff/doing/wiki).
 

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.6pre
+v2.1.9
 
 === Global Options
 === --config_file arg

data/lib/doing/configuration.rb

@@ -31,6 +31,7 @@ module Doing
       },
       'doing_file' => '~/.local/share/doing/what_was_i_doing.md',
       'backup_dir' => '~/.local/share/doing/doing_backup',
+      'history_size' => 15,
       'current_section' => 'Currently',
       'paginate' => false,
       'never_time' => [],

data/lib/doing/log_adapter.rb

@@ -259,6 +259,7 @@ module Doing
 
       if @logdev == $stdout
         $stdout.print results.map {|res| res[:message].uncolor }.join("\n")
+        $stdout.puts
       else
         results.each do |msg|
           @logdev.puts color_message(msg[:level], msg[:message])

data/lib/doing/prompt.rb

@@ -86,7 +86,38 @@ module Doing
         @fzf ||= install_fzf
       end
 
-      def install_fzf
+      def uninstall_fzf
+        fzf_bin = File.join(File.dirname(__FILE__), '../helpers/fzf/bin/fzf')
+        FileUtils.rm_f(fzf_bin) if File.exist?(fzf_bin)
+        Doing.logger.warn('fzf:', "removed #{fzf_bin}")
+      end
+
+      def which_fzf
+        fzf_dir = File.join(File.dirname(__FILE__), '../helpers/fzf')
+        fzf_bin = File.join(fzf_dir, 'bin/fzf')
+        return fzf_bin if File.exist?(fzf_bin)
+
+        Doing.logger.debug('fzf:', 'Using user-installed fzf')
+        TTY::Which.which('fzf')
+      end
+
+      def silence_std(file = '/dev/null')
+        $stdout = File.new(file, 'w')
+        $stderr = File.new(file, 'w')
+      end
+
+      def restore_std
+        $stdout = STDOUT
+        $stderr = STDERR
+      end
+
+      def install_fzf(force: false)
+        if force
+          uninstall_fzf
+        elsif which_fzf
+          return which_fzf
+        end
+
         fzf_dir = File.join(File.dirname(__FILE__), '../helpers/fzf')
         FileUtils.mkdir_p(fzf_dir) unless File.directory?(fzf_dir)
         fzf_bin = File.join(fzf_dir, 'bin/fzf')
@@ -94,17 +125,25 @@ module Doing
 
         prev_level = Doing.logger.level
         Doing.logger.adjust_verbosity({ log_level: :info })
-        Doing.logger.log_now(:warn, 'Compiling and installing fzf -- this will only happen once')
-        Doing.logger.log_now(:warn, 'fzf is copyright Junegunn Choi, MIT License <https://github.com/junegunn/fzf/blob/master/LICENSE>')
+        Doing.logger.log_now(:warn, 'fzf:', 'Compiling and installing fzf -- this will only happen once')
+        Doing.logger.log_now(:warn, 'fzf:', 'fzf is copyright Junegunn Choi, MIT License <https://github.com/junegunn/fzf/blob/master/LICENSE>')
 
-        system("'#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null")
+        silence_std
+        `'#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null`
         unless File.exist?(fzf_bin)
+          restore_std
           Doing.logger.log_now(:warn, 'Error installing, trying again as root')
-          system("sudo '#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null")
+          silence_std
+          `sudo '#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null`
+        end
+        restore_std
+        unless File.exist?(fzf_bin)
+          Doing.logger.error('fzf:', 'unable to install fzf. You can install manually and Doing will use the system version.')
+          Doing.logger.error('fzf:', 'see https://github.com/junegunn/fzf#installation')
+          raise RuntimeError.new('Error installing fzf, please report at https://github.com/ttscoff/doing/issues')
         end
-        raise RuntimeError.new('Error installing fzf, please report at https://github.com/ttscoff/doing/issues') unless File.exist?(fzf_bin)
 
-        Doing.logger.info("fzf installed to #{fzf}")
+        Doing.logger.info('fzf:', "installed to #{fzf}")
         Doing.logger.adjust_verbosity({ log_level: prev_level })
         fzf_bin
       end
@@ -189,7 +228,7 @@ module Doing
           %(-q "#{query}"),
           '--info=inline'
         ]
-        fzf_args.push('-1') unless opt.fetch(:show_if_single)
+        fzf_args.push('-1') unless opt.fetch(:show_if_single, false)
         fzf_args << case case_sensitive
                     when :sensitive
                       '+i'

data/lib/doing/util_backup.rb

@@ -20,6 +20,21 @@ module Doing
         backups[limit..-1].each do |file|
           FileUtils.rm(File.join(backup_dir, file))
         end
+
+        clear_redo(filename)
+      end
+
+      ##
+      ## Delete all redo files
+      ##
+      ## @param      limit  Maximum number of backups to retain
+      ##
+      def clear_redo(filename)
+        filename ||= Doing.config.settings['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
 
       ##
@@ -103,6 +118,8 @@ module Doing
           arr.push("#{d.time_ago}\t#{File.join(backup_dir, file)}")
         end
 
+        raise DoingRuntimeError, 'No backup files to load' if options.empty?
+
         backup_file = show_menu(options, filename)
         idx = undones.index(File.basename(backup_file))
         skipped = undones.slice!(idx, undones.count - idx)
@@ -135,8 +152,10 @@ module Doing
           arr.push("#{d.time_ago}\t#{File.join(backup_dir, file)}")
         end
 
+        raise DoingRuntimeError, 'No backup files to load' if options.empty?
+
         backup_file = show_menu(options, filename)
-        write_to_file(File.join(backup_dir, "undone___#{File.basename(filename)}"), IO.read(filename), backup: false)
+        Util.write_to_file(File.join(backup_dir, "undone___#{File.basename(filename)}"), IO.read(filename), backup: false)
         FileUtils.mv(backup_file, filename)
         prune_backups_after(File.basename(backup_file))
         Doing.logger.warn('File update:', "restored from #{backup_file}")
@@ -204,7 +223,7 @@ module Doing
 
         FileUtils.cp(filename, backup_file)
 
-        prune_backups(filename, 15)
+        prune_backups(filename, Doing.config.settings['history_size'].to_i)
         clear_undone(filename)
         Doing.logger.benchmark(:_write_backup, :finish)
       end
@@ -215,10 +234,10 @@ module Doing
         Time.now.strftime('%Y-%m-%d_%H.%M.%S')
       end
 
-      def get_backups(filename = nil)
+      def get_backups(filename = nil, include_forward: false)
         filename ||= Doing.config.settings['doing_file']
         backups = Dir.glob("*___#{File.basename(filename)}", base: backup_dir).sort.reverse
-        backups.delete_if { |f| f =~ /^undone/ }
+        backups.delete_if { |f| f =~ /^undone/ } unless include_forward
       end
 
       def save_undone(filename = nil)

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.6pre'
+  VERSION = '2.1.9'
 end

data/lib/doing/wwid.rb

@@ -338,7 +338,8 @@ module Doing
     ## @option opt :back [Date] backdate
     ## @option opt :timed [Boolean] new item is timed entry, marks previous entry as @done
     ##
-    def add_item(title, section = nil, opt = {})
+    def add_item(title, section = nil, opt)
+      opt ||= {}
       section ||= @config['current_section']
       @content.add_section(section, log: false)
       opt[:back] ||= opt[:date] ? opt[:date] : Time.now
@@ -401,7 +402,8 @@ module Doing
     ## @param      paths  [String] Path to JSON report file
     ## @param      opt    [Hash] Additional Options
     ##
-    def import(paths, opt = {})
+    def import(paths, opt)
+      opt ||= {}
       Plugins.plugins[:import].each do |_, options|
         next unless opt[:type] =~ /^(#{options[:trigger].normalize_trigger})$/i
 
@@ -461,7 +463,8 @@ module Doing
     #
     # @return     nothing
     #
-    def repeat_item(item, opt = {})
+    def repeat_item(item, opt)
+      opt ||= {}
       if item.should_finish?
         if item.should_time?
           item.title.tag!('done', value: Time.now.strftime('%F %R'))
@@ -501,7 +504,8 @@ module Doing
     ##
     ## @param      opt   [Hash] Additional Options
     ##
-    def repeat_last(opt = {})
+    def repeat_last(opt)
+      opt ||= {}
       opt[:section] ||= 'all'
       opt[:section] = guess_section(opt[:section])
       opt[:note] ||= []
@@ -523,7 +527,8 @@ module Doing
     ##
     ## @param      opt   [Hash] Additional Options
     ##
-    def last_entry(opt = {})
+    def last_entry(opt)
+      opt ||= {}
       opt[:tag_bool] ||= :and
       opt[:section] ||= @config['current_section']
 
@@ -800,7 +805,8 @@ module Doing
     ##
     ## Options hash is shared with #filter_items and #act_on
     ##
-    def interactive(opt = {})
+    def interactive(opt)
+      opt ||= {}
       opt[:section] = opt[:section] ? guess_section(opt[:section]) : 'All'
 
       search = nil
@@ -820,7 +826,11 @@ module Doing
       }
       items = filter_items(Items.new, opt: filter_options)
 
-      selection = Prompt.choose_from_items(items, include_section: opt[:section] =~ /^all$/i, **opt)
+      menu_options = %i[search query exact multiple show_if_single menu sort case].each_with_object({}) {
+        |k, hsh| hsh[k] = opt[k]
+      }
+
+      selection = Prompt.choose_from_items(items, include_section: opt[:section] =~ /^all$/i, **menu_options)
 
       raise NoResults, 'no items selected' if selection.nil? || selection.empty?
 
@@ -848,7 +858,8 @@ module Doing
     ## @option opt [Boolean] :again
     ## @option opt [Boolean] :resume
     ##
-    def act_on(items, opt = {})
+    def act_on(items, opt)
+      opt ||= {}
       actions = %i[editor delete tag flag finish cancel archive output save_to again resume]
       has_action = false
       single = items.count == 1
@@ -1105,7 +1116,8 @@ module Doing
     ##
     ## @see        #filter_items
     ##
-    def tag_last(opt = {})
+    def tag_last(opt)
+      opt ||= {}
       opt[:count] ||= 1
       opt[:archive] ||= false
       opt[:tags] ||= ['done']
@@ -1229,7 +1241,8 @@ module Doing
     ##
     ## @return     [Item] the next chronological item in the index
     ##
-    def next_item(item, options = {})
+    def next_item(item, options)
+      options ||= {}
       items = filter_items(Items.new, opt: options)
 
       idx = items.index(item)
@@ -1287,7 +1300,8 @@ module Doing
     ## @option opt :back [Date] backdate new item
     ## @option opt :new_item [String] content to use for new item
     ## @option opt :note [Array] note content for new item
-    def stop_start(target_tag, opt = {})
+    def stop_start(target_tag, opt)
+      opt ||= {}
       tag = target_tag.dup
       opt[:section] ||= @config['current_section']
       opt[:archive] ||= false
@@ -1354,7 +1368,8 @@ module Doing
     ##
     ## Rename doing file with date and start fresh one
     ##
-    def rotate(opt = {})
+    def rotate(opt)
+      opt ||= {}
       keep = opt[:keep] || 0
       tags = []
       tags.concat(opt[:tag].split(/ *, */).map { |t| t.sub(/^@/, '').strip }) if opt[:tag]
@@ -1369,7 +1384,7 @@ module Doing
       counter = 0
       new_content = Items.new
 
-      @content.each do |item|
+      section_items.each do |item|
         break if counter >= max
         if opt[:before]
           time_string = opt[:before]
@@ -1482,7 +1497,7 @@ module Doing
     ##
     ## @param      opt   [Hash] Additional Options
     ##
-    def list_section(opt = {}, items: Items.new)
+    def list_section(opt, items: Items.new)
       opt[:config_template] ||= 'default'
 
       tpl_cfg = @config.dig('templates', opt[:config_template])
@@ -1559,7 +1574,8 @@ module Doing
     ## @param      section      [String] The source section
     ## @param      options      [Hash] Options
     ##
-    def archive(section = @config['current_section'], options = {})
+    def archive(section = @config['current_section'], options)
+      options ||= {}
       count       = options[:keep] || 0
       destination = options[:destination] || 'Archive'
       tags        = options[:tags] || []
@@ -1589,7 +1605,8 @@ module Doing
     ## @param      output  [String] output format
     ## @param      opt     [Hash] Options
     ##
-    def today(times = true, output = nil, opt = {})
+    def today(times = true, output = nil, opt)
+      opt ||= {}
       opt[:totals] ||= false
       opt[:sort_tags] ||= false
 
@@ -1637,7 +1654,8 @@ module Doing
     ## @param      output   [String] Output format
     ## @param      opt      [Hash] Additional Options
     ##
-    def list_date(dates, section, times = nil, output = nil, opt = {})
+    def list_date(dates, section, times = nil, output = nil, opt)
+      opt ||= {}
       opt[:totals] ||= false
       opt[:sort_tags] ||= false
       section = guess_section(section)
@@ -1666,7 +1684,8 @@ module Doing
     ## @param      output   [String] Output format
     ## @param      opt      [Hash] Additional Options
     ##
-    def yesterday(section, times = nil, output = nil, opt = {})
+    def yesterday(section, times = nil, output = nil, opt)
+      opt ||= {}
       opt[:totals] ||= false
       opt[:sort_tags] ||= false
       section = guess_section(section)
@@ -1701,7 +1720,8 @@ module Doing
     ## @param      section  [String] The section to show from, default Currently
     ## @param      opt      [Hash] Additional Options
     ##
-    def recent(count = 10, section = nil, opt = {})
+    def recent(count = 10, section = nil, opt)
+      opt ||= {}
       times = opt[:t] || true
       opt[:totals] ||= false
       opt[:sort_tags] ||= false
@@ -1720,10 +1740,16 @@ module Doing
       section ||= @config['current_section']
       section = guess_section(section)
 
-      list_section({ section: section, wrap_width: cfg['wrap_width'], count: count,
-                     format: cfg['date_format'], template: cfg['template'],
-                     order: 'asc', times: times, totals: opt[:totals],
-                     sort_tags: opt[:sort_tags], tags_color: opt[:tags_color], config_template: 'recent' })
+      opt[:section] = section
+      opt[:wrap_width] = cfg['wrap_width']
+      opt[:count] = count
+      opt[:format] = cfg['date_format']
+      opt[:template] = cfg['template']
+      opt[:order] = 'asc'
+      opt[:times] = times
+      opt[:config_template] = 'recent'
+
+      list_section(opt)
     end
 
     ##
@@ -1776,13 +1802,14 @@ module Doing
     ## Does not repeat tags in a title, and only converts the first instance of an
     ## untagged keyword
     ##
-    ## @param      text  [String] The text to tag
+    ## @param      string  [String] The text to tag
     ##
-    def autotag(text)
-      return unless text
-      return text unless @auto_tag
+    def autotag(string)
+      return unless string
+      return string unless @auto_tag
 
-      original = text.dup
+      original = string.dup
+      text = string.dup
 
       current_tags = text.scan(/@\w+/).map { |t| t.sub(/^@/, '') }
       tagged = {
@@ -2091,7 +2118,8 @@ EOS
     ## @return     [String] formatted output based on opt[:output]
     ##             template trigger
     ##
-    def output(items, title, is_single, opt = {})
+    def output(items, title, is_single, opt)
+      opt ||= {}
       out = nil
 
       raise InvalidArgument, 'Unknown output format' unless opt[:output] =~ Plugins.plugin_regex(type: :export)
@@ -2135,7 +2163,8 @@ EOS
     ##                          section
     ## @param      opt          [Hash] Additional Options
     ##
-    def do_archive(section, destination, opt = {})
+    def do_archive(section, destination, opt)
+      opt ||= {}
       count = opt[:count] || 0
       tags  = opt[:tags] || []
       bool  = opt[:bool] || :and

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 2.1.6pre
+  version: 2.1.9
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -542,7 +542,6 @@ files:
 - lib/examples/plugins/wiki_export/templates/wiki.haml
 - lib/examples/plugins/wiki_export/templates/wiki_index.haml
 - lib/examples/plugins/wiki_export/wiki_export.rb
-- lib/helpers/fuzzyfilefinder
 - lib/helpers/fzf/.goreleaser.yml
 - lib/helpers/fzf/.rubocop.yml
 - lib/helpers/fzf/ADVANCED.md
@@ -666,9 +665,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.16
 signing_key: