doing 2.1.21 → 2.1.25

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

@@ -86,102 +86,11 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>, <span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span>, <span class='object_link'><a href="Numeric.html" title="Numeric (class)">Numeric</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>, <span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span>, <span class='object_link'><a href="Time.html" title="Time (class)">Time</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>, <span class='object_link'><a href="FalseClass.html" title="FalseClass (class)">FalseClass</a></span>, <span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span>, <span class='object_link'><a href="Numeric.html" title="Numeric (class)">Numeric</a></span>, <span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>, <span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span>, <span class='object_link'><a href="Time.html" title="Time (class)">Time</a></span>, <span class='object_link'><a href="TrueClass.html" title="TrueClass (class)">TrueClass</a></span>
     
   
 </p>
 
-  
-    <h2>
-      Constant Summary
-      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-    </h2>
-
-    <dl class="constants">
-      
-        <dt id="REGEX_BOOL-constant" class="">REGEX_BOOL =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$</span><span class='regexp_end'>/i</span></span></pre></dd>
-      
-        <dt id="REGEX_SORT_ORDER-constant" class="">REGEX_SORT_ORDER =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^(?:a(?:sc)?|d(?:esc)?)$</span><span class='regexp_end'>/i</span></span></pre></dd>
-      
-        <dt id="REGEX_VALUE_QUERY-constant" class="">REGEX_VALUE_QUERY =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^(?:!)?@?(?:\S+) +(?:!?[&lt;&gt;=][=*]?|[$*^]=) +(?:.*?)$</span><span class='regexp_end'>/</span></span></pre></dd>
-      
-        <dt id="REGEX_CLOCK-constant" class="">REGEX_CLOCK =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon)</span><span class='tstring_end'>&#39;</span></span></pre></dd>
-      
-        <dt id="REGEX_TIME-constant" class="">REGEX_TIME =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="top-level-namespace.html#REGEX_CLOCK-constant" title="REGEX_CLOCK (constant)">REGEX_CLOCK</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>$</span><span class='regexp_end'>/i</span></span></pre></dd>
-      
-        <dt id="REGEX_DAY-constant" class="">REGEX_DAY =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^(mon|tue|wed|thur?|fri|sat|sun)(\w+(day)?)?$</span><span class='regexp_end'>/i</span></span></pre></dd>
-      
-        <dt id="REGEX_RANGE_INDICATOR-constant" class="">REGEX_RANGE_INDICATOR =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> +(?:to|through|thru|(?:un)?til|-+) +</span><span class='tstring_end'>&#39;</span></span></pre></dd>
-      
-        <dt id="REGEX_RANGE-constant" class="">REGEX_RANGE =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\S+</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="top-level-namespace.html#REGEX_RANGE_INDICATOR-constant" title="REGEX_RANGE_INDICATOR (constant)">REGEX_RANGE_INDICATOR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>+\S+</span><span class='regexp_end'>/i</span></span></pre></dd>
-      
-        <dt id="REGEX_TIME_RANGE-constant" class="">REGEX_TIME_RANGE =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="top-level-namespace.html#REGEX_CLOCK-constant" title="REGEX_CLOCK (constant)">REGEX_CLOCK</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="top-level-namespace.html#REGEX_RANGE_INDICATOR-constant" title="REGEX_RANGE_INDICATOR (constant)">REGEX_RANGE_INDICATOR</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="top-level-namespace.html#REGEX_CLOCK-constant" title="REGEX_CLOCK (constant)">REGEX_CLOCK</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>$</span><span class='regexp_end'>/i</span></span></pre></dd>
-      
-        <dt id="InvalidExportType-constant" class="">InvalidExportType =
-          
-        </dt>
-        <dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>RuntimeError</span><span class='rparen'>)</span></pre></dd>
-      
-        <dt id="MissingConfigFile-constant" class="">MissingConfigFile =
-          
-        </dt>
-        <dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>RuntimeError</span><span class='rparen'>)</span></pre></dd>
-      
-        <dt id="TagArray-constant" class="">TagArray =
-          
-        </dt>
-        <dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></span><span class='rparen'>)</span></pre></dd>
-      
-        <dt id="DateBeginString-constant" class="">DateBeginString =
-          
-        </dt>
-        <dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>DateTime</span><span class='rparen'>)</span></pre></dd>
-      
-        <dt id="DateEndString-constant" class="">DateEndString =
-          
-        </dt>
-        <dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>DateTime</span><span class='rparen'>)</span></pre></dd>
-      
-        <dt id="DateRangeString-constant" class="">DateRangeString =
-          
-        </dt>
-        <dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></span><span class='rparen'>)</span></pre></dd>
-      
-        <dt id="DateIntervalString-constant" class="">DateIntervalString =
-          
-        </dt>
-        <dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>DateTime</span><span class='rparen'>)</span></pre></dd>
-      
-    </dl>
-  
-
 
 
 
