vagrant-devcommands 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 752833dc9227565eb5c6f9e3c9b2a2879aa4042af9ce6be42025efe6509e132b
-  data.tar.gz: a177ba8899bfc7eb2b72c227a30dfcbe8c7317369ccfdc474d6f3082fec3be28
+  metadata.gz: c87a4a5395ff70331bc828e00f95e4f2bd17b75dbc57561a9a512b2fa94d5402
+  data.tar.gz: ba566aeb333eb32fab9389b979df2f54e2326e0b98cd1beff1e94b07a52a45dd
 SHA512:
-  metadata.gz: 19c515bc5e4c2568f6fcc3a98b9389a345aff32bf56507be78f4653dda45d84d4887730a33e96c5e8a5bc58d98775dae7f7aed1f5a95ab4cb84359ab36953d90
-  data.tar.gz: 3af910e8e9e666ae68caa24faba6e79417aac33cf39086d568bc42404292d0501e42e9d69a132da27c9eec064beff4e21eacaa4e6a22d3049b03be7dafe1c80a
+  metadata.gz: 18314207fb498117756f3b0b1023c72c75c5c157408895e9d92fcc56f980039f8601f2797ca7013d0c9386f98349566662d4615f5bb329960ac895e49a4814e6
+  data.tar.gz: 6d92ec349743a1658fb1160b45f87c57eaf6785dba47f0c7130f4bf7249d35f40ea67897a6fdbd0b0c1fedf79711bc4d655f95e7650ea8de3e24b859d1aeb451

data/CHANGELOG.md

@@ -1,81 +1,68 @@
 # Changelog
 
+## v0.14.0 (2022-08-23)
+
+- Enhancements
+  - Lambda/Proc values of command scripts are now executed in the instance of the command when running
+  - Lambda/Proc scripts get the parsed argv values as the first (and only) argument unless defined with a zero arity
+
+- Bug fixes
+  - Parameters with a default value configured will now be properly displayed as optional in the detailed command help
+
 ## v0.13.0 (2018-07-19)
 
 - Enhancements
