chicken_soup 0.6.1 → 0.8.0

data/lib/chicken_soup/capabilities/apache/apache-checks.rb

@@ -2,8 +2,6 @@
 #                            APACHE CHECKS                           #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :variable do
       namespace :check do

data/lib/chicken_soup/capabilities/apache/apache-defaults.rb

@@ -2,27 +2,22 @@
 #                          APACHE DEFAULTS                           #
 ######################################################################
 module ChickenSoup
-  def find_web_server_control_script
-    if remote_file_exists?("/usr/sbin/apachectl")
-      set :web_server_control_script,   "/usr/sbin/apachectl"
-    elsif remote_file_exists?("/usr/sbin/apache2")
-      set :web_server_control_script,   "/usr/sbin/apache2"
-    elsif remote_file_exists?("/usr/sbin/httpd")
-      set :web_server_control_script,   "/usr/sbin/httpd"
-    end
-
-    abort "Couldn't figure out how to control your installation of Apache" unless exists?(:web_server_control_script)
+  module WebServer
+    STANDARD_CONTROL_SCRIPTS = ['/usr/sbin/apachectl', '/usr/sbin/apache2', '/usr/sbin/httpd']
+    STANDARD_LOG_LOCATIONS   = ['/var/log/apache2', '/var/log/httpd', '/etc/httpd/logs']
+    STANDARD_ERROR_LOGS      = ['error_log', 'error.log', 'httpd-error.log']
+    STANDARD_ACCESS_LOGS     = ['access_log', 'access.log', 'httpd-access.log']
   end
 end
 
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
+  require   'chicken_soup/capabilities/shared/web_server-defaults'
 
   namespace :capabilities do
     namespace :defaults do
       desc "[internal] Sets intelligent defaults for Apache deployments."
       task :apache do
-        find_web_server_control_script
+        capabilities.defaults.web_server
 
         if web_server_control_script =~ /apache2/
           set :apache_enable_script,    "a2ensite"

data/lib/chicken_soup/capabilities/bundler/bundler-checks.rb

@@ -2,8 +2,6 @@
 #                           BUNDLER CHECKS                           #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :variable do
       namespace :check do

data/lib/chicken_soup/capabilities/bundler/bundler-defaults.rb

@@ -2,8 +2,6 @@
 #                          BUNDLER DEFAULTS                          #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :defaults do
       desc "[internal] Sets intelligent defaults for Bundler deployments."

data/lib/chicken_soup/capabilities/bundler/bundler-tasks.rb

@@ -2,8 +2,6 @@
 #                           BUNDLER TASKS                            #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   before    'gems:install',       'bundler:install'
 
   run_task  'bundler:install',    :as => manager_username

data/lib/chicken_soup/capabilities/heroku/heroku-checks.rb

@@ -2,8 +2,6 @@
 #                           HEROKU CHECKS                            #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :variable do
       namespace :check do

data/lib/chicken_soup/capabilities/heroku/heroku-defaults.rb

@@ -2,8 +2,6 @@
 #                           HEROKU DEFAULTS                          #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :defaults do
       desc "[internal] Sets intelligent defaults for Heroku deployments"

data/lib/chicken_soup/capabilities/nginx/nginx-checks.rb

@@ -2,8 +2,6 @@
 #                             NGINX CHECKS                           #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :variable do
       namespace :check do

data/lib/chicken_soup/capabilities/nginx/nginx-defaults.rb

@@ -2,23 +2,22 @@
 #                           NGINX DEFAULTS                           #
 ######################################################################
 module ChickenSoup
-  def find_web_server_control_script
-    if remote_file_exists?("/etc/init.d/nginx")
-      set :web_server_control_script,   "/etc/init.d/nginx"
-    end
-
-    abort "Couldn't figure out how to control your installation of Nginx" unless exists?(:web_server_control_script)
+  module WebServer
+    STANDARD_CONTROL_SCRIPTS = ['/etc/init.d/nginx']
+    STANDARD_LOG_LOCATIONS   = ['/var/log/nginx', '/var/log/nginx/current']
+    STANDARD_ERROR_LOGS      = ['error.log']
+    STANDARD_ACCESS_LOGS     = ['access.log']
   end
 end
 
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
+  require   'chicken_soup/capabilities/shared/web_server-defaults'
 
   namespace :capabilities do
     namespace :defaults do
       desc "[internal] Checks to see what type of Nginx installation is running on the remote."
       task :nginx do
-        find_web_server_control_script
+        capabilities.defaults.web_server
       end
     end
   end

data/lib/chicken_soup/capabilities/passenger/passenger-defaults.rb

@@ -1,10 +1,18 @@
 ######################################################################
 #                       PASSENGER DEFAULTS                           #
 ######################################################################
+module ChickenSoup
+  module ApplicationServer
+    STANDARD_LOGS = ['passenger_log', 'passenger.log', 'passenger']
+  end
+end
+
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :capabilities do
     namespace :defaults do
-      set :application_server_type,   :passenger
+      task :passenger do
+        set :application_server_type,   :passenger
+      end
     end
   end
 end

data/lib/chicken_soup/capabilities/rvm/rvm-checks.rb

@@ -2,8 +2,6 @@
 #                             RVM CHECKS                             #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :variable do
       namespace :check do

data/lib/chicken_soup/capabilities/rvm/rvm-defaults.rb

@@ -6,24 +6,24 @@ module ChickenSoup
 end
 
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :defaults do
-      _cset :rvmrc_file,                    File.join(rails_root, '.rvmrc')
-      set   :ruby_version_update_pending,   false
+      task :rvm do
+        _cset :rvmrc_file,                    File.join(rails_root, '.rvmrc')
+        set   :ruby_version_update_pending,   false
 
-      _cset(:ruby_version)        do
-        contents = File.read(rvmrc_file)
-        contents.match(ChickenSoup::RVM_INFO_FORMAT)[2]
-      end
+        _cset(:ruby_version)        do
+          contents = File.read(rvmrc_file)
+          contents.match(ChickenSoup::RVM_INFO_FORMAT)[2]
+        end
 
-      _cset(:ruby_gemset)         do
-        contents = File.read(rvmrc_file)
-        contents.match(ChickenSoup::RVM_INFO_FORMAT)[3]
-      end
+        _cset(:ruby_gemset)         do
+          contents = File.read(rvmrc_file)
+          contents.match(ChickenSoup::RVM_INFO_FORMAT)[3]
+        end
 
-      _cset(:full_ruby_environment_string)      {ruby_gemset ? "#{ruby_version}@#{ruby_gemset}" : ruby_version}
+        _cset(:full_ruby_environment_string)      {ruby_gemset ? "#{ruby_version}@#{ruby_gemset}" : ruby_version}
+      end
     end
   end
 end

data/lib/chicken_soup/capabilities/rvm/rvm-tasks.rb

@@ -8,8 +8,6 @@ module ChickenSoup
 end
 
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   run_task 'ruby:update', :as => manager_username
 
   namespace :ruby do

data/lib/chicken_soup/capabilities/shared/db-checks.rb

@@ -2,8 +2,6 @@
 #                              DB CHECKS                             #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :variable do
       namespace :check do
@@ -13,7 +11,11 @@ Capistrano::Configuration.instance(:must_exist).load do
         task :db do
           required_variables = [
             :skip_backup_before_migration,
-            :db_backups_path
+            :db_backups_path,
+            :db_backup_file_extension,
+            :autocompress_db_backups,
+            :limit_db_backups,
+            :total_db_backup_limit
           ]
 
           verify_variables(required_variables)

data/lib/chicken_soup/capabilities/shared/db-defaults.rb

@@ -2,14 +2,22 @@
 #                             DB DEFAULTS                            #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :defaults do
       desc "[internal] Sets intelligent defaults for DB deployments."
       task :db do
         _cset :skip_backup_before_migration,  false
+
         _cset :db_backups_path,               "#{shared_path}/db_backups"
+        _cset :db_backup_file_extension,      "dump.sql"
+
+        _cset :autocompress_db_backups,       true
+
+        set(:latest_db_backup_file)           {capture("ls #{db_backups_path} -1t | head -n 1").chomp}
+        set(:latest_db_backup)                {"#{db_backups_path}/#{latest_db_backup_file}"}
+
+        _cset :limit_db_backups,              true
+        _cset :total_db_backup_limit,         100
       end
     end
   end

data/lib/chicken_soup/capabilities/shared/db-tasks.rb

@@ -2,8 +2,6 @@
 #                          COMMON DB TASKS                           #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   _cset(:db_root_password)    {Capistrano::CLI.password_prompt("Root Password For DB: ")}
   _cset(:db_app_password)     {Capistrano::CLI.password_prompt("App Password For DB: ")}
 
@@ -11,20 +9,71 @@ Capistrano::Configuration.instance(:must_exist).load do
   run_task  "db:drop",         :as => manager_username
 
   before    "deploy:cleanup",  "deploy:migrate"
-  before    "deploy:migrate",  "db:backup"        unless skip_backup_before_migration
+  before    "deploy:migrate",  "db:backup"            unless skip_backup_before_migration
 
-  namespace :db do
-    desc <<-DESC
-      Calls the rake task `db:backup` on the server for the given environment.
+  after     "db:backup",       "db:backup:compress"   if autocompress_db_backups
+  after     "db:backup",       "db:backup:cleanup"    if limit_db_backups
 
-      * The backup file is placed in a directory called `db_backups` under the `shared`
-        directory by default.
-      * The filenames are formatted with the timestamp of the backup.
-      * After export, each file is zipped up using a bzip2 compression format.
-    DESC
+  namespace :db do
     namespace :backup do
+      desc <<-DESC
+        Calls the rake task `db:backup` on the server for the given environment.
+
+        * The backup file is placed in a directory called `db_backups` under the `shared`
+          directory by default.
+        * The filenames are formatted with the timestamp of the backup.
+        * After export, each file is zipped up using a bzip2 compression format.
+      DESC
       task :default, :roles => :db, :only => {:primary => true} do
-        run "cd #{current_path} && BACKUP_DIRECTORY=#{db_backups_path} #{rake} db:backup"
+        run %Q{cd #{current_path} && BACKUP_DIRECTORY="#{db_backups_path}" BACKUP_FILE="#{release_name}" BACKUP_FILE_EXTENSION="#{db_backup_file_extension}" #{rake} db:backup}
+      end
+
+      desc <<-DESC
+        If the user has decided they would like to limit the number of db backups
+        that can exist on the system, this task is called to clean up any files
+        which are over that limit.
+
+        The oldest files are cleaned up first.
+      DESC
+      task :cleanup, :roles => :db, :only => {:primary => true} do
+        number_of_backups = capture("ls #{db_backups_path} -1 | wc -l").chomp.to_i
+
+        if number_of_backups > total_db_backup_limit
+          backup_files_to_remove = capture("ls #{db_backups_path}/* -1t | tail -n #{number_of_backups - total_db_backup_limit}").chomp.split("\n")
+
+          backup_files_to_remove.each do |file|
+            run "rm -f #{file}"
+          end
+        end
+      end
+
+      namespace :compress do
+        desc <<-DESC
+          Compresses the most recent backup if it isn't already compressed.
+
+          The compression format is bzip2.
+        DESC
+        task :default, :roles => :db, :only => {:primary => true} do
+          run "bzip2 -zvck9 #{latest_db_backup} > #{latest_db_backup}.bz2 && rm -f #{latest_db_backup}" unless compressed_file?(latest_db_backup)
+
+          # After compressing, the latest_db_backup is no longer the latest DB
+          # backup so we need to reset it.
+          reset! :latest_db_backup_file
+          reset! :latest_db_backup
+        end
+
+        desc <<-DESC
+          Compresses any uncompressed DB backups to help save space.
+
+          The compression format is bzip2.
+        DESC
+        task :all, :roles => :db, :only => {:primary => true} do
+          uncompressed_backup_files = capture("ls #{db_backups_path}/*.#{db_backup_file_extension} -1tr").chomp.split("\n")
+
+          uncompressed_backup_files.each do |file|
+            run "bzip2 -zvck9 #{file} > #{file}.bz2 && rm -f #{file}"
+          end
+        end
       end
     end
 
@@ -49,12 +98,15 @@ Capistrano::Configuration.instance(:must_exist).load do
         Just like `db:pull` but doesn't create a new backup first.
       DESC
       task :latest, :roles => :db, :only => {:primary => true} do
-        latest_backup = capture(%Q{ls #{db_backups_path} -xtC | head -n 1 | cut -d " " -f 1}).chomp
+        download_compressed "#{latest_db_backup}", "#{rails_root}/tmp/#{latest_db_backup_file}", :once => true
 
-        download_compressed "#{db_backups_path}/#{latest_backup}", "#{rails_root}/tmp/#{latest_backup}", :once => true
+        latest_local_db_backup = `ls -1t #{rails_root}/tmp/*.#{db_backup_file_extension} | head -n 1`.chomp
 
+        puts 'Running `rake db:drop:all db:create:all` locally'
         `rake db:drop:all db:create:all`
-        `rails dbconsole development < #{rails_root}/tmp/#{latest_backup}`
+        puts "Running `rails dbconsole development < #{latest_local_db_backup}` locally"
+        `rails dbconsole development < #{latest_local_db_backup}`
+        puts "Running `rake db:migrate db:test:prepare` locally"
         `rake db:migrate db:test:prepare`
       end
     end

data/lib/chicken_soup/capabilities/shared/web_server-defaults.rb

@@ -0,0 +1,13 @@
+######################################################################
+#                       WEB SERVER DEFAULTS                          #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :defaults do
+      desc "[internal] Sets common defaults for web servers."
+      task :web_server do
+        _cset(:web_server_control_script)   { WebServer::STANDARD_CONTROL_SCRIPTS.detect { |f| remote_directory_exists? f } }
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/shared/web_server-tasks.rb

@@ -2,8 +2,6 @@
 #                    COMMON WEB SERVER TASKS                         #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   run_task  'web_server:stop',            :as => manager_username
   run_task  'web_server:start',           :as => manager_username
   run_task  'web_server:restart',         :as => manager_username
@@ -50,7 +48,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         web-accessible again.
       DESC
       task :disable, :roles => :web do
-        run "rm #{shared_path}/system/maintenance.html"
+        run "rm #{shared_path}/system/#{maintenance_basename}.html"
       end
 
       desc <<-DESC
@@ -70,15 +68,15 @@ Capistrano::Configuration.instance(:must_exist).load do
         Further customization will require that you write your own task.
       DESC
       task :enable, :roles => :web do
-        on_rollback { rm "#{shared_path}/system/maintenance.html" }
+        on_rollback { rm "#{shared_path}/system/#{maintenance_basename}.html" }
 
         require 'erb'
         deadline, reason = ENV['UNTIL'], ENV['REASON']
 
-        template = File.read("./public/maintenance.html.erb")
+        template = File.read(maintenance_filename)
         maintenance_page = ERB.new(template).result(binding)
 
-        put maintenance_page, "#{shared_path}/system/maintenance.html", :mode => 0644
+        put maintenance_page, "#{shared_path}/system/#{maintenance_basename}.html", :mode => 0644
       end
     end
   end

data/lib/chicken_soup/capabilities/svn/svn-defaults.rb

@@ -2,8 +2,6 @@
 #                         SUBVERSION DEFAULTS                        #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :defaults do
       desc "[internal] Sets intelligent version control defaults for deployments"

data/lib/chicken_soup/capabilities/unix/unix-checks.rb

@@ -2,8 +2,6 @@
 #                             UNIX CHECKS                            #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :variable do
       namespace :check do
@@ -24,9 +22,9 @@ Capistrano::Configuration.instance(:must_exist).load do
             :app_server_ip,
             :web_server_ip,
             :db_server_ip,
-            :web_servers,
-            :app_servers,
-            :db_servers
+            :web_server_name,
+            :app_server_name,
+            :db_server_name
           ]
 
           verify_variables(required_variables)

data/lib/chicken_soup/capabilities/unix/unix-defaults.rb

@@ -2,8 +2,6 @@
 #                         UNIX SERVER DEFAULTS                       #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :capabilities do
     namespace :defaults do
       desc "[internal] Sets intelligent defaults for unix server deployments."
@@ -19,15 +17,16 @@ Capistrano::Configuration.instance(:must_exist).load do
         _cset :deploy_site_name,      domain
         set   :deploy_to,             "#{deploy_base_dir}/#{deploy_site_name}"
 
-        _cset :app_server_ip,         default_server_ip
-        _cset :web_server_ip,         default_server_ip
-        _cset :db_server_ip,          default_server_ip
-
         _cset :default_server_name,   domain
+        _cset(:default_server_ip)     { lookup_ip_for default_server_name }
+
+        _cset(:app_server_name)       { default_server_name }
+        _cset(:web_server_name)       { default_server_name }
+        _cset(:db_server_name)        { default_server_name }
 
-        _cset(:app_servers)           { default_server_name }
-        _cset(:web_servers)           { default_server_name }
-        _cset(:db_servers)            { default_server_name }
+        _cset(:app_server_ip)         { lookup_ip_for app_server_name }
+        _cset(:web_server_ip)         { lookup_ip_for web_server_name }
+        _cset(:db_server_ip)          { lookup_ip_for db_server_name  }
 
         # Evidently roles can't be assigned in a namespace :-/
         set_unix_server_roles
@@ -37,8 +36,8 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   desc "[internal] This task is only here because `role` cannot be used within a `namespace`"
   task :set_unix_server_roles do
-    role :web,                  web_servers
-    role :app,                  app_servers
-    role :db,                   db_servers, :primary => true
+    role :web,                  web_server_name
+    role :app,                  app_server_name
+    role :db,                   db_server_name, :primary => true
   end
 end

data/lib/chicken_soup/capabilities/unix/unix-tasks.rb

@@ -2,8 +2,6 @@
 #                             UNIX TASKS                             #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   before "deploy:shared_files:symlink",        "deploy:shared_files:setup"
 
   namespace :deploy do

data/lib/chicken_soup/capabilities.rb

@@ -14,8 +14,6 @@
 #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   require 'chicken_soup/capabilities/defaults'
   require 'chicken_soup/capabilities/checks'
   require 'chicken_soup/capabilities/tasks'

data/lib/chicken_soup/environment/checks.rb

@@ -6,8 +6,8 @@
 # First, an environment MUST be present in order for any deployment
 # to happen.  It's a safety measure that this is explicitly stated.
 #
-# It also checks to make sure that the :application and
-# :application_short environment variables have been set.
+# It also checks to make sure that the :application environment
+# variable has been set.
 #
 # This happens before any of the capabilities have been added to the
 # deployment and therefore that is all we know to check for at this
@@ -15,8 +15,6 @@
 #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   on      :start,                         'environment:variable:check',  :except => ['staging', 'production']
   before  'deploy',                       'environment:deployment:check'
   before  'deploy:cold',                  'environment:deployment:check'
@@ -33,8 +31,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         abort "You need to specify a deployment type in your application's 'deploy.rb' file. ie 'set :deployment_type, :heroku'" unless exists?(:deployment_type)
 
         required_variables = [
-          :application,
-          :application_short
+          :application
         ]
 
         verify_variables(required_variables)

data/lib/chicken_soup/environment/defaults.rb

@@ -20,23 +20,25 @@
 require 'etc'
 
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   after   'production',                 'environment:defaults:production', 'environment:init'
   after   'staging',                    'environment:defaults:staging',    'environment:init'
 
-  after   'environment:defaults',       'capabilities:defaults', 'notifiers:defaults'
+  after   'environment:defaults',       'capabilities:defaults', 'notifiers:defaults', 'tools:defaults'
 
   namespace :environment do
     namespace :defaults do
       desc "[internal] Used to set up the intelligent staging defaults we like for our projects"
       task :staging do
         set :rails_env,                 'staging'
+
+        _cset(:domain)                  { "staging.#{application}.com" }
       end
 
       desc "[internal] Used to set up the intelligent production defaults we like for our projects"
       task :production do
         set :rails_env,                 'production'
+
+        _cset(:domain)                  { "#{application}.com" }
       end
 
       desc "[internal] Sets intelligent common defaults for deployments"
@@ -51,10 +53,15 @@ Capistrano::Configuration.instance(:must_exist).load do
 
         _cset :global_shared_elements,    ["config/database.yml"]
 
+        _cset :maintenance_page_path,     'public'
+
         _cset :notifiers,                 []
+        _cset :tools,                     [:log]
 
-        _cset(:application_short)         {application}
         _cset(:application_underscored)   {application.gsub(/-/, "_")}
+
+        _cset(:latest_release_name)       {exists?(:deploy_timestamped) ? release_name : releases.last}
+        _cset(:previous_release_name)     {releases.length > 1 ? releases[-2] : nil}
       end
     end
   end

data/lib/chicken_soup/environment/tasks.rb

@@ -2,7 +2,7 @@
 #                         ENVIRONMENT TASKS                          #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  after  'environment:load_tasks',      'capabilities:load_tasks', 'notifiers:load_tasks'
+  after  'environment:load_tasks',      'capabilities:load_tasks', 'notifiers:load_tasks', 'tools:load_tasks'
 
   namespace :environment do
     desc "[internal] A helper task used to load the tasks for all of the capabilities."

data/lib/chicken_soup/global.rb

@@ -115,7 +115,13 @@ module ChickenSoup
   #   remote_file_exists? '/var/www/myappdir/current'
   #
   def remote_file_exists?(file)
-    capture("if [[ -d #{file} ]] || [[ -h #{file} ]] || [[ -f #{file} ]]; then echo -n 'exists'; fi;") == "exists"
+    capture("if [[ -d #{file} ]] || [[ -h #{file} ]] || [[ -f #{file} ]]; then echo -n 'exists'; fi;") == 'exists'
+  end
+
+  def remote_directory_exists?(directory, options = {})
+    with_files_check = options[:with_files] ? "&& $(ls -A #{directory})" : ''
+
+    capture("if [[ -d #{directory} #{with_files_check} ]]; then echo -n 'exists'; fi") == 'exists'
   end
 
   ###
@@ -152,16 +158,40 @@ module ChickenSoup
   #   download_compressed 'my/remote/file', 'my/local/file', :once => true
   #
   def download_compressed(remote, local, options = {})
-    remote_compressed_filename = "#{remote}.bz2"
-    local_compressed_filename  = "#{local}.bz2"
+    remote_basename              = File.basename(remote)
+
+    unless compressed_file? remote
+      remote_compressed_filename = "#{user_home}/#{remote_basename}.bz2"
+      local_compressed_filename  = "#{local}.bz2"
+
+      run "bzip2 -zvck9 #{remote} > #{remote_compressed_filename}"
+    end
+
+    remote_compressed_filename  ||= remote
+    local_compressed_filename   ||= local
 
-    run "bzip2 -zvck9 #{remote} > #{remote_compressed_filename}"
     download remote_compressed_filename, local_compressed_filename, options
 
-    run "rm -f #{remote_compressed_filename}"
+    run "rm -f #{remote_compressed_filename}" unless remote_compressed_filename == remote
     `bunzip2 -f #{local_compressed_filename} && rm -f #{local_compressed_filename}`
   end
 
+  ###
+  # Checks to see if a filename has an extension which would imply that
+  # it is compressed.
+  #
+  # @param [String] filename The filename whose extension will be checked.
+  #
+  # @return [Boolean] the result of whether the file has a compression
+  # extension.
+  #
+  # @example
+  #   compressed_file? 'file.bz2'
+  #
+  def compressed_file?(filename)
+    filename =~ /.*\.bz2/
+  end
+
   ###
   # A stub method which simply passes through to Capistrano's #run.  This
   # method is meant to be overridden when a Ruby manager capability (ie RVM)
@@ -195,4 +225,67 @@ module ChickenSoup
   def vc_log
     nil
   end
+
+  ###
+  # Uses nslookup locally to figure out the IP address of the provided
+  # hostname.
+  #
+  # @param [String] hostname The hostname you would like to retrieve the
+  # IP for.
+  #
+  # @return [String] The IP address of the provided hostname.  If no
+  # IP can be retrieved, nil will be returned.
+  #
+  # @example
+  #   lookup_ip_for 'google.com'
+  #
+  def lookup_ip_for(hostname)
+    ip = `nslookup #{hostname} | tail -n 2 | head -n 1 | cut -d ' ' -f 2`.chomp
+    ip != '' ? ip : nil
+  end
+
+  def find_all_logs(log_directory, log_filenames)
+    existing_files = []
+
+    log_filenames.each do |standard_file|
+      existing_files << "#{log_directory}/#{application}.#{standard_file}" if remote_file_exists?("#{log_directory}/#{application}.#{standard_file}")
+      existing_files << "#{log_directory}/#{application}-#{standard_file}" if remote_file_exists?("#{log_directory}/#{application}-#{standard_file}")
+      existing_files << "#{log_directory}/#{standard_file}"                if remote_file_exists?("#{log_directory}/#{standard_file}")
+    end
+
+    existing_files
+  end
+
+  def log_directory(log_directories)
+    log_directories.detect do |directory|
+      remote_directory_exists? directory, :with_files => true
+    end
+  end
+
+  def fetch_log(logs)
+    logs.each do |log|
+      local_log_directory = "#{rails_root}/log/#{rails_env}/#{release_name}"
+
+      `mkdir -p #{local_log_directory}`
+      download log, "#{local_log_directory}/$CAPISTRANO:HOST$-#{File.basename(log)}"
+    end
+  end
+
+  def tail_log(logs)
+    run "tail -n #{ENV['lines'] || 20} -f #{logs.join ' '}" do |channel, stream, data|
+      trap("INT") { puts 'Log tailing aborted...'; exit 0; }
+
+      puts  # for an extra line break before the host name
+      puts "#{channel[:host]}: #{data}"
+
+      break if stream == :err
+    end
+  end
+
+  def maintenance_filename
+    custom_maintenance_path   = File.join(rails_root, maintenance_page_path, "#{maintenance_basename}.html.erb")
+    template_maintenance_path = File.join(File.dirname(__FILE__), "templates", "maintenance.html.erb")
+
+    File.exist?(custom_maintenance_path) ? custom_maintenance_path : template_maintenance_path
+  end
 end

data/lib/chicken_soup/notifiers/email/email-checks.rb

@@ -2,8 +2,6 @@
 #                       EMAIL NOTIFIER CHECKS                        #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   namespace :notifiers do
     namespace :variable do
       namespace :check do

data/lib/chicken_soup/notifiers/email/email-defaults.rb

@@ -6,8 +6,6 @@ require 'erb'
 require 'chicken_soup/notifiers/email/presenter'
 
 Capistrano::Configuration.instance(:must_exist).load do |cap|
-  extend ChickenSoup
-
   namespace :notifiers do
     namespace :defaults do
       task :email do

data/lib/chicken_soup/notifiers/email/presenter.rb

@@ -3,8 +3,6 @@ require 'time'
 module ChickenSoup
   module Email
     class Presenter
-      include ChickenSoup
-
       LongDateFormat = "%A, %B %e, %Y at %l:%M%p %Z"
 
       def initialize(capistrano)
@@ -24,11 +22,11 @@ module ChickenSoup
       end
 
       def deploy_date_in_long_format
-        format_timestamp(@capistrano[:current_release], LongDateFormat)
+        format_timestamp(@capistrano[:latest_release_name], LongDateFormat)
       end
 
       def previous_deploy_date_in_long_format
-        format_timestamp(@capistrano[:previous_release], LongDateFormat)
+        format_timestamp(@capistrano[:previous_release_name], LongDateFormat)
       end
 
       def notifiers

data/lib/chicken_soup/notifiers/git/git-tasks.rb

@@ -19,9 +19,9 @@ Capistrano::Configuration.instance(:must_exist).load do
         Tag push happens in the background so it won't slow down deployment.
       DESC
       task :tag do
-        tag_name = "deployment/#{rails_env}/#{current_release}"
+        tag_name = "deployment/#{rails_env}/#{latest_release_name}"
 
-        `git tag -a -m "Tagging deploy to #{rails_env} at #{current_release}" #{tag_name} #{branch}`
+        `git tag -a -m "Tagging deploy to #{rails_env} at #{latest_release_name}" #{tag_name} #{branch}`
         `git push #{remote} --tags > /dev/null 2>&1 &`
         `git push origin --tags > /dev/null 2>&1 &`
       end

data/lib/chicken_soup/notifiers.rb

@@ -2,8 +2,6 @@
 #                           NOTIFIERS SETUP                          #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  extend ChickenSoup
-
   require 'chicken_soup/notifiers/defaults'
   require "chicken_soup/notifiers/checks"
   require "chicken_soup/notifiers/tasks"

data/lib/chicken_soup/templates/maintenance.html.erb

@@ -0,0 +1,41 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body {
+      background-color: #fff;
+      color: #666;
+      text-align: center;
+      font-family: arial, sans-serif;
+    }
+
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+
+    h1 {
+      font-size: 100%;
+      color: #f00;
+      line-height: 1.5em;
+    }
+  </style>
+</head>
+
+<body>
+
+<div class="dialog">
+  <h1>The application is currently down for <%= reason || "maintenance" %>.</h1>
+
+  <p>As of <%= Time.now.strftime("%H:%M %Z") %> this application was taken offline. We apologize for the inconvenience and are doing everything we can to have the site back up <%= deadline ? "by #{deadline}" : "shortly" %>.</p>
+</div>
+</body>
+</html>

data/lib/chicken_soup/tools/defaults.rb

@@ -0,0 +1,41 @@
+######################################################################
+#                       DEFAULT TOOLS SETUP
+#
+# The 'tools:defaults' task hooks itself into the deployment
+# stream by attaching an after hook to 'environment:defaults'.
+#
+# Prior to execution, all of the tools which were specified in
+# the deploy.rb file are loaded and then each tool has its
+# 'defaults' task called.
+#
+# All tools's defaults tasks are in the format:
+#   tools:defaults:<tool_name>
+#
+# Defaults tasks are there simply to set standard conventional
+# standards on each tool.  In almost all cases, they can
+# be overridden.
+#
+# Defaults are also optional.  If a tools doesn't require any
+# environment variables to be set, it can simply omit a defaults task.
+#
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  before  'tools:defaults',      'load_tool_defaults'
+
+  namespace :tools do
+    namespace :defaults do
+      desc <<-DESC
+        [internal] Installs all tools for the given deployment type.
+
+        Most of these values can be overridden in each application's deploy.rb file.
+      DESC
+      task :default do
+        if exists?(:tools)
+          fetch(:tools).each do |tool|
+            tools.defaults.send(tool.to_s) if tools.defaults.respond_to?(tool.to_sym)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chicken_soup/tools/log/log-defaults.rb

@@ -0,0 +1,21 @@
+######################################################################
+#                           LOG DEFAULTS                             #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :tools do
+    namespace :defaults do
+      task :log do
+        _cset(:web_server_error_log_files)  { find_all_logs(web_server_log_directory, ChickenSoup::WebServer::STANDARD_ERROR_LOGS) }
+        _cset(:web_server_access_log_files) { find_all_logs(web_server_log_directory, ChickenSoup::WebServer::STANDARD_ACCESS_LOGS) }
+        _cset(:web_server_log_files)        { web_server_access_log_files + web_server_error_log_files }
+        _cset(:web_server_log_directory)    { log_directory(ChickenSoup::WebServer::STANDARD_LOG_LOCATIONS) }
+
+        _cset(:app_server_log_files)        { find_all_logs(web_server_log_directory, ChickenSoup::ApplicationServer::STANDARD_LOGS) }
+
+        _cset(:rails_log_files)             { ["#{shared_path}/log/#{rails_env}.log"] }
+
+        _cset(:log_files)                   { rails_log_files + app_server_log_files + web_server_log_files }
+      end
+    end
+  end
+end

data/lib/chicken_soup/tools/log/log-tasks.rb

@@ -0,0 +1,56 @@
+######################################################################
+#                            LOG TASKS                               #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :log do
+    desc <<-DESC
+      Begins tailing the Rails log file within the specified environment.
+
+      * Pass lines=<number> to give you a bigger look back at what has
+        recently happened.  ie: cap staging log lines=50
+    DESC
+    task :default, :roles => :app do
+      log.all.tail
+    end
+
+    namespace :application do
+      task :fetch, :roles => :app do
+        fetch_log(rails_log_files)
+      end
+
+      task :tail, :roles => :app do
+        tail_log(rails_log_files)
+      end
+    end
+
+    namespace :app_server do
+      task :fetch, :roles => :app do
+        fetch_log(app_server_log_files)
+      end
+
+      task :tail, :roles => :app do
+        tail_log(app_server_log_files)
+      end
+    end
+
+    namespace :web_server do
+      task :fetch, :roles => :web do
+        fetch_log(web_server_log_files)
+      end
+
+      task :tail, :roles => :web do
+        tail_log(web_server_log_files)
+      end
+    end
+
+    namespace :all do
+      task :fetch, :roles => [:app, :web] do
+        fetch_log(log_files)
+      end
+
+      task :tail, :roles => [:app, :web] do
+        tail_log(log_files)
+      end
+    end
+  end
+end

data/lib/chicken_soup/tools/tasks.rb

@@ -0,0 +1,12 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  before  'tools:load_tasks',      'load_tool_tasks'
+
+  namespace :tools do
+    desc <<-DESC
+      [internal] A helper task used to load all of the tasks associated with the
+      requested tools.
+    DESC
+    task :load_tasks do
+    end
+  end
+end

data/lib/chicken_soup/tools.rb

@@ -0,0 +1,16 @@
+######################################################################
+#                           TOOLS SETUP                              #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require "chicken_soup/tools/defaults"
+  require "chicken_soup/tools/tasks"
+
+  ['defaults', 'checks', 'tasks'].each do |method|
+    desc "[internal] This task is only here because `require` cannot be used within a `namespace`"
+    task "load_tool_#{method}".to_sym do
+      fetch(:tools).each do |tool|
+        require_if_exists "chicken_soup/tools/#{tool}/#{tool}-#{method}"
+      end
+    end
+  end
+end

data/lib/chicken_soup/version.rb

@@ -1,3 +1,3 @@
 module ChickenSoup
-  VERSION = "0.6.1"
+  VERSION = "0.8.0"
 end

data/lib/chicken_stock.rb

@@ -1,5 +1,9 @@
 require 'chicken_soup/global'
+
+include  ChickenSoup
+
 require 'chicken_soup/environment'
 require 'chicken_soup/capabilities'
 require 'chicken_soup/notifiers'
+require 'chicken_soup/tools'
 require 'chicken_soup/deploy'

metadata

@@ -2,7 +2,7 @@
 name: chicken_soup
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors: 
 - thekompanee
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-11 00:00:00 -05:00
+date: 2011-08-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -119,6 +119,7 @@ files:
 - lib/chicken_soup/capabilities/shared/db-checks.rb
 - lib/chicken_soup/capabilities/shared/db-defaults.rb
 - lib/chicken_soup/capabilities/shared/db-tasks.rb
+- lib/chicken_soup/capabilities/shared/web_server-defaults.rb
 - lib/chicken_soup/capabilities/shared/web_server-tasks.rb
 - lib/chicken_soup/capabilities/svn/svn-defaults.rb
 - lib/chicken_soup/capabilities/svn/svn-tasks.rb
@@ -144,6 +145,12 @@ files:
 - lib/chicken_soup/notifiers/tasks.rb
 - lib/chicken_soup/templates/client_email.html.erb
 - lib/chicken_soup/templates/internal_email.html.erb
+- lib/chicken_soup/templates/maintenance.html.erb
+- lib/chicken_soup/tools.rb
+- lib/chicken_soup/tools/defaults.rb
+- lib/chicken_soup/tools/log/log-defaults.rb
+- lib/chicken_soup/tools/log/log-tasks.rb
+- lib/chicken_soup/tools/tasks.rb
 - lib/chicken_soup/version.rb
 - lib/chicken_stock.rb
 - spec/support/focused.rb