vagrant-devcommands 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50085046566a6d18be96b03122e887e5a268f4fb
-  data.tar.gz: 3cc0b7a62fd0924b5f7893f4387478d970807e3d
+  metadata.gz: dbb951d035fb1ae4e0101196fe520f470a328e5a
+  data.tar.gz: 2f1b1e9a87828c3a3d04e87b716cf29204c82896
 SHA512:
-  metadata.gz: d06c2176f75a8ca0bb4f6e56902b3e20c727f0365fb250a44683e4f26aa2ec3c965610b1920e89f597c07a63e18cb338f148505cbb3684f8c898eb3ce3fd509f
-  data.tar.gz: '097bf9a61bdf25a5ab7c598a9caa3c69b9f61db1bcedd3788951a320d915c5a54a9e1b2a43d0596952980138d1b5ec1dc3a91330162b62363bf8bd6ebc478bc1'
+  metadata.gz: fe416e3190fcefbf46795fa521cd9a04e2d4c536e831d4976e5c43b3a07ca19574452eabf11cd0d7998c1c744c42e3c32da278877942c31669abcdaf9094eaa3
+  data.tar.gz: feea83ec520f4fa46cbee8048b38ef9ca7ccc97ad1e02571f3ee8729efeaddfc48293be2035a57c4b1c06b943351e931d59d4495d50b1162a0ef632b2f342875

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 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
+  - 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
+
 ## v0.10.1 (2017-08-08)
 
 - Bug fixes
@@ -70,7 +81,7 @@
 - Enhancements
   - Command usage now displays the correct parameter syntax
   - Command usage always displays mandatory parameters before optional ones
-  - Error output (i.e. "missing Commandfile") is now printed using
+  - 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()`

data/README.md

@@ -35,6 +35,7 @@ command 'with_options',
   machine: :my_machine,
   desc: 'executes "hostname" on the machine "my_machine"',
   script: 'hostname',
+  tty: true,
   usage: 'vagrant run %<command>s',
   help: <<-eoh
 I am the help message for the command "with_options".
@@ -51,6 +52,9 @@ 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_: 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
@@ -182,9 +186,6 @@ chain 'my_chain',
   help: <<-eoh
 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>s.
 eoh
 ```
 
@@ -234,7 +235,7 @@ chain against a specific machine using `vagrant run your_machine your_chain`.
 
 #### Chain Definitions with Specific Machines
 
-If required you can modify the machine a box is run on:
+If required you can modify the machine a command is run on:
 
 ```ruby
 command 'chainhost',
@@ -285,6 +286,31 @@ 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
+
+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',
+  parameters: { first: {}, second: {} },
+  script: 'echo %<first>s %<second>s'
+
+command_alias 'aliasecho',
+  argv:    ['--first="param"', '--second="param"'],
+  command: 'customecho',
+  desc:    'modified "customecho" command',
+  machine: 'non.default',
+  help: <<-eoh
+I am the help message for the command alias "aliasecho".
+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.
+
 ### Experimental: Shell Completion
 
 Completion data for your shell is available via internal command:
@@ -304,7 +330,7 @@ vagrant run completion-data my-command
 
 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` (i.e. from a git installation) manually to your `%PATH%`.
+`ssh.exe` (e.g. from a git installation) manually to your `%PATH%`.
 
 ### Command Definition
 

data/lib/vagrant/devcommands/command.rb

@@ -2,6 +2,8 @@ module VagrantPlugins
   module DevCommands
     # Defines the executable vagrant command
     class Command < Vagrant.plugin(2, :command)
+      I18N_KEY = 'vagrant_devcommands.'.freeze
+
       def self.synopsis
         synopsis = VagrantPlugins::DevCommands::SYNOPSIS
 
@@ -58,12 +60,12 @@ module VagrantPlugins
         return false if alternatives.empty?
 
         if alternatives.length == 1
-          display_error('Did you mean this?', true)
+          display_error(I18n.t("#{I18N_KEY}.did_you_mean_single"), true)
         else
-          display_error('Did you mean one of these?', true)
+          display_error(I18n.t("#{I18N_KEY}.did_you_mean_multi"), true)
         end
 
-        alternatives.sort.each { |k, _v| display_error("        #{k}") }
+        alternatives.sort.each { |(k, _v)| display_error("        #{k}") }
       end
 
       def display_error(msg, pre_ln = false, post_ln = false)
@@ -116,19 +118,23 @@ module VagrantPlugins
         runner.run(command, args)
       end
 
-      def runnable_for(command)
-        if @registry.valid_command?(command)
-          @registry.commands[command]
+      def runnable_for(name)
+        if @registry.valid_chain?(name)
+          @registry.chains[name]
+        elsif @registry.valid_command_alias?(name)
+          @registry.command_aliases[name]
         else
-          @registry.chains[command]
+          @registry.commands[name]
         end
       end
 
-      def runner_for(command)
-        if @registry.valid_command?(command)
-          Runner::Command.new(self, @argv, @env, @registry)
-        else
+      def runner_for(name)
+        if @registry.valid_chain?(name)
           Runner::Chain.new(self, @argv, @env, @registry)
+        elsif @registry.valid_command_alias?(name)
+          Runner::CommandAlias.new(self, @argv, @env, @registry)
+        else
+          Runner::Command.new(self, @argv, @env, @registry)
         end
       end
     end

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

@@ -0,0 +1,65 @@
+module VagrantPlugins
+  module DevCommands
+    class Commandfile
+      # Converts a (commandfile) entry into a model instance
+      class Modeler
+        def model(spec)
+          case spec[:type]
+          when :chain
+            chain(spec[:name], spec[:options])
+          when :command
+            command(spec[:name], spec[:options])
+          when :command_alias
+            command_alias(spec[:name], spec[:options])
+          end
+        end
+
+        private
+
+        def chain(name, options)
+          options            = {} unless options.is_a?(Hash)
+          options[:commands] = {} unless options.key?(:commands)
+          options[:name]     = name
+
+          raise ArgumentError, 'chain_empty' if options[:commands].empty?
+          raise ArgumentError, 'chain_name_space' if name.include?(' ')
+
+          VagrantPlugins::DevCommands::Model::Chain.new(options)
+        end
+
+        def command(name, options)
+          raise ArgumentError, 'command_name_space' if name.include?(' ')
+
+          options        = { script: options } unless options.is_a?(Hash)
+          options[:name] = name
+
+          unless valid_script?(options[:script])
+            raise ArgumentError, 'command_no_script'
+          end
+
+          VagrantPlugins::DevCommands::Model::Command.new(options)
+        end
+
+        def command_alias(name, options)
+          raise ArgumentError, 'command_alias_name_space' if name.include?(' ')
+
+          options        = { command: options } unless options.is_a?(Hash)
+          options[:name] = name
+
+          raise ArgumentError, 'command_alias_empty' unless options[:command]
+
+          VagrantPlugins::DevCommands::Model::CommandAlias.new(options)
+        end
+
+        def valid_script?(script)
+          return true if script.is_a?(Proc)
+
+          return false unless script.is_a?(String)
+          return false if script.empty?
+
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module VagrantPlugins
+  module DevCommands
+    class Commandfile
+      # Provides the DSL to read the contents of a Commandfile
+      class Reader
+        attr_reader :entries
+
+        def initialize(commandfile, env)
+          @commandfile = commandfile
+          @env         = env
+
+          @entries = []
+        end
+
+        def read
+          global = @commandfile.path_global
+          local  = @commandfile.path
+
+          contents = ''
+          contents += "\n" + global.read unless global.nil?
+          contents += "\n" + local.read unless local.nil?
+
+          instance_eval(contents)
+
+          @entries
+        end
+
+        private
+
+        def chain(name, options = nil)
+          @entries << {
+            type:    :chain,
+            name:    name.to_s,
+            options: options
+          }
+        end
+
+        def command(name, options = nil)
+          @entries << {
+            type:    :command,
+            name:    name.to_s,
+            options: options
+          }
+        end
+
+        def command_alias(name, options = nil)
+          @entries << {
+            type:    :command_alias,
+            name:    name.to_s,
+            options: options
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@ module VagrantPlugins
     module HelpPrinter
       # Prints help for a command chain
       class Chain
+        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
         UTIL     = VagrantPlugins::DevCommands::Util
         MESSAGES = VagrantPlugins::DevCommands::Messages
 
@@ -33,15 +34,20 @@ module VagrantPlugins
         def commands(chain)
           info('Chained commands (in order):', true)
 
-          chain.commands.each do |cmd, _options|
+          chain.commands.each do |cmd|
             info(UTIL.padded_columns(0, chain_help_line(cmd)))
           end
         end
 
         def header(chain)
-          usage = "vagrant run [machine] #{chain.name}"
+          usage =
+            if chain.usage.nil?
+              I18n.t("#{I18N_KEY}.usage_default", what: chain.name)
+            else
+              format(chain.usage, chain: chain.name)
+            end
 
-          info(I18n.t('vagrant_devcommands.internal.help.usage', what: usage))
+          info(I18n.t("#{I18N_KEY}.usage", what: usage))
         end
 
         def info(msg, pre_ln = false)

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

@@ -3,6 +3,7 @@ module VagrantPlugins
     module HelpPrinter
       # Prints help for a command
       class Command
+        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
         UTIL     = VagrantPlugins::DevCommands::Util
         MESSAGES = VagrantPlugins::DevCommands::Messages
 
@@ -41,14 +42,17 @@ module VagrantPlugins
         end
 
         def header(command)
-          usage = "vagrant run [machine] #{command.name}"
-          usage = usage_params(usage, command)
+          usage =
+            if command.usage.nil?
+              usage_params(
+                I18n.t("#{I18N_KEY}.usage_default", what: command.name),
+                command
+              )
+            else
+              format(command.usage, command: command.name)
+            end
 
-          unless command.usage.nil?
-            usage = format(command.usage, command: command)
-          end
-
-          info(I18n.t('vagrant_devcommands.internal.help.usage', what: usage))
+          info(I18n.t("#{I18N_KEY}.usage", what: usage))
         end
 
         def info(msg, pre_ln = false)

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

@@ -0,0 +1,56 @@
+module VagrantPlugins
+  module DevCommands
+    module HelpPrinter
+      # Prints help for a command alias
+      class CommandAlias
+        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
+        UTIL     = VagrantPlugins::DevCommands::Util
+        MESSAGES = VagrantPlugins::DevCommands::Messages
+
+        def initialize(env)
+          @env = env
+        end
+
+        def output(command_alias)
+          header(command_alias)
+          body(command_alias.help)
+        end
+
+        private
+
+        def body(help)
+          return message(:command_alias_no_help, true) if help.nil?
+
+          info(help.strip, true)
+        end
+
+        def header(command_alias)
+          usage =
+            if command_alias.usage.nil?
+              I18n.t("#{I18N_KEY}.usage_default", what: command_alias.name)
+            else
+              format(command_alias.usage, command_alias: command_alias.name)
+            end
+
+          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)
+        end
+
+        def info(msg, pre_ln = false)
+          @env.ui.info '' if pre_ln
+          @env.ui.info msg
+        end
+
+        def message(msg, pre_ln = false)
+          if pre_ln
+            MESSAGES.pre_ln(msg, &@env.ui.method(:info))
+          else
+            MESSAGES.public_send(msg, &@env.ui.method(:info))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,6 +36,7 @@ module VagrantPlugins
           (
             @registry.chains.keys +
             @registry.commands.keys +
+            @registry.command_aliases.keys +
             VagrantPlugins::DevCommands::Registry::RESERVED_COMMANDS
           ).sort.join(' ')
         end

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

@@ -3,6 +3,7 @@ module VagrantPlugins
     module InternalCommand
       # Internal "help" command
       class Help
+        I18N_KEY = 'vagrant_devcommands.internal.help'.freeze
         UTIL     = VagrantPlugins::DevCommands::Util
         MESSAGES = VagrantPlugins::DevCommands::Messages
         PRINTER  = VagrantPlugins::DevCommands::HelpPrinter
@@ -28,6 +29,10 @@ module VagrantPlugins
         def help(command)
           if @registry.valid_chain?(command)
             PRINTER::Chain.new(@env).output(@registry.chains[command])
+          elsif @registry.valid_command_alias?(command)
+            PRINTER::CommandAlias.new(@env).output(
+              @registry.command_aliases[command]
+            )
           else
             PRINTER::Command.new(@env).output(@registry.commands[command])
           end
@@ -53,7 +58,14 @@ module VagrantPlugins
           spec  = internal_commands[command]
           usage = format(spec.usage, command: command)
 
-          info(I18n.t('vagrant_devcommands.internal.help.usage', what: usage))
+          info(I18n.t("#{I18N_KEY}.usage", what: usage))
+        end
+
+        def list_pad_to
+          UTIL.max_pad([internal_commands,
+                        @registry.chains,
+                        @registry.command_aliases,
+                        @registry.commands])
         end
 
         def message(msg, pre_ln = false)
@@ -65,21 +77,20 @@ module VagrantPlugins
         end
 
         def plugin_help(command)
-          message(:plugin_usage) unless command == '--commands'
+          plugin_help_header(command) unless command == '--commands'
 
-          pad_to = UTIL.max_pad([internal_commands,
-                                 @registry.commands,
-                                 @registry.chains])
+          pad_to = list_pad_to
 
-          plugin_help_commands('Available', @registry.commands, pad_to)
+          plugin_help_commands('available', @registry.commands, pad_to)
           plugin_help_chains(@registry.chains, pad_to)
-          plugin_help_commands('Internal', internal_commands, pad_to)
+          plugin_help_command_aliases(@registry.command_aliases, pad_to)
+          plugin_help_commands('internal', internal_commands, pad_to)
         end
 
         def plugin_help_chains(chains, pad_to)
           return if chains.empty?
 
-          info('Command chains:', true)
+          info(I18n.t("#{I18N_KEY}.list.chains"), true)
 
           chains.sort.each do |name, chain|
             info(UTIL.padded_columns(pad_to, name, chain.desc))
@@ -89,12 +100,30 @@ module VagrantPlugins
         def plugin_help_commands(type, commands, pad_to)
           return if commands.empty?
 
-          info("#{type} commands:", true)
+          info(I18n.t("#{I18N_KEY}.list.commands_#{type}"), true)
 
           commands.sort.each do |name, command|
             info(UTIL.padded_columns(pad_to, name, command.desc))
           end
         end
+
+        def plugin_help_command_aliases(command_aliases, pad_to)
+          return if command_aliases.empty?
+
+          info(I18n.t("#{I18N_KEY}.list.command_aliases"), true)
+
+          command_aliases.sort.each do |name, command_alias|
+            info(UTIL.padded_columns(pad_to, name, command_alias.desc))
+          end
+        end
+
+        def plugin_help_header(command)
+          if command.nil?
+            message(:plugin_usage)
+          else
+            @env.ui.error I18n.t("#{I18N_KEY}.invalid_command", what: command)
+          end
+        end
       end
     end
   end

data/lib/vagrant/devcommands/messages.rb

@@ -10,15 +10,19 @@ module VagrantPlugins
         out.call I18n.t("#{I18N_KEY}.chain_no_help")
       end
 
-      def self.deprecated_box_config(&out)
-        out.call I18n.t("#{I18N_KEY}.deprecated_box_config")
-        out.call ''
+      def self.command_alias_no_help(&out)
+        out.call I18n.t("#{I18N_KEY}.command_alias_no_help")
       end
 
       def self.command_no_help(&out)
         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
@@ -28,7 +32,7 @@ module VagrantPlugins
       end
 
       def self.plugin_readme(&out)
-        curdir = File.expand_path(File.dirname(__FILE__))
+        curdir = File.expand_path(__dir__)
         readme = File.expand_path(File.join(curdir, '../../../README.md'))
 
         out.call I18n.t("#{I18N_KEY}.plugin_readme", readme: readme)

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

@@ -8,13 +8,15 @@ module VagrantPlugins
 
         attr_reader :desc
         attr_reader :help
+        attr_reader :usage
 
         def initialize(spec)
           @name     = spec[:name]
           @commands = spec[:commands]
 
-          @desc = spec[:desc]
-          @help = spec[:help]
+          @desc  = spec[:desc]
+          @help  = spec[:help]
+          @usage = spec[:usage]
 
           @break_on_error = spec[:break_on_error] != false
         end

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

@@ -10,6 +10,7 @@ module VagrantPlugins
         attr_reader :flags
         attr_reader :parameters
         attr_reader :script
+        attr_reader :tty
 
         attr_reader :machine
         attr_reader :desc
@@ -18,12 +19,14 @@ module VagrantPlugins
 
         attr_reader :deprecated_box_config
 
+        # rubocop:disable Metrics/AbcSize
         def initialize(spec)
           @name = spec[:name]
 
           @flags      = spec[:flags] || {}
           @parameters = spec[:parameters] || {}
           @script     = spec[:script]
+          @tty        = spec[:tty] == true
 
           @machine = spec[:machine] || spec[:box]
           @desc    = spec[:desc]
@@ -32,6 +35,7 @@ module VagrantPlugins
 
           @deprecated_box_config = spec.key?(:box)
         end
+        # rubocop:enable Metrics/AbcSize
 
         def run_script(argv)
           script = @script
@@ -82,7 +86,7 @@ module VagrantPlugins
               end
             end
 
-            @parameters.each do |key, _conf|
+            @parameters.each_key do |key|
               opts.on("--#{key} OPTION", "Parameter: #{key}") do |o|
                 params[key] = o
               end

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

@@ -0,0 +1,28 @@
+require 'optparse'
+
+module VagrantPlugins
+  module DevCommands
+    module Model
+      # Definition of a command alias
+      class CommandAlias
+        attr_reader :name
+
+        attr_reader :argv
+        attr_reader :command
+        attr_reader :desc
+        attr_reader :help
+        attr_reader :usage
+
+        def initialize(spec)
+          @name = spec[:name]
+
+          @argv    = spec[:argv] || []
+          @command = spec[:command]
+          @desc    = spec[:desc]
+          @help    = spec[:help]
+          @usage   = spec[:usage]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module VagrantPlugins
+  module DevCommands
+    class Registry
+      # Generic registry message printer
+      class Messager
+        I18N_KEY = 'vagrant_devcommands.registry'.freeze
+
+        def initialize(env)
+          @env = env
+        end
+
+        def chain_ignored(message, name)
+          @env.ui.warn I18n.t("#{I18N_KEY}.#{message}", name: name)
+          @env.ui.warn I18n.t("#{I18N_KEY}.chain_ignored")
+        end
+
+        def command_alias_ignored(message, name)
+          @env.ui.warn I18n.t("#{I18N_KEY}.#{message}", name: name)
+          @env.ui.warn I18n.t("#{I18N_KEY}.command_alias_ignored")
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+module VagrantPlugins
+  module DevCommands
+    class Registry
+      # Registry conflict resolver
+      class Resolver
+        def initialize(messager)
+          @messager = messager
+        end
+
+        def resolve_naming_conflicts(registry)
+          resolve_command_naming_conflicts(registry)
+          resolve_chain_naming_conflicts(registry)
+          resolve_command_alias_naming_conflicts(registry)
+        end
+
+        private
+
+        def resolve_chain_naming_conflicts(registry)
+          registry.chains.each_key do |name|
+            next unless registry.valid_command?(name)
+
+            i18n_msg = 'chain_conflict_command'
+
+            if registry.reserved_command?(name)
+              i18n_msg = 'chain_conflict_internal'
+            end
+
+            @messager.chain_ignored(i18n_msg, name)
+
+            registry.chains.delete(name)
+          end
+        end
+
+        def resolve_command_naming_conflicts(registry)
+          registry.commands.each_key do |name|
+            next unless registry.reserved_command?(name)
+
+            @messager.def_ignored('command_reserved', name: name)
+
+            registry.commands.delete(name)
+          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
+
+            i18n_key = 'command'
+            i18n_key = 'chain'    if registry.valid_chain?(name)
+            i18n_key = 'internal' if registry.reserved_command?(name)
+
+            i18n_msg = "command_alias_conflict_#{i18n_key}"
+
+            @messager.command_alias_ignored(i18n_msg, name)
+
+            registry.command_aliases.delete(name)
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module VagrantPlugins
+  module DevCommands
+    class Registry
+      # Registry entry validator
+      class Validator
+        def initialize(messager)
+          @messager = messager
+        end
+
+        def validate_entries(registry)
+          validate_chains(registry)
+          validate_command_aliases(registry)
+        end
+
+        private
+
+        # rubocop:disable Metrics/MethodLength
+        def validate_chains(registry)
+          registry.chains.all? do |chain, chain_def|
+            chain_def.commands.each do |element|
+              next unless element.is_a?(Hash)
+              next if registry.valid_command?(element[:command])
+
+              @messager.def_ignored('chain_missing_command',
+                                    chain:   chain,
+                                    command: element)
+
+              registry.chains.delete(chain)
+
+              break
+            end
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def validate_command_aliases(registry)
+          registry.command_aliases.all? do |command_alias, command_alias_def|
+            cmd = command_alias_def.command
+
+            next if registry.valid_command?(cmd) || registry.valid_chain?(cmd)
+
+            @messager.def_ignored('command_alias_missing_command',
+                                  command_alias: command_alias,
+                                  command:       cmd)
+
+            registry.command_aliases.delete(command_alias)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/devcommands/registry.rb

@@ -1,34 +1,31 @@
 module VagrantPlugins
   module DevCommands
-    # Vagrant command registry
+    # Registry for definitions from the Commandfile
     class Registry
-      I18N_KEY          = 'vagrant_devcommands.registry'.freeze
       RESERVED_COMMANDS = %w[completion-data help version].freeze
 
       attr_accessor :chains
       attr_accessor :commands
+      attr_accessor :command_aliases
 
       def initialize(env)
-        @chains   = {}
-        @commands = {}
         @env      = env
+        @messager = Registry::Messager.new(@env)
+
+        @chains          = {}
+        @commands        = {}
+        @command_aliases = {}
       end
 
       def available?(name)
-        valid_command?(name) || valid_chain?(name)
+        valid_chain?(name) || valid_command?(name) || valid_command_alias?(name)
       end
 
       def read_commandfile(commandfile)
-        global = commandfile.path_global
-        local  = commandfile.path
-
-        contents = ''
-        contents += "\n" + global.read unless global.nil?
-        contents += "\n" + local.read unless local.nil?
+        register(Commandfile::Reader.new(commandfile, @env).read)
 
-        instance_eval(contents)
-        resolve_naming_conflicts
-        validate_chains
+        Registry::Resolver.new(@messager).resolve_naming_conflicts(self)
+        Registry::Validator.new(@messager).validate_entries(self)
       end
 
       def reserved_command?(command)
@@ -43,88 +40,28 @@ module VagrantPlugins
         @commands.include?(command) || reserved_command?(command)
       end
 
