capistrano-fanfare 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby
+  - 1.9.2
+  - ruby-head
+  - 1.8.7
+  - rbx-18mode
+  - ree

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-fanfare.gemspec
+gemspec
+
+group :test do
+  gem 'rake', '~> 0.9'
+  gem 'foreman'
+end
+
+platforms :jruby do
+  gem 'jruby-openssl'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fletcher Nichol
+
+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,29 @@
+# Capistrano::Fanfare [![Build Status](https://secure.travis-ci.org/fnichol/capistrano-fanfare.png)](http://travis-ci.org/fnichol/capistrano-fanfare)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-fanfare'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-fanfare
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => 'test'

data/capistrano-fanfare.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano/fanfare/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Fletcher Nichol"]
+  gem.email         = ["fnichol@nichol.ca"]
+  gem.description   = %q{Capistrano recipes (with full test suite) for fanfare application deployment framework}
+  gem.summary       = %q{Capistrano recipes (with full test suite) for fanfare application deployment framework}
+  gem.homepage      = "https://github.com/fnichol/capistrano-fanfare"
+
+  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-fanfare"
+  gem.require_paths = ["lib"]
+  gem.version       = Capistrano::Fanfare::VERSION
+
+  gem.add_dependency "capistrano", "2.10.0.pre"
+  gem.add_dependency "capistrano_colors", "~> 0.5"
+
+  gem.add_development_dependency "minitest", "~> 2.10.0"
+  gem.add_development_dependency "minitest-capistrano", "~> 0.0"
+  gem.add_development_dependency "timecop", "~> 0.3"
+end

data/lib/capistrano/fanfare/bundler.rb

@@ -0,0 +1,84 @@
+require 'capistrano'
+
+module Capistrano::Fanfare::Bundler
+  def self.load_into(configuration)
+    configuration.load do
+      set :bundle_cmd,      "bundle"
+      set :bundle_shebang,  "ruby-local-exec"
+
+      set(:default_environment) {
+        { 'PATH' => "#{current_path}/bin:$PATH" }
+      }
+
+      set(:bundle_flags) do
+        flags = "--deployment"
+        flags << " --quiet" unless ENV['VERBOSE']
+        flags << " --binstubs"
+        flags << " --shebang #{bundle_shebang}"
+        flags
+      end
+
+      set(:bundle_without) do
+        without = [:development, :test]
+        if exists?(:os_type) && exists?(:os_types)
+          without += (fetch(:os_types) - Array(fetch(:os_type)))
+        end
+        without
+      end
+
+      set :bundle_binstub_template do
+        <<-BINSTUB.gsub(/^ {10}/, '')
+          #!/usr/bin/env #{bundle_shebang}
+          #
+          # This file was generated by capistrano.
+          #
+
+          require 'pathname'
+          ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+            Pathname.new(__FILE__).realpath)
+
+          require 'rubygems'
+
+          load Gem.bin_path('bundler', 'bundle')
+        BINSTUB
+      end
+
+      require 'bundler/capistrano'
+
+      set(:rake) { "rake" }
+
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps.
+      # You can have cap give you a summary of them with `cap -T'.
+      # =========================================================================
+
+      namespace :bundle do
+        desc <<-DESC
+          [internal] Creates a binstub script for the bundle command.
+        DESC
+        task :create_binstub_script, :roles => :app, :except => { :no_release => true } do
+          run "mkdir -p #{shared_path}/bin"
+          put bundle_binstub_template, "#{shared_path}/bin/bundle", { :mode => "0755" }
+        end
+
+        desc <<-DESC
+          [internal] Copies bin/bundle from shared_path into current_path.
+        DESC
+        task :cp_bundle_binstub, :roles => :app, :except => { :no_release => true } do
+          run [
+            "mkdir -p #{current_path}/bin",
+            "cp #{shared_path}/bin/bundle #{current_path}/bin/bundle",
+            "chmod 0755 #{current_path}/bin/bundle"
+          ].join(" && ")
+        end
+      end
+
+      after "deploy:setup", "bundle:create_binstub_script"
+      before "deploy:finalize_update", "bundle:cp_bundle_binstub"
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Bundler.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/fanfare/defaults.rb

@@ -0,0 +1,66 @@
+require 'capistrano'
+
+module Capistrano::Fanfare::Defaults
+  def self.load_into(configuration)
+    configuration.load do
+      set :scm,         :git
+      set :use_sudo,    false
+      set :user,        "deploy"
+      set :rake,        "bundle exec rake"
+      set(:branch)      { ENV['BRANCH'] ? ENV['BRANCH'] : "master" }
+      set(:deploy_to)   { "/srv/#{application}_#{deploy_env}" }
+      set :ssh_options, { :forward_agent => true }
+      set :os_types,    [:darwin, :linux, :sunos]
+      set(:os_type)     { capture("uname -s").chomp.downcase.to_sym }
+
+      set :shared_children, %w{public/system log tmp/pids tmp/sockets tmp/sessions}
+
+      default_run_options[:pty] = true
+
+      ##
+      # Determines deployment environment or run mode to help database naming,
+      # deploy directories, etc.
+      #
+      # Thanks to capistrano-recipies for the great idea:
+      # https://github.com/webficient/capistrano-recipes
+      set(:deploy_env)  {
+        if exists?(:stage)
+          stage
+        elsif exists?(:rails_env)
+          rails_env
+        elsif ENV['RAILS_ENV']
+          ENV['RAILS_ENV']
+        elsif exists?(:rack_env)
+          rack_env
+        elsif ENV['RACK_ENV']
+          ENV['RACK_ENV']
+        else
+          "production"
+        end
+      }
+
+      namespace :deploy do
+        desc <<-DESC
+          Deploys and starts a `cold' application. This is useful if you have not \
+          deployed your application before, or if your application is (for some \
+          other reason) not currently running. It will deploy the code, run any \
+          pending migrations, and then instead of invoking `deploy:restart', it \
+          will invoke `deploy:start' to fire up the application servers.
+
+          [NOTE] This overides the capistrano default by calling the "db:seed" \
+          task, if it is defined.
+        DESC
+        task :cold do
+          update
+          migrate
+          db.seed if respond_to?(:db) && db.respond_to?(:seed)
+          start
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Defaults.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/fanfare/foreman/strategy/base.rb

@@ -0,0 +1,54 @@
+module Capistrano
+  module Fanfare
+    module Foreman
+      module Strategy
+
+        ##
+        # This class defines the abstract interface for all Capistrano
+        # foreman deployment strategies. Subclasses must implement at least the
+        # #export, #start, and #stop methods.
+
+        class Base
+          attr_reader :configuration
+
+          def initialize(config = {})
+            @configuration = config
+          end
+
+          def export
+            raise NotImplementedError, "`export' is not implemented by #{self.class.name}"
+          end
+
+          def start(proc_group = nil)
+            raise NotImplementedError, "`start' is not implemented by #{self.class.name}"
+          end
+
+          def stop(proc_group = nil)
+            raise NotImplementedError, "`stop' is not implemented by #{self.class.name}"
+          end
+
+          def register
+            # no-op
+          end
+
+          def restart(proc_group = nil)
+            stop(proc_group)
+            start(proc_group)
+          end
+
+          protected
+
+          # This is to allow helper methods like "run" and "put" to be more
+          # easily accessible to strategy implementations.
+          def method_missing(sym, *args, &block)
+            if configuration.respond_to?(sym)
+              configuration.send(sym, *args, &block)
+            else
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/fanfare/foreman/strategy/runit.rb

@@ -0,0 +1,63 @@
+require 'capistrano/fanfare/foreman/strategy/base'
+
+module Capistrano
+  module Fanfare
+    module Foreman
+      module Strategy
+        class Runit < Base
+          def export
+            run [
+              "cd #{configuration[:current_release]} &&",
+              "if [ -f Procfile ] ; then",
+              "mkdir -p #{configuration[:runit_sv_path]} &&",
+              "#{configuration[:foreman_cmd]} export runit",
+              "#{configuration[:runit_sv_path]}",
+              "--app=#{configuration[:runit_app_name]}",
+              "--log=#{configuration[:shared_path]}/log",
+              "--user=#{configuration[:user]} &&",
+              "find #{configuration[:runit_sv_path]} -type f -name run",
+              "-exec chmod 755 {} \\; ; else",
+              "echo '>>>> A Procfile must exist in this project.' && exit 10 ;",
+              "fi"
+            ].join(' ')
+          end
+
+          def register
+            run [
+              "ln -snf #{configuration[:runit_sv_path]}/*",
+              "#{configuration[:runit_service_path]}/"
+            ].join(' ')
+          end
+
+          def start(proc_group = nil)
+            run [
+              "sv start #{configuration[:runit_service_path]}/",
+              "#{configuration[:runit_app_name]}-*"
+            ].join
+          end
+
+          def stop(proc_group = nil)
+            run [
+              "sv stop #{configuration[:runit_service_path]}/",
+              "#{configuration[:runit_app_name]}-*"
+            ].join
+          end
+
+          def restart(proc_group = nil)
+            run [
+              "sv restart #{configuration[:runit_service_path]}/",
+              "#{configuration[:runit_app_name]}-*"
+            ].join
+          end
+
+          def ps
+            run [
+              "sv status #{configuration[:runit_service_path]}/",
+              "#{configuration[:runit_app_name]}-*"
+            ].join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/fanfare/foreman/strategy.rb

@@ -0,0 +1,21 @@
+module Capistrano
+  module Fanfare
+    module Foreman
+      module Strategy
+        def self.new(strategy, config={})
+          strategy_file = "capistrano/fanfare/foreman/strategy/#{strategy}"
+          require(strategy_file)
+
+          strategy_const = strategy.to_s.capitalize.gsub(/_(.)/) { $1.upcase }
+          if const_defined?(strategy_const)
+            const_get(strategy_const).new(config)
+          else
+            raise Capistrano::Error, "could not find `#{name}::#{strategy_const}' in `#{strategy_file}'"
+          end
+        rescue LoadError
+          raise Capistrano::Error, "could not find any strategy named `#{strategy}'"
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/fanfare/foreman.rb

@@ -0,0 +1,155 @@
+require 'capistrano'
+require 'capistrano/fanfare/foreman/strategy'
+
+begin
+  require 'foreman/procfile'
+
+rescue LoadError => error
+  raise "Foreman gem could not be loaded: (#{error.message}). " +
+    "Please ensure it is in your Gemfile."
+end
+
+module Capistrano::Fanfare::Foreman
+  def self.load_into(configuration)
+    configuration.load do
+      set(:local_procfile)      { ENV['PROCFILE'] || "Procfile" }
+      set(:user_home)           { capture("echo $HOME").chomp }
+
+      set :foreman_cmd,         "foreman"
+      set :foreman_export_via,  :runit
+
+      set(:foreman_strategy) do
+        Capistrano::Fanfare::Foreman::Strategy.new(foreman_export_via, self)
+      end
+
+      set(:runit_app_name)      { "#{application}_#{deploy_env}" }
+      set(:runit_sv_path)       { "#{shared_path}/sv" }
+      set(:runit_service_path)  { "#{user_home}/service" }
+
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps.
+      # You can have cap give you a summary of them with `cap -T'.
+      # =========================================================================
+
+      namespace :foreman do
+        desc <<-DESC
+          [internal] Copies env from shared path into current_path as .env
+        DESC
+        task :cp_env, :roles => :app, :except => { :no_release => true } do
+          run "cp #{shared_path}/env #{current_release}/.env"
+        end
+
+        desc <<-DESC
+          [internal]
+        DESC
+        task :run_cmd, :roles => :app, :except => { :no_release => true } do
+          command = ENV['COMMAND'] || ""
+          raise "Please specify a command to execute via the COMMAND " +
+            "environment variable" if command.empty?
+
+          run "cd #{current_path} && #{foreman_cmd} run '#{command}'"
+        end
+
+        desc <<-DESC
+          blah
+        DESC
+        task :export, :roles => :app, :except => { :no_release => true } do
+          foreman_strategy.export
+        end
+
+        desc <<-DESC
+          [internal]
+        DESC
+        task :register, :roles => :app, :except => { :no_release => true } do
+          foreman_strategy.register
+        end
+
+        namespace :start do
+          desc <<-DESC
+            flaw
+          DESC
+          task :default, :roles => :app, :except => { :no_release => true } do
+            foreman_strategy.start
+          end
+        end
+
+        namespace :stop do
+          desc <<-DESC
+            flaw
+          DESC
+          task :default, :roles => :app, :except => { :no_release => true } do
+            foreman_strategy.stop
+          end
+        end
+
+        namespace :restart do
+          desc <<-DESC
+            flaw
+          DESC
+          task :default, :roles => :app, :except => { :no_release => true } do
+            foreman_strategy.restart
+          end
+        end
+
+        desc <<-DESC
+          Procs
+        DESC
+        task :ps, :roles => :app, :except => { :no_release => true } do
+          foreman_strategy.ps
+        end
+
+        if File.exists?(fetch(:local_procfile))
+          def procfile
+            @procfile ||= Foreman::Procfile.new(fetch(:local_procfile))
+          end
+
+          namespace :start do
+            procfile.entries.each do |entry|
+              send :desc, <<-DESC
+                Starts #{entry.name} processes managed by the Procfile.
+              DESC
+              send :task, entry.name, :roles => :app, :except => { :no_release => true } do
+                foreman_strategy.start(entry.name)
+              end
+            end
+          end
+
+          namespace :stop do
+            procfile.entries.each do |entry|
+              send :desc, <<-DESC
+                Stops #{entry.name} processes managed by the Procfile.
+              DESC
+              send :task, entry.name, :roles => :app, :except => { :no_release => true } do
+                foreman_strategy.stop(entry.name)
+              end
+            end
+          end
+
+          namespace :restart do
+            procfile.entries.each do |entry|
+              send :desc, <<-DESC
+                Restarts #{entry.name} processes managed by the Procfile.
+              DESC
+              send :task, entry.name, :roles => :app, :except => { :no_release => true } do
+                foreman_strategy.restart(entry.name)
+              end
+            end
+          end
+        end
+      end
+
+      desc <<-DESC
+        Runnings
+      DESC
+      task :frun, :roles => :app, :except => { :no_release => true } do
+        foreman.run_cmd
+      end
+
+      after "deploy:update_code", "foreman:cp_env"
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Foreman.load_into(Capistrano::Configuration.instance)
+end