doing 2.1.13 → 2.1.17

data/lib/doing/string_chronify.rb

@@ -64,22 +64,120 @@ module Doing
       when /^(\d+):(\d\d)$/
         minutes += Regexp.last_match(1).to_i * 60
         minutes += Regexp.last_match(2).to_i
-      when /^(\d+(?:\.\d+)?)([hmd])?$/
-        amt = Regexp.last_match(1)
-        type = Regexp.last_match(2).nil? ? 'm' : Regexp.last_match(2)
-
-        minutes = case type.downcase
-                  when 'm'
-                    amt.to_i
-                  when 'h'
-                    (amt.to_f * 60).round
-                  when 'd'
-                    (amt.to_f * 60 * 24).round
-                  else
-                    minutes
-                  end
+      when /^(\d+(?:\.\d+)?)([hmd])?/
+        scan(/(\d+(?:\.\d+)?)([hmd])?/).each do |m|
+          amt = m[0]
+          type = m[1].nil? ? 'm' : m[1]
+
+          minutes += case type.downcase
+                     when 'm'
+                       amt.to_i
+                     when 'h'
+                       (amt.to_f * 60).round
+                     when 'd'
+                       (amt.to_f * 60 * 24).round
+                     else
+                       0
+                     end
+        end
       end
       minutes * 60
     end
+
+    ##
+    ## Convert DD:HH:MM to seconds
+    ##
+    ## @return     [Integer] rounded number of seconds
+    ##
+    def to_seconds
+      mtch = match(/(\d+):(\d+):(\d+)/)
+
+      raise Errors::DoingRuntimeError, "Invalid time string: #{self}" unless mtch
+
+      h = mtch[1]
+      m = mtch[2]
+      s = mtch[3]
+      (h.to_i * 60 * 60) + (m.to_i * 60) + s.to_i
+    end
+
+    ##
+    ## Convert DD:HH:MM to a natural language string
+    ##
+    ## @param      format  [Symbol] The format to output (:dhm, :hm, :m, :clock, :natural)
+    ##
+    def time_string(format: :dhm)
+      to_seconds.time_string(format: format)
+    end
+
+    ##
+    ## Convert (chronify) natural language dates
+    ## within configured date tags (tags whose value is
+    ## expected to be a date). Modifies string in place.
+    ##
+    ## @param      additional_tags  [Array] An array of
+    ##                              additional tags to
+    ##                              consider date_tags
+    ##
+    def expand_date_tags(additional_tags = nil)
+      iso_rx = /\d{4}-\d\d-\d\d \d\d:\d\d/
+
+      watch_tags = [
+        'start(?:ed)?',
+        'beg[ia]n',
+        'done',
+        'finished',
+        'completed?',
+        'waiting',
+        'defer(?:red)?'
+      ]
+
+      if additional_tags
+        date_tags = additional_tags
+        date_tags = date_tags.split(/ *, */) if date_tags.is_a?(String)
+        date_tags.map! do |tag|
+          tag.sub(/^@/, '').gsub(/\((?!\?:)(.*?)\)/, '(?:\1)').strip
+        end
+        watch_tags.concat(date_tags).uniq!
+      end
+
+      done_rx = /(?<=^| )@(?<tag>#{watch_tags.join('|')})\((?<date>.*?)\)/i
+
+      gsub!(done_rx) do
+        m = Regexp.last_match
+        t = m['tag']
+        d = m['date']
+        future = t =~ /^(done|complete)/ ? false : true
+        parsed_date = d =~ iso_rx ? Time.parse(d) : d.chronify(guess: :begin, future: future)
+        parsed_date.nil? ? m[0] : "@#{t}(#{parsed_date.strftime('%F %R')})"
+      end
+    end
+
+    ##
+    ## Splits a range string and returns an array of
+    ## DateTime objects as [start, end]. If only one date is
+    ## given, end time is nil.
+    ##
+    ## @return     [Array<DateTime>] Start and end dates as
+    ##             array
+    ## @example    Process a natural language date range
+    ## "mon 3pm to mon 5pm".split_date_range
+    ##
+    def split_date_range
+      date_string = dup
+      case date_string
+      when / (to|through|thru|(un)?til|-+) /
+        dates = date_string.split(/ (?:to|through|thru|(?:un)?til|-+) /)
+        start = dates[0].chronify(guess: :begin)
+        finish = dates[-1].chronify(guess: :end)
+      else
+        start = date_string.chronify(guess: :begin)
+        finish = nil
+      end
+
+      raise InvalidTimeExpression, 'Unrecognized date string' unless start
+
+      Doing.logger.debug('Parser:', "date range interpreted as #{start.strftime('%F %R')} -- #{finish ? finish.strftime('%F %R') : 'now'}")
+      [start, finish]
+    end
   end
 end

data/lib/doing/template_string.rb

@@ -176,7 +176,7 @@ module Doing
                   '  '
                 else
                   line = l.gsub(/%/, '\%').strip.wrap(width, pad: pad, indent: indent, offset: 0, prefix: prefix, color: last_color, after: after, reset: reset, pad_first: true)
-                  line.highlight_tags!(tags_color, last_color: last_color) unless tags_color.nil? || tags_color.empty?
+                  line.highlight_tags!(tags_color, last_color: last_color) unless !tags_color || tags_color.nil? || tags_color.empty?
                   "#{line}  "
                 end
               end.join("\n")

data/lib/doing/time.rb

@@ -8,10 +8,10 @@ module Doing
         strftime('%_I:%M%P')
       elsif self > (Date.today - 6).to_time
         strftime('%a %_I:%M%P')
-      elsif self.year == Date.today.year
+      elsif self.year == Date.today.year || (self.year + 1 == Date.today.year && self.month > Date.today.month)
         strftime('%m/%d %_I:%M%P')
       else
-        strftime('%m/%d/%Y %_I:%M%P')
+        strftime('%m/%d/%y %_I:%M%P')
       end
     end
 
@@ -25,10 +25,10 @@ module Doing
       h = h % 24
 
       output = []
-      output.push("#{d} #{'day'.pluralize(d)}") if d.positive?
-      output.push("#{h} #{'hour'.pluralize(h)}") if h.positive?
-      output.push("#{m} #{'minute'.pluralize(m)}") if m.positive?
-      output.push("#{s} #{'second'.pluralize(s)}") if s.positive?
+      output.push("#{d} #{'day'.to_p(d)}") if d.positive?
+      output.push("#{h} #{'hour'.to_p(h)}") if h.positive?
+      output.push("#{m} #{'minute'.to_p(m)}") if m.positive?
+      output.push("#{s} #{'second'.to_p(s)}") if s.positive?
       output.join(', ')
     end
 

data/lib/doing/util_backup.rb

@@ -79,7 +79,7 @@ module Doing
       def redo_backup(filename = nil, count: 1)
         filename ||= Doing.config.settings['doing_file']
         # redo_file = File.join(backup_dir, "undone___#{File.basename(filename)}")
-        undones = Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).sort
+        undones = Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).sort.reverse
         total = undones.count
         count = total if count > total
 

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.13'
+  VERSION = '2.1.17'
 end

data/lib/doing/wwid.rb

@@ -185,34 +185,11 @@ module Doing
 
       date = nil
       iso_rx = /\d{4}-\d\d-\d\d \d\d:\d\d/
-      watch_tags = [
-        'start(?:ed)?',
-        'beg[ia]n',
-        'done',
-        'finished',
-        'completed?',
-        'waiting',
-        'defer(?:red)?'
-      ]
-      if @config['date_tags']
-        date_tags = @config['date_tags']
-        date_tags = date_tags.split(/ *, */) if date_tags.is_a?(String)
-        date_tags.map! do |tag|
-          tag.sub(/^@/, '').gsub(/\((?!\?:)(.*?)\)/, '(?:\1)').strip
-        end
-        watch_tags.concat(date_tags).uniq!
-      end
-
-      done_rx = /(?<=^| )@(?<tag>#{watch_tags.join('|')})\((?<date>.*?)\)/i
       date_rx = /^(?:\s*- )?(?<date>.*?) \| (?=\S)/
 
-      title.gsub!(done_rx) do
-        m = Regexp.last_match
-        t = m['tag']
-        d = m['date']
-        parsed_date = d =~ date_rx ? Time.parse(d) : d.chronify(guess: :begin)
-        parsed_date.nil? ? m[0] : "@#{t}(#{parsed_date.strftime('%F %R')})"
-      end
+      raise EmptyInput, 'No content' if title.sub(/^.*?\| */, '').strip.empty?
+
+      title.expand_date_tags(@config['date_tags'])
 
       if title =~ date_rx
         m = title.match(date_rx)
@@ -369,7 +346,8 @@ module Doing
         items.each_with_index do |i, x|
           next if i.title =~ / @done/
 
-          items[x].title = "#{i.title} @done(#{opt[:back].strftime('%F %R')})"
+          finish_date = verify_duration(i.date, opt[:back], title: i.title)
+          items[x].tag('done', value: finish_date.strftime('%F %R'))
           break
         end
       end
@@ -384,10 +362,13 @@ module Doing
     end
 
     ##
-    ## Remove items from a list that already exist in @content
+    ## Remove items from an array that already exist in
+    ## @content based on start and end times
     ##
-    ## @param      items       [Array] The items to deduplicate
-    ## @param      no_overlap  [Boolean] Remove items with overlapping time spans
+    ## @param      items       [Array] The items to
+    ##                         deduplicate
+    ## @param      no_overlap  [Boolean] Remove items with
+    ##                         overlapping time spans
     ##
     def dedup(items, no_overlap: false)
       items.delete_if do |item|
@@ -817,17 +798,18 @@ module Doing
     end
 
     def delete_items(items, force: false)
-      res = force ? true : Prompt.yn("Delete #{items.size} #{items.size == 1 ? 'item' : 'items'}?", default_response: 'y')
-      if res
-        items.each do |i|
-          deleted = @content.delete_item(i, single: items.count == 1)
-          Hooks.trigger :post_entry_removed, self, deleted
-        end
-        write(@doing_file)
-      end
+      items.slice(0, 5).each { |i| puts i.to_pretty } unless force
+      puts softpurple("+ #{items.size - 5} additional #{'item'.to_p(items.size - 5)}") if items.size > 5 && !force
+
+      res = force ? true : Prompt.yn("Delete #{items.size} #{'item'.to_p(items.size)}?", default_response: 'y')
+      return unless res
+
+      items.each { |i| Hooks.trigger :post_entry_removed, self, @content.delete_item(i, single: items.count == 1) }
+      write(@doing_file)
     end
 
     def edit_items(items)
+      items.sort_by! { |i| i.date }
       editable_items = []
 
       items.each do |i|
@@ -836,16 +818,16 @@ module Doing
         editable += "\n#{old_note}" unless old_note.nil?
         editable_items << editable
       end
-      divider = "\n-----------\n"
+      divider = "-----------"
       notice =<<~EONOTICE
       # - You may delete entries, but leave all divider lines (---) in place.
       # - Start and @done dates replaced with a time string (yesterday 3pm) will
       #   be parsed automatically. Do not delete the pipe (|) between start date
       #   and entry title.
       EONOTICE
-      input =  "#{editable_items.map(&:strip).join(divider)}\n\n#{notice}"
+      input =  "#{editable_items.map(&:strip).join("\n#{divider}\n")}\n\n#{notice}"
 
-      new_items = fork_editor(input).split(/#{divider}/)
+      new_items = fork_editor(input).split(/^#{divider}/).map(&:strip)
 
       new_items.each_with_index do |new_item, i|
         input_lines = new_item.split(/[\n\r]+/).delete_if(&:ignore?)
@@ -854,7 +836,7 @@ module Doing
         if first_line.nil? || first_line =~ /^#{divider.strip}$/ || first_line.strip.empty?
           deleted = @content.delete_item(items[i], single: new_items.count == 1)
           Hooks.trigger :post_entry_removed, self, deleted
-          Doing.logger.count(:deleted)
+          Doing.logger.info('Deleted:', deleted.title)
         else
           date, title, note = format_input(new_item)
 
@@ -894,8 +876,8 @@ module Doing
         opt[:search] = search
       end
 
-      opt[:query] = opt[:search] if opt[:search] && !opt[:query]
-      opt[:query] = "!#{opt[:query]}" if opt[:not]
+      # opt[:query] = opt[:search] if opt[:search] && !opt[:query]
+      opt[:query] = "!#{opt[:query]}" if opt[:query] && opt[:not]
       opt[:multiple] = true
       opt[:show_if_single] = true
       filter_options = %i[after before case date_filter from fuzzy not search section val].each_with_object({}) {
@@ -982,8 +964,14 @@ module Doing
             type = action =~ /^add/ ? 'add' : 'remove'
             raise InvalidArgument, "'add tag' and 'remove tag' can not be used together" if opt[:tag]
 
-            print "#{yellow("Tag to #{type}: ")}#{reset}"
-            tag = $stdin.gets
+            tags = type == 'add' ? all_tags(@content) : all_tags(items)
+
+            puts "#{yellow}Separate multiple tags with spaces, hit tab to complete known tags#{type == 'add' ? ', include values with tag(value)' : ''}"
+            puts "#{boldgreen}Available tags: #{boldwhite}#{tags.sort.map(&:add_at).join(', ')}" if type == 'remove'
+            tag = Prompt.read_line(prompt: "Tags to #{type}", completions: tags)
+
+            # print "#{yellow("Tag to #{type}: ")}#{reset}"
+            # tag = $stdin.gets
             next if tag =~ /^ *$/
 
             opt[:tag] = tag.strip.sub(/^@/, '')
@@ -998,15 +986,16 @@ module Doing
                                                  '--no-sort',
                                                  '--info=hidden'
                                                ])
-            next if tag =~ /^ *$/
+            next if output_format =~ /^ *$/
 
             raise UserCancelled unless output_format
 
             opt[:output] = output_format.strip
             res = opt[:force] ? false : Prompt.yn('Save to file?', default_response: 'n')
             if res
-              print "#{yellow('File path/name: ')}#{reset}"
-              filename = $stdin.gets.strip
+              # print "#{yellow('File path/name: ')}#{reset}"
+              # filename = $stdin.gets.strip
+              filename = Prompt.read_line(prompt: 'File path/name')
               next if filename.empty?
 
               opt[:save_to] = filename
@@ -1086,6 +1075,7 @@ module Doing
         tag = opt[:tag]
         items.map! do |i|
           i.tag(tag, date: false, remove: opt[:remove], single: single)
+          i.expand_date_tags(@config['date_tags'])
           Hooks.trigger :post_entry_updated, self, i
         end
       end
@@ -1113,10 +1103,10 @@ module Doing
         i
       end
 
-      @content = Items.new
-      @content.concat(items)
-      @content.add_section(Section.new('Export'), log: false)
-      options = { section: 'Export' }
+      export_items = Items.new
+      export_items.concat(items)
+      export_items.add_section(Section.new('Export'), log: false)
+      options = { section: 'All' }
 
       if opt[:output] =~ /doing/
         options[:output] = 'template'
@@ -1126,7 +1116,7 @@ module Doing
         options[:template] = opt[:template] || nil
       end
 
-      output = list_section(options) # hooked
+      output = list_section(options, items: export_items) # hooked
 
       if opt[:save_to]
         file = File.expand_path(opt[:save_to])
@@ -1145,6 +1135,26 @@ module Doing
       end
     end
 
+    def verify_duration(date, finish_date, title: nil)
+      max_elapsed = @config.dig('interaction', 'confirm_longer_than') || 0
+      max_elapsed = max_elapsed.chronify_qty if max_elapsed.is_a?(String)
+      elapsed = finish_date - date
+
+      if max_elapsed.positive? && (elapsed > max_elapsed)
+        puts boldwhite(title) if title
+        human = elapsed.time_string(format: :natural)
+        res = Prompt.yn(yellow("Did this entry actually take #{human}"), default_response: true)
+        unless res
+          new_elapsed = Prompt.enter_text('How long did it take?').chronify_qty
+          raise InvalidTimeExpression, 'Unrecognized time span entry' unless new_elapsed.positive?
+
+          finish_date = date + new_elapsed if new_elapsed
+        end
+      end
+
+      finish_date
+    end
+
     ##
     ## Tag the last entry or X entries
     ##
@@ -1183,6 +1193,19 @@ module Doing
 
       raise NoResults, 'no items matched your search' if items.empty?
 
+      if opt[:tags].empty? && !opt[:autotag]
+        completions = opt[:remove] ? all_tags(items) : all_tags(@content)
+        if opt[:remove]
+          puts "#{yellow}Available tags: #{boldwhite}#{completions.map(&:add_at).join(', ')}"
+        else
+          puts "#{yellow}Use tab to complete known tags"
+        end
+        opt[:tags] = Doing::Prompt.read_line(prompt: "Enter tag(s) to #{opt[:remove] ? 'remove' : 'add'}",
+                                             completions: completions,
+                                             default_response: '').to_tags
+        raise UserCancelled, 'No tags provided' if opt[:tags].empty?
+      end
+
       items.each do |item|
         added = []
         removed = []
@@ -1206,21 +1229,8 @@ module Doing
                         else
                           next_entry.date - 60
                         end
-          elsif opt[:took]
-            if item.date + opt[:took] > Time.now
-              item.date = Time.now - opt[:took]
-              done_date = Time.now
-            else
-              done_date = item.date + opt[:took]
-            end
-          elsif opt[:back]
-            done_date = if opt[:back].is_a? Integer
-                          item.date + opt[:back]
-                        else
-                          item.date + (opt[:back] - item.date)
-                        end
           else
-            done_date = Time.now
+            done_date = item.calculate_end_date(opt)
           end
 
           opt[:tags].each do |tag|
@@ -1231,7 +1241,28 @@ module Doing
               next
             end
 
+
             tag = tag.strip
+
+            if tag =~ /^done$/
+              max_elapsed = @config.dig('interaction', 'confirm_longer_than') || 0
+              max_elapsed = max_elapsed.chronify_qty if max_elapsed.is_a?(String)
+              elapsed = done_date - item.date
+
+              if max_elapsed.positive? && (elapsed > max_elapsed) && !opt[:took]
+                puts boldwhite(item.title)
+                human = elapsed.time_string(format: :natural)
+                res = Prompt.yn(yellow("Did this actually take #{human}"), default_response: true)
+                unless res
+                  new_elapsed = Prompt.enter_text('How long did it take?').chronify_qty
+                  raise InvalidTimeExpression, 'Unrecognized time span entry' unless new_elapsed > 0
+
+                  opt[:took] = new_elapsed
+                  done_date = item.calculate_end_date(opt) if opt[:took]
+                end
+              end
+            end
+
             if opt[:remove] || opt[:rename] || opt[:value]
               rename_to = nil
               if opt[:value]
@@ -1269,6 +1300,7 @@ module Doing
           logger.warn('Skipped:', 'Archiving is skipped when operating on all entries')
         end
 
+        item.expand_date_tags(@config['date_tags'])
         Hooks.trigger :post_entry_updated, self, item
       end
 
@@ -1618,6 +1650,7 @@ module Doing
 
       opt[:output] ||= 'template'
       opt[:wrap_width] ||= @config['templates']['default']['wrap_width'] || 0
+
       output(items, title, is_single, opt)
     end
 
@@ -2002,7 +2035,7 @@ module Doing
 EOS
         sorted_tags_data.reverse.each do |k, v|
           if v > 0
-            output += "<tr><td style='text-align:left;'>#{k}</td><td style='text-align:left;'>#{'%02d:%02d:%02d' % format_time(v)}</td></tr>\n"
+            output += "<tr><td style='text-align:left;'>#{k}</td><td style='text-align:left;'>#{v.time_string(format: :clock)}</td></tr>\n"
           end
         end
         tail = <<EOS
@@ -2013,7 +2046,7 @@ EOS
         <tfoot>
         <tr>
           <td style="text-align:left;"><strong>Total</strong></td>
-          <td style="text-align:left;">#{'%02d:%02d:%02d' % format_time(total)}</td>
+          <td style="text-align:left;">#{total.time_string(format: :clock)}</td>
         </tr>
         </tfoot>
         </table>
@@ -2028,7 +2061,7 @@ EOS
         EOS
         sorted_tags_data.reverse.each do |k, v|
           if v > 0
-            output += "| #{' ' * (pad - k.length)}#{k} | #{'%02d:%02d:%02d' % format_time(v)} |\n"
+            output += "| #{' ' * (pad - k.length)}#{k} | #{v.time_string(format: :clock)} |\n"
           end
         end
         tail = "[Tag Totals]"
@@ -2036,11 +2069,10 @@ EOS
       when :json
         output = []
         sorted_tags_data.reverse.each do |k, v|
-          d, h, m = format_time(v)
           output << {
             'tag' => k,
             'seconds' => v,
-            'formatted' => format('%<d>02d:%<h>02d:%<m>02d', d: d, h: h, m: m)
+            'formatted' => v.time_string(format: :clock)
           }
         end
         output
@@ -2051,8 +2083,7 @@ EOS
           (max - k.length).times do
             spacer += ' '
           end
-          _d, h, m = format_time(v, human: true)
-          output.push("┃ #{spacer}#{k}:#{format('%<h> 4dh %<m>02dm', h: h, m: m)} ┃")
+          output.push("┃ #{spacer}#{k}:#{v.time_string(format: :hm)} ┃")
         end
 
         header = '┏━━ Tag Totals '
@@ -2065,14 +2096,14 @@ EOS
         (max + 12).times { divider += '━' }
         divider += '┫'
         output = output.empty? ? '' : "\n#{header}\n#{output.join("\n")}"
-        d, h, m = format_time(total, human: true)
         output += "\n#{divider}"
         spacer = ''
         (max - 6).times do
           spacer += ' '
         end
+        total_time = total.time_string(format: :hm)
         total = "┃ #{spacer}total: "
-        total += format('%<h> 4dh %<m>02dm', h: h, m: m)
+        total += total_time
         total += ' ┃'
         output += "\n#{total}"
         output += "\n#{footer}"
@@ -2084,13 +2115,11 @@ EOS
           (max - k.length).times do
             spacer += ' '
           end
-          d, h, m = format_time(v)
-          output.push("#{k}:#{spacer}#{format('%<d>02d:%<h>02d:%<m>02d', d: d, h: h, m: m)}")
+          output.push("#{k}:#{spacer}#{v.time_string(format: :clock)}")
         end
 
         output = output.empty? ? '' : "\n--- Tag Totals ---\n#{output.join("\n")}"
-        d, h, m = format_time(total)
-        output += "\n\nTotal tracked: #{format('%<d>02d:%<h>02d:%<m>02d', d: d, h: h, m: m)}\n"
+        output += "\n\nTotal tracked: #{total.time_string(format: :clock)}\n"
         output
       end
     end
@@ -2115,39 +2144,19 @@ EOS
         record_tag_times(item, seconds) if record
         return seconds.positive? ? seconds : false unless formatted
 
-        return seconds.positive? ? format('%02d:%02d:%02d', *format_time(seconds)) : false
+        return seconds.positive? ? seconds.time_string(format: :clock) : false
       end
 
       false
     end
 
     ##
-    ## Format human readable time from seconds
+    ## Load configuration files and updated the @config
+    ## attribute with a Doing::Configuration object
     ##
-    ## @param      seconds  [Integer] Seconds
+    ## @param      filename  [String] (optional) path to
+    ##                       alternative config file
     ##
-    def format_time(seconds, human: false)
-      return [0, 0, 0] if seconds.nil?
-
-      if seconds.instance_of?(String) && seconds =~ /(\d+):(\d+):(\d+)/
-        h = Regexp.last_match(1)
-        m = Regexp.last_match(2)
-        s = Regexp.last_match(3)
-        seconds = (h.to_i * 60 * 60) + (m.to_i * 60) + s.to_i
-      end
-      minutes = (seconds / 60).to_i
-      hours = (minutes / 60).to_i
-      if human
-        minutes = (minutes % 60).to_i
-        [0, hours, minutes]
-      else
-        days = (hours / 24).to_i
-        hours = (hours % 24).to_i
-        minutes = (minutes % 60).to_i
-        [days, hours, minutes]
-      end
-    end
-
     def configure(filename = nil)
       if filename
         Doing.config_with(filename, { ignore_local: true })
@@ -2227,6 +2236,8 @@ EOS
         break
       end
 
+      logger.debug('Output:', "#{items.count} #{items.count == 1 ? 'item' : 'items'} shown")
+
       out
     end