event_hook 1.0.0

data.tar.gz.sig

@@ -0,0 +1,3 @@
+H:�ڷX���f^��woP��:F�:�
+D5��D�Ͷ�/��5VZ]��p��1ʟ{�����^�k�5�j�V���D/_��>��>����7Š��A��7&
+`�,�<���m���oEhE�m����t"B�|c�H$�r1?��1`��5H>b�D�k�g���@��M���a

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-05-19
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/event_hook
+demo.rb
+lib/event_hook.rb
+test/test_event_hook.rb

data/README.txt

@@ -0,0 +1,64 @@
+= event_hook
+
+* http://rubyforge.org/projects/seattlerb
+
+== DESCRIPTION:
+
+Wraps rb_add_event_hook so you can write fast ruby event hook
+processors w/o the speed penalty that comes with set_trace_func (sooo
+sloooow!). Calls back into ruby so you don't have to write C.
+
+    % ruby demo.rb 
+    # of iterations = 1000000
+                              user     system      total        real
+    null_time             0.120000   0.000000   0.120000 (  0.125279)
+    ruby time             0.560000   0.000000   0.560000 (  0.562834)
+    event hook            3.160000   0.010000   3.170000 (  3.175361)
+    set_trace_func       34.530000   0.100000  34.630000 ( 34.942785)
+
+== FEATURES/PROBLEMS:
+
+* Simple subclass design. Override ::process and you're off.
+* Filters on calls/returns to not bog down on extraneous events.
+* Not sure why process needs to be a class method. Will fix eventually.
+
+== SYNOPSIS:
+
+  class StupidTracer < EventHook
+    self.process(*args)
+      p args
+    end
+  end
+
+== REQUIREMENTS:
+
+* RubyInline
+
+== INSTALL:
+
+* sudo gem install event_hook
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Ryan Davis, Seattle.rb
+
+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/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/event_hook.rb'
+
+Hoe.new('event_hook', EventHook::VERSION) do |p|
+  p.rubyforge_name = 'seattlerb'
+
+  p.developer('Ryan Davis', 'ryand-ruby@zenspider.com')
+
+  p.extra_deps << 'RubyInline'
+end
+
+# vim: syntax=Ruby

data/bin/event_hook

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/demo.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby -w
+
+require 'benchmark'
+
+$: << 'lib'
+require 'rubygems'
+require 'event_hook'
+
+class Demo < EventHook
+  def self.process(*ignore)
+  end
+
+  def call_a_method
+    a_method
+  end
+
+  def a_method
+  end
+end
+
+SET_TRACE_FUNC_PROC = proc { |e, f, l, m, b, c|
+  # do nothing
+}
+
+max = (ARGV.shift || 1_000_000).to_i
+
+demo = Demo.instance
+
+puts "# of iterations = #{max}"
+Benchmark::bm(20) do |x|
+  x.report("null_time") do
+    for i in 0..max do
+      # do nothing
+    end
+  end
+
+  x.report("ruby time") do
+    for i in 0..max do
+      demo.call_a_method
+    end
+  end
+
+  Demo.start_hook
+  x.report("event hook") do
+    for i in 0..max do
+      demo.call_a_method
+    end
+  end
+  Demo.stop_hook
+
+  set_trace_func SET_TRACE_FUNC_PROC
+  x.report("set_trace_func") do
+    for i in 0..max do
+      demo.call_a_method
+    end
+  end
+  set_trace_func nil
+end

data/lib/event_hook.rb

@@ -0,0 +1,109 @@
+require 'inline'
+require 'singleton'
+
+class EventHook
+  VERSION = '1.0.0'
+
+  include Singleton
+
+  NONE    = 0x00
+  LINE    = 0x01
+  CLASS   = 0x02
+  NND     = 0x04
+  CALL    = 0x08
+  RETURN  = 0x10
+  CCALL   = 0x20
+  CRETURN = 0x40
+  RAISE   = 0x80
+  ALL     = 0xff
+
+  ##
+  # Ruby events that EventHook notifies you about.
+
+  EVENTS = {
+    LINE    => :line,
+    CLASS   => :class,
+    NND     => :end,
+    CALL    => :call,
+    RETURN  => :return,
+    CCALL   => :ccall,
+    CRETURN => :creturn,
+    RAISE   => :raise,
+  }
+
+  def self.start_hook
+    self.instance.add_event_hook
+  end
+
+  def self.stop_hook
+    self.instance.remove_event_hook
+  end
+
+  ##
+  # Redefine me in a subclass.  +args+ is [event_id, self, method, class].
+
+  def self.process(*args)
+    raise NotImplementedError, "subclass responsibility"
+  end
+
+  inline(:C) do |builder|
+    builder.add_type_converter("rb_event_t", '', '')
+    builder.add_type_converter("ID", '', '')
+    builder.add_type_converter("NODE *", '', '')
+
+    builder.include '<time.h>'
+    builder.include '"ruby.h"'
+    builder.include '"node.h"'
+
+    builder.prefix <<-'EOF'
+      static VALUE event_hook_klass = Qnil;
+      static ID method = 0;
+      static int in_event_hook = 0;
+      static VALUE argv[4];
+    EOF
+
+    builder.c_raw <<-'EOF'
+    static void
+    event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass) {
+      if (in_event_hook) return;
+      if (mid == ID_ALLOCATOR) return;
+
+      in_event_hook++;
+
+      if (NIL_P(event_hook_klass)) event_hook_klass = self;
+      if (method == 0) method = rb_intern("process");
+
+      if (klass) {
+        if (TYPE(klass) == T_ICLASS) {
+          klass = RBASIC(klass)->klass;
+        } else if (FL_TEST(klass, FL_SINGLETON)) {
+          klass = self;
+        }
+      }
+
+      argv[0] = UINT2NUM(event);
+      argv[1] = self;
+      argv[2] = ID2SYM(mid);
+      argv[3] = klass;
+
+      rb_funcall2(event_hook_klass, method, 4, argv);
+
+      in_event_hook--;
+    }
+    EOF
+
+    builder.c <<-'EOF'
+      void add_event_hook() {
+        rb_add_event_hook(event_hook, RUBY_EVENT_CALL | RUBY_EVENT_RETURN |
+                                      RUBY_EVENT_C_CALL | RUBY_EVENT_C_RETURN);
+      }
+    EOF
+
+    builder.c <<-'EOF'
+      void remove_event_hook() {
+        rb_remove_event_hook(event_hook);
+        event_hook_klass = Qnil;
+      }
+    EOF
+  end
+end

