capistrano-rvm 0.0.1 → 0.0.2

data/README.md

@@ -1,41 +1,112 @@
-# Capistrano::Rvm
+# Capistrano::RVM
 
-Capistrano tasks to work with RVM
+RVM support for Capistrano 3.x
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-rvm'
+    # Gemfile
+    gem 'capistrano', github: 'capistrano/capistrano', branch: 'v3'
+    gem 'capistrano-rvm', github: "capistrano/rvm"
 
 And then execute:
 
-    $ bundle
+    $ bundle --binstubs
+    $ cap install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install capistrano-rvm
+Require in Capfile to use the default task:
 
-## Usage
+    # Capfile
+    require 'capistrano/rvm'
+
+And you should be good to go!
+
+## Configuration
+
+Set those in the stage file dependant on your server configuration:
+
+    # stage file (staging.rb, production.rb or else)
+    set :rvm_type, :user
+    set :rvm_ruby_version, '2.0.0-p247'
+    set :rvm_custom_path, '~/.myveryownrvm'
+
+### RVM path selection: `:rvm_type`
+
+Valid options are:
+  * `:auto` (default): just tries to find the correct path.
+                       `/usr/local/rvm` wins over `~/.rvm`
+  * `:system`: defines the RVM path to `/usr/local/rvm`
+  * `:user`: defines the RVM path to `~/.rvm`
+  * `:mixed`: defines the RVM path to `/usr/local/rvm` for rvm and `~/.rvm` for wrapped commands
+
+### Ruby and gemset selection: `:rvm_ruby_version`
+
+By default the Ruby and gemset is used which is returned by `rvm current` on
+the target host.
+
+You can omit the ruby patch level from `:rvm_ruby_version` if you want, and
+capistrano will choose the most recent patch level for that version of ruby:
+
+    set :rvm_ruby_version '2.0.0'
+
+If you are using an rvm gemset, just specify it after your ruby_version:
+
+    set :rvm_ruby_version, '2.0.0-p247@mygemset'
+
+or
+
+    set :rvm_ruby_version, '2.0.0@mygemset'
+
+
+### Custom RVM path: `:rvm_custom_path`
+
+If you have a custom RVM setup with a different path then expected, you have
+to define a custom RVM path to tell capistrano where it is.
+
+
+## Restrictions
+
+Capistrano can't (yet) use rvm to install rubies or create gemsets, so on the
+servers you are deploying to, you will have to manually use rvm to install the
+proper ruby and create the gemset.
+
+
+## How it works
+
+This gem adds a new task `rvm:hook` before `deploy:starting`. It uses the `rvm
+wrapper` command to create wrapper scripts for this application that use the
+desired ruby and gemset. These wrapper scripts are then used by capistrano
+when it wants to run `rake`, `gem`, `bundle`, or `ruby`.
+
+
+## Check your configuration
+
+If you want to check your configuration you can use the `rvm:check` task to
+get information about the RVM version and ruby which would be used for
+deployment.
+
+    $ cap production rvm:check
 
-Add this after you define rvm_ruby_string:
 
-    require 'capistrano-rvm'
+## Custom tasks which rely on RVM/Ruby
 
-This gem includes the following tasks:
+When building custom tasks which need a the corrent ruby and gemset, all you
+have to do is run the `rvm:hook` task before your own task. This will create
+the necessary wrappers and handles the execution of the ruby-related commands.
+This is only necessary if your task is *not* *after* the `deploy:starting` task.
 
-    cap rvm                      # Installs rvm, ruby and bundler
-    cap rvm:create_gemset        # Creates the gemset to use
-    cap rvm:default_ruby         # sets as default current ruby version
-    cap rvm:install              # Installs rvm
-    cap rvm:install_bundler      # Install bundler gem
-    cap rvm:install_ruby         # Installs ruby version specified in rvm_ruby_st...
+    before :my_custom_task, 'rvm:hook'
 
+The hook can be called multiple times per `cap` run - it only creates the
+wrappers once.
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/Rakefile

@@ -1,2 +1 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"

data/capistrano-rvm.gemspec

@@ -1,19 +1,20 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/capistrano-rvm/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Edwin Cruz"]
-  gem.email         = ["softr8@gmail.com"]
-  gem.description   = %q{Capistrano tasks to manage rvm commands}
-  gem.summary       = %q{Some tasks to install rvm, ruby and bundler without pain}
-  gem.homepage      = ""
-
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "capistrano-rvm"
+  gem.version       = '0.0.2'
+  gem.authors       = ["Kir Shatrov"]
+  gem.email         = ["shatrov@me.com"]
+  gem.description   = %q{RVM integration for Capistrano}
+  gem.summary       = %q{RVM integration for Capistrano}
+  gem.homepage      = "https://github.com/capistrano/rvm"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.version       = Capistrano::Rvm::VERSION
 
-  gem.add_runtime_dependency "capistrano"
+  gem.add_dependency 'capistrano'
+
 end

data/lib/capistrano-rvm.rb

@@ -1,2 +0,0 @@
-require "capistrano-rvm/capistrano_integration"
-require "capistrano-rvm/version"

data/lib/capistrano/rvm.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/rvm.rake", __FILE__)

data/lib/capistrano/tasks/rvm.rake

@@ -0,0 +1,78 @@
+RVM_SYSTEM_PATH = "/usr/local/rvm"
+RVM_USER_PATH = "~/.rvm"
+
+def bundler_loaded?
+  Gem::Specification::find_all_by_name('capistrano-bundler').any?
+end
+
+SSHKit.config.command_map = Hash.new do |hash, key|
+  if fetch(:rvm_map_bins).include?(key.to_s)
+    hash[key] = "#{fetch(:rvm_bins_path)}/bin/#{fetch(:application)}_#{key}"
+  elsif key.to_s == "rvm"
+    hash[key] = "#{fetch(:rvm_path)}/bin/rvm"
+  else
+    hash[key] = key
+  end
+end
+
+namespace :deploy do
+  after :starting, 'rvm:hook'
+end
+
+namespace :rvm do
+  desc "Runs the RVM hook - use it before any custom tasks if necessary"
+  task :hook do
+    unless fetch(:rvm_hooked)
+      invoke :'rvm:init'
+      invoke :'rvm:create_wrappers'
+      set :rvm_hooked, true
+    end
+  end
+
+  desc "Prints the RVM and Ruby version on the target host"
+  task :check do
+    on roles(:all) do
+      puts capture(:rvm, "version")
+      puts capture(:rvm, "current")
+      puts capture(:ruby, "--version")
+    end
+  end
+  before :check, 'rvm:hook'
+
+  task :init do
+    on roles(:all) do
+      rvm_path = fetch(:rvm_custom_path)
+      rvm_path ||= case fetch(:rvm_type)
+      when :auto
+        if test("[ -d #{RVM_SYSTEM_PATH} ]")
+          RVM_SYSTEM_PATH
+        else
+          RVM_USER_PATH
+        end
+      when :system, :mixed
+        RVM_SYSTEM_PATH
+      else # :user
+        RVM_USER_PATH
+      end
+      set :rvm_path, rvm_path
+      set :rvm_bins_path, fetch(:rvm_type) == :mixed ? RVM_USER_PATH : rvm_path
+
+      rvm_ruby_version = fetch(:rvm_ruby_version)
+      rvm_ruby_version ||= capture(:rvm, "current")
+      set :rvm_ruby_version, rvm_ruby_version
+    end
+  end
+
+  task :create_wrappers do
+    on roles(:all) do
+      execute :rvm, "wrapper #{fetch(:rvm_ruby_version)} #{fetch(:application)} #{fetch(:rvm_map_bins).join(" ")}"
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :rvm_map_bins, bundler_loaded? ? %w{bundle gem rake ruby} : %w{gem rake ruby}
+    set :rvm_type, :auto
+  end
+end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-rvm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
-- Edwin Cruz
+- Kir Shatrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-10 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &2172920960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,24 +21,27 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2172920960
-description: Capistrano tasks to manage rvm commands
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RVM integration for Capistrano
 email:
-- softr8@gmail.com
+- shatrov@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - Gemfile
-- LICENSE
 - README.md
 - Rakefile
 - capistrano-rvm.gemspec
 - lib/capistrano-rvm.rb
-- lib/capistrano-rvm/capistrano_integration.rb
-- lib/capistrano-rvm/version.rb
-homepage: ''
+- lib/capistrano/rvm.rb
+- lib/capistrano/tasks/rvm.rake
+homepage: https://github.com/capistrano/rvm
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -58,8 +61,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Some tasks to install rvm, ruby and bundler without pain
+summary: RVM integration for Capistrano
 test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.idea

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2012 Edwin Cruz
-
-MIT License
-
-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/capistrano-rvm/capistrano_integration.rb

@@ -1,60 +0,0 @@
-require "capistrano"
-require "capistrano/version"
-
-module CapistranoResque
-  class CapistranoIntegration
-    def self.load_into(capistrano_config)
-      capistrano_config.load do
-
-        namespace :rvm do
-
-          set :ruby_version, rvm_ruby_string.split('@').first
-          set :gemset_name, rvm_ruby_string.split('@')[1] || application
-          set :tmp_ruby_string, rvm_ruby_string
-
-          desc "Installs rvm, ruby and bundler"
-          task :default do
-            install
-            install_ruby
-            install_bundler
-            create_gemset
-          end
-
-          desc "Installs rvm"
-          task :install, :except => {:no_release => true} do
-            set :rvm_ruby_string, ''
-            run "RVM=`rvm | grep 'RVM'` ; if [ -z \"$RVM\" ] ; then bash -s stable < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer) ; fi", shell: 'bash -l'
-            set :rvm_ruby_string, tmp_ruby_string
-          end
-
-          desc "installs ruby version specified in rvm_ruby_string"
-          task :install_ruby, :except => {:no_release => true} do
-            set :rvm_ruby_string, ''
-            run "RUBY_INSTALLED=`rvm list | grep '#{ruby_version}'` ; if [ -z \"$RUBY_INSTALLED\" ]; then rvm install #{ruby_version} ; fi"
-            set :rvm_ruby_string, tmp_ruby_string
-          end
-
-          desc "sets as default current ruby version"
-          task :default_ruby, :except => {:no_release => true} do
-            run "rvm --default #{ruby_version}"
-          end
-
-          desc "install bundler gem"
-          task :install_bundler, :except => {:no_release => true} do
-            run "if [ -z \"`gem list | grep bundler`\" ] ; then gem install bundler --no-rdoc --no-ri ; fi "
-          end
-
-          task :create_gemset, :except => {:no_release => true} do
-            set :rvm_ruby_string, ruby_version
-            run "rvm gemset create #{gemset_name}"
-            set :rvm_ruby_string, tmp_ruby_string
-          end
-        end
-      end
-    end
-  end
-end
-
-if Capistrano::Configuration.instance
-  CapistranoResque::CapistranoIntegration.load_into(Capistrano::Configuration.instance)
-end

data/lib/capistrano-rvm/version.rb

@@ -1,5 +0,0 @@
-module Capistrano
-  module Rvm
-    VERSION = "0.0.1"
-  end
-end