vagrant-devcommands 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 264d76e5ba1857747eeb893b4c41ed6a907e8c30
-  data.tar.gz: 8333fdbe0a699481c5bc4e56dea0000394aca710
+  metadata.gz: f8cc009b295488b6a55ff950e98e4400605af8c9
+  data.tar.gz: a9336b3f1abfd04932d9797a4a4edc11b83b868d
 SHA512:
-  metadata.gz: 2712542700027f4d3c4e5f33b9e902d7cf237489bf9ee26c9a54cbb5fda6c91e6628195820fa8aad15b39c7f9054f62323814dc627cbd47bec1390c9e213aef2
-  data.tar.gz: 8c2f25a37e8385d6933dabad95d5453343b92214a9c753eedb10c640b60e9c57a9911632b37cf1a8c2214a89b70967c8f87937bb2b28673fdde770bc2e5881e1
+  metadata.gz: 357c5626f4b7d11dec138c601c3a5830ae92cefcf1bed81f68138a3aa7021dbf821f1fe8357070a6a000828307a3e042d78faf41f06b2c502621136c94c560c8
+  data.tar.gz: 1d2dcfcfd3ce80c70f8d86ed4bd56d7cf4c63564175cba3b3280264a7888abc45a94baa444058a6de6bc38398fa08400ac3724df4ac187c4c7ed76ca7f75a0b7

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v0.6.0 (2016-05-05)
+
+- 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
+    the configured ui class (allows colored output)
+  - Global commands can be defined using a file
+    named `.vagrant.devcommands` located under `Dir.home()`
+  - Invalid parameters are displayed in the error message
+  - Missing parameters are displayed in the error message
+  - Parameter wrapping is only done if a value is passed
+    or a default (at least empty string) is configured
+  - Warnings about using internal command names or missing scripts are now
+    printed using the configured ui class (allows colored output)
+
 ## v0.5.0 (2015-03-21)
 
 - Enhancements

data/README.md

@@ -46,7 +46,7 @@ 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"`.
 
-#### Experimental: Command Definition (parameters)
+#### Commands with Parameters
 
 Passing additional parameters to a command is (minimally) supported using an
 sprintf syntax:
@@ -87,7 +87,7 @@ 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.
 
-#### Experimental: Command Definition (lambda/proc)
+#### Commands defined by Lambda/Proc
 
 You can (more or less) dynamically generate your scripts by defining the
 command with a lambda or proc as its script.
@@ -102,6 +102,45 @@ These will be evaluated when running the command.
 Every rule from regular scripts (parameters, escaping "%", ...) still apply.
 
 
+### Experimental: global command definitions
+
+To have commands available even wihout a `Commandfile` you can define the
+globally. To do this just create a file named `.vagrant.devcommands` in your
+`$HOME` directory.
+
+You can use this command to find the correct path if unsure:
+
+```shell
+ruby -e "require 'pathname'; puts Pathname.new(Dir.home).join('.vagrant.devcommands')"
+```
+
+Any commands defined there will silently be overwritten by a local definition.
+
+### Abort parsing inside Commandfile
+
+If you, for whatever reasons, want to abort further parsing of a `Commandfile`
+you can simple return from it:
+
+```ruby
+command 'foo', script: 'foo'
+
+
+v_cur = Gem::Version.new(VagrantPlugins::DevCommands::VERSION)
+v_min = Gem::Version.new('1.3.3.7')
+
+return if v_cur < v_min
+
+
+command 'bar', script: 'bar'
+```
+
+This example leads to the command `bar` not being available if the currently
+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.
+
+
 ## Notes for Windows Users
 
 ### SSH

data/lib/vagrant/devcommands/command.rb

@@ -7,7 +7,7 @@ module VagrantPlugins
       end
 
       def initialize(argv, env)
-        @registry = Registry.new
+        @registry = Registry.new(env)
 
         super(argv, env)
       end
@@ -35,7 +35,9 @@ module VagrantPlugins
         end
 
         unless @registry.valid_command?(command)
-          display_error("Invalid command \"#{command}\"\n")
+          display_error("Invalid command \"#{command}\"!")
+          run_internal('help', ['--commands'])
+
           return false
         end
 
@@ -52,14 +54,16 @@ module VagrantPlugins
       end
 
       def display_error(msg)
-        puts(msg) && run_internal('help')
+        @env.ui.error msg
+        @env.ui.error ''
       end
 
       def read_commandfile
         commandfile = CommandFile.new(@env)
 
         unless commandfile.exist?
-          display_error('Missing "Commandfile"')
+          @env.ui.error 'Missing "Commandfile"'
+
           return false
         end
 
@@ -99,16 +103,23 @@ module VagrantPlugins
         nil
       end
 
-      def run_internal(command)
-        Internal.new(@registry).run(command, run_argv)
+      def run_internal(command, args = nil)
+        Internal.new(@env, @registry).run(command, args || run_argv)
       end
 
       def run_script(command, argv)
         command.run_script(argv)
-      rescue KeyError, OptionParser::InvalidOption
-        error = "Invalid/Missing parameters to execute \"#{command.name}\"!"
+      rescue KeyError => e
+        param = e.message.match(/{(.+)}/).captures.first
+
+        run_script_error(command.name, "missing parameter '#{param}'")
+      rescue OptionParser::InvalidOption => e
+        run_script_error(command.name, "invalid parameter '#{e.args.first}'")
+      end
 
-        display_error(error)
+      def run_script_error(command, error)
+        display_error("Could not execute #{command}: #{error}!")
+        run_internal('help', [command])
 
         nil
       end

data/lib/vagrant/devcommands/command_def.rb

@@ -55,7 +55,7 @@ module VagrantPlugins
 
         @parameters.each do |key, conf|
           options[key] = '' if conf[:optional]
-          options[key] = conf[:default] if conf[:default]
+          options[key] = conf[:default] unless conf[:default].nil?
         end
 
         options
@@ -64,6 +64,7 @@ module VagrantPlugins
       def wrap_option_values(options)
         @parameters.each do |key, conf|
           next if conf[:wrap].nil?
+          next if options[key].nil? && conf[:default].nil?
 
           options[key] = conf[:wrap] % options[key]
         end

data/lib/vagrant/devcommands/command_file.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module VagrantPlugins
   module DevCommands
     # Loads and handles the Commandfile
@@ -7,13 +9,21 @@ module VagrantPlugins
       end
 
       def exist?
-        nil != find_commandfile
+        nil != path
       end
 
       def path
         find_commandfile
       end
 
+      def path_global
+        global = Pathname.new(Dir.home).join('.vagrant.devcommands')
+
+        return global if global.file?
+
+        nil
+      end
+
       private
 
       attr_accessor :env

data/lib/vagrant/devcommands/internal.rb

@@ -9,10 +9,10 @@ module VagrantPlugins
         'version' => CommandDef.new(NAMESPACE::Version::SPEC)
       }.freeze
 
-      def initialize(registry)
+      def initialize(env, registry)
         @internal = {
-          'help'    => NAMESPACE::Help.new(registry),
-          'version' => NAMESPACE::Version.new
+          'help'    => NAMESPACE::Help.new(env, registry),
+          'version' => NAMESPACE::Version.new(env)
         }
         @registry = registry
       end

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

@@ -13,39 +13,33 @@ Just like this help for the help command!
 eoh
         }.freeze
 
-        def initialize(registry)
+        def initialize(env, registry)
+          @env      = env
           @registry = registry
         end
 
         def execute(argv)
-          if @registry.commands.empty?
-            puts 'No commands defined!'
-            return
-          end
+          return plugin_help_empty if @registry.commands.empty?
+
+          command = argv[0]
 
-          return plugin_help unless @registry.valid_command?(argv[0])
-          return internal_help(argv[0]) if @registry.reserved_command?(argv[0])
+          return plugin_help(command) unless @registry.valid_command?(command)
+          return internal_help(command) if @registry.reserved_command?(command)
 
-          command_help(argv[0])
+          command_help(command)
         end
 
         private
 
-        def collect_commands
-          internal = VagrantPlugins::DevCommands::Internal::COMMANDS
-
-          @registry.commands.merge internal
-        end
-
         def command_help(command)
           command_help_header(command)
 
-          puts ''
+          @env.ui.info ''
 
           if @registry.commands[command].help.nil?
-            puts 'No detailed help for this command available.'
+            @env.ui.info 'No detailed help for this command available.'
           else
-            puts @registry.commands[command].help
+            @env.ui.info @registry.commands[command].help
           end
         end
 
@@ -57,60 +51,86 @@ eoh
             usage = @registry.commands[command].usage % { command: command }
           end
 
-          puts "Usage: #{usage}"
+          @env.ui.info "Usage: #{usage}"
+        end
+
+        def command_pad_to
+          internal_commands
+            .merge(@registry.commands)
+            .keys
+            .map(&:length)
+            .max
+        end
+
+        def internal_commands
+          VagrantPlugins::DevCommands::Internal::COMMANDS
         end
 
         def internal_help(command)
           internal_help_header(command)
 
-          puts ''
-          puts VagrantPlugins::DevCommands::Internal::COMMANDS[command].help
+          @env.ui.info ''
+          @env.ui.info internal_commands[command].help
         end
 
         def internal_help_header(command)