-      private
-
-      def chain(name, options = nil)
-        options            = {} unless options.is_a?(Hash)
-        options[:commands] = {} unless options.key?(:commands)
-        options[:name]     = name
-
-        if options[:commands].empty?
-          return warn_def_ignored('chain_empty', name: name)
-        end
-
-        if name.include?(' ')
-          return warn_def_ignored('chain_name_space', name: name)
-        end
-
-        @chains[name] = Model::Chain.new(options)
-      end
-
-      # rubocop:disable Metrics/MethodLength
-      def command(name, options = nil)
-        if reserved_command?(name)
-          return warn_def_ignored('command_reserved', name: name)
-        end
-
-        if name.include?(' ')
-          return warn_def_ignored('command_name_space', name: name)
-        end
-
-        options        = { script: options } unless options.is_a?(Hash)
-        options[:name] = name
-
-        unless valid_script?(options[:script])
-          return warn_def_ignored('command_no_script', name: name)
-        end
-
-        @commands[name] = Model::Command.new(options)
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def resolve_naming_conflicts
-        @chains.keys.each do |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}.#{i18n_msg}", name: chain)
-          @env.ui.warn I18n.t("#{I18N_KEY}.chain_ignored")
-
-          @chains.delete(chain)
-        end
+      def valid_command_alias?(name)
+        @command_aliases.include?(name)
       end
 
-      def valid_script?(script)
-        return true if script.is_a?(Proc)
-
-        return false unless script.is_a?(String)
-        return false if script.empty?
-
-        true
-      end
-
-      def validate_chains
-        @chains.all? do |chain, chain_def|
-          chain_def.commands.each do |element|
-            next unless element.is_a?(Hash)
-            next if valid_command?(element[:command])
-
-            warn_def_ignored('chain_missing_command',
-                             chain: chain, command: element)
+      private
 
-            @chains.delete(chain)
+      def register(commandfile_entries)
+        modeler = Commandfile::Modeler.new
 
-            break
+        commandfile_entries.each do |entry|
+          begin
+            register_model(modeler.model(entry))
+          rescue ArgumentError => e
+            @messager.def_ignored(e.message, name: entry[:name])
           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 ''
+      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)
       end
     end
   end

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

@@ -24,7 +24,7 @@ module VagrantPlugins
             env = vm.action(:ssh_run,
                             ssh_run_command: script,
                             ssh_opts:        { extra_args: ['-q'] },
-                            tty:             true)
+                            tty:             command.tty)
 
             return env[:ssh_run_exit_status] || 0
           end

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

@@ -0,0 +1,42 @@
+module VagrantPlugins
+  module DevCommands
+    module Runner
+      # Command alias runner
+      class CommandAlias
+        UTIL = VagrantPlugins::DevCommands::Util
+
+        def initialize(plugin, argv, env, registry)
+          @plugin   = plugin
+          @argv     = argv
+          @env      = env
+          @registry = registry
+        end
+
+        def run(command_alias)
+          runnable      = runnable_for(command_alias)
+          runnable_argv = argv_for(command_alias)
+
+          Command.new(@plugin, runnable_argv, @env, @registry).run(runnable)
+        end
+
+        private
+
+        def argv_for(command_alias)
+          argv  = @argv.dup
+          index = 0
+          index = 1 if UTIL.machine_name?(argv[0].to_s, @env.machine_index)
+
+          argv[index] = command_alias.command
+
+          return argv unless command_alias.argv.is_a?(Array)
+
+          argv + command_alias.argv
+        end
+
+        def runnable_for(command_alias)
+          @registry.commands[command_alias.command]
+        end
+      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.10.1'.freeze
+    VERSION = '0.11.0'.freeze
   end
 end

data/lib/vagrant/devcommands.rb

@@ -13,18 +13,26 @@ require 'vagrant/devcommands/util'
 
 require 'vagrant/devcommands/model/chain'
 require 'vagrant/devcommands/model/command'
+require 'vagrant/devcommands/model/command_alias'
 
 require 'vagrant/devcommands/help_printer/chain'
 require 'vagrant/devcommands/help_printer/command'
+require 'vagrant/devcommands/help_printer/command_alias'
 require 'vagrant/devcommands/internal_command/completion_data'
 require 'vagrant/devcommands/internal_command/help'
 require 'vagrant/devcommands/internal_command/version'
 
 require 'vagrant/devcommands/runner/chain'
 require 'vagrant/devcommands/runner/command'
