rvm-capistrano 1.3.0.rc12 → 1.3.0

data/README.md

@@ -1,7 +1,5 @@
 # rvm-capistrano
 
-https://rvm.io/integration/capistrano/#gem
-
 ## Description
 
 RVM / Capistrano Integration Gem
@@ -10,13 +8,16 @@ RVM / Capistrano Integration Gem
 
 RVM / Capistrano integration is available as a separate gem
 
-    $ gem install rvm-capistrano
+```bash
+$ gem install rvm-capistrano
+```
 
 Or, if the **capistrano** gem is aleady in your `Gemfile`, then add **rvm-capistrano**:
 
-    $ echo "gem 'rvm-capistrano'" >> Gemfile
-    $ bundle install
-
+```bash
+$ echo "gem 'rvm-capistrano'" >> Gemfile
+$ bundle install
+```
 
 ## Example
 
@@ -27,23 +28,113 @@ The following code will:
 
 Example:
 
-    set :rvm_ruby_string, ENV['GEM_HOME'].gsub(/.*\//,"")
-    set :rvm_install_ruby_params, '--1.9'      # for jruby/rbx default to 1.9 mode
-    set :rvm_install_pkgs, %w[libyaml openssl] # package list from https://rvm.io/packages
-    set :rvm_install_ruby_params, '--with-opt-dir=/usr/local/rvm/usr' # package support
+```ruby
+set :rvm_ruby_string, :local               # use the same ruby as used locally for deployment
+set :rvm_autolibs_flag, "read-only"        # more info: rvm help autolibs
 
-    before 'deploy:setup', 'rvm:install_rvm'   # install RVM
-    before 'deploy:setup', 'rvm:install_pkgs'  # install RVM packages before Ruby
-    before 'deploy:setup', 'rvm:install_ruby'  # install Ruby and create gemset, or:
-    before 'deploy:setup', 'rvm:create_gemset' # only create gemset
-    before 'deploy:setup', 'rvm:import_gemset' # import gemset from file
+before 'deploy:setup', 'rvm:install_rvm'   # install RVM
+before 'deploy:setup', 'rvm:install_ruby'  # install Ruby and create gemset, OR:
+before 'deploy:setup', 'rvm:create_gemset' # only create gemset
+
+require "rvm/capistrano"
+```
 
-    require "rvm/capistrano"
+### RVM + Ruby on every deploy
 
+Update RVM and make sure Ruby is installed on every deploy:
+
+```ruby
+set :rvm_ruby_string, :local        # use the same ruby as used locally for deployment
+
+before 'deploy', 'rvm:install_rvm'  # update RVM
+before 'deploy', 'rvm:install_ruby' # install Ruby and create gemset (both if missing)
+
+require "rvm/capistrano"
+```
+
+### To use the ruby version currently active locally
+
+```ruby
+set :rvm_ruby_string, :local
+```
 
-## To use the ruby version currently active locally
+### To restrict rvm to only `:app` servers
 
-    set :rvm_ruby_string, :local
+Warning, when using `:rvm_require_role` `parallel` is used to select shell per server instead of `:default_shell`
+
+```ruby
+set :rvm_require_role, :app
+require "rvm/capistrano"
+```
+
+The order is important `:rvm_require_role` has to be `set` before `require "rvm/capistrano"`.
+
+### To restrict rvm to only some servers
+
+```ruby
+set :rvm_require_role, :rvm
+require "rvm/capistrano"
+role :rvm, "web1", "web2"
+role :app, "web1", "web2", "web3"
+```
+
+### To control rvm shell manually
+
+```ruby
+require "rvm/capistrano"
+set :default_shell, :bash
+task :example do
+  run "echo 'in rvm'", :shell => fetch(:rvm_shell)
+end
+```
+
+### Disable rvm shell for single command
+
+```ruby
+task :example do
+  run "echo 'not in rvm'", :shell => :bash
+end
+```
+
+## Options
+
+- `:rvm_ruby_string` - which ruby should be loaded
+ - `release_path` - load ruby defined in `#{release_path}` - Capistrano variable pointing where code is checked out
+ - `local` - detect local machine running ruby using `GEM_HOME`
+ - `<ruby-version>` - specify ruby version to use
+
+- `:rvm_type` - how to detect rvm, default `:user`
+ - `:user` - RVM installed in `$HOME`, user installation (default)
+ - `:system` - RVM installed in `/usr/local`, multiuser installation
+
+- `:rvm_autolibs_flag` - control autolibs, read more `rvm help autolibs`
+ - `:disable` - fully disable autolibs, limit automated tasks
+ - `:read`    - autolibs only in read only mode, do not change anything in system
+ - `:fail`    - autolibs only in read only mode, fail if changes are required
+ - `:enable`  - let RVM install what is needed for ruby, required `set :use_sudo, true`
+
+- `:rvm_path` - force `$rvm_path`, only overwrite if standard paths can not be used
+- `:rvm_bin_path` - force `$rvm_bin_path`, only overwrite if standard paths can not be used
+- `:rvm_gemset_path` - storage for gem lists files for exporting/importing, by default `$rvm_path/gemsets`
+- `:rvm_install_with_sudo` - when set to `true` forces RVM installation with `sudo` even `:use_sudo` is set to `false`
+
+- `:rvm_install_type` - version of RVM to install, by default `stable`
+ - `stable` - stable version of RVM
+ - `head` - head version of RVM (development)
+ - `latest-1.18` - latest version of RVM 1.18.x
+ - `1.18.4` - selected version
+
+- `:rvm_install_shell` - shell to be used for `rvm` operations, by default `bash`, most likely you do not need to change it
+- `:rvm_install_ruby` - a command used to install ruby, by default `install`, most likely you do not need to change it
+- `:rvm_install_ruby_threads` - number of threads to use for ruby compilation, by default it's number of CPU cores on Linux
+- `:rvm_install_ruby_params` - parameters for ruby, example `--patch railsexpress`
+- `:rvm_install_pkgs` - array of packages to install with `cap rvm:install_pkgs`
+- `:rvm_add_to_group` - user name to add to `rvm` group when RVM is installed with `:rvm_type` `:system`, by default it's the user name that runs deploy
+
+- `:rvm_require_role` - allows using RVM for only one role, useful when database is separated, it has to be defined before `require 'rvm/capistrano'`
+ - `:app` - use RVM only on servers defined for role `:app`
+ - `:rvm` - use RVM only on servers defined for role `:rvm` - where not all `:app` servers support RVM
+ - `<role>` - any other role that is defining servers supporting RVM
 
 ## Tasks
 
@@ -56,9 +147,14 @@ cap rvm:install_ruby         # Install RVM ruby to the server, create gemset ...
 cap rvm:install_rvm          # Install RVM of the given choice to the server.
 cap rvm:install_pkgs         # Install RVM packages to the server.
 cap rvm:install_gem   GEM=my_gem  # Install gem {my_gem} on the server using selected ruby.
+                                  # Use `ENV['GEM'] = "bundler"` in script to specify gems.
 cap rvm:uninstall_gem GEM=my_gem  # Uninstall gem {my_gem} from the server selected ruby.
 ```
 
 ## Development
 
-    $ rake spec
+SM Framework extension for gem development:
+
+    $ curl -L https://get.smf.sh | sh
+    $ sm ext install gem mpapis/sm_gem
+    $ sm gem --help

data/lib/rvm/capistrano/version.rb

@@ -1,5 +1,5 @@
 module RVM
   class Capistrano
-    VERSION="1.3.0.rc12"
+    VERSION="1.3.0"
   end
 end

metadata

@@ -1,66 +1,79 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: rvm-capistrano
-version: !ruby/object:Gem::Version
-  version: 1.3.0.rc12
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
-authors:
+authors: 
 - Wayne E. Seguin
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-04-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: capistrano
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
         version: 2.0.0
-- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: RVM / Capistrano Integration Gem
-email:
+email: 
 - wayneeseguin@gmail.com
 - mpapis@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - History.md
 - Manifest.yml
 - README.md
@@ -69,30 +82,39 @@ files:
 - lib/rvm/capistrano.rb
 - lib/rvm/capistrano/version.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: https://rvm.beginrescueend.com/integration/capistrano
-licenses:
+licenses: 
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>'
-    - !ruby/object:Gem::Version
-      version: 1.3.1
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: RVM / Capistrano Integration Gem
-test_files:
+test_files: 
 - spec/spec_helper.rb
-has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 306f784cddc89f763e8d11f4f11e49953b5ea412
-  data.tar.gz: 80429d698c74cc1704fca6a06af1c0a7686322d2
-SHA512:
-  metadata.gz: d99158d6f1627893757adb6723a482fd53a0a6aa0f461f29c6267ad594d36526c4765fad4b2d8b15de7dd1c83c31a252c5a22e8501d705b5fd0ea90f154edf13
-  data.tar.gz: f3b07661ccd6eb38c5d4f9b4f440092d033b5707da417642d0341fb0910aad4c9bae972c9d0709c7cf24cb1b31fa1b1c0b8b4e62d3f3d39aa03959e0ae099b26