doing 2.1.39 → 2.1.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02eff91d6af3da80b7a9f728c517dbb34c4a308d74f7b722a45c0999e3d9cec8
-  data.tar.gz: edb57cbb3c4c3c6a6a598f3e16a6a8d23dcb2a466635b68e0ecd359db207f8f3
+  metadata.gz: 8021e76952eb60e4eb68c5aa013f558e7e9e5db454bad792c1ae7e5cc495e24c
+  data.tar.gz: 5eda874992b4f9648c421afdc4429963f2614d08aabba8fb338d4d27c353e258
 SHA512:
-  metadata.gz: f1c66ccce28e225692c0e3fbbb46a74ba0c5ebd5f8043c79f2a938948cbb5c8a65dc6a7a80a19901bf5633441e01c083a7d1ab6e589cb1bfd5542f4aa6d48b5d
-  data.tar.gz: 53560dc1b93d92e67e9bc3a1803da23aaf167041857301126b4ae8b2eff851b75c45b36386cfad34922e22cbc2acc1e689b3c7b635f46dfd0fe5833d7ea24d4e
+  metadata.gz: 37ce93cc4868cbb5565f18b8cd2a77d61099f9692c5b6bcaacdf9329876faa4bc9ff240adc29ea2f8e4cff76adbadc697f583131dfcdb61379dc998a91d40de4
+  data.tar.gz: 06d59cd04607005a65f166701873107a8d4817986007940489dfda3247d97d567a4072d62eb05687f50e1ba93eb6341f1db8f5a317df948836fa56945270a8fa

data/.yardopts

@@ -1 +1 @@
---output-dir docs/doc --markup-provider=redcarpet --markup=markdown --no-private --exclude=README.md lib/doing/*.rb
+--output-dir docs/doc --markup-provider=redcarpet --markup=markdown --no-private --exclude=README.md lib/doing/**/*.rb

data/CHANGELOG.md

@@ -1,3 +1,70 @@
+### 2.1.42
+
+2022-03-17 09:38
+
+#### NEW
+
+- Config option `editors.pager` allows you to force a pager (ignore env settings)
+
+#### IMPROVED
+
+- Change pager preference order to $PAGER, less -Xr, $GIT_PAGER
+- Remove `bat` from pager options as it just falls back to `less -Xr` anyway
+- Using CTRL-C when entring a note interactively won't cancel the whole operation, just the note
+
+#### FIXED
+
+- Add delay between `doing select --editor` and opening the editor, fixes some TTY echo issues
+- If `doing last --editor` has no changes, exit gracefully
+- Trigger pre/post_write hooks when using undo/redo
+- `doing config set` issues with keys that default to nil
+- Notification for `doing config set --remove` missing last element of key path
+
+### 2.1.41
+
+2022-03-16 09:29
+
+#### NEW
+
+- Filter methods available to plugins on Items collection - #in_section, #search, #tagged, #between_dates
+
+#### IMPROVED
+
+- Better comparison methods for Items and Sections
+- `doing tag_dir -r TAG` can remove an indivudal tag from default_tags (--clear removes all)
+- `doing tag_dir` accepts `--editor` to edit tag list in default editor
+- `doing tag_dir` without arguments requests input via readline
+- Use `.txt` instead of `.md` for editor temp file to avoid incorrect syntax higlighting in editor
+- Further API documentation
+
+#### FIXED
+
+- Security warnings related to regular expressions
+- Items.diff method returning too many changes
+
+### 2.1.40
+
+2022-03-14 19:56
+
+#### NEW
+
+- `doing finish` accepts `--from` ranges to update both start and finish dates
+- `doing finish` allows `--back` and `--took` to be used together
+- `doing finish` allows `--search` and `--tag` to be used together
+- `doing finish --from 'DATE to DATE'` allows you to set a new start and end time with a single range string
+- `doing reset --from 'DATE to DATE'` allows you to reset an entry's start time and update or add @done time
+- `doing reset` accepts a `--took Xm` flag to change the finish time
+- `--output FORMAT` option for all display commands, including last, recent and today
+
+#### IMPROVED
+
+- Code refactoring, split up WWID class
+- Better diff method available to hooks to see what changed
+
+#### FIXED
+
+- Search highlighting was being skipped in all cases
+
 ### 2.1.39
 
 2022-03-13 04:32

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doing (2.1.39)
+    doing (2.1.42)
       chronic (~> 0.10, >= 0.10.2)
       deep_merge (~> 1.2, >= 1.2.1)
       gli (~> 2.20, >= 2.20.1)

data/README.md

@@ -8,7 +8,7 @@ _If you're one of the rare people like me who find this useful, feel free to
 
 <!--README-->
 
-The current version of `doing` is <!--VER-->2.1.38<!--END VER-->.
+The current version of `doing` is <!--VER-->2.1.41<!--END VER-->.
 
 Find all of the documentation in the [doing wiki][wiki].
 

data/Rakefile

@@ -71,16 +71,16 @@ task :dockertest, :version, :login do |_, args|
     Process.exit 0
   when /^3/
     img = 'doingtest3'
-    file = 'Dockerfile-3.0'
+    file = 'docker/Dockerfile-3.0'
   when /6$/
     img = 'doingtest26'
-    file = 'Dockerfile-2.6'
+    file = 'docker/Dockerfile-2.6'
   when /(^2|7$)/
     img = 'doingtest27'
-    file = 'Dockerfile-2.7'
+    file = 'docker/Dockerfile-2.7'
   else
     img = 'doingtest'
-    file = 'Dockerfile'
+    file = 'docker/Dockerfile'
   end
 
   puts `docker build . --file #{file} -t #{img}`

data/bin/commands/again.rb

@@ -33,9 +33,7 @@ command %i[again resume] do |c|
   c.action do |_global_options, options, _args|
     options[:fuzzy] = false
 
