chicken_soup 0.5.3 → 0.6.0

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

@@ -2,6 +2,8 @@
 #                         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."

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

@@ -2,6 +2,8 @@
 #                             UNIX TASKS                             #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
+  extend ChickenSoup
+
   before "deploy:shared_files:symlink",        "deploy:shared_files:setup"
 
   namespace :deploy do
@@ -22,8 +24,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         If it finds it, it will upload the file or directory to the shared directory on
         the server and rename it to the proper file name.
 
-        If it doesn't find it, it will check to see if the remote file exists, if not,
-        it will use whatever local file is available with that name.
+        If it doesn't find it, it will check to see if the remote file exists.
 
         As a last resort, it will error out because the symlink task which follows will
         fail due to the missing file.
@@ -36,18 +37,14 @@ Capistrano::Configuration.instance(:must_exist).load do
           run "mkdir -p '#{shared_path}/#{base_dir_of_shared_file}'"
 
           remote_shared_file              = "#{shared_path}/#{shared_file}"
-          local_shared_file               = "#{Dir.pwd}/#{shared_file}"
+          local_shared_file               = "#{rails_root}/#{shared_file}"
           local_environment_specific_file = "#{local_shared_file}.#{rails_env}"
           permissions                     = File.directory? local_shared_file ? "755" : "600"
 
           if File.exists?(local_environment_specific_file)
             top.upload(local_environment_specific_file, remote_shared_file, :mode => permissions)
           elsif !remote_file_exists?(remote_shared_file)
-            if File.exists?(local_shared_file)
-              top.upload(local_shared_file, remote_shared_file, :mode => permissions)
-            else
-              abort "I'm sorry Dave, but I couldn't find a local file or directory at '#{local_shared_file}' or '#{local_environment_specific_file}'"
-            end
+            abort "I'm sorry Dave, but I couldn't find a local file or directory at '#{local_environment_specific_file}' or on the remote server at '#{remote_shared_file}'"
           end
         end
       end

data/lib/chicken_soup/capabilities.rb

@@ -14,9 +14,11 @@
 #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
+  extend ChickenSoup
+
   require 'chicken_soup/capabilities/defaults'
-  require "chicken_soup/capabilities/checks"
-  require "chicken_soup/capabilities/tasks"
+  require 'chicken_soup/capabilities/checks'
+  require 'chicken_soup/capabilities/tasks'
 
   ['defaults', 'checks', 'tasks'].each do |method|
     desc "[internal] This task is only here because `require` cannot be used within a `namespace`"

data/lib/chicken_soup/deploy.rb

@@ -11,7 +11,6 @@ Capistrano::Configuration.instance(:must_exist).load do
         deploy.update
         deploy.shared_files.symlink
         gems.install
-        deploy.migrate
         deploy.cleanup
       end
     end

data/lib/chicken_soup/environment/checks.rb

@@ -15,6 +15,8 @@
 #
 ######################################################################
 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'

data/lib/chicken_soup/environment/defaults.rb

@@ -17,7 +17,11 @@
 # The latter should be set in the application's deploy.rb file.
 #
 ######################################################################
+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'
 
@@ -37,6 +41,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
       desc "[internal] Sets intelligent common defaults for deployments"
       task :default do
+        _cset :local_user,                Etc.getlogin
         _cset :use_sudo,                  false
         _cset :default_shell,             false
 

data/lib/chicken_soup/global.rb

@@ -1,137 +1,198 @@
-###
-# Helper method to close all session connections to the remote servers
-#
-def close_sessions
-  sessions.values.each { |session| session.close }
-  sessions.clear
-end
+module ChickenSoup
+  ###
+  # Helper method to close all session connections to the remote servers
+  #
+  def close_sessions
+    sessions.values.each { |session| session.close }
+    sessions.clear
+  end
 
-###
-# Forces all connections to switch to the user passed into it.
-#
-# It will forcibly terminate all open connections in order to accomplish this.
-#
-# @example Switch to the 'deploy' user:
-#   set_user_to 'deploy'
-#
-# @param [String] username The username you would like to begin using.
-#
-def set_user_to(username)
-  close_sessions
-  set :user,        username
-  set(:password)    {Capistrano::CLI.password_prompt("#{username.capitalize}'s Password: ")}
-  set(:user_home)   { user == "root" ? "/root" : "/home/#{username}" }
-end
+  ###
+  # Forces all connections to switch to the user passed into it.
+  #
+  # It will forcibly terminate all open connections in order to accomplish this.
+  #
+  # @example Switch to the 'deploy' user:
+  #   set_user_to 'deploy'
+  #
+  # @param [String] username The username you would like to begin using.
+  #
+  def set_user_to(username)
+    close_sessions
+    set :user,        username
+    set(:password)    {Capistrano::CLI.password_prompt("#{username.capitalize}'s Password: ")}
+    set(:user_home)   { user == "root" ? "/root" : "/home/#{username}" }
+  end
 
-###
-# Helper method to run tasks in different contexts.
-#
-# The workflow is as follows:
-# * Current user is saved
-# * User is switched to the desired username passed in via the :as option
-# * The task is run
-# * The user is switched back to the original user
-#
-# By default the task hooks are prepared but the task itself is not executed.
-# You can change this by passing :now as an option.
-#
-# Running a task 'now' does not create hooks. Standard calls to the task will
-# be executed via the current user.
-#
-# @example Always run the task to install gems as the 'manage' user:
-#   run_task 'gems:install', :as => 'manage'
-# @example Run the db migration task now as the 'deploy' user:
-#   run_task 'db:migrate', :as => 'deploy', :now => true
-#
-# @param [String] task_name The name of the task to run.
-# @param [Hash] options Options to customize how the task is run.  Valid options are:
-# @option options [Boolean] :now - If present, the task will be executed immediately.
-# @option options [String]  :as - The name of the user you wish the task to be executed as.
-#
-# @todo Remove all previous hooks prior to adding new ones.  Also disable hooks when running "now"
-#
-def run_task(task_name, options = {})
-  abort "#run_task must be passed an `:as` option so that it knows who to change the user to." unless options[:as]
+  ###
+  # Helper method to run tasks in different contexts.
+  #
+  # The workflow is as follows:
+  # * Current user is saved
+  # * User is switched to the desired username passed in via the :as option
+  # * The task is run
+  # * The user is switched back to the original user
+  #
+  # By default the task hooks are prepared but the task itself is not executed.
+  # You can change this by passing :now as an option.
+  #
+  # Running a task 'now' does not create hooks. Standard calls to the task will
+  # be executed via the current user.
+  #
+  # @example Always run the task to install gems as the 'manage' user:
+  #   run_task 'gems:install', :as => 'manage'
+  # @example Run the db migration task now as the 'deploy' user:
+  #   run_task 'db:migrate', :as => 'deploy', :now => true
+  #
+  # @param [String] task_name The name of the task to run.
+  # @param [Hash] options Options to customize how the task is run.  Valid options are:
+  # @option options [Boolean] :now - If present, the task will be executed immediately.
+  # @option options [String]  :as - The name of the user you wish the task to be executed as.
+  #
+  # @todo Remove all previous hooks prior to adding new ones.  Also disable hooks when running "now"
+  #
+  def run_task(task_name, options = {})
+    abort "#run_task must be passed an `:as` option so that it knows who to change the user to." unless options[:as]
 
-  original_username = exists?(:user) ? user : nil
+    original_username = exists?(:user) ? user : nil
 
-  if options[:now]
-    set_user_to options[:as]
-    find_and_execute_task(task_name)
-    set_user_to original_username
-  else
-    before task_name,     "os:users:#{options[:as]}:use"
-    after  task_name,     "os:users:#{original_username}:use"
+    if options[:now]
+      set_user_to options[:as]
+      find_and_execute_task(task_name)
+      set_user_to original_username
+    else
+      before task_name,     "os:users:#{options[:as]}:use"
+      after  task_name,     "os:users:#{original_username}:use"
+    end
   end
-end
 
-###
-# Checks an array of items to see if they are currently set within the
-# Capistrano scope.  If any of them fail, Capistrano execution will terminate.
-#
-# @param [Array, #each] required_variables An iterable list of items which
-#   represent the names of Capistrano environment variables.  Each item in this
-#   list is expected to be set.
-#
-# @raise [CapistranoGoBoom] Calls #abort on the Capistrano execution if any of
-#   the variables are not set.
-#
-# @example Using an array:
-#   verify_variables [:user, :deploy_base_dir, :app_server]
-#
-def verify_variables(required_variables)
-  required_variables.each do |expected_variable|
-    abort( "You have not defined '#{expected_variable}' which is necessary for deployment." ) unless exists?(expected_variable)
+  ###
+  # Checks an array of items to see if they are currently set within the
+  # Capistrano scope.  If any of them fail, Capistrano execution will terminate.
+  #
+  # @param [Array, #each] required_variables An iterable list of items which
+  #   represent the names of Capistrano environment variables.  Each item in this
+  #   list is expected to be set.
+  #
+  # @raise [CapistranoGoBoom] Calls #abort on the Capistrano execution if any of
+  #   the variables are not set.
+  #
+  # @example Using an array:
+  #   verify_variables [:user, :deploy_base_dir, :app_server]
+  #
+  def verify_variables(required_variables)
+    required_variables.each do |expected_variable|
+      abort( "You have not defined '#{expected_variable}' which is necessary for deployment." ) unless exists?(expected_variable)
+    end
   end
-end
 
-###
-# @note Taken directly from the Capistrano codebase.
-#
-# Sets a variable only if it doesn't already exist.
-#
-def _cset(name, *args, &block)
-  unless exists?(name)
-    set(name, *args, &block)
+  ###
+  # @note Taken directly from the Capistrano codebase.
+  #
+  # Sets a variable only if it doesn't already exist.
+  #
+  def _cset(name, *args, &block)
+    unless exists?(name)
+      set(name, *args, &block)
+    end
   end
-end
 
-###
-# Runs a command on the remote server to see if the file currently exists.
-#
-# @param [String] file The filename (optionally including path), directory,
-#   or symlink that is may or may not exist.
-#
-# @return [Boolean] Whether or not the file, directory or symlink exists.
-#
-# @example File without path:
-#   remote_file_exists? 'server.log'
-# @example File with path:
-#   remote_file_exists? '/var/www/myappdir/log/production.log'
-# @example Directory:
-#   remote_file_exists? '/var/www/myappdir/log'
-# @example Symbolic Link:
-#   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"
-end
+  ###
+  # Runs a command on the remote server to see if the file currently exists.
+  #
+  # @param [String] file The filename (optionally including path), directory,
+  #   or symlink that is may or may not exist.
+  #
+  # @return [Boolean] Whether or not the file, directory or symlink exists.
+  #
+  # @example File without path:
+  #   remote_file_exists? 'server.log'
+  # @example File with path:
+  #   remote_file_exists? '/var/www/myappdir/log/production.log'
+  # @example Directory:
+  #   remote_file_exists? '/var/www/myappdir/log'
+  # @example Symbolic Link:
+  #   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"
+  end
 
-def require_if_exists(file)
-  require file if File.exists?(File.join(File.dirname(__FILE__), '..', "#{file}.rb"))
-end
+  ###
+  # Will require a file but will not throw an error if that file does not
+  # exist.
+  #
+  # @param [String] file The filename (optionally including path), directory,
+  #   or symlink that is may or may not exist.
+  #
+  # @return [nil] nil will be returned if the file was loaded successfully.
+  #
+  # @example
+  #   require_if_exists 'my_library'
+  #
+  def require_if_exists(file)
+    require file if File.exists?(File.join(File.dirname(__FILE__), '..', "#{file}.rb"))
+  end
 
-def download_compressed(remote, local, options = {})
-  remote_compressed_filename = "#{remote}.bz2"
-  local_compressed_filename  = "#{local}.bz2"
+  ###
+  # Compresses a specific remote file before transferring it to the local
+  # machine.  Once the transfer is completed, the file will be uncompressed
+  # and the compressed version will be deleted.
+  #
+  # @param [String] remote The remote filename (optionally including path),
+  # or directory that you would like to transfer.
+  #
+  # @param [String] local The location locally where you would like the file
+  # or directory to be transferred.
+  #
+  # @param [String] options Any options that can be passed to Capistrano's
+  # #download method.
+  #
+  # @example
+  #   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"
 
-  run "bzip2 -zvck9 #{remote} > #{remote_compressed_filename}"
-  download remote_compressed_filename, local_compressed_filename, options
+    run "bzip2 -zvck9 #{remote} > #{remote_compressed_filename}"
+    download remote_compressed_filename, local_compressed_filename, options
 
-  run "rm -f #{remote_compressed_filename}"
-  `bunzip2 -f #{local_compressed_filename} && rm -f #{local_compressed_filename}`
-end
+    run "rm -f #{remote_compressed_filename}"
+    `bunzip2 -f #{local_compressed_filename} && rm -f #{local_compressed_filename}`
+  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)
+  # is installed.
+  #
+  # @param [String] ruby_version This is simply a noop on this method.  It
+  # is not used.  It is instead intended to be used with the Ruby manager
+  # that is installed.
+  #
+  # @param [String] command The command that is passed to #run
+  #
+  # @param [String] options Any options that can be passed to Capistrano's
+  # #run method.
+  #
+  # @example
+  #   run_with_ruby_manager 'foo', 'gem list', :pty => false
+  #
+  def run_with_ruby_manager(ruby_version, command, options = {})
+    run command, options
+  end
 
-def vc_log
-  nil
+  ###
+  # A stub method which simply returns nil.  It is meant to be overridden
+  # when a version control capability (ie Git) is installed.
+  #
+  # @return [nil] Always returns nil
+  #
+  # @example
+  #   run_with_ruby_manager 'foo', 'gem list', :pty => false
+  #
+  def vc_log
+    nil
+  end
 end

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

@@ -0,0 +1,21 @@
+######################################################################
+#                       AIRBRAKE NOTIFIER TASKS                      #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  after "deploy",            "notify:via_airbrake"
+
+  namespace :notify do
+    desc <<-DESC
+      [internal] Sends Airbrake information regarding the deployment.
+      If you have a paid version of Airbrake, it will resolve all of
+      your errors.
+    DESC
+    task :via_airbrake, :except => { :no_release => true } do
+      notify_command = "rake hoptoad:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+      notify_command << " DRY_RUN=true" if dry_run
+      notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
+
+      `#{notify_command}`
+    end
+  end
+end

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

@@ -2,6 +2,8 @@
 #                       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,6 +6,8 @@ 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/email-tasks.rb

@@ -4,7 +4,7 @@
 require 'mail'
 
 Capistrano::Configuration.instance(:must_exist).load do |cap|
-  after     'deploy:cleanup',             'notify:via_email'
+  after     'deploy',                 'notify:via_email'
 
   namespace :notify do
     desc <<-DESC
@@ -16,20 +16,28 @@ Capistrano::Configuration.instance(:must_exist).load do |cap|
       end
 
       if !cap[:email_notifier_client_recipients].empty?
-        Mail.deliver do
-              to cap[:email_notifier_client_recipients]
-            from cap[:email_notifier_sender]
-         subject cap[:email_notifier_subject]
-            body cap[:email_notifier_client_body]
+        begin
+          Mail.deliver do
+                to cap[:email_notifier_client_recipients]
+              from cap[:email_notifier_sender]
+          subject cap[:email_notifier_subject]
+              body cap[:email_notifier_client_body]
+          end
+        rescue
+          puts "I'm sorry Dave, but I couldn't contact the mail server.  The client email notifications you requested have not been sent"
         end
       end
 
       if !cap[:email_notifier_internal_recipients].empty?
-        Mail.deliver do
-              to cap[:email_notifier_internal_recipients]
-            from cap[:email_notifier_sender]
-         subject cap[:email_notifier_subject]
-            body cap[:email_notifier_internal_body]
+        begin
+          Mail.deliver do
+                to cap[:email_notifier_internal_recipients]
+              from cap[:email_notifier_sender]
+          subject cap[:email_notifier_subject]
+              body cap[:email_notifier_internal_body]
+          end
+        rescue
+          puts "I'm sorry Dave, but I couldn't contact the mail server.  The email notifications to the development team you requested have not been sent"
         end
       end
     end

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

@@ -1,9 +1,10 @@
-require 'etc'
 require 'time'
 
 module ChickenSoup
   module Email
     class Presenter
+      include ChickenSoup
+
       LongDateFormat = "%A, %B %e, %Y at %l:%M%p %Z"
 
       def initialize(capistrano)
@@ -19,7 +20,7 @@ module ChickenSoup
       end
 
       def deployed_by
-        Etc.getlogin
+        @capistrano[:local_user]
       end
 
       def deploy_date_in_long_format

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

@@ -8,7 +8,7 @@ module ChickenSoup
 end
 
 Capistrano::Configuration.instance(:must_exist).load do
-  after     'deploy:cleanup',           'notify:via_git:tag'
+  after     'deploy',             'notify:via_git:tag'
 
   namespace :notify do
     namespace :via_git do
@@ -19,10 +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
-        timestamp_string_without_seconds = Time.now.strftime("%Y%m%d%H%M")
-        tag_name = "deployed_to_#{rails_env}_#{timestamp_string_without_seconds}"
+        tag_name = "deployment/#{rails_env}/#{current_release}"
 
-        `git tag -a -m "Tagging deploy to #{rails_env} at #{timestamp_string_without_seconds}" #{tag_name} #{branch}`
+        `git tag -a -m "Tagging deploy to #{rails_env} at #{current_release}" #{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,6 +2,8 @@
 #                           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/version.rb

@@ -1,3 +1,3 @@
 module ChickenSoup
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: chicken_soup
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors: 
 - thekompanee
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-10 00:00:00 -05:00
+date: 2011-08-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,10 +96,14 @@ files:
 - lib/chicken_soup/capabilities/bundler/bundler-tasks.rb
 - lib/chicken_soup/capabilities/checks.rb
 - lib/chicken_soup/capabilities/defaults.rb
+- lib/chicken_soup/capabilities/git/git-checks.rb
 - lib/chicken_soup/capabilities/git/git-defaults.rb
+- lib/chicken_soup/capabilities/github/github-defaults.rb
+- lib/chicken_soup/capabilities/github/github-tasks.rb
 - lib/chicken_soup/capabilities/heroku/heroku-checks.rb
 - lib/chicken_soup/capabilities/heroku/heroku-defaults.rb
 - lib/chicken_soup/capabilities/heroku/heroku-tasks.rb
+- lib/chicken_soup/capabilities/mysql/mysql-checks.rb
 - lib/chicken_soup/capabilities/mysql/mysql-tasks.rb
 - lib/chicken_soup/capabilities/nginx/nginx-checks.rb
 - lib/chicken_soup/capabilities/nginx/nginx-defaults.rb
@@ -129,6 +133,7 @@ files:
 - lib/chicken_soup/environment/tasks.rb
 - lib/chicken_soup/global.rb
 - lib/chicken_soup/notifiers.rb
+- lib/chicken_soup/notifiers/airbrake/airbrake-tasks.rb
 - lib/chicken_soup/notifiers/checks.rb
 - lib/chicken_soup/notifiers/defaults.rb
 - lib/chicken_soup/notifiers/email/email-checks.rb
@@ -136,7 +141,6 @@ files:
 - lib/chicken_soup/notifiers/email/email-tasks.rb
 - lib/chicken_soup/notifiers/email/presenter.rb
 - lib/chicken_soup/notifiers/git/git-tasks.rb
-- lib/chicken_soup/notifiers/hoptoad/hoptoad-tasks.rb
 - lib/chicken_soup/notifiers/tasks.rb
 - lib/chicken_soup/templates/client_email.html.erb
 - lib/chicken_soup/templates/internal_email.html.erb

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

@@ -1,6 +0,0 @@
-######################################################################
-#                       HOPTOAD NOTIFIER TASKS                       #
-######################################################################
-Capistrano::Configuration.instance(:must_exist).load do
-  # require 'hoptoad_notifier/capistrano'
-end