capistrano_mailer 4.0.0 → 4.0.1

data/README.rdoc

@@ -1,206 +1,187 @@
-= Capistrano Mailer
-
-  * For Capistrano Deployment Email Notification 
-  * It is a Capistrano Plugin / Ruby Gem that requires ActionMailer
-  * It is MIT-LICENSE
-
-Ever wanted to be emailed whenever someone on the team does a cap deploy of trunk or some tag to some server.  
-Wouldn't it be nice to know about it every time a release was deployed?  For large rails projects this type of coordination is essential, 
-and this plugin makes sure everyone on the need to know list is notified when something new is deployed.
-
-This plugin/gem is an extension to Capistrano.
-
-That means it registers itself with Capistrano as a plugin and is therefore available to call in your recipes.
-
-If you are looking to roll your own email integration into capistrano then try this pastie:
-http://pastie.org/146264 (thanks to Mislav Marohnić).
-But if you want to take the easy road to riches then keep reading ;)
- -- figurative "riches" of course, I promise nothing in return for your using this plugin
-
-Important Note:
-The first time you deploy to a server (a 'cold' deploy) capistrano mailer will cause an error because it uses capistrano's previous release variables, and when there are no previous releases capistrano throws an error.  In the next version this will be fixed, just don't have time at the moment.  If you would like to work on this 'first deploy' problem please fork my repo and work on it!
-
-== Home Page
-
-http://github.com/pboling/capistrano_mailer
-
-
-== Credit where Credit is Due
-
-  * Thanks to Dustin Deyoung of Sagebit, LLC (http://www.sagebit.com) for the beautiful HTML email templates.
-
-
-== Requirements
-
-  * at least Rails 1.2.6 (might work with older versions, but has not been tested)
-
-  * at least Capistrano 2.4.3 (might work with capistrano as old as 2.1.0, but has not been tested)
-
-  * Known to be compatible with SCMs as of version 3.1.2: Perforce, SVN, and Git
-
-  * Known to be compatible with, but does not require, the deprec gem.
-
-
-== Usage with Rails >= 3.x.x
-
-The > 4.x versions of this gem require at least Rails 3
-
-=== Installation
-
-Install as a gem:
-
-  [sudo] gem install capistrano_mailer
-
-== Usage with Rails <= 2.3.x
-
-=== Installation
-
-Install the latest Rails 2 compatible version of the gem:
-
-  [sudo] gem install capistrano_mailer -v 3.2.5
-
-=== Upgrading
-
-The 3.x versions of the gem will remain compatible with Rails 2.x
-
-From version 3.1.x to version 3.2.x
-
-1. Update the way CapistranoMailer is configured using the new method: CapMailer.configure (see Usage below).
-2. require the cap mailer config file (see Usage below)
-
-From version 2.1.0 to version 3.1.x:
-
-1. Update the way CapistranoMailer is configured using the new method: CapMailer.configure_capistrano_mailer (changed in later versions to just 'configure') (see Usage below).
-2. Update the require statement at the top of deploy.rb, see below (note for plugin change from capistrano_mailer to capistrano/mailer).
-3. Change the mailer.send to mailer.send_notification_email in your cap recipe.
-
-== Setup
-
-1. You need to have already setup capistrano in the project, including the 'capify .' command.
-
-2. Add this line to the top of your config/deploy.rb:
-
-  # For plugin:
-  #   You must make capistrano_mailer's libraries available in Ruby's load path.  This is one way to do that:
-  #   Add to the top of your config/deploy.rb file:
-  $:.unshift 'vendor/plugins/capistrano_mailer/lib'
-
-  # For frozen gem:
-  #   You must make capistrano_mailer's libraries available in Ruby's load path.  This is one way to do that:
-  #   Add to the top of your config/deploy.rb file:
-  $:.unshift 'vendor/gems/capistrano_mailer-x.x.x/lib'
-
-  # then for gem or plugin:
-  ####################################
-  # Capistrano Plugins go here
-  require 'capistrano/mailer'
-  #configure capistrano_mailer:
-  # The configuration file can go anywhere, but in past versions of the gem it was required to be in the config/ dir.
-  require 'config/cap_mailer_settings'
-  ####################################
-
-3. Configure Caistrano Mailer in the settings file required in step 2:
-
-  # If installed as a plugin might need the require here as well
-
-  ActionMailer::Base.delivery_method = :smtp # or :sendmail, or whatever
-  ActionMailer::Base.smtp_settings = { # if using :smtp
-      :address        => "mail.example.com",
-      :port           => 25,
-      :domain         => 'default.com',
-      :perform_deliveries => true,
-      :user_name      => "releases@example.com",
-      :password       => "mypassword",
-      :authentication => :login }
-  ActionMailer::Base.default_charset = "utf-8"# or "latin1" or whatever you are using
-
-  CapMailer.configure do |config|
-    config[:recipient_addresses]  = ["dev1@example.com"]
-    # NOTE: THERE IS A BUG IN RAILS 2.3.3 which forces us to NOT use anything but a simple email address string for the sender address.
-    # https://rails.lighthouseapp.com/projects/8994/tickets/2340
-    # Therefore %("Capistrano Deployment" <releases@example.com>) style addresses may not work in Rails 2.3.3
-    config[:sender_address]       = "deployment@example.com"
-    config[:subject_prepend]      = "[EMPTY-CAP-DEPLOY]"
-    config[:site_name]            = "Empty Example.com App"
-  end
-
-4. Add these two tasks to your deploy.rb:
-
-  namespace :show do
-    desc "Show some internal Cap-Fu: What's mah NAYM?!?"
-    task :me do
-      set :task_name, task_call_frames.first.task.fully_qualified_name
-      #puts "Running #{task_name} task"
-    end
-  end
-
-  namespace :deploy do
-    ...
-
-    desc "Send email notification of deployment (only send variables you want to be in the email)"
-    task :notify, :roles => :app do
-      show.me  # this sets the task_name variable
-      mailer.send_notification_email(self)
-    end
-
-    ...
-  end
-
-5. Make _sure_ you've defined `rails_env`, `repository`, `deploy_to`, `host`, and `application`.  `task_name` is defined by the show:me task above, and the others are defined behind the scenes by Capistrano!
-
-6. The only parameter to mailer.send_notification_email that is *required* is the first. _Minimally_ you need to define the capistrano variables:
-
-  :rails_env
-  :repository
-  :task_name (provided by the show:me task included in this readme)
-  :deploy_to
-  :host
-  :application
-     
-But there are tons of others - just take a look at lib/mailer/cap_mailer.rb.
-
-If anyone has a cool way of recording the *output* into a capistrano accessible variable,
-so that it can be shoved into the release email that would be an excellent contribution!
-
-7. Then add the hook somewhere in your deploy.rb:
-
-  after "deploy", "deploy:notify"
-
-8. Enjoy and Happy Capping!
-
-9. Customization
-
-If you want to use your own views you'll need to recreate the notification_email view:
-First you need to define where your templates are:
-
-  CapMailer.configure_capistrano_mailer do |config|
-    config[:template_root]      = "app/views/capistrano_mailer/"
-  end
-
-Then you'll need to create templates there called:
-  `notification_email.text.html.erb`
-and / or
-  `notification_email.text.plain.erb`
-
-Take a look at the templates that comes with the plugin to see how it is done (views/cap_mailer/...)
-
-== Authors
-
-Peter Boling (pboling) - Wrote original & maintainer
-Dave Nolan (textgoeshere) - lots of refactoring merged into 3.2 release
-Jason Rust (jrust) - Updated for Rails 3 compatibility
-
-== Contributors
-
-Dustin Deyoung - HTML Email Templates
-mixonix - SCMs compatibility
-greut - SCMs compatibility
-
-----------------------------------------------------------------------------------
-  This plugin started out as a collaboration between Sagebit, LLC (http://www.sagebit.com) and Peter Boling (http://www.peterboling.com).
-  Written initially while Peter Boling was working at Sagebit for use in various projects.
-
-  Author: Peter Boling, peter.boling at gmail dot com
-
-  Copyright (c) 2009-2011 Peter Boling of 9thBit LLC, released under the MIT license
-  Copyright (c) 2007-2008 Sagebit LLC, released under the MIT license
+= Capistrano Mailer
+
+  * For Capistrano Deployment Email Notification 
+  * It is a Capistrano Plugin / Ruby Gem that requires ActionMailer
+  * It is MIT-LICENSE
+
+Ever wanted to be emailed whenever someone on the team does a cap deploy of trunk or some tag to some server.  
+Wouldn't it be nice to know about it every time a release was deployed?  For large rails projects this type of coordination is essential, 
+and this plugin makes sure everyone on the need to know list is notified when something new is deployed.
+
+This plugin/gem is an extension to Capistrano.
+
+That means it registers itself with Capistrano as a plugin and is therefore available to call in your recipes.
+
+If you are looking to roll your own email integration into capistrano then try this pastie:
+http://pastie.org/146264 (thanks to Mislav Marohnić).
+But if you want to take the easy road to riches then keep reading ;)
+ -- figurative "riches" of course, I promise nothing in return for your using this plugin
+
+Important Note:
+The first time you deploy to a server (a 'cold' deploy) capistrano mailer will cause an error because it uses capistrano's previous release variables, and when there are no previous releases capistrano throws an error.  In the next version this will be fixed, just don't have time at the moment.  If you would like to work on this 'first deploy' problem please fork my repo and work on it!
+
+== Home Page
+
+http://github.com/pboling/capistrano_mailer
+
+
+== Credit where Credit is Due
+
+  * Thanks to Dustin Deyoung of Sagebit, LLC (http://www.sagebit.com) for the beautiful HTML email templates.
+
+
+== Requirements
+
+  * at least Rails 3.0 (might work with older versions, but has not been tested)
+
+  * at least Capistrano 2.4.3 (might work with capistrano as old as 2.1.0, but has not been tested)
+
+  * Known to be compatible with SCMs as of version 3.1.2: Perforce, SVN, and Git
+
+  * Known to be compatible with, but does not require, the deprec gem.
+
+
+== Usage with Rails >= 3.x.x
+
+The > 4.x versions of this gem require at least Rails 3
+
+=== Installation
+
+Install as a gem:
+
+  [sudo] gem install capistrano_mailer
+
+== Usage with Rails <= 2.3.x
+
+Switch to the rails2 branch (releases will be in 3.x range)
+
+== Setup
+
+1. You need to have already setup capistrano in the project, including the 'capify .' command.
+
+2. Add this line to the top of your config/deploy.rb:
+
+  # For plugin:
+  #   You must make capistrano_mailer's libraries available in Ruby's load path.  This is one way to do that:
+  #   Add to the top of your config/deploy.rb file:
+  $:.unshift 'vendor/plugins/capistrano_mailer/lib'
+
+  # For frozen gem:
+  #   You must make capistrano_mailer's libraries available in Ruby's load path.  This is one way to do that:
+  #   Add to the top of your config/deploy.rb file:
+  $:.unshift 'vendor/gems/capistrano_mailer-x.x.x/lib'
+
+  # then for gem or plugin:
+  ####################################
+  # Capistrano Plugins go here
+  require 'capistrano/mailer'
+  #configure capistrano_mailer:
+  # The configuration file can go anywhere, but in past versions of the gem it was required to be in the config/ dir.
+  require 'config/cap_mailer_settings'
+  ####################################
+
+3. Configure Caistrano Mailer in the settings file required in step 2:
+
+  # If installed as a plugin might need the require here as well
+
+  ActionMailer::Base.delivery_method = :smtp # or :sendmail, or whatever
+  ActionMailer::Base.smtp_settings = { # if using :smtp
+      :address        => "mail.example.com",
+      :port           => 25,
+      :domain         => 'default.com',
+      :perform_deliveries => true,
+      :user_name      => "releases@example.com",
+      :password       => "mypassword",
+      :authentication => :login }
+  ActionMailer::Base.default_charset = "utf-8"# or "latin1" or whatever you are using
+
+  CapMailer.configure do |config|
+    config[:recipient_addresses]  = ["dev1@example.com"]
+    # NOTE: THERE IS A BUG IN RAILS 2.3.3 which forces us to NOT use anything but a simple email address string for the sender address.
+    # https://rails.lighthouseapp.com/projects/8994/tickets/2340
+    # Therefore %("Capistrano Deployment" <releases@example.com>) style addresses may not work in Rails 2.3.3
+    config[:sender_address]       = "deployment@example.com"
+    config[:subject_prepend]      = "[EMPTY-CAP-DEPLOY]"
+    config[:site_name]            = "Empty Example.com App"
+  end
+
+4. Add these two tasks to your deploy.rb:
+
+  namespace :show do
+    desc "Show some internal Cap-Fu: What's mah NAYM?!?"
+    task :me do
+      set :task_name, task_call_frames.first.task.fully_qualified_name
+      #puts "Running #{task_name} task"
+    end
+  end
+
+  namespace :deploy do
+    ...
+
+    desc "Send email notification of deployment (only send variables you want to be in the email)"
+    task :notify, :roles => :app do
+      show.me  # this sets the task_name variable
+      mailer.send_notification_email(self)
+    end
+
+    ...
+  end
+
+5. Make _sure_ you've defined `rails_env`, `repository`, `deploy_to`, `host`, and `application`.  `task_name` is defined by the show:me task above, and the others are defined behind the scenes by Capistrano!
+
+6. The only parameter to mailer.send_notification_email that is *required* is the first. _Minimally_ you need to define the capistrano variables:
+
+  :rails_env
+  :repository
+  :task_name (provided by the show:me task included in this readme)
+  :deploy_to
+  :host
+  :application
+     
+But there are tons of others - just take a look at lib/mailer/cap_mailer.rb.
+
+If anyone has a cool way of recording the *output* into a capistrano accessible variable,
+so that it can be shoved into the release email that would be an excellent contribution!
+
+7. Then add the hook somewhere in your deploy.rb:
+
+  after "deploy", "deploy:notify"
+
+8. Enjoy and Happy Capping!
+
+9. Customization
+
+If you want to use your own views you'll need to recreate the notification_email view:
+First you need to define where your templates are:
+
+  CapMailer.configure_capistrano_mailer do |config|
+    config[:template_root]      = "app/views/capistrano_mailer/"
+  end
+
+Then you'll need to create templates there called:
+  `notification_email.text.html.erb`
+and / or
+  `notification_email.text.plain.erb`
+
+Take a look at the templates that comes with the plugin to see how it is done (views/cap_mailer/...)
+
+== Authors
+
+Peter Boling (pboling) - Wrote original & maintainer
+Dave Nolan (textgoeshere) - lots of refactoring merged into 3.2 release
+Jason Rust (jrust) - Updated for Rails 3 compatibility
+
+== Contributors
+
+Dustin Deyoung - HTML Email Templates
+mixonix - SCMs compatibility
+greut - SCMs compatibility
+
+----------------------------------------------------------------------------------
+  This plugin started out as a collaboration between Sagebit, LLC (http://www.sagebit.com) and Peter Boling (http://www.peterboling.com).
+  Written initially while Peter Boling was working at Sagebit for use in various projects.
+
+  Author: Peter Boling, peter.boling at gmail dot com
+
+  Copyright (c) 2009-2011 Peter Boling of 9thBit LLC, released under the MIT license
+  Copyright (c) 2007-2008 Sagebit LLC, released under the MIT license

data/Rakefile

@@ -1,52 +1,52 @@
-require 'rake'
-require 'rake/testtask'
-require 'rdoc/task'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "capistrano_mailer"
-    gemspec.summary = "Capistrano Deployment Email Notification"
-    gemspec.description = %q{Capistrano Deployment Email Notification.  Keep the whole team informed of each release!}
-    gemspec.email = ["peter.boling@gmail.com", "dave@textgoeshere.org.uk", "jason@rustedcode.com"]
-    gemspec.homepage = "http://github.com/pboling/capistrano_mailer"
-    gemspec.authors = ["Peter Boling", "Dave Nolan", "Jason Rust"]
-    gemspec.add_dependency 'actionmailer'
-    gemspec.files = ["README.rdoc",
-             "capistrano_mailer.gemspec",
-             "lib/cap_mailer.rb",
-             "lib/capistrano/mailer.rb",
-             "Rakefile",
-             "MIT-LICENSE",
-             "views/cap_mailer/_section.html.erb",
-             "views/cap_mailer/_section.text.erb",
-             "views/cap_mailer/_section_custom.html.erb",
-             "views/cap_mailer/_section_custom.text.erb",
-             "views/cap_mailer/notification_email.html.erb",
-             "views/cap_mailer/notification_email.text.erb",
-             "VERSION.yml"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the capistrano_mailer gem.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the capistrano_mailer gem.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'capistrano_mailer'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.markdown')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "capistrano_mailer"
+    gemspec.summary = "Capistrano Deployment Email Notification"
+    gemspec.description = %q{Capistrano Deployment Email Notification.  Keep the whole team informed of each release!}
+    gemspec.email = ["peter.boling@gmail.com", "dave@textgoeshere.org.uk", "jason@rustedcode.com"]
+    gemspec.homepage = "http://github.com/pboling/capistrano_mailer"
+    gemspec.authors = ["Peter Boling", "Dave Nolan", "Jason Rust"]
+    gemspec.add_dependency 'actionmailer'
+    gemspec.files = ["README.rdoc",
+             "capistrano_mailer.gemspec",
+             "lib/cap_mailer.rb",
+             "lib/capistrano/mailer.rb",
+             "Rakefile",
+             "MIT-LICENSE",
+             "views/cap_mailer/_section.html.erb",
+             "views/cap_mailer/_section.text.erb",
+             "views/cap_mailer/_section_custom.html.erb",
+             "views/cap_mailer/_section_custom.text.erb",
+             "views/cap_mailer/notification_email.html.erb",
+             "views/cap_mailer/notification_email.text.erb",
+             "VERSION.yml"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the capistrano_mailer gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the capistrano_mailer gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'capistrano_mailer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 :major: 4
 :minor: 0
-:patch: 0
+:patch: 1
 :build: !!null 

data/capistrano_mailer.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "capistrano_mailer"
-  s.version = "4.0.0"
+  s.version = "4.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Boling", "Dave Nolan", "Jason Rust"]

data/lib/cap_mailer.rb

@@ -1,184 +1,184 @@
-class CapMailer < ActionMailer::Base
-
-  @@default_base_config ||= {
-    :sender_address           => %("#{(defined?(Rails) ? Rails.env.capitalize : defined?(RAILS_ENV) ? RAILS_ENV.capitalize : defined?(ENV) ? ENV['RAILS_ENV'] : "")} Capistrano Deployment" <capistrano.mailer@example.com>),
-    :recipient_addresses      => [],
-    # Customize the subject line
-    :subject_prepend          => "[DEPLOYMENT]-[#{(defined?(Rails) ? Rails.env.capitalize : defined?(RAILS_ENV) ? RAILS_ENV.capitalize : defined?(ENV) ? ENV['RAILS_ENV'] : "")}] ",
-    :subject_append           => nil,
-    # Include which sections of the deployment email?
-    :sections                 => %w(deployment release_data source_control latest_release previous_release other_deployment_info extra_information),
-    :site_name                => "",
-    :email_content_type       => "text/html",
-    :template_root            => "#{File.dirname(__FILE__)}/../views"
-  }
-
-  cattr_accessor :default_base_config
-  attr_accessor  :config, :options
-  attr_accessor  :date, :time, :inferred_command, :task_name, :repo_end
-  
-  def self.configure(&block)
-    yield @@default_base_config
-  end
-
-  def self.configure_capistrano_mailer(&block)
-    puts "Deprecated 'configure_capistrano_mailer'.  Please update your capistrano_mailer configuration to use 'configure' instead of 'configure_capistrano_mailer'"
-  end
-
-  self.prepend_view_path default_base_config[:template_root]
-
-  def self.reloadable?() false end
-    
-  def notification_email(cap, config = {}, *args)
-    @options = { :release_data => {}, :extra_information => {}, :data => {} }.merge(args.extract_options!)
-    @config  = default_base_config.merge(config.reverse_merge({
-          :rails_env          => cap.rails_env,
-          :host               => cap.host,
-          :task_name          => cap.task_name,
-          :application        => cap.application,
-          :repository         => cap.repository,
-          :scm                => cap.scm,
-          :deploy_via         => cap.deploy_via,
-          :deploy_to          => cap.deploy_to,
-          :revision           => cap.revision,
-          :real_revision      => cap.real_revision,
-          :release_name       => cap.release_name,
-          #This does not appear to be a capistrano variable:
-          #:release_notes      => cap.release_notes,
-          :version_dir        => cap.version_dir,
-          :shared_dir         => cap.shared_dir,
-          :current_dir        => cap.current_dir,
-          :releases_path      => cap.releases_path,
-          :shared_path        => cap.shared_path,
-          :current_path       => cap.current_path,
-          :release_path       => cap.release_path,
-          :releases           => cap.releases,
-          :current_release    => cap.current_release,
-          :previous_release   => cap.previous_release,
-          :current_revision   => cap.current_revision,
-          :latest_revision    => cap.latest_revision,
-          :previous_revision  => cap.previous_revision,
-          :run_method         => cap.run_method,
-          :latest_release     => cap.latest_release
-    
-          #This does not appear to be a capistrano variable:
-          #:site_url           => cap.site_url
-    }))
-    
-    @date             = Date.today.to_s
-    @time             = Time.now.strftime("%I:%M %p").to_s
-    @inferred_command = "cap #{@config[:rails_env]} #{@config[:task_name]}"
-    @task_name        = @config[:task_name] || "unknown"
-    
-    repo  = @config[:repository]
-    x     = repo.include?('/') ? repo.rindex('/') - 1 : repo.length
-    front = repo.slice(0..x)
-    back  = repo.sub(front, '')
-    unless back == 'trunk'
-      x = front.include?('/') ? front.rindex('/') - 1 : front.length
-      front = front.slice(0..x)
-    end
-    @repo_end = repo.sub(front, '')
-
-    body_data_hash.each_pair do |k, v|
-      self.instance_variable_set("@#{k}", v)
-    end
-
-    mail :subject       => subject_line,
-         :to            => @config[:recipient_addresses],
-         :from          => @config[:sender_address]
-  end
-
-  private
-  
-    def subject_line
-      #The subject prepend and append are useful for people to setup filters in mail clients.
-      user = config[:user] ? " by #{config[:user]}" : ""
-      middle = config[:subject] ? config[:subject] : "[#{config[:rails_env].upcase}][#{repo_end}] #{inferred_command}#{user}"
-      "#{config[:subject_prepend]}#{middle}#{config[:subject_append]}"
-    end
-
-    def body_data_hash
-      options[:data].merge({
-        :section_data     => section_data_hash,
-        :date             => date,
-        :time             => time,
-        :task_name        => task_name,
-        :inferred_command => inferred_command,
-        :repo_end         => repo_end,
-        :site_name        => config[:site_name],
-        :site_url         => config[:site_url],
-        :application      => config[:application],
-        :sections         => config[:sections]
-      })
-    end
-
-    def section_data_hash
-      {
-        :deployment             => section_hash_deployment,
-        :source_control         => section_hash_source_control,
-        :latest_release         => section_hash_latest_release,
-        :previous_release       => section_hash_previous_release,
-        :other_deployment_info  => section_hash_other_deployment_info,
-        :release_data           => options[:release_data],
-        :extra_information      => options[:extra_information]
-      }
-    end
-
-    def section_hash_deployment
-      {
-        :date             => date,
-        :time             => time,
-        :rails_env        => config[:rails_env],
-        :task_name        => task_name,
-        :inferred_command => inferred_command,
-        :host             => config[:host],
-        :release_name     => config[:release_name],
-        :release_notes    => config[:release_notes]
-      }
-    end
-
-    def section_hash_source_control
-      {
-        :revision         => config[:revision],
-        :released         => repo_end,
-        :repository       => config[:repository],
-        :branch           => config[:branch],
-        :scm              => config[:scm],
-        :deploy_via       => config[:deploy_via],
-        :deploy_to        => config[:deploy_to]
-      }
-    end
-
-    def section_hash_latest_release
-      {
-        :latest_release   => config[:latest_release],
-        :latest_revision  => config[:latest_revision],
-        :release_path     => config[:release_path],
-        :real_revision    => config[:real_revision],
-        :current_path     => config[:current_path]
-      }
-    end
-
-    def section_hash_previous_release
-      {
-        :current_release    => config[:current_release],
-        :current_revision   => config[:current_revision],
-        :previous_release   => config[:previous_release],
-        :previous_revision  => config[:previous_revision],
-        :releases           => config[:releases]
-      }
-    end
-
-    def section_hash_other_deployment_info
-      {
-        :version_dir    => config[:version_dir],
-        :shared_dir     => config[:shared_dir],
-        :current_dir    => config[:current_dir],
-        :releases_path  => config[:releases_path],
-        :shared_path    => config[:shared_path],
-        :run_method     => config[:run_method],
-        :ip_address     => config[:ip_address]
-      }
-    end
-end
+class CapMailer < ActionMailer::Base
+
+  @@default_base_config ||= {
+    :sender_address           => %("#{(defined?(Rails) ? Rails.env.capitalize : defined?(RAILS_ENV) ? RAILS_ENV.capitalize : defined?(ENV) ? ENV['RAILS_ENV'] : "")} Capistrano Deployment" <capistrano.mailer@example.com>),
+    :recipient_addresses      => [],
+    # Customize the subject line
+    :subject_prepend          => "[DEPLOYMENT]-[#{(defined?(Rails) ? Rails.env.capitalize : defined?(RAILS_ENV) ? RAILS_ENV.capitalize : defined?(ENV) ? ENV['RAILS_ENV'] : "")}] ",
+    :subject_append           => nil,
+    # Include which sections of the deployment email?
+    :sections                 => %w(deployment release_data source_control latest_release previous_release other_deployment_info extra_information),
+    :site_name                => "",
+    :email_content_type       => "text/html",
+    :template_root            => "#{File.dirname(__FILE__)}/../views"
+  }
+
+  cattr_accessor :default_base_config
+  attr_accessor  :config, :options
+  attr_accessor  :date, :time, :inferred_command, :task_name, :repo_end
+  
+  def self.configure(&block)
+    yield @@default_base_config
+  end
+
+  def self.configure_capistrano_mailer(&block)
+    puts "Deprecated 'configure_capistrano_mailer'.  Please update your capistrano_mailer configuration to use 'configure' instead of 'configure_capistrano_mailer'"
+  end
+
+  self.prepend_view_path default_base_config[:template_root]
+
+  def self.reloadable?() false end
+    
+  def notification_email(cap, config = {}, *args)
+    @options = { :release_data => {}, :extra_information => {}, :data => {} }.merge(args.extract_options!)
+    @config  = default_base_config.merge(config.reverse_merge({
+          :rails_env          => cap.rails_env,
+          :host               => cap.host,
+          :task_name          => cap.task_name,
+          :application        => cap.application,
+          :repository         => cap.repository,
+          :scm                => cap.scm,
+          :deploy_via         => cap.deploy_via,
+          :deploy_to          => cap.deploy_to,
+          :revision           => cap.revision,
+          :real_revision      => cap.real_revision,
+          :release_name       => cap.release_name,
+          #This does not appear to be a capistrano variable:
+          #:release_notes      => cap.release_notes,
+          :version_dir        => cap.version_dir,
+          :shared_dir         => cap.shared_dir,
+          :current_dir        => cap.current_dir,
+          :releases_path      => cap.releases_path,
+          :shared_path        => cap.shared_path,
+          :current_path       => cap.current_path,
+          :release_path       => cap.release_path,
+          :releases           => cap.releases,
+          :current_release    => cap.current_release,
+          :previous_release   => cap.previous_release,
+          :current_revision   => cap.current_revision,
+          :latest_revision    => cap.latest_revision,
+          :previous_revision  => cap.previous_revision,
+          :run_method         => cap.run_method,
+          :latest_release     => cap.latest_release
+    
+          #This does not appear to be a capistrano variable:
+          #:site_url           => cap.site_url
+    }))
+    
+    @date             = Date.today.to_s
+    @time             = Time.now.strftime("%I:%M %p").to_s
+    @inferred_command = "cap #{@config[:rails_env]} #{@config[:task_name]}"
+    @task_name        = @config[:task_name] || "unknown"
+    
+    repo  = @config[:repository]
+    x     = repo.include?('/') ? repo.rindex('/') - 1 : repo.length
+    front = repo.slice(0..x)
+    back  = repo.sub(front, '')
+    unless back == 'trunk'
+      x = front.include?('/') ? front.rindex('/') - 1 : front.length
+      front = front.slice(0..x)
+    end
+    @repo_end = repo.sub(front, '')
+
+    body_data_hash.each_pair do |k, v|
+      self.instance_variable_set("@#{k}", v)
+    end
+
+    mail :subject       => subject_line,
+         :to            => @config[:recipient_addresses],
+         :from          => @config[:sender_address]
+  end
+
+  private
+  
+    def subject_line
+      #The subject prepend and append are useful for people to setup filters in mail clients.
+      user = config[:user] ? " by #{config[:user]}" : ""
+      middle = config[:subject] ? config[:subject] : "[#{config[:rails_env].upcase}][#{repo_end}] #{inferred_command}#{user}"
+      "#{config[:subject_prepend]}#{middle}#{config[:subject_append]}"
+    end
+
+    def body_data_hash
+      options[:data].merge({
+        :section_data     => section_data_hash,
+        :date             => date,
+        :time             => time,
+        :task_name        => task_name,
+        :inferred_command => inferred_command,
+        :repo_end         => repo_end,
+        :site_name        => config[:site_name],
+        :site_url         => config[:site_url],
+        :application      => config[:application],
+        :sections         => config[:sections]
+      })
+    end
+
+    def section_data_hash
+      {
+        :deployment             => section_hash_deployment,
+        :source_control         => section_hash_source_control,
+        :latest_release         => section_hash_latest_release,
+        :previous_release       => section_hash_previous_release,
+        :other_deployment_info  => section_hash_other_deployment_info,
+        :release_data           => options[:release_data],
+        :extra_information      => options[:extra_information]
+      }
+    end
+
+    def section_hash_deployment
+      {
+        :date             => date,
+        :time             => time,
+        :rails_env        => config[:rails_env],
+        :task_name        => task_name,
+        :inferred_command => inferred_command,
+        :host             => config[:host],
+        :release_name     => config[:release_name],
+        :release_notes    => config[:release_notes]
+      }
+    end
+
+    def section_hash_source_control
+      {
+        :revision         => config[:revision],
+        :released         => repo_end,
+        :repository       => config[:repository],
+        :branch           => config[:branch],
+        :scm              => config[:scm],
+        :deploy_via       => config[:deploy_via],
+        :deploy_to        => config[:deploy_to]
+      }
+    end
+
+    def section_hash_latest_release
+      {
+        :latest_release   => config[:latest_release],
+        :latest_revision  => config[:latest_revision],
+        :release_path     => config[:release_path],
+        :real_revision    => config[:real_revision],
+        :current_path     => config[:current_path]
+      }
+    end
+
+    def section_hash_previous_release
+      {
+        :current_release    => config[:current_release],
+        :current_revision   => config[:current_revision],
+        :previous_release   => config[:previous_release],
+        :previous_revision  => config[:previous_revision],
+        :releases           => config[:releases]
+      }
+    end
+
+    def section_hash_other_deployment_info
+      {
+        :version_dir    => config[:version_dir],
+        :shared_dir     => config[:shared_dir],
+        :current_dir    => config[:current_dir],
+        :releases_path  => config[:releases_path],
+        :shared_path    => config[:shared_path],
+        :run_method     => config[:run_method],
+        :ip_address     => config[:ip_address]
+      }
+    end
+end

data/lib/capistrano/mailer.rb

@@ -1,25 +1,25 @@
-require 'rubygems' unless defined?(Rubygems)
-require 'capistrano' unless defined?(Capistrano)
-
-unless Capistrano::Configuration.respond_to?(:instance)
-  abort "capistrano/mailer requires Capistrano 2"
-end
-
-require 'action_mailer' unless defined?(ActionMailer)
-
-require 'cap_mailer' unless defined?(CapMailer)
-
-
-module Capistrano
-  class Configuration
-    module CapistranoMailer
-      def send_notification_email(cap, config = {}, *args)
-        CapMailer.notification_email(cap, config, *args).deliver
-      end
-    end
-
-    include CapistranoMailer
-  end
-end
-
-Capistrano.plugin :mailer, Capistrano::Configuration::CapistranoMailer
+require 'rubygems' unless defined?(Rubygems)
+require 'capistrano' unless defined?(Capistrano)
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano/mailer requires Capistrano 2"
+end
+
+require 'action_mailer' unless defined?(ActionMailer)
+
+require 'cap_mailer' unless defined?(CapMailer)
+
+
+module Capistrano
+  class Configuration
+    module CapistranoMailer
+      def send_notification_email(cap, config = {}, *args)
+        CapMailer.notification_email(cap, config, *args).deliver
+      end
+    end
+
+    include CapistranoMailer
+  end
+end
+
+Capistrano.plugin :mailer, Capistrano::Configuration::CapistranoMailer

data/views/cap_mailer/_section.html.erb

@@ -1,31 +1,31 @@
-<div style="margin: 20px; padding: 0 0 20px 0;">
-
-  <h2 style="margin: 0px; padding: 10px 10px 5px 10px; background: #eee; border-left: 10px solid #ccc; color: #333;">
-    <%= section_title.titleize unless section_title.nil? -%>
-  </h2>
-  <% if data.is_a?(Array) then data = data[0] end -%>
-  <% arr = case section_title
-      when 'deployment'
-        [:date,:time,:rails_env,:task_name,:inferred_command,:host,:release_name,:release_notes]
-      when 'source_control'
-        [:scm,:released,:branch,:revision,:deploy_via,:deploy_to,:repository]
-      when 'latest_release'
-        [:latest_release,:latest_revision,:real_revision,:release_path,:current_path]
-      when 'previous_release'
-        [:current_release,:current_revision,:previous_release,:previous_revision,:releases]
-      when 'other_deployment_info'
-        [:ip_address,:run_method,:source,:strategy,:version_dir,:shared_dir,:current_dir,:releases_path,:shared_path]
-      end -%>
-  <% if !arr.nil? && arr.is_a?(Array) %>
-    <% arr.each do |key| -%>
-      <% if key.is_a?(Symbol) && !data[key].nil?-%>
-        <p style="margin: 10px; padding: 0px;">
-          <span style="float:left; width:150px; padding: 10px 10px 0;"><%= key.to_s.titleize %></span>
-          <span style="float:left; width:490px; padding: 10px 10px 0;"><%= data[key].is_a?(Array) ? data[key].to_sentence : data[key].is_a?(String) ? data[key].gsub(/\n/, '<br>').gsub(/\n/, '<br>').html_safe : data[key].inspect.html_safe %></span>
-        </p>
-      <% end -%>
-    <% end -%>
-  <% end -%>
-  <p style="clear:both"></p>
-  
-</div>
+<div style="margin: 20px; padding: 0 0 20px 0;">
+
+  <h2 style="margin: 0px; padding: 10px 10px 5px 10px; background: #eee; border-left: 10px solid #ccc; color: #333;">
+    <%= section_title.titleize unless section_title.nil? -%>
+  </h2>
+  <% if data.is_a?(Array) then data = data[0] end -%>
+  <% arr = case section_title
+      when 'deployment'
+        [:date,:time,:rails_env,:task_name,:inferred_command,:host,:release_name,:release_notes]
+      when 'source_control'
+        [:scm,:released,:branch,:revision,:deploy_via,:deploy_to,:repository]
+      when 'latest_release'
+        [:latest_release,:latest_revision,:real_revision,:release_path,:current_path]
+      when 'previous_release'
+        [:current_release,:current_revision,:previous_release,:previous_revision,:releases]
+      when 'other_deployment_info'
+        [:ip_address,:run_method,:source,:strategy,:version_dir,:shared_dir,:current_dir,:releases_path,:shared_path]
+      end -%>
+  <% if !arr.nil? && arr.is_a?(Array) %>
+    <% arr.each do |key| -%>
+      <% if key.is_a?(Symbol) && !data[key].nil?-%>
+        <p style="margin: 10px; padding: 0px;">
+          <span style="float:left; width:150px; padding: 10px 10px 0;"><%= key.to_s.titleize %></span>
+          <span style="float:left; width:490px; padding: 10px 10px 0;"><%= data[key].is_a?(Array) ? data[key].to_sentence : data[key].is_a?(String) ? data[key].gsub(/\n/, '<br>').gsub(/\n/, '<br>').html_safe : data[key].inspect.html_safe %></span>
+        </p>
+      <% end -%>
+    <% end -%>
+  <% end -%>
+  <p style="clear:both"></p>
+  
+</div>

data/views/cap_mailer/_section.text.erb

@@ -1,23 +1,23 @@
-<%= section_title.titleize unless section_title.nil? -%>
-===========================================================
-
-<% if data.is_a?(Array) then data = data[0] end -%>
-<% arr = case section_title
-    when 'deployment'
-      [:date,:time,:rails_env,:task,:inferred_command,:host,:release_name,:release_notes]
-    when 'source_control'
-      [:scm,:released,:branch,:revision,:deploy_via,:deploy_to,:repository]
-    when 'latest_release'
-      [:latest_release,:latest_revision,:real_revision,:release_path,:current_path]
-    when 'previous_release'
-      [:current_release,:current_revision,:previous_release,:previous_revision,:releases]
-    when 'other_deployment_info'
-      [:ip_address,:run_method,:source,:strategy,:version_dir,:shared_dir,:current_dir,:releases_path,:shared_path]
-    end -%>
-<% if !arr.nil? && arr.is_a?(Array) %>
-  <% arr.each do |key| -%>
-    <% if key.is_a?(Symbol) && !data[key].nil?-%>
-        <%= key.to_s.titleize %>                <%= data[key].is_a?(Array) ? data[key].to_sentence : data[key].is_a?(String) ? data[key] : data[key].inspect %>
-    <% end -%>
-  <% end -%>
-<% end -%>
+<%= section_title.titleize unless section_title.nil? -%>
+===========================================================
+
+<% if data.is_a?(Array) then data = data[0] end -%>
+<% arr = case section_title
+    when 'deployment'
+      [:date,:time,:rails_env,:task,:inferred_command,:host,:release_name,:release_notes]
+    when 'source_control'
+      [:scm,:released,:branch,:revision,:deploy_via,:deploy_to,:repository]
+    when 'latest_release'
+      [:latest_release,:latest_revision,:real_revision,:release_path,:current_path]
+    when 'previous_release'
+      [:current_release,:current_revision,:previous_release,:previous_revision,:releases]
+    when 'other_deployment_info'
+      [:ip_address,:run_method,:source,:strategy,:version_dir,:shared_dir,:current_dir,:releases_path,:shared_path]
+    end -%>
+<% if !arr.nil? && arr.is_a?(Array) %>
+  <% arr.each do |key| -%>
+    <% if key.is_a?(Symbol) && !data[key].nil?-%>
+        <%= key.to_s.titleize %>                <%= data[key].is_a?(Array) ? data[key].to_sentence : data[key].is_a?(String) ? data[key] : data[key].inspect %>
+    <% end -%>
+  <% end -%>
+<% end -%>

data/views/cap_mailer/notification_email.html.erb

@@ -1,39 +1,39 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-	<head>
-		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-		<title><%= @site_name %> Notification </title>
-	</head>
-	<body style="font: 14px normal Helvetica, Arial, Sans; background: #999;">
-  
-    <div style="width:800px; margin: 10px auto; background: #fff; border: 10px solid #aaa;">
-
-      <h1 style="clear: both; margin: 0; padding: 40px 20px 5px 20px; border-bottom: 1px dotted; background: #ccc;">
-        <%= @site_name %> <%=@task_name.titleize unless @task_name.nil? %>
-      </h1>
-
-      <% unless @site_url.nil? %>
-        <p style="margin: 8px 0 20px 20px; padding: 0px; font-style: italic;" >
-          View site: <a href="<%= @site_url.html_safe -%>"><%= @site_url.html_safe -%></a>
-        </p>
-      <% end %>
-
-      <p style="margin: 10px 20px; font-weight: bold;">Released: <%= @date %> at <%= @time %></p>
-      
-      <%= @sections.map { |section|
-        data = @section_data[section.to_sym]
-        if !data.empty?
-          if %w(extra_information release_data).include?(section)
-            render :partial => 'section_custom.html.erb', :locals => {:section_title => section, :data => data}
-          else
-            render :partial => 'section.html.erb', :locals => {:section_title => section, :data => data}
-          end
-        end
-      }.join.html_safe unless @sections.nil? %>
-   </div>
-   
-    <p style="margin: 8px 0 20px 20px; padding: 0px; font-style: italic;" >
-      Brought to you by: <a href="http://github.com/textgoeshere/capistrano_mailer">Capistrano Mailer</a>
-    </p>
-	</body>
-</html>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+		<title><%= @site_name %> Notification </title>
+	</head>
+	<body style="font: 14px normal Helvetica, Arial, Sans; background: #999;">
+  
+    <div style="width:800px; margin: 10px auto; background: #fff; border: 10px solid #aaa;">
+
+      <h1 style="clear: both; margin: 0; padding: 40px 20px 5px 20px; border-bottom: 1px dotted; background: #ccc;">
+        <%= @site_name %> <%=@task_name.titleize unless @task_name.nil? %>
+      </h1>
+
+      <% unless @site_url.nil? %>
+        <p style="margin: 8px 0 20px 20px; padding: 0px; font-style: italic;" >
+          View site: <a href="<%= @site_url.html_safe -%>"><%= @site_url.html_safe -%></a>
+        </p>
+      <% end %>
+
+      <p style="margin: 10px 20px; font-weight: bold;">Released: <%= @date %> at <%= @time %></p>
+      
+      <%= @sections.map { |section|
+        data = @section_data[section.to_sym]
+        if !data.empty?
+          if %w(extra_information release_data).include?(section)
+            render :partial => 'section_custom.html.erb', :locals => {:section_title => section, :data => data}
+          else
+            render :partial => 'section.html.erb', :locals => {:section_title => section, :data => data}
+          end
+        end
+      }.join.html_safe unless @sections.nil? %>
+   </div>
+   
+    <p style="margin: 8px 0 20px 20px; padding: 0px; font-style: italic;" >
+      Brought to you by: <a href="http://github.com/textgoeshere/capistrano_mailer">Capistrano Mailer</a>
+    </p>
+	</body>
+</html>

data/views/cap_mailer/notification_email.text.erb

@@ -1,22 +1,22 @@
-<%= @site_name %> Notification
-===========================================================
-
-    <%= @site_name %> <%=@task_name.titleize unless @task_name.nil? %>
-===========================================================
-      Brought to you by: Capistrano Mailer - http://github.com/pboling/capistrano_mailer
-      Released: <%= @date %> at <%= @time %>
-      
-      <%= @sections.map { |section|
-        data = @section_data[section.to_sym]
-        if !data.empty?
-          if %w(extra_information release_data).include?(section)
-            render :partial => 'section_custom.text.erb', :locals => {:section_title => section, :data => data}
-          else
-            render :partial => 'section.text.erb', :locals => {:section_title => section, :data => data}
-          end
-        end
-      }.join.html_safe unless @sections.nil? %>
-
-===========================================================
-    Copyright 2009 9thBit LLC under MIT License
-    Copyright 2007-8 Sagebit LLC under MIT License
+<%= @site_name %> Notification
+===========================================================
+
+    <%= @site_name %> <%=@task_name.titleize unless @task_name.nil? %>
+===========================================================
+      Brought to you by: Capistrano Mailer - http://github.com/pboling/capistrano_mailer
+      Released: <%= @date %> at <%= @time %>
+      
+      <%= @sections.map { |section|
+        data = @section_data[section.to_sym]
+        if !data.empty?
+          if %w(extra_information release_data).include?(section)
+            render :partial => 'section_custom.text.erb', :locals => {:section_title => section, :data => data}
+          else
+            render :partial => 'section.text.erb', :locals => {:section_title => section, :data => data}
+          end
+        end
+      }.join.html_safe unless @sections.nil? %>
+
+===========================================================
+    Copyright 2009 9thBit LLC under MIT License
+    Copyright 2007-8 Sagebit LLC under MIT License

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano_mailer
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2011-12-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &70339020048080 !ruby/object:Gem::Requirement
+  requirement: &70226373536920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,7 +23,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339020048080
+  version_requirements: *70226373536920
 description: Capistrano Deployment Email Notification.  Keep the whole team informed
   of each release!
 email: