doing 2.1.27 → 2.1.31pre

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

@@ -97,12 +97,116 @@
 
 
 
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="top-level-namespace.html#add_options-instance_method" title="#add_options (instance method)">#<strong>add_options</strong>(type, cmd)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Add presets of flags and switches to a command.</p>
+</div></span>
+  
+</li>
 
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="add_options-instance_method">
+  
+    #<strong>add_options</strong>(type, cmd)  &#x21d2; <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Add presets of flags and switches to a command.</p>
+
+<p>:add_entry =&gt; --noauto, --note, --ask, --editor, --back</p>
+
+<p>:search =&gt; --search, --case, --exact</p>
+
+<p>:tag_filter =&gt; --tag, --bool, --not, --val</p>
+
+<p>:date_filter =&gt; --before, --after, --from</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>type</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The type</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>cmd</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The GLI command to which the options will be added</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div>
+</div>
+    
+  </div>
 
 </div>
 
       <div id="footer">
-  Generated on Mon Feb 14 10:46:50 2022 by
+  Generated on Thu Feb 17 13:05:18 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.gemspec

@@ -44,5 +44,6 @@ spec = Gem::Specification.new do |s|
   s.add_runtime_dependency('tty-screen', '~> 0.8', '>= 0.8.1')
   s.add_runtime_dependency('parslet', '~> 2.0', '>= 2.0.0')
   s.add_runtime_dependency('plist', '~> 3.6', '>= 3.6.0')
+  s.add_runtime_dependency('sys-uname', '~> 1.2', '>= 1.2.2')
   # s.add_runtime_dependency('amatch', '~> 0.4', '>= 0.4.0')
 end

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.27
+v2.1.31pre
 
 === Global Options
 === --config_file arg
@@ -440,10 +440,10 @@ Display a formatted list of changes in recent versions.
 
 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.
+           to a version. Wildcards (*?) accepted unless using < or >.
 
 [Default Value] None
-[Must Match] (?-mix:^(?:(?:(?:[<>=]|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[\d.*?]+ *)+|(?:[\d.]+ *-+ *[\d.]+))$)
+[Must Match] (?-mix:^(?:(?:(?:[<>=]+|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[0-9.*?]+ *)+|(?:[\d.]+ *(?:-|to)+ *[0-9.]+))$)
 
 
 ===== -s|--search arg
@@ -454,6 +454,14 @@ Show changelogs matching search terms (uses pattern-based searching).
 [Default Value] None
 
 
+===== --sort ORDER
+
+Sort order (asc/desc)
+
+[Default Value] desc
+[Must Match] (?i-mx:^(?:a(?:sc)?|d(?:esc)?)$)
+
+
 ===== -C|--changes
 Only output changes, no version numbers, headers, or dates
 
@@ -464,11 +472,21 @@ Display all versions
 
 
 
+===== -i|--interactive
+Open changelog in interactive viewer
+
+
+
 ===== -m|--md|--markdown
 Output raw Markdown
 
 
 
+===== --render
+Force rendered output
+
+
+
 ==== Command: <tt>colors </tt>
 List available color variables for configuration templates and views
 
@@ -488,26 +506,42 @@ Disable Doing commands
 
 [Default Command] add
 ==== Command: <tt>completion </tt>
-Generate shell completion scripts
+Generate shell completion scripts for doing
 
 Generates the necessary scripts to add command line completion to various shells,
 so typing 'doing' and hitting tab will offer completions of subcommands and their options.
 ===== Options
-===== -f|--file PATH
+===== -t|--type arg
 
-File to write output to
+Deprecated, specify shell as argument to subcommand
 
-[Default Value] STDOUT
+[Default Value] None
+[Must Match] (?i-mx:^(?:[bzf](?:[ai]?sh)?|all)$)
 
 
-===== -t|--type SHELL
+===== Commands
+====== Command: <tt>generate  [zsh|bash|fish|all]</tt>
+Generate completion scripts, including custom plugins and command options
 
-Shell to generate for (bash, zsh, fish)
+Argument specifies which shell to install for: zsh, bash, fish, all
+======= Options
+======= -f|--file PATH
 
-[Default Value] zsh
-[Must Match] (?i-mx:^(?:[bzf](?:[ai]?sh)?|all)$)
+Alternative file to write output to
+
+[Default Value] None
+Argument specifies which shell to install for: zsh, bash, fish, all
+
+======= --stdout
+Output result to STDOUT only
 
 
+
+====== Command: <tt>install  [zsh|bash|fish]</tt>
+Install default completion scripts
+
+Argument specifies which shell to install for: zsh, bash, fish, or all
+[Default Command] generate
 ==== Command: <tt>config </tt>
 Edit the configuration file or output a value from it
 
@@ -1161,35 +1195,6 @@ Force exact search string matching (case sensitive)
 
 
 
-==== Command: <tt>later  ENTRY</tt>
-Add an item to the Later section
-
-
-===== Options
-===== -b|--back|--started DATE_STRING
-
-Backdate start time to date string [4pm|20m|2h|yesterday noon]
-
-[Default Value] None
-
-
-===== -n|--note TEXT
-
-Note
-
-[Default Value] None
-
-
-===== --ask
-Prompt for note via multi-line input
-
-
-
-===== -e|--editor
-Edit entry with vim
-
-
-
 ==== Command: <tt>mark|flag </tt>
 Mark last entry as flagged
 
@@ -1541,7 +1546,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 editors->doing_file setting
+`doing open` defaults to using the editors.doing_file setting
 in /Users/ttscoff/.config/doing/config.yml (TaskPaper).
 ===== Options
 ===== -a|--app APP_NAME

data/example_plugin.rb

@@ -54,7 +54,7 @@ module Doing
     ##   automatically be added for the user to override
     ##   The config key will be available at:
     ##
-    ##       wwid.config['export_templates'][PLUGIN_NAME]
+    ##       Doing.config.settings['export_templates'][PLUGIN_NAME]
     ##
     ## config:    (optional) A Hash which will be
     ## added to the main configuration in the plugins section.
@@ -65,7 +65,7 @@ module Doing
     ##
     ##   The configuration keys will be available at:
     ##
-    ##      wwid.config['plugins'][PLUGIN_NAME][KEY]
+    ##      Doing.config.settings['plugins'][PLUGIN_NAME][KEY]
     ##
     ## Method to return plugin settings (required)
     ##
@@ -125,6 +125,8 @@ module Doing
     def self.render(wwid, items, variables: {})
       return unless items.good?
 
+      config = Doing.config.settings
+
       # the :options key includes the flags passed to the
       # command that called the plugin use `puts
       # variables.inspect` to see properties and methods
@@ -162,8 +164,8 @@ module Doing
       title = i.title.gsub(/@/, 'hashtag ')
       tpl = template('say')
 
-      if wwid.config['export_templates'].key?('say')
-        cfg_tpl = wwid.config['export_templates']['say']
+      if config['export_templates'].key?('say')
+        cfg_tpl = config['export_templates']['say']
         tpl = cfg_tpl if cfg_tpl.good?
       end
       output = tpl.dup
@@ -188,7 +190,7 @@ module Doing
       Doing.logger.info('Spoke the last entry. Did you hear it?')
 
       # This export runs a command for fun, most plugins won't
-      voice = wwid.config['plugins']['say']['say_voice'] || 'Alex'
+      voice = config['plugins']['say']['say_voice'] || 'Alex'
       `say -v "#{voice}" "#{output}"`
 
       # Return the result (don't output to terminal with puts or print)

data/lib/completion/_doing.zsh

@@ -18,7 +18,7 @@ function _doing() {
                   'changelog:List recent changes in Doing'
                   'colors:List available color variables for configuration templates and views'
                   'commands:Enable and disable Doing commands'
-                  'completion:Generate shell completion scripts'
+                  'completion:Generate shell completion scripts for doing'
                   'config:Edit the configuration file or output a value from it'
                   'done:Add a completed item with @done(date)'
                   'did:Add a completed item with @done(date)'
@@ -28,7 +28,6 @@ function _doing() {
                   'help:Shows a list of commands or help for one command'
                   'import:Import entries from an external source'
                   'last:Show the last entry'
-                  'later:Add an item to the Later section'
                   'mark:Mark last entry as flagged'
                   'flag:Mark last entry as flagged'
                   'meanwhile:Finish any running @meanwhile tasks and optionally create a new one'
@@ -89,10 +88,10 @@ function _doing() {
                 args=( {-a,--archive}"[Archive entries]" "(--bool=)--bool=}[Boolean used to combine multiple tags]" "(--case=)--case=}[Case sensitivity for search string matching [(c)ase-sensitive]" {-i,--interactive}"[Select item(s) to cancel from a menu of matching entries]" "(--not)--not}[Cancel items that *dont* match search/tag filterst* match search/tag filters]" {-s,--section=}"[Section]" "(--search=)--search=}[Filter entries using a search query]" "(--tag=)--tag=}[Filter entries by tag]" {-u,--unfinished}"[Cancel last entry]" "(--val=)--val=}[Perform a tag value query]" {-x,--exact}"[Force exact search string matching]" )
             ;;
             changes) 
-                args=( {-C,--changes}"[Only output changes]" {-a,--all}"[Display all versions]" {-l,--lookup=}"[Look up a specific version]" "(--markdown)--markdown}[Output raw Markdown]" {-s,--search=}"[Show changelogs matching search terms]" )
+                args=( {-C,--changes}"[Only output changes]" {-a,--all}"[Display all versions]" {-i,--interactive}"[Open changelog in interactive viewer]" {-l,--lookup=}"[Look up a specific version]" "(--markdown)--markdown}[Output raw Markdown]" "(--render)--render}[Force rendered output]" {-s,--search=}"[Show changelogs matching search terms]" "(--sort=)--sort=}[Sort order]" )
             ;;
             changelog) 
-                args=( {-C,--changes}"[Only output changes]" {-a,--all}"[Display all versions]" {-l,--lookup=}"[Look up a specific version]" "(--markdown)--markdown}[Output raw Markdown]" {-s,--search=}"[Show changelogs matching search terms]" )
+                args=( {-C,--changes}"[Only output changes]" {-a,--all}"[Display all versions]" {-i,--interactive}"[Open changelog in interactive viewer]" {-l,--lookup=}"[Look up a specific version]" "(--markdown)--markdown}[Output raw Markdown]" "(--render)--render}[Force rendered output]" {-s,--search=}"[Show changelogs matching search terms]" "(--sort=)--sort=}[Sort order]" )
             ;;
             colors) 
                 args=(  )
@@ -101,7 +100,7 @@ function _doing() {
                 args=(  )
             ;;
             completion) 
-                args=( {-f,--file=}"[File to write output to]" {-t,--type=}"[Shell to generate for]" )
+                args=( {-t,--type=}"[Deprecated]" )
             ;;
             config) 
                 args=( {-d,--dump}"[DEPRECATED]" {-u,--update}"[DEPRECATED]" )
@@ -130,9 +129,6 @@ function _doing() {
             last) 
                 args=( "(--bool=)--bool=}[Boolean used to combine multiple tags]" "(--case=)--case=}[Case sensitivity for search string matching [(c)ase-sensitive]" "(--config_template=)--config_template=}[Output using a template from configuration]" {-d,--delete}"[Delete the last entry]" "(--duration)--duration}[Show elapsed time if entry is not tagged @done]" {-e,--editor}"[Edit entry with vim]" {-h,--hilite}"[Highlight search matches in output]" "(--not)--not}[Show items that *dont* match search/tag filterst* match search/tag filters]" {-s,--section=}"[Specify a section]" "(--search=)--search=}[Filter entries using a search query]" "(--tag=)--tag=}[Filter entries by tag]" "(--template=)--template=}[Override output format with a template string containing %placeholders]" "(--val=)--val=}[Perform a tag value query]" {-x,--exact}"[Force exact search string matching]" )
             ;;
-            later) 
-                args=( "(--ask)--ask}[Prompt for note via multi-line input]" "(--started=)--started=}[Backdate start time to date string [4pm|20m|2h|yesterday noon]]" {-e,--editor}"[Edit entry with vim]" {-n,--note=}"[Note]" )
-            ;;
             mark) 
                 args=( "(--bool=)--bool=}[Boolean used to combine multiple tags]" {-c,--count=}"[How many recent entries to tag]" "(--case=)--case=}[Case sensitivity for search string matching [(c)ase-sensitive]" {-d,--date}"[Include current date/time with tag]" "(--force)--force}[Dont ask permission to flag all entries when count is 0t ask permission to flag all entries when count is 0]" {-i,--interactive}"[Select item(s) to flag from a menu of matching entries]" "(--not)--not}[Flag items that *dont* match search/tag filterst* match search/tag filters]" {-r,--remove}"[Remove flag]" {-s,--section=}"[Section]" "(--search=)--search=}[Filter entries using a search query]" "(--tag=)--tag=}[Filter entries by tag]" {-u,--unfinished}"[Flag last entry]" "(--val=)--val=}[Perform a tag value query]" {-x,--exact}"[Force exact search string matching]" )
             ;;

