vagrant-bundler 0.1.0

data/README.mdown

@@ -0,0 +1,50 @@
+# Vagrant-bundler-tools
+
+This gem is a plugin for vagrant that makes it possible to interact with
+bundled gems on the guest directly from the host.
+
+For example you can open a gem bundled on your linux guest in your OSX host's
+editor.
+
+## Installation
+
+    gem install vagrant-bundler-tools
+
+## Usage
+
+To open a gem bundled on your guest in your host's editor use
+
+    vagrant bundle open <gem_name>
+
+from the host.
+
+## Other commands
+
+You can also use
+
+  - List bundled gems on the host
+
+        vagrant bundle list
+
+  - Show path (on the host) to the named gem bundled on the guest
+
+        vagrant bundle show <gem_name>
+
+## Caveats
+
+You will need to set the bundle path on the guest to be a subdirectory of the
+project so that the host can access it, for example with
+
+    bundle config path .bundled_gems
+
+in the project directory on the guest.
+
+## MIT License
+
+(c) Joel Chippindale 2011
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vagrant_bundler.rb

@@ -0,0 +1,21 @@
+require 'vagrant'
+require 'vagrant_bundler/command/base'
+require 'vagrant_bundler/command/bundle'
+require 'vagrant_bundler/command/bundle_list'
+require 'vagrant_bundler/command/bundle_open'
+require 'vagrant_bundler/command/bundle_show'
+require 'vagrant_bundler/errors'
+
+module VagrantBundler
+
+  # The source root is the path to the root directory of
+  # the VagrantBundler gem.
+  def self.source_root
+    @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+  end
+end
+
+Vagrant.commands.register(:bundle) { VagrantBundler::Command::Bundle }
+
+# # Default I18n to load the en locale
+I18n.load_path << File.expand_path("templates/locales/en.yml", VagrantBundler.source_root)

data/lib/vagrant_bundler/command/base.rb

@@ -0,0 +1,37 @@
+module VagrantBundler
+  module Command
+    class Base < Vagrant::Command::Base
+      protected
+      def locate_gem(gem_name)
+        bundle_show = ssh_execute("cd /vagrant && bundle show #{gem_name}").strip
+
+        if bundle_show.include?('Could not find gem')
+          raise Errors::GemNotFound.new(bundle_show)
+        end
+
+        unless bundle_show.start_with?('/vagrant/')
+          raise Errors::BundlePathOutsideVagrantDirectory.new
+        end
+
+        host_path = bundle_show.gsub(%r{^/vagrant/}, '')
+        File.expand_path(host_path)
+      end
+
+      def ssh_execute(command)
+        output = ''
+        with_target_vms(nil, :single_target => true) do |vm|
+          # Basic checks that are required for proper SSH
+          raise Errors::VMNotCreatedError if !vm.created?
+          raise Errors::VMInaccessible if !vm.state == :inaccessible
+          raise Errors::VMNotRunningError if vm.state != :running
+
+          vm.channel.execute(command, :error_check => false) do |type, data|
+            output << data.to_s
+          end
+        end
+
+        output
+      end
+    end
+  end
+end

data/lib/vagrant_bundler/command/bundle.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+
+module VagrantBundler
+  module Command
+    class Bundle < Base
+      def initialize(argv, env)
+        super
+
+        @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+        @subcommands = Vagrant::Registry.new
+        @subcommands.register(:list)       { VagrantBundler::Command::BundleList }
+        @subcommands.register(:open)       { VagrantBundler::Command::BundleOpen }
+        @subcommands.register(:show)       { VagrantBundler::Command::BundleShow }
+      end
+
+      def execute
+        if @main_args.include?("-h") || @main_args.include?("--help")
+          # Print the help for all the box commands.
+          return help
+        end
+
+        # If we reached this far then we must have a subcommand. If not,
+        # then we also just print the help and exit.
+        command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+        return help if !command_class || !@sub_command
+
+        # Initialize and execute the command class
+        command_class.new(@sub_args, @env).execute
+      end
+
+      # Prints the help out for this command
+      def help
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: vagrant bundle <command> [<args>]"
+          opts.separator ""
+          opts.separator "Available subcommands:"
+
+          # Add the available subcommands as separators in order to print them
+          # out as well.
+          keys = []
+          @subcommands.each { |key, value| keys << key }
+
+          keys.each do |key|
+            opts.separator "     #{key}"
+          end
+        end
+
+        @env.ui.info(opts.help, :prefix => false)
+      end
+    end
+  end
+end

data/lib/vagrant_bundler/command/bundle_list.rb

