doing 2.1.30 → 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 Wed Feb 16 07:23:35 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.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.30
+v2.1.31pre
 
 === Global Options
 === --config_file arg
@@ -506,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
+
+Argument specifies which shell to install for: zsh, bash, fish, all
+======= Options
+======= -f|--file PATH
+
+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
 
-Shell to generate for (bash, zsh, fish)
 
-[Default Value] zsh
-[Must Match] (?i-mx:^(?:[bzf](?:[ai]?sh)?|all)$)
 
+====== 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
 

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)'
@@ -100,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]" )

data/lib/completion/doing.bash

@@ -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
 }

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
@@ -232,8 +232,7 @@ complete -c doing -l markdown  -f  -n '__fish_doing_using_command changes change
 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 sort  -f -r -n '__fish_doing_using_command changes changelog' -d Sort\ order
-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 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

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/completion/bash_completion.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Doing
   module Completion
+    # Generate completions for Bash
     class BashCompletions
       attr_accessor :commands, :global_options
 
@@ -11,7 +14,7 @@ module Doing
         @commands.each_with_index do |cmd, i|
           @bar.advance(status: cmd[:commands].first)
 
-          data = get_help_sections(cmd[:commands].first)
+          data = Completion.get_help_sections(cmd[:commands].first)
 
           arg = data[:synopsis].join(' ').strip.split(/ /).last
           case arg
@@ -26,7 +29,7 @@ module Doing
           end
 
           if data[:command_options]
-            options = parse_options(data[:command_options])
+            options = Completion.parse_options(data[:command_options])
             out << command_function(cmd[:commands].first, options, type)
 
             if first
@@ -119,56 +122,13 @@ module Doing
         [func, logic]
       end
 
-
-
-      def get_help_sections(command = '')
-        res = `doing help #{command}`.strip
-        scanned = res.scan(/(?m-i)^([A-Z ]+)\n([\s\S]*?)(?=\n+[A-Z]+|\Z)/)
-        sections = {}
-        scanned.each do |sect|
-          title = sect[0].downcase.strip.gsub(/ +/, '_').to_sym
-          content = sect[1].split(/\n/).map(&:strip).delete_if(&:empty?)
-          sections[title] = content
-        end
-        sections
-      end
-
-      def parse_option(option)
-        res = option.match(/(?:-(?<short>\w), )?(?:--(?:\[no-\])?(?<long>\w+)(?:=(?<arg>\w+))?)\s+- (?<desc>.*?)$/)
-        return nil unless res
-        {
-          short: res['short'],
-          long: res['long'],
-          arg: res[:arg],
-          description: res['desc'].short_desc
-        }
-      end
-
-      def parse_options(options)
-        options.map { |opt| parse_option(opt) }
-      end
-
-      def parse_command(command)
-        res = command.match(/^(?<cmd>[^, \t]+)(?<alias>(?:, [^, \t]+)*)?\s+- (?<desc>.*?)$/)
-        commands = [res['cmd']]
-        commands.concat(res['alias'].split(/, /).delete_if(&:empty?)) if res['alias']
-
-        {
-          commands: commands,
-          description: res['desc'].short_desc
-        }
-      end
-
-      def parse_commands(commands)
-        commands.map { |cmd| parse_command(cmd) }
-      end
-
       def initialize
-        data = get_help_sections
-        @global_options = parse_options(data[:global_options])
-        @commands = parse_commands(data[:commands])
-        @bar = TTY::ProgressBar.new("\033[0;0;33mGenerating Bash completions: \033[0;35;40m[:bar] :status\033[0m", total: @commands.count, bar_format: :blade, status: 'Reading subcommands')
-        @bar.resize(25)
+        data = Completion.get_help_sections
+        @global_options = Completion.parse_options(data[:global_options])
+        @commands = Completion.parse_commands(data[:commands])
+        @bar = TTY::ProgressBar.new("\033[0;0;33mGenerating Bash completions: \033[0;35;40m[:bar] :status\033[0m", total: @commands.count + 1, bar_format: :box, hide_cursor: true, status: 'Reading subcommands')
+        width = TTY::Screen.columns - 45
+        @bar.resize(width)
       end
 
       def generate_completions
@@ -176,6 +136,7 @@ module Doing
         out = []
         out << main_function
         out << 'complete -F _doing doing'
+        @bar.advance(status: '✅')
         @bar.finish
         out.join("\n")
       end

data/lib/doing/completion/fish_completion.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Doing
   module Completion
+    # Generate completions for Fish
     class FishCompletions
 
       attr_accessor :commands, :global_options
@@ -137,53 +140,12 @@ module Doing
         EOFUNCTIONS
       end
 
-      def get_help_sections(command = '')
-        res = `doing help #{command}`.strip
-        scanned = res.scan(/(?m-i)^([A-Z ]+)\n([\s\S]*?)(?=\n+[A-Z]+|\Z)/)
-        sections = {}
-        scanned.each do |sect|
-          title = sect[0].downcase.strip.gsub(/ +/, '_').to_sym
-          content = sect[1].split(/\n/).map(&:strip).delete_if(&:empty?)
-          sections[title] = content
-        end
-        sections
-      end
-
-      def parse_option(option)
-        res = option.match(/(?:-(?<short>\w), )?(?:--(?:\[no-\])?(?<long>\w+)(?:=(?<arg>\w+))?)\s+- (?<desc>.*?)$/)
-        return nil unless res
-
-        {
-          short: res['short'],
-          long: res['long'],
-          arg: res['arg'],
-          description: res['desc'].short_desc
-        }
-      end
-
-      def parse_options(options)
-        options.map { |opt| parse_option(opt) }
-      end
-
-      def parse_command(command)
-        res = command.match(/^(?<cmd>[^, \t]+)(?<alias>(?:, [^, \t]+)*)?\s+- (?<desc>.*?)$/)
-        commands = [res['cmd']]
-        commands.concat(res['alias'].split(/, /).delete_if(&:empty?)) if res['alias']
-
-        {
-          commands: commands,
-          description: res['desc'].short_desc
-        }
-      end
-
-      def parse_commands(commands)
-        commands.map { |cmd| parse_command(cmd) }
-      end
-
       def generate_subcommand_completions
         out = []
-        @commands.each_with_index do |cmd, i|
-          out << "complete -xc doing -n '__fish_doing_needs_command' -a '#{cmd[:commands].join(' ')}' -d #{Shellwords.escape(cmd[:description])}"
+        @commands.each do |cmd|
+          desc = Shellwords.escape(cmd[:description])
+          cmds = cmd[:commands].join(' ')
+          out << "complete -xc doing -n '__fish_doing_needs_command' -a '#{cmds}' -d #{desc}"
         end
 
         out.join("\n")
@@ -203,14 +165,14 @@ module Doing
 
         @commands.each_with_index do |cmd, i|
           @bar.advance(status: cmd[:commands].first)
-          data = get_help_sections(cmd[:commands].first)
+          data = Completion.get_help_sections(cmd[:commands].first)
 
           if data[:synopsis].join(' ').strip.split(/ /).last =~ /(path|file)/i
             out << "complete -c doing -F -n '__fish_doing_using_command #{cmd[:commands].join(" ")}'"
           end
 
           if data[:command_options]
-            parse_options(data[:command_options]).each do |option|
+            Completion.parse_options(data[:command_options]).each do |option|
               next if option.nil?
 
               arg = option[:arg] ? '-r' : ''
@@ -267,11 +229,12 @@ module Doing
       end
 
       def initialize
-        data = get_help_sections
-        @global_options = parse_options(data[:global_options])
-        @commands = parse_commands(data[:commands])
-        @bar = TTY::ProgressBar.new("\033[0;0;33mGenerating Fish completions: \033[0;35;40m[:bar] :status\033[0m", total: @commands.count, bar_format: :blade, status: 'processing subcommands')
-        @bar.resize(25)
+        data = Completion.get_help_sections
+        @global_options = Completion.parse_options(data[:global_options])
+        @commands = Completion.parse_commands(data[:commands])
+        @bar = TTY::ProgressBar.new("\033[0;0;33mGenerating Fish completions: \033[0;35;40m[:bar] :status\033[0m", total: @commands.count + 1, bar_format: :block, hide_cursor: true, status: 'processing subcommands')
+        width = TTY::Screen.columns - 45
+        @bar.resize(width)
       end
 
       def generate_completions
@@ -280,6 +243,7 @@ module Doing
         out << generate_helpers
         out << generate_subcommand_completions
         out << generate_subcommand_option_completions
+        @bar.advance(status: '✅')
         @bar.finish
         out.join("\n")
       end