vagrant-shortcuts 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bebbdbfbf45bfba6019e5b6cf9a28bb478658c1
-  data.tar.gz: f1dd23633ddcaa6c10ece73cbe56566b0199aaf0
+  metadata.gz: 6e94cfdd7ea4c44cfd7229753110286711a8d56d
+  data.tar.gz: bd63397478fadfe26c7063db0967367a3610c932
 SHA512:
-  metadata.gz: ebf2a3927e03b9bee60cb21f96af33f916801559d448c6569faeb9944ee3e7ca0ca4b5533d6d313e93c7b6141516dec9eaa512660660d4306b79aa62fc7bd541
-  data.tar.gz: 6a27c80bfc8db8a78f8fa421c485f85371b3c4b031a48a11039614f2139323b1021c8da6f1711d6d7d9bc9ddca397a54475538756873b5c193fda55aabed1c33
+  metadata.gz: 9c1460c365caa674562192e88114f6d047e6ce597d2c1eb26191d228558625b04671a2a244932524ee358be6283076d32cd0d90a77101ca3fe5d84817674473a
+  data.tar.gz: 0363294843abab4f01b45613d3238480e219bc60b9b9a3f30dcd0a537f5b9db5add022c18c6de6a3a3433c0718f9db4ccb51cfa7aef601c528d92a16c5a8523d

data/README.md

@@ -1,30 +1,81 @@
 # Vagrant::Shortcuts
 
-TODO: Write a gem description
+Add shortcut commands to your Vagrantfile:
+
+```ruby
+config.shortcuts.add(:assets) do |machine|
+  machine.action(:ssh_run, ssh_run_command: <<-cmd)
+    gulp assets
+  cmd
+end
+```
+
+```bash
+$ vagrant do assets
+```
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem:
+
+    $ gem install vagrant-shortcuts
+
+## Usage
+
+### Defining shortcuts
+
+In your `Vagrantfile`, in a `Vagrant.configure` block,
+add any number of shortcuts.
+To define a shortcut called `assets` that precompiles all your frontend assets
+using the Rails asset pipeline, you might do something like:
 
 ```ruby
-gem 'vagrant-shortcuts'
+Vagrant.configure("2") do |config|
+
+  # ...
+
+  config.shortcuts.add(:assets) do |machine|
+    machine.action(:ssh_run, ssh_run_command: <<-cmd)
+      bin/rake assets:precompile
+    cmd
+  end
+end
 ```
 
-And then execute:
+Shortcuts are defined by a name and a ruby function.
+The function must take one argument: a Vagrant machine.
+The function may do anything it wants with this machine,
+but common tasks include SSHing in to the box and running a command.
 
-    $ bundle
+By default, the machine is started before the shortcut is run.
+This may involve fetching a base box and provisioning the machine.
+If you do not want to start the box by default,
+pass `start_machine: false` when adding the shortcut:
 
-Or install it yourself as:
+```ruby
+config.shortcuts.add(:assets, start_machine: False) do |machine|
+  # ...
+end
+```
 
-    $ gem install vagrant-shortcuts
+The machine can be started manually by:
 
-## Usage
+```ruby
+machine.action(:up, {:provision_ignore_sentinel => false})
+```
+
+### Running shortcuts
 
-TODO: Write usage instructions here
+Run a shortcut from the command line using `vagrant do <shortcut>`.
+To run the example `assets` shortcut defined previously, run:
+
+```bash
+$ vagrant do assets
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/vagrant-shortcuts/fork )
+1. Fork it ( <https://bitbucket.org/tim_heap/vagrant-shortcuts/fork> )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/vagrant-shortcuts/version.rb

@@ -1,3 +1,3 @@
 module VagrantShortcuts
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/lib/vagrant-shortcuts.rb

@@ -2,6 +2,20 @@ require "vagrant-shortcuts/version"
 
 module VagrantPlugins
 
+  class Shortcut
+    def initialize(callable, start_machine: true)
+      @callable = callable
+      @start_machine = start_machine
+    end
+
+    def call(machine)
+      if @start_machine
+        machine.action(:up, {:provision_ignore_sentinel => false})
+      end
+      @callable.call(machine)
+    end
+  end
+
   class Shortcuts < Vagrant.plugin("2")
     name "Shortcuts plugin"
 
@@ -31,8 +45,8 @@ module VagrantPlugins
         def initialize
           @shortcuts = {}
         end
-        def add(name, &block)
-          @shortcuts[name] = block
+        def add(name, *args, &block)
+          @shortcuts[name] = Shortcut.new(block, *args)
         end
         def get(name)
           @shortcuts[name]

data/vagrant-shortcuts.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["tim@timheap.me"]
   spec.summary       = "Embed shortcut commands in your Vagrantfile"
   spec.description   = "Embed shortcut commands directly in your Vagrant file"
-  spec.homepage      = ""
+  spec.homepage      = "https://bitbucket.org/tim_heap/vagrant-shortcuts"
   spec.license       = "BSD"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-shortcuts
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Heap
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ files:
 - lib/vagrant-shortcuts.rb
 - lib/vagrant-shortcuts/version.rb
 - vagrant-shortcuts.gemspec
-homepage: ''
+homepage: https://bitbucket.org/tim_heap/vagrant-shortcuts
 licenses:
 - BSD
 metadata: {}