rhook 0.1.6 → 0.1.7

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/examples/benchmark_empty_method.rb

@@ -0,0 +1,43 @@
+require "rubygems"
+# $LOAD_PATH.unshift(File.dirname(__FILE__)+"/../lib")
+require "rhook"
+
+require "benchmark"
+
+class Target
+  def target
+
+  end
+end
+
+n = 30000
+Benchmark.bm(24) do |x|
+  t = Target.new
+  
+  doit = lambda do
+    n.times do
+      t.target
+    end
+  end
+  
+  # ========================================================================
+  x.report("direct:") do 
+    doit.call
+  end
+  
+  # ========================================================================
+  hook = Target._rhook.hack(:target) do |inv|
+    inv.call
+  end
+  
+  x.report("rhook enabled:") do 
+    doit.call
+  end
+  
+  # ========================================================================
+  hook.disable
+  
+  x.report("rhook disabled:") do 
+    doit.call
+  end
+end

data/examples/benchmark_logger.rb

@@ -0,0 +1,38 @@
+require "rubygems"
+# $LOAD_PATH.unshift(File.dirname(__FILE__)+"/../lib")
+require "rhook"
+
+require "benchmark"
+require "logger"
+
+n = 30000
+Benchmark.bm(24) do |x|
+  logger = Logger.new(open("/dev/null", "w"))
+  
+  doit = lambda do
+    n.times do
+      logger.info("msg")
+    end
+  end
+  
+  # ========================================================================
+  x.report("direct:") do 
+    doit.call
+  end
+  
+  # ========================================================================
+  hook = Logger._rhook.hack(:add) do |inv|
+    inv.call
+  end
+  
+  x.report("rhook enabled:") do 
+    doit.call
+  end
+  
+  # ========================================================================
+  hook.disable
+  
+  x.report("rhook disabled:") do 
+    doit.call
+  end
+end

data/lib/rhook.rb

@@ -21,6 +21,8 @@ module RHook
   class RHookService
     # @private
     attr_reader :hooks_map
+    # @private
+    attr_accessor :last_name_call_method_done
     
     # @private
     def initialize(obj)
@@ -42,7 +44,8 @@ module RHook
     # Add hook to the {#bound_object}. If it is a kind of Class, the hook is affected to all instance & subclasses of the class.
     # 
     # @param [Symbol] name hook-point's name (commonly equals to method name)
-    # @option opt [true] :disable Create hook but make disabled. (by default, automatically enabled.)
+    # @option opt [true] :disable Creates hook but make disabled. (by default, automatically enabled.)
+    # @option opt [RHook::HookGroup] :group Adds itself into the specified hook-group.
     # @yield [inv] The hook block.
     # @yieldparam [Invocation] inv
     # @yieldreturn The result value. (Returned value of called method.)
@@ -53,7 +56,11 @@ module RHook
        (@hooks_map[name.to_sym] ||= []).unshift( hook )
       RHook.registry.class_cached_flag_map.delete(name)
       opt[:disable] or hook.enable()
-      HookGroup.add_to_current_groups(hook)
+      if opt[:group]
+        opt[:group].add(hook)
+      else
+        HookGroup.add_to_current_groups(hook)
+      end
       hook
     end
     
@@ -124,6 +131,11 @@ module RHook
     
     # @private
     def call_method(name, method_name, args, block, opt = {})
+      if @last_name_call_method_done == name
+        return @obj.__send__(method_name, *args, &block)
+      end
+      @last_name_call_method_done = name
+      
       hooks = concat_hooks([], name)
       hooks.empty? and return @obj.__send__(method_name, *args, &block)
       
@@ -133,9 +145,13 @@ module RHook
       inv.args = args
       inv.block = block
       inv.hooks = hooks
-      inv.target_proc = @obj.method(method_name)
+      inv.target_proc = lambda do |*args, &block|
+        @obj.__send__(method_name, *args, &block)
+      end
       inv.hint = opt[:hint] || {}
       inv.proceed()
+    ensure
+      @last_name_call_method_done = nil
     end
     
     # Wraps the code block to be hookable.
@@ -398,6 +414,12 @@ module RHook
       self
     end
     
+    # Tests the given hook is registered in this group.
+    # @return [Boolean]
+    def include?(hook)
+      @hooks.include?(hook)
+    end
+    
     # @private
     def self.add_to_current_groups(hook)
      (Thread.current["rhook_group"] || []).each do |group|
@@ -415,8 +437,14 @@ module RHook
   #   }
   #   XXX_feature_for_library.disable
   # 
+  # @example
+  #   grp = RHook.group
+  #   Target._rhook.bind(..., :group => grp) { ... }
+  #
   # @return [HookGroup]
   def self.group(&block)
-    HookGroup.new.wrap(&block)
+    group = HookGroup.new
+    block and group.wrap(&block)
+    group
   end
 end

data/rhook.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rhook}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kaoru Kobo"]
-  s.date = %q{2010-12-01}
+  s.date = %q{2011-01-14}
   s.description = %q{You can provide hook point in your code, and can customize its behavior from outside. Also you can 'hack' (== injecting hook point from outside) any methods in existing code.}
   s.email = %q{}
   s.extra_rdoc_files = [
@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "examples/benchmark_empty_method.rb",
+    "examples/benchmark_logger.rb",
     "examples/log_socket_data.rb",
     "lib/rhook.rb",
     "rhook.gemspec",
@@ -38,6 +40,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Easily drive AOP & hacking existing library with Ruby}
   s.test_files = [
+    "examples/benchmark_empty_method.rb",
+    "examples/benchmark_logger.rb",
     "examples/log_socket_data.rb",
     "spec/examples/log_buffer_example_spec.rb",
     "spec/rhook_minor_spec.rb",

data/spec/rhook_minor_spec.rb

@@ -31,7 +31,7 @@ describe "rhook (minor specifications / behavior, and bugs)" do
         # [bug] It calls the target method/procedure twice when no hooks are registered.
         t.order_call
         t.order_ary.should == ["orig"]
-
+        
         t._rhook.bind(:order_target) do |inv|
           t.order_ary << "before_call"
           inv.call
@@ -119,6 +119,71 @@ describe "rhook (minor specifications / behavior, and bugs)" do
         result = Target._rhook.on_method(:on_method_test_non_existent, :ifdef => true)
         result.should == true
       end
+      
+    end
+    
+    # ========================================================================
+    describe "is applied to the method (== 'hack'ed), and also it is called via _rhook.to(), " do
+      class Target
+        def both_on_method_and_to
+          _rhook.to.both_on_method_and_to_target
+        end
+        
+        def both_on_method_and_to_target
+          
+        end
+      end
+      
+      example "even though, the hook should be just called once." do
+        m = mock
+        m.should_receive(:called).once
+        
+        Target._rhook.hack(:both_on_method_and_to_target) { |inv|
+          m.called
+          inv.call
+        } 
+        Target.new.both_on_method_and_to()
+      end
     end
   end
+  
+  # ========================================================================
+  describe "#call_method(#to): " do
+    before :each do
+    end
+    
+    example "[bugfix] super: no superclass method" do
+      class CallMethodSuperTest_Super
+        def the_method
+          
+        end
+      end
+      
+      module CallMethodSuperTest_Module
+        def the_method
+          super
+        end
+      end
+      
+      class CallMethodSuperTest_Inherited < CallMethodSuperTest_Super
+        include CallMethodSuperTest_Module
+      end
+      
+      # This bug does not appear without hooks.
+      CallMethodSuperTest_Inherited._rhook.bind(:the_method) do |inv|
+        inv.call
+      end
+      
+      # OK.
+      CallMethodSuperTest_Inherited.new.the_method
+      
+      # We fixed the bug this cause error:
+      lambda {
+        CallMethodSuperTest_Inherited.new._rhook.to.the_method
+      }.should_not raise_error
+      # - super: no superclass method `the_method'
+    end
+  end
+  # ========================================================================
+  
 end

data/spec/rhook_spec.rb

@@ -213,6 +213,16 @@ describe "rhook (advanced usage)" do
       t.group_1.should == "hack1"
       t.group_2.should == "hack2"
     end
+    
+    example "Adding a hook to group with bind()'s :group option." do
+      # Instantiate a group with RHook.group() without block.
+      group = RHook.group
+      t = Target.new
+      hook = t._rhook.hack(:group_1, :group => group) do |inv|
+        inv.call
+      end
+      group.include?(hook).should be_true
+    end
   end
   # ================================================================
   
@@ -234,29 +244,31 @@ describe "rhook (advanced usage)" do
         
       end
       
-      lambda { |called|
-        t = Target.new
-        t._rhook.bind(:invocation_object_target) { |inv|
-          # first hook
-          called.yes
-          inv.call()
-          inv.returned.should == :returned_value
+      m = mock
+      m.should_receive(:second).once.ordered
+      m.should_receive(:first).once.ordered
+      
+      t = Target.new
+      t._rhook.bind(:invocation_object_target) { |inv|
+        # first hook
+        m.first
+        inv.call()
+        inv.returned.should == :returned_value
           :returned_value_hooked
-        }
-        t._rhook.bind(:invocation_object_target) { |inv|
-          # second hook
-          called.yes
-          inv.args.should == args
-          inv.block.should == block
-          inv.hint[:hintkey].should == :hintval
-          inv.receiver.should == t
-          inv.target.should == t
-          inv.returned.should be_nil
-          inv.call()
-          inv.returned.should == :returned_value_hooked
-        }
-        t.invocation_object(*args, &block)
-      }.should calls_hook(:times => 2)
+      }
+      t._rhook.bind(:invocation_object_target) { |inv|
+        # second hook
+        m.second
+        inv.args.should == args
+        inv.block.should == block
+        inv.hint[:hintkey].should == :hintval
+        inv.receiver.should == t
+        inv.target.should == t
+        inv.returned.should be_nil
+        inv.call()
+        inv.returned.should == :returned_value_hooked
+      }
+      t.invocation_object(*args, &block)
     end
   end
   # ========================================================================

data/spec/spec_helper.rb

@@ -11,44 +11,3 @@ Spec::Runner.configure do |config|
   
 end
 
-# ========================================================================
-# Defines custom matcher to test the hook was called.
-
-module ::Spec::Matchers
-  class HookCalledMatcher
-    def initialize(opt)
-      @times = opt[:times]
-      @count = 0
-    end
-    
-    def yes
-      @count += 1
-    end
-    
-    def matches?(block)
-      block.call(self)
-      if @times
-        begin
-          @count.should == @times
-        rescue
-          @times_msg = " (Exactly called count: #{$!})"
-          false
-        end
-      else
-        @count > 0
-      end
-    end
-    
-    def failure_message
-      "Expected the hook to be called.#{@times_msg}"
-    end
-    
-    def negative_failure_message
-      "Expected the hook not to be called.#{@times_msg}"
-    end
-  end
-  
-  def calls_hook(opt = {})
-    HookCalledMatcher.new(opt)
-  end
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rhook
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Kaoru Kobo
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-01 00:00:00 +09:00
+date: 2011-01-14 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,8 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/benchmark_empty_method.rb
+- examples/benchmark_logger.rb
 - examples/log_socket_data.rb
 - lib/rhook.rb
 - rhook.gemspec
@@ -109,6 +111,8 @@ signing_key:
 specification_version: 3
 summary: Easily drive AOP & hacking existing library with Ruby
 test_files: 
+- examples/benchmark_empty_method.rb
+- examples/benchmark_logger.rb
 - examples/log_socket_data.rb
 - spec/examples/log_buffer_example_spec.rb
 - spec/rhook_minor_spec.rb