prey-capistrano-unicorn 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Capistrano3 Unicorn Changelog
+
+## `0.1.1`
+
+- Removed default value for `:unicorn_bundle_gemfile` of `:bundle_gemfile` so that current_path is the default
+
+## `0.1.0`
+
+- Changed default location of `:unicorn_pid`
+- Depend on capistrano => 3.1.0
+- Added `:unicorn_bundle_gemfile` to override `:bundle_gemfile`
+- Bugfix; use current_path vs release_path
+
+Thanks to @eLod, @mbrictson, and @complistic-gaff
+
+## `0.0.6`
+
+- Buxfix; unicorn -E should be passed a RACK_ENV (not a RAILS_ENV). [More here](http://www.hezmatt.org/~mpalmer/blog/2013/10/13/rack_env-its-not-for-you)
+
+## `0.0.5`
+
+- Added `:unicorn_options`
+
+## `0.0.4`
+
+- Added `:unicorn_roles`

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew Lineen
+
+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/README.md

@@ -0,0 +1,87 @@
+# Capistrano3 Unicorn
+
+This is a capistrano v3 plugin that integrates Unicorn tasks into capistrano deployment scripts; it was heavily inspired by [sosedoff/capistrano-unicorn](https://github.com/sosedoff/capistrano-unicorn) but written from scratch to use the capistrano 3 syntax.
+
+### Gotchas
+
+- The `unicorn:start` task invokes unicorn as `bundle exec unicorn`.
+
+- When running tasks not during a full deployment, you may need to run the `rvm:hook`:
+
+    `cap production rvm:hook unicorn:start`
+
+### Conventions
+
+You can override the defaults by `set :unicorn_example, value` in the `config/deploy.rb` or `config/deploy/ENVIRONMENT.rb` capistrano deployment files
+
+- `:unicorn_pid`
+
+    Assumes your pid file will be located in `tmp/pids/unicorn.pid` which is symlinked by `:linked_dirs` to survive across deployments
+
+    *NOTE: THIS PATH WAS CHANGED AS OF v0.1.0*
+
+- `:unicorn_config_path`
+
+    Assumes that your Unicorn configuration will be located in `config/unicorn/RAILS_ENV.rb`
+
+- `:unicorn_restart_sleep_time`
+
+    When performing zero-downtime deployment via the `unicorn:restart` task, send the USR2 signal, sleep for this many seconds (defaults to 3), then send the QUIT signal
+
+- `:unicorn_roles`
+
+    Roles to run unicorn commands on. Defaults to :app
+
+- `:unicorn_options`
+
+    Set any additional options to be passed to unicorn on startup. Defaults to none
+
+- `:unicorn_rack_env`
+
+    Set the RACK_ENV. Defaults to deployment unless the RAILS_ENV is development. Valid options are "development", "deployment", or "none". See the [RACK ENVIRONMENT](http://unicorn.bogomips.org/unicorn_1.html) section of the unicorn documentation for more information.
+
+- `:unicorn_bundle_gemfile`
+
+    Sets the BUNDLE_GEMFILE so that unicorn will point at the new Gemfile after unicorn:restart. Defaults to `current/Gemfile`.
+
+### Setup
+
+Add the library to your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'capistrano3-unicorn'
+end
+```
+
+Add the library to your `Capfile`:
+
+```ruby
+require 'capistrano3/unicorn'
+```
+
+Invoke Unicorn from your `config/deploy.rb` or `config/deploy/ENVIRONMENT.rb`:
+
+If `preload_app:true` use:
+
+```ruby
+after 'deploy:publishing', 'deploy:restart'
+namespace :deploy do
+  task :restart do
+    invoke 'unicorn:restart'
+  end
+end
+```
+
+Otherwise use:
+
+```ruby
+after 'deploy:publishing', 'deploy:restart'
+namespace :deploy do
+  task :restart do
+    invoke 'unicorn:reload'
+  end
+end
+```
+
+Note that presently you must put the `invoke` outside any `on` block since the task handles this for you; otherwise you will get an `undefined method 'verbosity'` error.

data/capistrano3-unicorn.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "prey-capistrano-unicorn"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Boris Quiroz"]
+  gem.email         = ["boris@forkhq.com"]
+  gem.description   = "Unicorn specific Capistrano tasks - forked from Matthew Lineen's gem"
+  gem.summary       = "Unicorn specific Capistrano tasks - forked from Matthew Lineen's gem"
+  gem.homepage      = "https://github.com/tablexi/capistrano3-unicorn"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '>= 3.1.0'
+end

data/lib/capistrano3/tasks/unicorn.rake

@@ -0,0 +1,101 @@
+namespace :load do
+  task :defaults do
+    set :unicorn_pid, -> { File.join(current_path, "tmp", "pids", "unicorn.pid") }
+    set :unicorn_config_path, -> { File.join(current_path, "config", "unicorn", "#{fetch(:rails_env)}.rb") }
+    set :unicorn_restart_sleep_time, 3
+    set :unicorn_roles, -> { :app }
+    set :unicorn_options, -> { "" }
+    set :unicorn_rack_env, -> { fetch(:rails_env) == "development" ? "development" : "deployment" }
+    set :unicorn_bundle_gemfile, -> { File.join(current_path, "Gemfile") }
+  end
+end
+
+namespace :unicorn do
+  desc "Start Unicorn"
+  task :start do
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        if test("[ -e #{fetch(:unicorn_pid)} ] && kill -0 #{pid}")
+          info "unicorn is running..."
+        else
+          with rails_env: fetch(:rails_env), bundle_gemfile: fetch(:unicorn_bundle_gemfile) do
+            execute :bundle, "exec unicorn", "-c", fetch(:unicorn_config_path), "-E", fetch(:rails_env), "-D", fetch(:unicorn_options)
+          end
+        end
+      end
+    end
+  end
+
+  desc "Stop Unicorn (QUIT)"
+  task :stop do
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        if test("[ -e #{fetch(:unicorn_pid)} ]")
+          if test("kill -0 #{pid}")
+            info "stopping unicorn..."
+            execute :kill, "-s QUIT", pid
+          else
+            info "cleaning up dead unicorn pid..."
+            execute :rm, fetch(:unicorn_pid)
+          end
+        else
+          info "unicorn is not running..."
+        end
+      end
+    end
+  end
+
+  desc "Reload Unicorn (HUP); use this when preload_app: false"
+  task :reload do
+    invoke "unicorn:start"
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        info "reloading..."
+        execute :kill, "-s HUP", pid
+      end
+    end
+  end
+
+  desc "Restart Unicorn (USR2 + QUIT); use this when preload_app: true"
+  task :restart do
+    invoke "unicorn:start"
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        info "unicorn restarting..."
+        execute :kill, "-s USR2", pid
+        execute :sleep, fetch(:unicorn_restart_sleep_time)
+        if test("[ -e #{fetch(:unicorn_pid)}.oldbin ]")
+          execute :kill, "-s QUIT", pid_oldbin
+        end
+      end
+    end
+  end
+
+  desc "Add a worker (TTIN)"
+  task :add_worker do
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        info "adding worker"
+        execute :kill, "-s TTIN", pid
+      end
+    end
+  end
+
+  desc "Remove a worker (TTOU)"
+  task :remove_worker do
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        info "removing worker"
+        execute :kill, "-s TTOU", pid
+      end
+    end
+  end
+end
+
+def pid
+  "`cat #{fetch(:unicorn_pid)}`"
+end
+
+def pid_oldbin
+  "`cat #{fetch(:unicorn_pid)}.oldbin`"
+end

data/lib/capistrano3/unicorn.rb

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: prey-capistrano-unicorn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Boris Quiroz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Unicorn specific Capistrano tasks - forked from Matthew Lineen's gem
+email:
+- boris@forkhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- capistrano3-unicorn.gemspec
+- lib/capistrano3-unicorn.rb
+- lib/capistrano3/tasks/unicorn.rake
+- lib/capistrano3/unicorn.rb
+homepage: https://github.com/tablexi/capistrano3-unicorn
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Unicorn specific Capistrano tasks - forked from Matthew Lineen's gem
+test_files: []