actionmailer-callbacks 0.0.2 → 1.0.0

data/lib/actionmailer-callbacks.rb

@@ -1,14 +1,9 @@
-require 'rubygems'
-require 'active_support'
 require 'action_mailer'
 
-module ActionMailer
-  module Callbacks
-  end
-end
+lib_dir = File.expand_path('..', __FILE__)
+require File.join(lib_dir, 'actionmailer-callbacks/version')
+require File.join(lib_dir, 'actionmailer-callbacks/callback')
+require File.join(lib_dir, 'actionmailer-callbacks/callbackable')
+require File.join(lib_dir, 'actionmailer-callbacks/extensions')
 
-require 'actionmailer/callbacks/version'
-require 'actionmailer/callbacks/callback'
-require 'actionmailer/callbacks/methods'
-
-ActionMailer::Base.send :include, ActionMailer::Callbacks::Methods
+ActionMailer::Base.extend ActionMailer::Callbacks::Extensions

data/lib/actionmailer-callbacks/callback.rb

@@ -0,0 +1,25 @@
+module ActionMailer
+  module Callbacks
+    class Callback
+      attr_reader :name, :only, :except
+
+      def initialize(name, opts={})
+        @name   = name
+        @only   = Array.wrap(opts[:only])
+        @except = Array.wrap(opts[:except])
+      end
+
+      def run?(callback_method)
+        if only.include?(callback_method)
+          true
+        else
+          if except.include?(callback_method)
+            false
+          else
+            only.empty? ? true : false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/actionmailer-callbacks/callbackable.rb

@@ -0,0 +1,44 @@
+module ActionMailer
+  module Callbacks
+    module Callbackable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def before_create_callbacks
+          @before_create_callbacks ||= Set.new
+        end
+
+        def add_before_create_callback(callback)
+          @before_create_callbacks << callback
+        end
+
+        def around_create_callback
+          @around_create_callback
+        end
+
+        def reset_callbacks
+          @before_create_callbacks = Set.new
+        end
+      end
+
+      def initialize(method, *args)
+        result = nil
+        around_create_callback = self.class.around_create_callback
+        if around_create_callback and around_create_callback.run?(method)
+          send self.class.around_create_callback.name, *args do
+            self.class.before_create_callbacks.each do |callback|
+              send callback.name, *args if callback.run?(method)
+            end
+            result = super
+          end
+          result
+        else
+          self.class.before_create_callbacks.each do |callback|
+            send callback.name, *args if callback.run?(method)
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/actionmailer-callbacks/extensions.rb

@@ -0,0 +1,24 @@
+module ActionMailer
+  module Callbacks
+    module Extensions
+      def before_create(*args)
+        include_callbackable
+        before_create_callbacks << Callback.new(*args)
+      end
+
+      def around_create(*args)
+        include_callbackable
+        @around_create_callback = Callback.new(*args)
+      end
+
+      private
+
+      def include_callbackable
+        callbackable = ActionMailer::Callbacks::Callbackable
+        unless ancestors.include?(callbackable)
+          include callbackable
+        end
+      end
+    end
+  end
+end

data/lib/{actionmailer/callbacks → actionmailer-callbacks}/version.rb

@@ -1,5 +1,5 @@
 module Actionmailer
   module Callbacks
-    VERSION = '0.0.2'
+    VERSION = '1.0.0'
   end
 end

data/spec/lib/actionmailer-callbacks/callback_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module ActionMailer
+  module Callbacks
+    describe Callback do
+      context 'creating an instance' do
+        it 'requires name' do
+          expect {Callback.new}.to raise_error(ArgumentError)
+        end
+
+        context 'when name but no option is passed' do
+          subject {Callback.new(:name)}
+
+          it 'runs all callback methods' do
+            subject.should run(:any_method)
+          end
+        end
+
+        context 'when name and all options are passed' do
+          subject {Callback.new(:name, :only => :only_method, :except => [:except_method])}
+
+          it 'sets "name" attribute' do
+            subject.name.should == :name
+          end
+
+          it 'sets "only" reader' do
+            subject.only.should == [:only_method]
+          end
+
+          it 'sets "except" reader' do
+            subject.except.should == [:except_method]
+          end
+
+          it 'runs the methods included in the "only" list' do
+            subject.should run(:only_method)
+          end
+
+          it 'skips the methods not included in the "only" list' do
+            subject.should_not run(:other_method)
+          end
+
+          it 'skips the methods included in the "except" list' do
+            subject.should_not run(:except_method)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/actionmailer-callbacks/callbackable_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+module ActionMailer
+  module Callbacks
+    describe Callbackable do
+      let(:sample_class) {Class.new {include Callbackable}}
+      let(:callback) {double(name: :callback_method)}
+
+      subject {sample_class}
+
+      before {subject.reset_callbacks}
+
+      context '#initialize' do
+        it 'checks for the around_create callback' do
+          sample_class.should_receive(:around_create_callback)
+          sample_class.new(:mailer_method)
+        end
+
+        it 'does not run the around_create callback if present but should not run' do
+          callback.stub(run?: false)
+          sample_class.stub(around_create_callback: callback)
+          sample_class.any_instance.should_not_receive(:callback_method)
+          sample_class.new(:mailer_method)
+        end
+
+        it 'runs the around_create callback if present and should run' do
+          callback.stub(run?: true)
+          sample_class.stub(around_create_callback: callback)
+          sample_class.any_instance.should_receive(:callback_method)
+          sample_class.new(:mailer_method)
+        end
+
+        it 'cycles on before_create_callbacks' do
+          sample_class.should_receive(:before_create_callbacks).and_return([])
+          sample_class.new(:mailer_method)
+        end
+
+        context 'when the callback should run' do
+          before {callback.stub run?: true}
+
+          it 'runs the callback included in the list' do
+            sample_class.stub(before_create_callbacks: [callback])
+            sample_class.any_instance.should_receive(:callback_method)
+            sample_class.new(:mailer_method)
+          end
+
+          it 'pass all the params to the callback' do
+            sample_class.stub(before_create_callbacks: [callback])
+            sample_class.any_instance.should_receive(:callback_method).with(:params)
+            sample_class.new(:mailer_method, :params)
+          end
+        end
+
+        context 'when the callback should not run' do
+          before {callback.stub run?: false}
+
+          it 'does not run the callback included in the list' do
+            sample_class.stub(before_create_callbacks: [callback])
+            sample_class.any_instance.should_not_receive(:callback_method)
+            sample_class.new(:mailer_method)
+          end
+        end
+      end
+
+      context 'class methods' do
+        describe 'before_create_callbacks' do
+          it 'responds to before_create_callbacks' do
+            subject.should respond_to(:before_create_callbacks)
+          end
+
+          it 'before_create_callbacks should be empty at start' do
+            subject.before_create_callbacks.should be_empty
+          end
+        end
+
+        describe 'add_before_create_callback' do
+          it 'responds to add_before_create_callback' do
+            subject.should respond_to(:add_before_create_callback)
+          end
+
+          it 'adds a callback to the before_create_callbacks list' do
+            subject.add_before_create_callback callback
+            subject.before_create_callbacks.should include(callback)
+          end
+
+          it 'does not add the same callback twice' do
+            2.times {subject.add_before_create_callback callback}
+            subject.before_create_callbacks.should have(1).callback
+          end
+        end
+
+        describe 'reset_callbacks' do
+          it 'empties the before_create_callbacks list' do
+            subject.add_before_create_callback callback
+            lambda do
+              subject.reset_callbacks
+            end.should change(subject, :before_create_callbacks).to(Set.new)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/actionmailer-callbacks/extensions_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module ActionMailer
+  module Callbacks
+    describe Extensions do
+      subject {Class.new {extend Extensions}}
+
+      context 'class methods' do
+        it 'responds to before_create' do
+          subject.should respond_to(:before_create)
+        end
+
+        it 'responds to around_create' do
+          subject.should respond_to(:around_create)
+        end
+
+        describe 'before_create' do
+          it 'adds Callbackable to the ancestors' do
+            Callback.stub(:new)
+            subject.before_create
+            subject.ancestors.should include(ActionMailer::Callbacks::Callbackable)
+          end
+        end
+
+        describe 'around_create' do
+          it 'adds Callbackable to the ancestors' do
+            Callback.stub(:new)
+            subject.around_create
+            subject.ancestors.should include(ActionMailer::Callbacks::Callbackable)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,2 @@
-# 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
+require 'support/custom_matchers'
+require File.expand_path('../../lib/actionmailer-callbacks', __FILE__)

data/spec/support/custom_matchers.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :run do |method|
+  match do |callback|
+    callback.run?(method) == true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actionmailer-callbacks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,14 +12,30 @@ cert_chain: []
 date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -44,38 +60,70 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.11
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.11
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.11
-  type: :runtime
+        version: '1.0'
+  type: :development
   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
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard-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: guard-cucumber
+  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'
+description: adds before_create, around_create callbacks to action mailer 3
 email:
 - andrea@spaghetticode.it
 executables: []
@@ -83,23 +131,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis
 - Gemfile
+- Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - actionmailer-callbacks.gemspec
+- features/around_create_callback.feature
+- features/before_create_callback.feature
+- features/step_definitions/before_create_callback_steps.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- features/support/world_extensions.rb
 - 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
+- lib/actionmailer-callbacks/callback.rb
+- lib/actionmailer-callbacks/callbackable.rb
+- lib/actionmailer-callbacks/extensions.rb
+- lib/actionmailer-callbacks/version.rb
+- spec/lib/actionmailer-callbacks/callback_spec.rb
+- spec/lib/actionmailer-callbacks/callbackable_spec.rb
+- spec/lib/actionmailer-callbacks/extensions_spec.rb
 - spec/spec_helper.rb
-- spec/support/flag.rb
-homepage: ''
+- spec/support/custom_matchers.rb
+homepage: http://github.com/spaghetticode/actionmailer-callbacks
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -111,23 +167,33 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1517825137690287905
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1517825137690287905
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: add callbacks to actionmailer 2.3.11
+summary: adds before_create, around_create callbacks to action mailer 3
 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
+- features/around_create_callback.feature
+- features/before_create_callback.feature
+- features/step_definitions/before_create_callback_steps.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- features/support/world_extensions.rb
+- spec/lib/actionmailer-callbacks/callback_spec.rb
+- spec/lib/actionmailer-callbacks/callbackable_spec.rb
+- spec/lib/actionmailer-callbacks/extensions_spec.rb
 - spec/spec_helper.rb
-- spec/support/flag.rb
+- spec/support/custom_matchers.rb