@@ -0,0 +1,11 @@
+require 'optparse'
+
+module VagrantBundler
+  module Command
+    class BundleList < Base
+      def execute
+        @env.ui.info ssh_execute("cd /vagrant && bundle list")
+      end
+    end
+  end
+end

data/lib/vagrant_bundler/command/bundle_open.rb

@@ -0,0 +1,33 @@
+module VagrantBundler
+  module Command
+    class BundleOpen < Base
+      def execute
+        opts = OptionParser.new do |opts|
+          opts.banner = "Show the path to a bundle gem on the vagrant box"
+          opts.separator ""
+          opts.separator "Usage: vagrant bundle show <gem_name>"
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+
+        return if !argv
+
+        raise Vagrant::Errors::CLIInvalidUsage, :help => opts.help.chomp if argv.length < 1
+
+        # Method largely copied and pasted from from Bundler::CLI#open
+        editor = [ENV['BUNDLER_EDITOR'], ENV['VISUAL'], ENV['EDITOR']].find{|e| !e.nil? && !e.empty? }
+        if editor
+          gem_path = locate_gem(argv[0])
+          Dir.chdir(gem_path) do
+            command = "#{editor} #{gem_path}"
+            success = system(command)
+            @env.ui.info "Could not run '#{command}'" unless success
+          end
+        else
+          @env.ui.info("To open a bundled gem, set $EDITOR or $BUNDLER_EDITOR")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_bundler/command/bundle_show.rb

@@ -0,0 +1,24 @@
+require 'optparse'
+
+module VagrantBundler
+  module Command
+    class BundleShow < Base
+      def execute
+        opts = OptionParser.new do |opts|
+          opts.banner = "Show the path to a bundle gem on the vagrant box"
+          opts.separator ""
+          opts.separator "Usage: vagrant bundle show <gem_name>"
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+
+        return if !argv
+
+        raise Vagrant::Errors::CLIInvalidUsage, :help => opts.help.chomp if argv.length < 1
+
+        @env.ui.info locate_gem(argv[0])
+      end
+    end
+  end
+end

data/lib/vagrant_bundler/errors.rb

@@ -0,0 +1,20 @@
+module VagrantBundler
+  module Errors
+    class BundlePathOutsideVagrantDirectory < Vagrant::Errors::VagrantError
+      error_key(:bundle_path_outside_vagrant_directory, "vagrant_bundler.errors")
+    end
+
+    class GemNotFound < Vagrant::Errors::VagrantError
+      def initialize(message)
+        # We inherit from Vagrant::Errors::VagrantError so that Vagrant
+        # handles this error like other VagrantErrors but we want to skip
+        # VagrantError#initialize to avoid i18n translations, because we are
+        # just passing on the message 'bundle show' returns
+        #
+        # This call effectively calls initialize on VagrantError's superclass
+        # StandardError
+        StandardError.instance_method(:initialize).bind(self).call(message)
+      end
+    end
+  end
+end

data/lib/vagrant_init.rb

@@ -0,0 +1,3 @@
+# This file is automatically loaded by Vagrant. We use this to kick-start
+# our plugin.
+require 'vagrant_bundler'

data/templates/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  vagrant_bundler:
+    errors:
+      bundle_path_outside_vagrant_directory: |-
+        The guest's bundle path must be a subdirectory of /vagrant to be accessible to the host
+
+        Run
+
+            bundle config path .bundled_gems && bundle install
+
+        On the guest to move the bundle to a location the host can access

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-bundler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joel Chippindale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: &70333138871860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70333138871860
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70333138886480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70333138886480
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70333138885220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70333138885220
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70333138882700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70333138882700
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70333138881780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70333138881780
+description: ! 'vagrant-bundler is a vagrant plugin to make it possible to interact
+
+  with the guest''s bundled gems directory from the host.
+
+'
+email: joel@joelchippindale.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.mdown
+files:
+- README.mdown
+- lib/vagrant_bundler.rb
+- lib/vagrant_bundler/command/base.rb
+- lib/vagrant_bundler/command/bundle.rb
+- lib/vagrant_bundler/command/bundle_list.rb
+- lib/vagrant_bundler/command/bundle_open.rb
+- lib/vagrant_bundler/command/bundle_show.rb
+- lib/vagrant_bundler/errors.rb
+- lib/vagrant_init.rb
+- templates/locales/en.yml
+homepage: http://github.com/mocoso/vagrant-bundler
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.mdown
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -147202364419629032
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Vagrant plugin for working with the guest's bundled gems
+test_files: []