-          spec  = VagrantPlugins::DevCommands::Internal::COMMANDS[command]
+          spec  = internal_commands[command]
           usage = spec.usage % { command: command }
 
-          puts "Usage: #{usage}"
+          @env.ui.info "Usage: #{usage}"
         end
 
-        def plugin_help
-          plugin_help_header
-          plugin_help_commands
+        def plugin_help(command)
+          plugin_help_usage unless '--commands' == command
+
+          pad_to = command_pad_to
+
+          plugin_help_commands('Available', @registry.commands, pad_to)
+          plugin_help_commands('Internal', internal_commands, pad_to)
         end
 
-        def plugin_help_commands
-          commands = collect_commands
-          pad_to   = commands.keys.map(&:length).max
+        def plugin_help_commands(type, commands, pad_to)
+          @env.ui.info ''
+          @env.ui.info "#{type} commands:"
 
-          commands.each do |name, command|
+          commands.sort.each do |name, command|
             if command.desc.nil?
-              puts "     #{name}"
+              @env.ui.info "     #{name}"
             else
-              puts "     #{name.ljust(pad_to)}   #{command.desc}"
+              @env.ui.info "     #{name.ljust(pad_to)}   #{command.desc}"
             end
           end
         end
 
-        def plugin_help_header
-          puts 'Usage: vagrant run [box] <command>'
-          puts 'Help:  vagrant run help <command>'
-          puts ''
-          puts 'Available commands:'
+        def plugin_help_empty
+          @env.ui.info 'No commands defined!'
+        end
+
+        def plugin_help_usage
+          @env.ui.info 'Usage: vagrant run [box] <command>'
+          @env.ui.info 'Help:  vagrant run help <command>'
         end
 
         def usage_params(usage, command)
           return usage if command.parameters.nil?
 
-          params = command.parameters.collect do |key, opts|
-            if opts[:optional]
-              "[#{key}]"
-            else
-              "<#{key}>"
-            end
+          [
+            usage,
+            usage_params_mandatory(command.parameters),
+            usage_params_optional(command.parameters)
+          ].flatten.compact.join(' ').strip
+        end
+
+        def usage_params_mandatory(params)
+          params.collect do |key, opts|
+            "--#{key}=<#{key}>" unless opts[:optional]
           end
+        end
 
-          "#{usage} #{params.join(' ')}"
+        def usage_params_optional(params)
+          params.collect do |key, opts|
+            "[--#{key}=<#{key}>]" if opts[:optional]
+          end
         end
       end
     end

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

@@ -12,8 +12,12 @@ Displays the currently installed version the plugin you are using right now.
 eoh
         }.freeze
 
+        def initialize(env)
+          @env = env
+        end
+
         def execute(_args)
-          puts "vagrant-devcommands, version #{VERSION}"
+          @env.ui.info "vagrant-devcommands, version #{VERSION}"
         end
       end
     end

data/lib/vagrant/devcommands/registry.rb

@@ -6,12 +6,18 @@ module VagrantPlugins
 
       attr_accessor :commands
 
-      def initialize
+      def initialize(env)
         @commands = {}
+        @env      = env
       end
 
       def read_commandfile(commandfile)
-        contents = commandfile.path.read
+        global = commandfile.path_global
+        local  = commandfile.path
+
+        contents  = ''
+        contents += "\n" + global.read unless nil == global
+        contents += "\n" + local.read unless nil == local
 
         instance_eval(contents)
       end
@@ -26,12 +32,12 @@ module VagrantPlugins
 
       private
 
-      def command(name, options)
+      def command(name, options = nil)
         return reserved_warning(name) if reserved_command?(name)
 
         options = { script: options } unless options.is_a?(Hash)
 
-        return script_warning(name) unless options.key?(:script)
+        return script_warning(name) unless valid_script?(options[:script])
 
         options[:name] = name
 
@@ -39,15 +45,27 @@ module VagrantPlugins
       end
 
       def script_warning(name)
-        puts "The command '#{name}' has no script defined to execute."
-        puts 'Your definition of it will be ignored.'
-        puts ''
+        @env.ui.warn "The command '#{name}' has no script defined to execute."
+        @env.ui.warn 'Your definition of it will be ignored.'
+        @env.ui.warn ''
       end
 
       def reserved_warning(name)
-        puts "The command name '#{name}' is reserved for internal usage."
-        puts 'Your definition of it will be ignored.'
-        puts ''
+        @env.ui.warn(
+          "The command name '#{name}' is reserved for internal usage."
+        )
+
+        @env.ui.warn 'Your definition of it will be ignored.'
+        @env.ui.warn ''
+      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

data/lib/vagrant/devcommands/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler