vagrant-devcommands 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec61d0c70a777b0ee45eaa801f90259553d7d3a6
-  data.tar.gz: b230c5d5e67753087b152e54ec38ca395b2bdc30
+  metadata.gz: 582303dc5434a37e980ebc5345eb39a75d229d8f
+  data.tar.gz: 110bdb1cda070d37745cdfd2cf44d16c74a9e3c8
 SHA512:
-  metadata.gz: bc241b3fb2810f89b3145c21cceb1169a89ec75f035865088f365d74c72671baab996d057346945c10c03ab5dae4377347e9c857f3468d426ee72e6996eeb1f5
-  data.tar.gz: d98282d205e143f5503582d251e52d66d12bf41abbf1a1b02136cfbf7849d1473a0b6f3a42cf4f0f6afacad3ac00d54a5d9edd0f05f0b6b0971715ab70bea1de
+  metadata.gz: 7b9110c730003d6bfaf764bf50017a839b2f35708a19e1f027469deb93ed1426fd8c7f83ec7dcafe2bd8ae5ea34b8580d61945baba2a3747b90ed9c32b1d53c5
+  data.tar.gz: 4c8f3c651c7673f5d08173b461b63da3a02a2c0d6b0757287c367a408b6630fc6f0530f65d911d869df7870381596c3d8e8552f88331560f069d4952a1c7da39

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.4.0 (2015-12-13)
+
+- Enhancements
+  - `vagrant run help` prints the plugin help (same as `vagrant run`)
+  - `vagrant run version` prints the currently used plugin version
+  - Commands can receive additional parameters from the command line
+
+- Backwards incompatible changes
+  - Command names `help` and `version` are reserved for internal usage
+  - Depecrated command definer was removed
+
+- Bug fixes
+  - Commands without a script display a message and are ignored
+
 ## v0.3.0 (2015-11-21)
 
 - Enhancements

data/README.md

@@ -18,6 +18,25 @@ command 'with_options',
     script: 'hostname'
 ```
 
+#### Command Definition (parameters)
+
+Passing additional parameters to a command is (minimally) supported using an
+sprintf syntax:
+
+```ruby
+command 'with_param', script: 'echo "%s"'
+```
+
+This allows you to execute the following command:
+
+```shell
+# will execute something like 'echo "works"'
+vagrant run with_param works
+```
+
+For now a command expecting one or more parameters will fail if the user does
+not provide them. Any arguments exceeding the number used are silently
+discarded.
 
 ### Command Listing
 

data/lib/vagrant/devcommands/command.rb

@@ -13,18 +13,13 @@ module VagrantPlugins
       end
 
       def execute
-        command     = @argv.last
-        commandfile = Commandfile.new(@env)
-
-        return display_error('Missing "Commandfile"') unless commandfile.exist?
+        return 127 unless read_commandfile
 
-        @registry.read_commandfile(commandfile)
+        command = argv_command
 
-        return display_help unless command
+        return 127 unless check_command(command)
 
-        unless @registry.valid_command?(command)
-          return display_error("Invalid command \"#{command}\"\n")
-        end
+        return run_internal(command) if @registry.reserved_command?(command)
 
         run @registry.commands[command]
       end
@@ -33,41 +28,90 @@ module VagrantPlugins
 
       attr_accessor :registry
 
+      def check_command(command)
+        unless command
+          run_internal('help')
+          return false
+        end
+
+        unless @registry.valid_command?(command)
+          display_error("Invalid command \"#{command}\"\n")
+          return false
+        end
+
+        true
+      end
+
+      def argv_command
+        return nil unless @argv.length
+
+        command = @argv[0]
+        command = @argv[1] if @env.machine_index.include?(command)
+
+        command
+      end
+
       def display_error(msg)
-        puts(msg) && display_help
+        puts(msg) && run_internal('help')
       end
 
-      def display_help
-        Help.display(@registry)
+      def read_commandfile
+        commandfile = Commandfile.new(@env)
 
-        # return exit code
-        127
+        unless commandfile.exist?
+          display_error('Missing "Commandfile"')
+          return false
+        end
+
+        @registry.read_commandfile(commandfile)
+
+        true
       end
 
       def run(command)
-        argv = run_argv(command)
+        argv   = run_argv
+        box    = run_box(command)
+        script = run_script(command[:script], argv)
 
-        with_target_vms(argv, single_target: true) do |vm|
+        return 2 unless script
+
+        with_target_vms(box, single_target: true) do |vm|
           env = vm.action(:ssh_run,
                           ssh_opts: { extra_args: ['-q'] },
-                          ssh_run_command: command[:script])
+                          ssh_run_command: script)
 
           return env[:ssh_run_exit_status] || 0
         end
       end
 
-      def run_argv(cmd)
+      def run_argv
         argv = @argv.dup
-        argv.pop
-
-        if cmd[:box] && argv.empty?
-          argv.unshift(cmd[:box].to_s)
-        elsif cmd[:box] && 1 == argv.size
-          argv[0] = cmd[:box].to_s
-        end
 
+        argv.shift if @env.machine_index.include?(argv[0])
+        argv.shift
         argv
       end
+
+      def run_box(cmd)
+        return cmd[:box] if cmd[:box]
+        return @argv[0] if @env.machine_index.include?(@argv[0])
+
+        nil
+      end
+
+      def run_internal(command)
+        Internal.new(@registry).run(command)
+      end
+
+      def run_script(script, argv)
+        script % argv
+      rescue ArgumentError
+        error = "Not enough parameters to execute \"command[:name]\"!"
+
+        display_error(error)
+
+        nil
+      end
     end
   end
 end

data/lib/vagrant/devcommands/internal.rb

@@ -0,0 +1,55 @@
+module VagrantPlugins
+  module DevCommands
+    # Handles internal commands and their execution.
+    class Internal
+      def initialize(registry)
+        @registry = registry
+      end
+
+      def run(command)
+        case command
+        when 'help'
+          print_help
+        when 'version'
+          print_version
+        end
+
+        0
+      end
+
+      private
+
+      def print_help
+        if @registry.commands.empty?
+          puts 'No commands defined!'
+          return
+        end
+
+        display_help_header
+        display_help_commands
+      end
+
+      def display_help_commands
+        pad_to = @registry.commands.keys.map(&:length).max
+
+        @registry.commands.each do |name, command|
+          if command.key?(:desc)
+            puts "     #{name.ljust(pad_to)}   #{command[:desc]}"
+          else
+            puts "     #{name}"
+          end
+        end
+      end
+
+      def display_help_header
+        puts 'Usage: vagrant run [box] <command>'
+        puts ''
+        puts 'Available commands:'
+      end
+
+      def print_version
+        puts "vagrant-devcommands, version #{VERSION}"
+      end
+    end
+  end
+end

data/lib/vagrant/devcommands/registry.rb

@@ -2,6 +2,8 @@ module VagrantPlugins
   module DevCommands
     # Vagrant command registry
     class Registry
+      RESERVED_COMMANDS = %w(help version)
+
       attr_accessor :commands
 
       def initialize
@@ -12,36 +14,39 @@ module VagrantPlugins
         contents = commandfile.path.read
 
         instance_eval(contents)
-        append_legacy
+      end
+
+      def reserved_command?(command)
+        RESERVED_COMMANDS.include?(command)
       end
 
       def valid_command?(command)
-        @commands.include? command
+        @commands.include?(command) || reserved_command?(command)
       end
 
       private
 
-      def append_legacy
-        unless Definer.commands.empty?
-          puts "You are using a deprecated way of defining your commands.\n" \
-               'The methods you are using will be removed in an upcoming' \
-               " release.\nPlease update your Commandfile!\n\nMore details: " \
-               'https://github.com/mneudert/vagrant-devcommands'
-        end
+      def command(name, options)
+        return reserved_warning(name) if reserved_command?(name)
+
+        options = { script: options } if options.is_a?(String)
 
-        Definer.commands.each do |name, options|
-          next if @commands.include?(name)
+        return script_warning(name) unless options.key?(:script)
 
-          command(name, options)
-        end
+        @commands[name]        = options
+        @commands[name][:name] = name
       end
 
-      def command(name, options)
-        if options.is_a?(String)
-          @commands[name] = { script: options }
-        else
-          @commands[name] = options
-        end
+      def script_warning(name)
+        puts "The command '#{name}' has no script defined to execute."
+        puts 'Your definition of it will be ignored.'
+        puts ''
+      end
+
+      def reserved_warning(name)
+        puts "The command name '#{name}' is reserved for internal usage."
+        puts 'Your definition of it will be ignored.'
+        puts ''
       end
     end
   end

data/lib/vagrant/devcommands/version.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   # Defines the current plugin version
   module DevCommands
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/vagrant/devcommands.rb

@@ -2,10 +2,7 @@ require 'vagrant'
 
 require 'vagrant/devcommands/command'
 require 'vagrant/devcommands/commandfile'
-require 'vagrant/devcommands/definer'
-require 'vagrant/devcommands/help'
+require 'vagrant/devcommands/internal'
 require 'vagrant/devcommands/plugin'
 require 'vagrant/devcommands/registry'
 require 'vagrant/devcommands/version'
-
-require 'vagrant/devcommands/_proxy'

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.10.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.10.6
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -92,11 +98,9 @@ files:
 - LICENSE.txt
 - README.md
 - lib/vagrant/devcommands.rb
-- lib/vagrant/devcommands/_proxy.rb
 - lib/vagrant/devcommands/command.rb
 - lib/vagrant/devcommands/commandfile.rb
-- lib/vagrant/devcommands/definer.rb
-- lib/vagrant/devcommands/help.rb
+- lib/vagrant/devcommands/internal.rb
 - lib/vagrant/devcommands/plugin.rb
 - lib/vagrant/devcommands/registry.rb
 - lib/vagrant/devcommands/version.rb

data/lib/vagrant/devcommands/_proxy.rb

@@ -1,6 +0,0 @@
-# Proxy class to make Commandfile definitions more readable.
-class VagrantDevCommands
-  def self.define(name, options)
-    VagrantPlugins::DevCommands::Definer.define(name, options)
-  end
-end

data/lib/vagrant/devcommands/definer.rb

@@ -1,24 +0,0 @@
-module VagrantPlugins
-  module DevCommands
-    # Public interface to define and access commands.
-    class Definer
-      class << self; attr_accessor :commands end
-
-      @commands = {}
-
-      def self.define(name, options)
-        if options.is_a?(String)
-          @commands[name] = { script: options }
-        else
-          if options.include?(:command)
-            options[:script] = options[:command]
-
-            options.delete(:command)
-          end
-
-          @commands[name] = options
-        end
-      end
-    end
-  end
-end

data/lib/vagrant/devcommands/help.rb

@@ -1,40 +0,0 @@
-module VagrantPlugins
-  module DevCommands
-    # Defines the help output
-    #
-    # Printed when running "vagrant run" without a command
-    class Help
-      def self.display(registry)
-        if registry.commands.empty?
-          puts 'No commands defined!'
-          return
-        end
-
-        display_header
-        display_commands(registry)
-      end
-
-      class << self
-        private
-
-        def display_commands(registry)
-          pad_to = registry.commands.keys.map(&:length).max
-
-          registry.commands.each do |name, command|
-            if command.key?(:desc)
-              puts "     #{name.ljust(pad_to)}   #{command[:desc]}"
-            else
-              puts "     #{name}"
-            end
-          end
-        end
-
-        def display_header
-          puts 'Usage: vagrant run [box] <command>'
-          puts ''
-          puts 'Available commands:'
-        end
-      end
-    end
-  end
-end