doing 2.0.24 → 2.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be908ed31434bd248efe3ebcba66b9022ed35be3651af6ada7e6464b50c91c9f
-  data.tar.gz: 0dcf2ce4915637e2514a8d9735c8ca294a6d5bbc0558afdabeb714d3f1de5b50
+  metadata.gz: 7fc7ae9d7369be36fcfb7bdd888ed7a6342d998e9ca77c5647ae2386fbaff3ca
+  data.tar.gz: b2b71651788d3e99b71a964a6ac93b2b485adf9467e2cec2bc66e51c49314a8f
 SHA512:
-  metadata.gz: ef314b60821ba50306c0d6b9704f310a21d6652480e67350f092cfc670c6ddab9024c24f602d68396e555fb624cf316507526a50b241c959639c738699c8602e
-  data.tar.gz: 8474ed1164f978c0359f7826b1c92fd66821bb112ae71938a67245b42a8e342f8e629dd42ec4cc8216b033e6aff20e1c44d0b3d89cdbc7f96b5e6d4513cd1319
+  metadata.gz: 8b11ec84f5b92b9938ac95f5e9dd2777ba9b218ed918ffa9de2082f3129a683d3fd6f112db775e479dc0967e9af2f5a619cbfafcd6416c35fcbeaf3df05c0c33
+  data.tar.gz: 3f87f827b16fdbe04440d8b58253a3cd209de909fa0be9369ab9638c85da8753d41237d0028c3fe37deef64ad742890c5fd91877373ef3a4b562b5331eddbb42

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 2.0.25
+
+#### NEW
+
+- `doing config set` to set single config values from command line
+- BREAKING CHANGE: Moves ~/.doingrc to ~/.config/doing/config.yml
+- BREAKING CHANGE: convert config flags to subcommands, e.g. `doing config --udpate` => `doing config update`, and `doing config --dump` => `doing config dump`
+
 ### 2.0.24
 
 - include fzf source directly, in case git isn't installed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doing (2.0.24)
+    doing (2.0.25)
       chronic (~> 0.10, >= 0.10.2)
       deep_merge (~> 1.2, >= 1.2.1)
       gli (~> 2.19, >= 2.19.2)

data/README.md

@@ -6,7 +6,7 @@ _If you're one of the rare people like me who find this useful, feel free to [bu
 
 <!--README-->
 
-The current version of `doing` is <!--VER-->2.0.23<!--END VER-->.
+The current version of `doing` is <!--VER-->2.0.24<!--END VER-->.
 
 Find all of the documentation in the [doing wiki](https://github.com/ttscoff/doing/wiki).
 
@@ -41,6 +41,12 @@ See the [doing project on BrettTerpstra.com](https://brettterpstra.com/projects/
 
 Evan Lovely has [created an Alfred workflow as well](http://www.evanlovely.com/blog/technology/alfred-for-terpstras-doing/).
 
+## Contributing
+
+If you [create a plugin](https://github.com/ttscoff/doing/wiki/Creating-Plugins), custom command, or hook you can share, please [let me know](https://brettterpstra.com/contact/). If I get a few plugin contributions, I'll set up a second repository for them.
+
+Feel free to fork [the repository](https://github.com/ttscoff/doing/) on GitHub and make pull requests with changes. Please target the `develop` branch with pull requests.
+
 <!--END README-->
 
 ---

data/bin/doing

@@ -1188,7 +1188,7 @@ command :tag do |c|
   c.desc 'Tag last entry (or entries) not marked @done'
   c.switch %i[u unfinished], negatable: false, default_value: false
 
-  c.desc 'Autotag entries based on autotag configuration in ~/.doingrc'
+  c.desc 'Autotag entries based on autotag configuration in ~/.config/doing/config.yml'
   c.switch %i[a autotag], negatable: false, default_value: false
 
   c.desc 'Tag the last X entries containing TAG.
@@ -2591,55 +2591,138 @@ command :open do |c|
 end
 
 desc 'Edit the configuration file or output a value from it'
-long_desc %(Run without arguments, `doing config` opens your `.doingrc` in an editor.
+long_desc %(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.)
-arg_name 'KEY_PATH'
 command :config do |c|
   c.example 'doing config', desc: "Open an active configuration in #{Doing::Util.find_default_editor('config')}"
-  c.example 'doing config -d doing_file', desc: 'Output the value of a config key as YAML'
-  c.example 'doing config -d plugins.say.say_voice -o json', desc: 'Output the value of a key path as JSON'
+  c.example 'doing config get doing_file', desc: 'Output the value of a config key as YAML'
+  c.example 'doing config get plugins.plugin_path -o json', desc: 'Output the value of a key path as JSON'
+  c.example 'doing config set plugins.say.say_voice Alex', desc: 'Set the value of a key path and update config file'
+  c.example 'doing config set plug.say.voice Zarvox', desc: 'Key paths for get and set are fuzzy matched'
 
-  c.desc 'Editor to use'
-  c.arg_name 'EDITOR'
-  c.flag %i[e editor], default_value: nil
+  c.default_command :edit
 
-  c.desc '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.'
-  c.switch %i[d dump], negatable: false
+  c.desc 'DEPRECATED'
+  c.switch %i[d dump]
 
-  c.desc 'Format for --dump (json|yaml|raw)'
-  c.arg_name 'FORMAT'
-  c.flag %i[o output], default_value: 'yaml', must_match: /^(?:y(?:aml)?|j(?:son)?|r(?:aw)?)$/
+  c.desc 'DEPRECATED'
+  c.switch %i[u update]
 
-  c.desc 'Update config file with missing configuration options'
-  c.switch %i[u update], default_value: false, negatable: false
+  c.desc 'Open config file in editor'
+  c.command :edit do |edit|
+    edit.example 'doing config edit', desc: 'Open a config file in the default editor'
+    edit.example 'doing config edit --editor vim', desc: 'Open config in specific editor'
 
-  if `uname` =~ /Darwin/
-    c.desc 'Application to use'
-    c.arg_name 'APP_NAME'
-    c.flag [:a]
+    edit.desc 'Editor to use'
+    edit.arg_name 'EDITOR'
+    edit.flag %i[e editor], default_value: nil
 
-    c.desc 'Application bundle id to use'
-    c.arg_name 'BUNDLE_ID'
-    c.flag [:b]
+    if `uname` =~ /Darwin/
+      edit.desc 'Application to use'
+      edit.arg_name 'APP_NAME'
+      edit.flag [:a]
+
+      edit.desc 'Application bundle id to use'
+      edit.arg_name 'BUNDLE_ID'
+      edit.flag [:b]
+
+      edit.desc "Use the config_editor_app defined in ~/.config/doing/config.yml (#{settings.key?('config_editor_app') ? settings['config_editor_app'] : 'config_editor_app not set'})"
+      edit.switch [:x]
+    end
+
+    edit.action do |global, options, args|
+      if options[:update] || options[:dump]
+        cmd = commands[:config]
+        if options[:update]
+          cmd = cmd.commands[:update]
+        elsif options[:dump]
+          cmd = cmd.commands[:get]
+        end
+        action = cmd.send(:get_action, nil)
+        action.call(global, options, args)
+        Doing.logger.warn('Deprecated:', '--dump and --update are deprecated,
+                             use `doing config get` and `doing config update`')
+        Doing.logger.output_results
+        return
+      end
+
+      config_file = config.choose_config
+
+      if `uname` =~ /Darwin/
+        if options[:x]
+          editor = Doing::Util.find_default_editor('config')
+          if editor
+            if Doing::Util.exec_available(editor)
+              system %(#{editor} "#{config_file}")
+            else
+              `open -a "#{editor}" "#{config_file}"`
+            end
+          else
+            raise InvalidArgument, 'No viable editor found in config or environment.'
+          end
+        elsif options[:a] || options[:b]
+          if options[:a]
+            `open -a "#{options[:a]}" "#{config_file}"`
+          elsif options[:b]
+            `open -b #{options[:b]} "#{config_file}"`
+          end
+        else
+          editor = options[:e] || Doing::Util.find_default_editor('config')
+
+          raise MissingEditor, 'No viable editor defined in config or environment' unless editor
+
+          if Doing::Util.exec_available(editor)
+            system %(#{editor} "#{config_file}")
+          else
+            `open -a "#{editor}" "#{config_file}"`
+          end
+        end
+      else
+        editor = options[:e] || Doing::Util.default_editor
+        raise MissingEditor, 'No EDITOR variable defined in environment' unless editor && Doing::Util.exec_available(editor)
 
-    c.desc "Use the config_editor_app defined in ~/.doingrc (#{settings.key?('config_editor_app') ? settings['config_editor_app'] : 'config_editor_app not set'})"
-    c.switch [:x]
+        system %(#{editor} "#{config_file}")
+      end
+    end
   end
 
-  c.action do |_global_options, options, args|
-    if options[:update]
+  c.desc 'Update default config file, adding any missing keys'
+  c.command %i[update refresh] do |update|
+    update.action do |_global, options, args|
       config.configure({rewrite: true, ignore_local: true})
-      return
+      Doing.logger.warn('Config:', 'config refreshed')
     end
+  end
+
+  c.desc 'Undo the last change to a config file'
+  c.command :undo do |undo|
+    undo.action do |_global, options, args|
+      config_file = config.choose_config
+      wwid.restore_backup(config_file)
+    end
+  end
+
+  c.desc 'Output a key\'s value'
+  c.arg 'KEY_PATH'
+  c.command %i[get dump] do |dump|
+    dump.example 'doing config get', desc: 'Output the entire configuration'
+    dump.example 'doing config get timer_format --output raw', desc: 'Output the value of timer_format as a plain string'
+    dump.example 'doing config get doing_file', desc: 'Output the value of the doing_file setting, respecting local configurations'
+    dump.example 'doing config get -o json plug.plugpath', desc: 'Key path is fuzzy matched: output the value of plugins->plugin_path as JSON'
+
+    dump.desc 'Format for output (json|yaml|raw)'
+    dump.arg_name 'FORMAT'
+    dump.flag %i[o output], default_value: 'yaml', must_match: /^(?:y(?:aml)?|j(?:son)?|r(?:aw)?)$/
+
+    dump.action do |_global, options, args|
 
-    if options[:dump]
       keypath = args.join('.')
       cfg = config.value_for_key(keypath)
 
@@ -2658,53 +2741,42 @@ command :config do |c|
       Doing.logger.output_results
       return
     end
+  end
 
-    if config.additional_configs.count.positive?
-      choices = [config.config_file]
-      choices.concat(config.additional_configs)
-      res = wwid.choose_from(choices.uniq.sort.reverse, sorted: false, prompt: 'Local configs found, select which to edit > ')
+  c.desc 'Set a key\'s value in the config file'
+  c.arg 'KEY VALUE'
+  c.command :set do |set|
+    set.example 'doing config set timer_format human', desc: 'Set the value of timer_format to "human"'
+    set.example 'doing config set plug.plugpath ~/my_plugins', desc: 'Key path is fuzzy matched: set the value of plugins->plugin_path'
 
-      raise UserCancelled, 'Cancelled' unless res
+    set.action do |_global, options, args|
+      if args.count < 2
+        raise InvalidArgument, 'config set requires at least two arguments, key path and value'
 
-      config_file = res.strip || config.config_file
-    else
-      config_file = config.config_file
-    end
+      end
 
-    if `uname` =~ /Darwin/
-      if options[:x]
-        editor = Doing::Util.find_default_editor('config')
-        if editor
-          if Doing::Util.exec_available(editor)
-            system %(#{editor} "#{config_file}")
-          else
-            `open -a "#{editor}" "#{config_file}"`
-          end
-        else
-          raise InvalidArgument, 'No viable editor found in config or environment.'
-        end
-      elsif options[:a] || options[:b]
-        if options[:a]
-          `open -a "#{options[:a]}" "#{config_file}"`
-        elsif options[:b]
-          `open -b #{options[:b]} "#{config_file}"`
-        end
-      else
-        editor = options[:e] || Doing::Util.find_default_editor('config')
+      value = args.pop
+      keypath = args.join('.')
+      old_value = config.value_for_key(keypath).map { |k, v| v.to_s }
+      real_path = config.resolve_key_path(keypath)
+      raise InvalidArgument, 'Invalid key path' if real_path.empty?
 
-        raise MissingEditor, 'No viable editor defined in config or environment' unless editor
+      key = real_path.last
+      real_path[0...-1].inject(config.settings, :fetch)[key] = value
 
-        if Doing::Util.exec_available(editor)
-          system %(#{editor} "#{config_file}")
-        else
-          `open -a "#{editor}" "#{config_file}"`
-        end
-      end
-    else
-      editor = options[:e] || Doing::Util.default_editor
-      raise MissingEditor, 'No EDITOR variable defined in environment' unless editor && Doing::Util.exec_available(editor)
+      config_file = config.choose_config
+
+      prev_level = Doing.logger.level
+      Doing.logger.adjust_verbosity({ level: :info })
+      Doing.logger.log_now(:info, 'Config:', "Updating #{config_file}")
+      Doing.logger.log_now(:info, 'Config:', "#{real_path.join('->')} => #{value}")
+      res = wwid.yn('Update selected config', default_response: true)
+
+      raise UserCancelled, 'Cancelled' unless res
 
-      system %(#{editor} "#{config_file}")
+      Doing.logger.adjust_verbosity({ level: prev_level })
+      Doing::Util.write_to_file(config_file, YAML.dump(config.settings), backup: true)
+      Doing.logger.warn('Config:', "#{config_file} updated")
     end
   end
 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.24
+v2.0.25
 
 === 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
@@ -385,63 +385,87 @@ 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_NAME
 
 Application to use
 
 [Default Value] None
 
 
-===== -b BUNDLE_ID
+======= -b 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
+Use the config_editor_app defined in ~/.config/doing/config.yml (config_editor_app not set)
 
-Format for --dump (json|yaml|raw)
 
-[Default Value] yaml
-[Must Match] (?-mix:^(?:y(?:aml)?|j(?:son)?|r(?:aw)?)$)
+
+====== Command: <tt>get|dump </tt>
+Output a key's value
 
 
-===== -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.
+======= Options
+======= -o|--output FORMAT
 
+Format for output (json|yaml|raw)
+
+[Default Value] yaml
+[Must Match] (?-mix:^(?:y(?:aml)?|j(?:son)?|r(?:aw)?)$)
 
 
-===== -u|--update
-Update config file with missing configuration options
+====== Command: <tt>set </tt>
+Set a key's value in the config file
 
 
+====== Command: <tt>undo </tt>
+Undo the last change to a config file
 
-===== -x
-Use the config_editor_app defined in ~/.doingrc (config_editor_app not set)
 
+====== 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.
 
@@ -1159,7 +1183,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
 
@@ -1734,7 +1758,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
 
 
 

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