actionmailer-callbacks 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in actionmailer-callbacks.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+# ActionMailer Callbacks
+
+[![Build Status](https://secure.travis-ci.org/spaghetticode/actionmailer-callbacks.png)](http://travis-ci.org/spaghetticode/actionmailer-callbacks)
+
+This gem adds the following methods to ActionMailer, similar to ActionController
+before/after filters:
+
+```ruby
+  before_create  :log_params,   :except => :test_email
+  after_create   :alert_police, :only   => :robbery_alert
+  before_deliver :apply_stamp,  :except => [:postage_prepaid, :test_email]
+  after_deliver  :log_success
+  around_create  :benchmark
+  around_deliver :benckmark
+```
+
+## Requirements
+
+This gem is tested only with ActionMailer 2.3.x, gem version dependencies are
+strict because I needed it to work only on those specific versions. Probably it
+will work with other versions too, as long as the creation/delivery interface of
+ActionMailer::Base class is still the same.
+
+## Notes
+
+*before_create* is executed even if the mail instantiation process fails due to
+some error.
+Since no mail has been created at this point, you can't do that much here,
+basically it's useful to inspect or log params. You can access the params
+anywhere via *@params* instance variable.
+
+*around_create* and *around_deliver* wrap the mail method execution (and all
+callbacks). You can use them for rescuing from errors or for benchmarking, for
+example.
+There can be only 1 around_create or around_deliver method for each email method,
+if there are more than 1 only the first will be executed.
+
+## Example
+
+```ruby
+  class UserMailer < ActionMailer::Base
+    before_create :log_params
+    after_deliver :log_success
+    around_create :rescue_from_errors
+
+    def user_registration(user)
+      # this is a regular ActionMailer email method
+    end
+
+    private
+
+    def log_params
+      MailerLogger.info "[CREATE] #{params_inspector}"
+    end
+
+    def log_success
+      MailerLogger.info "[DELIVERED] #{params_inspector}"
+    end
+
+    def rescue_from_errors
+      begin
+        yield
+      rescue
+        puts 'An error occured!'
+      end
+    end
+
+    def params_inspector
+      @params.present? && @params.inject([]) do |lines, param|
+        message = begin
+          if param.is_a?(ActiveRecord::Base)
+            "#{param.class.name.downcase}.id = #{param.id}"
+          else
+            param
+          end
+        end
+        lines << message
+      end.join(', ')
+    end
+  end
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run those specs"
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = %w{--colour --format progress}
+    t.pattern = 'spec/**/*_spec.rb'
+    t.rspec_path = 'bundle exec rspec'
+  end
+end
+
+task :default => :spec

data/actionmailer-callbacks.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'actionmailer/callbacks/version'
+
+Gem::Specification.new do |s|
+  s.name        = "actionmailer-callbacks"
+  s.version     = Actionmailer::Callbacks::VERSION
+  s.authors     = ["andrea longhi"]
+  s.email       = ["andrea@spaghetticode.it"]
+  s.homepage    = ""
+  s.summary     = %q{add callbacks to actionmailer 2.3.11}
+  s.description = %q{add callbacks to actionmailer 2.3.11}
+
+  # s.rubyforge_project = 'actionmailer-callbacks'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_runtime_dependency 'activesupport', '~> 2.3.11'
+  s.add_runtime_dependency 'actionmailer',  '~> 2.3.11'
+end

data/lib/actionmailer-callbacks.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'active_support'
+require 'action_mailer'
+
+module ActionMailer
+  module Callbacks
+  end
+end
+
+require 'actionmailer/callbacks/version'
+require 'actionmailer/callbacks/callback'
+require 'actionmailer/callbacks/methods'
+
+ActionMailer::Base.send :include, ActionMailer::Callbacks::Methods

data/lib/actionmailer/callbacks/callback.rb

@@ -0,0 +1,22 @@
+module ActionMailer
+  module Callbacks
+    # this object stores the callback data
+    class Callback
+      attr_accessor :name, :except, :only
+
+      def initialize(callback_name, opts={})
+        @name   = callback_name
+        @only   = Array.wrap(opts[:only]).map(&:to_s)
+        @except = Array.wrap(opts[:except]).map(&:to_s)
+      end
+
+      def should_run?(mailer_method)
+        if @only.present?
+          @only.include?(mailer_method.to_s)
+        else
+          !@except.include?(mailer_method.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/actionmailer/callbacks/methods.rb

@@ -0,0 +1,116 @@
+# this implements those class methods to be used in your mailer model:
+# after_create   :do_something
+# before_deliver :log_data
+# after_deliver :log_data, :only   => :notify_customer
+# after_deliver :log_data, :except => [:notify_customer, :send_xmas_regards]
+
+module ActionMailer
+  module Callbacks
+    module Methods
+      CALLBACK_TYPES = %w[before_create after_create before_deliver after_deliver]
+      AROUND_METHODS = %w[around_create around_deliver]
+
+      def self.included(base)
+        base.extend ClassMethods
+        base.alias_method_chain :create!,  :create_callbacks
+        base.alias_method_chain :deliver!, :deliver_callbacks
+      end
+
+      module ClassMethods
+        # this creates a series of methods like these:
+        # def after_create(*args)
+        #   after_create_callbacks << Callback.new(*args)
+        # end
+
+        # def after_create_callbacks
+        #   @after_create_callbacks ||= []
+        # end
+        CALLBACK_TYPES.each do |type|
+          define_method type do |*args|
+            send("#{type}_callbacks") << Callback.new(*args)
+          end
+
+          name = "#{type}_callbacks"
+          define_method name do
+            instance_variable_get("@#{name}") || instance_variable_set("@#{name}", [])
+          end
+        end
+
+        def clear_callbacks
+          CALLBACK_TYPES.each do |type|
+            instance_variable_set "@#{type}_callbacks", []
+          end
+        end
+
+        def around_create(*args)
+          around_create_methods << Callback.new(*args)
+        end
+
+        def around_create_methods
+          @around_create_methods ||= []
+        end
+
+        def around_deliver(*args)
+          around_deliver_methods << Callback.new(*args)
+        end
+
+        def around_deliver_methods
+          @around_deliver_methods ||= []
+        end
+      end
+
+      def create_with_create_callbacks!(*args)
+        @params = args
+        run_around_create_method do
+          run_before_create_callbacks
+          create_without_create_callbacks!(*args)
+          run_after_create_callbacks
+          @mail
+        end
+      end
+
+      def deliver_with_deliver_callbacks!(*args)
+        run_around_deliver_method do
+          run_before_deliver_callbacks
+          deliver_without_deliver_callbacks!(*args)
+          run_after_deliver_callbacks
+          @mail
+        end
+      end
+
+      # this creates a series of methods similar to this:
+      # def run_after_create_callbacks
+      #   self.class.send('after_create_callbacks').each do |callback|
+      #     send callback.name if callback.should_run?(@params.first)
+      #   end
+      # end
+      CALLBACK_TYPES.each do |type|
+        define_method "run_#{type}_callbacks" do
+          self.class.send("#{type}_callbacks").each do |callback|
+            send callback.name if callback.should_run?(@params.first)
+          end
+        end
+      end
+
+      def run_around_create_method(&block)
+        self.class.send('around_create_methods').each do |callback|
+          if callback.should_run?(@params.first)
+            send callback.name, &block
+            return
+          end
+        end
+        block.call
+      end
+
+      def run_around_deliver_method(&block)
+        self.class.send('around_deliver_methods').each do |callback|
+          if callback.should_run?(@params.first)
+            send callback.name, &block
+            return
+          end
+        end
+        block.call
+      end
+    end
+  end
+end

data/lib/actionmailer/callbacks/version.rb

@@ -0,0 +1,5 @@
+module Actionmailer
+  module Callbacks
+    VERSION = '0.0.1'
+  end
+end

data/spec/callback_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe ActionMailer::Callbacks::Callback do
+  describe 'a new callback' do
+    let(:callback) { ActionMailer::Callbacks::Callback.new('name', :except => ['except', :notthis], :only => :yesthis) }
+
+    it 'should have "name", "except", "only" accessors' do
+      %w[name except only].each do |attribute|
+        callback.send "#{attribute}=", 'asd'
+        callback.send(attribute).should == 'asd'
+      end
+    end
+
+    it 'should stringify symbols in "except" and "only" arrays' do
+      callback.instance_eval do
+        @except.should == ['except', 'notthis']
+      end
+    end
+  end
+
+  describe 'should_run?' do
+    context 'when "except" is set' do
+      let(:callback) { ActionMailer::Callbacks::Callback.new('name', :except => ['except']) }
+      it 'should be false for except' do
+        callback.should_run?('except').should be_false
+      end
+
+      it 'be true for anything else' do
+        callback.should_run?('other').should be_true
+      end
+    end
+
+    context 'when "only" is set' do
+      let(:callback) { ActionMailer::Callbacks::Callback.new('name', :only => :this_method_name)}
+
+      it 'should be be true for this_method_name' do
+        callback.should_run?('this_method_name').should be_true
+      end
+
+      it 'should be be false for anything else' do
+        callback.should_run?('another_method_name').should be_false
+      end
+    end
+
+    context 'when neither "except" or "only" are set' do
+      let(:callback) { ActionMailer::Callbacks::Callback.new('name') }
+
+      it 'should be true for any method' do
+        callback.should_run?('any_method_name').should be_true
+      end
+    end
+  end
+end

data/spec/fixtures/mailer_with_callbacks.rb

@@ -0,0 +1,49 @@
+class MailerWithCallbacks < ActionMailer::Base
+  before_create  :set_before_create_flag,  :except => :no_callback
+  after_create   :set_after_create_flag,   :except => [:no_callback]
+  before_deliver :set_before_deliver_flag, :only   => :test_email
+  after_deliver  :set_after_deliver_flag
+  around_create  :create_wrapper_flag
+  around_deliver :deliver_wrapper_flag
+
+  def test_email(recipient)
+    recipients recipient
+     from      'test@test.com'
+     subject   'test email'
+     body      'a test email'
+  end
+
+  def no_callback(recipient)
+    test_email(recipient)
+  end
+
+  private
+
+    def create_wrapper_flag
+      Flag.create_before_block_call = true
+      yield
+      Flag.create_after_block_call = true
+    end
+
+    def deliver_wrapper_flag
+      Flag.deliver_before_block_call = true
+      yield
+      Flag.deliver_after_block_call = true
+    end
+
+    def set_before_create_flag
+      Flag.before_create = true
+    end
+
+    def set_after_create_flag
+      Flag.after_create = true
+    end
+
+    def set_before_deliver_flag
+      Flag.before_deliver = true
+    end
+
+    def set_after_deliver_flag
+      Flag.after_deliver = true
+    end
+end

data/spec/fixtures/mailer_without_callbacks.rb

@@ -0,0 +1,8 @@
+class MailerWithoutCallbacks < ActionMailer::Base
+  def test_email(recipient)
+    recipients recipient
+     from      'test@test.com'
+     subject   'test email'
+     body      'a test email'
+  end
+end

data/spec/integration/action_mailer_integration_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe MailerWithCallbacks do
+  before { Flag.reset }
+
+  context 'when delivering a mail via deliver_* class method' do
+    context 'when the mailer method has callbacks' do
+      before { MailerWithCallbacks.deliver_test_email('asd@asd.it') }
+
+      it 'should run before_create callback' do
+        Flag.before_create.should be_true
+      end
+
+      it 'should run after_create callback' do
+        Flag.after_create.should be_true
+      end
+
+      it 'should run before_deliver callback' do
+        Flag.before_deliver.should be_true
+      end
+
+      it 'should run after_deliver callback' do
+        Flag.after_deliver.should be_true
+      end
+
+      it 'should run around_create method' do
+        Flag.create_before_block_call.should be_true
+        Flag.create_after_block_call.should be_true
+      end
+
+      it 'should run around_deliver method' do
+        Flag.deliver_before_block_call.should be_true
+        Flag.deliver_after_block_call.should be_true
+      end
+    end
+
+    context 'when the mailer method is included in only/except options' do
+      before { MailerWithCallbacks.deliver_no_callback('asd@asd.it') }
+
+      it 'should not run the callback when in except' do
+        Flag.after_create.should_not be_true
+      end
+
+      it 'should not run the callback when not in only' do
+        Flag.before_deliver.should_not be_true
+      end
+    end
+
+    context 'when the mailer method is not included in any restricting options' do
+      before { MailerWithCallbacks.deliver_test_email('asd@asd.it') }
+
+      it 'should run after_deliver callback' do
+        Flag.after_deliver.should be_true
+      end
+    end
+
+    context 'when error is raised on delivery' do
+      before do
+        MailerWithCallbacks.any_instance.should_receive(:deliver_without_deliver_callbacks!).and_raise(ArgumentError)
+        MailerWithCallbacks.deliver_test_email('asd@asd.it') rescue nil
+      end
+
+      it 'should run before_create callback' do
+        Flag.before_create.should be_true
+      end
+
+      it 'should run after_create callback' do
+        Flag.after_create.should be_true
+      end
+
+      it 'should run before_deliver callback' do
+        Flag.before_deliver.should be_true
+      end
+
+      it 'should not run after_deliver callback' do
+        Flag.after_deliver.should_not be_true
+      end
+    end
+
+    context 'when error is raised on creation' do
+      context 'when error is raised on delivery' do
+        before do
+          MailerWithCallbacks.any_instance.should_receive(:create_without_create_callbacks!).and_raise(ArgumentError)
+          MailerWithCallbacks.create_test_email('asd@asd.it') rescue nil
+        end
+
+        it 'should run before_create callback' do
+          Flag.before_create.should be_true
+        end
+
+        it 'should not run after_create callback' do
+          Flag.after_create.should_not be_true
+        end
+
+        it 'should not run before_deliver callback' do
+          Flag.before_deliver.should_not be_true
+        end
+
+        it 'should not run after_deliver callback' do
+          Flag.after_deliver.should_not be_true
+        end
+      end
+    end
+  end
+
+  context 'when creating a mail via create_* class method' do
+    before { MailerWithCallbacks.create_test_email('asd@asd.it') }
+
+    it 'should run before_create callback' do
+      Flag.before_create.should be_true
+    end
+
+    it 'should run after_create callback' do
+      Flag.after_create.should be_true
+    end
+
+    it 'should not run before_deliver callback' do
+      Flag.before_deliver.should_not be_true
+    end
+
+    it 'should not run after_deliver callback' do
+      Flag.after_deliver.should_not be_true
+    end
+
+    it 'should run around_create method' do
+      Flag.create_before_block_call.should be_true
+      Flag.create_after_block_call.should be_true
+    end
+
+    it 'should not run around_deliver method' do
+      Flag.deliver_before_block_call.should_not be_true
+      Flag.deliver_after_block_call.should_not be_true
+    end
+  end
+end

data/spec/methods_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe ActionMailer::Callbacks::Methods do
+  def callback_lists
+    %w[before_create_callbacks after_create_callbacks before_deliver_callbacks after_deliver_callbacks]
+  end
+
+  before { MailerWithoutCallbacks.clear_callbacks }
+
+  it 'callbacks lists should be empty' do
+    callback_lists.each do |list|
+      MailerWithoutCallbacks.send(list).should be_empty
+    end
+  end
+
+  context 'when adding a after create callback' do
+    before do
+      MailerWithoutCallbacks.before_create('name')
+      MailerWithoutCallbacks.after_create('name')
+      MailerWithoutCallbacks.before_deliver('name')
+      MailerWithoutCallbacks.after_deliver('name')
+    end
+
+    it 'should add the callbacks to the list' do
+      callback_lists.each do |list|
+        MailerWithoutCallbacks.send(list).should have(1).item
+      end
+    end
+
+    it 'clear_callbacks should clear all lists' do
+      MailerWithoutCallbacks.clear_callbacks
+      callback_lists.each do |list|
+        MailerWithoutCallbacks.send(list).should be_empty
+      end
+    end
+  end
+
+  describe 'when delivering a mail via method missing' do
+    it 'should call before_create callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_receive(:run_before_create_callbacks)
+      MailerWithoutCallbacks.deliver_test_email('asd@asd.it')
+    end
+
+    it 'should call after_create callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_receive(:run_after_create_callbacks)
+      MailerWithoutCallbacks.deliver_test_email('asd@asd.it')
+    end
+
+    it 'should call before_deliver callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_receive(:run_before_deliver_callbacks)
+      MailerWithoutCallbacks.deliver_test_email('asd@asd.it')
+    end
+
+    it 'should call after_deliver callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_receive(:run_after_deliver_callbacks)
+      MailerWithoutCallbacks.deliver_test_email('asd@asd.it')
+    end
+
+  end
+
+  describe 'when creating a mail via method_missing' do
+    it 'should call before_create callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_receive(:run_before_create_callbacks)
+      MailerWithoutCallbacks.create_test_email('asd@asd.it')
+    end
+
+    it 'should call after_create callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_receive(:run_after_create_callbacks)
+      MailerWithoutCallbacks.create_test_email('asd@asd.it')
+    end
+
+    it 'should not call before_deliver callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_not_receive(:run_before_deliver_callbacks)
+      MailerWithoutCallbacks.create_test_email('asd@asd.it')
+    end
+
+    it 'should not call after_deliver callback handing method' do
+      MailerWithoutCallbacks.any_instance.should_not_receive(:run_after_deliver_callbacks)
+      MailerWithoutCallbacks.create_test_email('asd@asd.it')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# load required files
+current_dir = File.dirname(__FILE__)
+require File.join(current_dir, '../lib/actionmailer-callbacks')
+Dir[File.expand_path(File.join(current_dir, 'support', '**', '*.rb'))].each {|f| require f}
+Dir[File.expand_path(File.join(current_dir, 'fixtures', '**', '*.rb'))].each {|f| require f}
+
+# don't raise email sending erros
+ActionMailer::Base.raise_delivery_errors = false

data/spec/support/flag.rb

@@ -0,0 +1,21 @@
+module Flag
+  ACCESSORS =  :before_create, :after_create, :before_deliver, :after_deliver,
+                 :create_before_block_call, :create_after_block_call,
+                 :deliver_before_block_call, :deliver_after_block_call
+
+  mattr_accessor *ACCESSORS
+
+  def self.reset
+    ACCESSORS.each do |accessor|
+      send "#{accessor}=", nil
+    end
+  end
+
+  def self.included
+    raise 'Not to be included anywhere!'
+  end
+
+  def self.extended
+    included
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: actionmailer-callbacks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- andrea longhi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.11
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.11
+description: add callbacks to actionmailer 2.3.11
+email:
+- andrea@spaghetticode.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- actionmailer-callbacks.gemspec
+- lib/actionmailer-callbacks.rb
+- lib/actionmailer/callbacks/callback.rb
+- lib/actionmailer/callbacks/methods.rb
+- lib/actionmailer/callbacks/version.rb
+- spec/callback_spec.rb
+- spec/fixtures/mailer_with_callbacks.rb
+- spec/fixtures/mailer_without_callbacks.rb
+- spec/integration/action_mailer_integration_spec.rb
+- spec/methods_spec.rb
+- spec/spec_helper.rb
+- spec/support/flag.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: add callbacks to actionmailer 2.3.11
+test_files:
+- spec/callback_spec.rb
+- spec/fixtures/mailer_with_callbacks.rb
+- spec/fixtures/mailer_without_callbacks.rb
+- spec/integration/action_mailer_integration_spec.rb
+- spec/methods_spec.rb
+- spec/spec_helper.rb
+- spec/support/flag.rb