vagrant-devcommands 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd051c66c3c698629e9eeac65aab7f359e7ee230
-  data.tar.gz: e607628cc652b04882a226f7b10def7b32152298
+SHA256:
+  metadata.gz: '08d7a51ae5cc5cc9d25df475e2724c86d040db68249141512a4b6b6a618919cd'
+  data.tar.gz: 362279f7c92feb9f9ecf0b90de497a99df5fb41f362713e28b92b1b94d167752
 SHA512:
-  metadata.gz: 25c8ef756decf39dbce7050799b841e4c4e2aefb4091fd13e12ee221e593efd0434e05e6bfb70b54fc096d473907afe2045d4427960b1878f7f19f2b75fcc1bb
-  data.tar.gz: 8cfa604c43f53e037666378517df766b54ba936b9c428ae89e90fa950d3f2729fc66827c2911ed56e9d494e32234587dc09e935d771afff33d01772b4cc74faa
+  metadata.gz: 43e5dd302ca02025014a022557176f2e590b7bd96b1f3a8c5db708320c5ec56960cfc7039b1f5b806b60185e93e6940b51ca7ce4009c150944e1a55f0f27e9aa
+  data.tar.gz: 37c8f76d57a861f730cddbeef9bafe5d053c3f85a07f37e3267a201ec057d72e3e82e3e7b27bf6ff5dd8526f7c85260918a095fe23816d90e4f794c88fe9f01b

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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 unknown options will issue a warning
+
+- Backwards incompatible changes
+  - Support for the already deprecated configuration parameter `:box` has
+    been removed
+
 ## v0.11.1 (2017-10-04)
 
 - Bug fixes

data/README.md

@@ -32,7 +32,7 @@ Add to a `Commandfile` besides your `Vagrantfile`:
 command 'basic', 'hostname'
 
 command 'with_options',
-  machine: :my_machine,
+  machine: 'my_machine',
   desc: 'executes "hostname" on the machine "my_machine"',
   script: 'hostname',
   tty: true,
@@ -47,7 +47,7 @@ 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"`.
+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.
@@ -64,10 +64,10 @@ sprintf syntax:
 command 'with_param',
   parameters: {
     # mandatory parameter with a description
-    p_mandatory: { desc: "mandatory parameter to do... stuff!" },
+    p_mandatory: { desc: 'mandatory parameter to do... stuff!' },
 
     # parameter with default (implies optional)
-    p_default: { default: "always" },
+    p_default: { default: 'always' },
 
     # parameter with escaping rule
     p_escaped: { escape: { '*' => '\\' }},
@@ -76,7 +76,12 @@ command 'with_param',
     p_optional: { optional: true },
 
     # wrapped option value
-    p_wrapped: { wrap: "--and %s wrapped" }
+    p_wrapped: { wrap: '--and %s wrapped' },
+
+    # parameters with aliased values
+    # the aliases are resolved prior to escaping/wrapping/allowance!
+    # aliases are resolved in order of definition (multiple can apply)
+    p_aliased: { aliases: { 'foo' => 'bar' }},
 
     # parameters with a limited set of allowed values
     # the allowed values are checked prior to escaping/wrapping!
@@ -89,17 +94,17 @@ command 'with_param',
 This allows you to execute the following command:
 
 ```shell
-# will execute 'echo works always'
+# will execute 'echo "works always"'
 vagrant run with_param --p_mandatory works
 
-# will execute 'echo works always like a charm'
-vagrant run with_param --p_mandatory works --p_optional "like a charm"
+# will execute 'echo "works always like a charm"'
+vagrant run with_param --p_mandatory works --p_optional 'like a charm'
 
-# will execute 'echo works sometimes like a charm --and is wrapped completely'
+# will execute 'echo "works sometimes like a charm --and is wrapped completely"'
 vagrant run with_param \
     --p_mandatory works \
     --p_default sometimes \
-    --p_optional "like a charm" \
+    --p_optional 'like a charm' \
     --p_wrapped is
     --p_limited completely
 ```
@@ -108,7 +113,7 @@ 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" }`.
+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.
 
@@ -120,8 +125,8 @@ for later command interpolation:
 ```ruby
 command 'with_flags',
   flags: {
-    f_standard: { desc: "standard flag" },
-    f_valued:   { value: "--f_modified" }
+    f_standard: { desc: 'standard flag' },
+    f_valued:   { value: '--f_modified' }
   },
   script: 'echo "flags: %<f_standard>s"'
 ```
@@ -139,7 +144,7 @@ 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
+By default a flag gets interpolated as `--#{flagname}`. If a value is defined
 this value will be interpolated unmodified.
 
 #### Commands defined by Lambda/Proc
@@ -154,7 +159,19 @@ command 'from_proc', script: proc { 'echo "proc works"' }
 
 These will be evaluated when running the command.
 
-Every rule from regular scripts (parameters, escaping "%", ...) still apply.
+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:
+
+```ruby
+command 'interactive', tty: true
+```
+
+This allows full interaction with programs like `irb` or `mysql`.
+
 
 ### Global Command Definitions
 
@@ -222,11 +239,11 @@ chain 'my_customized_chain',
 Running the chain will execute the following commands:
 
 ```shell
-> vagrant run my_customized_chain --first="initial" --second="initial"
+> vagrant run my_customized_chain --first='initial' --second='initial'
 
-vagrant run chainecho --first="param" --second="initial"
-vagrant run chainecho --first="initial" --second="initial"
-vagrant run chainecho --first="param" --second="param"
+vagrant run chainecho --first='param' --second='initial'
+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
@@ -286,7 +303,7 @@ 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.
 
-### Experimental: Command Alias Definitions
+### 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:
@@ -340,9 +357,9 @@ a sigil notation like the following:
 ```ruby
 command 'long_running_task',
   script: %(cd /path/to/somewhere \
-                && echo "starting long running task" \
+                && echo 'starting long running task' \
                 && ./long_running_task.sh \
-                && echo "finished long running task")
+                && echo 'finished long running task')
 ```
 
 Using a quote delimited command definition might otherwise result in not that

data/lib/vagrant/devcommands.rb

@@ -1,6 +1,6 @@
 require 'vagrant'
 
-I18n.load_path << File.expand_path('../../../locales/en.yml', __FILE__)
+I18n.load_path << File.expand_path('../../locales/en.yml', __dir__)
 I18n.reload!
 
 require 'vagrant/devcommands/synopsis'

data/lib/vagrant/devcommands/command.rb

@@ -19,8 +19,6 @@ module VagrantPlugins
       def execute
         return 127 unless read_commandfile
 
-        deprecated_box_config?
-
         command = Util.argv_command(@argv, @env)
 
         return 127 unless non_empty?(command)
@@ -47,12 +45,6 @@ module VagrantPlugins
         @registry.available?(command)
       end
 
-      def deprecated_box_config?
-        return unless @registry.commands.values.any?(&:deprecated_box_config)
-
-        Messages.deprecated_box_config(&@env.ui.method(:warn))
-      end
-
       def display_alternatives(command)
         alternatives = Util.did_you_mean(command, @registry)
         alternatives = alternatives.select { |_k, v| v > 0.8 }

data/lib/vagrant/devcommands/messages.rb

@@ -18,11 +18,6 @@ module VagrantPlugins
         out.call I18n.t("#{I18N_KEY}.command_no_help")
       end
 
-      def self.deprecated_box_config(&out)
-        out.call I18n.t("#{I18N_KEY}.deprecated_box_config")
-        out.call ''
-      end
-
       def self.missing_commandfile(&out)
         out.call I18n.t("#{I18N_KEY}.missing_commandfile")
       end

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

@@ -17,9 +17,6 @@ module VagrantPlugins
         attr_reader :help
         attr_reader :usage
 
-        attr_reader :deprecated_box_config
-
-        # rubocop:disable Metrics/AbcSize
         def initialize(spec)
           @name = spec[:name]
 
@@ -28,14 +25,11 @@ module VagrantPlugins
           @script     = spec[:script]
           @tty        = spec[:tty] == true
 
-          @machine = spec[:machine] || spec[:box]
+          @machine = spec[:machine]
           @desc    = spec[:desc]
           @help    = spec[:help]
           @usage   = spec[:usage]
-
-          @deprecated_box_config = spec.key?(:box)
         end
-        # rubocop:enable Metrics/AbcSize
 
         def run_script(argv)
           script = @script
@@ -93,10 +87,27 @@ module VagrantPlugins
             end
           end.parse!(argv)
 
-          wrap_parameters(escape_parameters(validate_parameters(params)))
+          params = unalias_parameters(params)
+          params = validate_parameters(params)
+          params = escape_parameters(params)
+          params = wrap_parameters(params)
+          params
         end
         # rubocop:enable Metrics/MethodLength
 
+        def unalias_parameters(params)
+          @parameters.each do |key, conf|
+            next if params[key].nil?
+            next if conf[:aliases].nil?
+
+            conf[:aliases].each do |input, output|
+              params[key] = params[key] == input ? output : params[key]
+            end
+          end
+
+          params
+        end
+
         def validate_parameters(params)
           @parameters.each do |key, conf|
             next if params[key].nil?

data/lib/vagrant/devcommands/registry.rb

@@ -15,6 +15,12 @@ module VagrantPlugins
         @chains          = {}
         @commands        = {}
         @command_aliases = {}
+
+        @duplicates = {
+          'chains'          => [],
+          'commands'        => [],
+          'command_aliases' => []
+        }
       end
 
       def available?(name)
@@ -46,12 +52,54 @@ module VagrantPlugins
 
       private
 
+      def check_model(model, entry)
+        speccheck_model(model, entry)
+        dupcheck_model(model)
+      end
+
+      def dupcheck_model(model)
+        type         = model_attr(model)
+        type_attr    = "@#{type}"
+        type_entries = instance_variable_get(type_attr)
+
+        return unless type_entries[model.name]
+        return if @duplicates[type].include?(model.name)
+
+        @messager.def_duplicate(what: model_name(model), name: model.name)
+        @duplicates[type] << model.name
+      end
+
+      def model_attr(model)
+        case model
+        when Model::Chain
+          'chains'
+        when Model::Command
+          'commands'
+        when Model::CommandAlias
+          'command_aliases'
+        end
+      end
+
+      def model_name(model)
+        case model
+        when Model::Chain
+          'chain'
+        when Model::Command
+          'command'
+        when Model::CommandAlias
+          'command alias'
+        end
+      end
+
       def register(commandfile_entries)
         modeler = Commandfile::Modeler.new
 
         commandfile_entries.each do |entry|
           begin
-            register_model(modeler.model(entry))
+            model = modeler.model(entry)
+
+            check_model(model, entry)
+            register_model(model)
           rescue ArgumentError => e
             @messager.def_ignored(e.message, name: entry[:name])
           end
@@ -59,9 +107,24 @@ module VagrantPlugins
       end
 
       def register_model(model)
-        @chains[model.name]          = model if model.is_a?(Model::Chain)
-        @commands[model.name]        = model if model.is_a?(Model::Command)
-        @command_aliases[model.name] = model if model.is_a?(Model::CommandAlias)
+        type         = model_attr(model)
+        type_attr    = "@#{type}"
+        type_entries = instance_variable_get(type_attr)
+
+        type_entries[model.name] = model
+
+        instance_variable_set(type_attr, type_entries)
+      end
+
+      def speccheck_model(model, spec)
+        return unless spec[:options].is_a?(Hash)
+
+        model_attrs = model.instance_variables
+        spec_attrs  = spec[:options].keys.map { |k| :"@#{k}" }
+
+        return if (spec_attrs - model_attrs).empty?
+
+        @messager.unknown_options(what: model_name(model), name: model.name)
       end
     end
   end

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

@@ -19,11 +19,21 @@ module VagrantPlugins
           @env.ui.warn I18n.t("#{I18N_KEY}.command_alias_ignored")
         end
 
+        def 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}.def_ignored")
           @env.ui.warn ''
         end
+
+        def unknown_options(args)
+          @env.ui.warn I18n.t("#{I18N_KEY}.unknown_options", args)
+          @env.ui.warn ''
+        end
       end
     end
   end

data/lib/vagrant/devcommands/version.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   # Defines the current plugin version
   module DevCommands
-    VERSION = '0.11.1'.freeze
+    VERSION = '0.12.0'.freeze
   end
 end

data/locales/en.yml

@@ -29,10 +29,6 @@ en:
       chain_no_help: No detailed help for this chain available.
       command_alias_no_help: No detailed help for this command alias available.
       command_no_help: No detailed help for this command available.
-      deprecated_box_config: |-
-        At least one of your commands is configured with the deprecated
-        option ':box'. This option has been renamed to ':machine' and will
-        stop working in a future version. Please update your Commandfile.
       missing_commandfile: Missing Commandfile
       no_commands: No commands defined!
       plugin_readme: |-
@@ -61,6 +57,8 @@ en:
       command_no_script: "The command '%<name>s' has no script defined to execute."
       command_reserved: "The command name '%<name>s' is reserved for internal usage."
       def_ignored: Your definition of it will be ignored.
+      def_duplicate: "The %<what>s name '%<name>s' is used more than once. Only the last definition will be available."
+      unknown_options: "The %<what>s '%<name>s' is defined with at least one unknown option."
 
     runner:
       invalid_parameter: "invalid parameter '%<detail>s'"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2018-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.55'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.55'
 description: Vagrant plugin to run commands specified in a Commandfile inside one
   of your vagrant boxes
 email:
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Runs vagrant commands from a Commandfile