method_decorator 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b76ea850afa9489fa5475cb52dce8f6884215b6a
-  data.tar.gz: 9a05e1374523166287151e6790b66e5701ae9c09
+  metadata.gz: 2122ba1d4785e5f9f7a85e9b2d1d87cebdc80790
+  data.tar.gz: ed85eb225a92395e20a39e5e407f872dd1fa6552
 SHA512:
-  metadata.gz: 7c088113e4a0803b007944eba4781cd8655f2d907be4a9fcd3493583faa688868b30521706057e2b4b89b39a17e8adfc55d4ece2bac25f85a2bb6c91bb1650cf
-  data.tar.gz: b46674adf3ff149e6fe00ff5bff6df99415ea6a4b7650f96e7d98d090660b52d6dfd04cce6ebb1a772a699ec065c11c8abaf3ea04eaf8574f2d8714fab28d26f
+  metadata.gz: 6473ef9b300a885973c49515ebaa926b9bf961099ce8117440c85b61f92706cd0a4e53cecf648e2937e3efa0bd6f606c53fed671c713929e9cd3c484e621d0a9
+  data.tar.gz: 5d129bad827bb7ac3eb4c5e4df66b566d71d163e0f83e1b29a1a6961e9be746c96324968d69a6b254afb49d14a7cbd51822158181f607f3d7df3da522024e5bc

data/README.rdoc

@@ -14,9 +14,9 @@ For a given class:
 
     end
 
-    MethodDecorator.decorate SomeClass, :some_method do |*args|
-        puts :decorated_some_method
-        MethodDecorator.call_original_method self, :some_method, *args
+    MethodDecorator.decorate SomeClass, :some_method do
+        puts "decorated_some_method_with: #{call_args}"
+        call_original
     end
 
 This call:
@@ -25,9 +25,37 @@ This call:
 
 Produces this output:
 
-    decorated_some_method
+    decorated_some_method_with: ["some arg"]
     some arg
 
+== Helper Methods
+
+Inside the block given to `MethodDecorator.decorate`, you can call four helper methods:
+
+    call_args          # returns original arguments given to the call
+    call_block         # returns original block given to the call
+    call_original      # call the original method, with original args and block given to the call
+    call_original_with # call the original method, with desired args and block
+
+== Module inclusion
+
+You can call `decorate` method directly instead of calling `MethodDecorator.decorate`. Just include `MethodDecorator` module:
+
+    class SomeClass
+
+        def some_method(some_arg)
+            puts some_arg
+        end
+
+        include MethodDecorator
+
+        decorate :some_method do
+            puts "decorated_some_method_with: #{call_args}"
+            call_original
+        end
+
+    end
+
 == Singleton Classes Support
 
 It works too:
@@ -44,13 +72,17 @@ It works too:
 
     end
 
-    MethodDecorator.decorate SomeClass.singleton_class, :some_method do |*args|
-        puts :decorated_some_method
-        MethodDecorator.call_original_method self, :some_method, *args
+    MethodDecorator.decorate SomeClass.singleton_class, :some_method do
+        puts "decorated_some_method_with: #{call_args}"
+        call_original
     end
 
     SomeClass.some_method 'some arg'
 
+== More
+
+To see more of `MethodDecorator` usages, please take a look at DummyClass[https://github.com/r4z3c/method_decorator/blob/master/spec/support/dummy_class.rb].
+
 ===
 
 {<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="Donate" />}[https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AMPXM3PW6CTBE]

data/lib/method_decorator.rb

@@ -1,6 +1,18 @@
 require 'method_decorator/repository'
 
-module MethodDecorator
+module MethodDecorator extend ActiveSupport::Concern
+
+  included do
+
+    class << self
+
+      def decorate(target_method_name, &decoration)
+        MethodDecorator.decorate self, target_method_name, &decoration
+      end
+
+    end
+
+  end
 
   class << self
 
@@ -25,11 +37,27 @@ module MethodDecorator
     def override_method(decoration, target_class, target_method_name)
       is_protected = target_class.protected_instance_methods.include? target_method_name
       is_private = target_class.private_instance_methods.include? target_method_name
-      target_class.send :define_method, target_method_name, &decoration
+      define_decorated_method decoration, target_class, target_method_name
       target_class.instance_eval { protected target_method_name } if is_protected
       target_class.instance_eval { private target_method_name } if is_private
     end
 
+    def define_decorated_method(decoration, target_class, target_method_name)
+      target_class.send :define_method, target_method_name do |*args, &block|
+        target_class.send :define_method, :call_args do return *args end
+        target_class.send :define_method, :call_block do return block end
+        target_class.send :define_method, :call_original do
+          MethodDecorator.call_original_method self, target_method_name, *call_args, &call_block
+        end
+        target_class.send :define_method, :call_original_with do |*desired_args, &desired_block|
+          MethodDecorator.call_original_method self, target_method_name, *desired_args, &desired_block
+        end
+        target_class.instance_eval { protected :call_args }
+        target_class.instance_eval { protected :call_block }
+        instance_eval &decoration
+      end
+    end
+
     public
 
     def call_original_method(target_context, target_method_name, *original_args, &original_block)

data/lib/method_decorator/decoration.rb

@@ -3,7 +3,7 @@ module MethodDecorator
 
     attr_accessor :target_class, :target_method_name, :target_method, :decoration
 
-    def initialize(target_class, target_method_name, target_method, &decoration)
+    def initialize(target_class, target_method_name, target_method)
       self.target_class = target_class
       self.target_method_name = target_method_name
       self.target_method = target_method

data/lib/method_decorator/version.rb

@@ -1,3 +1,3 @@
 module MethodDecorator
-  VERSION = '2.1.0'
+  VERSION = '3.0.0'
 end

data/spec/lib/method_decorator_spec.rb

@@ -12,27 +12,57 @@ describe MethodDecorator do
 
     context 'when public method' do
 
-      before { expect(target_instance).to receive(:puts).with(:a_decorated_public_instance_method).ordered }
-      before { expect(target_instance).to receive(:puts).with("a_public_instance_method_arg: #{dummy_arg}").ordered }
+      context 'when through module singleton method' do
 
-      it { target_instance.a_public_instance_method dummy_arg }
+        before { expect(target_instance).to receive(:puts).with("a_decorated_public_instance_method_with: #{[dummy_arg]}").ordered }
+        before { expect(target_instance).to receive(:puts).with("a_public_instance_method_arg: #{dummy_arg}").ordered }
+
+        it { target_instance.a_public_instance_method dummy_arg }
+
+      end
+
+      context 'when through module inclusion' do
+
+        before { expect(target_instance).to receive(:puts).with("another_decorated_public_instance_method_with: #{[dummy_arg]}").ordered }
+        before { expect(target_instance).to receive(:puts).with("another_public_instance_method_arg: #{dummy_arg}").ordered }
+
+        it { target_instance.another_public_instance_method dummy_arg }
+
+      end
 
     end
 
     context 'when protected method' do
 
-      context 'when calling protected method deliberately' do
+      context 'when calling original method through `call_original`' do
+
+        context 'when calling protected method deliberately' do
+
+          it { expect{target_instance.a_protected_instance_method dummy_arg}.to raise_error NoMethodError }
+
+        end
+
+        context 'when calling protected method through `send`' do
 
-        it { expect{target_instance.a_protected_instance_method dummy_arg}.to raise_error NoMethodError }
+          before { expect(target_instance).to receive(:puts).with("a_decorated_protected_instance_method_with: #{[dummy_arg]}").ordered }
+          before { expect(target_instance).to receive(:puts).with("a_protected_instance_method_arg: #{dummy_arg}").ordered }
+
+          it { target_instance.send :a_protected_instance_method, dummy_arg }
+
+        end
 
       end
 
-      context 'when calling protected method through `send`' do
+      context 'when calling original method through `call_original_with`' do
+
+        context 'when calling protected method through `send`' do
 
-        before { expect(target_instance).to receive(:puts).with(:a_decorated_protected_instance_method).ordered }
-        before { expect(target_instance).to receive(:puts).with("a_protected_instance_method_arg: #{dummy_arg}").ordered }
+          before { expect(target_instance).to receive(:puts).with("another_decorated_protected_instance_method_with: #{[dummy_arg]}").ordered }
+          before { expect(target_instance).to receive(:puts).with("another_protected_instance_method_arg: hue").ordered }
 
-        it { target_instance.send :a_protected_instance_method, dummy_arg }
+          it { target_instance.send :another_protected_instance_method, dummy_arg }
+
+        end
 
       end
 
@@ -48,7 +78,7 @@ describe MethodDecorator do
 
       context 'when calling private method through `send`' do
 
-        before { expect(target_instance).to receive(:puts).with(:a_decorated_private_instance_method).ordered }
+        before { expect(target_instance).to receive(:puts).with("a_decorated_private_instance_method_with: #{[dummy_arg]}").ordered }
         before { expect(target_instance).to receive(:puts).with("a_private_instance_method_arg: #{dummy_arg}").ordered }
 
         it { target_instance.send :a_private_instance_method, dummy_arg }
@@ -66,10 +96,23 @@ describe MethodDecorator do
 
     context 'when public method' do
 
-      before { expect(target_instance).to receive(:puts).with(:a_decorated_public_singleton_method).ordered }
-      before { expect(target_instance).to receive(:puts).with("a_public_singleton_method_arg: #{dummy_arg}").ordered }
+      context 'when through module singleton method' do
+
+        before { expect(target_instance).to receive(:puts).with("a_decorated_public_singleton_method_with: #{[dummy_arg]}").ordered }
+        before { expect(target_instance).to receive(:puts).with("a_public_singleton_method_arg: #{dummy_arg}").ordered }
+
+        it { target_instance.a_public_singleton_method dummy_arg }
 
-      it { target_instance.a_public_singleton_method dummy_arg }
+      end
+
+      context 'when through module inclusion' do
+
+        before { expect(target_instance).to receive(:puts).with("another_decorated_public_singleton_method_with: #{[dummy_arg]}").ordered }
+        before { expect(target_instance).to receive(:puts).with("another_public_singleton_method_arg: #{dummy_arg}").ordered }
+
+        it { target_instance.another_public_singleton_method dummy_arg }
+
+      end
 
     end
 
@@ -83,7 +126,7 @@ describe MethodDecorator do
 
       context 'when calling protected method through `send`' do
 
-        before { expect(target_instance).to receive(:puts).with(:a_decorated_protected_singleton_method).ordered }
+        before { expect(target_instance).to receive(:puts).with("a_decorated_protected_singleton_method_with: #{[dummy_arg]}").ordered }
         before { expect(target_instance).to receive(:puts).with("a_protected_singleton_method_arg: #{dummy_arg}").ordered }
 
         it { target_instance.send :a_protected_singleton_method, dummy_arg }
@@ -102,7 +145,7 @@ describe MethodDecorator do
 
       context 'when calling private method through `send`' do
 
-        before { expect(target_instance).to receive(:puts).with(:a_decorated_private_singleton_method).ordered }
+        before { expect(target_instance).to receive(:puts).with("a_decorated_private_singleton_method_with: #{[dummy_arg]}").ordered }
         before { expect(target_instance).to receive(:puts).with("a_private_singleton_method_arg: #{dummy_arg}").ordered }
 
         it { target_instance.send :a_private_singleton_method, dummy_arg }

data/spec/support/dummy_class.rb

@@ -4,12 +4,20 @@ class DummyClass
     puts "a_public_instance_method_arg: #{arg}"
   end
 
+  def another_public_instance_method(arg)
+    puts "another_public_instance_method_arg: #{arg}"
+  end
+
   protected
 
   def a_protected_instance_method(arg)
     puts "a_protected_instance_method_arg: #{arg}"
   end
 
+  def another_protected_instance_method(arg)
+    puts "another_protected_instance_method_arg: #{arg}"
+  end
+
   private
 
   def a_private_instance_method(arg)
@@ -22,6 +30,10 @@ class DummyClass
       puts "a_public_singleton_method_arg: #{arg}"
     end
 
+    def another_public_singleton_method(arg)
+      puts "another_public_singleton_method_arg: #{arg}"
+    end
+
     protected
 
     def a_protected_singleton_method(arg)
@@ -34,36 +46,55 @@ class DummyClass
       puts "a_private_singleton_method_arg: #{arg}"
     end
 
+    include MethodDecorator
+
+    decorate :another_public_singleton_method do
+      puts "another_decorated_public_singleton_method_with: #{call_args}"
+      call_original
+    end
+
   end
 
+  include MethodDecorator
+
+  decorate :another_public_instance_method do
+    puts "another_decorated_public_instance_method_with: #{call_args}"
+    call_original
+  end
+
+end
+
+MethodDecorator.decorate DummyClass, :a_public_instance_method do
+  puts "a_decorated_public_instance_method_with: #{call_args}"
+  call_original
 end
 
-MethodDecorator.decorate DummyClass, :a_public_instance_method do |*args, &block|
-  puts :a_decorated_public_instance_method
-  MethodDecorator.call_original_method self, :a_public_instance_method, *args, &block
+MethodDecorator.decorate DummyClass, :a_protected_instance_method do
+  puts "a_decorated_protected_instance_method_with: #{call_args}"
+  call_original
 end
 
-MethodDecorator.decorate DummyClass, :a_protected_instance_method do |*args, &block|
-  puts :a_decorated_protected_instance_method
-  MethodDecorator.call_original_method self, :a_protected_instance_method, *args, &block
+MethodDecorator.decorate DummyClass, :another_protected_instance_method do
+  puts "another_decorated_protected_instance_method_with: #{call_args}"
+  call_original_with :hue
 end
 
-MethodDecorator.decorate DummyClass, :a_private_instance_method do |*args, &block|
-  puts :a_decorated_private_instance_method
-  MethodDecorator.call_original_method self, :a_private_instance_method, *args, &block
+MethodDecorator.decorate DummyClass, :a_private_instance_method do
+  puts "a_decorated_private_instance_method_with: #{call_args}"
+  call_original
 end
 
-MethodDecorator.decorate DummyClass.singleton_class, :a_public_singleton_method do |*args, &block|
-  puts :a_decorated_public_singleton_method
-  MethodDecorator.call_original_method self, :a_public_singleton_method, *args, &block
+MethodDecorator.decorate DummyClass.singleton_class, :a_public_singleton_method do
+  puts "a_decorated_public_singleton_method_with: #{call_args}"
+  call_original
 end
 
-MethodDecorator.decorate DummyClass.singleton_class, :a_protected_singleton_method do |*args, &block|
-  puts :a_decorated_protected_singleton_method
-  MethodDecorator.call_original_method self, :a_protected_singleton_method, *args, &block
+MethodDecorator.decorate DummyClass.singleton_class, :a_protected_singleton_method do
+  puts "a_decorated_protected_singleton_method_with: #{call_args}"
+  call_original
 end
 
-MethodDecorator.decorate DummyClass.singleton_class, :a_private_singleton_method do |*args, &block|
-  puts :a_decorated_private_singleton_method
-  MethodDecorator.call_original_method self, :a_private_singleton_method, *args, &block
+MethodDecorator.decorate DummyClass.singleton_class, :a_private_singleton_method do
+  puts "a_decorated_private_singleton_method_with: #{call_args}"
+  call_original
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: method_decorator
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - r4z3c
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler