doing 2.1.15 → 2.1.16

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

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Jan 17 08:01:48 2022 by
+  Generated on Tue Jan 18 02:48:57 2022 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.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.15
+v2.1.16
 
 === Global Options
 === --config_file arg
@@ -528,10 +528,10 @@ Use this command to add an entry after you've already finished it. It will be im
 You can modify the start and end times of the entry using the --back, --took, and --at flags, making it an easy
 way to add entries in post and maintain accurate (albeit manual) time tracking.
 ===== Options
-===== --at DATE_STRING
+===== --at|--finished DATE_STRING
 
 Set finish date to specific date/time (natural langauge parsed, e.g. --at=1:30pm).
-  If used, ignores --back. Used with --took, backdates start date
+  Used with --took, backdates start date
 
 [Default Value] None
 
@@ -543,6 +543,14 @@ Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]
 [Default Value] None
 
 
+===== --from TIME_RANGE
+
+Start and end times as a date/time range `doing done --from "1am to 8am"`.
+        Overrides other date flags.
+
+[Default Value] None
+
+
 ===== -n|--note TEXT
 
 Include a note
@@ -1274,7 +1282,9 @@ Record what you're starting now, or backdate the start time using natural langua
 
 A parenthetical at the end of the entry will be converted to a note.
 
-Run with no argument to create a new entry using vim.
+Run without arguments to create a new entry interactively.
+
+Run with --editor to create a new entry using vim.
 ===== Options
 ===== -b|--back|--started DATE_STRING
 

data/lib/completion/_doing.zsh

@@ -106,10 +106,10 @@ function _doing() {
                 args=( {-d,--dump}"[DEPRECATED]" {-u,--update}"[DEPRECATED]" )
             ;;
             done) 
-                args=( {-a,--archive}"[Immediately archive the entry]" "(--ask)--ask}[Prompt for note via multi-line input]" "(--at=)--at=}[Set finish date to specific date/time]" "(--started=)--started=}[Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]]" "(--date)--date}[Include date]" {-e,--editor}"[Edit entry with vim]" {-n,--note=}"[Include a note]" {-r,--remove}"[Remove @done tag]" {-s,--section=}"[Section]" "(--for=)--for=}[Set completion date to start date plus interval]" {-u,--unfinished}"[Finish last entry not already marked @done]" )
+                args=( {-a,--archive}"[Immediately archive the entry]" "(--ask)--ask}[Prompt for note via multi-line input]" "(--finished=)--finished=}[Set finish date to specific date/time]" "(--started=)--started=}[Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]]" "(--date)--date}[Include date]" {-e,--editor}"[Edit entry with vim]" "(--from=)--from=}[Start and end times as a date/time range `doing done --from "1am to 8am"`]" {-n,--note=}"[Include a note]" {-r,--remove}"[Remove @done tag]" {-s,--section=}"[Section]" "(--for=)--for=}[Set completion date to start date plus interval]" {-u,--unfinished}"[Finish last entry not already marked @done]" )
             ;;
             did) 
