vagrant-devcommands 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1835de5d77e36ecc2fdda818fd4b6f682d044b8
-  data.tar.gz: b9edaee5f787c09dd8b4783d5342fb7e55045a0c
+  metadata.gz: ec61d0c70a777b0ee45eaa801f90259553d7d3a6
+  data.tar.gz: b230c5d5e67753087b152e54ec38ca395b2bdc30
 SHA512:
-  metadata.gz: 5cc5094fa2638a80ce20390587e42c26b589c02c8744fe112166cd82f2d54f796983866967af80021ad7c97a5b6caa52cc3fc03f62c412f36525ffca99590b6c
-  data.tar.gz: 9323285ba6a94e6339f28c44b539c7cc0eb27698acc28b08ea22671a5c08c8a07230f1de03e3ed41cbd7ce6c2aba3bd8517dc5bb704edd4afa436baaa6942198
+  metadata.gz: bc241b3fb2810f89b3145c21cceb1169a89ec75f035865088f365d74c72671baab996d057346945c10c03ab5dae4377347e9c857f3468d426ee72e6996eeb1f5
+  data.tar.gz: d98282d205e143f5503582d251e52d66d12bf41abbf1a1b02136cfbf7849d1473a0b6f3a42cf4f0f6afacad3ac00d54a5d9edd0f05f0b6b0971715ab70bea1de

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.3.0 (2015-11-21)
+
+- Enhancements
+  - Commands can be created using `command 'name', 'script'`
+
+- Deprecations
+  - Commands defined without the new `command ...` syntax are deprecated
+
 ## v0.2.0 (2015-11-02)
 
 - Enhancements

data/README.md

@@ -10,12 +10,12 @@ Runs vagrant commands from a Commandfile.
 Add to a `Commandfile` besides your `Vagrantfile`:
 
 ```ruby
-VagrantDevCommands.define 'basic', 'hostname'
+command 'basic', 'hostname'
 
-VagrantDevCommands.define 'with_options',
+command 'with_options',
     box: :my_box,
     desc: 'executes "hostname" on the box "my_box"',
-    command: 'hostname'
+    script: 'hostname'
 ```
 
 
@@ -52,8 +52,8 @@ When using multi-line commands you probably need to define your command using
 a sigil notation like the following:
 
 ```ruby
-VagrantDevCommands.define 'long_running_task',
-    command: %(cd /path/to/somewhere \
+command 'long_running_task',
+    script: %(cd /path/to/somewhere \
                   && echo "starting long running task" \
                   && ./long_running_task.sh \
                   && echo "finished long running task")

data/lib/vagrant/devcommands/command.rb

@@ -6,41 +6,54 @@ module VagrantPlugins
         'runs vagrant commands from a Commandfile'
       end
 
+      def initialize(argv, env)
+        @registry = Registry.new
+
+        super(argv, env)
+      end
+
       def execute
         command     = @argv.last
         commandfile = Commandfile.new(@env)
 
         return display_error('Missing "Commandfile"') unless commandfile.exist?
 
-        commandfile.import
+        @registry.read_commandfile(commandfile)
 
         return display_help unless command
 
-        unless valid_command?(command)
+        unless @registry.valid_command?(command)
           return display_error("Invalid command \"#{command}\"\n")
         end
 
-        run command
+        run @registry.commands[command]
       end
 
       private
 
+      attr_accessor :registry
+
       def display_error(msg)
         puts(msg) && display_help
       end
 
       def display_help
-        Help.display
+        Help.display(@registry)
 
         # return exit code
         127
       end
 
-      def run(name)
-        cmd  = Definer.commands[name]
-        argv = run_argv(cmd)
+      def run(command)
+        argv = run_argv(command)
+
+        with_target_vms(argv, single_target: true) do |vm|
+          env = vm.action(:ssh_run,
+                          ssh_opts: { extra_args: ['-q'] },
+                          ssh_run_command: command[:script])
 
-        run_command(cmd, argv)
+          return env[:ssh_run_exit_status] || 0
+        end
       end
 
       def run_argv(cmd)
@@ -55,20 +68,6 @@ module VagrantPlugins
 
         argv
       end
-
-      def run_command(cmd, argv)
-        with_target_vms(argv, single_target: true) do |vm|
-          env = vm.action(:ssh_run,
-                          ssh_opts: { extra_args: ['-q'] },
-                          ssh_run_command: cmd[:command])
-
-          return env[:ssh_run_exit_status] || 0
-        end
-      end
-
-      def valid_command?(command)
-        Definer.commands.include? command
-      end
     end
   end
 end

data/lib/vagrant/devcommands/commandfile.rb

@@ -14,10 +14,6 @@ module VagrantPlugins
         find_commandfile
       end
 
-      def import
-        load path
-      end
-
       private
 
       attr_accessor :env

data/lib/vagrant/devcommands/definer.rb

@@ -8,8 +8,14 @@ module VagrantPlugins
 
       def self.define(name, options)
         if options.is_a?(String)
-          @commands[name] = { command: options }
+          @commands[name] = { script: options }
         else
+          if options.include?(:command)
+            options[:script] = options[:command]
+
+            options.delete(:command)
+          end
+
           @commands[name] = options
         end
       end

data/lib/vagrant/devcommands/help.rb

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

data/lib/vagrant/devcommands/registry.rb

@@ -0,0 +1,48 @@
+module VagrantPlugins
+  module DevCommands
+    # Vagrant command registry
+    class Registry
+      attr_accessor :commands
+
+      def initialize
+        @commands = {}
+      end
+
+      def read_commandfile(commandfile)
+        contents = commandfile.path.read
+
+        instance_eval(contents)
+        append_legacy
+      end
+
+      def valid_command?(command)
+        @commands.include? 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
+
+        Definer.commands.each do |name, options|
+          next if @commands.include?(name)
+
+          command(name, options)
+        end
+      end
+
+      def command(name, options)
+        if options.is_a?(String)
+          @commands[name] = { script: options }
+        else
+          @commands[name] = options
+        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.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/vagrant/devcommands.rb

@@ -5,6 +5,7 @@ require 'vagrant/devcommands/commandfile'
 require 'vagrant/devcommands/definer'
 require 'vagrant/devcommands/help'
 require 'vagrant/devcommands/plugin'
+require 'vagrant/devcommands/registry'
 require 'vagrant/devcommands/version'
 
 require 'vagrant/devcommands/_proxy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,7 @@ files:
 - lib/vagrant/devcommands/definer.rb
 - lib/vagrant/devcommands/help.rb
 - lib/vagrant/devcommands/plugin.rb
+- lib/vagrant/devcommands/registry.rb
 - lib/vagrant/devcommands/version.rb
 homepage: https://github.com/mneudert/vagrant-devcommands
 licenses: