actionmailer-callbacks 0.0.2 → 1.0.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
+end
+
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrea Longhi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,46 +2,53 @@
 
 [![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:
+This gem adds before_create and around_create to ActionMailer::Base to make it
+work similarly to ActionController before/around filters and ActiveRecord::Base
+callbacks:
 
 ```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
+  before_create  :log_params, except: :test_email
+  around_create  :benchmark,  only:   :test_email
 ```
 
+*except* and *only* options are optional and has same functionality as in
+ActionController.
+
+
 ## 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. Some features of this version are
-available also on the action mailer v3.x version. Checkout the 1.0 release.
+The master branch now works only with Actionmailer 3.x, if you need to add
+callbacks to older versions please refer to the 0.x release.
+
+
+## Installation
+
+Add the gem to the Gemfile:
+
+```ruby
+  gem 'actionmailer-callbacks'
+```
+
+And then run ```bundle```
+
+>>>>>>> actionmailer3
 
 ## 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.
+If you need something like before/after deliver callbacks ActionMailer 3.x comes
+ready for that: you can use an *observer* or an *instrumentation* for that.
+
+*around_create* wrap the mail method execution (and all before_create callbacks).
+You can use them for rescuing from errors or for benchmarking, for example.
+There can be only one *around_create* method for each email method, if you
+register more than one only the first will be executed.
 
-*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)
@@ -50,12 +57,8 @@ if there are more than 1 only the first will be executed.
 
     private
 
-    def log_params
-      MailerLogger.info "[CREATE] #{params_inspector}"
-    end
-
-    def log_success
-      MailerLogger.info "[DELIVERED] #{params_inspector}"
+    def log_params(args)
+      MailerLogger.info "[CREATE] #{args.inspect}"
     end
 
     def rescue_from_errors
@@ -65,18 +68,15 @@ if there are more than 1 only the first will be executed.
         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
 ```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add your feature tests to the rspec/cucumber test suite
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -1,11 +1,12 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-desc "Run those specs"
+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.pattern    = 'spec/**/*_spec.rb'
     t.rspec_path = 'bundle exec rspec'
   end
 end

data/actionmailer-callbacks.gemspec

@@ -1,26 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require 'actionmailer/callbacks/version'
+require File.expand_path('../lib/actionmailer-callbacks/version', __FILE__)
 
-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}
+Gem::Specification.new do |gem|
+  gem.authors       = ['andrea longhi']
+  gem.email         = ['andrea@spaghetticode.it']
+  gem.description   = %q{adds before_create, around_create callbacks to action mailer 3}
+  gem.summary       = %q{adds before_create, around_create callbacks to action mailer 3}
+  gem.homepage      = 'http://github.com/spaghetticode/actionmailer-callbacks'
 
-  # s.rubyforge_project = 'actionmailer-callbacks'
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'actionmailer-callbacks'
+  gem.require_paths = ["lib"]
+  gem.version       = Actionmailer::Callbacks::VERSION
 
-  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'
+  gem.add_dependency 'actionmailer', '~> 3.0'
+  gem.add_dependency 'activesupport'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_development_dependency 'cucumber', '~> 1.0'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-cucumber'
 end

data/features/around_create_callback.feature

@@ -0,0 +1,84 @@
+Feature: around_create callback
+  As an actionmailer gem user
+  I want to be able to use the around_create callback
+  So that I can wrap the email creation process with my callback
+
+    The "around_create" callback allows to wrap the email creation
+    process around another method definition.
+    The macro accepts the callback name as first arguments and an
+    optional hash with "only" and/or "except" keys that are
+    functionally equivalent to the ones of ActionController
+    before/after/around create filters: for example in order
+    to run a callback only for the "test" action you should
+    specify one of the following:
+      around_create :test_callback, only: :test
+      around_create :test_callback, only: [:test]
+@focus
+Scenario: successful around_create calling
+  Given the following mailer class with an around_create callback:
+    """
+    class TestMailer < ::ActionMailer::Base
+      around_create :log_args
+
+      def self.logger
+        @logger ||= Array.new
+      end
+
+      def test(recipient)
+        mail(
+          to: recipient,
+          from: 'sender@test.com',
+          subject: 'Test Email'
+        )
+      end
+
+      private
+
+      def log_args(*args)
+        self.class.logger << "Test email now being called with #{args.flatten.inspect}"
+        yield
+        self.class.logger << "Test email was successfully created"
+      end
+    end
+    """
+  When I run the code "TestMailer.test('recipient@test.com')"
+  Then an email should have been created
+  And the logger for the class "TestMailer" should contain:
+    """
+    Test email now being called with ["recipient@test.com"]
+    """
+  And the logger for the class "TestMailer" should contain:
+    """
+    Test email was successfully created
+    """
+
+  Scenario: around_create callback skipped because not included in "only" directive
+    Given the following mailer class with an around_create callback:
+      """
+      class TestMailer < ::ActionMailer::Base
+        around_create :log_args, only: :only_method
+
+        def self.logger
+          @logger ||= Array.new
+        end
+
+        def test(recipient)
+          mail(
+            to: recipient,
+            from: 'sender@test.com',
+            subject: 'Test Email'
+          )
+        end
+
+        private
+
+        def log_args(*args)
+          self.class.logger << "Test email now being called"
+          yield
+          self.class.logger << "Test email was successfully created"
+        end
+      end
+      """
+    When I run the code "TestMailer.test('recipient@test.com')"
+    Then an email should have been created
+    And the logger for the class "TestMailer" should be empty

data/features/before_create_callback.feature

@@ -0,0 +1,76 @@
+Feature: before_create callback
+  As an actionmailer gem user
+  I want to be able to use the before_create callback
+  So that I can to execute code before creating an email
+
+    The "before_create" callback allows to execute a callback
+    before the email creation process. The macro accepts
+    the callback name as first arguments and an
+    optional hash with "only" and/or "except" keys that are
+    functionally equivalent to the ones of ActionController
+    before/after/around create filters: for example in order
+    to run a callback only for the "test" action you should
+    specify one of the following:
+      before_create :test_callback, only: :test
+      before_create :test_callback, only: [:test]
+
+Scenario: successful before_create callback calling
+  Given the following mailer class with a before_create callback:
+    """
+    class TestMailer < ::ActionMailer::Base
+      before_create :log_args
+
+      def self.logger
+        @logger ||= Array.new
+      end
+
+      def test(recipient)
+        mail(
+          to: recipient,
+          from: 'sender@test.com',
+          subject: 'Test Email'
+        )
+      end
+
+      private
+
+      def log_args(args)
+        self.class.logger << "Test was called with #{args.inspect}"
+      end
+    end
+    """
+  When I run the code "TestMailer.test('recipient@test.com').deliver"
+  Then an email should have been sent
+  And the logger for the class "TestMailer" should contain:
+    """
+    Test was called with "recipient@test.com"
+    """
+
+  Scenario: before_create callback skipped because not included in "only" directive
+    Given the following mailer class with a before_create callback:
+      """
+      class TestMailer < ::ActionMailer::Base
+        before_create :log_args, only: :only_method
+
+        def self.logger
+          @logger ||= Array.new
+        end
+
+        def test(recipient)
+          mail(
+            to: recipient,
+            from: 'sender@test.com',
+            subject: 'Test Email'
+          )
+        end
+
+        private
+
+        def log_args(*args)
+          self.class.logger << "Test was called with #{args.inspect}"
+        end
+      end
+      """
+    When I run the code "TestMailer.test('recipient@test.com').deliver"
+    Then an email should have been sent
+    And the logger for the class "TestMailer" should be empty

data/features/step_definitions/before_create_callback_steps.rb

@@ -0,0 +1,25 @@
+Given /^the following mailer class with an? (around_create callback|before_create callback):$/ do |_, class_definition|
+  context_module.class_eval class_definition
+end
+
+When /^I run the code "(.*?)"$/ do |code|
+  self.code_result = context_module.class_eval code
+end
+
+Then /^the logger for the class "(.*?)" should contain:$/ do |class_name, log|
+  klass = context_module.const_get(class_name)
+  klass.logger.should include(log)
+end
+
+Then /^an email should have been sent$/ do
+  ActionMailer::Base.deliveries.size.should == 1
+end
+
+Then /^the logger for the class "(.*?)" should be empty$/ do |class_name|
+  klass = context_module.const_get(class_name)
+  klass.logger.should == []
+end
+
+Then /^an email should have been created$/ do
+  code_result.should be_a(Mail::Message)
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'action_mailer'
+require File.expand_path('../../../lib/actionmailer-callbacks', __FILE__)
+ActionMailer::Base.delivery_method = :test
+

data/features/support/hooks.rb

@@ -0,0 +1,3 @@
+Before do
+  ActionMailer::Base.deliveries.clear
+end

data/features/support/world_extensions.rb

@@ -0,0 +1,9 @@
+module WorldExtensions
+  attr_accessor :code_result
+
+  def context_module
+    @context_module ||= Module.new
+  end
+end
+
+World(WorldExtensions)