simple-capistrano-unicorn 0.0.3

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## v 0.0.3: Better documentation.
+
+Added better (correct!) documentation, and added possibility to use a different unicorn.stderr.log
+
+## v 0.0.2: Initial release.
+
+Added better Capistrano bindings
+
+## v 0.0.1: Initial release.
+
+:)

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-unicorn-methods.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+# Simple Capistrano Unicorn
+
+Contains a namespace with methods for administrating the unicorn server through capistrano recipes.
+
+## Setup
+
+### 1. Require this gem in deploy.rb
+
+You should add this line in the bottom of `RAILS_ROOT/config/deploy.rb`:
+
+```
+require 'simple-capistrano-unicorn'
+```
+
+### 2. Restart Unicorn on deploy
+
+You should place this line in `RAILS_ROOT/config/deploy.rb`:
+
+```
+after :deploy, "unicorn:restart"
+```
+
+### 3. Extra step only for multi-stage setup
+
+Make sure that you are using the multi-stage extension for Capistrano ( https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension )
+
+You should create different Unicorn files to use for each of your environments. The most common setup is to place the Unicorn files in `RAILS_ROOT/config/unicorn/{staging|beta|production}.rb`.
+
+You can then override the `unicorn_config`-variable that this gem is listening for, by placing this in `RAILS_ROOT/config/deploy.rb`:
+
+```
+set(:unicorn_config) { "#{fetch(:current_path)}/config/unicorn/#{fetch(:stage)}.rb" }
+```
+
+## Usage
+
+Go through the setup and run: `cap deploy` or `cap production deploy` (for multistage)
+
+The gem gives you access to the following methods within the `unicorn.<method>` namespace.
+
+* `unicorn.start` starts the Unicorn processes
+* `unicorn.stop` stops the Unicorn processes
+* `unicorn.restart` makes a seamless zero-downtime restart
+* `unicorn.hard_restart` basically runs `unicorn.stop` followed with a `unicorn.start` 
+* `unicorn.log` prints out from the Unicorn log in `tail -f`-like fashion
+* `unicorn.cleanup` removes the old running Unicorn master
+
+## Requirements
+
+* `unicorn`
+* `capistrano`
+
+## Customization
+
+You can customize the gems behavior by setting any (or all) of the following options within capistrano's configuration:
+
+* `unicorn_pid` indicates the path for the pid file. Defaults to `"#{shared_path}/pids/unicorn.pid"`.
+* `unicorn_old_pid` indicates the path for the old pid file, which Unicorn creates when forking a new master. Defaults to `#{shared_path}/pids/unicorn.pid.oldbin`.
+* `unicorn_config` the path to the unicorn config file. Defaults to `"#{current_path}/config/unicorn.rb"`.
+* `unicorn_socket` indicates the place that Unicorn should place its socket file. Defaults to `"#{shared_path}/system/unicorn.sock"`.
+* `unicorn_log` the path where unicorn places its STDERR-log. Defaults to `"#{shared_path}/log/unicorn.stderr.log"`.
+* `unicorn_port` defines the port that unicorn should listen on. Defaults to `"3000"`.
+* `use_bundler` defines whether Unicorn should start with `bundle exec` or not. Default to `true`.
+* `rails_env` sets the environment that the server will run in. Defaults to `"production"`.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+require 'bundler/gem_tasks'

data/lib/simple-capistrano-unicorn/namespace.rb

@@ -0,0 +1,137 @@
+require 'capistrano'
+require 'capistrano/version'
+
+module SimpleCapistranoUnicorn
+  class CapistranoIntegration
+    def self.load_into(capistrano_config)
+      capistrano_config.load do
+        # Defaulting these variables, because they could end up not being defined in deploy.rb.
+        _cset(:unicorn_pid)     { "#{shared_path}/pids/unicorn.pid" }
+        _cset(:unicorn_old_pid) { "#{shared_path}/pids/unicorn.pid.oldbin" }
+        _cset(:unicorn_config)  { "#{current_path}/config/unicorn.rb" }
+        _cset(:unicorn_socket)  { "#{shared_path}/system/unicorn.sock" }
+        _cset(:unicorn_log)     { "#{shared_path}/log/unicorn.stderr.log" }
+        _cset(:unicorn_port)    { '3000' }
+        _cset(:use_bundler)     { true }
+        _cset(:rails_env)       { "production" }
+
+        def process_running?(server, pidfile)
+          cmd = "if [ -e #{unicorn_pid} ]; then ps cax | grep `cat #{pidfile}` > /dev/null; if [ $? -eq 0 ]; then echo -n running; fi; fi"
+          'running' == capture(cmd, :hosts => [server])
+        end
+
+        # Command to check if Unicorn is running.
+        #
+        def unicorn_is_running?(server)
+          process_running?(server, unicorn_pid)
+        end
+
+        # Command to check if old Unicorn is running.
+        #
+        def old_unicorn_is_running?(server)
+          process_running?(server, unicorn_old_pid)
+        end
+
+        def nice_output(output, server = nil)
+          "#{server.to_s.ljust(20) if server} #{output}"
+        end
+
+        def start_unicorn(server)
+          run "cd #{current_path}; #{'bundle exec' if use_bundler} unicorn -c #{unicorn_config} -E #{rails_env}#{" -p #{unicorn_port}" if unicorn_port} -D", :hosts => [server]
+        end
+
+        def clean_old_unicorn(server)
+          if old_unicorn_is_running?(server)
+            run "kill -s QUIT `cat #{unicorn_old_pid}`", :hosts => [server]
+            run "if [ -e #{unicorn_pid} ]; then rm #{unicorn_old_pid}; fi", :hosts => [server]
+            logger.info nice_output("Cleaned up old Unicorn", server)
+          end
+        end
+
+        namespace :unicorn do
+          # Starts the unicorn process(es)
+          #
+          desc "Starts unicorn"
+          task :start, :roles => :app do            
+            find_servers(:roles => :app).each do |server|
+              clean_old_unicorn(server)
+
+              if unicorn_is_running?(server)
+                logger.info("Unicorn already running on #{server}")
+              else
+                # Unicorn is not running, remove the pid-file if it exists
+                run "if [ -e #{unicorn_pid} ]; then rm #{unicorn_pid}; fi", :hosts => [server]
+                start_unicorn(server)
+                logger.info nice_output("Started Unicorn!", server)
+              end
+            end
+          end
+
+          # This will quit the unicorn process(es).
+          #
+          desc "Stop unicorn"
+          task :stop, :roles => :app do
+            find_servers(:roles => :app).each do |server|
+              if unicorn_is_running?(server)
+                run "kill -s QUIT `cat #{unicorn_pid}`", :hosts => [server]
+                run "rm #{unicorn_pid}", :hosts => [server]
+                logger.info nice_output("Stopped Unicorn!", server)
+              else
+                logger.info nice_output("Unicorn _not_ running, nothing to stop!", server)
+              end
+            end
+          end
+
+          # Restarts the unicorn process(es) with the URS2 code, to gracefully
+          # create a new server, and kill of the old one, leaving *no* downtime.
+          #
+          desc "Zero-downtime restart of Unicorn"
+          task :restart do
+            find_servers(:roles => :app).each do |server|
+              if unicorn_is_running?(server)
+                pid = capture "cat #{unicorn_pid}", :hosts => [server]
+                run "kill -s USR2 #{pid.to_i}", :hosts => [server] if pid.to_i > 0
+                sleep(1)
+                clean_old_unicorn(server)
+                logger.info nice_output("Restarted Unicorn!", server)
+              else
+                start_unicorn(server)
+                logger.info nice_output("Unicorn wasn't running, starting it!", server)
+              end
+            end
+          end
+
+          desc "Restart of Unicorn with downtime"
+          task :hard_restart do
+            unicorn.stop
+            sleep(1)
+            unicorn.start
+          end
+
+          # Displays the unicorn log.
+          #
+          desc "Displays the unicorn log"
+          task :log, :roles => :app do
+            run "tail -f #{shared_path}/log/unicorn.stderr.log" do |channel,stream,data|
+              logger.info nice_output(data, channel[:host])
+            end
+          end
+
+          # This will clean up any old unicorn servers left behind by the USR2 kill
+          # command.
+          #
+          desc "Cleans up the old unicorn processes"
+          task :cleanup, :roles => :app do
+            find_servers(:roles => :app).each do |server|
+              clean_old_unicorn(server)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  SimpleCapistranoUnicorn::CapistranoIntegration.load_into(Capistrano::Configuration.instance)
+end

data/lib/simple-capistrano-unicorn/version.rb

@@ -0,0 +1,7 @@
+module Capistrano
+  module Unicorn
+    module Methods
+      VERSION = "0.0.3"
+    end
+  end
+end

data/lib/simple-capistrano-unicorn.rb

@@ -0,0 +1,2 @@
+require "simple-capistrano-unicorn/version"
+require "simple-capistrano-unicorn/namespace"

data/simple-capistrano-unicorn.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple-capistrano-unicorn/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "simple-capistrano-unicorn"
+  gem.version     = Capistrano::Unicorn::Methods::VERSION
+  gem.authors     = ["Kasper Grubbe"]
+  gem.email       = ["kaspergrubbe@gmail.com"]
+  gem.homepage    = "http://kaspergrubbe.dk"
+  gem.summary     = %q{Contains a collection of simple tasks to manage Unicorn with Capistrano.}
+  gem.description = %q{Contains a collection of simple tasks to manage Unicorn with Capistrano.}
+
+  gem.rubyforge_project = "simple-capistrano-unicorn"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+
+  gem.add_runtime_dependency "unicorn"
+  gem.add_runtime_dependency 'capistrano'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: simple-capistrano-unicorn
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Kasper Grubbe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: unicorn
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Contains a collection of simple tasks to manage Unicorn with Capistrano.
+email: 
+- kaspergrubbe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/simple-capistrano-unicorn.rb
+- lib/simple-capistrano-unicorn/namespace.rb
+- lib/simple-capistrano-unicorn/version.rb
+- simple-capistrano-unicorn.gemspec
+homepage: http://kaspergrubbe.dk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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: simple-capistrano-unicorn
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Contains a collection of simple tasks to manage Unicorn with Capistrano.
+test_files: []
+