-                args=( {-a,--archive}"[Immediately archive the entry]" "(--ask)--ask}[Prompt for note via multi-line input]" "(--at=)--at=}[Set finish date to specific date/time]" "(--started=)--started=}[Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]]" "(--date)--date}[Include date]" {-e,--editor}"[Edit entry with vim]" {-n,--note=}"[Include a note]" {-r,--remove}"[Remove @done tag]" {-s,--section=}"[Section]" "(--for=)--for=}[Set completion date to start date plus interval]" {-u,--unfinished}"[Finish last entry not already marked @done]" )
+                args=( {-a,--archive}"[Immediately archive the entry]" "(--ask)--ask}[Prompt for note via multi-line input]" "(--finished=)--finished=}[Set finish date to specific date/time]" "(--started=)--started=}[Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]]" "(--date)--date}[Include date]" {-e,--editor}"[Edit entry with vim]" "(--from=)--from=}[Start and end times as a date/time range `doing done --from "1am to 8am"`]" {-n,--note=}"[Include a note]" {-r,--remove}"[Remove @done tag]" {-s,--section=}"[Section]" "(--for=)--for=}[Set completion date to start date plus interval]" {-u,--unfinished}"[Finish last entry not already marked @done]" )
             ;;
             finish) 
                 args=( {-a,--archive}"[Archive entries]" "(--at=)--at=}[Set finish date to specific date/time]" "(--auto)--auto}[Auto-generate finish dates from next entrys start times start time]" {-b,--back=}"[Backdate completed date to date string [4pm|20m|2h|yesterday noon]]" "(--bool=)--bool=}[Boolean]" "(--case=)--case=}[Case sensitivity for search string matching [(c)ase-sensitive]" "(--date)--date}[Include date]" {-i,--interactive}"[Select item(s) to finish from a menu of matching entries]" "(--not)--not}[Finish items that *dont* match search/tag filterst* match search/tag filters]" {-r,--remove}"[Remove done tag]" {-s,--section=}"[Section]" "(--search=)--search=}[Finish the last X entries matching search filter]" "(--for=)--for=}[Set the completed date to the start date plus XX[hmd]]" "(--tag=)--tag=}[Finish the last X entries containing TAG]" {-u,--unfinished}"[Finish last entry]" "(--val=)--val=}[Perform a tag value query]" {-x,--exact}"[Force exact search string matching]" )

data/lib/completion/doing.bash

@@ -81,9 +81,9 @@ _doing_config() {
 _doing_done() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--archive --ask --at --started --date --editor --note --remove --section --for --unfinished' -- $token ) )
+    COMPREPLY=( $( compgen -W '--archive --ask --finished --started --date --editor --from --note --remove --section --for --unfinished' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-a -e -n -r -s -u --archive --ask --at --started --date --editor --note --remove --section --for --unfinished' -- $token ) )
+    COMPREPLY=( $( compgen -W '-a -e -n -r -s -u --archive --ask --finished --started --date --editor --from --note --remove --section --for --unfinished' -- $token ) )
   
   fi
 }

data/lib/completion/doing.fish

@@ -148,10 +148,11 @@ complete -c doing -l dump -s d -f  -n '__fish_doing_using_command config' -d DEP
 complete -c doing -l update -s u -f  -n '__fish_doing_using_command config' -d DEPRECATED
 complete -c doing -l archive -s a -f  -n '__fish_doing_using_command done did' -d Immediately\ archive\ the\ entry
 complete -c doing -l ask  -f  -n '__fish_doing_using_command done did' -d Prompt\ for\ note\ via\ multi-line\ input
-complete -c doing -l at  -f -r -n '__fish_doing_using_command done did' -d Set\ finish\ date\ to\ specific\ date/time
+complete -c doing -l finished  -f -r -n '__fish_doing_using_command done did' -d Set\ finish\ date\ to\ specific\ date/time
 complete -c doing -l started  -f -r -n '__fish_doing_using_command done did' -d Backdate\ start\ date\ by\ interval\ or\ set\ to\ time\ \[4pm\|20m\|2h\|\"yesterday\ noon\"\]
 complete -c doing -l date  -f  -n '__fish_doing_using_command done did' -d Include\ date
 complete -c doing -l editor -s e -f  -n '__fish_doing_using_command done did' -d Edit\ entry\ with\ vim
+complete -c doing -l from  -f -r -n '__fish_doing_using_command done did' -d Start\ and\ end\ times\ as\ a\ date/time\ range\ \`doing\ done\ --from\ \"1am\ to\ 8am\"\`
 complete -c doing -l note -s n -f -r -n '__fish_doing_using_command done did' -d Include\ a\ note
 complete -c doing -l remove -s r -f  -n '__fish_doing_using_command done did' -d Remove\ @done\ tag
 complete -c doing -l section -s s -f -r -n '__fish_doing_using_command done did' -d Section

data/lib/doing/prompt.rb

@@ -23,6 +23,47 @@ module Doing
         $stdin.gets.strip
       end
 
+      def read_line(prompt: 'Enter text', completions: [], default_response: '')
+        return default_response if @default_answer
+
+        unless completions.empty?
+          completions.sort!
+          comp = proc { |s| completions.grep(/^#{Regexp.escape(s)}/) }
+          Readline.completion_append_character = " "
+          Readline.completion_proc = comp
+        end
+
+        begin
+          Readline.readline("#{yellow(prompt).sub(/:?$/, ':')} #{reset}", true).strip
+        rescue Interrupt
+          raise UserCancelled
+        end
+      end
+
+      def read_lines(prompt: 'Enter text', completions: [])
+        return default_response if @default_answer
+
+        completions.sort!
+        comp = proc { |s| completions.grep(/^#{Regexp.escape(s)}/) }
+        Readline.completion_append_character = " "
+        Readline.completion_proc = comp
+
+        puts "#{boldgreen(prompt.sub(/:?$/, ':'))} #{yellow('Hit return for a new line, ')}#{boldwhite('enter a blank line (')}#{boldyellow('return twice')}#{boldwhite(') to end editing')}"
+
+        res = []
+
+        begin
+          while line = Readline.readline('> ', true)
+            break if line.strip.empty?
+            res << line.chomp
+          end
+        rescue Interrupt
+          raise UserCancelled
+        end
+
+        res.join("\n").strip
+      end
+
       def request_lines(prompt: 'Enter text')
         ask_note = []
         reader = TTY::Reader.new(interrupt: -> { raise Errors::UserCancelled }, track_history: false)

data/lib/doing/string_chronify.rb

@@ -151,5 +151,33 @@ module Doing
         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/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.15'
+  VERSION = '2.1.16'
 end

data/lib/doing/wwid.rb

@@ -187,6 +187,8 @@ module Doing
       iso_rx = /\d{4}-\d\d-\d\d \d\d:\d\d/
       date_rx = /^(?:\s*- )?(?<date>.*?) \| (?=\S)/
 
+      raise EmptyInput, 'No content' if title.sub(/^.*?\| */, '').strip.empty?
+
       title.expand_date_tags(@config['date_tags'])
 
       if title =~ date_rx
@@ -807,6 +809,7 @@ module Doing
     end
 
     def edit_items(items)
+      items.sort_by! { |i| i.date }
       editable_items = []
 
       items.each do |i|
@@ -815,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?)
@@ -833,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)
 
@@ -961,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(/^@/, '')
@@ -984,8 +993,9 @@ module Doing
             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
@@ -1093,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'
@@ -1106,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])
@@ -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 = []
@@ -2126,6 +2149,13 @@ EOS
       false
     end
 
+    ##
+    ## Load configuration files and updated the @config
+    ## attribute with a Doing::Configuration object
+    ##
+    ## @param      filename  [String] (optional) path to
+    ##                       alternative config file
+    ##
     def configure(filename = nil)
       if filename
         Doing.config_with(filename, { ignore_local: true })

data/lib/doing.rb

@@ -10,6 +10,11 @@ require 'tempfile'
 require 'zlib'
 require 'base64'
 require 'plist'
+require 'readline'
+require 'haml'
+require 'json'
+require 'logger'
+require 'safe_yaml/load'
 
 require 'chronic'
 require 'tty-link'
@@ -17,10 +22,6 @@ require 'tty-which'
 require 'tty-markdown'
 require 'tty-reader'
 require 'tty-screen'
-require 'haml'
-require 'json'
-require 'logger'
-require 'safe_yaml/load'
 
 require_relative 'doing/hash'
 require_relative 'doing/colors'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 2.1.15
+  version: 2.1.16
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml