daemon-kit 0.1.6 → 0.1.7

data/History.txt

@@ -1,3 +1,12 @@
+== 0.1.6 2009-05-13
+
+* DaemonKit::Safety class to handle the trapping and logging of
+  exceptions, as well as email notifications or Hoptoad notifications.
+* New config/pre-daemonize and config/post-daemonize structure
+* New tasks to simplify upgrading daemon-kit projects
+* Fixed some other annoyances and bugs
+* Bigger TODO list
+
 == 0.1.5 2009-05-07
 
 * DaemonKit::Config class to easy the use of YAML configs internally,

data/Manifest.txt

@@ -1,7 +1,7 @@
 History.txt
 Manifest.txt
 PostInstall.txt
-README.textile
+README.rdoc
 Rakefile
 TODO.txt
 app_generators/daemon_kit/USAGE
@@ -28,6 +28,13 @@ daemon_generators/cron/USAGE
 daemon_generators/cron/cron_generator.rb
 daemon_generators/cron/templates/config/initializers/cron.rb
 daemon_generators/cron/templates/libexec/daemon.rb
+daemon_generators/deploy_capistrano/USAGE
+daemon_generators/deploy_capistrano/deploy_capistrano_generator.rb
+daemon_generators/deploy_capistrano/templates/Capfile
+daemon_generators/deploy_capistrano/templates/config/deploy.rb
+daemon_generators/deploy_capistrano/templates/config/deploy/production.rb
+daemon_generators/deploy_capistrano/templates/config/deploy/staging.rb
+daemon_generators/deploy_capistrano/templates/config/environments/staging.rb
 daemon_generators/jabber/USAGE
 daemon_generators/jabber/jabber_generator.rb
 daemon_generators/jabber/templates/config/initializers/jabber.rb
@@ -44,6 +51,7 @@ lib/daemon_kit/amqp.rb
 lib/daemon_kit/application.rb
 lib/daemon_kit/config.rb
 lib/daemon_kit/cron.rb
+lib/daemon_kit/deployment/capistrano.rb
 lib/daemon_kit/error_handlers/base.rb
 lib/daemon_kit/error_handlers/hoptoad.rb
 lib/daemon_kit/error_handlers/mail.rb
@@ -75,6 +83,7 @@ test/test_amqp_generator.rb
 test/test_cron_generator.rb
 test/test_daemon-kit_generator.rb
 test/test_daemon_kit_config.rb
+test/test_deploy_capistrano_generator.rb
 test/test_generator_helper.rb
 test/test_helper.rb
 test/test_jabber_generator.rb

data/{README.textile → README.rdoc}

@@ -1,8 +1,10 @@
-h1. Daemon Kit
+= Daemon Kit
 
-* http://daemon-kit.rubyforge.org/ (coming soon)
+* http://kit.rubyforge.org/daemon (coming soon)
+* http://groups.google.com/group/daemon-kit (daemon-kit@googlegroups.com)
+* #daemon-kit on Freenode
 
-h2. Description
+== Description
 
 Daemon Kit aims to simplify creating Ruby daemons by providing a sound application skeleton (through a generator), task specific generators (jabber bot, etc) and robust environment management code.
 
@@ -14,12 +16,12 @@ Supported generators:
 * Evented and non-evented loops (coming soon)
 * Queue poller (SQS, AMQP, etc) (coming soon)
 
-h2. Features/Problems
+== Features/Problems
 
 * Build it
 * Review TODO.txt
 
-h2. Synopsis
+== Synopsis
 
   $ daemon-kit [/path/to/your/daemon] [options]
 
@@ -29,46 +31,58 @@ The above command generates a skeleton daemon environment for you to adapt.
 
 Use the 'jabber' generator instead of the default one.
 
-h2. Generators
+== Generators
 
 Currently only two generators exist, a 'default' generator and a 'jabber' generator.
 
 The default generator creates a simple daemon with an infinite loop inside that you can adapt.
 
-h3. Jabber Generator
+=== Jabber Generator
 
 The jabber generator creates a simple daemon that leverages the "xmpp4r-simple":http://xmpp4r-simple.rubyforge.org/ gem to process inbound messages. The daemon will manage the roster and other little tasks, leaving you to provide the hooks for processing messages, presence notifications and subscription request.
 
-h3. Cron Generator
+=== Cron Generator
 
 The cron generator creates a simple daemon that leverages the "rufus-scheduler":http://github.com/jmettraux/rufus-scheduler gem to create a simple cron-lie daemon. Please be aware that this daemon could never be a replacement for the battle-tested "cron utility":http://www.gentoo.org/doc/en/cron-guide.xml shipped standard with most *nix distributions.
 
-h3. AMQP Consumer Generator
+=== AMQP Consumer Generator
 
 The AMQP generator creates a simple daemon that has all the stub code and configuration in place to help you write AMQP consumers quickly and effectively. The generated daemon relies on the presence of the "amqp":http://github.com/tmm1/amqp gem.
 
-h2. Requirements
+== Requirements
 
 * Ruby 1.8.6
 * daemons 1.0.10
 * rspec 1.1.11 (for writing/running your specs)
 
-h3. Generator Requirements
+== Generator Requirements
 
 Depending on the generator you choose for your daemon, it might require additional gems to run.
 
-|.Generator|.Dependencies|
-|jabber|"xmpp4r-simple":http://xmpp4r-simple.rubyforge.org/|
-|cron|"rufus-scheduler":http://github.com/jmettraux/rufus-scheduler|
-|amqp|"amqp":http://github.com/tmm1/amqp|
+<table>
+<tr><th>Generator</th><th>\&nbsp;</th><th>Dependencies</th></tr>
+<tr><td>jabber</td><td>\&nbsp;</td><td> xmpp4r-simple[http://xmpp4r-simple.rubyforge.org] </td></tr>
+<tr><td>cron</td><td>\&nbsp;</td><td> rufus-scheduler[http://github.com/jmettraux/rufus-scheduler] </td></tr>
+<tr><td>amqp</td><td>\&nbsp;</td><td> amqp[http://github.com/tmm1/amqp] </td></tr>
+</table>
 
-h2. Install
+== Install
+
+Currently recommended to stick to the git repo:
 
   $ git clone git://github.com/kennethkalmer/daemon-kit.git
   $ rake gem
   $ gem install pkg/daemon-kit-X.X.X.gem
 
-h2. License
+Development versions are available as gems from github:
+
+  $ gem install kennethkalmer-daemon-kit -s http://gems.github.com
+
+Stable versions, when released are available directly from Rubyforge:
+
+  $ gem install daemon-kit
+
+== License
 
 (The MIT License)
 

data/TODO.txt

@@ -4,7 +4,7 @@ DaemonKit TODO List
 This is purely a drop in the bucket of what has to come...
 
 * [DONE] Easy way to trap signals
-* Error handling to the degree Rails does
+* [IN PROGRESS] Error handling to the degree Rails does
 * Easy configuration of an ORM of choice, including patching it if needed (ActiveRecord *cough*)
 * Improved generators for creating skeleton daemons:
   * [DONE] Jabber bot
@@ -14,6 +14,7 @@ This is purely a drop in the bucket of what has to come...
   * Queue (SQS, AMQP, etc) pollers
 * Rake tasks for generating:
   * god configs
+  * Sys-V style init scripts
 * Pre-built capistrano configs for easy deployment
 * Support for dropping privileges
 * Support for chroot'ing

data/app_generators/daemon_kit/daemon_kit_generator.rb

@@ -5,10 +5,13 @@ class DaemonKitGenerator < RubiGen::Base
 
   VALID_GENERATORS = ['default', 'jabber', 'cron', 'amqp', 'nanite_agent']
 
+  DEPLOYERS = ['none', 'capistrano']
+
   default_options :shebang => DEFAULT_SHEBANG, :author => nil
 
   attr_reader :daemon_name
   attr_reader :installer
+  attr_reader :deployer
 
   def initialize(runtime_args, runtime_options = {})
     super
@@ -26,6 +29,12 @@ class DaemonKitGenerator < RubiGen::Base
       exit 1
     end
 
+    unless DEPLOYERS.include?( deployer )
+      $stderr.puts "Invalid deployment mechanism: '#{deployer}'."
+      $stderr.puts "Valid deployers are: #{DEPLOYERS.join(', ')}"
+      exit 1
+    end
+
     script_options = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
 
     record do |m|
@@ -75,6 +84,11 @@ class DaemonKitGenerator < RubiGen::Base
       # Tests
       m.dependency "install_rspec", [daemon_name], :destination => destination_root, :collision => :force
 
+      # Deployers
+      unless deployer == 'none'
+        m.dependency "deploy_#{deployer}", [daemon_name], :destination => destination_root, :collision => :force
+      end
+
       # Others
       m.directory "log"
       m.directory "tmp"
@@ -102,12 +116,21 @@ EOS
       # opts.on("-a", "--author=\"Your Name\"", String,
       #         "Some comment about this option",
       #         "Default: none") { |o| options[:author] = o }
+
       opts.on("-i", "--install=generator", String,
               "Select a generator to use (other than the default).",
               "Available generators: #{VALID_GENERATORS.join(', ')}",
               "Defaults to: default") do |installer|
         options[:installer] = installer
       end
+
+      opts.on("-d", "--deploy-with=config", String,
+              "Select an optional deployment mechanism.",
+              "Available deployers: #{DEPLOYERS.join(', ')}",
+              "Defaults to: none") do |deploy|
+        options[:deployer] = deploy
+      end
+
       opts.on("-r", "--ruby=path", String,
               "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).",
               "Default: #{DEFAULT_SHEBANG}") { |x| options[:shebang] = x }
@@ -120,6 +143,7 @@ EOS
       # raw instance variable value.
       # @author = options[:author]
       @installer = options[:installer] || 'default'
+      @deployer  = (options[:deployer] || 'none').strip
     end
 
 end

data/daemon_generators/deploy_capistrano/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/daemon_generators/deploy_capistrano/deploy_capistrano_generator.rb

@@ -0,0 +1,54 @@
+class DeployCapistranoGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+
+      m.file      "Capfile", "Capfile"
+      m.directory "config"
+      m.template  "config/deploy.rb", "config/deploy.rb"
+      m.directory "config/deploy"
+      m.template  "config/deploy/staging.rb", "config/deploy/staging.rb"
+      m.template  "config/deploy/production.rb", "config/deploy/production.rb"
+      m.directory "config/environments"
+      m.file      "config/environments/staging.rb", "config/environments/staging.rb", :collision => :skip
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |o| options[:author] = o }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/daemon_generators/deploy_capistrano/templates/Capfile

@@ -0,0 +1,10 @@
+unless respond_to?(:namespace) # cap2 differentiator
+  $stderr.puts "Requires capistrano version 2"
+  exit 1
+end
+
+require 'config/boot'
+load DaemonKit.framework_root + '/lib/daemon_kit/deployment/capistrano.rb'
+
+Dir['config/deploy/recipes/*.rb'].each { |plugin| load(plugin) }
+load 'config/deploy.rb'

data/daemon_generators/deploy_capistrano/templates/config/deploy.rb

@@ -0,0 +1,51 @@
+# Modified capistrano recipe, based on the standard 'deploy' recipe
+# provided by capistrano but without the Rails-specific dependencies
+
+set :stages, %w(staging production)
+set :default_stage, "staging"
+require "capistrano/ext/multistage"
+
+# Set some globals
+default_run_options[:pty] = true
+set :application, "<%= name %>"
+
+# Deployment
+set :deploy_to, "/svc/#{application}"
+#set :user, 'someone'
+
+# Get repo configuration
+set :repository, "git@github.com:yourname/#{application}.git"
+set :scm, "git"
+set :branch, "master"
+set :deploy_via, :remote_cache
+set :git_enable_submodules, 1
+
+# No sudo
+set :use_sudo, false
+
+# File list in the config_files setting will be copied from the
+# 'deploy_to' directory into config, overwriting files from the repo
+# with the same name
+set :config_files, %w{}
+
+# List any work directories here that you need persisted between
+# deployments. They are created in 'deploy_to'/shared and symlinked
+# into the root directory of the deployment.
+set :shared_children, %w{log tmp}
+
+# Record our dependencies
+depend :remote, :gem, "daemon-kit", ">=0.0.0"
+
+# Hook into capistrano's events
+before "deploy:update_code", "deploy:check"
+
+# Create some tasks related to deployment
+namespace :deploy do
+
+  desc "Get the current revision of the deployed code"
+  task :get_current_version do
+    run "cat #{current_path}/REVISION" do |ch, stream, out|
+      puts "Current revision: " + out.chomp
+    end
+  end
+end

data/daemon_generators/deploy_capistrano/templates/config/deploy/production.rb

@@ -0,0 +1,6 @@
+#set :deploy_to, "/svc/<%= name %>" # defaults to "/u/apps/#{application}"
+#set :user, "<% name %>"            # defaults to the currently logged in user
+set :daemon_env, 'production'
+
+set :domain, 'example.com'
+server domain

data/daemon_generators/deploy_capistrano/templates/config/deploy/staging.rb

@@ -0,0 +1,6 @@
+#set :deploy_to, "/svc/<%= name %>" # defaults to "/u/apps/#{application}"
+#set :user, "<% name %>"            # defaults to the currently logged in user
+set :daemon_env, 'staging'
+
+set :domain, 'example.com'
+server domain

data/lib/daemon_kit.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'rubygems'
 
 module DaemonKit
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 
   autoload :Initializer, 'daemon_kit/initializer'
   autoload :Application, 'daemon_kit/application'

data/lib/daemon_kit/deployment/capistrano.rb

@@ -0,0 +1,485 @@
+require 'yaml'
+require 'capistrano/recipes/deploy/scm'
+require 'capistrano/recipes/deploy/strategy'
+
+def _cset(name, *args, &block)
+  unless exists?(name)
+    set(name, *args, &block)
+  end
+end
+
+# =========================================================================
+# These variables MUST be set in the client capfiles. If they are not set,
+# the deploy will fail with an error.
+# =========================================================================
+
+_cset(:application) { abort "Please specify the name of your application, set :application, 'foo'" }
+_cset(:repository)  { abort "Please specify the repository that houses your application's code, set :repository, 'foo'" }
+
+# =========================================================================
+# These variables may be set in the client capfile if their default values
+# are not sufficient.
+# =========================================================================
+
+_cset :scm, :subversion
+_cset :deploy_via, :checkout
+
+_cset(:deploy_to) { "/u/apps/#{application}" }
+_cset(:revision)  { source.head }
+
+# =========================================================================
+# These variables should NOT be changed unless you are very confident in
+# what you are doing. Make sure you understand all the implications of your
+# changes if you do decide to muck with these!
+# =========================================================================
+
+_cset(:source)            { Capistrano::Deploy::SCM.new(scm, self) }
+_cset(:real_revision)     { source.local.query_revision(revision) { |cmd| with_env("LC_ALL", "C") { run_locally(cmd) } } }
+
+_cset(:strategy)          { Capistrano::Deploy::Strategy.new(deploy_via, self) }
+
+_cset(:release_name)      { set :deploy_timestamped, true; Time.now.utc.strftime("%Y%m%d%H%M%S") }
+
+_cset :version_dir,       "releases"
+_cset :shared_dir,        "shared"
+_cset :shared_children,   %w(log tmp)
+_cset :current_dir,       "current"
+
+_cset(:releases_path)     { File.join(deploy_to, version_dir) }
+_cset(:shared_path)       { File.join(deploy_to, shared_dir) }
+_cset(:current_path)      { File.join(deploy_to, current_dir) }
+_cset(:release_path)      { File.join(releases_path, release_name) }
+
+_cset(:releases)          { capture("ls -xt #{releases_path}").split.reverse }
+_cset(:current_release)   { File.join(releases_path, releases.last) }
+_cset(:previous_release)  { releases.length > 1 ? File.join(releases_path, releases[-2]) : nil }
+
+_cset(:current_revision)  { capture("cat #{current_path}/REVISION").chomp }
+_cset(:latest_revision)   { capture("cat #{current_release}/REVISION").chomp }
+_cset(:previous_revision) { capture("cat #{previous_release}/REVISION").chomp }
+
+_cset(:run_method)        { fetch(:use_sudo, true) ? :sudo : :run }
+
+# some tasks, like symlink, need to always point at the latest release, but
+# they can also (occassionally) be called standalone. In the standalone case,
+# the timestamped release_path will be inaccurate, since the directory won't
+# actually exist. This variable lets tasks like symlink work either in the
+# standalone case, or during deployment.
+_cset(:latest_release) { exists?(:deploy_timestamped) ? release_path : current_release }
+
+# =========================================================================
+# These are helper methods that will be available to your recipes.
+# =========================================================================
+
+# Auxiliary helper method for the `deploy:check' task. Lets you set up your
+# own dependencies.
+def depend(location, type, *args)
+  deps = fetch(:dependencies, {})
+  deps[location] ||= {}
+  deps[location][type] ||= []
+  deps[location][type] << args
+  set :dependencies, deps
+end
+
+# Temporarily sets an environment variable, yields to a block, and restores
+# the value when it is done.
+def with_env(name, value)
+  saved, ENV[name] = ENV[name], value
+  yield
+ensure
+  ENV[name] = saved
+end
+
+# logs the command then executes it locally.
+# returns the command output as a string
+def run_locally(cmd)
+  logger.trace "executing locally: #{cmd.inspect}" if logger
+  `#{cmd}`
+end
+
+# If a command is given, this will try to execute the given command, as
+# described below. Otherwise, it will return a string for use in embedding in
+# another command, for executing that command as described below.
+#
+# If :run_method is :sudo (or :use_sudo is true), this executes the given command
+# via +sudo+. Otherwise is uses +run+. If :as is given as a key, it will be
+# passed as the user to sudo as, if using sudo. If the :as key is not given,
+# it will default to whatever the value of the :admin_runner variable is,
+# which (by default) is unset.
+#
+# THUS, if you want to try to run something via sudo, and what to use the
+# root user, you'd just to try_sudo('something'). If you wanted to try_sudo as
+# someone else, you'd just do try_sudo('something', :as => "bob"). If you
+# always wanted sudo to run as a particular user, you could do
+# set(:admin_runner, "bob").
+def try_sudo(*args)
+  options = args.last.is_a?(Hash) ? args.pop : {}
+  command = args.shift
+  raise ArgumentError, "too many arguments" if args.any?
+
+  as = options.fetch(:as, fetch(:admin_runner, nil))
+  via = fetch(:run_method, :sudo)
+  if command
+    invoke_command(command, :via => via, :as => as)
+  elsif via == :sudo
+    sudo(:as => as)
+  else
+    ""
+  end
+end
+
+# Same as sudo, but tries sudo with :as set to the value of the :runner
+# variable (which defaults to "app").
+def try_runner(*args)
+  options = args.last.is_a?(Hash) ? args.pop : {}
+  args << options.merge(:as => fetch(:runner, "app"))
+  try_sudo(*args)
+end
+
+# =========================================================================
+# These are the tasks that are available to help with deploying web apps,
+# and specifically, Rails applications. You can have cap give you a summary
+# of them with `cap -T'.
+# =========================================================================
+
+namespace :deploy do
+  desc <<-DESC
+    Deploys your project. This calls both `update' and `restart'. Note that \
+    this will generally only work for applications that have already been deployed \
+    once. For a "cold" deploy, you'll want to take a look at the `deploy:cold' \
+    task, which handles the cold start specifically.
+  DESC
+  task :default do
+    update
+    restart
+  end
+
+  desc <<-DESC
+    Prepares one or more servers for deployment. Before you can use any \
+    of the Capistrano deployment tasks with your project, you will need to \
+    make sure all of your servers have been prepared with `cap deploy:setup'. When \
+    you add a new server to your cluster, you can easily run the setup task \
+    on just that server by specifying the HOSTS environment variable:
+
+      $ cap HOSTS=new.server.com deploy:setup
+
+    It is safe to run this task on servers that have already been set up; it \
+    will not destroy any deployed revisions or data.
+  DESC
+  task :setup, :except => { :no_release => true } do
+    dirs = [deploy_to, releases_path, shared_path]
+    dirs += shared_children.map { |d| File.join(shared_path, d) }
+    run "#{try_sudo} mkdir -p #{dirs.join(' ')} && #{try_sudo} chmod g+w #{dirs.join(' ')}"
+  end
+
+  desc <<-DESC
+    Copies your project and updates the symlink. It does this in a \
+    transaction, so that if either `update_code' or `symlink' fail, all \
+    changes made to the remote servers will be rolled back, leaving your \
+    system in the same state it was in before `update' was invoked. Usually, \
+    you will want to call `deploy' instead of `update', but `update' can be \
+    handy if you want to deploy, but not immediately restart your application.
+  DESC
+  task :update do
+    transaction do
+      update_code
+      symlink
+    end
+  end
+
+  desc <<-DESC
+    Copies your project to the remote servers. This is the first stage \
+    of any deployment; moving your updated code and assets to the deployment \
+    servers. You will rarely call this task directly, however; instead, you \
+    should call the `deploy' task (to do a complete deploy) or the `update' \
+    task (if you want to perform the `restart' task separately).
+
+    You will need to make sure you set the :scm variable to the source \
+    control software you are using (it defaults to :subversion), and the \
+    :deploy_via variable to the strategy you want to use to deploy (it \
+    defaults to :checkout).
+  DESC
+  task :update_code, :except => { :no_release => true } do
+    on_rollback { run "rm -rf #{release_path}; true" }
+    strategy.deploy!
+    finalize_update
+  end
+
+  desc <<-DESC
+    [internal] Touches up the released code. This is called by update_code \
+    after the basic deploy finishes. It assumes a Rails project was deployed, \
+    so if you are deploying something else, you may want to override this \
+    task with your own environment's requirements.
+
+    This task will make the release group-writable (if the :group_writable \
+    variable is set to true, which is the default). It will then set up \
+    symlinks to the shared directory for the :shared_children \
+    directories, and will lastly touch all assets in public/images, \
+    public/stylesheets, and public/javascripts so that the times are \
+    consistent (so that asset timestamping works).  This touch process \
+    is only carried out if the :normalize_asset_timestamps variable is \
+    set to true, which is the default.
+  DESC
+  task :finalize_update, :except => { :no_release => true } do
+    run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
+
+    # mkdir -p is making sure that the directories are there for some SCM's that don't
+    # save empty folders
+    dirs = fetch(:shared_children, [])
+    cmd = dirs.inject([]) do |c,d|
+      c.push "rm -rf #{latest_release}/#{d}"
+      c.push "ln -s #{shared_path}/#{d} #{latest_release}/#{d}"
+      c
+    end
+
+    run cmd.join( ' && ' )
+
+    if fetch(:normalize_asset_timestamps, false)
+      stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
+      asset_paths = %w(images stylesheets javascripts).map { |p| "#{latest_release}/public/#{p}" }.join(" ")
+      run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true", :env => { "TZ" => "UTC" }
+    end
+
+    copy_configs
+  end
+
+  desc <<-DESC
+    Copies any shared configuration files from :deploy_to/config into \
+    the current release's config directory. Original files, if present, \
+    are renamed to the same name with .orig appended.
+
+    Specify a list of files by setting :config_files to an array in your \
+    deployment configuration.
+  DESC
+  task :copy_configs do
+    fetch(:config_files, []).each do |f|
+      run "[ -f #{release_path}/config/#{f} ]; mv #{release_path}/config/#{f} #{release_path}/config/#{f}.orig"
+      run "[ -f #{deploy_to}/config/#{f} ]; cp #{deploy_to}/config/#{f} #{release_path}/config/#{f}"
+    end
+  end
+
+  desc <<-DESC
+    Updates the symlink to the most recently deployed version. Capistrano works \
+    by putting each new release of your application in its own directory. When \
+    you deploy a new version, this task's job is to update the `current' symlink \
+    to point at the new version. You will rarely need to call this task \
+    directly; instead, use the `deploy' task (which performs a complete \
+    deploy, including `restart') or the 'update' task (which does everything \
+    except `restart').
+  DESC
+  task :symlink, :except => { :no_release => true } do
+    on_rollback do
+      if previous_release
+        run "rm -f #{current_path}; ln -s #{previous_release} #{current_path}; true"
+      else
+        logger.important "no previous release to rollback to, rollback of symlink skipped"
+      end
+    end
+
+    run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
+  end
+
+  desc <<-DESC
+    Copy files to the currently deployed version. This is useful for updating \
+    files piecemeal, such as when you need to quickly deploy only a single \
+    file. Some files, such as updated templates, images, or stylesheets, \
+    might not require a full deploy, and especially in emergency situations \
+    it can be handy to just push the updates to production, quickly.
+
+    To use this task, specify the files and directories you want to copy as a \
+    comma-delimited list in the FILES environment variable. All directories \
+    will be processed recursively, with all files being pushed to the \
+    deployment servers.
+
+      $ cap deploy:upload FILES=templates,controller.rb
+
+    Dir globs are also supported:
+
+      $ cap deploy:upload FILES='config/apache/*.conf'
+  DESC
+  task :upload, :except => { :no_release => true } do
+    files = (ENV["FILES"] || "").split(",").map { |f| Dir[f.strip] }.flatten
+    abort "Please specify at least one file or directory to update (via the FILES environment variable)" if files.empty?
+
+    files.each { |file| top.upload(file, File.join(current_path, file)) }
+  end
+
+  desc <<-DESC
+    Restarts your application. This works by calling the bin/:application \
+    script under the current path with 'restart'
+
+    By default, this will be invoked via sudo as the `app' user. If \
+    you wish to run it as a different user, set the :runner variable to \
+    that user. If you are in an environment where you can't use sudo, set \
+    the :use_sudo variable to false:
+
+      set :use_sudo, false
+  DESC
+  task :restart, :except => { :no_release => true } do
+    try_runner "/usr/bin/env DAEMON_ENV=#{fetch(:daemon_env)} #{current_path}/bin/#{application} restart"
+  end
+
+  namespace :rollback do
+    desc <<-DESC
+      [internal] Points the current symlink at the previous revision.
+      This is called by the rollback sequence, and should rarely (if
+      ever) need to be called directly.
+    DESC
+    task :revision, :except => { :no_release => true } do
+      if previous_release
+        run "rm #{current_path}; ln -s #{previous_release} #{current_path}"
+      else
+        abort "could not rollback the code because there is no prior release"
+      end
+    end
+
+    desc <<-DESC
+      [internal] Removes the most recently deployed release.
+      This is called by the rollback sequence, and should rarely
+      (if ever) need to be called directly.
+    DESC
+    task :cleanup, :except => { :no_release => true } do
+      run "if [ `readlink #{current_path}` != #{current_release} ]; then rm -rf #{current_release}; fi"
+    end
+
+    desc <<-DESC
+      Rolls back to the previously deployed version. The `current' symlink will \
+      be updated to point at the previously deployed version, and then the \
+      current release will be removed from the servers. You'll generally want \
+      to call `rollback' instead, as it performs a `restart' as well.
+    DESC
+    task :code, :except => { :no_release => true } do
+      revision
+      cleanup
+    end
+
+    desc <<-DESC
+      Rolls back to a previous version and restarts. This is handy if you ever \
+      discover that you've deployed a lemon; `cap rollback' and you're right \
+      back where you were, on the previously deployed version.
+    DESC
+    task :default do
+      revision
+      restart
+      cleanup
+    end
+  end
+
+  desc <<-DESC
+    Clean up old releases. By default, the last 5 releases are kept on each \
+    server (though you can change this with the keep_releases variable). All \
+    other deployed revisions are removed from the servers. By default, this \
+    will use sudo to clean up the old releases, but if sudo is not available \
+    for your environment, set the :use_sudo variable to false instead.
+  DESC
+  task :cleanup, :except => { :no_release => true } do
+    count = fetch(:keep_releases, 5).to_i
+    if count >= releases.length
+      logger.important "no old releases to clean up"
+    else
+      logger.info "keeping #{count} of #{releases.length} deployed releases"
+
+      directories = (releases - releases.last(count)).map { |release|
+        File.join(releases_path, release) }.join(" ")
+
+      try_sudo "rm -rf #{directories}"
+    end
+  end
+
+  desc <<-DESC
+    Test deployment dependencies. Checks things like directory permissions, \
+    necessary utilities, and so forth, reporting on the things that appear to \
+    be incorrect or missing. This is good for making sure a deploy has a \
+    chance of working before you actually run `cap deploy'.
+
+    You can define your own dependencies, as well, using the `depend' method:
+
+      depend :remote, :gem, "tzinfo", ">=0.3.3"
+      depend :local, :command, "svn"
+      depend :remote, :directory, "/u/depot/files"
+  DESC
+  task :check, :except => { :no_release => true } do
+    dependencies = strategy.check!
+
+    other = fetch(:dependencies, {})
+    other.each do |location, types|
+      types.each do |type, calls|
+        if type == :gem
+          dependencies.send(location).command(fetch(:gem_command, "gem")).or("`gem' command could not be found. Try setting :gem_command")
+        end
+
+        calls.each do |args|
+          dependencies.send(location).send(type, *args)
+        end
+      end
+    end
+
+    if dependencies.pass?
+      puts "You appear to have all necessary dependencies installed"
+    else
+      puts "The following dependencies failed. Please check them and try again:"
+      dependencies.reject { |d| d.pass? }.each do |d|
+        puts "--> #{d.message}"
+      end
+      abort
+    end
+  end
+
+  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, and then \
+    instead of invoking `deploy:restart', it will invoke `deploy:start' to \
+    fire up the application servers.
+  DESC
+  task :cold do
+    update
+    start
+  end
+
+  desc <<-DESC
+    Start the daemon processes. This will attempt to invoke a script \
+    in your application called `bin/:application', with the 'start' parameter.
+
+    By default, the script will be executed via sudo as the `app' user. If \
+    you wish to run it as a different user, set the :runner variable to \
+    that user. If you are in an environment where you can't use sudo, set \
+    the :use_sudo variable to false.
+  DESC
+  task :start do
+    try_runner "/usr/bin/env DAEMON_ENV=#{fetch(:daemon_env)} #{current_path}/bin/#{application} start"
+  end
+
+  desc <<-DESC
+    Stop the daemon processes. This will call 'bin/:application stop'.
+
+    By default, the script will be executed via sudo as the `app' user. If \
+    you wish to run it as a different user, set the :runner variable to \
+    that user. If you are in an environment where you can't use sudo, set \
+    the :use_sudo variable to false.
+  DESC
+  task :stop do
+    try_runner "/usr/bin/env DAEMON_ENV=#{fetch(:daemon_env)} #{current_path}/bin/#{application} stop"
+  end
+
+  namespace :pending do
+    desc <<-DESC
+      Displays the `diff' since your last deploy. This is useful if you want \
+      to examine what changes are about to be deployed. Note that this might \
+      not be supported on all SCM's.
+    DESC
+    task :diff, :except => { :no_release => true } do
+      system(source.local.diff(current_revision))
+    end
+
+    desc <<-DESC
+      Displays the commits since your last deploy. This is good for a summary \
+      of the changes that have occurred since the last deploy. Note that this \
+      might not be supported on all SCM's.
+    DESC
+    task :default, :except => { :no_release => true } do
+      from = source.next_revision(current_revision)
+      system(source.local.log(from))
+    end
+  end
+end

data/rubygems_generators/install_rspec/templates/spec/spec_helper.rb

@@ -6,7 +6,7 @@ rescue LoadError
   require 'spec'
 end
 
-require File.dirname(__FILE__) + '/../config/boot'
+require File.dirname(__FILE__) + '/../config/environment'
 DaemonKit::Application.running!
 require '<%= gem_name %>'
 

data/test/test_daemon-kit_generator.rb

@@ -53,6 +53,15 @@ class TestDaemonKitGenerator < Test::Unit::TestCase
     assert_directory_exists "tasks"
     assert_directory_exists "vendor"
     assert_directory_exists "tmp"
+
+    assert !File.exists?("#{APP_ROOT}/Capfile"), 'Capfile generated, but should not be'
+  end
+
+  def test_generator_with_capistrano_deployer
+    run_generator('daemon_kit', [APP_ROOT, '-d capistrano'], sources)
+
+    assert_generated_file "Capfile"
+    assert_generated_file "config/deploy.rb"
   end
 
   private

data/test/test_deploy_capistrano_generator.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestDeployCapistranoGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "myapp"
+    run_generator('deploy_capistrano', [name], sources)
+    assert_generated_file   "Capfile"
+    assert_directory_exists "config"
+    assert_generated_file   "config/deploy.rb"
+    assert_directory_exists "config/deploy"
+    assert_generated_file   "config/deploy/staging.rb"
+    assert_generated_file   "config/deploy/production.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "daemon_generators"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: daemon-kit
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 +02:00
+date: 2009-05-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: 
+description: "Daemon Kit aims to simplify creating Ruby daemons by providing a sound application skeleton (through a generator), task specific generators (jabber bot, etc) and robust environment management code.  Using simple built-in generators it is easy to created evented and non-evented daemons that perform a multitude of different tasks.  Supported generators:  * Evented and non-evented Jabber Bot (coming next) * Evented and non-evented loops (coming soon) * Queue poller (SQS, AMQP, etc) (coming soon)"
 email: 
 - kenneth.kalmer@gmail.com
 executables: 
@@ -63,12 +63,13 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - PostInstall.txt
+- README.rdoc
 - TODO.txt
 files: 
 - History.txt
 - Manifest.txt
 - PostInstall.txt
-- README.textile
+- README.rdoc
 - Rakefile
 - TODO.txt
 - app_generators/daemon_kit/USAGE
@@ -95,6 +96,13 @@ files:
 - daemon_generators/cron/cron_generator.rb
 - daemon_generators/cron/templates/config/initializers/cron.rb
 - daemon_generators/cron/templates/libexec/daemon.rb
+- daemon_generators/deploy_capistrano/USAGE
+- daemon_generators/deploy_capistrano/deploy_capistrano_generator.rb
+- daemon_generators/deploy_capistrano/templates/Capfile
+- daemon_generators/deploy_capistrano/templates/config/deploy.rb
+- daemon_generators/deploy_capistrano/templates/config/deploy/production.rb
+- daemon_generators/deploy_capistrano/templates/config/deploy/staging.rb
+- daemon_generators/deploy_capistrano/templates/config/environments/staging.rb
 - daemon_generators/jabber/USAGE
 - daemon_generators/jabber/jabber_generator.rb
 - daemon_generators/jabber/templates/config/initializers/jabber.rb
@@ -111,6 +119,7 @@ files:
 - lib/daemon_kit/application.rb
 - lib/daemon_kit/config.rb
 - lib/daemon_kit/cron.rb
+- lib/daemon_kit/deployment/capistrano.rb
 - lib/daemon_kit/error_handlers/base.rb
 - lib/daemon_kit/error_handlers/hoptoad.rb
 - lib/daemon_kit/error_handlers/mail.rb
@@ -142,12 +151,13 @@ files:
 - test/test_cron_generator.rb
 - test/test_daemon-kit_generator.rb
 - test/test_daemon_kit_config.rb
+- test/test_deploy_capistrano_generator.rb
 - test/test_generator_helper.rb
 - test/test_helper.rb
 - test/test_jabber_generator.rb
 - test/test_nanite_agent_generator.rb
 has_rdoc: true
-homepage: 
+homepage: http://kit.rubyforge.org/daemon (coming soon)
 post_install_message: |+
   
   For more information on daemon-kit, see http://daemon-kit.rubyforge.org
@@ -157,7 +167,7 @@ post_install_message: |+
   
 rdoc_options: 
 - --main
-- README.textile
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -185,6 +195,7 @@ test_files:
 - test/test_cron_generator.rb
 - test/test_amqp_generator.rb
 - test/test_nanite_agent_generator.rb
-- test/test_daemon-kit_generator.rb
 - test/test_daemon_kit_config.rb
 - test/test_helper.rb
+- test/test_daemon-kit_generator.rb
+- test/test_deploy_capistrano_generator.rb