doing 2.0.7.pre → 2.0.11

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,20 @@
 
 module Doing
   ##
-  ## @brief      Array helpers
+  ## Array helpers
   ##
-  class ::Array end
+  class ::Array
+    def to_tags
+      map { |t| t.sub(/^@?/, '@') }
+    end
+
+    def highlight_tags(color = 'cyan')
+      tag_color = Doing::Color.send(color)
+      to_tags.map { |t| "#{tag_color}#{t}" }
+    end
+
+    def log_tags
+      highlight_tags.join(', ')
+    end
+  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?