doing 2.0.6.pre → 2.0.10

data/example_plugin.rb

@@ -26,7 +26,7 @@
 
 module Doing
   ##
-  ## @brief      Plugin class
+  ## Plugin class
   ##
   class SayExport
     include Doing::Util
@@ -65,7 +65,7 @@ module Doing
     ##
     ##      wwid.config['plugins'][PLUGIN_NAME][KEY]
     ##
-    ## @brief      Method to return plugin settings (required)
+    ## Method to return plugin settings (required)
     ##
     ## @return     Hash of settings for this plugin
     ##
@@ -87,7 +87,7 @@ module Doing
     ## included in settings. The method should return a
     ## string (not output it to the STDOUT).
     ##
-    ## @brief      Method to return template (optional)
+    ## Method to return template (optional)
     ##
     ## @param      trigger  The trigger passed to the
     ##                      template function. When this
@@ -96,7 +96,7 @@ module Doing
     ##                      used to determine which one is
     ##                      output.
     ##
-    ## @return     (String) template contents
+    ## @return     [String] template contents
     ##
     def self.template(trigger)
       return unless trigger =~ /^say(it)?$/
@@ -106,7 +106,7 @@ module Doing
 
 
     ##
-    ## @brief      Render data received from an output
+    ## Render data received from an output
     ##             command
     ##
     ## @param      wwid       The wwid object with config
@@ -118,7 +118,7 @@ module Doing
     ##                        flags passed to command
     ##                        (variables[:options])
     ##
-    ## @return     (String) Rendered output
+    ## @return     [String] Rendered output
     ##
     def self.render(wwid, items, variables: {})
       return if items.nil? || items.empty?

data/lib/doing/array.rb

@@ -2,7 +2,7 @@
 
 module Doing
   ##
-  ## @brief      Array helpers
+  ## Array helpers
   ##
   class ::Array end
 end

data/lib/doing/configuration.rb

@@ -2,7 +2,7 @@
 
 module Doing
   ##
-  ## @brief      Configuration object
+  ## Configuration object
   ##
   class Configuration
     attr_reader :settings
@@ -106,14 +106,15 @@ module Doing
 
     def value_for_key(keypath = '')
       cfg = @settings
+      real_path = []
       unless keypath =~ /^[.*]?$/
         paths = keypath.split(/[:.]/)
         while paths.length.positive? && !cfg.nil?
           path = paths.shift
           new_cfg = nil
           cfg.each do |key, val|
-            next unless key =~ /#{path.to_rx(2)}/
-
+            next unless key =~ path.to_rx(distance: 2)
+            real_path << key
             new_cfg = val
             break
           end
@@ -122,12 +123,13 @@ module Doing
             Doing.logger.error("Key match not found: #{path}")
             break
           end
-
           cfg = new_cfg
         end
       end
-
-      cfg
+      Doing.logger.debug('Config:', "translated key path #{keypath} to #{real_path.join('.')}")
+      result = {}
+      result[real_path[-1]] = cfg
+      result
     end
 
     # It takes the input, fills in the defaults where values do not exist.
@@ -148,9 +150,9 @@ module Doing
     end
 
     ##
-    ## @brief      Read user configuration and merge with defaults
+    ## Read user configuration and merge with defaults
     ##
-    ## @param      opt   (Hash) Additional Options
+    ## @param      opt   [Hash] Additional Options
     ##
     def configure(opt = {})
       @ignore_local = opt[:ignore_local] if opt[:ignore_local]
@@ -219,7 +221,7 @@ module Doing
     end
 
     ##
-    ## @brief      Read local configurations
+    ## Read local configurations
     ##
     ## @return     Hash of config options
     ##
@@ -251,7 +253,7 @@ module Doing
     end
 
     ##
-    ## @brief      Reads a configuration.
+    ## Reads a configuration.
     ##
     def read_config
       unless File.exist?(config_file)
@@ -279,9 +281,9 @@ module Doing
     end
 
     ##
-    ## @brief      Finds a project-specific configuration file
+    ## Finds a project-specific configuration file
     ##
-    ## @return     (String) A file path
+    ## @return     [String] A file path
     ##
     def find_local_config
       dir = Dir.pwd

data/lib/doing/errors.rb

@@ -27,7 +27,7 @@ module Doing
     end
 
     class WrongCommand < ::StandardError
-      def initialize(msg = 'wrong command', topic = 'Error:')
+      def initialize(msg = 'wrong command', topic: 'Error:')
         Doing.logger.warn(topic, msg)
 
         super(msg)

data/lib/doing/hash.rb

@@ -4,7 +4,7 @@ module Doing
   # Hash helpers
   class ::Hash
     ##
-    ## @brief      Freeze all values in a hash
+    ## Freeze all values in a hash
     ##
     ## @return     { description_of_the_return_value }
     ##

data/lib/doing/item.rb

@@ -2,11 +2,24 @@
 
 module Doing
   ##
-  ## @brief      This class describes a single WWID item
+  ## This class describes a single WWID item
   ##
   class Item
+    include Amatch
+
     attr_accessor :date, :title, :section, :note
 
+    ##
+    ## Initialize an item with date, title, section, and
+    ## optional note
+    ##
+    ## @param      date     [Time] The item's start date
+    ## @param      title    [String] The title
+    ## @param      section  [String] The section to which
+    ##                      the item belongs
+    ## @param      note     [Array or String] The note
+    ##                      (optional)
+    ##
     def initialize(date, title, section, note = nil)
       @date = date.is_a?(Time) ? date : Time.parse(date)
       @title = title
@@ -18,14 +31,36 @@ module Doing
     #   @date = new_date.is_a?(Time) ? new_date : Time.parse(new_date)
     # end
 
+    ##
+    ## Get the difference between the item's start date and
+    ## the value of its @done tag (if present)
+    ##
+    ## @return     Interval in seconds
+    ##
     def interval
       @interval ||= calc_interval
     end
 
+    ##
+    ## Get the value of the item's @done tag
+    ##
+    ## @return     [Time] @done value
+    ##
     def end_date
       @end_date ||= Time.parse(Regexp.last_match(1)) if @title =~ /@done\((\d{4}-\d\d-\d\d \d\d:\d\d.*?)\)/
     end
 
+    def hash_id
+      (@date.to_s + @title + @section + @note.join(' ')).hash
+    end
+
+    ##
+    ## Test for equality between items
+    ##
+    ## @param      other [Item] The other item
+    ##
+    ## @return     [Boolean] is equal?
+    ##
     def equal?(other)
       return false if @title.strip != other.title.strip
 
@@ -36,10 +71,25 @@ module Doing
       true
     end
 
+    ##
+    ## Test if two items occur at the same time (same start date and equal duration)
+    ##
+    ## @param      item_b  [Item] The item to compare
+    ##
+    ## @return     [Boolean] is equal?
+    ##
     def same_time?(item_b)
       date == item_b.date ? interval == item_b.interval : false
     end
 
+    ##
+    ## Test if the interval between start date and @done
+    ## value overlaps with another item's
+    ##
+    ## @param      item_b  [Item] The item to compare
+    ##
+    ## @return     [Boolean] overlaps?
+    ##
     def overlapping_time?(item_b)
       return true if same_time?(item_b)
 
@@ -52,43 +102,83 @@ module Doing
       (start_a >= start_b && start_a <= end_b) || (end_a >= start_b && end_a <= end_b) || (start_a < start_b && end_a > end_b)
     end
 
+    ##
+    ## Add (or remove) tags from the title of the item
+    ##
+    ## @param      tag        [String] The tag to add
+    ## @param      value      [String] A value to include as @tag(value)
+    ## @param      remove     [Boolean] if true remove instead of adding
+    ## @param      rename_to  [String] if not nil, rename target tag to this tag name
+    ## @param      regex      [Boolean] treat target tag string as regex pattern
+    ##
     def tag(tag, value: nil, remove: false, rename_to: nil, regex: false)
       @title.tag!(tag, value: value, remove: remove, rename_to: rename_to, regex: regex).strip!
     end
 
