vagrant-devcommands 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8cc009b295488b6a55ff950e98e4400605af8c9
-  data.tar.gz: a9336b3f1abfd04932d9797a4a4edc11b83b868d
+  metadata.gz: 9c92cad09fd102f04af3040e3652d21942787743
+  data.tar.gz: 6f76ac6ff0b4c852b5fa3a9e7419d22a42529c42
 SHA512:
-  metadata.gz: 357c5626f4b7d11dec138c601c3a5830ae92cefcf1bed81f68138a3aa7021dbf821f1fe8357070a6a000828307a3e042d78faf41f06b2c502621136c94c560c8
-  data.tar.gz: 1d2dcfcfd3ce80c70f8d86ed4bd56d7cf4c63564175cba3b3280264a7888abc45a94baa444058a6de6bc38398fa08400ac3724df4ac187c4c7ed76ca7f75a0b7
+  metadata.gz: dc5cdabc09ff186bfceb197b3a47bb0100222771e979bf3bf6f596c1685cf7c2216997c294fff863aae382262aa1cc7ca4215bfda35bd5a2ae1b096d9a9be462
+  data.tar.gz: 810924b466b73987ced9be2d413788eebd42b0fbc859d140f0df4e66dd61fcc2621e31ad209ca4a9fc67fe7d2913e27757402aab72d2c5880902167fd5154af8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.0 (2016-09-26)
+
+- Enhancements
+  - Parameters are allowed to have a detailed description
+  - Parameters values can be escaped before interpolation
+
 ## v0.6.0 (2016-05-05)
 
 - Enhancements
@@ -16,7 +22,7 @@
   - 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)
+## v0.5.0 (2016-03-21)
 
 - Enhancements
   - Commands can define a detailed help message

data/README.md

@@ -54,39 +54,49 @@ sprintf syntax:
 ```ruby
 command 'with_param',
   parameters: {
-    # mandatory parameter
-    mdtry: {},
+    # mandatory parameter with a description
+    p_mandatory: { desc: "mandatory parameter to do... stuff!" },
+
     # parameter with default (implies optional)
-    dflt: { default: "always" },
+    p_default: { default: "always" },
+
+    # parameter with escaping rule
+    p_escaped: { escape: { '*' => '\\' }},
+
     # optional parameter
-    optnl: { optional: true },
+    p_optional: { optional: true },
+
     # wrapped option value
-    wrppd: { wrap: "--and %s wrapped" }
+    p_wrapped: { wrap: "--and %s wrapped" }
   },
-  script: 'echo %{mdtry} %{dflt} %{optnl} %{wrppd}'
+  script: 'echo %{p_mandatory} %{p_default} %{p_escaped} %{p_optional} %{p_wrapped}'
 ```
 
 This allows you to execute the following command:
 
 ```shell
 # will execute 'echo works always'
-vagrant run with_param --mdtry works
+vagrant run with_param --p_mandatory works
 
 # will execute 'echo works always like a charm'
-vagrant run with_param --mdtry works --optnl "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'
 vagrant run with_param \
-    --mdtry works \
-    --dflt sometimes \
-    --optnl "like a charm" \
-    --wrppd is
+    --p_mandatory works \
+    --p_default sometimes \
+    --p_optional "like a charm" \
+    --p_wrapped is
 ```
 
 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.
 
+Escaping rules are defined as `{ "char_to_escape": "char_to_use_as_escape" }`.
+These are applied prior to interpolation into the command. Regular ruby escaping
+rules apply.
+
 #### Commands defined by Lambda/Proc
 
 You can (more or less) dynamically generate your scripts by defining the

data/lib/vagrant/devcommands/command.rb

@@ -62,7 +62,7 @@ module VagrantPlugins
         commandfile = CommandFile.new(@env)
 
         unless commandfile.exist?
-          @env.ui.error 'Missing "Commandfile"'
+          @env.ui.error 'Missing Commandfile'
 
           return false
         end

data/lib/vagrant/devcommands/command_def.rb

@@ -36,18 +36,17 @@ module VagrantPlugins
 
       private
 
-      def parse_argv(argv)
-        options = options_with_defaults
+      def escape_option_values(options)
+        @parameters.each do |key, conf|
+          next if conf[:escape].nil?
 
-        OptionParser.new do |opts|
-          @parameters.each do |key, _conf|
-            opts.on("--#{key} OPTION", "Parameter: #{key}") do |o|
-              options[key] = o
-            end
+          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.parse!(argv)
+        end
 
-        wrap_option_values options
+        options
       end
 
       def options_with_defaults
@@ -61,6 +60,20 @@ module VagrantPlugins
         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?

data/lib/vagrant/devcommands/internal.rb

@@ -2,17 +2,18 @@ module VagrantPlugins
   module DevCommands
     # Handles internal commands and their execution.
     class Internal
-      NAMESPACE = VagrantPlugins::DevCommands::InternalCommand
+      NAMESPACE_CMD  = VagrantPlugins::DevCommands::InternalCommand
+      NAMESPACE_SPEC = VagrantPlugins::DevCommands::InternalSpec
 
       COMMANDS = {
-        'help'    => CommandDef.new(NAMESPACE::Help::SPEC),
-        'version' => CommandDef.new(NAMESPACE::Version::SPEC)
+        'help'    => CommandDef.new(NAMESPACE_SPEC::HELP),
+        'version' => CommandDef.new(NAMESPACE_SPEC::VERSION)
       }.freeze
 
       def initialize(env, registry)
         @internal = {
-          'help'    => NAMESPACE::Help.new(env, registry),
-          'version' => NAMESPACE::Version.new(env)
+          'help'    => NAMESPACE_CMD::Help.new(env, registry),
+          'version' => NAMESPACE_CMD::Version.new(env)
         }
         @registry = registry
       end

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

@@ -3,15 +3,8 @@ module VagrantPlugins
     module InternalCommand
       # Internal "help" command
       class Help
-        SPEC = {
-          desc: 'display this help message',
-          name: 'help',
-          usage: 'vagrant run %{command} [command]',
-          help: <<-eoh
-Display the help of the command given as the first argument if defined.
-Just like this help for the help command!
-eoh
-        }.freeze
+        UTIL     = VagrantPlugins::DevCommands::Util
+        MESSAGES = VagrantPlugins::DevCommands::Messages
 
         def initialize(env, registry)
           @env      = env
@@ -19,7 +12,7 @@ eoh
         end
 
         def execute(argv)
-          return plugin_help_empty if @registry.commands.empty?
+          return message(:no_commands) if @registry.commands.empty?
 
           command = argv[0]
 
@@ -33,13 +26,17 @@ eoh
 
         def command_help(command)
           command_help_header(command)
+          command_help_parameters(command)
+          command_help_body(@registry.commands[command].help)
+        end
 
+        def command_help_body(help)
           @env.ui.info ''
 
-          if @registry.commands[command].help.nil?
-            @env.ui.info 'No detailed help for this command available.'
+          if help.nil?
+            message(:no_help)
           else
-            @env.ui.info @registry.commands[command].help
+            @env.ui.info help.strip
           end
         end
 
@@ -54,12 +51,22 @@ eoh
           @env.ui.info "Usage: #{usage}"
         end
 
-        def command_pad_to
-          internal_commands
-            .merge(@registry.commands)
-            .keys
-            .map(&:length)
-            .max
+        def command_help_parameters(command)
+          return if @registry.commands[command].parameters.nil?
+
+          @env.ui.info ''
+          @env.ui.info 'Parameters:'
+
+          command_help_parameters_body(command)
+        end
+
+        def command_help_parameters_body(command)
+          params = @registry.commands[command].parameters
+          pad_to = UTIL.pad_to(params)
+
+          params.sort.each do |name, options|
+            @env.ui.info UTIL.padded_columns(pad_to, name, options[:desc])
+          end
         end
 
         def internal_commands
@@ -70,7 +77,7 @@ eoh
           internal_help_header(command)
 
           @env.ui.info ''
-          @env.ui.info internal_commands[command].help
+          @env.ui.info internal_commands[command].help.strip
         end
 
         def internal_help_header(command)
@@ -80,13 +87,19 @@ eoh
           @env.ui.info "Usage: #{usage}"
         end
 
+        def message(msg)
+          MESSAGES.public_send(msg, &@env.ui.method(:info))
+        end
+
         def plugin_help(command)
-          plugin_help_usage unless '--commands' == command
+          message(:plugin_usage) unless '--commands' == command
 
-          pad_to = command_pad_to
+          pad_to = UTIL.pad_to(internal_commands.merge(@registry.commands))
 
           plugin_help_commands('Available', @registry.commands, pad_to)
           plugin_help_commands('Internal', internal_commands, pad_to)
+
+          message(:plugin_usage_info) unless '--commands' == command
         end
 
         def plugin_help_commands(type, commands, pad_to)
@@ -94,23 +107,10 @@ eoh
           @env.ui.info "#{type} commands:"
 
           commands.sort.each do |name, command|
-            if command.desc.nil?
-              @env.ui.info "     #{name}"
-            else
-              @env.ui.info "     #{name.ljust(pad_to)}   #{command.desc}"
-            end
+            @env.ui.info UTIL.padded_columns(pad_to, name, command.desc)
           end
         end
 
-        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?
 

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

@@ -3,15 +3,6 @@ module VagrantPlugins
     module InternalCommand
       # Internal "version" command
       class Version
-        SPEC = {
-          desc: 'display currently used the plugin version',
-          name: 'version',
-          usage: 'vagrant run %{command}',
-          help: <<-eoh
-Displays the currently installed version the plugin you are using right now.
-eoh
-        }.freeze
-
         def initialize(env)
           @env = env
         end

data/lib/vagrant/devcommands/internal_spec.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module DevCommands
+    # Contains the specs for internal commands
+    class InternalSpec
+      HELP = {
+        desc:  I18n.t('vagrant_devcommands.internal.help.desc'),
+        name:  'help',
+        usage: 'vagrant run %{command} [command]',
+        help:  I18n.t('vagrant_devcommands.internal.help.help')
+      }.freeze
+
+      VERSION = {
+        desc:  I18n.t('vagrant_devcommands.internal.version.desc'),
+        name:  'version',
+        usage: 'vagrant run %{command}',
+        help:  I18n.t('vagrant_devcommands.internal.version.help')
+      }.freeze
+    end
+  end
+end

data/lib/vagrant/devcommands/messages.rb

@@ -0,0 +1,33 @@
+require 'optparse'
+
+module VagrantPlugins
+  module DevCommands
+    # Provides access to messages used by the plugin
+    class Messages
+      def self.no_help(&out)
+        out.call 'No detailed help for this command available.'
+      end
+
+      def self.no_commands(&out)
+        out.call 'No commands defined!'
+      end
+
+      def self.plugin_usage(&out)
+        out.call 'Usage: vagrant run [box] <command>'
+        out.call 'Help:  vagrant run help <command>'
+      end
+
+      def self.plugin_usage_info(&out)
+        curdir = File.expand_path(File.dirname(__FILE__))
+        readme = File.expand_path(File.join(curdir, '../../../README.md'))
+
+        out.call ''
+        out.call 'For detailed usage please read the'
+        out.call 'README.md at the original source location:'
+        out.call '>>> https://github.com/mneudert/vagrant-devcommands'
+        out.call 'A copy of this file should be locally available at'
+        out.call ">>> #{readme}"
+      end
+    end
+  end
+end

data/lib/vagrant/devcommands/util.rb

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module DevCommands
+    # Utility module
+    class Util
+      def self.pad_to(items)
+        items.keys.map(&:length).max
+      end
+
+      def self.padded_columns(pad_to, left, right)
+        left  = left.to_s  unless left.is_a?(String)
+        right = right.to_s unless right.is_a?(String)
+
+        if right.nil?
+          "     #{left}"
+        else
+          "     #{left.ljust(pad_to)}   #{right}"
+        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.6.0'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

data/lib/vagrant/devcommands.rb

@@ -1,5 +1,12 @@
 require 'vagrant'
 
+I18n.load_path << File.expand_path('../../../locales/en.yml', __FILE__)
+I18n.reload!
+
+require 'vagrant/devcommands/internal_spec'
+require 'vagrant/devcommands/messages'
+require 'vagrant/devcommands/util'
+
 require 'vagrant/devcommands/internal_command/help'
 require 'vagrant/devcommands/internal_command/version'
 

data/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  vagrant_devcommands:
+    internal:
+      help:
+        desc: "display this help message"
+        help: |-
+          Display the help of the command given as the first argument if defined.
+          Just like this help for the help command!
+
+      version:
+        desc: "display currently used the plugin version"
+        help: "Displays the currently installed version the plugin you are using right now."

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-05 00:00:00.000000000 Z
+date: 2016-09-26 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.10.6
+        version: 1.12.5
   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.10.6
+        version: 1.12.5
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -104,9 +98,13 @@ files:
 - lib/vagrant/devcommands/internal.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/plugin.rb
 - lib/vagrant/devcommands/registry.rb
+- lib/vagrant/devcommands/util.rb
 - lib/vagrant/devcommands/version.rb
+- locales/en.yml
 homepage: https://github.com/mneudert/vagrant-devcommands
 licenses:
 - MIT