+require 'vagrant/devcommands/runner/command_alias'
 require 'vagrant/devcommands/runner/internal_command'
 
 require 'vagrant/devcommands/command'
 require 'vagrant/devcommands/commandfile'
+require 'vagrant/devcommands/commandfile/modeler'
+require 'vagrant/devcommands/commandfile/reader'
 require 'vagrant/devcommands/plugin'
 require 'vagrant/devcommands/registry'
+require 'vagrant/devcommands/registry/messager'
+require 'vagrant/devcommands/registry/resolver'
+require 'vagrant/devcommands/registry/validator'

data/locales/en.yml

@@ -1,21 +1,33 @@
 en:
   vagrant_devcommands:
+    did_you_mean_multi: Did you mean one of these?
+    did_you_mean_single: Did you mean this?
+
     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
+        alias_for: "Alias for: vagrant run [machine] %<what>s"
+        desc: get some plugin or command help
         help: |-
           Display the help of the command given as the first argument if defined.
           Just like this help for the help command!
+        invalid_command: "Invalid command '%<what>s'!"
+        list:
+          chains: "Command chains:"
+          command_aliases: "Command aliases:"
+          commands_available: "Available commands:"
+          commands_internal: "Internal commands:"
         usage: "Usage: %<what>s"
+        usage_default: "vagrant run [machine] %<what>s"
       version:
         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_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
@@ -34,15 +46,20 @@ en:
         Help:  vagrant run help <command>
 
     registry:
+      chain_conflict_command: "The name '%<name>s' is used for both a command and a chain."
+      chain_conflict_internal: "The name '%<name>s' is used for both an internal command and a chain."
       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_alias_conflict_chain: "The name '%<name>s' is used for both a chain and a command alias."
+      command_alias_conflict_command: "The name '%<name>s' is used for both a command and a command alias."
+      command_alias_conflict_internal: "The name '%<name>s' is used for both an internal command and a command alias."
+      command_alias_empty: "The command alias '%<name>s' has no command associated."
+      command_alias_missing_command: "The command alias '%<command_alias>s' is using an unknown command ('%<command>s')."
       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:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: '0.50'
 description: Vagrant plugin to run commands specified in a Commandfile inside one
   of your vagrant boxes
 email:
@@ -80,8 +80,11 @@ files:
 - lib/vagrant/devcommands.rb
 - lib/vagrant/devcommands/command.rb
 - lib/vagrant/devcommands/commandfile.rb
+- lib/vagrant/devcommands/commandfile/modeler.rb
+- lib/vagrant/devcommands/commandfile/reader.rb
 - lib/vagrant/devcommands/help_printer/chain.rb
 - lib/vagrant/devcommands/help_printer/command.rb
+- lib/vagrant/devcommands/help_printer/command_alias.rb
 - lib/vagrant/devcommands/internal_command/completion_data.rb
 - lib/vagrant/devcommands/internal_command/help.rb
 - lib/vagrant/devcommands/internal_command/version.rb
@@ -89,10 +92,15 @@ files:
 - lib/vagrant/devcommands/messages.rb
 - lib/vagrant/devcommands/model/chain.rb
 - lib/vagrant/devcommands/model/command.rb
+- lib/vagrant/devcommands/model/command_alias.rb
 - lib/vagrant/devcommands/plugin.rb
 - lib/vagrant/devcommands/registry.rb
+- lib/vagrant/devcommands/registry/messager.rb
+- lib/vagrant/devcommands/registry/resolver.rb
+- lib/vagrant/devcommands/registry/validator.rb
 - lib/vagrant/devcommands/runner/chain.rb
 - lib/vagrant/devcommands/runner/command.rb
+- lib/vagrant/devcommands/runner/command_alias.rb
 - lib/vagrant/devcommands/runner/internal_command.rb
 - lib/vagrant/devcommands/synopsis.rb
 - lib/vagrant/devcommands/util.rb
@@ -120,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Runs vagrant commands from a Commandfile