+    ##
+    ## Get a list of tags on the item
+    ##
+    ## @return     [Array] array of tags (no values)
+    ##
     def tags
       @title.scan(/(?<= |\A)@([^\s(]+)/).map {|tag| tag[0]}.sort.uniq
     end
 
-    def tags?(tags, bool = :and)
+    ##
+    ## Test if item contains tag(s)
+    ##
+    ## @param      tags    (Array or String) The tags to test. Can be an array or a comma-separated string.
+    ## @param      bool    (Symbol) The boolean to use for multiple tags (:and, :or, :not)
+    ## @param      negate  [Boolean] negate the result?
+    ##
+    ## @return     [Boolean] true if tag/bool combination passes
+    ##
+    def tags?(tags, bool = :and, negate: false)
       tags = split_tags(tags)
       bool = bool.normalize_bool
 
-      case bool
-      when :and
-        all_tags?(tags)
-      when :not
-        no_tags?(tags)
-      else
-        any_tags?(tags)
-      end
-    end
-
-    def search(search)
+      matches = case bool
+                when :and
+                  all_tags?(tags)
+                when :not
+                  no_tags?(tags)
+                else
+                  any_tags?(tags)
+                end
+      negate ? !matches : matches
+    end
+
+    ##
+    ## Test if item matches search string
+    ##
+    ## @param      search     [String] The search string
+    ## @param      negate     [Boolean] negate results
+    ## @param      case_type  (Symbol) The case-sensitivity
+    ##                        type (:sensitive,
+    ##                        :ignore, :smart)
+    ##
+    ## @return     [Boolean] matches search criteria
+    ##
+    def search(search, distance: 3, negate: false, case_type: :smart, fuzzy: false)
       text = @title + @note.to_s
-      pattern = case search.strip
-                when %r{^/.*?/$}
-                  search.sub(%r{/(.*?)/}, '\1')
-                when /^'/
-                  case_sensitive = true
-                  search.sub(/^'(.*?)'?$/, '\1')
+
+      if search.is_rx? || !fuzzy
+        matches = text =~ search.to_rx(distance: distance, case_type: case_type)
+      else
+        distance = 0.25 if distance > 1
+        score = if (case_type == :smart && search !~ /[A-Z]/) || case_type == :ignore
+                  text.downcase.pair_distance_similar(search.downcase)
                 else
-                  case_sensitive = true if search =~ /[A-Z]/
-                  search.split('').join('.{0,3}')
+                  score = text.pair_distance_similar(search)
                 end
-      rx = Regexp.new(pattern, !case_sensitive)
 
-      text =~ rx
+        if score >= distance
+          matches = true
+          Doing.logger.debug('Fuzzy Match:', %(#{@title}, "#{search}" #{score}))
+        end
+      end
+
+      negate ? !matches : matches
     end
 
     def should_finish?

data/lib/doing/log_adapter.rb

@@ -2,7 +2,7 @@
 
 module Doing
   ##
-  ## @brief      Log adapter
+  ## Log adapter
   ##
   class LogAdapter
     attr_writer :logdev, :max_length
@@ -32,7 +32,7 @@ module Doing
     ].freeze
 
     #
-    # @brief      Create a new instance of a log writer
+    # Create a new instance of a log writer
     #
     # @param      level   (optional, symbol) the log level
     #
@@ -47,29 +47,25 @@ module Doing
     end
 
     #
-    # @brief      Set the log level on the writer
+    # Set the log level on the writer
     #
     # @param      level  (symbol) the log level
     #
     # @return     nothing
     #
-    def log_level=(level)
-      level ||= 'info'
+    def log_level=(level = 'info')
       level = level.to_s
-      if level.is_a?(String) && level =~ /^([ewid]\w+|[0123])$/
-        level = case level
-                when /^[e0]/
-                  :error
-                when /^[w1]/
-                  :warn
-                when /^[i2]/
-                  :info
-                when /^[d3]/
-                  :debug
-                end
-      else
-        level = level.downcase.to_sym
-      end
+
+      level = case level
+              when /^[e0]/i
+                :error
+              when /^[w1]/i
+                :warn
+              when /^[d3]/i
+                :debug
+              else
+                :info
+              end
 
       @level = level
     end
@@ -84,46 +80,6 @@ module Doing
       # log_now :debug, 'Doing Version:', Doing::VERSION
     end
 
-    def format_counter(key, data)
-      case key
-      when :added_tags
-        ['Tagged:', data[:message] || 'added %tags to %count %items']
-      when :removed_tags
-        ['Untagged:', data[:message] || 'removed %tags from %count %items']
-      when :added
-        ['Added:', data[:message] || 'added %count new %items']
-      when :updated
-        ['Updated:', data[:message] || 'updated %count %items']
-      when :deleted
-        ['Deleted:', data[:message] || 'deleted %count %items']
-      when :moved
-        ['Moved:', data[:message] || 'moved %count %items']
-      when :completed
-        ['Completed:', data[:message] || 'completed %count %items']
-      when :archived
-        ['Archived:',  data[:message] || 'archived %count %items']
-      when :completed_archived
-        ['Archived:',  data[:message] || 'completed and archived %count %items']
-      when :skipped
-        ['Skipped:', data[:message] || '%count %items were unchanged']
-      end
-    end
-
-    def total_counters
-      @counters.each do |key, data|
-        next if data[:count].zero?
-
-        count = data[:count]
-        tags = data[:tag] ? data[:tag].uniq.map { |t| "@#{t}".cyan }.join(', ') : 'tags'
-        topic, m = format_counter(key, data)
-        message = m.dup
-        message.sub!(/%count/, count.to_s)
-        message.sub!(/%items/, count == 1 ? 'item' : 'items')
-        message.sub!(/%tags/, tags)
-        write(data[:level], topic, message)
-      end
-    end
-
     def count(key, level: :info, count: 1, tag: nil, message: nil)
       raise ArgumentError, 'invalid counter key' unless COUNT_KEYS.include?(key)
 
@@ -134,7 +90,7 @@ module Doing
     end
 
     #
-    # @brief      Print a debug message
+    # Print a debug message
     #
     # @param      topic    the topic of the message
     # @param      message  the message detail
@@ -146,7 +102,7 @@ module Doing
     end
 
     #
-    # @brief      Print a message
+    # Print a message
     #
     # @param      topic    the topic of the message, e.g.
     #                      "Configuration file",
@@ -160,7 +116,7 @@ module Doing
     end
 
     #
-    # @brief      Print a message
+    # Print a message
     #
     # @param      topic    the topic of the message, e.g.
     #                      "Configuration file",
@@ -174,7 +130,7 @@ module Doing
     end
 
     #
-    # @brief      Print an error message
+    # Print an error message
     #
     # @param      topic    the topic of the message, e.g.
     #                      "Configuration file",
@@ -188,7 +144,7 @@ module Doing
     end
 
     #
-    # @brief      Print an error message and immediately
+    # Print an error message and immediately
     #             abort the process
     #
     # @param      topic    the topic of the message, e.g.
@@ -204,33 +160,8 @@ module Doing
       abort
     end
 
-    # Internal: Build a topic method
     #
-    # @param      topic    the topic of the message, e.g.
-    #                      "Configuration file",
-    #                      "Deprecation", etc.
-    # @param      message  the message detail
-    #
-    # @return     the formatted message
-    #
-    def message(topic, message = nil)
-      raise ArgumentError, 'block or message, not both' if block_given? && message
-
-      message = yield if block_given?
-      message = message.to_s.gsub(/\s+/, ' ')
-
-      return topic.ljust(TOPIC_WIDTH) if topic && message.strip.empty?
-
-      topic = formatted_topic(topic, colon: block_given?)
-      message.truncmiddle!(@max_length - TOPIC_WIDTH - 5)
-      out = topic + message
-      out.truncate!(@max_length) if @max_length.positive?
-      messages << out
-      out
-    end
-
-    #
-    # @brief      Format the topic
+    # Format the topic
     #
     # @param      topic  the topic of the message, e.g.
     #                    "Configuration file",
@@ -250,39 +181,34 @@ module Doing
     end
 
     #
-    # @brief      Check if the message should be written
-    #             given the log level.
-    #
-    # @param      level_of_message  the Symbol level of
-    #                               message, one of :debug,
-    #                               :info, :warn, :error
-    #
-    # @return     whether the message should be written.
-    #
-    def write_message?(level_of_message)
-      LOG_LEVELS.fetch(@level) <= LOG_LEVELS.fetch(level_of_message)
-    end
-
-    #
-    # @brief      Log a message.
+    # Log a message.
     #
-    # @param      level_of_message  the Symbol level of
-    #                               message, one of :debug,
-    #                               :info, :warn, :error
-    # @param      topic             the String topic or full
-    #                               message
-    # @param      message           the String message
-    #                               (optional)
+    # @param      level_of_message  [Symbol] the Symbol
+    #                               level of message, one of
+    #                               :debug, :info, :warn,
+    #                               :error
+    # @param      topic             [String] the String
+    #                               topic or full message
+    # @param      message           [String] the String
+    #                               message (optional)
     # @param      block             a block containing the
     #                               message (optional)
     #
-    # @return     false if the message was not written
+    # @return     [Boolean] false if the message was not written
     #
     def write(level_of_message, topic, message = nil, &block)
       @results << { level: level_of_message, message: message(topic, message, &block) }
       true
     end
 
+    ##
+    ## Log to console immediately instead of writing messages on exit
+    ##
+    ## @param      level    [Symbol] The level
+    ## @param      topic    [String] The topic or full message
+    ## @param      message  [String] The message (optional)
+    ## @param      block    a block containing the message (optional)
+    ##
     def log_now(level, topic, message = nil, &block)
       return false unless write_message?(level)
 
@@ -293,6 +219,11 @@ module Doing
       end
     end
 
+    ##
+    ## Output registers based on log level
+    ##
+    ## @return     nothing
+    ##
     def output_results
       total_counters
 
@@ -309,6 +240,85 @@ module Doing
 
     private
 
+    def format_counter(key, data)
+      case key
+      when :added_tags
+        ['Tagged:', data[:message] || 'added %tags to %count %items']
+      when :removed_tags
+        ['Untagged:', data[:message] || 'removed %tags from %count %items']
+      when :added
+        ['Added:', data[:message] || 'added %count new %items']
+      when :updated
+        ['Updated:', data[:message] || 'updated %count %items']
+      when :deleted
+        ['Deleted:', data[:message] || 'deleted %count %items']
+      when :moved
+        ['Moved:', data[:message] || 'moved %count %items']
+      when :completed
+        ['Completed:', data[:message] || 'completed %count %items']
+      when :archived
+        ['Archived:',  data[:message] || 'archived %count %items']
+      when :completed_archived
+        ['Archived:',  data[:message] || 'completed and archived %count %items']
+      when :skipped
+        ['Skipped:', data[:message] || '%count %items were unchanged']
+      end
+    end
+
+    def total_counters
+      @counters.each do |key, data|
+        next if data[:count].zero?
+
+        count = data[:count]
+        tags = data[:tag] ? data[:tag].uniq.map { |t| "@#{t}".cyan }.join(', ') : 'tags'
+        topic, m = format_counter(key, data)
+        message = m.dup
+        message.sub!(/%count/, count.to_s)
+        message.sub!(/%items/, count == 1 ? 'item' : 'items')
+        message.sub!(/%tags/, tags)
+        write(data[:level], topic, message)
+      end
+    end
+
+    #
+    # Check if the message should be written
+    #             given the log level.
+    #
+    # @param      level_of_message  the Symbol level of
+    #                               message, one of :debug,
+    #                               :info, :warn, :error
+    #
+    # @return     whether the message should be written.
+    #
+    def write_message?(level_of_message)
+      LOG_LEVELS.fetch(@level) <= LOG_LEVELS.fetch(level_of_message)
+    end
+
+    # Internal: Build a topic method
+    #
+    # @param      topic    the topic of the message, e.g.
+    #                      "Configuration file",
+    #                      "Deprecation", etc.
+    # @param      message  the message detail
+    #
+    # @return     the formatted message
+    #
+    def message(topic, message = nil)
+      raise ArgumentError, 'block or message, not both' if block_given? && message
+
+      message = yield if block_given?
+      message = message.to_s.gsub(/\s+/, ' ')
+
+      return topic.ljust(TOPIC_WIDTH) if topic && message.strip.empty?
+
+      topic = formatted_topic(topic, colon: block_given?)
+      message.truncmiddle!(@max_length - TOPIC_WIDTH - 5)
+      out = topic + message
+      out.truncate!(@max_length) if @max_length.positive?
+      messages << out
+      out
+    end
+
     def color_message(level, topic, message = nil, &block)
       colors = Doing::Color
       message = message(topic, message, &block)