vagrant-devcommands 0.7.2 → 0.8.0

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

@@ -0,0 +1,44 @@
+module VagrantPlugins
+  module DevCommands
+    module Runner
+      # Chain runner
+      class Chain
+        def initialize(plugin, argv, env, registry)
+          @plugin   = plugin
+          @argv     = argv
+          @env      = env
+          @registry = registry
+        end
+
+        def run(chain)
+          retval = 0
+
+          chain.commands.each do |command_def|
+            runnable      = runnable_for(command_def)
+            runnable_argv = argv_for(command_def)
+
+            runner = Command.new(@plugin, runnable_argv, @env, @registry)
+            retval = runner.run(runnable)
+
+            break if retval.nonzero? && chain.break_on_error?
+          end
+
+          retval
+        end
+
+        private
+
+        def argv_for(command_def)
+          return @argv unless command_def.key?(:argv)
+          return @argv unless command_def[:argv].is_a?(Array)
+
+          @argv + command_def[:argv]
+        end
+
+        def runnable_for(command_def)
+          @registry.commands[command_def[:command]]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module VagrantPlugins
+  module DevCommands
+    module Runner
+      # Command runner
+      class Command
+        UTIL = VagrantPlugins::DevCommands::Util
+
+        def initialize(plugin, argv, env, registry)
+          @plugin   = plugin
+          @argv     = argv
+          @env      = env
+          @registry = registry
+        end
+
+        def run(command)
+          argv   = run_argv
+          box    = run_box(command)
+          script = run_script(command, argv)
+
+          return 2 unless script
+
+          @plugin.proxy_with_target_vms(box, single_target: true) do |vm|
+            env = vm.action(:ssh_run,
+                            ssh_opts: { extra_args: ['-q'] },
+                            ssh_run_command: script)
+
+            return env[:ssh_run_exit_status] || 0
+          end
+        end
+
+        private
+
+        def run_argv
+          argv = @argv.dup
+
+          argv.shift if UTIL.machine_name?(argv[0].to_s, @env.machine_index)
+          argv.shift
+          argv
+        end
+
+        def run_box(cmd)
+          box = nil
+          box = cmd.box.to_s if cmd.box
+          box = @argv[0] if UTIL.machine_name?(@argv[0].to_s,
+                                               @env.machine_index)
+
+          box
+        end
+
+        def run_script(command, argv)
+          command.run_script(argv)
+        rescue KeyError => e
+          param = e.message.match(/{(.+)}/).captures.first
+
+          script_error(command.name, 'missing_parameter', param)
+        rescue OptionParser::InvalidOption => e
+          script_error(command.name, 'invalid_parameter', e.args.first)
+        end
+
+        def script_error(command, type, detail)
+          error = I18n.t("vagrant_devcommands.runner.#{type}", detail: detail)
+
+          raise I18n.t('vagrant_devcommands.runner.script_error',
+                       command: command,
+                       error:   error)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module VagrantPlugins
+  module DevCommands
+    module Runner
+      # Internal command runner
+      class InternalCommand
+        NAMESPACE_CMD   = VagrantPlugins::DevCommands::InternalCommand
+        NAMESPACE_MODEL = VagrantPlugins::DevCommands::Model
+        NAMESPACE_SPEC  = VagrantPlugins::DevCommands::InternalSpec
+        UTIL            = VagrantPlugins::DevCommands::Util
+
+        COMMANDS = {
+          'help'    => NAMESPACE_MODEL::Command.new(NAMESPACE_SPEC::HELP),
+          'version' => NAMESPACE_MODEL::Command.new(NAMESPACE_SPEC::VERSION)
+        }.freeze
+
+        def initialize(plugin, argv, env, registry)
+          @plugin   = plugin
+          @argv     = argv
+          @env      = env
+          @registry = registry
+
+          @internal = {
+            'help'    => NAMESPACE_CMD::Help.new(env, registry),
+            'version' => NAMESPACE_CMD::Version.new(env)
+          }
+        end
+
+        def run(command, args = nil)
+          return nil unless @internal.key?(command)
+
+          @internal[command].execute(args || run_argv)
+        end
+
+        private
+
+        def run_argv
+          argv = @argv.dup
+
+          argv.shift if UTIL.machine_name?(argv[0].to_s, @env.machine_index)
+          argv.shift
+          argv
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/devcommands/synopsis.rb

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

data/lib/vagrant/devcommands/util.rb

@@ -2,15 +2,56 @@ module VagrantPlugins
   module DevCommands
     # Utility module
     class Util
+      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
+      end
+
+      def self.collect_flags(flags)
+        flags.collect do |key, _opts|
+          "[--#{key}]"
+        end
+      end
+
+      def self.collect_mandatory_params(params)
+        params.collect do |key, opts|
+          "--#{key}=<#{key}>" unless opts[:optional]
+        end
+      end
+
+      def self.collect_optional_params(params)
+        params.collect do |key, opts|
+          "[--#{key}=<#{key}>]" if opts[:optional]
+        end
+      end
+
       def self.machine_name?(name, machine_index)
         machine_index.any? { |machine| name == machine.name }
       end
 
+      def self.max_pad(items_list)
+        paddings = items_list.map do |items|
+          if items.nil? || items.empty?
+            0
+          else
+            pad_to(items)
+          end
+        end
+
+        paddings.max
+      end
+
       def self.pad_to(items)
-        items.keys.map(&:length).max
+        items = items.keys unless items.is_a?(Array)
+
+        items.map(&:length).max
       end
 
-      def self.padded_columns(pad_to, left, right)
+      def self.padded_columns(pad_to, left, right = nil)
         left  = left.to_s  unless left.is_a?(String)
         right = right.to_s unless right.is_a?(String)
 

data/lib/vagrant/devcommands/version.rb

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

data/lib/vagrant/devcommands.rb

@@ -3,17 +3,26 @@ require 'vagrant'
 I18n.load_path << File.expand_path('../../../locales/en.yml', __FILE__)
 I18n.reload!
 
+require 'vagrant/devcommands/synopsis'
+require 'vagrant/devcommands/version'
+
 require 'vagrant/devcommands/internal_spec'
 require 'vagrant/devcommands/messages'
 require 'vagrant/devcommands/util'
 
+require 'vagrant/devcommands/model/chain'
+require 'vagrant/devcommands/model/command'
+
+require 'vagrant/devcommands/help_printer/chain'
+require 'vagrant/devcommands/help_printer/command'
 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/internal_command'
+
 require 'vagrant/devcommands/command'
-require 'vagrant/devcommands/command_def'
-require 'vagrant/devcommands/command_file'
-require 'vagrant/devcommands/internal'
+require 'vagrant/devcommands/commandfile'
 require 'vagrant/devcommands/plugin'
 require 'vagrant/devcommands/registry'
-require 'vagrant/devcommands/version'

data/locales/en.yml

@@ -2,11 +2,41 @@ en:
   vagrant_devcommands:
     internal:
       help:
-        desc: "display this help message"
+        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}"
 
       version:
-        desc: "display currently used the plugin version"
-        help: "Displays the currently installed version 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."
+      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}
+      plugin_usage: |-
+        Usage: vagrant run [box] <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."
+
+    runner:
+      invalid_parameter: "invalid parameter '%{detail}'"
+      missing_parameter: "missing parameter '%{detail}'"
+      script_error:      "Could not execute %{command}: %{error}"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-12 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.12.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.12.5
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -93,15 +79,21 @@ files:
 - README.md
 - lib/vagrant/devcommands.rb
 - lib/vagrant/devcommands/command.rb
-- lib/vagrant/devcommands/command_def.rb
-- lib/vagrant/devcommands/command_file.rb
-- lib/vagrant/devcommands/internal.rb
+- lib/vagrant/devcommands/commandfile.rb
+- lib/vagrant/devcommands/help_printer/chain.rb
+- lib/vagrant/devcommands/help_printer/command.rb
 - lib/vagrant/devcommands/internal_command/help.rb
 - lib/vagrant/devcommands/internal_command/version.rb
 - lib/vagrant/devcommands/internal_spec.rb
 - lib/vagrant/devcommands/messages.rb
+- lib/vagrant/devcommands/model/chain.rb
+- lib/vagrant/devcommands/model/command.rb
 - lib/vagrant/devcommands/plugin.rb
 - lib/vagrant/devcommands/registry.rb
+- lib/vagrant/devcommands/runner/chain.rb
+- lib/vagrant/devcommands/runner/command.rb
+- lib/vagrant/devcommands/runner/internal_command.rb
+- lib/vagrant/devcommands/synopsis.rb
 - lib/vagrant/devcommands/util.rb
 - lib/vagrant/devcommands/version.rb
 - locales/en.yml
@@ -126,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Runs vagrant commands from a Commandfile

data/lib/vagrant/devcommands/command_def.rb

@@ -1,92 +0,0 @@
-require 'optparse'
-
-module VagrantPlugins
-  module DevCommands
-    # Definition of an executable command
-    class CommandDef
-      attr_reader :name
-      attr_reader :parameters
-      attr_reader :script
-
-      attr_reader :box
-      attr_reader :desc
-      attr_reader :help
-      attr_reader :usage
-
-      def initialize(spec)
-        @name       = spec[:name]
-        @parameters = spec[:parameters]
-        @script     = spec[:script]
-
-        @box   = spec[:box]
-        @desc  = spec[:desc]
-        @help  = spec[:help]
-        @usage = spec[:usage]
-      end
-
-      def run_script(argv)
-        script = @script
-        script = script.call if script.is_a?(Proc)
-
-        opts = {}
-        opts = parse_argv(argv) if @parameters
-
-        (script % opts).strip
-      end
-
-      private
-
-      def escape_option_values(options)
-        @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}")
-          end
-        end
-
-        options
-      end
-
-      def options_with_defaults
-        options = {}
-
-        @parameters.each do |key, conf|
-          options[key] = '' if conf[:optional]
-          options[key] = conf[:default] unless conf[:default].nil?
-        end
-
-        options
-      end
-
-      def parse_argv(argv)
-        options = options_with_defaults
-
-        OptionParser.new do |opts|
-          @parameters.each do |key, _conf|
-            opts.on("--#{key} OPTION", "Parameter: #{key}") do |o|
-              options[key] = o
-            end
-          end
-        end.parse!(argv)
-
-        wrap_option_values(escape_option_values(options))
-      end
-
-      def wrap_option_values(options)
-        @parameters.each do |key, conf|
-          next if conf[:wrap].nil?
-
-          if conf[:default].nil?
-            next if options[key].nil? || options[key].empty?
-          end
-
-          options[key] = conf[:wrap] % options[key]
-        end
-
-        options
-      end
-    end
-  end
-end