doing 2.0.6.pre → 2.0.10

data/lib/doing/note.rb

@@ -2,7 +2,7 @@
 
 module Doing
   ##
-  ## @brief      This class describes an item note.
+  ## This class describes an item note.
   ##
   class Note < Array
     def initialize(note = [])

data/lib/doing/plugin_manager.rb

@@ -107,7 +107,7 @@ module Doing
       end
 
       ##
-      ## @brief      List available plugins to stdout
+      ## List available plugins to stdout
       ##
       ## @param      options  { type, separator }
       ##
@@ -129,11 +129,11 @@ module Doing
       end
 
       ##
-      ## @brief      Return array of available plugin names
+      ## Return array of available plugin names
       ##
       ## @param      type  Plugin type (:import, :export)
       ##
-      ## @returns    [Array<String>] plugin names
+      ## @return     [Array<String>] plugin names
       ##
       def available_plugins(type: :export)
         type = valid_type(type)
@@ -141,7 +141,7 @@ module Doing
       end
 
       ##
-      ## @brief      Return string version of plugin names
+      ## Return string version of plugin names
       ##
       ## @param      type       Plugin type (:import, :export)
       ## @param      separator  The separator to join names with
@@ -154,7 +154,7 @@ module Doing
       end
 
       ##
-      ## @brief      Return a regular expression of all
+      ## Return a regular expression of all
       ##             plugin triggers for type
       ##
       ## @param      type  The type :import or :export

data/lib/doing/plugins/export/csv_export.rb

@@ -6,7 +6,7 @@
 # url: https://brettterpstra.com
 module Doing
   ##
-  ## @brief      CSV Export
+  ## CSV Export
   ##
   class CSVExport
     include Doing::Util

data/lib/doing/plugins/export/template_export.rb

@@ -94,7 +94,7 @@ module Doing
         end
 
         if note.empty?
-          output.gsub!(/%([io]d|(\^.)?(([ _t]|[^a-z0-9])?\d+)?(.[ _t]?)?)?note/, '')
+          output.gsub!(/%(chomp|[io]d|(\^.)?(([ _t]|[^a-z0-9])?\d+)?(.[ _t]?)?)?note/, '')
         else
           output.sub!(/%note/, "\n#{note.map { |l| "\t#{l.strip}  " }.join("\n")}")
           output.sub!(/%idnote/, "\n#{note.map { |l| "\t\t#{l.strip}  " }.join("\n")}")
@@ -111,15 +111,13 @@ module Doing
             prefix = m['prefix'] || ''
             "\n#{note.map { |l| "#{mark}#{indent}#{prefix}#{l.strip}  " }.join("\n")}"
           end
-          output.sub!(/%chompnote/) do |_m|
-            chomp_note = note.map do |l|
-              l.gsub(/\n+/, ' ').gsub(/(^\s*|\s*$)/, '').gsub(/\s+/, ' ')
-            end
-            chomp_note.join(' ')
+
+          output.sub!(/%chompnote/) do
+            note.map { |l| l.gsub(/\n+/, ' ').gsub(/(^\s*|\s*$)/, '').gsub(/\s+/, ' ') }.join(' ')
           end
         end
 
-        output.gsub!(/%hr(_under)?/) do |_m|
+        output.gsub!(/%hr(_under)?/) do
           o = ''
           `tput cols`.to_i.times do
             o += Regexp.last_match(1).nil? ? '-' : '_'

data/lib/doing/plugins/import/calendar_import.rb

@@ -8,7 +8,7 @@ require 'json'
 
 module Doing
   ##
-  ## @brief      Plugin for importing from Calendar.app on macOS
+  ## Plugin for importing from Calendar.app on macOS
   ##
   class CalendarImport
     include Doing::Util
@@ -64,9 +64,15 @@ module Doing
         new_items.push(new_entry)
       end
       total = new_items.count
+
+      new_items = wwid.filter_items(new_items, opt: options)
+      filtered = total - new_items.count
+      Doing.logger.debug('Skipped:' , %(#{filtered} items that didn't match filter criteria)) if filtered.positive?
+
       new_items = wwid.dedup(new_items, options[:no_overlap])
-      dups = total - new_items.count
+      dups = filtered - new_items.count
       Doing.logger.info(%(Skipped #{dups} items with overlapping times)) if dups.positive?
+
       wwid.content[section][:items].concat(new_items)
       Doing.logger.info(%(Imported #{new_items.count} items to #{section}))
     end

data/lib/doing/plugins/import/doing_import.rb

@@ -15,11 +15,11 @@ module Doing
     end
 
     ##
-    ## @brief      Imports a Doing file
+    ## Imports a Doing file
     ##
-    ## @param      wwid     WWID object
-    ## @param      path     (String) Path to Doing file
-    ## @param      options  (Hash) Additional Options
+    ## @param      wwid     [WWID] WWID object
+    ## @param      path     [String] Path to Doing file
+    ## @param      options  [Hash] Additional Options
     ##
     ## @return     Nothing
     ##
@@ -40,13 +40,13 @@ module Doing
 
       new_items = read_doing_file(path)
 
-      if options[:date_filter]
-        new_items = wwid.filter_items(new_items, opt: { count: 0, date_filter: options[:date_filter] })
-      end
+      total = new_items.count
 
-      if options[:before] || options[:after]
-        new_items = wwid.filter_items(new_items, opt: { count: 0, before: options[:before], after: options[:after] })
-      end
+      options[:count] = 0
+      new_items = wwid.filter_items(new_items, opt: options)
+
+      skipped = total - new_items.count
+      Doing.logger.debug('Skipped:' , %(#{skipped} items that didn't match filter criteria)) if skipped.positive?
 
       imported = []
 

data/lib/doing/plugins/import/timing_import.rb

@@ -15,10 +15,12 @@ module Doing
     end
 
     ##
-    ## @brief      Imports a Timing report
+    ## Imports a Timing report
     ##
-    ## @param      path     (String) Path to JSON report file
-    ## @param      options      (Hash) Additional Options
+    ## @param      wwid     [WWID] The wwid object
+    ## @param      path     [String] Path to JSON report
+    ##                      file
+    ## @param      options  [Hash] Additional Options
     ##
     def self.import(wwid, path, options: {})
       exit_now! 'Path to JSON report required' if path.nil?
@@ -66,9 +68,15 @@ module Doing
       total = new_items.count
       skipped = data.count - total
       Doing.logger.debug('Skipped:' , %(#{skipped} items, invalid type or no time interval)) if skipped.positive?
+
+      new_items = wwid.filter_items(new_items, opt: options)
+      filtered = skipped - new_items.count
+      Doing.logger.debug('Skipped:' , %(#{filtered} items that didn't match filter criteria)) if filtered.positive?
+
       new_items = wwid.dedup(new_items, options[:no_overlap])
-      dups = total - new_items.count
+      dups = filtered - new_items.count
       Doing.logger.debug('Skipped:' , %(#{dups} items with overlapping times)) if dups.positive?
+
       wwid.content[section][:items].concat(new_items)
       Doing.logger.info('Imported:', %(#{new_items.count} items to #{section}))
     end

data/lib/doing/string.rb

@@ -2,14 +2,59 @@
 
 module Doing
   ##
-  ## @brief      String helpers
+  ## String helpers
   ##
   class ::String
     include Doing::Color
-    def to_rx(distance)
-      gsub(/(.)/, "\\1.{0,#{distance}}")
+    ##
+    ## Determines if receiver is surrounded by slashes or starts with single quote
+    ##
+    ## @return     True if regex, False otherwise.
+    ##
+    def is_rx?
+      self =~ %r{(^/.*?/$|^')}
+    end
+
+    ##
+    ## Convert string to fuzzy regex. Characters in words
+    ## can be separated by up to *distance* characters in
+    ## haystack, spaces indicate unlimited distance.
+    ##
+    ## @example    "this word".to_rx(2) =>
+    ## /t.{0,3}h.{0,3}i.{0,3}s.{0,3}.*?w.{0,3}o.{0,3}r.{0,3}d/
+    ##
+    ## @param      distance   [Integer] Allowed distance
+    ##                        between characters
+    ## @param      case_type  The case type
+    ##
+    ## @return     [Regexp] Regex pattern
+    ##
+    def to_rx(distance: 3, case_type: :smart)
+      case_sensitive = case case_type
+                       when :smart
+                         self =~ /[A-Z]/ ? true : false
+                       when :sensitive
+                         true
+                       else
+                         false
+                       end
+
+      pattern = case dup.strip
+                when %r{^/.*?/$}
+                  sub(%r{/(.*?)/}, '\1')
+                when /^'/
+                  sub(/^'(.*?)'?$/, '\1')
+                else
+                  split(/ +/).map { |w| w.split('').join(".{0,#{distance}}") }.join('.*?')
+                end
+      Regexp.new(pattern, !case_sensitive)
     end
 
+    ##
+    ## Test string for truthiness (0, "f", "false", "n", "no" all return false, case insensitive, otherwise true)
+    ##
+    ## @return     [Boolean] String is truthy
+    ##
     def truthy?
       if self =~ /^(0|f(alse)?|n(o)?)$/i
         false
@@ -18,10 +63,18 @@ module Doing
       end
     end
 
+    ## @param (see #highlight_tags)
     def highlight_tags!(color = 'yellow')
       replace highlight_tags(color)
     end
 
+    ##
+    ## Colorize @tags with ANSI escapes
+    ##
+    ## @param      color  [String] color (see #Color)
+    ##
+    ## @return     [String] string with @tags highlighted
+    ##
     def highlight_tags(color = 'yellow')
       escapes = scan(/(\e\[[\d;]+m)[^\e]+@/)
       tag_color = Doing::Color.send(color)
@@ -34,7 +87,7 @@ module Doing
     end
 
     ##
-    ## @brief      Test if line should be ignored
+    ## Test if line should be ignored
     ##
     ## @return     [Boolean] line is empty or comment
     ##
@@ -44,7 +97,7 @@ module Doing
     end
 
     ##
-    ## @brief      Truncate to nearest word
+    ## Truncate to nearest word
     ##
     ## @param      len   The length
     ##
@@ -68,7 +121,7 @@ module Doing
     end
 
     ##
-    ## @brief      Truncate string in the middle
+    ## Truncate string in the middle
     ##
     ## @param      len       The length
     ## @param      ellipsis  The ellipsis
@@ -87,7 +140,7 @@ module Doing
     end
 
     ##
-    ## @brief      Remove color escape codes
+    ## Remove color escape codes
     ##
     ## @return     clean string
     ##
@@ -100,7 +153,7 @@ module Doing
     end
 
     ##
-    ## @brief      Wrap string at word breaks, respecting tags
+    ## Wrap string at word breaks, respecting tags
     ##
     ## @param      len     [Integer] The length
     ## @param      offset  [Integer] (Optional) The width to pad each subsequent line
@@ -134,7 +187,7 @@ module Doing
     end
 
     ##
-    ## @brief      Capitalize on the first character on string
+    ## Capitalize on the first character on string
     ##
     ## @return     Capitalized string
     ##
@@ -145,12 +198,12 @@ module Doing
     end
 
     ##
-    ## @brief      Convert a sort order string to a qualified type
+    ## Convert a sort order string to a qualified type
     ##
-    ## @return     (String) 'asc' or 'desc'
+    ## @return     [String] 'asc' or 'desc'
     ##
-    def normalize_order!
-      replace normalize_order
+    def normalize_order!(default = 'asc')
+      replace normalize_order(default)
     end
 
     def normalize_order(default = 'asc')
@@ -165,12 +218,34 @@ module Doing
     end
 
     ##
-    ## @brief      Convert a boolean string to a symbol
+    ## Convert a case sensitivity string to a symbol
+    ##
+    ## @return     Symbol :smart, :sensitive, :ignore
+    ##
+    def normalize_case!
+      replace normalize_case
+    end
+
+    def normalize_case(default = :smart)
+      case self
+      when /^c/i
+        :sensitive
+      when /^i/i
+        :ignore
+      when /^s/i
+        :smart
+      else
+        default.is_a?(Symbol) ? default : default.normalize_case
+      end
+    end
+
+    ##
+    ## Convert a boolean string to a symbol
     ##
     ## @return     Symbol :and, :or, or :not
     ##
-    def normalize_bool!
-      replace normalize_bool
+    def normalize_bool!(default = :and)
+      replace normalize_bool(default)
     end
 
     def normalize_bool(default = :and)
@@ -268,7 +343,7 @@ module Doing
     end
 
     ##
-    ## @brief      Remove duplicate tags, leaving only first occurrence
+    ## Remove duplicate tags, leaving only first occurrence
     ##
     ## @return     Deduplicated string
     ##
@@ -294,9 +369,9 @@ module Doing
     end
 
     ##
-    ## @brief      Turn raw urls into HTML links
+    ## Turn raw urls into HTML links
     ##
-    ## @param      opt   (Hash) Additional Options
+    ## @param      opt   [Hash] Additional Options
     ##
     def link_urls!(opt = {})
       replace link_urls(opt)

data/lib/doing/symbol.rb

@@ -2,15 +2,19 @@
 
 module Doing
   ##
-  ## @brief      Symbol helpers
+  ## Symbol helpers
   ##
   class ::Symbol
-    def normalize_bool
-      to_s.normalize_bool
+    def normalize_bool(default = :and)
+      to_s.normalize_bool(default)
     end
 
-    def normalize_order
-      to_s.normalize_order
+    def normalize_order(default = 'asc')
+      to_s.normalize_order(default)
+    end
+
+    def normalize_case
+      self
     end
   end
 end

data/lib/doing/time.rb

@@ -1,6 +1,6 @@
 module Doing
   ##
-  ## @brief      Date helpers
+  ## Date helpers
   ##
   class ::Time
     def relative_date

data/lib/doing/util.rb

@@ -14,9 +14,9 @@ module Doing
     end
 
     ##
-    ## @brief      Test if command line tool is available
+    ## Test if command line tool is available
     ##
-    ## @param      cli   (String) The name or path of the cli
+    ## @param      cli   [String] The name or path of the cli
     ##
     def exec_available(cli)
       return false if cli.nil?
@@ -40,9 +40,14 @@ module Doing
       end
     end
 
-    # Non-destructive version of deep_merge_hashes! See that method.
+    # Non-destructive version of deep_merge_hashes! See that
+    # method.
+    #
+    # @return     the merged hashes.
+    #
+    # @param      [Hash] master_hash  The master hash
+    # @param      [Hash] other_hash   The other hash
     #
-    # Returns the merged hashes.
     def deep_merge_hashes(master_hash, other_hash)
       deep_merge_hashes!(master_hash.dup, other_hash)
     end
@@ -90,11 +95,11 @@ module Doing
     end
 
     ##
-    ## @brief      Write content to a file
+    ## Write content to a file
     ##
-    ## @param      file     (String) The path to the file to (over)write
-    ## @param      content  (String) The content to write to the file
-    ## @param      backup   (Boolean) create a ~ backup
+    ## @param      file     [String] The path to the file to (over)write
+    ## @param      content  [String] The content to write to the file
+    ## @param      backup   [Boolean] create a ~ backup
     ##
     def write_to_file(file, content, backup: true)
       unless file
@@ -143,6 +148,8 @@ module Doing
     end
 
     def find_default_editor(editor_for = 'default')
+      # return nil unless $stdout.isatty || ENV['DOING_EDITOR_TEST']
+
       if ENV['DOING_EDITOR_TEST']
         return ENV['EDITOR']
       end
@@ -156,20 +163,20 @@ module Doing
 
       if editor_config[editor_for]
         editor = editor_config[editor_for]
-        Doing.logger.debug('Editor:', "Using #{editor} from config 'editors->#{editor_for}'")
+        # Doing.logger.debug('Editor:', "Using #{editor} from config 'editors->#{editor_for}'")
         return editor unless editor.nil? || editor.empty?
       end
 
       if editor_for != 'editor' && editor_config['default']
         editor = editor_config['default']
-        Doing.logger.debug('Editor:', "Using #{editor} from config: 'editors->default'")
+        # Doing.logger.debug('Editor:', "Using #{editor} from config: 'editors->default'")
         return editor unless editor.nil? || editor.empty?
       end
 
       editor ||= ENV['DOING_EDITOR'] || ENV['GIT_EDITOR'] || ENV['EDITOR']
 
       unless editor.nil? || editor.empty?
-        Doing.logger.debug('Editor:', "Found editor in environment variables: #{editor}")
+        # Doing.logger.debug('Editor:', "Found editor in environment variables: #{editor}")
         return editor
       end
 

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.0.6.pre'
+  VERSION = '2.0.10'
 end