vagrant-devcommands 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cdd09f90d6b080675f4b15e4fb9ec4ce3101cf2
-  data.tar.gz: 9968d30256b15ce9247ad33c39e1e1c39a3b6daf
+  metadata.gz: 9050521052b96dc86341f385a13b9f7a86e9d9b7
+  data.tar.gz: f53326e688ccd00e6a60b6cca80996510cf5d253
 SHA512:
-  metadata.gz: aa62d03f315aab6378feb9f9ffff8d7c3f3f22930c2b7ab177ab7afea46e34761a7cab7a5c08c4ce249cff2d6e51e288fb6a1d274663ff21b529c5d242bed272
-  data.tar.gz: 6581d21c82f57b249c645844f4e64a5cebe36c4e5171a2992e1a9a9ba914fb4ae710b3d5ae7bfcbe56deb021e5f273910071acfdf655eedf3219d99b85419533
+  metadata.gz: 6153595b35c47a8f770d1a4dccdc3affe5fd816b5d8ee17c70922f13a1b19dde80ff2d38bf51f3eebee7222f728620cf3adcf09e83153100896e85465ca751fe
+  data.tar.gz: 3e684a23dcd43765a00283771f2106eec4b79940e534cfc5c2c534ea9355df6ab5913d7056995d8306bc6c23b8cf28122df276f29849211815ef70b223d2fc61

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 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
+  - 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
+
+- 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
+
 ## v0.9.0 (2017-05-20)
 
 - Enhancements

data/README.md

@@ -35,19 +35,22 @@ command 'with_options',
   machine: :my_machine,
   desc: 'executes "hostname" on the machine "my_machine"',
   script: 'hostname',
-  usage: 'vagrant run %{command}',
+  usage: 'vagrant run %<command>s',
   help: <<-eoh
 I am the help message for the command "with_options".
 I get displayed when running "vagrant run help with_options".
 
 The usage printed above the help can interpolate the name
-of the command name using %{command}.
+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_: Spaces in command names are not supported. Definitions with spaces will
+be ignored.
+
 #### Commands with Parameters
 
 Passing additional parameters to a command is (minimally) supported using an
@@ -70,8 +73,13 @@ command 'with_param',
 
     # wrapped option value
     p_wrapped: { wrap: "--and %s wrapped" }
+
+    # 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'] }
   },
-  script: 'echo %{p_mandatory} %{p_default} %{p_escaped} %{p_optional} %{p_wrapped}'
+  script: 'echo %<p_mandatory>s %<p_default>s %<p_escaped>s %<p_optional>s %<p_wrapped>s %<p_limited>s'
 ```
 
 This allows you to execute the following command:
@@ -83,12 +91,13 @@ 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 sometimes like a charm --and is wrapped'
+# 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_wrapped is
+    --p_limited completely
 ```
 
 For now a command expecting one or more parameters will fail if the user does
@@ -110,7 +119,7 @@ command 'with_flags',
     f_standard: { desc: "standard flag" },
     f_valued:   { value: "--f_modified" }
   },
-  script: 'echo "flags: %{f_standard}"'
+  script: 'echo "flags: %<f_standard>s"'
 ```
 
 This definition allows the following executions:
@@ -157,7 +166,7 @@ ruby -e "require 'pathname'; puts Pathname.new(Dir.home).join('.vagrant.devcomma
 
 Any commands defined there will silently be overwritten by a local definition.
 
-### Experimental: Chain Definitions
+### Chain Definitions
 
 You can define command chains to execute multiple commands in order:
 
@@ -175,7 +184,7 @@ I am the help message for the chain "my_chain".
 I get displayed when running "vagrant run help my_chain".
 
 The usage printed above the help can interpolate the name
-of the command name using %{command}.
+of the command name using %<command>s.
 eoh
 ```
 
@@ -188,6 +197,9 @@ 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.
+
 #### Chain Definitions with Pre-Defined Parameters
 
 If required you can modify the arguments given to each chain element by setting
@@ -196,7 +208,7 @@ additional/custom argv values for a single chain element:
 ```ruby
 command 'chainecho',
   parameters: { first: {}, second: {} },
-  script: 'echo %{first} %{second}'
+  script: 'echo %<first>s %<second>s'
 
 chain 'my_customized_chain',
   commands: [
@@ -234,6 +246,7 @@ chain 'customized_chain_machine',
     { command: 'chainecho', machine: 'secondary' },
     { command: 'chainecho', machine: 'tertiary' }
   ]
+```
 
 Running the chain will execute the following commands:
 
@@ -272,6 +285,18 @@ 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: Shell Completion
+
+Completion data for your shell is available via internal command:
+
+```shell
+# list commands
+vagrant run completion-data
+
+# list command flags/parameters
+vagrant run completion-data my-command
+```
+
 
 ## Notes for Windows Users
 

data/lib/vagrant/devcommands/command.rb

@@ -2,10 +2,6 @@ module VagrantPlugins
   module DevCommands
     # Defines the executable vagrant command
     class Command < Vagrant.plugin(2, :command)
-      NAMESPACE_RUNNER = VagrantPlugins::DevCommands::Runner
-      MESSAGES         = VagrantPlugins::DevCommands::Messages
-      UTIL             = VagrantPlugins::DevCommands::Util
-
       def self.synopsis
         synopsis = VagrantPlugins::DevCommands::SYNOPSIS
 
@@ -43,8 +39,7 @@ module VagrantPlugins
       def available?(command)
         unless @registry.available?(command)
           display_error("Invalid command \"#{command}\"!")
-          did_you_mean(command)
-          run_internal('help', ['--commands'])
+          display_alternatives(command)
         end
 
         @registry.available?(command)
@@ -53,13 +48,22 @@ module VagrantPlugins
       def deprecated_box_config?
         return unless @registry.commands.values.any?(&:deprecated_box_config)
 
-        MESSAGES.deprecated_box_config(&@env.ui.method(:warn))
+        Messages.deprecated_box_config(&@env.ui.method(:warn))
       end
 
-      def did_you_mean(command)
-        alternative, score = Util.did_you_mean(command, @registry)
+      def display_alternatives(command)
+        alternatives = Util.did_you_mean(command, @registry)
+        alternatives = alternatives.select { |_k, v| v > 0.8 }
+
+        return false if alternatives.empty?
+
+        if alternatives.length == 1
+          display_error('Did you mean this?', true)
+        else
+          display_error('Did you mean one of these?', true)
+        end
 
-        display_error("Did you mean #{alternative}?", true) if 0.8 < score
+        alternatives.sort.each { |k, _v| display_error("        #{k}") }
       end
 
       def display_error(msg, pre_ln = false, post_ln = false)
@@ -81,8 +85,8 @@ module VagrantPlugins
         commandfile = Commandfile.new(@env)
 
         unless commandfile.exist?
-          MESSAGES.missing_commandfile(&@env.ui.method(:error))
-          MESSAGES.pre_ln(:plugin_readme, &@env.ui.method(:info))
+          Messages.missing_commandfile(&@env.ui.method(:error))
+          Messages.pre_ln(:plugin_readme, &@env.ui.method(:info))
 
           return false
         end
@@ -105,7 +109,7 @@ module VagrantPlugins
       end
 
       def run_internal(command, args = nil)
-        runner = NAMESPACE_RUNNER::InternalCommand.new(
+        runner = Runner::InternalCommand.new(
           self, @argv, @env, @registry
         )
 
@@ -122,9 +126,9 @@ module VagrantPlugins
 
       def runner_for(command)
         if @registry.valid_command?(command)
-          NAMESPACE_RUNNER::Command.new(self, @argv, @env, @registry)
+          Runner::Command.new(self, @argv, @env, @registry)
         else
-          NAMESPACE_RUNNER::Chain.new(self, @argv, @env, @registry)
+          Runner::Chain.new(self, @argv, @env, @registry)
         end
       end
     end

data/lib/vagrant/devcommands/commandfile.rb

@@ -9,7 +9,7 @@ module VagrantPlugins
       end
 
       def exist?
-        nil != path
+        path != nil
       end
 
       def path

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

@@ -20,7 +20,7 @@ module VagrantPlugins
         private
 
         def arguments(arguments, title)
-          return if arguments.nil?
+          return if arguments.nil? || arguments.empty?
 
           info("#{title}:", true)
           arguments_body(arguments)
@@ -67,9 +67,9 @@ module VagrantPlugins
         def usage_params(usage, command)
           [
             usage,
-            UTIL.collect_mandatory_params(command.parameters || {}),
-            UTIL.collect_optional_params(command.parameters || {}),
-            UTIL.collect_flags(command.flags || {})
+            UTIL.collect_mandatory_params(command.parameters),
+            UTIL.collect_optional_params(command.parameters),
+            UTIL.collect_flags(command.flags)
           ].flatten.compact.join(' ').strip
         end
       end

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

@@ -0,0 +1,52 @@
+module VagrantPlugins
+  module DevCommands
+    module InternalCommand
+      # Internal "completion-data" command
+      class CompletionData
+        def initialize(env, registry)
+          @env      = env
+          @registry = registry
+        end
+
+        def execute(argv)
+          return if @registry.commands.empty?
+
+          command  = VagrantPlugins::DevCommands::Util.argv_command(argv, @env)
+          compdata =
+            if command.nil?
+              command_completion
+            else
+              argument_completion(command)
+            end
+
+          @env.ui.info(compdata, new_line: false)
+        end
+
+        private
+
+        def argument_completion(command)
+          spec = registry_spec(command)
+
+          return '' if spec.nil?
+
+          (spec.flags.keys + spec.parameters.keys).sort.join(' ')
+        end
+
+        def command_completion
+          (
+            @registry.chains.keys +
+            @registry.commands.keys +
+            VagrantPlugins::DevCommands::Registry::RESERVED_COMMANDS
+          ).sort.join(' ')
+        end
+
+        def registry_spec(name)
+          return nil if @registry.reserved_command?(name)
+          return @registry.commands[name] if @registry.valid_command?(name)
+
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -46,7 +46,7 @@ module VagrantPlugins
           internal_help_header(command)
           info(internal_commands[command].help.strip, true)
 
-          message(:plugin_readme, true) if 'help' == command
+          message(:plugin_readme, true) if command == 'help'
         end
 
         def internal_help_header(command)
@@ -65,7 +65,7 @@ module VagrantPlugins
         end
 
         def plugin_help(command)
-          message(:plugin_usage) unless '--commands' == command
+          message(:plugin_usage) unless command == '--commands'
 
           pad_to = UTIL.max_pad([internal_commands,
                                  @registry.commands,

data/lib/vagrant/devcommands/internal_spec.rb

@@ -4,17 +4,24 @@ module VagrantPlugins
     class InternalSpec
       I18N_KEY = 'vagrant_devcommands.internal'.freeze
 
+      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")
+      }.freeze
+
       HELP = {
         desc:  I18n.t("#{I18N_KEY}.help.desc"),
         name:  'help',
-        usage: 'vagrant run %{command} [command]',
+        usage: 'vagrant run %<command>s [command]',
         help:  I18n.t("#{I18N_KEY}.help.help")
       }.freeze
 
       VERSION = {
         desc:  I18n.t("#{I18N_KEY}.version.desc"),
         name:  'version',
-        usage: 'vagrant run %{command}',
+        usage: 'vagrant run %<command>s',
         help:  I18n.t("#{I18N_KEY}.version.help")
       }.freeze
     end

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

@@ -16,7 +16,7 @@ module VagrantPlugins
           @desc = spec[:desc]
           @help = spec[:help]
 
-          @break_on_error = false != spec[:break_on_error]
+          @break_on_error = spec[:break_on_error] != false
         end
 
         def break_on_error?

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

@@ -21,8 +21,8 @@ module VagrantPlugins
         def initialize(spec)
           @name = spec[:name]
 
-          @flags      = spec[:flags]
-          @parameters = spec[:parameters]
+          @flags      = spec[:flags] || {}
+          @parameters = spec[:parameters] || {}
           @script     = spec[:script]
 
           @machine = spec[:machine] || spec[:box]
@@ -38,73 +38,87 @@ module VagrantPlugins
           script = script.call if script.is_a?(Proc)
 
           opts = {}
-          opts = parse_argv(argv) if @flags || @parameters
+          opts = parse_argv(argv) unless @flags.empty? && @parameters.empty?
 
           (script % opts).strip
         end
 
         private
 
-        def escape_option_values(options)
-          (@parameters || {}).each do |key, conf|
+        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)
-              options[key] = options[key].sub(char, "#{with}#{char}")
+              char        = char.to_s unless char.is_a?(String)
+              params[key] = params[key].sub(char, "#{with}#{char}")
             end
           end
 
-          options
+          params
         end
 
-        def options_with_defaults
-          options = {}
+        def parameters_with_defaults
+          params = {}
 
-          (@parameters || {}).each do |key, conf|
-            options[key] = '' if conf[:optional]
-            options[key] = conf[:default] unless conf[:default].nil?
+          @parameters.each do |key, conf|
+            params[key] = '' if conf[:optional]
+            params[key] = conf[:default] unless conf[:default].nil?
           end
 
-          options
+          params
         end
 
         # rubocop:disable Metrics/MethodLength
         def parse_argv(argv)
-          options = options_with_defaults
+          params = parameters_with_defaults
 
           OptionParser.new do |opts|
-            (@flags || {}).each do |key, conf|
-              options[key] = ''
+            @flags.each do |key, conf|
+              params[key] = ''
 
               opts.on("--#{key}", "Flag: #{key}") do
-                options[key] = conf[:value] || "--#{key}"
+                params[key] = conf[:value] || "--#{key}"
               end
             end
 
-            (@parameters || {}).each do |key, _conf|
+            @parameters.each do |key, _conf|
               opts.on("--#{key} OPTION", "Parameter: #{key}") do |o|
-                options[key] = o
+                params[key] = o
               end
             end
           end.parse!(argv)
 
-          wrap_option_values(escape_option_values(options))
+          wrap_parameters(escape_parameters(validate_parameters(params)))
         end
         # rubocop:enable Metrics/MethodLength
 
-        def wrap_option_values(options)
-          (@parameters || {}).each do |key, conf|
+        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 options[key].nil? || options[key].empty?
+              next if params[key].nil? || params[key].empty?
             end
 
-            options[key] = conf[:wrap] % options[key]
+            params[key] = conf[:wrap] % params[key]
           end
 
-          options
+          params
         end
       end
     end

data/lib/vagrant/devcommands/registry.rb

@@ -2,10 +2,8 @@ module VagrantPlugins
   module DevCommands
     # Vagrant command registry
     class Registry
-      I18N_KEY        = 'vagrant_devcommands.registry'.freeze
-      NAMESPACE_MODEL = VagrantPlugins::DevCommands::Model
-
-      RESERVED_COMMANDS = %w[help version].freeze
+      I18N_KEY          = 'vagrant_devcommands.registry'.freeze
+      RESERVED_COMMANDS = %w[completion-data help version].freeze
 
       attr_accessor :chains
       attr_accessor :commands
@@ -24,9 +22,9 @@ module VagrantPlugins
         global = commandfile.path_global
         local  = commandfile.path
 
-        contents  = ''
-        contents += "\n" + global.read unless nil == global
-        contents += "\n" + local.read unless nil == local
+        contents = ''
+        contents += "\n" + global.read unless global.nil?
+        contents += "\n" + local.read unless local.nil?
 
         instance_eval(contents)
         resolve_naming_conflicts
@@ -50,63 +48,54 @@ module VagrantPlugins
       def chain(name, options = nil)
         options            = {} unless options.is_a?(Hash)
         options[:commands] = {} unless options.key?(:commands)
+        options[:name]     = name
 
-        return empty_chain_warning(name) if options[:commands].empty?
+        if options[:commands].empty?
+          return warn_def_ignored('chain_empty', name: name)
+        end
 
-        options[:name] = name
+        if name.include?(' ')
+          return warn_def_ignored('chain_name_space', name: name)
+        end
 
-        @chains[name] = NAMESPACE_MODEL::Chain.new(options)
+        @chains[name] = Model::Chain.new(options)
       end
 
+      # rubocop:disable Metrics/MethodLength
       def command(name, options = nil)
-        return reserved_warning(name) if reserved_command?(name)
-
-        options = { script: options } unless options.is_a?(Hash)
+        if reserved_command?(name)
+          return warn_def_ignored('command_reserved', name: name)
+        end
 
-        return script_warning(name) unless valid_script?(options[:script])
+        if name.include?(' ')
+          return warn_def_ignored('command_name_space', name: name)
+        end
 
+        options        = { script: options } unless options.is_a?(Hash)
         options[:name] = name
 
-        @commands[name] = NAMESPACE_MODEL::Command.new(options)
-      end
-
-      def empty_chain_warning(name)
-        @env.ui.warn I18n.t("#{I18N_KEY}.empty_chain", name: name)
-        @env.ui.warn I18n.t("#{I18N_KEY}.def_ignored")
-        @env.ui.warn ''
-      end
-
-      def missing_chain_command_warning(chain, command)
-        i18n_args = { chain: chain, command: command }
-
-        @env.ui.warn I18n.t("#{I18N_KEY}.missing_command", i18n_args)
-        @env.ui.warn I18n.t("#{I18N_KEY}.def_ignored")
-        @env.ui.warn ''
-      end
+        unless valid_script?(options[:script])
+          return warn_def_ignored('command_no_script', name: name)
+        end
 
-      def reserved_warning(name)
-        @env.ui.warn I18n.t("#{I18N_KEY}.reserved", name: name)
-        @env.ui.warn I18n.t("#{I18N_KEY}.def_ignored")
-        @env.ui.warn ''
+        @commands[name] = Model::Command.new(options)
       end
+      # rubocop:enable Metrics/MethodLength
 
       def resolve_naming_conflicts
         @chains.keys.each do |chain|
-          next unless @commands.key?(chain)
+          next unless valid_command?(chain)
+
+          i18n_msg = 'conflict_command'
+          i18n_msg = 'conflict_internal' if reserved_command?(chain)
 
-          @env.ui.warn I18n.t("#{I18N_KEY}.conflict", name: chain)
+          @env.ui.warn I18n.t("#{I18N_KEY}.#{i18n_msg}", name: chain)
           @env.ui.warn I18n.t("#{I18N_KEY}.chain_ignored")
 
           @chains.delete(chain)
         end
       end
 
-      def script_warning(name)
-        @env.ui.warn I18n.t("#{I18N_KEY}.no_script", name: name)
-        @env.ui.warn I18n.t("#{I18N_KEY}.def_ignored")
-        @env.ui.warn ''
-      end
-
       def valid_script?(script)
         return true if script.is_a?(Proc)
 
@@ -122,7 +111,8 @@ module VagrantPlugins
             next unless element.is_a?(Hash)
             next if valid_command?(element[:command])
 
-            missing_chain_command_warning(chain, element)
+            warn_def_ignored('chain_missing_command',
+                             chain: chain, command: element)
 
             @chains.delete(chain)
 
@@ -130,6 +120,12 @@ module VagrantPlugins
           end
         end
       end
+
+      def warn_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
     end
   end
 end

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

@@ -49,8 +49,10 @@ module VagrantPlugins
 
         def run_script(command, argv)
           command.run_script(argv)
+        rescue ArgumentError => e
+          script_error(command.name, 'parameter_not_allowed', e.message)
         rescue KeyError => e
-          param = e.message.match(/{(.+)}/).captures.first
+          param = e.message.match(/key[<{](.+)[}>]/).captures.first
 
           script_error(command.name, 'missing_parameter', param)
         rescue OptionParser::InvalidOption => e

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

@@ -9,8 +9,15 @@ module VagrantPlugins
         UTIL            = VagrantPlugins::DevCommands::Util
 
         COMMANDS = {
-          'help'    => NAMESPACE_MODEL::Command.new(NAMESPACE_SPEC::HELP),
-          'version' => NAMESPACE_MODEL::Command.new(NAMESPACE_SPEC::VERSION)
+          'completion-data' => NAMESPACE_MODEL::Command.new(
+            NAMESPACE_SPEC::COMPLETION_DATA
+          ),
+          'help' => NAMESPACE_MODEL::Command.new(
+            NAMESPACE_SPEC::HELP
+          ),
+          'version' => NAMESPACE_MODEL::Command.new(
+            NAMESPACE_SPEC::VERSION
+          )
         }.freeze
 
         def initialize(plugin, argv, env, registry)
@@ -19,10 +26,7 @@ module VagrantPlugins
           @env      = env
           @registry = registry
 
-          @internal = {
-            'help'    => NAMESPACE_CMD::Help.new(env, registry),
-            'version' => NAMESPACE_CMD::Version.new(env)
-          }
+          @internal = internal_commands
         end
 
         def run(command, args = nil)
@@ -33,6 +37,17 @@ module VagrantPlugins
 
         private
 
+        def internal_commands
+          {
+            'completion-data' => NAMESPACE_CMD::CompletionData.new(
+              @env, @registry
+            ),
+
+            'help'    => NAMESPACE_CMD::Help.new(@env, @registry),
+            'version' => NAMESPACE_CMD::Version.new(@env)
+          }
+        end
+
         def run_argv
           argv = @argv.dup
 

data/lib/vagrant/devcommands/util.rb

@@ -2,15 +2,14 @@ module VagrantPlugins
   module DevCommands
     # Utility module
     class Util
-      JARO_WINKLER = VagrantPlugins::DevCommands::Util::JaroWinkler
-
       def self.argv_command(argv, env)
         return nil if argv.empty?
 
-        command = argv[0].to_s
-        command = argv[1].to_s if machine_name?(command, env.machine_index)
-
-        command
+        if machine_name?(argv[0].to_s, env.machine_index) && argv.length > 1
+          argv[1].to_s
+        else
+          argv[0].to_s
+        end
       end
 
       def self.collect_flags(flags)
@@ -32,15 +31,17 @@ module VagrantPlugins
       end
 
       def self.did_you_mean(command, registry)
-        alternatives = registry.commands.keys + registry.chains.keys
+        alternatives = registry.commands.keys +
+                       registry.chains.keys +
+                       Registry::RESERVED_COMMANDS
         distances    = {}
 
         alternatives.each do |alternative|
-          calculator             = JARO_WINKLER.new(command, alternative)
+          calculator             = Util::JaroWinkler.new(command, alternative)
           distances[alternative] = calculator.distance
         end
 
-        distances.max_by { |_k, v| v }
+        distances
       end
 
       def self.machine_name?(name, machine_index)

data/lib/vagrant/devcommands/version.rb

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

data/lib/vagrant/devcommands.rb

@@ -16,6 +16,7 @@ require 'vagrant/devcommands/model/command'
 
 require 'vagrant/devcommands/help_printer/chain'
 require 'vagrant/devcommands/help_printer/command'
+require 'vagrant/devcommands/internal_command/completion_data'
 require 'vagrant/devcommands/internal_command/help'
 require 'vagrant/devcommands/internal_command/version'
 

data/locales/en.yml

@@ -1,45 +1,52 @@
 en:
   vagrant_devcommands:
     internal:
+      completion-data:
+        desc: provides shell completion data
+        help: Returns a list of all defined commands separated using spaces.
       help:
-        desc: "get some plugin help"
+        desc: get some plugin help
         help: |-
           Display the help of the command given as the first argument if defined.
           Just like this help for the help command!
-        usage: "Usage: %{what}"
+        usage: "Usage: %<what>s"
       version:
-        desc: "get currently installed plugin version"
-        help: "Displays the currently installed version of the plugin you are using right now."
+        desc: get currently installed plugin version
+        help: Displays the currently installed version of the plugin you are using right now.
 
     message:
-      chain_no_help: "No detailed help for this chain available."
-      command_no_help: "No detailed help for this command available."
+      chain_no_help: No detailed help for this chain 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!"
+      missing_commandfile: Missing Commandfile
+      no_commands: No commands defined!
       plugin_readme: |-
         For detailed plugin usage information please read
         the README.md at the original source location:
         >>> https://github.com/mneudert/vagrant-devcommands
         A copy of this file should be locally available at:
-        >>> %{readme}
+        >>> %<readme>s
       plugin_usage: |-
         Usage: vagrant run [machine] <command>
         Help:  vagrant run help <command>
 
     registry:
-      chain_ignored:   "Your chain definition will be ignored in favor of the command"
-      conflict:        "The name '%{name}' is used for both a command and a chain."
-      def_ignored:     "Your definition of it will be ignored."
-      empty_chain:     "The chain '%{name}' has no commands associated."
-      missing_command: "The chain '%{chain}' is using at least one unknown command ('%{command}')."
-      no_script:       "The command '%{name}' has no script defined to execute."
-      reserved:        "The command name '%{name}' is reserved for internal usage."
+      chain_empty: "The chain '%<name>s' has no commands associated."
+      chain_ignored: Your chain definition will be ignored in favor of the command.
+      chain_missing_command: "The chain '%<chain>s' is using at least one unknown command ('%<command>s')."
+      chain_name_space: "The chain '%<name>s' contains spaces in it's name."
+      command_name_space: "The command '%<name>s' contains spaces in it's name."
+      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."
+      conflict_command: "The name '%<name>s' is used for both a command and a chain."
+      conflict_internal: "The name '%<name>s' is used for both an internal command and a chain."
+      def_ignored: Your definition of it will be ignored.
 
     runner:
-      invalid_parameter: "invalid parameter '%{detail}'"
-      missing_parameter: "missing parameter '%{detail}'"
-      script_error:      "Could not execute %{command}: %{error}"
+      invalid_parameter: "invalid parameter '%<detail>s'"
+      missing_parameter: "missing parameter '%<detail>s'"
+      parameter_not_allowed: "parameter value not allowed: '%<detail>s'"
+      script_error: "Could not execute '%<command>s': %<error>s"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-20 00:00:00.000000000 Z
+date: 2017-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -82,6 +82,7 @@ files:
 - lib/vagrant/devcommands/commandfile.rb
 - lib/vagrant/devcommands/help_printer/chain.rb
 - lib/vagrant/devcommands/help_printer/command.rb
+- lib/vagrant/devcommands/internal_command/completion_data.rb
 - lib/vagrant/devcommands/internal_command/help.rb
 - lib/vagrant/devcommands/internal_command/version.rb
 - lib/vagrant/devcommands/internal_spec.rb
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Runs vagrant commands from a Commandfile