callmeback 1.1.0 → 1.2.0

data/README.rdoc

@@ -17,10 +17,10 @@ Or add it to your gem file:
   gem 'callmeback'
 
 == Usage
-Add +include Callmeback+ after **all** your module inclusions to be sure the gem works.
 
+=== Basic
+Add +include Callmeback+ after *all* your module inclusions to be sure the gem works.
   class Example
-    include Mongoid::Document
     include Callmeback
 
     before :foo => :bar
@@ -38,32 +38,52 @@ Add +include Callmeback+ after **all** your module inclusions to be sure the gem
   example.foo #=> ['bar','foo']
 
 Because this extension overrides the +.initialize+ method, if you need to redefine it, please add +callback_binding+ to your +.initialize+ method. Here is the same example as above but implemeting the +.initialize+ method:
-  class Example
-    include Mongoid::Document
-    include Callmeback
 
-    after :foo => :bar
+You can use +before+, +after+ and +around+, as if you use the suggested method in the +ActiveSupport::Callbacks+ documentation.
+To perform the +around+ callbacks, define them like:
+  around :foo => :wrapped_foo
 
-    def initialize
-      @result = []
-      callback_binding
-    end
+  def wrapped_foo
+    bar
+    yield
+    bar
+  end
 
-    def foo
-      @result << 'foo'
-    end
+=== Array of callbacks
+You can pass an array of callback method symbol:
+  before :foo => [:bar, :bar]
+  # => ['bar', 'bar', 'foo']
 
-    def bar
-      @result << 'bar'
-    end
+=== Blocks
+You also can pass blocks:
+  before :foo do
+    bar
   end
 
-  example = Example.new
-  example.foo #=> ['foo','bar']
+  after :foo do
+    bar
+  end
 
-You can use +before+, +after+ and +around+, as if you use the suggested method in the +ActiveSupport::Callbacks+ documentation.
+  around :foo do |&block|
+    bar
+    block.call
+    bar
+  end
+
+=== Combinations
+You can combine them with methods:
+  before :foo => [:bar, :bar]
+  after :foo do
+    bar
+  end
+
+=== Array of binded methods
+You can pass an array of the methods you want:
+  before [:foo, :bar] => [:other_method]
 
-Note that Mongoid is used in these examples but it *should* also work with ActiveRecord.
+=== Regex
+You can run a callback for every method that matches a given regex:
+  before /^fo.$/ => [:bar, :bar]
 
 == How is it work?
 First, this gem module defines the class methods +.before+, +.after+, +.around+ in your class. Then when you instanciate your class, the gem overrides your binded methods and wraps them to bind your custom callbacks.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/callmeback.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "callmeback"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sebastien Azimi"]
-  s.date = "2013-01-15"
+  s.date = "2013-01-16"
   s.description = ""
   s.email = "sebstp@gmail.com"
   s.extra_rdoc_files = [

data/lib/callmeback.rb

@@ -21,29 +21,40 @@ module Callmeback
   def callback_binding
     self.class.callmeback_methods.each do |callback_prefix, callback_array|
       callback_array.each do |callback_hash|
-        callback_hash.each do |binded, callbacks|
-          [callbacks].flatten.each do |callback|
+        callback_hash.each do |callback_key, callbacks|
 
-            binded_suffix = "method_#{self.class.callmeback_method_index}"
-            self.class.callmeback_method_index += 1
+          callbacks = [callbacks].flatten
 
-            prefixed_wrapped_binded = "callmeback_wrapped_#{binded_suffix}"
-            prefixed_unwrapped_binded = "callmeback_unwrapped_#{binded_suffix}"
+          if callback_key.is_a?(Regexp)
+            binded_methods = methods.select{|m| m =~ callback_key}
+          else
+            binded_methods = [callback_key].flatten
+          end
 
-            class_eval do
-              define_method prefixed_wrapped_binded do
-                class_eval do
-                  define_callbacks prefixed_wrapped_binded
-                  set_callback prefixed_wrapped_binded, callback_prefix, callback
-                end
+          binded_methods.each do |binded|
+            callbacks.each do |callback|
+
+              binded_suffix = "method_#{self.class.callmeback_method_index}"
+              self.class.callmeback_method_index += 1
+
+              prefixed_wrapped_binded = "callmeback_wrapped_#{binded_suffix}"
+              prefixed_unwrapped_binded = "callmeback_unwrapped_#{binded_suffix}"
 
-                run_callbacks prefixed_wrapped_binded do
-                  send prefixed_unwrapped_binded
+              class_eval do
+                define_method prefixed_wrapped_binded do
+                  class_eval do
+                    define_callbacks prefixed_wrapped_binded
+                    set_callback prefixed_wrapped_binded, callback_prefix, callback
+                  end
+
+                  run_callbacks prefixed_wrapped_binded do
+                    send prefixed_unwrapped_binded
+                  end
                 end
-              end
 
-              alias_method prefixed_unwrapped_binded, binded
-              alias_method binded, prefixed_wrapped_binded
+                alias_method prefixed_unwrapped_binded, binded
+                alias_method binded, prefixed_wrapped_binded
+              end
             end
           end
         end
@@ -55,13 +66,11 @@ module Callmeback
     attr_accessor :callmeback_methods
     attr_accessor :callmeback_method_index
 
-    class_eval do
-      [:before, :after, :around].each do |callback_prefix|
-        define_method callback_prefix do |arg, &block|
-          self.callmeback_methods[callback_prefix] ||= []
-          arg = {:"#{arg}" => block} if block.is_a?(Proc)
-          self.callmeback_methods[callback_prefix] << arg
-        end
+    [:before, :after, :around].each do |callback_prefix|
+      define_method callback_prefix do |arg, &block|
+        self.callmeback_methods[callback_prefix] ||= []
+        arg = {arg => block} if block.is_a?(Proc)
+        self.callmeback_methods[callback_prefix] << arg
       end
     end
   end

data/spec/app/models/example.rb

@@ -13,6 +13,8 @@ class Example
   around :complex_foo => [:around_bar, :around_bar]
   after :complex_foo => [:bar, :bar]
 
+  before( /^regex_before_.+$/ => :bar )
+
   before :block_before_foo do
     bar
   end
@@ -50,12 +52,57 @@ class Example
     bar
   end
 
+  before(/^regex_block_before.+$/) do
+    bar
+  end
+
+  before(/^regex_block_method_before.+$/) do
+    bar
+  end
+  after(/^regex_block_method_before.+$/ => :bar)
+
+  around [:array_around_method1_foo, :array_around_method2_foo] => :around_bar
+
+  before %w{array_block_before_method1_foo array_block_before_method2_foo} do
+    bar
+  end
+
+  before %w{array_block_method_before_method1_foo array_block_method_before_method2_foo} do
+    bar
+  end
+  after %w{array_block_method_before_method1_foo array_block_method_before_method2_foo} => :bar
+
+
   def initialize
     @result = []
     callback_binding
   end
 
-  %w{before after around multiple_before multiple_after multiple_around complex block_before block_after block_around complex_with_blocks complex_with_methods_and_blocks}.each do |prefix|
+  %w{
+  before after
+  around
+  multiple_before
+  multiple_after
+  multiple_around
+  complex
+  block_before
+  block_after
+  block_around
+  complex_with_blocks
+  complex_with_methods_and_blocks
+  regex_before_method1
+  regex_before_method2
+  regex_block_before_method1
+  regex_block_before_method2
+  regex_block_method_before_method1
+  regex_block_method_before_method2
+  array_around_method1
+  array_around_method2
+  array_block_before_method1
+  array_block_before_method2
+  array_block_method_before_method1
+  array_block_method_before_method2
+  }.each do |prefix|
     define_method "#{prefix}_foo" do
       foo
     end

data/spec/callmeback_spec.rb

@@ -81,4 +81,44 @@ describe Callmeback do
       example.complex_with_methods_and_blocks_foo.should == %w{bar bar bar foo bar bar}
     end
   end
+
+  context "the gem should handle regex as callback argument" do
+    it "should fire the callback for all the given methods that match the given regex" do
+      example.regex_before_method1_foo.should == %w{bar foo}
+      example.result.clear
+      example.regex_before_method2_foo.should == %w{bar foo}
+    end
+
+    it "should fire the callback for all the given blocks that match the given regex" do
+      example.regex_block_before_method1_foo.should == %w{bar foo}
+      example.result.clear
+      example.regex_block_before_method2_foo.should == %w{bar foo}
+    end
+
+    it "should fire the callback for all the given methods and blocks that match the given regex" do
+      example.regex_block_method_before_method1_foo.should == %w{bar foo bar}
+      example.result.clear
+      example.regex_block_method_before_method2_foo.should == %w{bar foo bar}
+    end
+  end
+
+  context "the gem should handle array as callback argument" do
+    it "should fire the callback for all the given methods that are included in the given array" do
+      example.array_around_method1_foo.should == %w{bar foo bar}
+      example.result.clear
+      example.array_around_method2_foo.should == %w{bar foo bar}
+    end
+
+    it "should fire the callback for all the given blocks that are included in the given array" do
+      example.array_block_before_method1_foo.should == %w{bar foo}
+      example.result.clear
+      example.array_block_before_method2_foo.should == %w{bar foo}
+    end
+
+    it "should fire the callback for all the given methods and blocks that are included in the given array" do
+      example.array_block_method_before_method1_foo.should == %w{bar foo bar}
+      example.result.clear
+      example.array_block_method_before_method2_foo.should == %w{bar foo bar}
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: callmeback
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2462921630949056169
+      hash: -529320161042203170
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: