doing 2.1.23 → 2.1.27

data/lib/doing/chronify/chronify.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'array'
+require_relative 'numeric'
+require_relative 'string'

data/lib/doing/colors.rb

@@ -6,61 +6,67 @@ module Doing
   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],
-      [:purple, 35],
-      [:cyan, 36],
-      [:white, 37],
-      [:bgblack, 40],
-      [:bgred, 41],
-      [:bggreen, 42],
-      [:bgyellow, 43],
-      [:bgblue, 44],
-      [:bgmagenta, 45],
-      [:bgpurple, 45],
-      [:bgcyan, 46],
-      [:bgwhite, 47],
-      [:boldblack, 90], # High intensity, aixterm (works in OS X)
-      [:boldred, 91],
-      [:boldgreen, 92],
-      [:boldyellow, 93],
-      [:boldblue, 94],
-      [:boldmagenta, 95],
-      [:boldpurple, 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],
-      [:boldbgpurple, 105],
-      [:boldbgcyan, 106],
-      [:boldbgwhite, 107],
-      [:softpurple, '0;35;40'],
-      [:hotpants, '7;34;40'],
+      [: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
+      [:strike,              9], # not widely implemented
+      [:black,              30],
+      [:red,                31],
+      [:green,              32],
+      [:yellow,             33],
+      [:blue,               34],
+      [:magenta,            35],
+      [:purple,             35],
+      [:cyan,               36],
+      [:white,              37],
+      [:bgblack,            40],
+      [:bgred,              41],
+      [:bggreen,            42],
+      [:bgyellow,           43],
+      [:bgblue,             44],
+      [:bgmagenta,          45],
+      [:bgpurple,           45],
+      [:bgcyan,             46],
+      [:bgwhite,            47],
+      [:boldblack,          90],
+      [:boldred,            91],
+      [:boldgreen,          92],
+      [:boldyellow,         93],
+      [:boldblue,           94],
+      [:boldmagenta,        95],
+      [:boldpurple,         95],
+      [:boldcyan,           96],
+      [:boldwhite,          97],
+      [:boldbgblack,       100],
+      [:boldbgred,         101],
+      [:boldbggreen,       102],
+      [:boldbgyellow,      103],
+      [:boldbgblue,        104],
+      [:boldbgmagenta,     105],
+      [:boldbgpurple,      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']
+      [:flamingo,    '7;31;47'],
+      [:yeller,      '1;37;43'],
+      [:whiteboard,  '1;30;47'],
+      [:chalkboard,  '1;37;40'],
+      [:led,         '0;32;40'],
+      [:redacted,    '0;30;40'],
+      [:alert,       '1;31;43'],
+      [:error,       '1;37;41'],
+      [:default,        '0;39']
     ].map(&:freeze).freeze
 
     ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
@@ -78,6 +84,40 @@ module Doing
       end
     end
 
+    # Template coloring
+    class ::String
+      ##
+      ## Extract the longest valid %color name from a string.
+      ##
+      ## Allows %colors to bleed into other text and still
+      ## be recognized, e.g. %greensomething still finds
+      ## %green.
+      ##
+      ## @return     [String] a valid color name
+      ##
+      def validate_color
+        valid_color = nil
+        compiled = ''
+        normalize_color.split('').each do |char|
+          compiled += char
+          valid_color = compiled if Color.attributes.include?(compiled.to_sym)
+        end
+
+        valid_color
+      end
+
+      ##
+      ## Normalize a color name, removing underscores,
+      ## replacing "bright" with "bold", and converting
+      ## bgbold to boldbg
+      ##
+      ## @return     [String] Normalized color name
+      ##
+      def normalize_color
+        gsub(/_/, '').sub(/bright/i, 'bold').sub(/bgbold/, 'boldbg')
+      end
+    end
+
     class << self
       # Returns true, if the coloring function of this module
       # is switched on, false otherwise.
@@ -113,6 +153,27 @@ module Doing
           result
         end
       EOT
+
+      # Accept brightwhite in addition to boldwhite
+      if c =~ /bold/
+        eval <<-EOT
+          def #{c.to_s.sub(/bold/, 'bright')}(string = nil)
+            result = ''
+            result << "\e[#{v}m" if Doing::Color.coloring?
+            if block_given?
+              result << yield
+            elsif string.respond_to?(:to_str)
+              result << string.to_str
+            elsif respond_to?(:to_str)
+              result << to_str
+            else
+              return result #only switch on
+            end
+            result << "\e[0m" if Doing::Color.coloring?
+            result
+          end
+        EOT
+      end
     end
 
     # Regular expression that is used to scan for ANSI-sequences while

data/lib/doing/completion/fish_completion.rb

@@ -123,8 +123,9 @@ module Doing
           complete -f -c doing -n '__fish_doing_using_command view' -a '(__fish_doing_complete_views)'
           complete -f -c doing -n '__fish_doing_using_command template' -a '(__fish_doing_complete_templates)'
           complete -f -c doing -s t -l type -x -n '__fish_doing_using_command import' -a '(__fish_doing_import_plugins)'
+          complete -f -c doing -n '__fish_doing_using_command help' -a '(__fish_doing_subcommands)'
 
-          complete -xc doing -n '__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from (doing help -c)' -a "(doing help -c)"
+          # complete -xc doing -n '__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from (doing help -c)' -a "(doing help -c)"
 
           function __fish_doing_complete_args
             for cmd in (doing commands_accepting -c $argv[1])

data/lib/doing/configuration.rb

@@ -29,6 +29,7 @@ module Doing
         'plugin_path' => File.join(Util.user_home, '.config', 'doing', 'plugins'),
         'command_path' => File.join(Util.user_home, '.config', 'doing', 'commands')
       },
+      'disabled_commands' => [],
       'doing_file' => '~/.local/share/doing/what_was_i_doing.md',
       'doing_file_sort' => 'desc',
       'backup_dir' => '~/.local/share/doing/doing_backup',
@@ -45,8 +46,7 @@ module Doing
       'templates' => {
         'default' => {
           'date_format' => '%Y-%m-%d %H:%M',
-          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
-            %yellow%interval%boldred%duration%dark%white%80_14┃ note',
+          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %boldmagenta[%boldwhite%-10section%boldmagenta]%reset %yellow%interval%boldred%duration%white%80_14┃ note',
           'wrap_width' => 0,
           'order' => 'asc'
         },
@@ -63,8 +63,7 @@ module Doing
         },
         'recent' => {
           'date_format' => '%_I:%M%P',
-          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
-            %yellow%interval%boldred%duration%dark%white%80_14┃ note',
+          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %boldmagenta[%boldwhite%-10section%boldmagenta]%reset  %yellow%interval%boldred%duration%white%80_14┃ note',
           'wrap_width' => 88,
           'count' => 10,
           'order' => 'asc'
@@ -180,6 +179,10 @@ module Doing
       end
     end
 
+    def fetch(*path, default)
+      @settings.dig(*path) || default
+    end
+
     ##
     ## Resolve a fuzzy-matched key path
     ##
@@ -314,7 +317,7 @@ module Doing
 
       @ignore_local = opt[:ignore_local] if opt[:ignore_local]
 
-      config = read_config.dup
+      config = read_config.clone
 
       plugin_config = Util.deep_merge_hashes(DEFAULTS['plugins'], config['plugins'] || {})
 
@@ -322,7 +325,7 @@ module Doing
 
       Plugins.plugins.each do |_type, plugins|
         plugins.each do |title, plugin|
-          plugin_config[title] = plugin[:config] if plugin[:config] && !plugin[:config].empty?
+          plugin_config[title] = plugin[:config] if plugin[:config].good?
           config['export_templates'][title] ||= nil if plugin[:templates] && !plugin[:templates].empty?
         end
       end

data/lib/doing/good.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Doing
+  # Object helpers
+  class ::Object
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      !nil? && !empty?
+    end
+  end
+
+  class ::String
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      !strip.empty?
+    end
+  end
+
+  class ::Array
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      !nil? && !empty?
+    end
+  end
+
+  class ::FalseClass
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      false
+    end
+
+    def normalize_tag_sort
+      :time
+    end
+  end
+
+  class ::TrueClass
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      true
+    end
+
+    def normalize_tag_sort
+      :name
+    end
+  end
+end

data/lib/doing/hash.rb

@@ -34,6 +34,10 @@ module Doing
       replace deep_thaw
     end
 
+    def clone
+      Marshal.load(Marshal.dump(self))
+    end
+
     # Turn all keys into string
     #
     # Return a copy of the hash where all its keys are strings

data/lib/doing/help_monkey_patch.rb

@@ -4,15 +4,15 @@ module GLI
   module Commands
     # Help Command Monkeypatch for paginated output
     class Help < Command
-      def show_help(global_options,options,arguments,out,error)
+      def show_help(global_options, options, arguments, out, error)
         Doing::Pager.paginate = true
 
-        command_finder = HelpModules::CommandFinder.new(@app,arguments,error)
+        command_finder = HelpModules::CommandFinder.new(@app, arguments, error)
         if options[:c]
-          help_output = HelpModules::HelpCompletionFormat.new(@app,command_finder,arguments).format
+          help_output = HelpModules::HelpCompletionFormat.new(@app, command_finder, arguments).format
           out.puts help_output unless help_output.nil?
         elsif arguments.empty? || options[:c]
-          Doing::Pager.page HelpModules::GlobalHelpFormat.new(@app,@sorter,@text_wrapping_class).format
+          Doing::Pager.page HelpModules::GlobalHelpFormat.new(@app, @sorter, @text_wrapping_class).format
         else
           name = arguments.shift
           command = command_finder.find_command(name)
@@ -22,7 +22,8 @@ module GLI
               @app,
               @sorter,
               @synopsis_formatter_class,
-              @text_wrapping_class).format
+              @text_wrapping_class
+            ).format
           end
         end
       end

data/lib/doing/hooks.rb

@@ -10,8 +10,8 @@ module Doing
       post_local_config: [],  # wwid
       post_read: [],          # wwid
       pre_entry_add: [],      # wwid, new_entry
-      post_entry_added: [],   # wwid, new_entry.dup
-      post_entry_updated: [], # wwid, entry
+      post_entry_added: [],   # wwid, new_entry
+      post_entry_updated: [], # wwid, entry, old_entry
       post_entry_removed: [], # wwid, entry.dup
       pre_export: [],         # wwid, format, entries
       pre_write: [],          # wwid, file
@@ -57,7 +57,7 @@ module Doing
 
     def self.trigger(event, *args)
       hooks = @registry[event]
-      return if hooks.nil? || hooks.empty?
+      return unless hooks.good?
 
       # sort and call hooks according to priority and load order
       hooks.sort_by { |h| @hook_priority[h] }.each do |hook|

data/lib/doing/item.rb

@@ -177,7 +177,7 @@ module Doing
       tags.each do |tag|
         bool = remove ? :and : :not
         if tags?(tag, bool)
-          @title.tag!(tag, **options).strip!
+          @title = @title.tag(tag, **options).strip
           remove ? removed.push(tag) : added.push(tag)
         end
       end
@@ -278,7 +278,7 @@ module Doing
       case_type ||= prefs.fetch('case', 'smart').normalize_case
       new_note = Note.new
 
-      if search.is_rx? || matching == :fuzzy
+      if search.rx? || matching == :fuzzy
         rx = search.to_rx(distance: distance, case_type: case_type)
         new_title = @title.gsub(rx) { |m| yellow(m) }
         new_note.add(@note.to_s.gsub(rx) { |m| yellow(m) })
@@ -316,7 +316,7 @@ module Doing
       distance ||= prefs.fetch('distance', 3).to_i
       case_type ||= prefs.fetch('case', 'smart').normalize_case
 
-      if search.is_rx? || matching == :fuzzy
+      if search.rx? || matching == :fuzzy
         matches = @title + @note.to_s =~ search.to_rx(distance: distance, case_type: case_type)
       else
         query = search.strip.to_phrase_query
@@ -335,7 +335,7 @@ module Doing
       #   matches = text =~ search.to_rx(distance: distance, case_type: case_type)
       # end
 
-      # if search.is_rx? || !fuzzy
+      # if search.rx? || !fuzzy
       #   matches = text =~ search.to_rx(distance: distance, case_type: case_type)
       # else
       #   distance = 0.25 if distance > 1
@@ -393,13 +393,13 @@ module Doing
 
       Doing.logger.count(@section == 'Archive' ? :archived : :moved) if log
       Doing.logger.debug("#{@section == 'Archive' ? 'Archived' : 'Moved'}:",
-                         "#{@title.truncate(60)} from #{from} to #{@section}")
+                         "#{@title.trunc(60)} from #{from} to #{@section}")
       self
     end
 
     # outputs item in Doing file format, including leading tab
     def to_s
-      "\t- #{@date.strftime('%Y-%m-%d %H:%M')} | #{@title}#{@note.empty? ? '' : "\n#{@note}"}"
+      "\t- #{@date.strftime('%Y-%m-%d %H:%M')} | #{@title}#{@note.good? ? "\n#{@note}" : ''}"
     end
 
     ##
@@ -429,6 +429,10 @@ module Doing
       %(<Doing::Item @date=#{@date}>)
     end
 
+    def clone
+      Marshal.load(Marshal.dump(self))
+    end
+
     private
 
     def should?(key)
@@ -457,7 +461,7 @@ module Doing
     end
 
     def all_searches?(searches, case_type: :smart)
-      return true if searches.nil? || searches.empty?
+      return true unless searches.good?
 
       text = @title + @note.to_s
       searches.each do |s|
@@ -468,7 +472,7 @@ module Doing
     end
 
     def no_searches?(searches, case_type: :smart)
-      return true if searches.nil? || searches.empty?
+      return true unless searches.good?
 
       text = @title + @note.to_s
       searches.each do |s|
@@ -479,7 +483,7 @@ module Doing
     end
 
     def any_searches?(searches, case_type: :smart)
-      return true if searches.nil? || searches.empty?
+      return true unless searches.good?
 
       text = @title + @note.to_s
       searches.each do |s|
@@ -490,7 +494,7 @@ module Doing
     end
 
     def all_tags?(tags)
-      return true if tags.nil? || tags.empty?
+      return true unless tags.good?
 
       tags.each do |tag|
         return false unless @title =~ /@#{tag.wildcard_to_rx}(?= |\(|\Z)/i
@@ -499,7 +503,7 @@ module Doing
     end
 
     def no_tags?(tags)
-      return true if tags.nil? || tags.empty?
+      return true unless tags.good?
 
       tags.each do |tag|
         return false if @title =~ /@#{tag.wildcard_to_rx}(?= |\(|\Z)/i
@@ -508,7 +512,7 @@ module Doing
     end
 
     def any_tags?(tags)
-      return true if tags.nil? || tags.empty?
+      return true unless tags.good?
 
       tags.each do |tag|
         return true if @title =~ /@#{tag.wildcard_to_rx}(?= |\(|\Z)/i
@@ -537,7 +541,7 @@ module Doing
     end
 
     def any_values?(queries)
-      return true if queries.nil? || queries.empty?
+      return true unless queries.good?
 
       queries.each do |q|
         parts = split_value_query(q)
@@ -547,7 +551,7 @@ module Doing
     end
 
     def all_values?(queries)
-      return true if queries.nil? || queries.empty?
+      return true unless queries.good?
 
       queries.each do |q|
         parts = split_value_query(q)
@@ -557,7 +561,7 @@ module Doing
     end
 
     def no_values?(queries)
-      return true if queries.nil? || queries.empty?
+      return true unless queries.good?
 
       queries.each do |q|
         parts = split_value_query(q)

data/lib/doing/items.rb

@@ -102,7 +102,7 @@ module Doing
 
       self[s_idx] = new_item
       Doing.logger.count(:updated)
-      Doing.logger.info('Entry updated:', self[s_idx].title.truncate(60))
+      Doing.logger.info('Entry updated:', self[s_idx].title.trunc(60))
       new_item
     end
 
@@ -132,7 +132,7 @@ module Doing
       @sections.each do |section|
         out.push(section.original)
         items = in_section(section.title).sort_by { |i| i.date }
-        items.reverse! if Doing.config.settings['doing_file_sort'].normalize_order == 'desc'
+        items.reverse! if Doing.config.settings['doing_file_sort'].normalize_order == :desc
         items.each { |item| out.push(item.to_s)}
       end
 

data/lib/doing/log_adapter.rb

@@ -277,17 +277,50 @@ module Doing
 
     def log_benchmarks
       if ENV['DOING_BENCHMARK']
+
         output = []
-        @benchmarks.each do |k, timers|
+        beginning = @benchmarks[:total][:start]
+        ending = @benchmarks[:total][:finish]
+        total = ending - beginning
+        factor = TTY::Screen.columns / total
+
+        cols = Array.new(TTY::Screen.columns)
+
+        colors = %w[bgred bggreen bgyellow bgblue bgmagenta bgcyan bgwhite boldbgred boldbggreen boldbgyellow boldbgblue boldbgwhite]
+        idx = 0
+        # @benchmarks.delete(:total)
+
+        @benchmarks.sort_by { |_, timers| [timers[:start], timers[:finish]] }.each do |k, timers|
           if timers[:finish] && timers[:start]
-            output << "#{k}: #{timers[:finish] - timers[:start]}"
+            color = colors[idx % colors.count]
+            fg = if idx < 7
+                   Color.boldblack
+                 else
+                   Color.boldwhite
+                 end
+            color = Color.send(color) + fg
+
+            start = ((timers[:start] - beginning) * factor).floor
+            finish = ((timers[:finish] - beginning) * factor).ceil
+
+            cols.fill("#{color}-", start..finish)
+            cols[start] = "#{color}|"
+            cols[finish] = "#{color}|"
+            output << "#{color}#{k}#{Color.default}: #{timers[:finish] - timers[:start]}"
           else
             output << "#{k}: error"
           end
+
+          idx += 1
         end
+
         output.each do |msg|
           $stdout.puts color_message(:debug, 'Benchmark:', msg)
         end
+
+        $stdout.puts color_message(:debug, 'Benchmark:', "Total: #{total}")
+
+        $stdout.puts cols[0..TTY::Screen.columns-1].join + Color.reset
       end
     end