capistrano-helpers 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 West Arete Computing, Inc.
+
+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.rdoc

@@ -0,0 +1,174 @@
+= capistrano-helpers
+
+A set of optional extensions to capistrano to make common tasks easier and 
+reduce redundancy across your deployments.
+
+== Usage
+
+In your capistrano deploy recipe, simply require the helpers that contain the
+functionality that you would like to add to your recipe. In most cases this
+also takes care of adding the hook so that the action takes place at the right
+time during deployment.
+
+Here's an example config/deploy.rb that uses a few helpers:
+
+  require 'capistrano-helpers/passenger' # Support for Apache passenger
+  require 'capistrano-helpers/specs'     # Check specs before deploying
+  require 'capistrano-helpers/version'   # Record the version number after deploying
+  require 'capistrano-helpers/campfire'  # Post deploy info to campfire
+
+  # The name of the application.
+  set :application, "myapp"
+
+  # The source code management software to use.
+  set :scm, "git"
+
+  # Location of the source code.
+  set :repository,  "git@github.com:mycompany/myapp.git"
+
+That's it! The recipe will now also perform the actions described by the
+helpers (in this case, the campfire helper also requires the tinder gem and
+a config/campfire.yml file).
+
+== Helpers
+
+=== branch
+
+Prompts the user for the particular tag/branch/commit to deploy.
+
+=== campfire
+
+After the application has been deployed, this helper will post a message to 
+the given campfire room stating the username, the application, the branch/tag,
+and the environment. E.g.:
+
+  woods just deployed myapp v0.5.4 to staging
+
+This helper expects to find a configuration file config/campfire.yml with the
+following format:
+
+  # Configuration for posting to campfire.
+  account: mycompany
+  email: smithers@mycompany.com
+  password: 's3kret!'
+  room: Chatter
+
+You can override the location of the configuration file by setting the
+:campfire_config variable:
+
+  set :campfire_config, 'somewhere/else.yml'
+  
+This helper requires that the "tinder" gem is installed on the machine that
+you run the "cap" command from. It doesn't need to be installed on any of the
+servers. You can install the tinder gem using the following command on linux 
+or mac:
+
+  sudo gem install tinder
+
+=== features
+
+Before the app is deployed, this helper checks out the branch/tag that is
+being deployed and runs all the cucumber features, ensuring that they all
+pass.
+
+== gems
+
+Run the gems:install rake task using sudo after deployment.
+
+== git
+
+Set git as the repository type, and set up remote caching to speed up
+deployments.
+
+== migrations
+
+Always run migrations during deployment.
+
+=== passenger
+
+Overrides the default :restart task so that it's compatible with restarting
+apache/passenger (aka mod_rails). Touches tmp/restart.txt.
+
+=== php
+
+Use this helper when using capistrano to deploy a purely PHP application.
+
+This neuters the default :restart and :finalize_updates tasks, since they
+aren't typically needed for a PHP installation.
+
+=== preflight
+
+Goes through a set of yes/no questions with the user before the application is
+actually deployed. This provides a way to walk the user through a set of
+reminders. The deploy only proceeds if the user answers each question
+affirmatively.
+
+This helper expects to find the questions in a configuration file called
+config/preflight.yml . The file should be in the following format:
+
+  # Questions that must be answered "yes" before a deploy is allowed to proceed.
+  - Does cruise control show all tests passing?
+  - Do the staging and production servers have the required gems installed?
+  - Are you prepared to run migrations on the remote server?
+  - Have you tagged this release?
+  - Have you pushed the tags to github?
+
+You can override the location of the configuration file by setting the
+:preflight_config variable:
+
+  set :preflight_config, 'somewhere/else.yml'
+
+=== shared
+
+During deployment, this helper replaces each of the given paths with a
+symbolic link that points to the same path under the "shared" directory on the
+server. This is useful for setting up files and directories that contain
+data that should persist across deployments (uploads, for example).
+
+After requiring this helper, set the paths to be symlinked using the
+:shared variable:
+
+  set :shared, %w{
+    public/uploads
+    public/downloads/huge_files
+  }
+
+This will create two symbolic links on the production server:
+
+  #{release_path}/public/uploads -> #{shared_path}/public/uploads
+  #{release_path}/public/downloads/huge_files -> #{shared_path}/public/downloads/huge_files
+
+=== privates
+
+This works much like the shared helper above, except the symbolic link will
+point to the same path under "shared/private" on the server. This allows you
+to set special permissions on that directory for keeping particularly 
+sensitive files safe, such as those that contain passwords or encryption keys.
+
+After requiring this helper, set the paths to be symlinked using the
+:privates variable:
+
+  set :privates, %w{
+    config/database.yml
+    config/session_secret.txt
+  }
+  
+This will create two symbolic links on the production server:
+
+  #{release_path}/config/database.yml -> #{shared_path}/private/config/database.yml
+  #{release_path}/config/session_secret.txt -> #{shared_path}/private/config/session_secret.txt
+
+=== specs
+
+Before the app is deployed, this helper checks out the branch/tag that is
+being deployed and runs all the rspec specs, ensuring that they all pass.
+
+=== version
+
+Creates a VERSION file in the deployed copy that contains the name of the
+branch/tag that was deployed. Useful for displaying version information in the
+app itself.
+
+== Copyright
+
+Copyright (c) 2009 West Arete Computing, Inc.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "capistrano-helpers"
+    gem.summary = %Q{A set of optional extensions to capistrano to make common tasks easier.}
+    gem.description = %Q{A set of optional extensions to capistrano to make common tasks easier.}
+    gem.email = "scott@westarete.com"
+    gem.homepage = "http://github.com/westarete/capistrano-helpers"
+    gem.authors = ["Scott Woods"]
+    gem.add_dependency('capistrano', '>= 2.0.0')
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "capistrano-helpers #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/capistrano-helpers.gemspec

@@ -0,0 +1,63 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{capistrano-helpers}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Woods"]
+  s.date = %q{2009-11-04}
+  s.description = %q{A set of optional extensions to capistrano to make common tasks easier.}
+  s.email = %q{scott@westarete.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "capistrano-helpers.gemspec",
+     "lib/capistrano-helpers.rb",
+     "lib/capistrano-helpers/branch.rb",
+     "lib/capistrano-helpers/campfire.rb",
+     "lib/capistrano-helpers/features.rb",
+     "lib/capistrano-helpers/gems.rb",
+     "lib/capistrano-helpers/git.rb",
+     "lib/capistrano-helpers/migrations.rb",
+     "lib/capistrano-helpers/passenger.rb",
+     "lib/capistrano-helpers/php.rb",
+     "lib/capistrano-helpers/preflight.rb",
+     "lib/capistrano-helpers/privates.rb",
+     "lib/capistrano-helpers/shared.rb",
+     "lib/capistrano-helpers/specs.rb",
+     "lib/capistrano-helpers/version.rb",
+     "test/capistrano-helpers_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/westarete/capistrano-helpers}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A set of optional extensions to capistrano to make common tasks easier.}
+  s.test_files = [
+    "test/capistrano-helpers_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 2.0.0"])
+  end
+end

data/lib/capistrano-helpers/branch.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+ 
+  desc "Ensure that a branch has been selected."
+  task :set_branch do
+    if !exists?(:branch)
+      set(:branch, Capistrano::CLI.ui.ask("Which tag/branch/commit? "))
+    end 
+  end
+
+  on :start, :set_branch
+  
+end

data/lib/capistrano-helpers/campfire.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+begin
+  # Campfire API gem for deploy notifications.
+  require 'tinder'
+rescue LoadError
+  abort "The campfire helper requires the tinder gem. Install it with: sudo gem install tinder"
+end
+
+CapistranoHelpers.with_configuration do
+  
+  namespace :deploy do
+    desc 'Make a post to campfire to tell everyone about this deployment.'
+    task :post_to_campfire do
+      if !exists?(:application)
+        puts "You should set :application to the name of this app."
+      end
+      username = `whoami`.chomp
+      config_file = fetch(:campfire_config, 'config/campfire.yml')
+      config = YAML::load_file(config_file)
+      campfire = Tinder::Campfire.new(config['account'])
+      campfire.login(config['email'], config['password'])
+      room = campfire.find_room_by_name(config['room'])
+      room.speak("#{username} just deployed #{application} #{branch} to #{stage}")
+      room.leave
+    end
+  end
+
+  after "deploy:restart", "deploy:post_to_campfire"
+
+end

data/lib/capistrano-helpers/features.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+require File.dirname(__FILE__) + '/branch'
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    desc "Make sure all features pass"
+    task :check_features do
+      if scm != 'git'
+        abort "Sorry, you can only check features if you're using git as your scm."
+      end
+      `git branch` =~ /^\* ([^\s]+)/ or abort "Couldn't understand the output of `git branch`."
+      original_branch = $1
+      begin
+        puts "Checking out #{branch}"
+        system("git checkout #{branch}") or raise "Couldn't check out #{branch}."
+        puts "Checking features..."
+        system("rake features") or raise "One or more features are failing. Come back when they all pass."
+        @failed = false
+      rescue Exception => e
+        puts e
+        @failed = true
+      ensure
+        puts "Going back to branch #{original_branch}"
+        system("git checkout #{original_branch}") or abort "Sorry, couldn't put you back to your original branch."
+      end
+      abort if @failed
+    end
+  end
+
+  before "deploy:update_code", "deploy:check_features"
+
+end

data/lib/capistrano-helpers/gems.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+  
+  namespace :gems do
+    desc "Install gems on the remote server."
+    task :install, :roles => :app do
+      run "cd #{current_release} && #{sudo} rake gems:install RAILS_ENV=#{rails_env}"
+    end
+  end
+  
+  after "deploy:update_code", "gems:install"
+
+end

data/lib/capistrano-helpers/git.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+  
+  # The source code management software to use.
+  set :scm, "git"
+
+  # Rather than cloning from github each time, keep a local repo on the server
+  # and fetch from that instead. Much faster.
+  set :deploy_via, :remote_cache
+  
+  # By default, it tries to keep git quiet. But this makes older version of 
+  # git (like those on our servers) barf, since they don't always support the
+  # quiet options.
+  set :scm_verbose, true
+
+end

data/lib/capistrano-helpers/migrations.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+  
+  # Always run migrations.
+  after "deploy:update_code", "deploy:migrate"
+
+end

data/lib/capistrano-helpers/passenger.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    desc 'Restart passenger'
+    task :restart, :roles => :app do
+      run "touch #{release_path}/tmp/restart.txt"
+    end
+  end
+
+end

data/lib/capistrano-helpers/php.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    task :restart do
+      # No need to restart the web server. 
+    end
+
+    task :finalize_update do
+      # No need to make any extra symlinks.
+    end
+  end
+
+end

data/lib/capistrano-helpers/preflight.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    desc 'Go through the preflight checklist'
+    task :preflight do
+      puts 'Going through preflight checklist:'
+      config_file = fetch(:preflight_config, 'config/preflight.yml')
+      questions = YAML::load_file(config_file)
+      questions.map! { |q| " * #{q} " }
+      questions.each do |question|
+        response = Capistrano::CLI.ui.ask(question)
+        if response !~ /y(es)?/i
+          abort 'Come back when you can answer "yes" to all the deploy questions.'
+        end
+      end
+    end
+  end
+
+  before "deploy:update_code", "deploy:preflight"
+
+end

data/lib/capistrano-helpers/privates.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    desc 'Replace named files with a symlink to their counterparts in shared/private/'
+    task :symlink_privates do
+      if !exists?(:privates)
+        abort 'You must specify which privates to symlink using the "set :privates" command.'
+      end
+      privates.each do |path|
+        run "ln -nfs #{shared_path}/private/#{path} #{release_path}/#{path}"
+      end
+    end
+  end
+
+  after "deploy:update_code", "deploy:symlink_privates"
+
+end

data/lib/capistrano-helpers/shared.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    desc 'Replace named files with a symlink to their counterparts in shared/'
+    task :symlink_shared do
+      if !exists?(:shared)
+        abort 'You must specify which files to symlink using the "set :shared" command.'
+      end
+      shared.each do |path|
+        run "ln -nfs #{shared_path}/#{path} #{release_path}/#{path}"
+      end
+    end
+  end
+
+  after "deploy:update_code", "deploy:symlink_shared"
+
+end

data/lib/capistrano-helpers/specs.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+require File.dirname(__FILE__) + '/branch'
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    desc "Make sure all specs pass"
+    task :check_specs do
+      if scm != 'git'
+        abort "Sorry, you can only check specs if you're using git as your scm."
+      end
+      `git branch` =~ /^\* ([^\s]+)/ or abort "Couldn't understand the output of `git branch`."
+      original_branch = $1
+      begin
+        puts "Checking out #{branch}"
+        system("git checkout #{branch}") or raise "Couldn't check out #{branch}."
+        puts "Checking specs..."
+        system("rake spec") or raise "One or more specs are failing. Come back when they all pass."
+        @failed = false
+      rescue Exception => e
+        puts e
+        @failed = true
+      ensure
+        puts "Going back to branch #{original_branch}"
+        system("git checkout #{original_branch}") or abort "Sorry, couldn't put you back to your original branch."
+      end
+      abort if @failed
+    end
+  end
+
+  before "deploy:update_code", "deploy:check_specs"
+
+end

data/lib/capistrano-helpers/version.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+require File.dirname(__FILE__) + '/branch'
+
+CapistranoHelpers.with_configuration do
+ 
+  namespace :deploy do
+    desc "Write the name of the tag that we're deploying to a VERSION file"
+    task :write_version_file do
+      run "echo -n \"#{branch}\" > #{release_path}/VERSION"
+    end
+  end
+
+  after "deploy:update_code", "deploy:write_version_file"
+
+end

data/lib/capistrano-helpers.rb

@@ -0,0 +1,15 @@
+require 'capistrano'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano-helpers requires Capistrano 2"
+end
+
+class CapistranoHelpers
+  
+  # Execute the given block of code within the context of the capistrano
+  # configuration.
+  def self.with_configuration(&block)
+    Capistrano::Configuration.instance(:must_exist).load(&block)
+  end
+  
+end

data/test/capistrano-helpers_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CapistranoHelpersTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'capistrano-helpers'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-helpers
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Scott Woods
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: A set of optional extensions to capistrano to make common tasks easier.
+email: scott@westarete.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- capistrano-helpers.gemspec
+- lib/capistrano-helpers.rb
+- lib/capistrano-helpers/branch.rb
+- lib/capistrano-helpers/campfire.rb
+- lib/capistrano-helpers/features.rb
+- lib/capistrano-helpers/gems.rb
+- lib/capistrano-helpers/git.rb
+- lib/capistrano-helpers/migrations.rb
+- lib/capistrano-helpers/passenger.rb
+- lib/capistrano-helpers/php.rb
+- lib/capistrano-helpers/preflight.rb
+- lib/capistrano-helpers/privates.rb
+- lib/capistrano-helpers/shared.rb
+- lib/capistrano-helpers/specs.rb
+- lib/capistrano-helpers/version.rb
+- test/capistrano-helpers_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/westarete/capistrano-helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A set of optional extensions to capistrano to make common tasks easier.
+test_files: 
+- test/capistrano-helpers_test.rb
+- test/test_helper.rb