capistrano_mailer 3.1.10 → 3.2.1

data/README.rdoc

@@ -1,4 +1,4 @@
-= Capistrano Mailer v3.1.3 (20090925)
+= Capistrano Mailer
 
   * For Capistrano Deployment Email Notification 
   * It is a Capistrano Plugin / Ruby Gem that requires ActionMailer
@@ -22,7 +22,7 @@ The first time you deploy to a server (a 'cold' deploy) capistrano mailer will c
 
 == Home Page
 
-http://github.com/pboling/capistrano_mailer/tree/master
+http://github.com/pboling/capistrano_mailer
 
 
 == Credit where Credit is Due
@@ -62,7 +62,7 @@ Then cd to your rails app to optionally freeze the gem into your app:
 
   rake gems:freeze GEM=capistrano_mailer
   # You do NOT need to add a config.gem line to environment.rb for capistrano mailer,
-  # But in order to use the gems:freeze task you DO need ot add it as a config.gem, at least temporarily.
+  # But in order to use the gems:freeze task you DO need to add it as a config.gem, at least temporarily.
 
 Plugin using Git:
 
@@ -75,9 +75,14 @@ Using SVN (deprecated, repository is no longer updated):
 
 == Upgrading
 
-From version 2.1.0 to version 3.x.x:
+From version 3.1.x to version 3.2.x
 
-1. Update the way CapistranoMailer is configured using the new method: CapMailer.configure_capistrano_mailer, see below.
+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.
 
@@ -87,17 +92,21 @@ From version 2.1.0 to version 3.x.x:
 
   2. Add this line to the top of your config/deploy.rb:
 
-    # For gem:
-    #   You do NOT need to register the gem in your environment file using config.gem
-    require 'capistrano/mailer'
-
     # 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'
+
+    # 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. Add a cap_mailer_settings.rb file to your config/ directory:
+  3. Configure Caistrano Mailer in the settings file required in step 2:
 
     # If installed as a plugin might need the require here as well
     
@@ -112,7 +121,7 @@ From version 2.1.0 to version 3.x.x:
         :authentication => :login }
     ActionMailer::Base.default_charset = "utf-8"# or "latin1" or whatever you are using
     
-    CapMailer.configure_capistrano_mailer do |config|
+    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
@@ -139,48 +148,7 @@ From version 2.1.0 to version 3.x.x:
       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([
-                          :rails_env => rails_env, 
-                          :host => host, 
-                          :task_name => task_name, 
-                          :application => application,
-                          :repository => repository,
-                          :scm => scm,
-                          :deploy_via => deploy_via,
-                          :deploy_to => deploy_to,
-                          :revision => revision,
-                          :real_revision => real_revision,
-                          :release_name => release_name,
-                          :version_dir => version_dir,
-                          :shared_dir => shared_dir,
-                          :current_dir => current_dir,
-                          :releases_path => releases_path,
-                          :shared_path => shared_path,
-                          :current_path => current_path,
-                          :release_path => release_path,
-                          :releases => releases,
-                          :current_release => current_release,
-                          :previous_release => previous_release,
-                          :current_revision => current_revision,
-                          :latest_revision => latest_revision,
-                          :previous_revision => previous_revision,
-                          :run_method => run_method,
-                          :latest_release => latest_release,
-                    ],[   # Send some custom vars you've setup in your deploy.rb to be sent out with the notification email!
-                          # will be rendered as a section of the email called 'Release Data'
-                          #:some_other_var1 => some_other_var1,
-                          #:some_other_var2 => some_other_var2,
-                          #:some_other_var3 => some_other_var3
-                    ],[   # Send some more custom vars you've setup in your deploy.rb to be sent out with the notification email!
-                          # will be rendered as a section of the email called 'Extra Information'
-                          #:some_other_var4 => some_other_var4,
-                          #:some_other_var5 => some_other_var5,
-                          #:some_other_var6 => some_other_var6
-                    ],[ # and even more!!!
-                        # these will not be rendered as a section, but will be passed to the email template in the @data hash,
-                        # and be available there if you want to write your own template
-                    ]
-                  )
+        mailer.send_notification_email(self)
       end
     
       ...
@@ -189,13 +157,15 @@ From version 2.1.0 to version 3.x.x:
   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!
 
-  The only parameter to mailer.send_notification_email that is *required* is the first array of hashes, and _minimally_ it needs the keys:
+  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!
@@ -222,6 +192,16 @@ From version 2.1.0 to version 3.x.x:
 
   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
+Dave Nolan (textgoeshere) - lots of refactoring merged into 3.2 release
+
+== Contributors
+
+Dustin Deyoung - HTML Email Templates
+mixonix - SCMs compatibility
+greut - SCMs compatibility
 
 ----------------------------------------------------------------------------------
   This plugin is a collaboration between Sagebit, LLC (http://www.sagebit.com) and Peter Boling (http://www.peterboling.com).

data/Rakefile

@@ -8,9 +8,9 @@ begin
     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"
+    gemspec.email = ["peter.boling@gmail.com", "dave@textgoeshere.org.uk"]
     gemspec.homepage = "http://github.com/pboling/capistrano_mailer"
-    gemspec.authors = ["Peter Boling"]
+    gemspec.authors = ["Peter Boling", "Dave Nolan"]
     gemspec.add_dependency 'actionmailer'
     gemspec.files = ["README.rdoc",
              "capistrano_mailer.gemspec",
@@ -29,7 +29,7 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
 end
 
 desc 'Default: run unit tests.'

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 3
-:minor: 1
-:patch: 10
+:minor: 2
+:patch: 1
 :build: 

data/about.yml

@@ -5,5 +5,5 @@ summary: Sends rails deployment notification emails from Capistrano
 homepage: http://github.com/pboling/capistrano_mailer/tree/master
 plugin: http://github.com/pboling/capistrano_mailer.git
 license: MIT
-version: 3.1.3
+version: 3.2.1
 rails_version: 1.2.6+

data/capistrano_mailer.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capistrano_mailer}
-  s.version = "3.1.10"
+  s.version = "3.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Peter Boling"]
-  s.date = %q{2010-01-07}
+  s.authors = ["Peter Boling", "Dave Nolan"]
+  s.date = %q{2010-01-13}
   s.description = %q{Capistrano Deployment Email Notification.  Keep the whole team informed of each release!}
-  s.email = %q{peter.boling@gmail.com}
+  s.email = ["peter.boling@gmail.com", "dave@textgoeshere.org.uk"]
   s.extra_rdoc_files = [
     "README.rdoc"
   ]

data/lib/cap_mailer.rb

@@ -1,6 +1,6 @@
 class CapMailer < ActionMailer::Base
 
-  @@config ||= {
+  @@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
@@ -13,122 +13,164 @@ class CapMailer < ActionMailer::Base
     :template_root            => "#{File.dirname(__FILE__)}/../views"
   }
 
-  cattr_accessor :config
+  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)
-    yield @@config
+    puts "Deprecated 'configure_capistrano_mailer'.  Please update your capistrano_mailer configuration to use 'configure' instead of 'configure_capistrano_mailer'"
   end
 
-  self.template_root = config[:template_root]
+  self.template_root = default_base_config[:template_root]
 
   def self.reloadable?() false end
-
-  def notification_email(cap_vars, release_data = {}, extra_information = {}, data = {})
-    body_hash = body_data_hash(cap_vars, release_data = {}, extra_information = {}, data = {})
-    subject       "#{config[:subject_prepend]}[#{cap_vars.first[:rails_env].upcase}][#{body_hash[:repo_end]}] #{body_hash[:inferred_command]}#{config[:subject_append]}"
-    recipients    config[:recipient_addresses]
-    from          config[:sender_address]
-    content_type  config[:email_content_type]
-
-    body          body_hash
+    
+  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,
+          :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, '')
+	  
+    subject       subject_line
+    recipients    @config[:recipient_addresses]
+    from          @config[:sender_address]
+    content_type  @config[:email_content_type]
+
+    body          body_data_hash
   end
 
   private
+  
+    def subject_line
+      config[:subject] || "[#{config[:application]}] #{inferred_command} by #{config[:user]}"
+    end
 
