doing 2.1.4pre → 2.1.5pre

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Dec 17 16:17:18 2021 by
+  Generated on Sun Dec 19 12:35:32 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/doing.gemspec

@@ -41,5 +41,6 @@ spec = Gem::Specification.new do |s|
   s.add_runtime_dependency('tty-which', '~> 0.5', '>= 0.5.0')
   s.add_runtime_dependency('tty-markdown', '~> 0.7', '>= 0.7.0')
   s.add_runtime_dependency('parslet', '~> 2.0', '>= 2.0.0')
+  s.add_runtime_dependency('plist', '~> 3.6', '>= 3.6.0')
   # s.add_runtime_dependency('amatch', '~> 0.4', '>= 0.4.0')
 end

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.4pre
+v2.1.5pre
 
 === Global Options
 === --config_file arg
@@ -711,7 +711,7 @@ Date range to show, or a single day to filter date on.
 
 ===== -o|--output FORMAT
 
-Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 
@@ -1204,7 +1204,7 @@ it will create a range.
 ===== Options
 ===== -o|--output FORMAT
 
-Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 
@@ -1532,7 +1532,7 @@ Move selected items to section
 
 ===== -o|--output FORMAT
 
-Output entries to format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output entries to format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 
@@ -1669,6 +1669,7 @@ Show entries older than date. If this is only a time (8am, 1:30pm, 15:00), all d
 Max count to show
 
 [Default Value] 0
+[Must Match] (?-mix:^\d+$)
 
 
 ===== --case TYPE
@@ -1693,7 +1694,7 @@ Date range to show, or a single day to filter date on.
 
 ===== -o|--output FORMAT
 
-Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 
@@ -1784,7 +1785,7 @@ and "2d" would be interpreted as "two days ago."
 ===== Options
 ===== -o|--output FORMAT
 
-Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 
@@ -1939,6 +1940,22 @@ List all tags in the current Doing file
 
 
 ===== Options
+===== --bool BOOLEAN
+
+Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans.
+
+[Default Value] PATTERN
+[Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$)
+
+
+===== --case TYPE
+
+Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]
+
+[Default Value] smart
+[Must Match] (?-mix:^[csi])
+
+
 ===== -o|--order ORDER
 
 Sort order (asc/desc)
@@ -1954,6 +1971,14 @@ Section
 [Default Value] All
 
 
+===== --search QUERY
+
+Get tags for items matching search. Surround with
+  slashes for regex (e.g. "/query/"), start with a single quote for exact match ("'query").
+
+[Default Value] None
+
+
 ===== --sort SORT_ORDER
 
 Sort by name or count
@@ -1962,11 +1987,33 @@ Sort by name or count
 [Must Match] (?-mix:^(?:n(?:ame)?|c(?:ount)?)$)
 
 
+===== --tag TAG
+
+Get tags for entries matching tags. Combine multiple tags with a comma. Wildcards allowed (*, ?).
+
+[Default Value] None
+
+
 ===== -c|--[no-]counts
 Show count of occurrences
 
 
 
+===== -i|--interactive
+Select items to scan from a menu of matching entries
+
+
+
+===== --not
+Get tags from items that *don't* match search/tag filters
+
+
+
+===== -x|--exact
+Force exact search string matching (case sensitive)
+
+
+
 ==== Command: <tt>template  TYPE</tt>
 Output HTML, CSS, and Markdown (ERB) templates for customization
 
@@ -2016,7 +2063,7 @@ Time range to show `doing today --from "12pm to 4pm"`
 
 ===== -o|--output FORMAT
 
-Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 
@@ -2141,7 +2188,7 @@ Date range to show, or a single day to filter date on.
 
 ===== -o|--output FORMAT
 
-Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 
@@ -2324,7 +2371,7 @@ Time range to show, e.g. `doing yesterday --from "1am to 8am"`
 
 ===== -o|--output FORMAT
 
-Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
+Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|markdown|say|taskpaper|template|timeline|wiki)
 
 [Default Value] None
 

data/lib/doing/array.rb

@@ -5,6 +5,15 @@ module Doing
   ## Array helpers
   ##
   class ::Array
+    ##
+    ## Convert an @tags to plain strings
+    ##
+    ## @return     [Array] array of strings
+    ##
+    def tags_to_array
+      map { |t| t.sub(/^@/, '') }
+    end
+
     # Convert strings to @tags
     #
     # @example `['one', '@two', 'three'].to_tags`

data/lib/doing/configuration.rb

@@ -29,8 +29,8 @@ module Doing
         'plugin_path' => File.join(Util.user_home, '.config', 'doing', 'plugins'),
         'command_path' => File.join(Util.user_home, '.config', 'doing', 'commands')
       },
-      'doing_file' => '~/what_was_i_doing.md',
-      'backup_dir' => '~/.doing_backup',
+      'doing_file' => '~/.local/share/doing/what_was_i_doing.md',
+      'backup_dir' => '~/.local/share/doing/doing_backup',
       'current_section' => 'Currently',
       'paginate' => false,
       'never_time' => [],
@@ -43,7 +43,8 @@ module Doing
       'templates' => {
         'default' => {
           'date_format' => '%Y-%m-%d %H:%M',
-          'template' => '%date | %title %interval%duration%note',
+          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
+            %yellow%interval%boldred%duration%dark%white%80_14┃ note',
           'wrap_width' => 0,
           'order' => 'asc'
         },
@@ -60,7 +61,8 @@ module Doing
         },
         'recent' => {
           'date_format' => '%_I:%M%P',
-          'template' => '%shortdate: %title (%section) %interval%duration%note',
+          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
+            %yellow%interval%boldred%duration%dark%white%80_14┃ note',
           'wrap_width' => 88,
           'count' => 10,
           'order' => 'asc'
@@ -72,7 +74,7 @@ module Doing
       'views' => {
         'done' => {
           'date_format' => '%_I:%M%P',
-          'template' => '%date | %title%note',
+          'template' => '%date | %title (%section)% 18: note',
           'wrap_width' => 0,
           'section' => 'All',
           'count' => 0,
@@ -93,6 +95,11 @@ module Doing
       'marker_color' => 'red',
       'default_tags' => [],
       'tag_sort' => 'name',
+      'search' => {
+        'matching' => 'pattern', # fuzzy, pattern, exact
+        'distance' => 3,
+        'case' => 'smart' # sensitive, ignore, smart
+      },
       'include_notes' => true
     }
 
@@ -110,6 +117,17 @@ module Doing
       @config_dir ||= File.join(Util.user_home, '.config', 'doing')
     end
 
+    ##
+    ## Check if configuration enforces exact string matching
+    ##
+    ## @return     [Boolean] exact matching enabled
+    ##
+    def exact_match?
+      search_settings = @settings['search']
+      matching = search_settings.fetch('matching', 'pattern').normalize_matching
+      matching == :exact
+    end
+
     def default_config_file
       if File.exist?(config_dir) && !File.directory?(config_dir)
         raise DoingRuntimeError, "#{config_dir} exists but is not a directory"
@@ -220,11 +238,15 @@ module Doing
       cfg.nil? ? nil : { real_path[-1] => cfg }
     end
 
-    # It takes the input, fills in the defaults where values do not exist.
+    # It takes the input, fills in the defaults where values
+    # do not exist.
+    #
+    # @param      user_config  a Hash or Configuration of
+    #                          overrides.
     #
-    # user_config - a Hash or Configuration of overrides.
+    # @return     [Hash] a Configuration filled with
+    #             defaults.
     #
-    # Returns a Configuration filled with defaults.
     def from(user_config)
       Util.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
     end

data/lib/doing/item.rb

@@ -7,7 +7,7 @@ module Doing
   class Item
     attr_accessor :date, :title, :section, :note
 
-    attr_reader :id
+    # attr_reader :id
 
     ##
     ## Initialize an item with date, title, section, and
@@ -162,6 +162,10 @@ module Doing
       @title.scan(/(?<= |\A)@([^\s(]+)/).map { |tag| tag[0] }.sort.uniq
     end
 
+    def tag_array
+      tags.tags_to_array
+    end
+
     ##
     ## Test if item contains tag(s)
     ##
@@ -208,8 +212,13 @@ module Doing
     ##
     ## @return     [Boolean] matches search criteria
     ##
-    def search(search, distance: 3, negate: false, case_type: :smart)
-      if search.is_rx?
+    def search(search, distance: nil, negate: false, case_type: nil)
+      prefs = Doing.config.settings['search'] || {}
+      matching = prefs.fetch('matching', 'pattern').normalize_matching
+      distance ||= prefs.fetch('distance', 3).to_i
+      case_type ||= prefs.fetch('case', 'smart').normalize_case
+
+      if search.is_rx? || matching == :fuzzy
         matches = @title + @note.to_s =~ search.to_rx(distance: distance, case_type: case_type)
       else
         query = to_phrase_query(search.strip)

data/lib/doing/log_adapter.rb

@@ -38,6 +38,7 @@ module Doing
       rotated
       skipped
       updated
+      exported
     ].freeze
 
     #
@@ -265,6 +266,31 @@ module Doing
       end
     end
 
+    def benchmark(key, state)
+      return unless ENV['DOING_BENCHMARK']
+
+      @benchmarks ||= {}
+      @benchmarks[key] ||= { start: nil, finish: nil }
+      @benchmarks[key][state] = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def log_benchmarks
+      if ENV['DOING_BENCHMARK']
+        output = []
+        @benchmarks.each do |k, timers|
+          if timers[:finish] && timers[:start]
+            output << "#{k}: #{timers[:finish] - timers[:start]}"
+          else
+            output << "#{k}: error"
+          end
+        end
+        output.each do |msg|
+          $stdout.puts color_message(:debug, 'Benchmark:', msg)
+        end
+      end
+    end
+
+
     def log_change(tags_added: [], tags_removed: [], count: 1, item: nil, single: false)
       if tags_added.empty? && tags_removed.empty?
         count(:skipped, level: :debug, message: '%count %items with no change', count: count)
@@ -319,6 +345,8 @@ module Doing
         ['Archived:',  data[:message] || 'completed and archived %count %items']
       when :skipped
         ['Skipped:', data[:message] || '%count %items were unchanged']
+      when :exported
+        ['Exported:', data[:message] || '%count %items were exported']
       end
     end
 

data/lib/doing/note.rb

@@ -22,7 +22,7 @@ module Doing
     ## Add note contents, optionally replacing existing note
     ##
     ## @param      note     [Array] The note to add, can be
-    ##                      string or array (Note)
+    ##                      String, Array, or Note
     ## @param      replace  [Boolean] replace existing
     ##                      content
     ##
@@ -36,32 +36,7 @@ module Doing
     end
 
     ##
-    ## Append an array of strings to note
-    ##
-    ## @param      lines  [Array] Array of strings
-    ##
-    def append(lines)
-      concat(lines)
-      replace compress
-    end
-
-    ##
-    ## Append a string to the note content
-    ##
-    ## @param      input  [String] The input string,
-    ##                    newlines will be split
-    ##
-    def append_string(input)
-      concat(input.split(/\n/).map(&:strip))
-      replace compress
-    end
-
-    def compress!
-      replace compress
-    end
-
-    ##
-    ## Remove blank lines and comment lines (#)
+    ## Remove blank lines and comments (#)
     ##
     ## @return     [Array] compressed array
     ##
@@ -69,8 +44,8 @@ module Doing
       delete_if { |l| l =~ /^\s*$/ || l =~ /^#/ }
     end
 
-    def strip_lines!
-      replace strip_lines
+    def compress!
+      replace compress
     end
 
     ##
@@ -83,6 +58,10 @@ module Doing
       map(&:strip)
     end
 
+    def strip_lines!
+      replace strip_lines
+    end
+
     ##
     ## Note as multi-line string
     def to_s
@@ -101,11 +80,33 @@ module Doing
     ## @param      other  [Note] The other Note
     ##
     ## @return     [Boolean] true if equal
-    ##
     def equal?(other)
       return false unless other.is_a?(Note)
 
       to_s == other.to_s
     end
+
+    private
+
+    ##
+    ## Append an array of strings to note
+    ##
+    ## @param      lines  [Array] Array of strings
+    ##
+    def append(lines)
+      concat(lines)
+      replace compress
+    end
+
+    ##
+    ## Append a string to the note content
+    ##
+    ## @param      input  [String] The input string,
+    ##                    newlines will be split
+    ##
+    def append_string(input)
+      concat(input.split(/\n/).map(&:strip))
+      replace compress
+    end
   end
 end

data/lib/doing/plugin_manager.rb

@@ -28,26 +28,30 @@ module Doing
         plugins
       end
 
-      # Public: Setup the plugin search path
+      # Setup the plugin search path
+      #
+      # @param      add_dir  [String] optional additional
+      #                      path to include
+      #
+      # @return     [Array] Returns an Array of plugin search paths
       #
-      # Returns an Array of plugin search paths
       def plugins_path(add_dir = nil)
         paths = Array(File.join(File.dirname(__FILE__), 'plugins'))
         paths << File.join(add_dir) if add_dir
         paths.map { |d| File.expand_path(d) }
       end
 
-      ##
+
       # Register a plugin
       #
-      # param: +[String|Array]+ title  The name of the plugin (can be an array of names)
-      #
-      # param: +type+ The plugin type (:import, :export)
-      #
-      # param: +klass+ The class responding to :render or :import
+      # @param      title  [String|Array] The name of the
+      #                    plugin (can be an array of names)
+      # @param      type   [Symbol] The plugin type
+      #                    (:import, :export)
+      # @param      klass  [Class] The class responding to
+      #                    :render or :import
       #
-      #
-      # returns: Success boolean
+      # @return     [Boolean] Success boolean
       #
       def register(title, type, klass)
         type = validate_plugin(title, type, klass)
@@ -90,6 +94,15 @@ module Doing
         type
       end
 
+      ##
+      ## Converts a partial symbol to a valid plugin type,
+      ## e.g. :imp => :import
+      ##
+      ## @param      type     [Symbol] the symbol to test
+      ## @param      default  [Symbol] fallback value
+      ##
+      ## @return     [Symbol] :import or :export
+      ##
       def valid_type(type, default: nil)
         type ||= default
 
@@ -154,10 +167,13 @@ module Doing
       end
 
       ##
-      ## Return a regular expression of all
-      ##             plugin triggers for type
+      ## Return a regular expression of all plugin triggers
+      ## for type
+      ##
+      ## @param      type  [Symbol] The type :import or
+      ##                   :export
       ##
-      ## @param      type  The type :import or :export
+      ## @return     [Regexp] regular expression
       ##
       def plugin_regex(type: :export)
         type = valid_type(type)
@@ -168,6 +184,14 @@ module Doing
         Regexp.new("^(?:#{pattern.join('|')})$", true)
       end
 
+      ##
+      ## Return array of available template names
+      ##
+      ## @param      type  [Symbol] Plugin type (:import,
+      ##                   :export)
+      ##
+      ## @return     [Array<String>] template names
+      ##
       def plugin_templates(type: :export)
         type = valid_type(type)
         templates = []
@@ -181,6 +205,15 @@ module Doing
         templates
       end
 
+      ##
+      ## Return a regular expression of all template
+      ## triggers for type
+      ##
+      ## @param      type  [Symbol] The type :import or
+      ##                   :export
+      ##
+      ## @return     [Regexp] regular expression
+      ##
       def template_regex(type: :export)
         type = valid_type(type)
         pattern = []
@@ -193,6 +226,17 @@ module Doing
         Regexp.new("^(?:#{pattern.join('|')})$", true)
       end
 
+      ##
+      ## Find and return the appropriate template for a
+      ## trigger string. Outputs a string that can be
+      ## written out to the terminal for redirection
+      ##
+      ## @param      trigger  [String] The trigger to test
+      ## @param      type     [Symbol] the plugin type
+      ##                      (:import, :export)
+      ##
+      ## @return     [String] string content of template for trigger
+      ##
       def template_for_trigger(trigger, type: :export)
         type = valid_type(type)
         plugs = plugins[type].clone