doing 2.0.23 → 2.1.1pre

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 18 16:39:11 2021 by
+  Generated on Sat Nov 27 13:57:12 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

@@ -31,10 +31,13 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency 'redcarpet', '~> 3.5', '>= 3.5.1'
   s.add_development_dependency 'github-markup', '~> 4.0', '>= 4.0.0'
   s.add_development_dependency 'parallel_tests', '~> 3.7', '>= 3.7.3'
+  s.add_development_dependency 'tty-spinner', '~> 0.9', '>= 0.9.3'
   s.add_runtime_dependency('tty-progressbar', '~> 0.18', '>= 0.18.2')
   s.add_runtime_dependency('gli', '~> 2.19', '>= 2.19.2')
   s.add_runtime_dependency('haml','~>5.0.0', '>= 5.0.0')
   s.add_runtime_dependency('chronic','~> 0.10', '>= 0.10.2')
   s.add_runtime_dependency('deep_merge', '~> 1.2', '>= 1.2.1')
+  s.add_runtime_dependency('tty-link', '~> 0.1', '>= 0.1.1')
+  s.add_runtime_dependency('tty-which', '~> 0.5', '>= 0.5.0')
   # s.add_runtime_dependency('amatch', '~> 0.4', '>= 0.4.0')
 end

data/doing.rdoc

@@ -5,14 +5,14 @@ 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.0.23
+v2.1.1pre
 
 === Global Options
 === --config_file arg
 
 Use a specific configuration file. Deprecated, set $DOING_CONFIG instead.
 
-[Default Value] /Users/ttscoff/.doingrc
+[Default Value] /Users/ttscoff/.config/doing/config.yml
 
 
 === -f|--doing_file arg
@@ -42,6 +42,11 @@ Show this message
 
 
 
+=== --no
+Answer all yes/no menus with no
+
+
+
 === --[no-]notes
 Output notes if included in the template
 
@@ -72,6 +77,11 @@ Exclude auto tags and default tags
 
 
 
+=== --yes
+Answer all yes/no menus with yes
+
+
+
 === Commands
 ==== Command: <tt>add_section  SECTION_NAME</tt>
 Add a new section to the "doing" file
@@ -135,7 +145,7 @@ Repeat last entry matching tags. Combine multiple tags with a comma.
 
 
 ===== -e|--editor
-Edit duplicated entry with vim before adding
+Edit duplicated entry with emacs -nw before adding
 
 
 
@@ -385,63 +395,98 @@ Shell to generate for (bash, zsh, fish)
 [Must Match] (?i-mx:^[bzf](?:[ai]?sh)?$)
 
 
-==== Command: <tt>config  KEY_PATH</tt>
+==== Command: <tt>config </tt>
 Edit the configuration file or output a value from it
 
-Run without arguments, `doing config` opens your `.doingrc` in an editor.
+Run without arguments, `doing config` opens your `config.yml` in an editor.
 If local configurations are found in the path between the current directory
-and `~/.doingrc`, a menu will allow you to select which to open in the editor.
+and the root (/), a menu will allow you to select which to open in the editor.
 
 It will use the editor defined in `config_editor_app`, or one specified with `--editor`.
 
-Use `doing config -d` to output the configuration to the terminal, and
+Use `doing config get` to output the configuration to the terminal, and
 provide a dot-separated key path to get a specific value. Shows the current value
 including keys/overrides set by local configs.
 ===== Options
-===== -a APP_NAME
+===== -d|--[no-]dump
+DEPRECATED
+
+
+
+===== -u|--[no-]update
+DEPRECATED
+
+
+
+===== Commands
+====== Command: <tt>edit </tt>
+Open config file in editor
+
+
+======= Options
+======= -a|--app APP_NAME
 
 Application to use
 
 [Default Value] None
 
 
-===== -b BUNDLE_ID
+======= -b|--bundle_id BUNDLE_ID
 
 Application bundle id to use
 
 [Default Value] None
 
 
-===== -e|--editor EDITOR
+======= -e|--editor EDITOR
 
 Editor to use
 
 [Default Value] None
 
 
-===== -o|--output FORMAT
+======= -x|--[no-]default
+Use the config_editor_app defined in ~/.config/doing/config.yml (config_editor_app not set)
+
+
+
+====== Command: <tt>get|dump </tt>
+Output a key's value
+
+
+======= Options
+======= -o|--output FORMAT
 
-Format for --dump (json|yaml|raw)
+Format for output (json|yaml|raw)
 
 [Default Value] yaml
 [Must Match] (?-mix:^(?:y(?:aml)?|j(?:son)?|r(?:aw)?)$)
 
 
-===== -d|--dump
-Show a config key value based on arguments. Separate key paths with colons or dots, e.g. "export_templates.html". Empty arguments outputs the entire config.
+====== Command: <tt>list </tt>
+List configuration paths, including .doingrc files in the current and parent directories
 
+Config files are listed in order of precedence (if there are multiple configs detected).
+  Values defined in the top item in the list will override values in configutations below it.
+====== Command: <tt>set </tt>
+Set a key's value in the config file
 
 
-===== -u|--update
-Update config file with missing configuration options
+======= Options
+======= -r|--remove
+Delete specified key
 
 
 
-===== -x
-Use the config_editor_app defined in ~/.doingrc (config_editor_app not set)
+====== Command: <tt>undo </tt>
+Undo the last change to a config file
 
 
+====== Command: <tt>update|refresh </tt>
+Update default config file, adding any missing keys
 
+
+[Default Command] edit
 ==== Command: <tt>done|did  ENTRY</tt>
 Add a completed item with @done(date). No argument finishes last entry.
 
@@ -455,9 +500,9 @@ Set finish date to specific date/time (natural langauge parsed, e.g. --at=1:30pm
 [Default Value] None
 
 
-===== -b|--back DATE_STRING
+===== -b|--back|--started DATE_STRING
 
-Backdate start date by interval [4pm|20m|2h|yesterday noon]
+Backdate start date by interval or set to time [4pm|20m|2h|"yesterday noon"]
 
 [Default Value] None
 
@@ -496,7 +541,7 @@ Include date
 
 
 ===== -e|--editor
-Edit entry with vim (with no arguments, edits the last entry)
+Edit entry with emacs -nw (with no arguments, edits the last entry)
 
 
 
@@ -625,14 +670,14 @@ To search with regular expressions, single quote the string and surround with sl
 ===== Options
 ===== --after DATE_STRING
 
-Constrain search to entries newer than date
+Search entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
 
 [Default Value] None
 
 
 ===== --before DATE_STRING
 
-Constrain search to entries older than date
+Search entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
 
 [Default Value] None
 
@@ -645,6 +690,18 @@ Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart
 [Must Match] (?-mix:^[csi])
 
 
+===== --from DATE_OR_RANGE
+
+Date range to show, or a single day to filter date on.
+      Date range argument should be quoted. Date specifications can be natural language.
+      To specify a range, use "to" or "through": `doing search --from "monday 8am to friday 5pm"`.
+
+      If values are only time(s) (6am to noon) all dates will be included, but entries will be filtered
+      by time of day.
+
+[Default Value] None
+
+
 ===== -o|--output FORMAT
 
 Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
@@ -710,7 +767,7 @@ List commands one per line, to assist with shell completion
 ==== Command: <tt>import  PATH</tt>
 Import entries from an external source
 
-Imports entries from other sources. Available plugins: calendar, doing, timing
+Imports entries from other sources. Available plugins: calendar, capturething, doing, timing
 ===== Options
 ===== --after DATE_STRING
 
@@ -773,7 +830,7 @@ Tag all imported entries
 
 ===== --type TYPE
 
-Import type (calendar|doing|timing)
+Import type (calendar|capturething|doing|timing)
 
 [Default Value] doing
 
@@ -846,7 +903,7 @@ Tag filter, combine multiple tags with a comma.
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with emacs -nw
 
 
 
@@ -880,7 +937,7 @@ Note
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with emacs -nw
 
 
 
@@ -1002,7 +1059,7 @@ Archive previous @meanwhile entry
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with emacs -nw
 
 
 
@@ -1053,7 +1110,7 @@ Add/remove note from last entry matching tag
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with emacs -nw
 
 
 
@@ -1084,11 +1141,11 @@ 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 with no argument to create a new entry using emacs -nw.
 ===== Options
-===== -b|--back DATE_STRING
+===== -b|--back|--started DATE_STRING
 
-Backdate start time [4pm|20m|2h|yesterday noon]
+Backdate start time [4pm|20m|2h|"yesterday noon"]
 
 [Default Value] None
 
@@ -1108,7 +1165,7 @@ Section
 
 
 ===== -e|--editor
-Edit entry with vim
+Edit entry with emacs -nw
 
 
 
@@ -1159,7 +1216,7 @@ Show time totals at the end of output
 ==== Command: <tt>open </tt>
 Open the "doing" file in an editor
 
-`doing open` defaults to using the editor_app setting in /Users/ttscoff/.doingrc (not set).
+`doing open` defaults to using the editor_app setting in /Users/ttscoff/.config/doing/config.yml (not set).
 ===== Options
 ===== -a|--app APP_NAME
 
@@ -1175,6 +1232,13 @@ Open with app bundle id
 [Default Value] None
 
 
+===== -e|--editor COMMAND
+
+Open with editor command (e.g. vim, mate)
+
+[Default Value] None
+
+
 ==== Command: <tt>plugins </tt>
 List installed plugins
 
@@ -1381,6 +1445,20 @@ Multiple selections are allowed, hit tab to add the highlighted entry to the
 selection, and use ctrl-a to select all visible items. Return processes the
 selected entries.
 ===== Options
+===== --after DATE_STRING
+
+Select from entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
+
+[Default Value] None
+
+
+===== --before DATE_STRING
+
+Select from entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
+
+[Default Value] None
+
+
 ===== --case TYPE
 
 Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]
@@ -1389,6 +1467,18 @@ Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart
 [Must Match] (?-mix:^[csi])
 
 
+===== --from DATE_OR_RANGE
+
+Date range to show, or a single day to filter date on.
+      Date range argument should be quoted. Date specifications can be natural language.
+      To specify a range, use "to" or "through": `doing select --from "monday 8am to friday 5pm"`.
+
+      If values are only time(s) (6am to noon) all dates will be included, but entries will be filtered
+      by time of day.
+
+[Default Value] None
+
+
 ===== -m|--move SECTION
 
 Move selected items to section
@@ -1506,7 +1596,7 @@ Age (oldest|newest)
 
 ===== --after DATE_STRING
 
-View entries newer than date
+Show entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
 
 [Default Value] None
 
@@ -1521,7 +1611,7 @@ Tag boolean (AND,OR,NOT)
 
 ===== --before DATE_STRING
 
-View entries older than date
+Show entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
 
 [Default Value] None
 
@@ -1541,11 +1631,14 @@ Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart
 [Must Match] (?-mix:^[csi])
 
 
-===== -f|--from DATE_OR_RANGE
+===== --from DATE_OR_RANGE
 
 Date range to show, or a single day to filter date on.
-    Date range argument should be quoted. Date specifications can be natural language.
-    To specify a range, use "to" or "through": `doing show --from "monday to friday"`
+      Date range argument should be quoted. Date specifications can be natural language.
+      To specify a range, use "to" or "through": `doing show --from "monday 8am to friday 5pm"`.
+
+      If values are only time(s) (6am to noon) all dates will be included, but entries will be filtered
+      by time of day.
 
 [Default Value] None
 
@@ -1734,7 +1827,7 @@ Tag the last X entries containing TAG.
 
 
 ===== -a|--autotag
-Autotag entries based on autotag configuration in ~/.doingrc
+Autotag entries based on autotag configuration in ~/.config/doing/config.yml
 
 
 
@@ -1784,7 +1877,7 @@ Output HTML, CSS, and Markdown (ERB) templates for customization
 Templates are printed to STDOUT for piping to a file.
   Save them and use them in the configuration file under export_templates.
 ===== Options
-===== -c
+===== -c|--[no-]column
 List in single column for completion
 
 
@@ -1817,6 +1910,13 @@ View entries before specified time (e.g. 8am, 12:30pm, 15:00)
 [Default Value] None
 
 
+===== --from DATE_OR_RANGE
+
+Time range to show `doing today --from "12pm to 4pm"`
+
+[Default Value] None
+
+
 ===== -o|--output FORMAT
 
 Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
@@ -1850,7 +1950,7 @@ Show time totals at the end of output
 
 
 ==== Command: <tt>undo </tt>
-Undo the last change to the doing_file
+Undo the last change to the Doing file
 
 
 ===== Options
@@ -1868,7 +1968,7 @@ Command line options override view configuration
 ===== Options
 ===== --after DATE_STRING
 
-View entries newer than date
+View entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
 
 [Default Value] None
 
@@ -1883,7 +1983,7 @@ Tag boolean (AND,OR,NOT)
 
 ===== --before DATE_STRING
 
-View entries older than date
+View entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day.
 
 [Default Value] None
 
@@ -1904,6 +2004,18 @@ Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart
 [Must Match] (?-mix:^[csi])
 
 
+===== --from DATE_OR_RANGE
+
+Date range to show, or a single day to filter date on.
+      Date range argument should be quoted. Date specifications can be natural language.
+      To specify a range, use "to" or "through": `doing view --from "monday 8am to friday 5pm" view_name`.
+
+      If values are only time(s) (6am to noon) all dates will be included, but entries will be filtered
+      by time of day.
+
+[Default Value] None
+
+
 ===== -o|--output FORMAT
 
 Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
@@ -2074,6 +2186,13 @@ View entries before specified time (e.g. 8am, 12:30pm, 15:00)
 [Default Value] None
 
 
+===== --from TIME_RANGE
+
+Time range to show, e.g. `doing yesterday --from "1am to 8am"`
+
+[Default Value] None
+
+
 ===== -o|--output FORMAT
 
 Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)

data/example_plugin.rb

@@ -14,13 +14,13 @@
 # Change what the plugin says by generating a template with
 # `doing template --type say`, saving it to a file, and
 # putting the path to that file in `export_templates->say` in
-# .doingrc.
+# config.yml.
 #
 # export_templates:
 #   say: /path/to/template.txt
 #
 # Use a different voice by adding a `say_voice` key to your
-# .doingrc. Use `say -v ?` to see available voices.
+# config.yml. Use `say -v ?` to see available voices.
 #
 # say_voice: Zarvox
 
@@ -136,9 +136,9 @@ module Doing
       # or :map to generate output.
       i = items[-1]
 
-      # Format the item. Items are a hash with 4 keys: date,
-      # title, section (parent section), and note. Start
-      # time is in item.date. The wwid object has some
+      # Format the item. Items are an object with 4 methods:
+      # date, title, section (parent section), and note.
+      # Start time is in item.date. The wwid object has some
       # methods for calculation and formatting, including
       # wwid.item.end_date to convert the @done timestamp to
       # an end date.