vagrant-devcommands 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3de3849c6e3d761ca5b178fdc94bf957632e3b78
-  data.tar.gz: eda7f7046ff1ba3ed1f71d36b90acb595d887b4c
+  metadata.gz: c1835de5d77e36ecc2fdda818fd4b6f682d044b8
+  data.tar.gz: b9edaee5f787c09dd8b4783d5342fb7e55045a0c
 SHA512:
-  metadata.gz: 53997668cf426e5f6536a72bd3013807d4fd7209ee2adb58850d54220c1b6071fbfd2e5d7074c87b3fdfb6b5965c3e7de5bf3ffae52137e96fcf26fd430677f9
-  data.tar.gz: 69a93bfdb2e66e45833d4b9ee2164cb3d334ce0b05e3defa4ac954c3bfe659ee7c2ed78c9545364af53a2bea1e61dae15aaf4c6c9291a3284e7d0a13aa7ac598
+  metadata.gz: 5cc5094fa2638a80ce20390587e42c26b589c02c8744fe112166cd82f2d54f796983866967af80021ad7c97a5b6caa52cc3fc03f62c412f36525ffca99590b6c
+  data.tar.gz: 9323285ba6a94e6339f28c44b539c7cc0eb27698acc28b08ea22671a5c08c8a07230f1de03e3ed41cbd7ce6c2aba3bd8517dc5bb704edd4afa436baaa6942198

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.2.0 (2015-11-02)
+
+- Enhancements
+  - Commandfile is read from the path of the loaded Vagrantfile
+  - Commandfile is looked up case insensitive (`Commandfile` vs `commandfile`)
+  - Descriptions can be set for commands
+
+- Bug fixes
+  - Commandfile can be located outside of current working directory
+
 ## v0.1.0 (2015-10-16)
 
 - Initial Release

data/README.md

@@ -3,24 +3,30 @@
 Runs vagrant commands from a Commandfile.
 
 
-## Command Definition
+## Usage
+
+### Command Definition
 
 Add to a `Commandfile` besides your `Vagrantfile`:
 
 ```ruby
-VagrantDevCommands.define 'with_options', box: :my_box, command: 'hostname'
-VagrantDevCommands.define 'without_otions', 'hostname'
+VagrantDevCommands.define 'basic', 'hostname'
+
+VagrantDevCommands.define 'with_options',
+    box: :my_box,
+    desc: 'executes "hostname" on the box "my_box"',
+    command: 'hostname'
 ```
 
 
-## Command Listing
+### Command Listing
 
 ```shell
 vagrant run
 ```
 
 
-## Command Execution
+### Command Execution
 
 ```shell
 # single-vm environment
@@ -32,6 +38,35 @@ vagrant run your_box your_command
 ```
 
 
+## Notes for Windows Users
+
+### 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
+`ssh.exe` (i.e. from a git installation) manually to your `%PATH%`.
+
+### Command Definition
+
+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 \
+                  && echo "starting long running task" \
+                  && ./long_running_task.sh \
+                  && echo "finished long running task")
+```
+
+Using a quote delimited command definition might otherwise result in not that
+helpful error messages about a bad shell command.
+
+It might also help to double check the line endings in your Commandfile are set
+unix-style (`\n`) and not windows-style (`\r\n`) if you get errors when running
+your commands.
+
+
 ## License
 
 Licensed under the [MIT license](http://opensource.org/licenses/MIT).

data/lib/vagrant/devcommands/command.rb

@@ -7,18 +7,17 @@ module VagrantPlugins
       end
 
       def execute
-        command = @argv.last
+        command     = @argv.last
+        commandfile = Commandfile.new(@env)
 
-        unless File.exist?(command_file_path)
-          return display_error('Missing "Commandfile"')
-        end
+        return display_error('Missing "Commandfile"') unless commandfile.exist?
 
-        import_commands(command_file_path)
+        commandfile.import
 
         return display_help unless command
 
         unless valid_command?(command)
-          return display_error("Invalid command \"#{command}\"")
+          return display_error("Invalid command \"#{command}\"\n")
         end
 
         run command
@@ -26,43 +25,17 @@ module VagrantPlugins
 
       private
 
-      def command_file_path
-        File.join @env.cwd, 'Commandfile'
-      end
-
       def display_error(msg)
-        puts msg
-
-        display_help
+        puts(msg) && display_help
       end
 
       def display_help
-        list_commands
+        Help.display
 
         # return exit code
         127
       end
 
-      def import_commands(command_file)
-        load command_file
-      end
-
-      def list_commands
-        if Definer.commands.empty?
-          puts 'No commands defined!'
-          return
-        end
-
-        puts 'Available commands:'
-
-        Definer.commands.each_key do |name|
-          puts "- #{name}"
-        end
-
-        puts ''
-        puts 'Usage: vagrant run <command>'
-      end
-
       def run(name)
         cmd  = Definer.commands[name]
         argv = run_argv(cmd)

data/lib/vagrant/devcommands/commandfile.rb

@@ -0,0 +1,38 @@
+module VagrantPlugins
+  module DevCommands
+    # Loads and handles the Commandfile
+    class Commandfile
+      def initialize(env)
+        @env = env
+      end
+
+      def exist?
+        nil != find_commandfile
+      end
+
+      def path
+        find_commandfile
+      end
+
+      def import
+        load path
+      end
+
+      private
+
+      attr_accessor :env
+
+      def find_commandfile
+        return nil unless @env.root_path
+
+        %w(Commandfile commandfile).each do |commandfile|
+          current_path = @env.root_path.join(commandfile)
+
+          return current_path if current_path.file?
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/vagrant/devcommands/help.rb

@@ -0,0 +1,40 @@
+module VagrantPlugins
+  module DevCommands
+    # Defines the help output
+    #
+    # Printed when running "vagrant run" without a command
+    class Help
+      def self.display
+        if Definer.commands.empty?
+          puts 'No commands defined!'
+          return
+        end
+
+        display_header
+        display_commands
+      end
+
+      class << self
+        private
+
+        def display_commands
+          pad_to = Definer.commands.keys.map(&:length).max
+
+          Definer.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

data/lib/vagrant/devcommands/plugin.rb

@@ -6,7 +6,6 @@ module VagrantPlugins
       description 'Runs vagrant commands from a Commandfile'
 
       command :run do
-        require_relative 'command'
         Command
       end
     end

data/lib/vagrant/devcommands/version.rb

@@ -1,8 +1,6 @@
 module VagrantPlugins
   # Defines the current plugin version
   module DevCommands
-    # Defines the current plugin version
-
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/vagrant/devcommands.rb

@@ -1,6 +1,9 @@
 require 'vagrant'
 
+require 'vagrant/devcommands/command'
+require 'vagrant/devcommands/commandfile'
 require 'vagrant/devcommands/definer'
+require 'vagrant/devcommands/help'
 require 'vagrant/devcommands/plugin'
 require 'vagrant/devcommands/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-devcommands
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-16 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,28 +80,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.34'
-description: ''
+description: Vagrant plugin to run commands specified in a Commandfile inside one
+  of your vagrant boxes
 email:
 - marc.neudert@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - 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/plugin.rb
 - lib/vagrant/devcommands/version.rb
-- vagrant-devcommands.gemspec
-homepage: ''
+homepage: https://github.com/mneudert/vagrant-devcommands
 licenses:
 - MIT
 metadata:
@@ -108,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Runs vagrant commands from a Commandfile

data/.gitignore

@@ -1,2 +0,0 @@
-/pkg/
-/Gemfile.lock

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.0
-
-before_install:
-  - gem update bundler

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-group :development do
-  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
-end
-
-group :plugins do
-  gemspec
-end

data/Rakefile

@@ -1,26 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-namespace :style do
-  desc 'Run ruby style checks'
-
-  RuboCop::RakeTask.new(:ruby) do |task|
-    task.patterns = [
-      '**/*.rb',
-      '*.gemspec',
-      'Gemfile',
-      'Rakefile'
-    ]
-  end
-end
-
-namespace :test do
-  desc 'Run tests'
-
-  RSpec::Core::RakeTask.new(:unit) do |t|
-    t.pattern = 'test/unit/**/*_spec.rb'
-  end
-end
-
-task default: ['style:ruby', 'test:unit']

data/vagrant-devcommands.gemspec

@@ -1,35 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'vagrant/devcommands/version'
-
-Gem::Specification.new do |spec|
-  spec.name     = 'vagrant-devcommands'
-  spec.version  = VagrantPlugins::DevCommands::VERSION
-  spec.platform = Gem::Platform::RUBY
-  spec.authors  = ['Marc Neudert']
-  spec.email    = ['marc.neudert@gmail.com']
-
-  spec.summary     = 'Runs vagrant commands from a Commandfile'
-  spec.description = ''
-  spec.homepage    = ''
-  spec.license     = 'MIT'
-
-  spec.files = `git ls-files -z`.split("\x0").reject { |f|
-    f.match(%r{^(test|spec|features)/})
-  }
-
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  end
-
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'rubocop', '~> 0.34'
-end