vagrant-devcommands 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08d7a51ae5cc5cc9d25df475e2724c86d040db68249141512a4b6b6a618919cd'
-  data.tar.gz: 362279f7c92feb9f9ecf0b90de497a99df5fb41f362713e28b92b1b94d167752
+  metadata.gz: 752833dc9227565eb5c6f9e3c9b2a2879aa4042af9ce6be42025efe6509e132b
+  data.tar.gz: a177ba8899bfc7eb2b72c227a30dfcbe8c7317369ccfdc474d6f3082fec3be28
 SHA512:
-  metadata.gz: 43e5dd302ca02025014a022557176f2e590b7bd96b1f3a8c5db708320c5ec56960cfc7039b1f5b806b60185e93e6940b51ca7ce4009c150944e1a55f0f27e9aa
-  data.tar.gz: 37c8f76d57a861f730cddbeef9bafe5d053c3f85a07f37e3267a201ec057d72e3e82e3e7b27bf6ff5dd8526f7c85260918a095fe23816d90e4f794c88fe9f01b
+  metadata.gz: 19c515bc5e4c2568f6fcc3a98b9389a345aff32bf56507be78f4653dda45d84d4887730a33e96c5e8a5bc58d98775dae7f7aed1f5a95ab4cb84359ab36953d90
+  data.tar.gz: 3af910e8e9e666ae68caa24faba6e79417aac33cf39086d568bc42404292d0501e42e9d69a132da27c9eec064beff4e21eacaa4e6a22d3049b03be7dafe1c80a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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))
+
 ## v0.12.0 (2018-04-21)
 
 - Enhancements

data/README.md

@@ -2,7 +2,6 @@
 
 Runs vagrant commands from a Commandfile.
 
-
 ## Usage
 
 ### Command Listing
@@ -86,9 +85,21 @@ command 'with_param',
     # parameters with a limited set of allowed values
     # the allowed values are checked prior to escaping/wrapping!
     # optional parameters are only validated if given!
-    p_limited: { allowed: ['completely'] }
+    p_limited: { allowed: ['completely'] },
+
+    # you can define a specific parameter to receive
+    # all otherwise unknown parameters and flags
+    p_passthru: { optional: true, passthru: true }
   },
-  script: 'echo %<p_mandatory>s %<p_default>s %<p_escaped>s %<p_optional>s %<p_wrapped>s %<p_limited>s'
+  script: %(
+    echo %<p_mandatory>s \
+         %<p_default>s \
+         %<p_escaped>s \
+         %<p_optional>s \
+         %<p_wrapped>s \
+         %<p_limited>s \
+         %<p_passthru>s
+  )
 ```
 
 This allows you to execute the following command:
@@ -105,7 +116,7 @@ vagrant run with_param \
     --p_mandatory works \
     --p_default sometimes \
     --p_optional 'like a charm' \
-    --p_wrapped is
+    --p_wrapped is \
     --p_limited completely
 ```
 
@@ -172,7 +183,6 @@ command 'interactive', tty: true
 
 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
@@ -340,7 +350,6 @@ vagrant run completion-data
 vagrant run completion-data my-command
 ```
 
-
 ## Notes for Windows Users
 
 ### SSH
@@ -369,6 +378,16 @@ 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
+
+You can always install the plugin directly from source:
+
+```shell
+gem build vagrant-devcommands.gemspec
+
+vagrant plugin uninstall vagrant-devcommands
+vagrant plugin install vagrant-devcommands-x.x.x.dev.gem
+```
 
 ## License
 

data/lib/vagrant/devcommands.rb

@@ -8,6 +8,7 @@ require 'vagrant/devcommands/version'
 
 require 'vagrant/devcommands/internal_spec'
 require 'vagrant/devcommands/messages'
+require 'vagrant/devcommands/param_parser'
 require 'vagrant/devcommands/util/jaro_winkler'
 require 'vagrant/devcommands/util'
 

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

@@ -1,10 +1,10 @@
-require 'optparse'
-
 module VagrantPlugins
   module DevCommands
     module Model
       # Definition of an executable command
       class Command
+        PARAM_PARSER = VagrantPlugins::DevCommands::ParamParser
+
         attr_reader :name
 
         attr_reader :flags
@@ -35,105 +35,10 @@ module VagrantPlugins
           script = @script
           script = script.call if script.is_a?(Proc)
 
-          opts = {}
-          opts = parse_argv(argv) unless @flags.empty? && @parameters.empty?
-
-          (script % opts).strip
-        end
-
-        private
-
-        def escape_parameters(params)
-          @parameters.each do |key, conf|
-            next if conf[:escape].nil?
-
-            conf[:escape].each do |char, with|
-              char        = char.to_s unless char.is_a?(String)
-              params[key] = params[key].sub(char, "#{with}#{char}")
-            end
-          end
-
-          params
-        end
-
-        def parameters_with_defaults
-          params = {}
-
-          @parameters.each do |key, conf|
-            params[key] = '' if conf[:optional]
-            params[key] = conf[:default] unless conf[:default].nil?
-          end
-
-          params
-        end
-
-        # rubocop:disable Metrics/MethodLength
-        def parse_argv(argv)
-          params = parameters_with_defaults
-
-          OptionParser.new do |opts|
-            @flags.each do |key, conf|
-              params[key] = ''
-
-              opts.on("--#{key}", "Flag: #{key}") do
-                params[key] = conf[:value] || "--#{key}"
-              end
-            end
-
-            @parameters.each_key do |key|
-              opts.on("--#{key} OPTION", "Parameter: #{key}") do |o|
-                params[key] = o
-              end
-            end
-          end.parse!(argv)
-
-          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?
-            next if params[key] == '' && conf[:optional]
-
-            next if conf[:allowed].nil?
-            next if conf[:allowed].include?(params[key])
-
-            raise ArgumentError, "--#{key}=#{params[key]}"
-          end
-
-          params
-        end
-
-        def wrap_parameters(params)
-          @parameters.each do |key, conf|
-            next if conf[:wrap].nil?
-
-            if conf[:default].nil?
-              next if params[key].nil? || params[key].empty?
-            end
-
-            params[key] = conf[:wrap] % params[key]
-          end
+          param_parser = PARAM_PARSER.new
+          params       = param_parser.parse!(self, argv)
 
-          params
+          (script % params).strip
         end
       end
     end

data/lib/vagrant/devcommands/param_parser.rb

@@ -0,0 +1,130 @@
+require 'optparse'
+
+module VagrantPlugins
+  module DevCommands
+    # Command Parameter Parser
+    class ParamParser
+      def parse!(command, argv)
+        return {} if command.flags.empty? && command.parameters.empty?
+
+        params = parse_argv(command, argv)
+        params = unalias_parameters(command, params)
+        params = validate_parameters(command, params)
+        params = escape_parameters(command, params)
+        params = wrap_parameters(command, params)
+        params
+      end
+
+      private
+
+      def escape_parameters(command, params)
+        command.parameters.each do |key, conf|
+          next if conf[:escape].nil?
+
+          conf[:escape].each do |char, with|
+            char        = char.to_s unless char.is_a?(String)
+            params[key] = params[key].sub(char, "#{with}#{char}")
+          end
+        end
+
+        params
+      end
+
+      def parameters_with_defaults(command)
+        params = {}
+
+        command.parameters.each do |key, conf|
+          params[key] = '' if conf[:optional]
+          params[key] = conf[:default] unless conf[:default].nil?
+        end
+
+        params
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def parse_argv(command, argv)
+        params = parameters_with_defaults(command)
+
+        begin
+          OptionParser.new do |opts|
+            command.flags.each do |key, conf|
+              params[key] = ''
+
+              opts.on("--#{key}", "Flag: #{key}") do
+                params[key] = conf[:value] || "--#{key}"
+              end
+            end
+
+            command.parameters.each_key do |key|
+              opts.on("--#{key} OPTION", "Parameter: #{key}") do |o|
+                params[key] = o
+              end
+            end
+          end.parse!(argv)
+        rescue OptionParser::InvalidOption => e
+          e.recover(argv)
+        end
+
+        params = passthru_parameters(params, command, argv) unless argv.empty?
+        params
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def passthru_parameters(params, command, argv)
+        has_passthru = false
+
+        command.parameters.each do |key, conf|
+          next unless conf[:passthru]
+
+          params[key]  = argv.join(' ')
+          has_passthru = true
+        end
+
+        raise OptionParser::InvalidOption, argv unless has_passthru
+
+        params
+      end
+
+      def unalias_parameters(command, params)
+        command.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(command, params)
+        command.parameters.each do |key, conf|
+          next if params[key].nil?
+          next if params[key] == '' && conf[:optional]
+
+          next if conf[:allowed].nil?
+          next if conf[:allowed].include?(params[key])
+
+          raise ArgumentError, "--#{key}=#{params[key]}"
+        end
+
+        params
+      end
+
+      def wrap_parameters(command, params)
+        command.parameters.each do |key, conf|
+          next if conf[:wrap].nil?
+
+          if conf[:default].nil?
+            next if params[key].nil? || params[key].empty?
+          end
+
+          params[key] = conf[:wrap] % params[key]
+        end
+
+        params
+      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.12.0'.freeze
+    VERSION = '0.13.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2018-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: '0.58'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: '0.58'
 description: Vagrant plugin to run commands specified in a Commandfile inside one
   of your vagrant boxes
 email:
@@ -93,6 +93,7 @@ files:
 - lib/vagrant/devcommands/model/chain.rb
 - lib/vagrant/devcommands/model/command.rb
 - lib/vagrant/devcommands/model/command_alias.rb
+- lib/vagrant/devcommands/param_parser.rb
 - lib/vagrant/devcommands/plugin.rb
 - lib/vagrant/devcommands/registry.rb
 - lib/vagrant/devcommands/registry/messager.rb