-    def body_data_hash(cap_vars, release_data = {}, extra_information = {}, data = {})
-      date = Date.today.to_s
-      time = Time.now.strftime("%I:%M %p").to_s
-      inferred_command = "cap #{cap_vars.first[:rails_env]} #{cap_vars.first[:task_name]}"
-      repo = cap_vars.first[: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, '')
-      task_name = cap_vars.first[:task_name] || "unknown"
-
-      return data.merge({
-        :section_data => section_data_hash(cap_vars, date, time, task_name, inferred_command, repo_end, release_data, extra_information),
-        :date => date,
-        :time => time,
-        :task_name => task_name,
+    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],
-        :application => cap_vars.first[:application],
-        :sections => config[:sections]
+        :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(cap_vars, date, time, task_name, inferred_command, repo_end, release_data, extra_information)
+    def section_data_hash
       {
-        :deployment => section_hash_deployment(cap_vars, date, time, task_name, inferred_command),
-        :source_control => section_hash_source_control(cap_vars, repo_end),
-        :latest_release => section_hash_latest_release(cap_vars),
-        :previous_release => section_hash_previous_release(cap_vars),
-        :other_deployment_info => section_hash_other_deployment_info(cap_vars),
-        :release_data => release_data,
-        :extra_information => extra_information
+        :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(cap_vars, date, time, task_name, inferred_command)
+    def section_hash_deployment
       {
-        :date => date,
-        :time => time,
-        :rails_env => cap_vars.first[:rails_env],
-        :task_name => task_name,
+        :date             => date,
+        :time             => time,
+        :rails_env        => config[:rails_env],
+        :task_name        => task_name,
         :inferred_command => inferred_command,
-        :host => cap_vars.first[:host],
-        :release_name => cap_vars.first[:release_name]
+        :host             => config[:host],
+        :release_name     => config[:release_name]
       }
     end
 
-    def section_hash_source_control(cap_vars, repo_end)
+    def section_hash_source_control
       {
-        :revision => cap_vars.first[:revision],
-        :released => repo_end,
-        :repository => cap_vars.first[:repository],
-        :branch => cap_vars.first[:branch],
-        :scm => cap_vars.first[:scm],
-        :deploy_via => cap_vars.first[:deploy_via],
-        :deploy_to => cap_vars.first[:deploy_to]
+        :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(cap_vars)
+    def section_hash_latest_release
       {
-        :latest_release => cap_vars.first[:latest_release],
-        :latest_revision => cap_vars.first[:latest_revision],
-        :release_path => cap_vars.first[:release_path],
-        :real_revision => cap_vars.first[:real_revision],
-        :current_path => cap_vars.first[:current_path]
+        :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(cap_vars)
+    def section_hash_previous_release
       {
-        :current_release => cap_vars.first[:current_release],
-        :current_revision => cap_vars.first[:current_revision],
-        :previous_release => cap_vars.first[:previous_release],
-        :previous_revision => cap_vars.first[:previous_revision],
-        :releases => cap_vars.first[:releases]
+        :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(cap_vars)
+    def section_hash_other_deployment_info
       {
-        :version_dir => cap_vars.first[:version_dir],
-        :shared_dir => cap_vars.first[:shared_dir],
-        :current_dir => cap_vars.first[:current_dir],
-        :releases_path => cap_vars.first[:releases_path],
-        :shared_path => cap_vars.first[:shared_path],
-        :run_method => cap_vars.first[:run_method],
-        :ip_address => cap_vars.first[:ip_address]
+        :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,5 +1,6 @@
 require 'rubygems' unless defined?(Rubygems)
 require 'capistrano' unless defined?(Capistrano)
+require 'active_support'
 
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "capistrano/mailer requires Capistrano 2"
@@ -9,15 +10,12 @@ require 'action_mailer' unless defined?(ActionMailer)
 
 require 'cap_mailer' unless defined?(CapMailer)
 
-# ActionMailer configuration in the rails app
-require 'config/cap_mailer_settings'
-
 
 module Capistrano
   class Configuration
     module CapistranoMailer
-      def send_notification_email(cap_vars, extra = {}, data = {})
-        CapMailer.deliver_notification_email(cap_vars, extra, data)
+      def send_notification_email(cap, config = {}, *args)
+        CapMailer.deliver_notification_email(cap, config, args)
       end
     end
 

data/views/cap_mailer/notification_email.text.html.erb

@@ -7,15 +7,17 @@
 	<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>
 
-      <p style="margin: 8px 0 20px 20px; padding: 0px; font-style: italic;" >
-        Brought to you by: <a href="http://github.com/pboling/capistrano_mailer">Capistrano Mailer</a>
-      </p>
-      
+      <% unless @site_url.nil? %>
+        <p style="margin: 8px 0 20px 20px; padding: 0px; font-style: italic;" >
+          View site: <a href="<%= @site_url -%>"><%= @site_url -%></a>
+        </p>
+      <% end %>
+
       <p style="margin: 10px 20px; font-weight: bold;">Released: <%= @date %> at <%= @time %></p>
       
       <%= @sections.map { |section|
@@ -30,9 +32,8 @@
       }.join unless @sections.nil? %>
    </div>
    
-   <div style="text-align:center;">
-     &copy; 2009 <a href="http://www.9thbit.net">9thBit LLC</a>, MIT License<br/>
-     &copy; 2007-8 <a href="http://www.sagebit.com">Sagebit LLC</a>, MIT License
-   </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>

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano_mailer
 version: !ruby/object:Gem::Version 
-  version: 3.1.10
+  version: 3.2.1
 platform: ruby
 authors: 
 - Peter Boling
+- Dave Nolan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-07 00:00:00 -05:00
+date: 2010-01-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +24,9 @@ dependencies:
         version: "0"
     version: 
 description: Capistrano Deployment Email Notification.  Keep the whole team informed of each release!
-email: peter.boling@gmail.com
+email: 
+- peter.boling@gmail.com
+- dave@textgoeshere.org.uk
 executables: []
 
 extensions: []