@@ -193,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 20 12:10:33 2022 by
+  Generated on Sun Jan 23 09:24:04 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/docs/index.md

@@ -8,7 +8,7 @@ _If you're one of the rare people like me who find this useful, feel free to
 
 
 
-The current version of `doing` is 2.1.13.
+The current version of `doing` is 2.1.21.
 
 Find all of the documentation in the [doing wiki][wiki].
 

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.21
+v2.1.25
 
 === Global Options
 === --config_file arg
@@ -32,7 +32,7 @@ Verbose output
 
 
 
-=== --[no-]default
+=== --default
 Answer yes/no menus with default option
 
 
@@ -165,7 +165,7 @@ Prompt for note via multi-line input
 
 
 ===== -e|--editor
-Edit duplicated entry with vim before adding
+Edit duplicated entry with /opt/homebrew/bin/vim before adding
 
 
 
@@ -403,10 +403,37 @@ Force exact search string matching (case sensitive)
 
 
 
-==== Command: <tt>changelog|changes </tt>
+==== Command: <tt>changes|changelog </tt>
 List recent changes in Doing
 
-Display a formatted list of changes in recent versions, latest at the top
+Display a formatted list of changes in recent versions.
+
+            Without flags, displays only the most recent version.
+            Use --lookup or --all for history.
+===== Options
+===== -l|--lookup VERSION
+
+Look up a specific version. Specify versions as "MAJ.MIN.PATCH", MIN
+           and PATCH are optional. Use > or < to see all changes since or prior
+           to a version.
+
+[Default Value] None
+[Must Match] (?-mix:^(?:(?:(?:[<>=]|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[\d.*?]+ *)+|(?:[\d.]+ *-+ *[\d.]+))$)
+
+
+===== -s|--search arg
+
+Show changelogs matching search terms (uses pattern-based searching).
+           Add slashes to search with regular expressions, e.g. `--search "/output.*flag/"`
+
+[Default Value] None
+
+
+===== -a|--all
+Display all versions
+
+
+
 ==== Command: <tt>choose </tt>
 Select a section to display from a menu
 
@@ -528,7 +555,7 @@ Update default config file, adding any missing keys
 
 
 [Default Command] edit
-==== Command: <tt>done|did  ENTRY</tt>
+==== Command: <tt>done|did  [ENTRY]</tt>
 Add a completed item with @done(date). No argument finishes last entry
 
 Use this command to add an entry after you've already finished it. It will be immediately marked as @done.
@@ -598,7 +625,7 @@ Include date
 
 
 ===== -e|--editor
-Edit entry with vim (with no arguments, edits the last entry)
+Edit entry with /opt/homebrew/bin/vim (with no arguments, edits the last entry)
 
 
 
@@ -612,7 +639,7 @@ Finish last entry not already marked @done
 
 
 
-==== Command: <tt>finish  COUNT</tt>
+==== Command: <tt>finish  [COUNT]</tt>
 Mark last X entries as @done
 
 Marks the last X entries with a @done tag and current date. Does not alter already completed entries.
@@ -763,6 +790,13 @@ Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart
 [Must Match] (?-mix:^[csi])
 
 
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] default
+
+
 ===== --from DATE_OR_RANGE
 
 Date range to show, or a single day to filter date on.
@@ -797,6 +831,13 @@ Sort tags by (name|time)
 [Must Match] (?i-mx:^(?:name|time)$)
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --val QUERY
 
 Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool
@@ -816,7 +857,7 @@ Show elapsed time on entries without @done tag
 
 
 ===== -e|--editor
-Edit matching entries with vim
+Edit matching entries with /opt/homebrew/bin/vim
 
 
 
@@ -983,6 +1024,13 @@ Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart
 [Must Match] (?-mix:^[csi])
 
 
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] last
+
+
 ===== -s|--section NAME
 
 Specify a section
@@ -1004,6 +1052,13 @@ Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?)
 [Default Value] None
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --val QUERY
 
 Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool
@@ -1023,7 +1078,7 @@ Show elapsed time if entry is not tagged @done
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with /opt/homebrew/bin/vim
 
 
 
@@ -1067,7 +1122,7 @@ Prompt for note via multi-line input
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with /opt/homebrew/bin/vim
 
 
 
@@ -1165,7 +1220,7 @@ Force exact search string matching (case sensitive)
 
 
 
-==== Command: <tt>meanwhile  ENTRY</tt>
+==== Command: <tt>meanwhile  [ENTRY]</tt>
 Finish any running @meanwhile tasks and optionally create a new one
 
 The @meanwhile tag allows you to have long-running entries that encompass smaller entries.
@@ -1205,11 +1260,11 @@ Prompt for note via multi-line input
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with /opt/homebrew/bin/vim
 
 
 
-==== Command: <tt>note  NOTE_TEXT</tt>
+==== Command: <tt>note  [NOTE_TEXT]</tt>
 Add a note to the last entry
 
 If -r is provided with no other arguments, the last note is removed.
@@ -1269,7 +1324,7 @@ Prompt for note via multi-line input
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with /opt/homebrew/bin/vim
 
 
 
@@ -1302,7 +1357,7 @@ A parenthetical at the end of the entry will be converted to a note.
 
 Run without arguments to create a new entry interactively.
 
-Run with --editor to create a new entry using vim.
+Run with --editor to create a new entry using /opt/homebrew/bin/vim.
 ===== Options
 ===== -b|--back|--started DATE_STRING
 
@@ -1311,6 +1366,14 @@ Backdate start time [4pm|20m|2h|"yesterday noon"]
 [Default Value] None
 
 
+===== --from TIME_RANGE
+
+Set a start and optionally end time as a date range ("from 1pm to 2:30pm").
+        If an end time is provided, a dated @done tag will be added
+
+[Default Value] None
+
+
 ===== -n|--note TEXT
 
 Include a note
@@ -1331,7 +1394,7 @@ Prompt for note via multi-line input
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with /opt/homebrew/bin/vim
 
 
 
@@ -1347,6 +1410,13 @@ Date argument can be natural language. "thursday" would be interpreted as "last
 and "2d" would be interpreted as "two days ago." If you use "to" or "through" between two dates,
 it will create a range.
 ===== Options
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] default
+
+
 ===== -o|--output FORMAT
 
 Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|json|markdown|say|taskpaper|template|timeline|wiki)
@@ -1369,6 +1439,13 @@ Sort tags by (name|time)
 [Must Match] (?i-mx:^(?:name|time)$)
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --[no-]duration
 Show elapsed time on entries without @done tag
 
@@ -1388,7 +1465,7 @@ Show time totals at the end of output
 Open the "doing" file in an editor
 
 `doing open` defaults to using the editors->doing_file setting
-in /Users/ttscoff/.config/doing/config.yml (TaskPaper).
+in /Users/ttscoff/.config/doing/config.yml (/opt/homebrew/bin/vim).
 ===== Options
 ===== -a|--app APP_NAME
 
@@ -1438,6 +1515,13 @@ List recent entries
 
 
 ===== Options
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] recent
+
+
 ===== -s|--section NAME
 
 Section
@@ -1453,6 +1537,13 @@ Sort tags by (name|time)
 [Must Match] (?i-mx:^(?:name|time)$)
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --[no-]duration
 Show elapsed time on entries without @done tag
 
@@ -1473,7 +1564,7 @@ Show intervals with totals at the end of output
 
 
 
-==== Command: <tt>reset|begin  DATE_STRING</tt>
+==== Command: <tt>reset|begin  [DATE_STRING]</tt>
 Reset the start time of an entry
 
 Update the start time of the last entry or the last entry matching a tag/search filter.
@@ -1530,6 +1621,11 @@ Select from a menu of matching entries
 
 
 
+===== -n
+Change start date but do not remove @done (shortcut for --no-resume)
+
+
+
 ===== --not
 Reset items that *don't* match search/tag filters
 
@@ -1856,6 +1952,13 @@ Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart
 [Must Match] (?-mix:^[csi])
 
 
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] default
+
+
 ===== --from DATE_OR_RANGE
 
 Date range to show, or a single day to filter date on.
@@ -1913,6 +2016,13 @@ Sort tags by (name|time)
 [Must Match] (?i-mx:^(?:name|time))
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --val QUERY
 
 Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool
@@ -1972,6 +2082,13 @@ List entries since a date
 Date argument can be natural language and are always interpreted as being in the past. "thursday" would be interpreted as "last thursday,"
 and "2d" would be interpreted as "two days ago."
 ===== Options
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] default
+
+
 ===== -o|--output FORMAT
 
 Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|json|markdown|say|taskpaper|template|timeline|wiki)
@@ -1994,6 +2111,13 @@ Sort tags by (name|time)
 [Must Match] (?i-mx:^(?:name|time)$)
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --[no-]duration
 Show elapsed time on entries without @done tag
 
@@ -2151,7 +2275,7 @@ Remove all default_tags from the local .doingrc
 
 
 
-==== Command: <tt>tags </tt>
+==== Command: <tt>tags  [MAX_COUNT]</tt>
 List all tags in the current Doing file
 
 
@@ -2228,6 +2352,11 @@ Select items to scan from a menu of matching entries
 
 
 
+===== -l|--[no-]line
+Output in a single line with @ symbols. Ignored if --counts is specified.
+
+
+
 ===== --not
 Get tags from items that *don't* match search/tag filters
 
@@ -2290,6 +2419,13 @@ View entries before specified time (e.g. 8am, 12:30pm, 15:00)
 [Default Value] None
 
 
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] today
+
+
 ===== --from TIME_RANGE
 
 Time range to show `doing today --from "12pm to 4pm"`
@@ -2319,6 +2455,13 @@ Sort tags by (name|time)
 [Must Match] (?i-mx:^(?:name|time)$)
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --[no-]duration
 Show elapsed time on entries without @done tag
 
@@ -2618,6 +2761,13 @@ View entries before specified time (e.g. 8am, 12:30pm, 15:00)
 [Default Value] None
 
 
+===== --config_template TEMPLATE_KEY
+
+Output using a template from configuration
+
+[Default Value] today
+
+
 ===== --from TIME_RANGE
 
 Time range to show, e.g. `doing yesterday --from "1am to 8am"`
@@ -2656,6 +2806,13 @@ Sort tags by (name|time)
 [Must Match] (?i-mx:^(?:name|time)$)
 
 
+===== --template TEMPLATE_STRING
+
+Override output format with a template string containing %placeholders
+
+[Default Value] None
+
+
 ===== --[no-]duration
 Show elapsed time on entries without @done tag
 

data/example_plugin.rb

@@ -123,7 +123,7 @@ module Doing
     ## @return     [String] Rendered output
     ##
     def self.render(wwid, items, variables: {})
-      return if items.nil? || items.empty?
+      return unless items.good?
 
       # the :options key includes the flags passed to the
       # command that called the plugin use `puts
@@ -164,7 +164,7 @@ module Doing
 
       if wwid.config['export_templates'].key?('say')
         cfg_tpl = wwid.config['export_templates']['say']
-        tpl = cfg_tpl unless cfg_tpl.nil? || cfg_tpl.empty?
+        tpl = cfg_tpl if cfg_tpl.good?
       end
       output = tpl.dup
       output.gsub!(/%date/, date)