zend-framework-deploy 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "capistrano", "~> 2.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Fabio Napoleoni
+
+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.markdown

@@ -0,0 +1,91 @@
+# Deploying Zend Framework applications with zend-framework-deploy
+
+Tired to manually deploy your Zend Framework projects, this gem is for you. It will use
+the Capistrano framework adapted to fit ZF structure and files and removes Rails specific tasks.
+
+## Installation
+
+    $ gem install zend-framework-deploy
+
+## Usage
+
+    $ cd your-zf-project-root && zf-capify .
+
+This command will create the required files inside your ZF project. You can also use `-m` switch to
+use the [multistage extension](https://boxpanel.bluebox.net/public/the_vault/index.php/Capistrano_Multi_Stage_Instructions)
+of capistrano. The `-m` switch accepts a comma separated list of stages to create.
+
+## Requirements
+
+It depends on `capistrano` gem. If you want multistage support you should also install
+`capistano-ext` gem (it's not listed as dependency). [RVM](http://rvm.beginrescueend.com/) is
+strongly advised to install Ruby and RubyGems.
+
+## What tasks are included in the gem?
+
+These are the tasks adapted for Zend Framework projects included in my gem
+
+    cap deploy               # Deploys your project.
+    cap deploy:check         # Test deployment dependencies.
+    cap deploy:cleanup       # Clean up old releases.
+    cap deploy:install_zf    # Install Zend Framework in library path for the dep...
+    cap deploy:pending       # Displays the commits since your last deploy.
+    cap deploy:pending:diff  # Displays the `diff' since your last deploy.
+    cap deploy:rollback      # Rolls back to a previous version and restarts.
+    cap deploy:rollback:code # Rolls back to the previously deployed version.
+    cap deploy:setup         # Prepares one or more servers for deployment.
+    cap deploy:symlink       # Updates the symlink to the most recently deployed ...
+    cap deploy:update        # Copies your project and updates the symlink.
+    cap deploy:update_code   # Copies your project to the remote servers.
+    cap deploy:upload        # Copy files to the currently deployed version.
+    cap invoke               # Invoke a single command on the remote servers.
+    cap shell                # Begin an interactive Capistrano session.
+    cap web:disable          # Present a maintenance page to visitors.
+    cap web:enable           # Makes the application web-accessible again.
+
+## Zend Framework installation
+
+This gem provides a task named deploy:install_zf which is called by default deploy. This task relies on
+`zf_path` capistrano variable, so you must provide it in your `deploy.rb` file. This variable should contain
+the path for the ZF release, or if you have more than one version of ZF in your server, the base path for the
+installations. In the latter case you should have a dir structure like this one (in my case `zf_path` is set
+to `'/var/zend/`)
+
+    $ ls /var/zend/
+    ZendFramework-1.11.0
+    ZendFramework-1.11.5
+
+When you're following this convention you can use a file in your scm to control what version of ZF is copied
+in the library folder. To achieve this simply drop a file named `zf.version` in your `application/configs` folder
+ containing the required ZF version and the corresponding version is linked in your library folder.
+
+This approach works as far as your `index.php` contains the code generated from the zf tool, i.e. the following
+snippet of code is executed before requiring any ZF class.
+
+    // Ensure library/ is on include_path
+    set_include_path(implode(PATH_SEPARATOR, array(
+        realpath(APPLICATION_PATH . '/../library'),
+        get_include_path(),
+    )));
+
+I prepared a sample empty zf-capified application on github, you can fork it [here](https://github.com/fabn/zf-capified-sample)
+
+## Thanks to
+
+* Lee Hambley for his [Railsless Deploy Gem](https://github.com/leehambley/railsless-deploy)
+
+## Contributing to zend-framework-deploy
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Fabio Napoleoni. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "zend-framework-deploy"
+  gem.homepage = "http://github.com/fabn/zend-framework-deploy"
+  gem.license = "MIT"
+  gem.summary = %Q{Deploy Zend Framework applications with Capistrano}
+  gem.description = %Q{Use this gem to deploy Zend Framework projects with Capistrano. It will adapt Capistrano configuration in order to be used with ZF project structure.}
+  gem.email = "f.napoleoni@gmail.com"
+  gem.authors = ["Fabio Napoleoni"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/zf-capify

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+
+CONFIG_DIR = 'application/configs'
+stages = []
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-m [stage1,stage2]", "--multistage [stage1,stage2]", Array, "Uses multistage configuration") do |stges|
+    stages = stges
+  end
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to capify, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to capify."
+end
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+files = {
+  "Capfile" => unindent(<<-FILE),
+    require 'rubygems'
+    require 'zend-framework-deploy'
+    load    '#{CONFIG_DIR}/deploy'
+  FILE
+
+  "#{CONFIG_DIR}/deploy.rb" => 'set :application, "set your application name here"
+set :repository,  "set your repository location here"
+set :deploy_to, "set path where to deploy application"
+set :zf_path, "set Zend Framework (remote) installation path here"
+
+set :scm, :subversion
+# Or: `accurev`, `bzr`, `cvs`, `darcs`, `git`, `mercurial`, `perforce`, `subversion` or `none`
+
+role :web, "your web-server here"                          # Your HTTP server, Apache/etc
+'}
+
+# multistage patch
+unless stages.empty?
+  files["#{CONFIG_DIR}/deploy.rb"] << <<-MULTI
+
+# multistage setup, see https://boxpanel.bluebox.net/public/the_vault/index.php/Capistrano_Multi_Stage_Instructions
+set :default_stage, "#{stages.first}"
+set :stages, %w(#{stages.join(' ')})
+require 'capistrano/ext/multistage'
+MULTI
+  files.merge!(
+      stages.inject({}) do |hash, file|
+        hash["#{CONFIG_DIR}/deploy/" + file + '.rb'] = "# #{file} stage configuration goes here\n"
+        hash
+      end
+  )
+  puts "Multistage configuration selected, remember to install capistrano-ext gem with '[sudo] gem install capistrano-ext'"
+end
+
+base = ARGV.shift
+files.each do |file, content|
+  file = File.join(base, file)
+  if File.exists?(file)
+    warn "[skip] '#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] '#{file.downcase}' exists, which could conflict with `#{file}'"
+  else
+    unless File.exists?(File.dirname(file))
+      puts "[add] making directory '#{File.dirname(file)}'"
+      FileUtils.mkdir(File.dirname(file))
+    end
+    puts "[add] writing '#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
+  end
+end
+
+puts "[done] zf-capified!"

data/lib/zend-framework-deploy.rb

@@ -0,0 +1,498 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  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'" }
+  # this should be required
+  _cset(:deploy_to) { abort "Please specify where to deploy your application, set :deploy_to, '/some/path'" }
+  # zend framework(s) path installation (we don't have bundler...)
+  _cset(:zf_path) { abort "Please specify where is located zend framework on server, set :zf_path, '/path/to/zend/framework'" }
+
+  # =========================================================================
+  # These variables may be set in the client capfile if their default values
+  # are not sufficient.
+  # =========================================================================
+
+  _cset :scm, :subversion
+  _cset :deploy_via, :checkout
+
+  _cset(:revision)  { source.head }
+  # multistage config directory
+  _cset:stage_dir, "application/configs/deploy"
+
+  # =========================================================================
+  # 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"
+  # makes directories used by zend framework default project structure, see http://framework.zend.com/manual/en/project-structure.project.html
+  _cset :shared_children,   %w(system data) + %w(cache indexes locales logs sessions uploads).map { |d| File.join("data", d) }
+  _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 }
+
+  # Maintenance base filename
+  _cset :maintenance_basename, "maintenance"
+
+  # =========================================================================
+  # 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
+
+  # check if remote file exist
+  # inspired by http://stackoverflow.com/questions/1661586/how-can-you-check-to-see-if-a-file-exists-on-the-remote-server-in-capistrano/1662001#1662001
+  def remote_file_exists?(full_path)
+    'true' ==  capture("if [ -e #{full_path} ]; then echo 'true'; fi").strip
+  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. Handy wrapper to hook into the beginning of the deployment. 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
+    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
+      Install Zend Framework in library path for the deployed application. \
+      If multiple versions of ZF exists in the :zf_path and a config file \
+      zf.version is found in the application/configs folder, then it try to link \
+      the given version. Otherwise the :zf_path is assumed to be the root path of the \
+      full Zend Framework release.
+    DESC
+    task :install_zf, :except => { :no_release => true } do
+      version_file = "#{release_path}/application/configs/zf.version"
+      # get the zf root as defined in the configuration
+      zf_root = "#{zf_path}"
+      # append version if zf.version file exists
+      zf_root << "/ZendFramework-#{capture("cat #{version_file}").strip}" if remote_file_exists? version_file
+      # check correctness of given version of ZF
+      run "test -d #{zf_root}/library/Zend -a -d #{zf_root}/extras/library/ZendX"
+      # link Zend Framework libraries in the library path
+      run "ln -s #{zf_root}/library/Zend #{zf_root}/extras/library/ZendX #{release_path}/library"
+    end
+
+    desc <<-DESC
+      [internal] Touches up the released code. This is called by update_code \
+      after the basic deploy finishes. It assumes a standard ZF 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 data and system, directories. \
+      Lastly it will install Zend Framework library in the library folder \
+      using the install_zf task provided.
+    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, link the shared data folder
+      run <<-CMD
+        rm -rf #{latest_release}/data &&
+        ln -s #{shared_path}/data #{latest_release}/data
+      CMD
+      # install Zend Framework in library folder
+      install_zf
+      # link system subdir
+      run "rm -rf #{latest_release}/public/system && ln -s #{shared_path}/system #{latest_release}/public/system"
+    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
+
+    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.
+      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
+        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
+
+    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
+
+  namespace :web do
+    desc <<-DESC
+      Present a maintenance page to visitors. Disables your application's web \
+      interface by writing a "#{maintenance_basename}.html" file to each web server. The \
+      servers must be configured to detect the presence of this file, and if \
+      it is present, always display it instead of performing the request.
+
+      By default, the maintenance page will just say the site is down for \
+      "maintenance", and will be back "shortly", but you can customize the \
+      page by specifying the REASON and UNTIL environment variables:
+
+        $ cap deploy:web:disable \\
+              REASON="hardware upgrade" \\
+              UNTIL="12pm Central Time"
+
+      Further customization will require that you write your own task.
+    DESC
+    task :disable, :roles => :web, :except => { :no_release => true } do
+      require 'erb'
+      on_rollback { run "rm #{shared_path}/system/#{maintenance_basename}.html" }
+
+      warn <<-EOHTACCESS
+
+        # Please add something like this to your site's htaccess to redirect users to the maintenance page.
+        # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
+
+        ErrorDocument 503 /system/#{maintenance_basename}.html
+        RewriteEngine On
+        RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
+        RewriteCond %{DOCUMENT_ROOT}/system/#{maintenance_basename}.html -f
+        RewriteCond %{SCRIPT_FILENAME} !#{maintenance_basename}.html
+        RewriteRule ^.*$  -  [redirect=503,last]
+      EOHTACCESS
+
+      reason = ENV['REASON']
+      deadline = ENV['UNTIL']
+
+      # get maintainance template from capistrano gem
+      cap_path = Gem.searcher.find("capistrano").full_gem_path
+      template = File.read(File.join(cap_path, "lib", "capistrano", "recipes", "templates", "maintenance.rhtml"))
+      result = ERB.new(template).result(binding)
+
+      put result, "#{shared_path}/system/#{maintenance_basename}.html", :mode => 0644
+    end
+
+    desc <<-DESC
+      Makes the application web-accessible again. Removes the \
+      "#{maintenance_basename}.html" page generated by deploy:web:disable, which (if your \
+      web servers are configured correctly) will make your application \
+      web-accessible again.
+    DESC
+    task :enable, :roles => :web, :except => { :no_release => true } do
+      run "rm #{shared_path}/system/#{maintenance_basename}.html"
+    end
+  end
+
+end # Capistrano::Configuration.instance(:must_exist).load do

data/zend-framework-deploy.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zend-framework-deploy}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fabio Napoleoni"]
+  s.date = %q{2011-05-03}
+  s.default_executable = %q{zf-capify}
+  s.description = %q{Use this gem to deploy Zend Framework projects with Capistrano. It will adapt Capistrano configuration in order to be used with ZF project structure.}
+  s.email = %q{f.napoleoni@gmail.com}
+  s.executables = ["zf-capify"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "bin/zf-capify",
+    "lib/zend-framework-deploy.rb",
+    "zend-framework-deploy.gemspec"
+  ]
+  s.homepage = %q{http://github.com/fabn/zend-framework-deploy}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Deploy Zend Framework applications with Capistrano}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, ["~> 2.5"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+    else
+      s.add_dependency(%q<capistrano>, ["~> 2.5"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, ["~> 2.5"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+  end
+end
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: zend-framework-deploy
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Fabio Napoleoni
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-03 00:00:00 +02:00
+default_executable: zf-capify
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: capistrano
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  requirement: *id003
+description: Use this gem to deploy Zend Framework projects with Capistrano. It will adapt Capistrano configuration in order to be used with ZF project structure.
+email: f.napoleoni@gmail.com
+executables: 
+- zf-capify
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- bin/zf-capify
+- lib/zend-framework-deploy.rb
+- zend-framework-deploy.gemspec
+has_rdoc: true
+homepage: http://github.com/fabn/zend-framework-deploy
+licenses: 
+- MIT
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Deploy Zend Framework applications with Capistrano
+test_files: []
+