-  - Unknown parameters can be catched and used by setting
-    the option `passthru: true` on one of your parameters
-    ([#3](https://github.com/mneudert/vagrant-devcommands/issues/3))
+  - Unknown parameters can be catched and used by setting the option `passthru: true` on one of your parameters ([#3](https://github.com/mneudert/vagrant-devcommands/issues/3))
 
 ## v0.12.0 (2018-04-21)
 
 - Enhancements
   - Command parameters can define alias values to be replaced before escaping
-  - Commandfile entries with duplicate names will now issue a warning while
-    still discarding all previous definitions
+  - Commandfile entries with duplicate names will now issue a warning while still discarding all previous definitions
   - Commandfile entries with unknown options will issue a warning
 
 - Backwards incompatible changes
-  - Support for the already deprecated configuration parameter `:box` has
-    been removed
+  - Support for the already deprecated configuration parameter `:box` has been removed
 
 ## v0.11.1 (2017-10-04)
 
 - Bug fixes
-  - The machine of a command alias definition is now correctly preferred over
-    the machine of the command definition
+  - The machine of a command alias definition is now correctly preferred over the machine of the command definition
 
 ## v0.11.0 (2017-10-02)
 
 - Enhancements
-  - Command aliases can be used to provide multiple ways to call a single
-    command including automatically populated arguments
+  - Command aliases can be used to provide multiple ways to call a single command including automatically populated arguments
   - Commands can define if they need a tty by using the new `:tty` option
 
 - Backwards incompatible changes
-  - By default a command does not use a tty. This potentially breaks commands
-    requiring one, e.g. a mysql console command
+  - By default a command does not use a tty. This potentially breaks commands requiring one, e.g. a mysql console command
 
 ## v0.10.1 (2017-08-08)
 
 - Bug fixes
-  - Vagrant introduced a tty flag for ssh command execution in version `1.9.6`.
-    This broke some commands requiring an interactive terminal
-    (like a mysql client). This flag is now permanently active to restore the
-    function of these commands until the next regular release introduces a
-    full per command tty configuration
+  - Vagrant introduced a tty flag for ssh command execution in version `1.9.6`. This broke some commands requiring an interactive terminal (like a mysql client). This flag is now permanently active to restore the function of these commands until the next regular release introduces a full per command tty configuration
 
 ## v0.10.0 (2017-07-02)
 
 - Enhancements
-  - Command alternatives provided by the "did-you-mean" feature no longer
-    display the full command list (help)
-  - Depending on the internal scoring multiple alternative commands
-    will be presented instead of a full command list (help)
-  - Minimal data for shell completion is available via the internal
-    `completion-data` command
+  - Command alternatives provided by the "did-you-mean" feature no longer display the full command list (help)
+  - Depending on the internal scoring multiple alternative commands will be presented instead of a full command list (help)
+  - Minimal data for shell completion is available via the internal `completion-data` command
   - Parameters can limit the values you are allowed to pass in
-  - Spaces in chain/command names are now officially disallowed. Those
-    would have always been broken anyways, but now there is a nice message
-    and the commands are excluded from the various listings
+  - Spaces in chain/command names are now officially disallowed. Those would have always been broken anyways, but now there is a nice message and the commands are excluded from the various listings
 
 - Bug fixes
-  - Chain names can no longer conflict with internal commands like `help`
-    or `version`. The respective chain definitions are dropped and a warning
-    is issued
+  - Chain names can no longer conflict with internal commands like `help` or `version`. The respective chain definitions are dropped and a warning is issued
 
 ## v0.9.0 (2017-05-20)
 
 - Enhancements
   - Every command in a chain can specify the machine to be used
-  - If an unknown command is requested a possible alternative
-    is suggested based on the calculated
-    [Jaro-Winkler distance](https://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance)
+  - If an unknown command is requested a possible alternative is suggested based on the calculated [Jaro-Winkler distance](https://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance)
 
 - Deprecations
-  - The configuration parameter `:box` has been renamed to `:machine` to
-    match the vagrant naming. Support for the old configuration will be
-    dropped in a future version
+  - The configuration parameter `:box` has been renamed to `:machine` to match the Vagrant naming. Support for the old configuration will be dropped in a future version
 
 ## v0.8.0 (2017-04-19)
 
@@ -86,14 +73,12 @@
 ## v0.7.2 (2017-03-12)
 
 - Bug fixes
-  - Machine names passed via argv are properly detected and used
-    ([#1](https://github.com/mneudert/vagrant-devcommands/pull/1))
+  - Machine names passed via argv are properly detected and used ([#1](https://github.com/mneudert/vagrant-devcommands/pull/1))
 
 ## v0.7.1 (2017-02-15)
 
 - Bug fixes
-  - Wrapping of optional parameters should now properly be done only if
-    at least an empty string is defined as a default value
+  - Wrapping of optional parameters should now properly be done only if at least an empty string is defined as a default value
 
 ## v0.7.0 (2016-09-26)
 
@@ -106,16 +91,12 @@
 - Enhancements
   - Command usage now displays the correct parameter syntax
   - Command usage always displays mandatory parameters before optional ones
-  - Error output (e.g. "missing Commandfile") is now printed using
-    the configured ui class (allows colored output)
-  - Global commands can be defined using a file
-    named `.vagrant.devcommands` located under `Dir.home()`
+  - Error output (e.g. "missing Commandfile") is now printed using the configured ui class (allows colored output)
+  - Global commands can be defined using a file named `.vagrant.devcommands` located under `Dir.home()`
   - Invalid parameters are displayed in the error message
   - Missing parameters are displayed in the error message
-  - Parameter wrapping is only done if a value is passed
-    or a default (at least empty string) is configured
-  - Warnings about using internal command names or missing scripts are now
-    printed using the configured ui class (allows colored output)
+  - Parameter wrapping is only done if a value is passed or a default (at least empty string) is configured
+  - Warnings about using internal command names or missing scripts are now printed using the configured ui class (allows colored output)
 
 ## v0.5.0 (2016-03-21)
 

data/README.md

@@ -1,6 +1,6 @@
 # Vagrant DevCommands
 
-Runs vagrant commands from a Commandfile.
+Runs Vagrant commands from a Commandfile.
 
 ## Usage
 
@@ -45,19 +45,15 @@ of the command name using either %{command} or %<command>s.
 eoh
 ```
 
-_Note_: If you are defining literal `%` (percent sign) in your commands you
-have to escape them using a second `%`. For example `date '+%%Y-%%m-%%d'`.
+_Note_: If you are defining literal `%` (percent sign) in your commands you have to escape them using a second `%`. For example `date '+%%Y-%%m-%%d'`.
 
-_Note_: Spaces in command names are not supported. Definitions with spaces will
-be ignored.
+_Note_: Spaces in command names are not supported. Definitions with spaces will be ignored.
 
-_Note_: Please be aware that setting a custom `usage` hides the original usage
-line from the help output.
+_Note_: Please be aware that setting a custom `usage` hides the original usage line from the help output.
 
 #### Commands with Parameters
 
-Passing additional parameters to a command is (minimally) supported using an
-sprintf syntax:
+Passing additional parameters to a command is (minimally) supported using an sprintf syntax:
 
 ```ruby
 command 'with_param',
@@ -120,18 +116,13 @@ vagrant run with_param \
     --p_limited completely
 ```
 
-For now a command expecting one or more parameters will fail if the user does
-not provide them. Any arguments exceeding the number used are silently
-discarded.
+For now a command expecting one or more parameters will fail if the user does not provide them. Any arguments exceeding the number used are silently discarded.
 
-Escaping rules are defined as `{ 'char_to_escape' => 'char_to_use_as_escape' }`.
-These are applied prior to interpolation into the command. Regular ruby escaping
-rules apply.
+Escaping rules are defined as `{ 'char_to_escape' => 'char_to_use_as_escape' }`. These are applied prior to interpolation into the command. Regular ruby escaping rules apply.
 
 #### Commands with Flags
 
-Every command can be associated with (by definition optional) flags available
-for later command interpolation:
+Every command can be associated with (by definition optional) flags available for later command interpolation:
 
 ```ruby
 command 'with_flags',
@@ -155,27 +146,36 @@ vagrant run with_flags --f_standard
 vagrant run with_flags --f_valued
 ```
 
-By default a flag gets interpolated as `--#{flagname}`. If a value is defined
-this value will be interpolated unmodified.
+By default a flag gets interpolated as `--#{flagname}`. If a value is defined this value will be interpolated unmodified.
 
 #### Commands defined by Lambda/Proc
 
-You can (more or less) dynamically generate your scripts by defining the
-command with a lambda or proc as its script.
+You can (more or less) dynamically generate your scripts by defining the command with a lambda or proc as its script.
 
 ```ruby
 command 'from_lambda', script: lambda { 'echo "lambda works"' }
 command 'from_proc', script: proc { 'echo "proc works"' }
+
+command 'from_lambda_params',
+  parameters: { argv_param: {} },
+  script: lambda { |params|
+    'echo "lambda works: ' + params[:argv_param] + '"'
+  }
+
+command 'from_proc_params',
+  parameters: { argv_param: {} },
+  script: proc { |params|
+    'echo "proc works: ' + params[:argv_param] + '"'
+  }
 ```
 
-These will be evaluated when running the command.
+These will be evaluated when running the command and optionally received the parsed shell arguments when defined with an arity of one.
 
 Every rule from regular scripts (parameters, escaping `%`, ...) still apply.
 
 #### Commands with a TTY ("interactive")
 
-If you have a command that expects some sort of interaction with the user you
-may need to set the `tty` option for a command:
+If you have a command that expects some sort of interaction with the user you may need to set the `tty` option for a command:
 
 ```ruby
 command 'interactive', tty: true
@@ -185,9 +185,7 @@ This allows full interaction with programs like `irb` or `mysql`.
 
 ### Global Command Definitions
 
-To have commands available even wihout a `Commandfile` you can define the
-globally. To do this just create a file named `.vagrant.devcommands` in your
-`$HOME` directory.
+To have commands available even wihout a `Commandfile` you can define the globally. To do this just create a file named `.vagrant.devcommands` in your `$HOME` directory.
 
 You can use this command to find the correct path if unsure:
 
@@ -218,20 +216,15 @@ eoh
 
 The configured commands will be executed in the order defined.
 
-If one or more of your commands requires parameters all of them have to be
-passed to the chain execution.
+If one or more of your commands requires parameters all of them have to be passed to the chain execution.
 
-By default a chain breaks upon the first non-zero return value of any
-configured command. To deactivate this behaviour you can set `:break_on_error`
-to `false`. Any value other than `false` will stick to the default.
+By default a chain breaks upon the first non-zero return value of any configured command. To deactivate this behaviour you can set `:break_on_error` to `false`. Any value other than `false` will stick to the default.
 
-_Note_: Spaces in command names are not supported. Definitions with spaces will
-be ignored.
+_Note_: Spaces in command names are not supported. Definitions with spaces will be ignored.
 
 #### Chain Definitions with Pre-Defined Parameters
 
-If required you can modify the arguments given to each chain element by setting
-additional/custom argv values for a single chain element:
+If required you can modify the arguments given to each chain element by setting additional/custom argv values for a single chain element:
 
 ```ruby
 command 'chainecho',
@@ -256,9 +249,7 @@ vagrant run chainecho --first='initial' --second='initial'
 vagrant run chainecho --first='param' --second='param'
 ```
 
-By default every command will be executed using the machine defined by the
-command itself or the only one available. You can, however, run the complete
-chain against a specific machine using `vagrant run your_machine your_chain`.
+By default every command will be executed using the machine defined by the command itself or the only one available. You can, however, run the complete chain against a specific machine using `vagrant run your_machine your_chain`.
 
 #### Chain Definitions with Specific Machines
 
@@ -286,13 +277,11 @@ vagrant run secondary chainhost
 vagrant run tertiary chainhost
 ```
 
-This configuration can itself be modified by passing a machine name to run
-all chain commands on using  using `vagrant run your_machine your_chain`.
+This configuration can itself be modified by passing a machine name to run all chain commands on using  using `vagrant run your_machine your_chain`.
 
 ### Abort Parsing inside Commandfile
 
-If you, for whatever reasons, want to abort further parsing of a `Commandfile`
-you can simple return from it:
+If you, for whatever reasons, want to abort further parsing of a `Commandfile` you can simple return from it:
 
 ```ruby
 command 'foo', script: 'foo'
@@ -307,16 +296,13 @@ return if v_cur < v_min
 command 'bar', script: 'bar'
 ```
 
-This example leads to the command `bar` not being available if the currently
-installed plugin has a version below `1.3.3.7`.
+This example leads to the command `bar` not being available if the currently installed plugin has a version below `1.3.3.7`.
 
-Please be aware that returning from a global commandfile completely skips
-evaluating a local one.
+Please be aware that returning from a global commandfile completely skips evaluating a local one.
 
 ### Command Alias Definitions
 
-For commands you want to keep generic but often call with a specific set of
-parameter values you can define an alias:
+For commands you want to keep generic but often call with a specific set of parameter values you can define an alias:
 
 ```ruby
 command 'customecho',
@@ -334,9 +320,7 @@ I get displayed when running "vagrant run help aliasecho".
 eoh
 ```
 
-The setting `command` is required, the other options `argv` and `machine` are
-optional and used for the actual customization. Any argument configured will
-take precedence over the value given to `vagrant run` itself.
+The setting `command` is required, the other options `argv` and `machine` are optional and used for the actual customization. Any argument configured will take precedence over the value given to `vagrant run` itself.
 
 ### Experimental: Shell Completion
 
@@ -354,14 +338,11 @@ vagrant run completion-data my-command
 
 ### SSH
 
-If you are using this plugin on a Windows host system, please make sure your
-regular `vagrant ssh [machine]` succeeds. In some cases you may need to add the
-`ssh.exe` (e.g. from a git installation) manually to your `%PATH%`.
+If you are using this plugin on a Windows host system, please make sure your regular `vagrant ssh [machine]` succeeds. In some cases you may need to add the `ssh.exe` (e.g. from a git installation) manually to your `%PATH%`.
 
 ### Command Definition
 
-When using multi-line commands you probably need to define your command using
-a sigil notation like the following:
+When using multi-line commands you probably need to define your command using a sigil notation like the following:
 
 ```ruby
 command 'long_running_task',
@@ -371,12 +352,9 @@ command 'long_running_task',
                 && echo 'finished long running task')
 ```
 
-Using a quote delimited command definition might otherwise result in not that
-helpful error messages about a bad shell command.
+Using a quote delimited command definition might otherwise result in not that helpful error messages about a bad shell command.
 
-It might also help to double check the line endings in your Commandfile are set
-unix-style (`\n`) and not windows-style (`\r\n`) if you get errors when running
-your commands.
+It might also help to double check the line endings in your Commandfile are set unix-style (`\n`) and not windows-style (`\r\n`) if you get errors when running your commands.
 
 ## Development
 

data/lib/vagrant/devcommands/command.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     # Defines the executable vagrant command
     class Command < Vagrant.plugin(2, :command)
-      I18N_KEY = 'vagrant_devcommands.'.freeze
+      I18N_KEY = 'vagrant_devcommands.'
 
       def self.synopsis
         synopsis = VagrantPlugins::DevCommands::SYNOPSIS
@@ -52,15 +54,15 @@ module VagrantPlugins
         return false if alternatives.empty?
 
         if alternatives.length == 1
-          display_error(I18n.t("#{I18N_KEY}.did_you_mean_single"), true)
+          display_error(I18n.t("#{I18N_KEY}.did_you_mean_single"), pre_ln: true)
         else
-          display_error(I18n.t("#{I18N_KEY}.did_you_mean_multi"), true)
+          display_error(I18n.t("#{I18N_KEY}.did_you_mean_multi"), pre_ln: true)
         end
 
         alternatives.sort.each { |(k, _v)| display_error("        #{k}") }
       end
 
-      def display_error(msg, pre_ln = false, post_ln = false)
+      def display_error(msg, pre_ln: false, post_ln: false)
         @env.ui.error '' if pre_ln
         @env.ui.error msg
         @env.ui.error '' if post_ln
@@ -96,7 +98,7 @@ module VagrantPlugins
 
         runner.run(runnable)
       rescue RuntimeError => e
-        display_error(e.message, false, true)
+        display_error(e.message, post_ln: true)
         run_internal('help', [command])
 
         nil

data/lib/vagrant/devcommands/commandfile/modeler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     class Commandfile
@@ -33,9 +35,7 @@ module VagrantPlugins
           options        = { script: options } unless options.is_a?(Hash)
           options[:name] = name
 
-          unless valid_script?(options[:script])
-            raise ArgumentError, 'command_no_script'
-          end
+          raise ArgumentError, 'command_no_script' unless valid_script?(options[:script])
 
           VagrantPlugins::DevCommands::Model::Command.new(options)
         end

data/lib/vagrant/devcommands/commandfile/reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     class Commandfile
@@ -17,8 +19,8 @@ module VagrantPlugins
           local  = @commandfile.path
 
           contents = ''
-          contents += "\n" + global.read unless global.nil?
-          contents += "\n" + local.read unless local.nil?
+          contents += "\n#{global.read}" unless global.nil?
+          contents += "\n#{local.read}" unless local.nil?
 
           instance_eval(contents)
 
@@ -29,24 +31,24 @@ module VagrantPlugins
 
         def chain(name, options = nil)
           @entries << {
-            type:    :chain,
-            name:    name.to_s,
+            type: :chain,
+            name: name.to_s,
             options: options
           }
         end
 
         def command(name, options = nil)
           @entries << {
-            type:    :command,
-            name:    name.to_s,
+            type: :command,
+            name: name.to_s,
             options: options
           }
         end
 
         def command_alias(name, options = nil)
           @entries << {
-            type:    :command_alias,
-            name:    name.to_s,
+            type: :command_alias,
+            name: name.to_s,
             options: options
           }
         end

data/lib/vagrant/devcommands/commandfile.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module VagrantPlugins

data/lib/vagrant/devcommands/help_printer/chain.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module HelpPrinter
       # Prints help for a command chain
       class Chain
-        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
+        I18N_KEY = 'vagrant_devcommands.internal.help'
         UTIL     = VagrantPlugins::DevCommands::Util
         MESSAGES = VagrantPlugins::DevCommands::Messages
 
@@ -20,9 +22,9 @@ module VagrantPlugins
         private
 
         def body(help)
-          return message(:chain_no_help, true) if help.nil?
+          return message(:chain_no_help, pre_ln: true) if help.nil?
 
-          info(help.strip, true)
+          info(help.strip, pre_ln: true)
         end
 
         def chain_help_line(cmd)
@@ -32,7 +34,7 @@ module VagrantPlugins
         end
 
         def commands(chain)
-          info('Chained commands (in order):', true)
+          info('Chained commands (in order):', pre_ln: true)
 
           chain.commands.each do |cmd|
             info(UTIL.padded_columns(0, chain_help_line(cmd)))
@@ -50,12 +52,12 @@ module VagrantPlugins
           info(I18n.t("#{I18N_KEY}.usage", what: usage))
         end
 
-        def info(msg, pre_ln = false)
+        def info(msg, pre_ln: false)
           @env.ui.info '' if pre_ln
           @env.ui.info msg
         end
 
-        def message(msg, pre_ln = false)
+        def message(msg, pre_ln: false)
           if pre_ln
             MESSAGES.pre_ln(msg, &@env.ui.method(:info))
           else

data/lib/vagrant/devcommands/help_printer/command.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module HelpPrinter
       # Prints help for a command
       class Command
-        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
+        I18N_KEY = 'vagrant_devcommands.internal.help'
         UTIL     = VagrantPlugins::DevCommands::Util
         MESSAGES = VagrantPlugins::DevCommands::Messages
 
@@ -23,7 +25,7 @@ module VagrantPlugins
         def arguments(arguments, title)
           return if arguments.nil? || arguments.empty?
 
-          info("#{title}:", true)
+          info("#{title}:", pre_ln: true)
           arguments_body(arguments)
         end
 
@@ -36,9 +38,9 @@ module VagrantPlugins
         end
 
         def body(help)
-          return message(:command_no_help, true) if help.nil?
+          return message(:command_no_help, pre_ln: true) if help.nil?
 
-          info(help.strip, true)
+          info(help.strip, pre_ln: true)
         end
 
         def header(command)
@@ -55,12 +57,12 @@ module VagrantPlugins
           info(I18n.t("#{I18N_KEY}.usage", what: usage))
         end
 
-        def info(msg, pre_ln = false)
+        def info(msg, pre_ln: false)
           @env.ui.info '' if pre_ln
           @env.ui.info msg
         end
 
-        def message(msg, pre_ln = false)
+        def message(msg, pre_ln: false)
           if pre_ln
             MESSAGES.pre_ln(msg, &@env.ui.method(:info))
           else

data/lib/vagrant/devcommands/help_printer/command_alias.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module HelpPrinter
       # Prints help for a command alias
       class CommandAlias
-        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
+        I18N_KEY = 'vagrant_devcommands.internal.help'
         UTIL     = VagrantPlugins::DevCommands::Util
         MESSAGES = VagrantPlugins::DevCommands::Messages
 
@@ -19,9 +21,9 @@ module VagrantPlugins
         private
 
         def body(help)
-          return message(:command_alias_no_help, true) if help.nil?
+          return message(:command_alias_no_help, pre_ln: true) if help.nil?
 
-          info(help.strip, true)
+          info(help.strip, pre_ln: true)
         end
 
         def header(command_alias)
@@ -35,15 +37,15 @@ module VagrantPlugins
           alias_for = [command_alias.command, command_alias.argv].join(' ')
 
           info(I18n.t("#{I18N_KEY}.usage", what: usage))
-          info(I18n.t("#{I18N_KEY}.alias_for", what: alias_for), true)
+          info(I18n.t("#{I18N_KEY}.alias_for", what: alias_for), pre_ln: true)
         end
 
-        def info(msg, pre_ln = false)
+        def info(msg, pre_ln: false)
           @env.ui.info '' if pre_ln
           @env.ui.info msg
         end
 
-        def message(msg, pre_ln = false)
+        def message(msg, pre_ln: false)
           if pre_ln
             MESSAGES.pre_ln(msg, &@env.ui.method(:info))
           else

data/lib/vagrant/devcommands/internal_command/completion_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module InternalCommand

data/lib/vagrant/devcommands/internal_command/help.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module InternalCommand
       # Internal "help" command
       class Help
-        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
+        I18N_KEY = 'vagrant_devcommands.internal.help'
         UTIL     = VagrantPlugins::DevCommands::Util
         MESSAGES = VagrantPlugins::DevCommands::Messages
         PRINTER  = VagrantPlugins::DevCommands::HelpPrinter
@@ -38,7 +40,7 @@ module VagrantPlugins
           end
         end
 
-        def info(msg, pre_ln = false)
+        def info(msg, pre_ln: false)
           @env.ui.info '' if pre_ln
           @env.ui.info msg
         end
@@ -49,9 +51,9 @@ module VagrantPlugins
 
         def internal_help(command)
           internal_help_header(command)
-          info(internal_commands[command].help.strip, true)
+          info(internal_commands[command].help.strip, pre_ln: true)
 
-          message(:plugin_readme, true) if command == 'help'
+          message(:plugin_readme, pre_ln: true) if command == 'help'
         end
 
         def internal_help_header(command)
@@ -68,7 +70,7 @@ module VagrantPlugins
                         @registry.commands])
         end
 
-        def message(msg, pre_ln = false)
+        def message(msg, pre_ln: false)
           if pre_ln
             MESSAGES.pre_ln(msg, &@env.ui.method(:info))
           else
@@ -90,7 +92,7 @@ module VagrantPlugins
         def plugin_help_chains(chains, pad_to)
           return if chains.empty?
 
-          info(I18n.t("#{I18N_KEY}.list.chains"), true)
+          info(I18n.t("#{I18N_KEY}.list.chains"), pre_ln: true)
 
           chains.sort.each do |name, chain|
             info(UTIL.padded_columns(pad_to, name, chain.desc))
@@ -100,7 +102,7 @@ module VagrantPlugins
         def plugin_help_commands(type, commands, pad_to)
           return if commands.empty?
 
-          info(I18n.t("#{I18N_KEY}.list.commands_#{type}"), true)
+          info(I18n.t("#{I18N_KEY}.list.commands_#{type}"), pre_ln: true)
 
           commands.sort.each do |name, command|
             info(UTIL.padded_columns(pad_to, name, command.desc))
@@ -110,7 +112,7 @@ module VagrantPlugins
         def plugin_help_command_aliases(command_aliases, pad_to)
           return if command_aliases.empty?
 
-          info(I18n.t("#{I18N_KEY}.list.command_aliases"), true)
+          info(I18n.t("#{I18N_KEY}.list.command_aliases"), pre_ln: true)
 
           command_aliases.sort.each do |name, command_alias|
             info(UTIL.padded_columns(pad_to, name, command_alias.desc))

data/lib/vagrant/devcommands/internal_command/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module InternalCommand

data/lib/vagrant/devcommands/internal_spec.rb

@@ -1,28 +1,30 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     # Contains the specs for internal commands
     class InternalSpec
-      I18N_KEY = 'vagrant_devcommands.internal'.freeze
+      I18N_KEY = 'vagrant_devcommands.internal'
 
       COMPLETION_DATA = {
-        desc:  I18n.t("#{I18N_KEY}.completion-data.desc"),
-        name:  'completion-data',
+        desc: I18n.t("#{I18N_KEY}.completion-data.desc"),
+        name: 'completion-data',
         usage: 'vagrant run %<command>s',
-        help:  I18n.t("#{I18N_KEY}.completion-data.help")
+        help: I18n.t("#{I18N_KEY}.completion-data.help")
       }.freeze
 
       HELP = {
-        desc:  I18n.t("#{I18N_KEY}.help.desc"),
-        name:  'help',
+        desc: I18n.t("#{I18N_KEY}.help.desc"),
+        name: 'help',
         usage: 'vagrant run %<command>s [command]',
-        help:  I18n.t("#{I18N_KEY}.help.help")
+        help: I18n.t("#{I18N_KEY}.help.help")
       }.freeze
 
       VERSION = {
-        desc:  I18n.t("#{I18N_KEY}.version.desc"),
-        name:  'version',
+        desc: I18n.t("#{I18N_KEY}.version.desc"),
+        name: 'version',
         usage: 'vagrant run %<command>s',
-        help:  I18n.t("#{I18N_KEY}.version.help")
+        help: I18n.t("#{I18N_KEY}.version.help")
       }.freeze
     end
   end

data/lib/vagrant/devcommands/messages.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module VagrantPlugins
   module DevCommands
     # Provides access to messages used by the plugin
     class Messages
-      I18N_KEY = 'vagrant_devcommands.message'.freeze
+      I18N_KEY = 'vagrant_devcommands.message'
 
       def self.chain_no_help(&out)
         out.call I18n.t("#{I18N_KEY}.chain_no_help")

data/lib/vagrant/devcommands/model/chain.rb

@@ -1,14 +1,11 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module Model
       # Definition of an executable command chain
       class Chain
-        attr_reader :name
-        attr_reader :commands
-
-        attr_reader :desc
-        attr_reader :help
-        attr_reader :usage
+        attr_reader :name, :commands, :desc, :help, :usage
 
         def initialize(spec)
           @name     = spec[:name]

data/lib/vagrant/devcommands/model/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module Model
@@ -5,17 +7,7 @@ module VagrantPlugins
       class Command
         PARAM_PARSER = VagrantPlugins::DevCommands::ParamParser
 
-        attr_reader :name
-
-        attr_reader :flags
-        attr_reader :parameters
-        attr_reader :script
-        attr_reader :tty
-
-        attr_reader :machine
-        attr_reader :desc
-        attr_reader :help
-        attr_reader :usage
+        attr_reader :name, :flags, :parameters, :script, :tty, :machine, :desc, :help, :usage
 
         def initialize(spec)
           @name = spec[:name]
@@ -32,14 +24,24 @@ module VagrantPlugins
         end
 
         def run_script(argv)
-          script = @script
-          script = script.call if script.is_a?(Proc)
-
           param_parser = PARAM_PARSER.new
           params       = param_parser.parse!(self, argv)
 
+          script = @script
+          script = eval_script_proc(script, params) if script.is_a?(Proc)
+
           (script % params).strip
         end
+
+        private
+
+        def eval_script_proc(script, params)
+          if script.arity == 1
+            instance_exec(params, &script)
+          else
+            instance_exec(&script)
+          end
+        end
       end
     end
   end

data/lib/vagrant/devcommands/model/command_alias.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module VagrantPlugins
@@ -5,15 +7,7 @@ module VagrantPlugins
     module Model
       # Definition of a command alias
       class CommandAlias
-        attr_reader :name
-
-        attr_reader :argv
-        attr_reader :command
-
-        attr_reader :machine
-        attr_reader :desc
-        attr_reader :help
-        attr_reader :usage
+        attr_reader :name, :argv, :command, :machine, :desc, :help, :usage
 
         def initialize(spec)
           @name = spec[:name]

data/lib/vagrant/devcommands/param_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module VagrantPlugins
@@ -11,8 +13,7 @@ module VagrantPlugins
         params = unalias_parameters(command, params)
         params = validate_parameters(command, params)
         params = escape_parameters(command, params)
-        params = wrap_parameters(command, params)
-        params
+        wrap_parameters(command, params)
       end
 
       private
@@ -41,6 +42,7 @@ module VagrantPlugins
         params
       end
 
+      # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/MethodLength
       def parse_argv(command, argv)
         params = parameters_with_defaults(command)
@@ -68,6 +70,7 @@ module VagrantPlugins
         params = passthru_parameters(params, command, argv) unless argv.empty?
         params
       end
+      # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/MethodLength
 
       def passthru_parameters(params, command, argv)
@@ -116,9 +119,7 @@ module VagrantPlugins
         command.parameters.each do |key, conf|
           next if conf[:wrap].nil?
 
-          if conf[:default].nil?
-            next if params[key].nil? || params[key].empty?
-          end
+          next if conf[:default].nil? && (params[key].nil? || params[key].empty?)
 
           params[key] = conf[:wrap] % params[key]
         end

data/lib/vagrant/devcommands/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     # Vagrant plugin definition

data/lib/vagrant/devcommands/registry/messager.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     class Registry
       # Generic registry message printer
       class Messager
-        I18N_KEY = 'vagrant_devcommands.registry'.freeze
+        I18N_KEY = 'vagrant_devcommands.registry'
 
         def initialize(env)
           @env = env
@@ -20,18 +22,18 @@ module VagrantPlugins
         end
 
         def def_duplicate(args)
-          @env.ui.warn I18n.t("#{I18N_KEY}.def_duplicate", args)
+          @env.ui.warn I18n.t("#{I18N_KEY}.def_duplicate", **args)
           @env.ui.warn ''
         end
 
         def def_ignored(message, args)
-          @env.ui.warn I18n.t("#{I18N_KEY}.#{message}", args)
+          @env.ui.warn I18n.t("#{I18N_KEY}.#{message}", **args)
           @env.ui.warn I18n.t("#{I18N_KEY}.def_ignored")
           @env.ui.warn ''
         end
 
         def unknown_options(args)
-          @env.ui.warn I18n.t("#{I18N_KEY}.unknown_options", args)
+          @env.ui.warn I18n.t("#{I18N_KEY}.unknown_options", **args)
           @env.ui.warn ''
         end
       end

data/lib/vagrant/devcommands/registry/resolver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     class Registry
@@ -21,9 +23,7 @@ module VagrantPlugins
 
             i18n_msg = 'chain_conflict_command'
 
-            if registry.reserved_command?(name)
-              i18n_msg = 'chain_conflict_internal'
-            end
+            i18n_msg = 'chain_conflict_internal' if registry.reserved_command?(name)
 
             @messager.chain_ignored(i18n_msg, name)
 
@@ -41,12 +41,9 @@ module VagrantPlugins
           end
         end
 
-        # rubocop:disable Metrics/MethodLength
         def resolve_command_alias_naming_conflicts(registry)
           registry.command_aliases.each_key do |name|
-            unless registry.valid_command?(name) || registry.valid_chain?(name)
-              next
-            end
+            next unless registry.valid_command?(name) || registry.valid_chain?(name)
 
             i18n_key = 'command'
             i18n_key = 'chain'    if registry.valid_chain?(name)
@@ -59,7 +56,6 @@ module VagrantPlugins
             registry.command_aliases.delete(name)
           end
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/vagrant/devcommands/registry/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     class Registry
@@ -22,7 +24,7 @@ module VagrantPlugins
               next if registry.valid_command?(element[:command])
 
               @messager.def_ignored('chain_missing_command',
-                                    chain:   chain,
+                                    chain: chain,
                                     command: element)
 
               registry.chains.delete(chain)
@@ -41,7 +43,7 @@ module VagrantPlugins
 
             @messager.def_ignored('command_alias_missing_command',
                                   command_alias: command_alias,
-                                  command:       cmd)
+                                  command: cmd)
 
             registry.command_aliases.delete(command_alias)
           end

data/lib/vagrant/devcommands/registry.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     # Registry for definitions from the Commandfile
     class Registry
       RESERVED_COMMANDS = %w[completion-data help version].freeze
 
-      attr_accessor :chains
-      attr_accessor :commands
-      attr_accessor :command_aliases
+      attr_accessor :chains, :commands, :command_aliases
 
       def initialize(env)
         @env      = env
@@ -17,8 +17,8 @@ module VagrantPlugins
         @command_aliases = {}
 
         @duplicates = {
-          'chains'          => [],
-          'commands'        => [],
+          'chains' => [],
+          'commands' => [],
           'command_aliases' => []
         }
       end

data/lib/vagrant/devcommands/runner/chain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module Runner

data/lib/vagrant/devcommands/runner/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module Runner
@@ -23,8 +25,8 @@ module VagrantPlugins
           @plugin.proxy_with_target_vms(machine, single_target: true) do |vm|
             env = vm.action(:ssh_run,
                             ssh_run_command: script,
-                            ssh_opts:        { extra_args: ['-q'] },
-                            tty:             command.tty)
+                            ssh_opts: { extra_args: ['-q'] },
+                            tty: command.tty)
 
             return env[:ssh_run_exit_status] || 0
           end
@@ -67,7 +69,7 @@ module VagrantPlugins
 
           raise I18n.t('vagrant_devcommands.runner.script_error',
                        command: command,
-                       error:   error)
+                       error: error)
         end
       end
     end

data/lib/vagrant/devcommands/runner/command_alias.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module Runner

data/lib/vagrant/devcommands/runner/internal_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     module Runner
@@ -43,7 +45,7 @@ module VagrantPlugins
               @env, @registry
             ),
 
-            'help'    => NAMESPACE_CMD::Help.new(@env, @registry),
+            'help' => NAMESPACE_CMD::Help.new(@env, @registry),
             'version' => NAMESPACE_CMD::Version.new(@env)
           }
         end

data/lib/vagrant/devcommands/synopsis.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   # Defines the plugin synopsis
   module DevCommands
-    SYNOPSIS = 'Runs vagrant commands from a Commandfile'.freeze
+    SYNOPSIS = 'Runs vagrant commands from a Commandfile'
   end
 end

data/lib/vagrant/devcommands/util/jaro_winkler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     class Util
@@ -73,6 +75,7 @@ module VagrantPlugins
           end
         end
 
+        # rubocop:disable Metrics/AbcSize
         # rubocop:disable Metrics/MethodLength
         def find_common_characters
           common_chars_of_shorter = Array.new(@shorter.size)
@@ -96,6 +99,7 @@ module VagrantPlugins
 
           [common_chars_of_shorter, common_chars_of_longer].map(&:compact)
         end
+        # rubocop:enable Metrics/AbcSize
         # rubocop:enable Metrics/MethodLength
 
         def limited_common_prefix_length
@@ -110,7 +114,7 @@ module VagrantPlugins
 
         def matching_index_range(origin)
           min = origin - matching_window
-          min = 0 if min < 0
+          min = 0 if min.negative?
 
           max = origin + matching_window
 

data/lib/vagrant/devcommands/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module DevCommands
     # Utility module
@@ -20,13 +22,13 @@ module VagrantPlugins
 
       def self.collect_mandatory_params(params)
         params.collect do |key, opts|
-          "--#{key}=<#{key}>" unless opts[:optional]
+          "--#{key}=<#{key}>" unless opts[:optional] || opts[:default]
         end
       end
 
       def self.collect_optional_params(params)
         params.collect do |key, opts|
-          "[--#{key}=<#{key}>]" if opts[:optional]
+          "[--#{key}=<#{key}>]" if opts[:optional] || opts[:default]
         end
       end
 

data/lib/vagrant/devcommands/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   # Defines the current plugin version
   module DevCommands
-    VERSION = '0.13.0'.freeze
+    VERSION = '0.14.0'
   end
 end

data/lib/vagrant/devcommands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vagrant'
 
 I18n.load_path << File.expand_path('../../locales/en.yml', __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Marc Neudert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -30,44 +30,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: 1.12.0
 description: Vagrant plugin to run commands specified in a Commandfile inside one
-  of your vagrant boxes
+  of your Vagrant boxes
 email:
 - marc.neudert@gmail.com
 executables: []
@@ -113,7 +113,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,16 +121,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Runs vagrant commands from a Commandfile
 test_files: []