data/lib/completion/doing.bash

@@ -61,9 +61,9 @@ _doing_cancel() {
 _doing_changes() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--changes --all --lookup --markdown --search' -- $token ) )
+    COMPREPLY=( $( compgen -W '--changes --all --interactive --lookup --markdown --render --search --sort' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-C -a -l -s --changes --all --lookup --markdown --search' -- $token ) )
+    COMPREPLY=( $( compgen -W '-C -a -i -l -s --changes --all --interactive --lookup --markdown --render --search --sort' -- $token ) )
   
   fi
 }
@@ -71,9 +71,9 @@ _doing_changes() {
 _doing_completion() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--file --type' -- $token ) )
+    COMPREPLY=( $( compgen -W '--type' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-f -t --file --type' -- $token ) )
+    COMPREPLY=( $( compgen -W '-t --type' -- $token ) )
   
   fi
 }
@@ -148,16 +148,6 @@ _doing_last() {
   fi
 }
 
-_doing_later() {
-  
-  if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--ask --started --editor --note' -- $token ) )
-  elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-e -n --ask --started --editor --note' -- $token ) )
-  
-  fi
-}
-
 _doing_mark() {
   
   if [[ "$token" == --* ]]; then
@@ -466,7 +456,6 @@ _doing()
     elif [[ $last =~ (help) ]]; then _doing_help
     elif [[ $last =~ (import) ]]; then _doing_import
     elif [[ $last =~ (last) ]]; then _doing_last
-    elif [[ $last =~ (later) ]]; then _doing_later
     elif [[ $last =~ (mark|flag) ]]; then _doing_mark
     elif [[ $last =~ (meanwhile) ]]; then _doing_meanwhile
     elif [[ $last =~ (note) ]]; then _doing_note

data/lib/completion/doing.fish

@@ -143,7 +143,7 @@ complete -xc doing -n '__fish_doing_needs_command' -a 'cancel' -d End\ last\ X\
 complete -xc doing -n '__fish_doing_needs_command' -a 'changes changelog' -d List\ recent\ changes\ in\ Doing
 complete -xc doing -n '__fish_doing_needs_command' -a 'colors' -d List\ available\ color\ variables\ for\ configuration\ templates\ and\ views
 complete -xc doing -n '__fish_doing_needs_command' -a 'commands' -d Enable\ and\ disable\ Doing\ commands
-complete -xc doing -n '__fish_doing_needs_command' -a 'completion' -d Generate\ shell\ completion\ scripts
+complete -xc doing -n '__fish_doing_needs_command' -a 'completion' -d Generate\ shell\ completion\ scripts\ for\ doing
 complete -xc doing -n '__fish_doing_needs_command' -a 'config' -d Edit\ the\ configuration\ file\ or\ output\ a\ value\ from\ it
 complete -xc doing -n '__fish_doing_needs_command' -a 'done did' -d Add\ a\ completed\ item\ with\ @done\(date\)
 complete -xc doing -n '__fish_doing_needs_command' -a 'finish' -d Mark\ last\ X\ entries\ as\ @done
@@ -151,7 +151,6 @@ complete -xc doing -n '__fish_doing_needs_command' -a 'grep search' -d Search\ f
 complete -xc doing -n '__fish_doing_needs_command' -a 'help' -d Shows\ a\ list\ of\ commands\ or\ help\ for\ one\ command
 complete -xc doing -n '__fish_doing_needs_command' -a 'import' -d Import\ entries\ from\ an\ external\ source
 complete -xc doing -n '__fish_doing_needs_command' -a 'last' -d Show\ the\ last\ entry
-complete -xc doing -n '__fish_doing_needs_command' -a 'later' -d Add\ an\ item\ to\ the\ Later\ section
 complete -xc doing -n '__fish_doing_needs_command' -a 'mark flag' -d Mark\ last\ entry\ as\ flagged
 complete -xc doing -n '__fish_doing_needs_command' -a 'meanwhile' -d Finish\ any\ running\ @meanwhile\ tasks\ and\ optionally\ create\ a\ new\ one
 complete -xc doing -n '__fish_doing_needs_command' -a 'note' -d Add\ a\ note\ to\ the\ last\ entry
@@ -227,11 +226,13 @@ complete -c doing -l val  -f -r -n '__fish_doing_using_command cancel' -d Perfor
 complete -c doing -l exact -s x -f  -n '__fish_doing_using_command cancel' -d Force\ exact\ search\ string\ matching
 complete -c doing -l changes -s C -f  -n '__fish_doing_using_command changes changelog' -d Only\ output\ changes
 complete -c doing -l all -s a -f  -n '__fish_doing_using_command changes changelog' -d Display\ all\ versions
+complete -c doing -l interactive -s i -f  -n '__fish_doing_using_command changes changelog' -d Open\ changelog\ in\ interactive\ viewer
 complete -c doing -l lookup -s l -f -r -n '__fish_doing_using_command changes changelog' -d Look\ up\ a\ specific\ version
 complete -c doing -l markdown  -f  -n '__fish_doing_using_command changes changelog' -d Output\ raw\ Markdown
+complete -c doing -l render  -f  -n '__fish_doing_using_command changes changelog' -d Force\ rendered\ output
 complete -c doing -l search -s s -f -r -n '__fish_doing_using_command changes changelog' -d Show\ changelogs\ matching\ search\ terms
-complete -c doing -l file -s f -f -r -n '__fish_doing_using_command completion' -d File\ to\ write\ output\ to
-complete -c doing -l type -s t -f -r -n '__fish_doing_using_command completion' -d Shell\ to\ generate\ for
+complete -c doing -l sort  -f -r -n '__fish_doing_using_command changes changelog' -d Sort\ order
+complete -c doing -l type -s t -f -r -n '__fish_doing_using_command completion' -d Deprecated
 complete -c doing -l dump -s d -f  -n '__fish_doing_using_command config' -d DEPRECATED
 complete -c doing -l update -s u -f  -n '__fish_doing_using_command config' -d DEPRECATED
 complete -c doing -l noauto -s X -f  -n '__fish_doing_using_command done did' -d Exclude\ auto\ tags\ and\ default\ tags
@@ -315,10 +316,6 @@ complete -c doing -l tag  -f -r -n '__fish_doing_using_command last' -d Filter\
 complete -c doing -l template  -f -r -n '__fish_doing_using_command last' -d Override\ output\ format\ with\ a\ template\ string\ containing\ \%placeholders
 complete -c doing -l val  -f -r -n '__fish_doing_using_command last' -d Perform\ a\ tag\ value\ query
 complete -c doing -l exact -s x -f  -n '__fish_doing_using_command last' -d Force\ exact\ search\ string\ matching
-complete -c doing -l ask  -f  -n '__fish_doing_using_command later' -d Prompt\ for\ note\ via\ multi-line\ input
-complete -c doing -l started  -f -r -n '__fish_doing_using_command later' -d Backdate\ start\ time\ to\ date\ string\ \[4pm\|20m\|2h\|yesterday\ noon\]
-complete -c doing -l editor -s e -f  -n '__fish_doing_using_command later' -d Edit\ entry\ with\ vim
-complete -c doing -l note -s n -f -r -n '__fish_doing_using_command later' -d Note
 complete -c doing -l bool  -f -r -n '__fish_doing_using_command mark flag' -d Boolean\ used\ to\ combine\ multiple\ tags
 complete -c doing -l count -s c -f -r -n '__fish_doing_using_command mark flag' -d How\ many\ recent\ entries\ to\ tag
 complete -c doing -l case  -f -r -n '__fish_doing_using_command mark flag' -d Case\ sensitivity\ for\ search\ string\ matching\ \[\(c\)ase-sensitive
@@ -558,7 +555,7 @@ complete -c doing -l template  -f -r -n '__fish_doing_using_command yesterday' -
 complete -c doing -l totals  -f  -n '__fish_doing_using_command yesterday' -d Show\ time\ totals\ at\ the\ end\ of\ output
 complete -f -c doing -s o -l output -x -n '__fish_doing_using_command grep search on select show since today view yesterday' -a '(__fish_doing_export_plugin)'
 complete -f -c doing -s b -l bool -x -n '__fish_doing_using_command again resume archive move autotag cancel finish grep search last mark flag note reset begin rotate show tag tags view wiki' -a 'and or not pattern'
-complete -f -c doing -l case -x -n '__fish_doing_using_command again resume archive move cancel finish grep search import last mark flag note reset begin rotate select show show tag tags tags view' -a 'case-sensitive ignore smart'
+complete -f -c doing -l case -x -n '__fish_doing_using_command again resume archive move cancel changes changelog finish grep search import last mark flag note reset begin rotate select show show tag tags tags view' -a 'case-sensitive ignore smart'
 complete -f -c doing -l tag_sort -x -n '__fish_doing_using_command grep search on recent show since today view yesterday' -a 'name time'
 complete -f -c doing -l tag_order -x -n '__fish_doing_using_command show view yesterday' -a 'asc desc'
 complete -f -c doing -s a -l age -x -n '__fish_doing_using_command show view' -a 'oldest newest'

data/lib/doing/add_options.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+##
+## Add presets of flags and switches to a command.
+##
+## :add_entry => --noauto, --note, --ask, --editor, --back
+##
+## :search => --search, --case, --exact
+##
+## :tag_filter => --tag, --bool, --not, --val
+##
+## :date_filter => --before, --after, --from
+##
+## @param      type  [Symbol] The type
+## @param      cmd   The GLI command to which the options will be added
+##
+def add_options(type, cmd)
+  cmd_name = cmd.name.to_s
+  action = case cmd_name
+           when /again/
+             'Repeat'
+           when /grep/
+             'Search'
+           when /mark/
+             'Flag'
+           when /(last|tags|view)/
+             'Show'
+           else
+             cmd_name.capitalize
+           end
+
+  case type
+  when :add_entry
+    cmd.desc 'Exclude auto tags and default tags'
+    cmd.switch %i[X noauto], default_value: false, negatable: false
+
+    cmd.desc 'Include a note'
+    cmd.arg_name 'TEXT'
+    cmd.flag %i[n note]
+
+    cmd.desc 'Prompt for note via multi-line input'
+    cmd.switch %i[ask], negatable: false, default_value: false
+
+    cmd.desc "Edit entry with #{Doing::Util.default_editor}"
+    cmd.switch %i[e editor], negatable: false, default_value: false
+
+    cmd.desc 'Backdate start date for new entry to date string [4pm|20m|2h|yesterday noon]'
+    cmd.arg_name 'DATE_STRING'
+    cmd.flag %i[b back started], type: DateBeginString
+  when :search
+    cmd.desc 'Filter entries using a search query, surround with slashes for regex (e.g. "/query.*/"),
+            start with single quote for exact match ("\'query")'
+    cmd.arg_name 'QUERY'
+    cmd.flag [:search]
+
+    cmd.desc 'Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]'
+    cmd.arg_name 'TYPE'
+    cmd.flag [:case], must_match: REGEX_CASE,
+                      default_value: Doing.settings.dig('search', 'case').normalize_case,
+                      type: CaseSymbol
+
+    cmd.desc 'Force exact search string matching (case sensitive)'
+    cmd.switch %i[x exact], default_value: Doing.config.exact_match?, negatable: Doing.config.exact_match?
+  when :tag_filter
+    cmd.desc 'Filter entries by tag. Combine multiple tags with a comma. Wildcards allowed (*, ?)'
+    cmd.arg_name 'TAG'
+    cmd.flag [:tag], type: TagArray
+
+    cmd.desc 'Perform a tag value query ("@done > two hours ago" or "@progress < 50").
+            May be used multiple times, combined with --bool'
+    cmd.arg_name 'QUERY'
+    cmd.flag [:val], multiple: true, must_match: REGEX_VALUE_QUERY
+
+    cmd.desc "#{action} items that *don't* match search/tag filters"
+    cmd.switch [:not], default_value: false, negatable: false
+
+    cmd.desc 'Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans'
+    cmd.arg_name 'BOOLEAN'
+    cmd.flag [:bool], must_match: REGEX_BOOL,
+                      default_value: :pattern,
+                      type: BooleanSymbol
+  when :date_filter
+    if action =~ /Archive/
+      cmd.desc 'Archive entries older than date (natural language).'
+    else
+      cmd.desc "#{action} entries older than date (natural language). 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"
+    end
+    cmd.arg_name 'DATE_STRING'
+    cmd.flag [:before], type: DateBeginString
+
+    if action =~ /Archive/
+      cmd.desc 'Archive entries newer than date (natural language).'
+    else
+      cmd.desc "#{action} entries newer than date (natural language). 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"
+    end
+    cmd.arg_name 'DATE_STRING'
+    cmd.flag [:after], type: DateEndString
+
+    if action =~ /Archive/
+      cmd.desc %(
+          Date range (natural language) to archive: `doing archive --from "1/1/21 to 12/31/21"`.
+        )
+    else
+      cmd.desc %(
+        Date range (natural language) to #{action.downcase}, or a single day to filter on.
+        To specify a range, use "to": `doing #{cmd_name} --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.
+      )
+    end
+    cmd.arg_name 'DATE_OR_RANGE'
+    cmd.flag [:from], type: DateRangeString
+  end
+end

data/lib/doing/array/array.rb

@@ -2,3 +2,19 @@
 
 require_relative 'tags'
 require_relative 'nested_hash'
+
+class ::Array
+  ##
+  ## Force UTF-8 encoding of strings in array
+  ##
+  ## @return     [Array] Encoded lines
+  ##
+  def utf8
+    c = self.class
+    if String.method_defined? :force_encoding
+      replace c.new(map(&:utf8))
+    else
+      self
+    end
+  end
+end

data/lib/doing/changelog/change.rb

@@ -92,7 +92,7 @@ module Doing
         out << members.map(&:to_s).join("\n")
       end
 
-      out.join("")
+      out.join("\n")
     end
 
     private