-    if options[:search]
-      options[:search] = options[:exact] ? options[:search].sub(/^'?/, "'") : options[:search]
-    end
+    options[:search] = options[:search].sub(/^'?/, "'") if options[:search] && options[:exact]
 
     if options[:back]
       options[:date] = options[:back]

data/bin/commands/changes.rb

@@ -14,52 +14,68 @@ MARKDOWN_THEME = {
   comment: :bright_black
 }.deep_freeze
 
-CHANGE_RX = /^(?:(?:(?:[<>=]+|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[0-9.*?]+ *)+|(?:[\d.]+ *(?:-|to)+ *[0-9.]+))$/
+module Doing
+  # changes command methods
+  class ChangesCommand
+    CHANGE_RX = /^(?:(?:(?:[<>=]+|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[0-9.*?]{1,10} *)+|(?:[\d.]+ *(?:-|to)+ *[0-9.]{1,10}))$/
 
-desc 'List recent changes in Doing'
-long_desc %(Display a formatted list of changes in recent versions.
+    def add_options(cmd)
+      cmd.desc 'Display all versions'
+      cmd.switch %i[a all], default_value: false, negatable: false
 
-            Without flags, displays only the most recent version.
-            Use --lookup or --all for history.)
-command %i[changes changelog] do |c|
-  c.desc 'Display all versions'
-  c.switch %i[a all], default_value: false, negatable: false
+      cmd.desc %(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. Wildcards (*?) accepted unless using < or >.)
+      cmd.arg_name 'VERSION'
+      cmd.flag %i[l lookup], must_match: CHANGE_RX
 
-  c.desc %(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. Wildcards (*?) accepted unless using < or >.)
-  c.arg_name 'VERSION'
-  c.flag %i[l lookup], must_match: CHANGE_RX
+      cmd.desc %(Show changelogs matching search terms (uses pattern-based searching).
+               Add slashes to search with regular expressions, e.g. `--search "/output.*flag/"`)
+      cmd.flag %i[s search]
 
-  c.desc %(Show changelogs matching search terms (uses pattern-based searching).
-           Add slashes to search with regular expressions, e.g. `--search "/output.*flag/"`)
-  c.flag %i[s search]
+      cmd.desc 'Sort order (asc/desc)'
+      cmd.arg_name 'ORDER'
+      cmd.flag %i[sort], must_match: REGEX_SORT_ORDER, default_value: :desc, type: OrderSymbol
 
-  c.desc 'Sort order (asc/desc)'
-  c.arg_name 'ORDER'
-  c.flag %i[sort], must_match: REGEX_SORT_ORDER, default_value: :desc, type: OrderSymbol
+      cmd.desc 'Only output changes, no version numbers, headers, or dates'
+      cmd.switch %i[C changes], default_value: false, negatable: false
 
-  c.desc 'Only output changes, no version numbers, headers, or dates'
-  c.switch %i[C changes], default_value: false, negatable: false
+      cmd.desc 'Output raw Markdown'
+      cmd.switch %i[m md markdown], default_value: false, negatable: false
 
-  c.desc 'Output raw Markdown'
-  c.switch %i[m md markdown], default_value: false, negatable: false
+      cmd.desc 'Force rendered output'
+      cmd.switch %i[render], default_value: false, negatable: false
 
-  c.desc 'Force rendered output'
-  c.switch %i[render], default_value: false, negatable: false
+      cmd.desc 'Open changelog in interactive viewer'
+      cmd.switch %i[i interactive], default_value: false, negatable: false
+    end
 
-  c.desc 'Open changelog in interactive viewer'
-  c.switch %i[i interactive], default_value: false, negatable: false
+    def add_examples(cmd)
+      cmd.example 'doing changes', desc: 'View changes in the current version'
+      cmd.example 'doing changes --all', desc: 'See the entire changelog'
+      cmd.example 'doing changes --lookup 2.0.21', desc: 'See changes from version 2.0.21'
+      cmd.example 'doing changes --lookup "> 2.1"', desc: 'See all changes since 2.1.0'
+      cmd.example 'doing changes --search "tags +bool"', desc: 'See all changes containing "tags" and "bool"'
+      cmd.example 'doing changes -l "> 2.1" -s "pattern"', desc: 'Lookup and search can be combined'
+    end
+  end
+end
+
+desc 'List recent changes in Doing'
+long_desc %(Display a formatted list of changes in recent versions.
 
-  c.example 'doing changes', desc: 'View changes in the current version'
-  c.example 'doing changes --all', desc: 'See the entire changelog'
-  c.example 'doing changes --lookup 2.0.21', desc: 'See changes from version 2.0.21'
-  c.example 'doing changes --lookup "> 2.1"', desc: 'See all changes since 2.1.0'
-  c.example 'doing changes --search "tags +bool"', desc: 'See all changes containing "tags" and "bool"'
-  c.example 'doing changes -l "> 2.1" -s "pattern"', desc: 'Lookup and search can be combined'
+            Without flags, displays only the most recent version.
+            Use --lookup or --all for history.)
+command %i[changes changelog] do |c|
+  cmd = Doing::ChangesCommand.new
+  cmd.add_options(c)
+  cmd.add_examples(c)
 
   c.action do |_global_options, options, _args|
-    cl = Doing::Changes.new(lookup: options[:lookup], search: options[:search], changes: options[:changes], sort: options[:sort])
+    cl = Doing::Changes.new(lookup: options[:lookup],
+                            search: options[:search],
+                            changes: options[:changes],
+                            sort: options[:sort])
 
     if options[:interactive]
       cl.interactive

data/bin/commands/commands.rb

@@ -1,37 +1,71 @@
 # frozen_string_literal: true
 
-# @@commands
-desc 'Enable and disable Doing commands'
-command :commands do |c|
-  c.example 'doing commands add', desc: 'Get a menu of available commands'
-  c.example 'doing commands add COMMAND', desc: 'Specify a command to enable'
-  c.example 'doing commands remove COMMAND', desc: 'Specify a command to disable'
+module Doing
+  # commands command methods
+  class CommandsCommand
+    def add_examples(cmd)
+      cmd.example 'doing commands add', desc: 'Get a menu of available commands'
+      cmd.example 'doing commands add COMMAND', desc: 'Specify a command to enable'
+      cmd.example 'doing commands remove COMMAND', desc: 'Specify a command to disable'
+    end
 
-  c.default_command :add
+    def remove_command(args)
+      available = Dir.glob(File.join(File.dirname(__FILE__), '*.rb')).map { |cmd| File.basename(cmd, '.rb') }
+      cfg = Doing.settings
+      custom_dir = Doing.setting('plugins.command_path')
+      custom_commands = Dir.glob(File.join(File.expand_path(custom_dir), '*.rb'))
+      available.concat(custom_commands.map { |cmd| File.basename(cmd, '.rb') })
+      disabled = Doing.setting('disabled_commands')
+      disabled.each { |cmd| available.delete(cmd) }
+      to_disable = if args.good?
+                     args
+                   else
+                     Prompt.choose_from(available,
+                                        prompt: 'Select commands to enable',
+                                        multiple: true,
+                                        sorted: true)
+                   end
+      raise UserCancelled unless to_disable.good?
 
-  # @@commands.enable
-  c.desc 'Enable Doing commands'
-  c.long_desc 'Run without arguments to select commands from a list.'
-  c.arg_name 'COMMAND [COMMAND...]'
-  c.command %i[add enable] do |add|
-    add.action do |_global, _options, args|
+      to_disable = to_disable.strip.split("\n") if to_disable.is_a?(String)
+
+      to_disable.each do |cmd|
+        default_command = File.join(File.dirname(__FILE__), "#{cmd}.rb")
+        custom_command = File.join(File.expand_path(custom_dir), "#{cmd}.rb")
+        unless File.exist?(default_command) || File.exist?(custom_command)
+          raise InvalidArgument, "Command #{cmd} not found"
+
+        end
+
+        raise InvalidArgument, "Command #{cmd} is not enabled" unless available.include?(cmd)
+      end
+
+      cfg.deep_set(['disabled_commands'], disabled.concat(to_disable))
+
+      Util.write_to_file(Doing.config.config_file, YAML.dump(cfg), backup: true)
+      Doing.logger.warn('Config:', "#{Doing.config.config_file} updated")
+    end
+
+    def add_command(args)
       cfg = Doing.settings
-      custom_dir = cfg.dig('plugins', 'command_path')
+      custom_dir = Doing.setting('plugins.command_path')
+      available = Doing.setting('disabled_commands')
 
-      available = cfg['disabled_commands']
       raise UserCancelled, 'No commands available to enable' unless args.good? || available.good?
 
       to_enable = if args.good?
                     args
                   else
-                    Doing::Prompt.choose_from(available,
-                                              prompt: 'Select commands to enable',
-                                              multiple: true,
-                                              sorted: true)
+                    Prompt.choose_from(available,
+                                       prompt: 'Select commands to enable',
+                                       multiple: true,
+                                       sorted: true)
                   end
-      raise UserCancelled unless to_enable
+      raise UserCancelled unless to_enable.good?
 
-      to_enable.strip.split("\n").each do |cmd|
+      to_enable = to_enable.strip.split("\n") if to_enable.is_a?(String)
+
+      to_enable.each do |cmd|
         default_command = File.join(File.dirname(__FILE__), "#{cmd}.rb")
         custom_command = File.join(File.expand_path(custom_dir), "#{cmd}.rb")
         unless File.exist?(default_command) || File.exist?(custom_command)
@@ -45,45 +79,36 @@ command :commands do |c|
 
       cfg.deep_set(['disabled_commands'], available)
 
-      Doing::Util.write_to_file(Doing.config.config_file, YAML.dump(cfg), backup: true)
+      Util.write_to_file(Doing.config.config_file, YAML.dump(cfg), backup: true)
       Doing.logger.warn('Config:', "#{Doing.config.config_file} updated")
     end
   end
+end
+
+# @@commands
+desc 'Enable and disable Doing commands'
+command :commands do |c|
+  c.default_command :add
+
+  cmd = Doing::CommandsCommand.new
+
+  cmd.add_examples(c)
+
+  # @@commands.enable
+  c.desc 'Enable Doing commands'
+  c.long_desc 'Run without arguments to select commands from a list.'
+  c.arg_name 'COMMAND [COMMAND...]'
+  c.command %i[add enable] do |add|
+    add.action do |_global, _options, args|
+      cmd.add_command(args)
+    end
+  end
 
   # @@commands.disable
   c.desc 'Disable Doing commands'
   c.command %i[remove disable] do |remove|
     remove.action do |_global, _options, args|
-      available = Dir.glob(File.join(File.dirname(__FILE__), '*.rb')).map { |cmd| File.basename(cmd, '.rb') }
-      cfg = Doing.settings
-      custom_dir = cfg.dig('plugins', 'command_path')
-      custom_commands = Dir.glob(File.join(File.expand_path(custom_dir), '*.rb'))
-      available.concat(custom_commands.map { |cmd| File.basename(cmd, '.rb') })
-      disabled = cfg['disabled_commands']
-      disabled.each { |cmd| available.delete(cmd) }
-      to_disable = if args.good?
-                     args
-                   else
-                     Doing::Prompt.choose_from(available,
-                                               prompt: 'Select commands to enable',
-                                               multiple: true,
-                                               sorted: true).strip.split("\n")
-                   end
-      to_disable.each do |cmd|
-        default_command = File.join(File.dirname(__FILE__), "#{cmd}.rb")
-        custom_command = File.join(File.expand_path(custom_dir), "#{cmd}.rb")
-        unless File.exist?(default_command) || File.exist?(custom_command)
-          raise InvalidArgument, "Command #{cmd} not found"
-
-        end
-
-        raise InvalidArgument, "Command #{cmd} is not enabled" unless available.include?(cmd)
-      end
-
-      cfg.deep_set(['disabled_commands'], disabled.concat(to_disable))
-
-      Doing::Util.write_to_file(Doing.config.config_file, YAML.dump(cfg), backup: true)
-      Doing.logger.warn('Config:', "#{Doing.config.config_file} updated")
+      cmd.remove_command(args)
     end
   end
 end

data/bin/commands/commands_accepting.rb

@@ -1,5 +1,56 @@
 # frozen_string_literal: true
 
+module Doing
+  # commands_accepting command methods
+  class CommandsAcceptingCommand
+    def flags?(options, args, bool)
+      case bool
+      when :and
+        all_flags?(options, args)
+      when :not
+        no_flags?(options, args)
+      else
+        any_flags?(options, args)
+      end
+    end
+
+    def all_flags?(options, args)
+      args.each do |arg|
+        has_flag = false
+        options.flags.merge(options.switches).each do |_, flag|
+          if flag.name == arg.to_sym || flag.aliases&.include?(arg.to_sym)
+            has_flag = true
+            break
+          end
+        end
+        return false unless has_flag
+      end
+
+      true
+    end
+
+    def any_flags?(options, args)
+      args.each do |option|
+        options.flags.merge(options.switches).each do |_, flag|
+          return true if flag.name == option.to_sym || flag.aliases&.include?(option.to_sym)
+        end
+      end
+
+      false
+    end
+
+    def no_flags?(options, args)
+      args.each do |option|
+        options.flags.merge(options.switches).each do |_, flag|
+          return false if flag.name == option.to_sym || flag.aliases&.include?(option.to_sym)
+        end
+      end
+
+      true
+    end
+  end
+end
+
 # @@commands_accepting
 arg_name 'OPTION'
 command :commands_accepting do |c|
@@ -11,66 +62,19 @@ command :commands_accepting do |c|
                   default_value: :and,
                   type: BooleanSymbol
 
-  c.action do |g, o, a|
+  c.action do |_g, o, a|
+    cac = Doing::CommandsAcceptingCommand.new
     cmds = []
-    commands.each { |cmd, v| cmds.push(cmd) if has_flags?(v, a, o[:bool]) }
+    commands.each { |cmd, v| cmds.push(cmd) if cac.flags?(v, a, o[:bool]) }
 
     if o[:column]
       puts cmds.sort
     else
-      description = "Commands "
-      description += "not " if o[:bool] == :not
-      description += "accepting "
+      description = 'Commands '
+      description += 'not ' if o[:bool] == :not
+      description += 'accepting '
       description += a.map { |arg| "--#{arg}" }.join(o[:bool] == :and ? ' and ' : ' or ')
       puts "#{description}: #{cmds.sort.join(', ')}"
     end
   end
-
-  def has_flags?(options, args, bool)
-    case bool
-    when :and
-      all_flags?(options, args)
-    when :not
-      no_flags?(options, args)
-    else
-      any_flags?(options, args)
-    end
-  end
-
-  def all_flags?(options, args)
-    args.each do |arg|
-      has_flag = false
-      options.flags.merge(options.switches).each do |_, flag|
-        if flag.name == arg.to_sym || flag.aliases&.include?(arg.to_sym)
-          has_flag = true
-          break
-        end
-      end
-      return false unless has_flag
-    end
-
-    true
-  end
-
-  def any_flags?(options, args)
-    args.each do |option|
-      options.flags.merge(options.switches).each do |_, flag|
-        return true if flag.name == option.to_sym || flag.aliases&.include?(option.to_sym)
-      end
-    end
-
-    false
-  end
-
-  def no_flags?(options, args)
-    args.each do |option|
-      options.flags.merge(options.switches).each do |_, flag|
-        return false if flag.name == option.to_sym || flag.aliases&.include?(option.to_sym)
-      end
-    end
-
-    true
-  end
 end
-
-