vagrant-devcommands 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32211b187c89aedb28b7e3b084553e07030fa971
-  data.tar.gz: 2be8cec37c79264056981c70acdd490ebdeb4d18
+  metadata.gz: 1cdd09f90d6b080675f4b15e4fb9ec4ce3101cf2
+  data.tar.gz: 9968d30256b15ce9247ad33c39e1e1c39a3b6daf
 SHA512:
-  metadata.gz: a6a418391c08c271c88d3c334a88c1ad02173725fe2300bc81523ce9302b3344068769cdf52c23da6fd869a307bf8ba01f0a78855aca86afbaa2a42de384e858
-  data.tar.gz: cabdfa5024114480df1ae410ddfd7d78928a62099672fd6909838260fa0e314f708a73abd00d08e01d57917b14fe203a1149217aeefec1735cb1aca91466af37
+  metadata.gz: aa62d03f315aab6378feb9f9ffff8d7c3f3f22930c2b7ab177ab7afea46e34761a7cab7a5c08c4ce249cff2d6e51e288fb6a1d274663ff21b529c5d242bed272
+  data.tar.gz: 6581d21c82f57b249c645844f4e64a5cebe36c4e5171a2992e1a9a9ba914fb4ae710b3d5ae7bfcbe56deb021e5f273910071acfdf655eedf3219d99b85419533

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v0.9.0 (2017-05-20)
+
+- Enhancements
+  - Every command in a chain can specify the machine to be used
+  - If an unknown command is requested a possible alternative
+    is suggested based on the calculated
+    [Jaro-Winkler distance](https://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance)
+
+- Deprecations
+  - The configuration parameter `:box` has been renamed to `:machine` to
+    match the vagrant naming. Support for the old configuration will be
+    dropped in a future version
+
 ## v0.8.0 (2017-04-19)
 
 - Enhancements

data/README.md

@@ -15,11 +15,11 @@ vagrant run
 
 ```shell
 # single-vm environment
-# or multi-vm environment with :box option
+# or multi-vm environment with :machine option
 vagrant run your_command
 
 # multi-vm environment
-vagrant run your_box your_command
+vagrant run your_machine your_command
 ```
 
 This runs commands or alternatively a command chain with the passed name.
@@ -32,8 +32,8 @@ Add to a `Commandfile` besides your `Vagrantfile`:
 command 'basic', 'hostname'
 
 command 'with_options',
-  box: :my_box,
-  desc: 'executes "hostname" on the box "my_box"',
+  machine: :my_machine,
+  desc: 'executes "hostname" on the machine "my_machine"',
   script: 'hostname',
   usage: 'vagrant run %{command}',
   help: <<-eoh
@@ -216,9 +216,37 @@ vagrant run chainecho --first="initial" --second="initial"
 vagrant run chainecho --first="param" --second="param"
 ```
 
-By default every command will be executed using the box defined by the command
-itself or the only one available. You can, however, run the complete chain
-against a specific box using `vagrant run your_box your_chain`.
+By default every command will be executed using the machine defined by the
+command itself or the only one available. You can, however, run the complete
+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:
+
+```ruby
+command 'chainhost',
+  script: 'hostname'
+
+chain 'customized_chain_machine',
+  commands: [
+    { command: 'chainhost' },
+    { command: 'chainecho', machine: 'secondary' },
+    { command: 'chainecho', machine: 'tertiary' }
+  ]
+
+Running the chain will execute the following commands:
+
+```shell
+> vagrant run customized_chain_machine
+
+vagrant run chainhost
+vagrant run secondary chainhost
+vagrant run tertiary chainhost
+```
+
+This configuration can itself be modified by passing a machine name to run
+all chain commands on using  using `vagrant run your_machine your_chain`.
 
 ### Abort Parsing inside Commandfile
 
@@ -250,7 +278,7 @@ evaluating a local one.
 ### SSH
 
 If you are using this plugin on a Windows host system, please make sure your
-regular `vagrant ssh [box]` succeeds. In some cases you may need to add the
+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%`.
 
 ### Command Definition

data/lib/vagrant/devcommands.rb

@@ -8,6 +8,7 @@ require 'vagrant/devcommands/version'
 
 require 'vagrant/devcommands/internal_spec'
 require 'vagrant/devcommands/messages'
+require 'vagrant/devcommands/util/jaro_winkler'
 require 'vagrant/devcommands/util'
 
 require 'vagrant/devcommands/model/chain'

data/lib/vagrant/devcommands/command.rb

@@ -4,6 +4,7 @@ module VagrantPlugins
     class Command < Vagrant.plugin(2, :command)
       NAMESPACE_RUNNER = VagrantPlugins::DevCommands::Runner
       MESSAGES         = VagrantPlugins::DevCommands::Messages
+      UTIL             = VagrantPlugins::DevCommands::Util
 
       def self.synopsis
         synopsis = VagrantPlugins::DevCommands::SYNOPSIS
@@ -20,6 +21,8 @@ module VagrantPlugins
       def execute
         return 127 unless read_commandfile
 
+        deprecated_box_config?
+
         command = Util.argv_command(@argv, @env)
 
         return 127 unless non_empty?(command)
@@ -40,13 +43,27 @@ module VagrantPlugins
       def available?(command)
         unless @registry.available?(command)
           display_error("Invalid command \"#{command}\"!")
+          did_you_mean(command)
           run_internal('help', ['--commands'])
         end
 
         @registry.available?(command)
       end
 
-      def display_error(msg, post_ln = false)
+      def deprecated_box_config?
+        return unless @registry.commands.values.any?(&:deprecated_box_config)
+
+        MESSAGES.deprecated_box_config(&@env.ui.method(:warn))
+      end
+
+      def did_you_mean(command)
+        alternative, score = Util.did_you_mean(command, @registry)
+
+        display_error("Did you mean #{alternative}?", true) if 0.8 < score
+      end
+
+      def display_error(msg, pre_ln = false, post_ln = false)
+        @env.ui.error '' if pre_ln
         @env.ui.error msg
         @env.ui.error '' if post_ln
       end
@@ -81,7 +98,7 @@ module VagrantPlugins
 
         runner.run(runnable)
       rescue RuntimeError => e
-        display_error(e.message, true)
+        display_error(e.message, false, true)
         run_internal('help', [command])
 
         nil

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

@@ -39,7 +39,7 @@ module VagrantPlugins
         end
 
         def header(chain)
-          usage = "vagrant run [box] #{chain.name}"
+          usage = "vagrant run [machine] #{chain.name}"
 
           info(I18n.t('vagrant_devcommands.internal.help.usage', what: usage))
         end

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

@@ -41,7 +41,7 @@ module VagrantPlugins
         end
 
         def header(command)
-          usage = "vagrant run [box] #{command.name}"
+          usage = "vagrant run [machine] #{command.name}"
           usage = usage_params(usage, command)
 
           unless command.usage.nil?

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

@@ -7,7 +7,7 @@ module VagrantPlugins
           @env = env
         end
 
-        def execute(_args)
+        def execute(_argv)
           @env.ui.info "vagrant-devcommands, version #{VERSION}"
         end
       end

data/lib/vagrant/devcommands/messages.rb

@@ -10,6 +10,11 @@ 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 ''
+      end
+
       def self.command_no_help(&out)
         out.call I18n.t("#{I18N_KEY}.command_no_help")
       end

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

@@ -11,11 +11,13 @@ module VagrantPlugins
         attr_reader :parameters
         attr_reader :script
 
-        attr_reader :box
+        attr_reader :machine
         attr_reader :desc
         attr_reader :help
         attr_reader :usage
 
+        attr_reader :deprecated_box_config
+
         def initialize(spec)
           @name = spec[:name]
 
@@ -23,10 +25,12 @@ module VagrantPlugins
           @parameters = spec[:parameters]
           @script     = spec[:script]
 
-          @box   = spec[:box]
-          @desc  = spec[:desc]
-          @help  = spec[:help]
-          @usage = spec[:usage]
+          @machine = spec[:machine] || spec[:box]
+          @desc    = spec[:desc]
+          @help    = spec[:help]
+          @usage   = spec[:usage]
+
+          @deprecated_box_config = spec.key?(:box)
         end
 
         def run_script(argv)
@@ -87,6 +91,7 @@ module VagrantPlugins
 
           wrap_option_values(escape_option_values(options))
         end
+        # rubocop:enable Metrics/MethodLength
 
         def wrap_option_values(options)
           (@parameters || {}).each do |key, conf|

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

@@ -3,6 +3,8 @@ module VagrantPlugins
     module Runner
       # Chain runner
       class Chain
+        UTIL = VagrantPlugins::DevCommands::Util
+
         def initialize(plugin, argv, env, registry)
           @plugin   = plugin
           @argv     = argv
@@ -29,10 +31,22 @@ module VagrantPlugins
         private
 
         def argv_for(command_def)
-          return @argv unless command_def.key?(:argv)
-          return @argv unless command_def[:argv].is_a?(Array)
+          argv = patch_machine(@argv.dup, command_def)
+
+          return argv unless command_def.key?(:argv)
+          return argv unless command_def[:argv].is_a?(Array)
+
+          argv + command_def[:argv]
+        end
+
+        def patch_machine(argv, command_def)
+          return argv unless command_def.key?(:machine)
 
-          @argv + command_def[:argv]
+          if UTIL.machine_name?(argv[0].to_s, @env.machine_index)
+            argv
+          else
+            [command_def[:machine].to_s] + argv
+          end
         end
 
         def runnable_for(command_def)

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

@@ -13,13 +13,13 @@ module VagrantPlugins
         end
 
         def run(command)
-          argv   = run_argv
-          box    = run_box(command)
-          script = run_script(command, argv)
+          argv    = run_argv
+          machine = run_machine(command)
+          script  = run_script(command, argv)
 
           return 2 unless script
 
-          @plugin.proxy_with_target_vms(box, single_target: true) do |vm|
+          @plugin.proxy_with_target_vms(machine, single_target: true) do |vm|
             env = vm.action(:ssh_run,
                             ssh_opts: { extra_args: ['-q'] },
                             ssh_run_command: script)
@@ -38,13 +38,13 @@ module VagrantPlugins
           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)
+        def run_machine(cmd)
+          machine = nil
+          machine = cmd.machine.to_s if cmd.machine
+          machine = @argv[0] if UTIL.machine_name?(@argv[0].to_s,
+                                                   @env.machine_index)
 
-          box
+          machine
         end
 
         def run_script(command, argv)

data/lib/vagrant/devcommands/util.rb

@@ -2,6 +2,8 @@ module VagrantPlugins
   module DevCommands
     # Utility module
     class Util
+      JARO_WINKLER = VagrantPlugins::DevCommands::Util::JaroWinkler
+
       def self.argv_command(argv, env)
         return nil if argv.empty?
 
@@ -29,6 +31,18 @@ module VagrantPlugins
         end
       end
 
+      def self.did_you_mean(command, registry)
+        alternatives = registry.commands.keys + registry.chains.keys
+        distances    = {}
+
+        alternatives.each do |alternative|
+          calculator             = JARO_WINKLER.new(command, alternative)
+          distances[alternative] = calculator.distance
+        end
+
+        distances.max_by { |_k, v| v }
+      end
+
       def self.machine_name?(name, machine_index)
         machine_index.any? { |machine| name == machine.name }
       end

data/lib/vagrant/devcommands/util/jaro_winkler.rb

@@ -0,0 +1,126 @@
+module VagrantPlugins
+  module DevCommands
+    class Util
+      # Jaro Winkler string distance
+      #
+      # Adapted from:
+      # https://github.com/bbatsov/rubocop/blob/ec3123fc3454b080e1100e35480c6466d1240fff/lib/rubocop/string_util.rb
+      class JaroWinkler
+        BOOST_THRESHOLD          = 0.7
+        MAX_COMMON_PREFIX_LENGTH = 4
+        SCALING_FACTOR           = 0.1
+
+        def initialize(left, right)
+          @left  = left.to_s
+          @right = right.to_s
+
+          if @left.size < @right.size
+            @shorter = @left
+            @longer  = @right
+          else
+            @shorter = @right
+            @longer  = @left
+          end
+        end
+
+        def distance
+          jaro_distance = compute_distance
+
+          if jaro_distance >= BOOST_THRESHOLD
+            jaro_distance += (
+              limited_common_prefix_length.to_f *
+              SCALING_FACTOR.to_f *
+              (1.0 - jaro_distance)
+            )
+          end
+
+          jaro_distance
+        end
+
+        private
+
+        def common_prefix_length
+          @shorter.size.times do |index|
+            return index unless @shorter[index] == @longer[index]
+          end
+
+          @shorter.size
+        end
+
+        def compute_distance
+          common_chars_a, common_chars_b = find_common_characters
+          matched_count                  = common_chars_a.size
+
+          return 0.0 if matched_count.zero?
+
+          transposition_count = count_transpositions(common_chars_a,
+                                                     common_chars_b)
+
+          compute_non_zero_distance(matched_count.to_f, transposition_count)
+        end
+
+        def compute_non_zero_distance(matched_count, transposition_count)
+          sum = (matched_count / @shorter.size.to_f) +
+                (matched_count / @longer.size.to_f) +
+                ((matched_count - transposition_count / 2) / matched_count)
+
+          sum / 3.0
+        end
+
+        def count_transpositions(common_chars_a, common_chars_b)
+          common_chars_a.size.times.count do |index|
+            common_chars_a[index] != common_chars_b[index]
+          end
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def find_common_characters
+          common_chars_of_shorter = Array.new(@shorter.size)
+          common_chars_of_longer  = Array.new(@longer.size)
+
+          @shorter.each_char.with_index do |shorter_char, shorter_index|
+            matching_index_range(shorter_index).each do |longer_index|
+              longer_char = @longer.chars[longer_index]
+
+              next unless shorter_char == longer_char
+
+              common_chars_of_shorter[shorter_index] = shorter_char
+              common_chars_of_longer[longer_index]   = longer_char
+
+              # Mark the matching character as already used
+              @longer.chars[longer_index] = nil
+
+              break
+            end
+          end
+
+          [common_chars_of_shorter, common_chars_of_longer].map(&:compact)
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def limited_common_prefix_length
+          length = common_prefix_length
+
+          if length > MAX_COMMON_PREFIX_LENGTH
+            MAX_COMMON_PREFIX_LENGTH
+          else
+            length
+          end
+        end
+
+        def matching_index_range(origin)
+          min = origin - matching_window
+          min = 0 if min < 0
+
+          max = origin + matching_window
+
+          min..max
+        end
+
+        def matching_window
+          @matching_window ||= (@longer.size / 2).to_i - 1
+        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.8.0'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

data/locales/en.yml

@@ -7,7 +7,6 @@ en:
           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: "get currently installed plugin version"
         help: "Displays the currently installed version of the plugin you are using right now."
@@ -15,6 +14,10 @@ en:
     message:
       chain_no_help: "No detailed help for this chain 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
+        option ':box'. This option has been renamed to ':machine' and will
+        stop working in a future version. Please update your Commandfile.
       missing_commandfile: "Missing Commandfile"
       no_commands: "No commands defined!"
       plugin_readme: |-
@@ -24,7 +27,7 @@ en:
         A copy of this file should be locally available at:
         >>> %{readme}
       plugin_usage: |-
-        Usage: vagrant run [box] <command>
+        Usage: vagrant run [machine] <command>
         Help:  vagrant run help <command>
 
     registry:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -95,6 +95,7 @@ files:
 - lib/vagrant/devcommands/runner/internal_command.rb
 - lib/vagrant/devcommands/synopsis.rb
 - lib/vagrant/devcommands/util.rb
+- lib/vagrant/devcommands/util/jaro_winkler.rb
 - lib/vagrant/devcommands/version.rb
 - locales/en.yml
 homepage: https://github.com/mneudert/vagrant-devcommands