data/test/test_event_hook.rb

@@ -0,0 +1,51 @@
+require "test/unit"
+require "event_hook"
+
+class Stupid < EventHook
+  @@log = []
+
+  def self.log
+    @@log
+  end
+
+  def self.process(*a)
+    @@log << a
+  end
+end
+
+class TestEventHook < Test::Unit::TestCase
+  def method_1
+    method_2
+  end
+
+  def method_2
+    method_3
+  end
+
+  def method_3
+  end
+
+  def test_sanity
+    Stupid.start_hook
+    method_1
+    Stupid.stop_hook
+
+    actual = Stupid.log.map { |id, obj, meth, klass|
+      [EventHook::EVENTS[id], klass, meth]
+    }
+
+    expected = [[:return, Stupid,        :start_hook],
+                [:call,   TestEventHook, :method_1],
+                [:call,   TestEventHook, :method_2],
+                [:call,   TestEventHook, :method_3],
+                [:return, TestEventHook, :method_3],
+                [:return, TestEventHook, :method_2],
+                [:return, TestEventHook, :method_1],
+                [:call,   Stupid,        :stop_hook],
+                [:call,   Stupid,        :instance],
+                [:return, Stupid,        :instance],
+                [:ccall,  EventHook,     :remove_event_hook]]
+
+    assert_equal expected, actual
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: event_hook
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan Davis
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQAY59gYvDxqSqgC92nAP9P8dnGgfZgLxP237xS6XxFGJSghdz/nI6pusfCWKM8m
+  vzjjH2wUMSSf3tNudQ3rCGLf2epkcU13/rguI88wO6MrE0wi4ZqLQX+eZQFskJb/
+  w6x9W1ur8eR01s397LSMexySDBrJOh34cm2AlfKr/jokKCTwcM0OvVZnAutaovC0
+  l1SVZ0ecg88bsWHA0Yhh7NFxK1utWoIhtB6AFC/+trM0FQEB/jZkIS8SaNzn96Rl
+  n0sZEf77FLf5peR8TP/PtmIg7Cyqz23sLM4mCOoTGIy5OcZ8TdyiyINUHtb5ej/T
+  FBHgymkyj/AOSqKRIpXPhjC6
+  -----END CERTIFICATE-----
+
+date: 2009-05-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RubyInline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.2
+    version: 
+description: |-
+  Wraps rb_add_event_hook so you can write fast ruby event hook
+  processors w/o the speed penalty that comes with set_trace_func (sooo
+  sloooow!). Calls back into ruby so you don't have to write C.
+  
+      % ruby demo.rb 
+      # of iterations = 1000000
+                                user     system      total        real
+      null_time             0.120000   0.000000   0.120000 (  0.125279)
+      ruby time             0.560000   0.000000   0.560000 (  0.562834)
+      event hook            3.160000   0.010000   3.170000 (  3.175361)
+      set_trace_func       34.530000   0.100000  34.630000 ( 34.942785)
+email: 
+- ryand-ruby@zenspider.com
+executables: 
+- event_hook
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/event_hook
+- demo.rb
+- lib/event_hook.rb
+- test/test_event_hook.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/seattlerb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: seattlerb
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Wraps rb_add_event_hook so you can write fast ruby event hook processors w/o the speed penalty that comes with set_trace_func (sooo sloooow!)
+test_files: 
+- test/test_event_hook.rb