doing 2.1.38 → 2.1.39

data/docs/doc/top-level-namespace.html

@@ -206,7 +206,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Mar 12 16:18:00 2022 by
+  Generated on Sun Mar 13 05:08:08 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-3.0.1).
 </div>

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.38
+v2.1.39
 
 === Global Options
 === --config_file arg
@@ -2283,6 +2283,11 @@ Show elapsed time on entries without @done tag
 
 
 
+===== -e|--editor
+Edit matching entries with vim
+
+
+
 ===== -h|--[no-]hilite
 Highlight search matches in output. Only affects command line output
 

data/lib/completion/_doing.zsh

@@ -174,7 +174,7 @@ function _doing() {
                 args=( {'(--archive)-a','(-a)--archive'}"[Archive selected items]" "--after[Select entries newer than date]:DATE_STRING:" "--resume[Copy selection as a new entry with current time and no @done tag]" "--before[Select entries older than date]:DATE_STRING:" {'(--cancel)-c','(-c)--cancel'}"[Cancel selected items]" "--case[Case sensitivity for search string matching ((c)ase-sensitive]:TYPE:" {'(--delete)-d','(-d)--delete'}"[Delete selected items]" {'(--editor)-e','(-e)--editor'}"[Edit selected item(s)]" {'(--finish)-f','(-f)--finish'}"[Add @done with current time to selected item(s)]" "--flag[Add flag to selected item(s)]" "--force[Perform action without confirmation]" "--from[Date range]:DATE_OR_RANGE:" {'(--move)-m','(-m)--move'}"[Move selected items to section]:SECTION:" "--menu[Use --no-menu to skip the interactive menu]" "--not[Select items that *dont* match search/tag filterst* match search/tag filters]" {'(--output)-o','(-o)--output'}"[Output entries to format]:FORMAT:" {'(--query)-q','(-q)--query'}"[Initial search query for filtering]:QUERY:" {'(--remove)-r','(-r)--remove'}"[Reverse -c]" {'(--section)-s','(-s)--section'}"[Select from a specific section]:SECTION:" "--save_to[Save selected entries to file using --output format]:FILE:" "--search[Filter entries using a search query]:QUERY:" {'(--tag)-t','(-t)--tag'}"[Tag selected entries]:TAG:" "--val[Perform a tag value query]:QUERY:" {'(--exact)-x','(-x)--exact'}"[Force exact search string matching]" )
             ;;
             show) 
-                args=( {'(--age)-a','(-a)--age'}"[Age]:AGE:" "--after[Show entries newer than date]:DATE_STRING:" "--before[Show entries older than date]:DATE_STRING:" "--bool[Boolean used to combine multiple tags]:BOOLEAN:" {'(--count)-c','(-c)--count'}"[Max count to show]:MAX:" "--case[Case sensitivity for search string matching ((c)ase-sensitive]:TYPE:" "--config_template[Output using a template from configuration]:TEMPLATE_KEY:" "--duration[Show elapsed time on entries without @done tag]" "--from[Date range]:DATE_OR_RANGE:" {'(--hilite)-h','(-h)--hilite'}"[Highlight search matches in output]" {'(--interactive)-i','(-i)--interactive'}"[Select from a menu of matching entries to perform additional operations]" {'(--menu)-m','(-m)--menu'}"[Select section or tag to display from a menu]" "--not[Show items that *dont* match search/tag filterst* match search/tag filters]" {'(--output)-o','(-o)--output'}"[Output to export format]:FORMAT:" "--only_timed[Only show items with recorded time intervals]" {'(--sort)-s','(-s)--sort'}"[Sort order]:ORDER:" "--search[Filter entries using a search query]:QUERY:" {'(--times)-t','(-t)--times'}"[Show time intervals on @done tasks]" "--tag[Filter entries by tag]:TAG:" "--tag_order[Tag sort direction]:DIRECTION:" "--tag_sort[Sort tags by]:KEY:" "--template[Override output format with a template string containing %placeholders]:TEMPLATE_STRING:" "--totals[Show time totals at the end of output]" "--val[Perform a tag value query]:QUERY:" {'(--exact)-x','(-x)--exact'}"[Force exact search string matching]" )
+                args=( {'(--age)-a','(-a)--age'}"[Age]:AGE:" "--after[Show entries newer than date]:DATE_STRING:" "--before[Show entries older than date]:DATE_STRING:" "--bool[Boolean used to combine multiple tags]:BOOLEAN:" {'(--count)-c','(-c)--count'}"[Max count to show]:MAX:" "--case[Case sensitivity for search string matching ((c)ase-sensitive]:TYPE:" "--config_template[Output using a template from configuration]:TEMPLATE_KEY:" "--duration[Show elapsed time on entries without @done tag]" {'(--editor)-e','(-e)--editor'}"[Edit matching entries with vim]" "--from[Date range]:DATE_OR_RANGE:" {'(--hilite)-h','(-h)--hilite'}"[Highlight search matches in output]" {'(--interactive)-i','(-i)--interactive'}"[Select from a menu of matching entries to perform additional operations]" {'(--menu)-m','(-m)--menu'}"[Select section or tag to display from a menu]" "--not[Show items that *dont* match search/tag filterst* match search/tag filters]" {'(--output)-o','(-o)--output'}"[Output to export format]:FORMAT:" "--only_timed[Only show items with recorded time intervals]" {'(--sort)-s','(-s)--sort'}"[Sort order]:ORDER:" "--search[Filter entries using a search query]:QUERY:" {'(--times)-t','(-t)--times'}"[Show time intervals on @done tasks]" "--tag[Filter entries by tag]:TAG:" "--tag_order[Tag sort direction]:DIRECTION:" "--tag_sort[Sort tags by]:KEY:" "--template[Override output format with a template string containing %placeholders]:TEMPLATE_STRING:" "--totals[Show time totals at the end of output]" "--val[Perform a tag value query]:QUERY:" {'(--exact)-x','(-x)--exact'}"[Force exact search string matching]" )
             ;;
             since) 
                 args=( "--bool[Boolean used to combine multiple tags]:BOOLEAN:" "--case[Case sensitivity for search string matching ((c)ase-sensitive]:TYPE:" "--config_template[Output using a template from configuration]:TEMPLATE_KEY:" "--duration[Show elapsed time on entries without @done tag]" "--not[Since items that *dont* match search/tag filterst* match search/tag filters]" {'(--output)-o','(-o)--output'}"[Output to export format]:FORMAT:" "--only_timed[Only show items with recorded time intervals]" {'(--section)-s','(-s)--section'}"[Section]:NAME:" "--search[Filter entries using a search query]:QUERY:" {'(--times)-t','(-t)--times'}"[Show time intervals on @done tasks]" "--tag[Filter entries by tag]:TAG:" "--tag_order[Tag sort direction]:DIRECTION:" "--tag_sort[Sort tags by]:KEY:" "--template[Override output format with a template string containing %placeholders]:TEMPLATE_STRING:" "--totals[Show time totals at the end of output]" "--val[Perform a tag value query]:QUERY:" {'(--exact)-x','(-x)--exact'}"[Force exact search string matching]" )

data/lib/completion/doing.bash

@@ -276,9 +276,9 @@ local words=$(doing sections)
 IFS="$OLD_IFS"
 
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--age --after --before --bool --count --case --config_template --duration --from --hilite --interactive --menu --not --output --only_timed --sort --search --times --tag --tag_order --tag_sort --template --totals --val --exact' -- $token ) )
+    COMPREPLY=( $( compgen -W '--age --after --before --bool --count --case --config_template --duration --editor --from --hilite --interactive --menu --not --output --only_timed --sort --search --times --tag --tag_order --tag_sort --template --totals --val --exact' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-a -c -h -i -m -o -s -t -x --age --after --before --bool --count --case --config_template --duration --from --hilite --interactive --menu --not --output --only_timed --sort --search --times --tag --tag_order --tag_sort --template --totals --val --exact' -- $token ) )
+    COMPREPLY=( $( compgen -W '-a -c -e -h -i -m -o -s -t -x --age --after --before --bool --count --case --config_template --duration --editor --from --hilite --interactive --menu --not --output --only_timed --sort --search --times --tag --tag_order --tag_sort --template --totals --val --exact' -- $token ) )
   else
   local nocasematchWasOff=0
   shopt nocasematch >/dev/null || nocasematchWasOff=1

data/lib/completion/doing.fish

@@ -447,6 +447,7 @@ complete -c doing -l count -s c -f -r -n '__fish_doing_using_command show' -d Ma
 complete -c doing -l case  -f -r -n '__fish_doing_using_command show' -d Case\ sensitivity\ for\ search\ string\ matching\ \[\(c\)ase-sensitive
 complete -c doing -l config_template  -f -r -n '__fish_doing_using_command show' -d Output\ using\ a\ template\ from\ configuration
 complete -c doing -l duration  -f  -n '__fish_doing_using_command show' -d Show\ elapsed\ time\ on\ entries\ without\ @done\ tag
+complete -c doing -l editor -s e -f  -n '__fish_doing_using_command show' -d Edit\ matching\ entries\ with\ vim
 complete -c doing -l from  -f -r -n '__fish_doing_using_command show' -d Date\ range
 complete -c doing -l hilite -s h -f  -n '__fish_doing_using_command show' -d Highlight\ search\ matches\ in\ output
 complete -c doing -l interactive -s i -f  -n '__fish_doing_using_command show' -d Select\ from\ a\ menu\ of\ matching\ entries\ to\ perform\ additional\ operations

data/lib/doing/chronify/string.rb

@@ -196,7 +196,9 @@ module Doing
           finish = dates[-1].chronify(guess: inclusive ? :end : :begin, future: true)
         end
 
-        raise Errors::InvalidTimeExpression, 'Unrecognized date string' if start.nil? || finish.nil?
+        raise Errors::InvalidTimeExpression, "Unrecognized date string (#{dates[0]})" if start.nil?
+
+        raise Errors::InvalidTimeExpression, "Unrecognized date string (#{dates[-1]})" if finish.nil?
 
       else
         if date_string.strip =~ time_rx

data/lib/doing/item.rb

@@ -180,8 +180,14 @@ module Doing
 
       remove = options.fetch(:remove, false)
       tags.each do |tag|
+        if tag =~ /^(\S+)\((.*?)\)$/
+          m = Regexp.last_match
+          tag = m[1]
+          options[:value] ||= m[2]
+        end
+
         bool = remove ? :and : :not
-        if tags?(tag, bool)
+        if tags?(tag, bool) || options[:value]
           @title = @title.tag(tag, **options).strip
           remove ? removed.push(tag) : added.push(tag)
         end
@@ -201,6 +207,16 @@ module Doing
       @title.scan(/(?<= |\A)@([^\s(]+)/).map { |tag| tag[0] }.sort.uniq
     end
 
+    ##
+    ## Return all tags including parenthetical values
+    ##
+    ## @return     [Array<Array>] Array of array pairs,
+    ##             [[tag1, value], [tag2, value]]
+    ##
+    def tags_with_values
+      @title.scan(/(?<= |\A)@([^\s(]+)(?:\((.*?)\))?/).map { |tag| [tag[0], tag[1]] }.sort.uniq
+    end
+
     ##
     ## convert tags on item to an array with @ symbols removed
     ##
@@ -557,6 +573,12 @@ module Doing
       false
     end
 
+    def tag_pattern?(tags)
+      query = tags.to_query
+
+      no_tags?(query[:must_not]) && all_tags?(query[:must]) && any_tags?(query[:should])
+    end
+
     def tag_value(tag)
       res = @title.match(/@#{tag.sub(/^@/, '').wildcard_to_rx}\((.*?)\)/)
       res ? res[1] : nil
@@ -592,6 +614,7 @@ module Doing
 
       queries.each do |q|
         parts = split_value_query(q)
+
         return false unless tag_value_matches?(parts[2], parts[3], parts[4], parts[1])
       end
       true
@@ -607,78 +630,153 @@ module Doing
       true
     end
 
+    def duration_matches?(value, comp)
+      return false if interval.nil?
+
+      val = value.chronify_qty
+      case comp
+      when /^<$/
+        interval < val
+      when /^<=$/
+        interval <= val
+      when /^>$/
+        interval > val
+      when /^>=$/
+        interval >= val
+      when /^!=/
+        interval != val
+      when /^=/
+        interval == val
+      end
+    end
+
+    def date_matches?(value, comp)
+      time_rx = /^(\d{1,2}+(:\d{1,2}+)?( *(am|pm))?|midnight|noon)$/i
+      value = "#{@date.strftime('%Y-%m-%d')} #{value}" if value =~ time_rx
+
+      val = value.chronify(guess: :begin)
+      raise InvalidTimeExpression, "Unrecognized date/time expression (#{value})" if val.nil?
+
+      case comp
+      when /^<$/
+        @date < val
+      when /^<=$/
+        @date <= val
+      when /^>$/
+        @date > val
+      when /^>=$/
+        @date >= val
+      when /^!=/
+        @date != val
+      when /^=/
+        @date == val
+      end
+    end
+
+    def value_string_matches?(tag_val, comp, value)
+      case comp
+      when /\^=/
+        tag_val =~ /^#{value.wildcard_to_rx}/i
+      when /\$=/
+        tag_val =~ /#{value.wildcard_to_rx}$/i
+      when %r{==}
+        tag_val =~ /^#{value.wildcard_to_rx}$/i
+      else
+        tag_val =~ /#{value.wildcard_to_rx}/i
+      end
+    end
+
+    def value_number_matches?(tag_val, comp, value)
+      case comp
+      when /^<$/
+        tag_val < value
+      when /^<=$/
+        tag_val <= value
+      when /^>$/
+        tag_val > value
+      when /^>=$/
+        tag_val >= value
+      when /^!=/
+        tag_val != value
+      when /^=/
+        tag_val == value
+      end
+    end
+
+    ##
+    ## Test if a tag's value matches a given value. Value
+    ## can be a date string, a text string, or a
+    ## number/percentage. Type of comparison is determined
+    ## by the comparitor and the objects being compared.
+    ##
+    ## @param      tag     [String] The tag name from which
+    ##                     to get the value
+    ## @param      comp    [String] The comparator (e.g. >=
+    ##                     or *=)
+    ## @param      value   [String] The value to test
+    ##                     against
+    ## @param      negate  [Boolean] Negate the response
+    ##
+    ## @return     True if tag value matches, False otherwise.
+    ##
     def tag_value_matches?(tag, comp, value, negate)
-      if tag =~ /^(elapsed|dur(ation)?|int(erval)?|t(ime)?)$/
-
-        return false if interval.nil?
-
-        val = value.chronify_qty
-        is_match = case comp
-                   when /^<$/
-                     interval < val
-                   when /^<=$/
-                     interval <= val
-                   when /^>$/
-                     interval > val
-                   when /^>=$/
-                     interval >= val
-                   when /^!=/
-                     interval != val
-                   when /^=/
-                     interval == val
-                   end
-        comp =~ /!/ || negate ? !is_match : is_match
-      elsif all_tags?([tag])
+      # If tag matches existing tag
+      if tags?(tag, :and)
         tag_val = tag_value(tag)
 
+        # If the tag value is not a date and contains alpha
+        # characters and comparison is ==, or comparison is
+        # a string comparitor (*= ^= $=)
         if (value.chronify.nil? && value =~ /[a-z]/i && comp =~ /^!?==?$/) || comp =~ /[$*^]=/
-          is_match = case comp
-                     when /\^=/
-                       tag_val =~ /^#{value.wildcard_to_rx}/i
-                     when /\$=/
-                       tag_val =~ /#{value.wildcard_to_rx}$/i
-                     when %r{==}
-                       tag_val =~ /^#{value.wildcard_to_rx}$/i
-                     else
-                       tag_val =~ /#{value.wildcard_to_rx}/i
-                     end
+          is_match = value_string_matches?(tag_val, comp, value)
 
           comp =~ /!/ || negate ? !is_match : is_match
         else
+          # Convert values to either a number or a date
           tag_val = number_or_date(tag_val)
           val = number_or_date(value)
 
+          # Fail if either value is nil
           return false if val.nil? || tag_val.nil?
 
+          # Fail unless both values are of the same class (float or date)
           return false unless val.class == tag_val.class
 
-          matches = case comp
-                    when /^<$/
-                      tag_val < val
-                    when /^<=$/
-                      tag_val <= val
-                    when /^>$/
-                      tag_val > val
-                    when /^>=$/
-                      tag_val >= val
-                    when /^!=/
-                      tag_val != val
-                    when /^=/
-                      tag_val == val
-                    end
-          negate.nil? ? matches : !matches
+          is_match = value_number_matches?(tag_val, comp, val)
+
+          negate.nil? ? is_match : !is_match
         end
+      # If tag name matches a trigger for elapsed time test
+      elsif tag =~ /^(elapsed|dur(ation)?|int(erval)?)$/i
+        is_match = duration_matches?(value, comp)
+
+        comp =~ /!/ || negate ? !is_match : is_match
+      # Else if tag name matches a trigger for start date
+      elsif tag =~ /^(d(ate)?|t(ime)?)$/i
+        is_match = date_matches?(value, comp)
+
+        comp =~ /!/ || negate ? !is_match : is_match
+      # Else if tag name matches a trigger for all text
+      elsif tag =~ /^text$/i
+        is_match = value_string_matches?([@title, @note.to_s(prefix: '')].join(' '), comp, value)
+
+        comp =~ /!/ || negate ? !is_match : is_match
+      # Else if tag name matches a trigger for title
+      elsif tag =~ /^title$/i
+        is_match = value_string_matches?(@title, comp, value)
+
+        comp =~ /!/ || negate ? !is_match : is_match
+      # Else if tag name matches a trigger for note
+      elsif tag =~ /^note$/i
+        is_match = value_string_matches?(@note.to_s(prefix: ''), comp, value)
+
+        comp =~ /!/ || negate ? !is_match : is_match
+      # Else if item contains tag being tested
       else
         false
       end
     end
 
-    def tag_pattern?(tags)
-      query = tags.to_query
-
-      no_tags?(query[:must_not]) && all_tags?(query[:must]) && any_tags?(query[:should])
-    end
-
     def split_tags(tags)
       tags.to_tags.tags_to_array
     end

data/lib/doing/items.rb

@@ -179,7 +179,7 @@ module Doing
       out = []
       @sections.each do |section|
         out.push(section.original)
-        items = in_section(section.title).sort_by(&:date)
+        items = in_section(section.title).sort_by { |i| [i.date, i.title] }
         items.reverse! if Doing.setting('doing_file_sort').normalize_order == :desc
         items.each { |item| out.push(item.to_s) }
       end

data/lib/doing/prompt.rb

@@ -58,14 +58,12 @@ module Doing
         comp = proc { |s| completions.grep(/^#{Regexp.escape(s)}/) }
         Readline.completion_append_character = ' '
         Readline.completion_proc = comp
-        prompt_text = []
-        prompt_text << boldgreen(prompt.sub(/:?$/, ':'))
-        prompt_text << yellow(' Enter a blank line (')
-        prompt_text << boldwhite('return twice')
-        prompt_text << yellow(') to end editing and save, ')
-        prompt_text << boldwhite('CTRL-C')
-        prompt_text << yellow(' to cancel')
-        puts prompt_text.join('')
+        puts format(['%<promptcolor>s%<prompt>s %<textcolor>sEnter a blank line',
+          '(%<keycolor>sreturn twice%<textcolor>s)',
+          'to end editing and save,',
+          '%<keycolor>sCTRL-C%<textcolor>s to cancel%<reset>s'].join(' '),
+          { promptcolor: boldgreen, prompt: prompt.sub(/:?$/, ':'),
+            textcolor: yellow, keycolor: boldwhite, reset: reset })
 
         res = []
 

data/lib/doing/string/tags.rb

@@ -117,14 +117,20 @@ module Doing
         else
           Doing.logger.debug('Skipped:', "not tagged #{"@#{tag}".cyan}")
         end
-      elsif title =~ /@#{tag}(?=[ (]|$)/
+      elsif title =~ /@#{tag}(?=[ (]|$)/ && !value.good?
         Doing.logger.debug('Skipped:', "already tagged #{"@#{tag}".cyan}")
         return title
       else
         add = tag
         add += "(#{value})" unless value.nil?
+
         title.chomp!
-        title += " @#{add}"
+
+        if value && title =~ /@#{tag}(?=[ (]|$)/
+          title.sub!(/@#{tag}(\(.*?\))?/, "@#{add}")
+        else
+          title += " @#{add}"
+        end
 
         title.dedup_tags!
         title.chomp!

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.38'
+  VERSION = '2.1.39'
 end

data/lib/doing/wwid.rb

@@ -665,7 +665,7 @@ module Doing
     ##
     def filter_items(items = Items.new, opt: {})
       logger.benchmark(:filter_items, :start)
-      time_rx = /^(\d{1,2}+(:\d{1,2}+)?( *(am|pm))?|midnight|noon)$/
+      time_rx = /^(\d{1,2}+(:\d{1,2}+)?( *(am|pm))?|midnight|noon)$/i
 
       if items.nil? || items.empty?
         section = opt[:section] ? guess_section(opt[:section]) : 'All'
@@ -1292,9 +1292,14 @@ module Doing
               next
             end
 
-
             tag = tag.strip
 
+            if tag =~ /^(\S+)\((.*?)\)$/
+              m = Regexp.last_match
+              tag = m[1]
+              opt[:value] ||= m[2]
+            end
+
             if tag =~ /^done$/ && opt[:date] && item.should_time?
               max_elapsed = Doing.setting('interaction.confirm_longer_than', 0)
               max_elapsed = max_elapsed.chronify_qty if max_elapsed.is_a?(String)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 2.1.38
+  version: 2.1.39
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup