capistrano-passenger 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f8fd2477d085bb6bdc41b2a2eec100fa3a92b2e
-  data.tar.gz: e4cf76f579ecb5d76c50d7da1d260335a1f6550e
+  metadata.gz: de7f72b6bfcdc40bbbd10af5c56e00ba964a56b0
+  data.tar.gz: bc39916c2642aa4126fc48b1df4bc1571391066c
 SHA512:
-  metadata.gz: 948bf4c42d4cf7975a17e92479c1d2f055ecd9310a7cdf18a19d1c68f48d6154ea04ef0f18254983c15997589faaa2254a0c2c12e5df52ba04ff8afec4be2081
-  data.tar.gz: 70b6e897b3e4ca05f2e9e16f5742964e54d5b56ec28f70400bffaca74e4c974aa241310d9c6175a0f5a934179b2fbb9352b577184a597a8fde240ce19d0de5fb
+  metadata.gz: 8d6135fa823c59892880fd81721df36ffde57b6001bb4b583d1cc901bea290bea5b7d3b48421b3a171b699c4f2138d266d4c5f9dd713040d0861ee7540a16af3
+  data.tar.gz: 16559f6fa7ab2e0dea172615dc49b891ede80016051ea936f9b9c4ca267fdf3cbe8691bdb46a7a872b70af4f581be656421374d22d025aea0e8a8d84ffffc0ba

data/CHANGELOG.md

@@ -1,7 +1,24 @@
+# 0.0.5 (12 Apr 2015)
+
+* Bug fixes:
+  * When restarting passenger without sudo, made it nevertheless use command map (@betesh, capistrano/passenger#8)
+  * We now check whether passenger is installed outside of RVM and use the system installation if it is found.  Otherwise, the user can specify which version of RVM passenger was installed with if it is not the default.
+
+* Command map prefixes for rbenv are automatically added now
+
+# 0.0.4 (26 Mar 2015)
+
+* Bug fixes:
+  * rvm:hook task was being called even if it wasn't defined (@betesh, capistrano/passenger#5)
+
+# 0.0.3 (25 Mar 2015)
+
+* Passenger 5 support (@pjkelly, capistrano/passenger#4)
+
 # 0.0.2 (10 Feb 2015)
 
 Bugfixes:
-  * If directory doesn't exist, it's created during task (@powertoaster, #1)
+  * If directory doesn't exist, it's created during task (@powertoaster, capistrano/passenger#1)
 
 # 0.0.1 (7 Aug 2014)
 

data/README.md

@@ -1,51 +1,105 @@
 # Capistrano::Passenger
 
-Adds a task to restart your application after deployment via Capistrano:
-
-   * cap production deploy:restart
+Adds a task to restart your application after deployment via Capistrano. Supports Passenger versions 5 and lower.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-passenger'
+``` ruby
+gem 'capistrano-passenger'
+```
 
 And then execute:
 
-    $ bundle
+``` bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install capistrano-passenger
+``` bash
+$ gem install capistrano-passenger
+```
 
 ## Usage
 
-Adding this line to your `Capfile` will load the default configuration and make the task run after `deploy:publishing`:
+Add this line to your `Capfile` and `deploy:restart` will be setup to automatically run after `:publishing` is complete:
+
+``` ruby
+require 'capistrano/passenger'
+```
+
+You can also run the underlying task in isolation:
+
+``` bash
+# Restart your Passenger application.
+# The restart mechanism used is based on the version of Passenger installed on your server.
+$ cap production passenger:restart
+# Alternatively:
+$ cap production deploy:restart
+```
 
-    require 'capistrano/passenger'
+If you want the task to run at a different point in your deployment, require `capistrano/passenger/no_hook` instead of `capistrano/passenger` and then add your own hook in `config/deploy.rb`.  When using this gem in this way, you must use `passenger:restart`--the `deploy:restart` alias is not available.  Example:
 
-You can also run the task in isolation:
+``` ruby
+# Capfile
+require 'capistrano/passenger/no_hook'
 
-    $ cap production deploy:restart
+# config/deploy.rb
+after :some_other_task, :'passenger:restart'
+```
 
-Configurable options:
+Configurable options and their defaults:
 
-    set :passenger_roles, :app                  # this is default
-    set :passenger_restart_runner, :sequence    # this is default
-    set :passenger_restart_wait, 5              # this is default
-    set :passenger_restart_limit, 2             # this is default
+``` ruby
+set :passenger_roles, :app
+set :passenger_restart_runner, :sequence
+set :passenger_restart_wait, 5
+set :passenger_restart_limit, 2
+set :passenger_restart_with_sudo, false
+set :passenger_environment_variables, {}
+set :passenger_restart_command, 'passenger-config restart-app'
+set :passenger_restart_options, -> { "#{deploy_to} --ignore-app-not-running" }
+```
+
+### Restarting Your Passenger Application
+
+In most cases, the default settings should just work for most people. This plugin checks the version of passenger you're running on your server(s) and invokes the appropriate restart mechanism based on that.
 
 `passenger_restart_wait` and `passenger_restart_limit` are passed to the `on` block when restarting the application:
 
-    on roles(fetch(:passenger_roles)), in: fetch(:passenger_restart_runner), wait: fetch(:passenger_restart_wait), limit: fetch(:passenger_restart_limit) do
-      execute :touch, release_path.join('tmp/restart.txt')
-    end
+``` ruby
+on roles(fetch(:passenger_roles)), in: fetch(:passenger_restart_runner), wait: fetch(:passenger_restart_wait), limit: fetch(:passenger_restart_limit) do
+  with fetch(:passenger_environment_variables) do
+    # Version-specific restart happens here.
+  end
+end
+```
 
 Note that `passenger_restart_limit` has no effect if you are using the default `passenger_restart_runner` of `:sequence`.  sshkit only looks at it when the runner is `:group`.
 
+`:passenger_environment_variables` is available if anything about your environment is not available to the user deploying your application. One use-case for this is when `passenger-config` isn't available in your user's `PATH` on the server. You could override it like so:
+
+``` ruby
+set :passenger_environment_variables, { :path => '/your/path/to/passenger/bin:$PATH' }
+```
+
+### Note for RVM users
+
+https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html#_when_the_system_has_multiple_ruby_interpreters descibes how "Once installed, you can run Phusion Passenger’s Ruby parts under any Ruby interpreter you want, even if that Ruby interpreter was not the one you originally installed Phusion Passenger with. [...] There is however one caveat if you happen to be using RVM or RVM gemsets. When you gem install Phusion Passenger using RVM," it is available only to the Ruby version where it was installed.  Therefore, if you are using RVM **AND** passenger was installed via RVM **AND** it was installed under a different version of RVM than `fetch(:rvm_ruby_version)`, you need to `set :passenger_rvm_ruby_version` in your `config/deploy.rb`.
+
+### Restarting Passenger 5 (and above) Applications
+
+Passenger 5 introduced a new way to restart your application, and thus has some additional configuration options to accomodate for various server environments.
+
+If you need to pass additional/different options to `:passenger_restart_command`, simply override `:passenger_restart_options`.
+
+If you require `sudo` when restarting passenger, set `:passenger_restart_with_sudo` to `true`. **Note**: This option has no effect when restarting Passenger 4 (and lower) applications.
+
 ## Contributing
 
-1. Fork it ( https://github.com/betesh/capistrano-passenger/fork )
+1. Fork it ( https://github.com/capistrano/passenger/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/capistrano/passenger.rb

@@ -1 +1 @@
-load File.expand_path('../tasks/passenger.cap', __FILE__)
+load File.expand_path('../tasks/deploy_passenger.cap', __FILE__)

data/lib/capistrano/passenger/no_hook.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/passenger.cap', __FILE__)

data/lib/capistrano/passenger/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Passenger
-    VERSION = "0.0.2"
+    VERSION = "0.0.5"
   end
 end

data/lib/capistrano/tasks/deploy_passenger.cap

@@ -0,0 +1,9 @@
+load File.expand_path('../passenger.cap', __FILE__)
+
+namespace :deploy do
+  desc 'Restart your Passenger application'
+  task :restart do
+    invoke('passenger:restart')
+  end
+  after :publishing, :restart
+end

data/lib/capistrano/tasks/passenger.cap

@@ -1,19 +1,70 @@
-namespace :deploy do
-  desc 'Restart application'
+namespace :passenger do
+  desc 'Restart your Passenger application'
   task :restart do
     on roles(fetch(:passenger_roles)), in: fetch(:passenger_restart_runner), wait: fetch(:passenger_restart_wait), limit: fetch(:passenger_restart_limit) do
-      execute :mkdir, '-p', release_path.join('tmp')
-      execute :touch, release_path.join('tmp/restart.txt')
+      with fetch(:passenger_environment_variables) do
+        passenger_version = capture(:passenger, '-v').match(/\APhusion Passenger version (.*)$/)[1].to_i
+
+        if passenger_version > 4
+          restart_with_sudo = fetch(:passenger_restart_with_sudo) ? :sudo : nil
+          arguments = [restart_with_sudo, *fetch(:passenger_restart_command).split(" ").collect(&:to_sym), fetch(:passenger_restart_options)].compact
+          execute *arguments
+        else
+          execute :mkdir, '-p', release_path.join('tmp')
+          execute :touch, release_path.join('tmp/restart.txt')
+        end
+      end
+    end
+  end
+
+  namespace :rvm do
+    task :hook do
+      passenger_installed_via_rvm = false
+      on roles(fetch(:passenger_roles)) do
+        passenger_installed_via_rvm = !(test :which, :passenger)
+      end
+      if passenger_installed_via_rvm
+        if fetch(:passenger_rvm_ruby_version) == fetch(:rvm_ruby_version)
+          set :rvm_map_bins, fetch(:rvm_map_bins) + [:passenger, :'passenger-config']
+        else
+          after :'rvm:hook', :'passenger:rvm:after_rvm_path_is_set'
+        end
+      end
+    end
+
+    task :after_rvm_path_is_set do
+      # This is very similar to code in capistrano-rvm.  Ideally, there would be a way to hook into that code instead of duplicating it with only minor changes.
+      passenger_rvm_prefix = "#{fetch(:rvm_path)}/bin/rvm #{fetch(:passenger_rvm_ruby_version)} do"
+      [:passenger, :'passenger-config'].each do |command|
+        SSHKit.config.command_map.prefix[command.to_sym].unshift(passenger_rvm_prefix)
+      end
+    end
+  end
+
+  namespace :rbenv do
+    task :hook do
+      set :rbenv_map_bins, fetch(:rbenv_map_bins) + [:passenger, :'passenger-config']
     end
   end
-  after :publishing, :restart
 end
 
+
 namespace :load do
   task :defaults do
     set :passenger_roles, :app
     set :passenger_restart_runner, :sequence
     set :passenger_restart_wait, 5
     set :passenger_restart_limit, 2
+    set :passenger_restart_with_sudo, false
+    set :passenger_environment_variables, {}
+    set :passenger_restart_command, 'passenger-config restart-app'
+    set :passenger_restart_options, -> { "#{deploy_to} --ignore-app-not-running" }
+    set :passenger_rvm_ruby_version, ->{ fetch(:rvm_ruby_version) }
+    if Rake.application.tasks.collect(&:to_s).include?("rvm:hook")
+      before :'rvm:hook', :'passenger:rvm:hook'
+    end
+    if Rake.application.tasks.collect(&:to_s).include?("rbenv:map_bins")
+      before :'rbenv:map_bins', :'passenger:rbenv:hook'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-passenger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Isaac Betesh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -68,7 +68,9 @@ files:
 - capistrano-passenger.gemspec
 - lib/capistrano-passenger.rb
 - lib/capistrano/passenger.rb
+- lib/capistrano/passenger/no_hook.rb
 - lib/capistrano/passenger/version.rb
+- lib/capistrano/tasks/deploy_passenger.cap
 - lib/capistrano/tasks/passenger.cap
 homepage: https://github.com/capistrano/passenger
 licenses:
@@ -90,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Passenger support for Capistrano 3.x