binding_of_caller 0.4.1 → 0.6.3

data/README.md

@@ -13,7 +13,7 @@ call stack, not limited to just the immediate caller.
 
 **Recommended for use only in debugging situations. Do not use this in production apps.**
 
-**Only works in MRI Ruby 1.9.2**
+**Only works in MRI Ruby 1.9.2 and 1.9.3**
 
 * Install the [gem](https://rubygems.org/gems/binding_of_caller): `gem install binding_of_caller`
 * See the [source code](http://github.com/banister/binding_of_caller)
@@ -50,8 +50,7 @@ This project is a spinoff from the [Pry REPL project.](http://pry.github.com)
 Features and limitations
 -------------------------
 
-* Only works with MRI 1.9.2
-* Broken in 1.9.3, support will hopefully be provided in the near future.
+* Only works with MRI 1.9.2 and 1.9.3
 * Does not work in 1.8.7, but there is a well known (continuation-based) hack to get a `Binding#of_caller` there.
 
 Contact

data/Rakefile

@@ -1,28 +1,30 @@
 dlext = Config::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
 
 $:.unshift 'lib'
 
 PROJECT_NAME = "binding_of_caller"
 
 require 'rake/clean'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
+
 require "#{PROJECT_NAME}/version"
 
 CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
 CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
               "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
-              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
+              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake", "**/*.rbc")
 
 def apply_spec_defaults(s)
   s.name = PROJECT_NAME
-  s.summary = "Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack. Currently only works for MRI 1.9.2."
+  s.summary = "Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack. Currently only works for MRI 1.9.2+"
   s.version = BindingOfCaller::VERSION
   s.date = Time.now.strftime '%Y-%m-%d'
   s.author = "John Mair (banisterfiend)"
   s.email = 'jrmair@gmail.com'
   s.description = s.summary
   s.require_path = 'lib'
-  s.add_development_dependency("bacon","~>1.1.0")
+  s.add_development_dependency("bacon","~>1.1")
   s.homepage = "http://github.com/banister/binding_of_caller"
   s.has_rdoc = 'yard'
   s.files = `git ls-files`.split("\n")
@@ -39,6 +41,9 @@ task :pry do
   sh "pry -r ./lib/binding_of_caller"
 end
 
+desc "generate gemspec"
+task :gemspec => "ruby:gemspec"
+
 namespace :ruby do
   spec = Gem::Specification.new do |s|
     apply_spec_defaults(s)
@@ -46,7 +51,26 @@ namespace :ruby do
     s.extensions = ["ext/#{PROJECT_NAME}/extconf.rb"]
   end
 
-  Rake::GemPackageTask.new(spec) do |pkg|
+  Gem::PackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  desc  "Generate gemspec file"
+  task :gemspec do
+    File.open("#{spec.name}.gemspec", "w") do |f|
+      f << spec.to_ruby
+    end
+  end
+end
+
+namespace :rbx do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)
+    s.platform = Gem::Platform.new(["universal", "rubinius"])
+  end
+
+  Gem::PackageTask.new(spec) do |pkg|
     pkg.need_zip = false
     pkg.need_tar = false
   end
@@ -62,11 +86,19 @@ task :compile do
   end
 end
 
+desc "reinstall gem"
+task :reinstall => :gems do
+  sh "gem uninstall binding_of_caller" rescue nil
+  sh "gem install #{direc}/pkg/#{PROJECT_NAME}-#{BindingOfCaller::VERSION}.gem"
+end
+
 desc "build all platform gems at once"
-task :gems => [:clean, :rmgems, "ruby:gem"]
+task :gems => [:clean, :rmgems, "ruby:gem", "rbx:gem"]
 
 task :gem => [:gems]
 
+task :rbxgem => "rbx:gem"
+
 desc "remove all platform gems"
 task :rmgems => ["ruby:clobber_package"]
 

data/ext/binding_of_caller/binding_of_caller.c

@@ -6,6 +6,27 @@
 
 typedef enum { false, true } bool;
 
+static VALUE
+string2sym(const char * string)
+{
+  return ID2SYM(rb_intern(string));
+}
+
+static inline const rb_data_type_t *
+threadptr_data_type(void)
+{
+  static const rb_data_type_t *thread_data_type;
+  if (!thread_data_type) {
+    VALUE current_thread = rb_thread_current();
+    thread_data_type = RTYPEDDATA_TYPE(current_thread);
+  }
+  return thread_data_type;
+}
+
+#define ruby_thread_data_type *threadptr_data_type()
+
+#define ruby_current_thread ((rb_thread_t *)RTYPEDDATA_DATA(rb_thread_current()))
+
 static size_t
 binding_memsize(const void *ptr)
 {
@@ -32,7 +53,11 @@ binding_mark(void *ptr)
   if (ptr) {
     bind = ptr;
     RUBY_MARK_UNLESS_NULL(bind->env);
+
+#ifdef RUBY_192
     RUBY_MARK_UNLESS_NULL(bind->filename);
+#endif
+
   }
   RUBY_MARK_LEAVE("binding");
 }
@@ -54,27 +79,48 @@ binding_alloc(VALUE klass)
 }
 
 static bool valid_frame_p(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
-  if (cfp >= limit_cfp)
-    rb_raise(rb_eRuntimeError, "Invalid frame, gone beyond end of stack!");
-
   return cfp->iseq && !NIL_P(cfp->self);
 }
 
 static rb_control_frame_t * find_valid_frame(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
-  while (true) {
+  while (cfp < limit_cfp) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
+    if (cfp >= limit_cfp)
+      return NULL;
+
     if (valid_frame_p(cfp, limit_cfp))
       return cfp;
   }
 
-  // never reached
-  return 0;
+  // beyond end of stack
+  return NULL;
+}
+
+static VALUE
+frametype_name(VALUE flag)
+{
+  switch (flag & VM_FRAME_MAGIC_MASK) {
+  case VM_FRAME_MAGIC_METHOD: return string2sym("method");
+  case VM_FRAME_MAGIC_BLOCK:  return string2sym("block");
+  case VM_FRAME_MAGIC_CLASS:  return string2sym("class");
+  case VM_FRAME_MAGIC_TOP:    return string2sym("top");
+  case VM_FRAME_MAGIC_FINISH: return string2sym("finish");
+  case VM_FRAME_MAGIC_CFUNC:  return string2sym("cfunc");
+  case VM_FRAME_MAGIC_PROC:   return string2sym("proc");
+  case VM_FRAME_MAGIC_IFUNC:  return string2sym("ifunc");
+  case VM_FRAME_MAGIC_EVAL:   return string2sym("eval");
+  case VM_FRAME_MAGIC_LAMBDA: return string2sym("lambda");
+  default:
+    rb_raise(rb_eRuntimeError, "Unknown frame type! got flag: %d", FIX2INT(flag));
+  }
 }
 
 static VALUE binding_of_caller(VALUE self, VALUE rb_level)
 {
-  rb_thread_t *th = GET_THREAD();
+  rb_thread_t *th;
+  GetThreadPtr(rb_thread_current(), th);
+
   rb_control_frame_t *cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp);
   rb_control_frame_t *limit_cfp = (void *)(th->stack + th->stack_size);
   int level = FIX2INT(rb_level);
@@ -83,6 +129,9 @@ static VALUE binding_of_caller(VALUE self, VALUE rb_level)
   for (int i = 0; i < level; i++) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
+    if (cfp >= limit_cfp)
+      rb_raise(rb_eRuntimeError, "Invalid frame, gone beyond end of stack!");
+
     // skip invalid frames
     if (!valid_frame_p(cfp, limit_cfp))
       cfp = find_valid_frame(cfp, limit_cfp);
@@ -98,15 +147,74 @@ static VALUE binding_of_caller(VALUE self, VALUE rb_level)
   bind->env = rb_vm_make_env_object(th, cfp);
   bind->filename = cfp->iseq->filename;
   bind->line_no = rb_vm_get_sourceline(cfp);
+
+  rb_iv_set(bindval, "@frame_type", frametype_name(cfp->flag));
+  rb_iv_set(bindval, "@frame_description", cfp->iseq->name);
+
   return bindval;
 }
 
+static VALUE
+frame_type(VALUE self)
+{
+  return rb_iv_get(self, "@frame_type");
+}
+
+static VALUE
+frame_description(VALUE self)
+{
+  return rb_iv_get(self, "@frame_description");
+}
+
+static VALUE frame_count(VALUE self)
+{
+  rb_thread_t *th;
+  GetThreadPtr(rb_thread_current(), th);
+
+  rb_control_frame_t *cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp);
+  rb_control_frame_t *limit_cfp = (void *)(th->stack + th->stack_size);
+
+  int i = 1;
+  while (cfp < limit_cfp) {
+    cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
+
+    if (cfp >= limit_cfp)
+      return INT2FIX(i);
+
+    // skip invalid frames
+    if (!valid_frame_p(cfp, limit_cfp))
+      cfp = find_valid_frame(cfp, limit_cfp);
+
+    if (!cfp)
+      break;
+
+    i++;
+  }
+
+  return INT2FIX(i);
+}
+
+static VALUE
+callers(VALUE self)
+{
+  VALUE ary = rb_ary_new();
+
+  for (int i = 0; i < FIX2INT(frame_count(self)); i++)
+    rb_ary_push(ary, binding_of_caller(self, INT2FIX(i)));
+
+  return ary;
+}
+
 void
 Init_binding_of_caller()
 {
   VALUE mBindingOfCaller = rb_define_module("BindingOfCaller");
 
   rb_define_method(mBindingOfCaller, "of_caller", binding_of_caller, 1);
+  rb_define_method(mBindingOfCaller, "frame_count", frame_count, 0);
+  rb_define_method(mBindingOfCaller, "frame_type", frame_type, 0);
+  rb_define_method(mBindingOfCaller, "frame_description", frame_description, 0);
+  rb_define_method(mBindingOfCaller, "callers", callers, 0);
   rb_include_module(rb_cBinding, mBindingOfCaller);
 }
 

data/ext/binding_of_caller/extconf.rb

@@ -5,10 +5,9 @@ $CFLAGS += " -std=c99"
 
 case RUBY_VERSION
 when /1.9.2/
-  $CFLAGS += " -I./ruby_headers/192/"
+  $CFLAGS += " -I./ruby_headers/192/ -DRUBY_192"
 when /1.9.3/
-  puts "hit 193"
-  $CFLAGS += " -I./ruby_headers/193/"
+  $CFLAGS += " -I./ruby_headers/193/ -DRUBY_193"
 end
 
 create_makefile('binding_of_caller')

data/lib/binding_of_caller/version.rb

@@ -1,3 +1,3 @@
 module BindingOfCaller
-  VERSION = "0.4.1"
+  VERSION = "0.6.3"
 end

data/lib/binding_of_caller.rb

@@ -0,0 +1,82 @@
+dlext = Config::CONFIG['DLEXT']
+
+if RUBY_ENGINE && RUBY_ENGINE == "ruby"
+  require "binding_of_caller.#{dlext}"
+
+elsif defined?(Rubinius)
+  module BindingOfCaller
+    module BindingExtensions
+
+      def of_caller(n)
+        bt = Rubinius::VM.backtrace(1 + n, true).first
+
+        b = Binding.setup(
+                      bt.variables,
+                      bt.variables.method,
+                      bt.static_scope,
+                      bt.variables.self,
+                      bt
+                      )
+
+        b.instance_variable_set(:@frame_description, bt.describe)
+
+        b
+        rescue
+          raise RuntimeError, "Invalid frame, gone beyond end of stack!"
+      end
+
+      def frame_description
+        @frame_description
+      end
+
+      def callers
+        ary = []
+        n = 0
+        loop {
+          begin
+            ary << Binding.of_caller(n)
+          rescue
+            break
+          end
+
+          n += 1
+        }
+
+        ary
+      end
+
+      def frame_count
+        ary = []
+        n = 1
+        loop {
+          begin
+            Binding.of_caller(n)
+          rescue
+            break
+          end
+
+          n += 1
+        }
+
+        n
+      end
+
+      def frame_type
+        case self.variables.method.metadata.to_a.first.to_s
+        when /block/
+          :block
+        when /eval/
+          :eval
+        else
+          :method
+        end
+      end
+
+    end
+  end
+
+  class ::Binding
+    include BindingOfCaller::BindingExtensions
+    extend BindingOfCaller::BindingExtensions
+  end
+end

data/lib/tester.rb

@@ -0,0 +1,15 @@
+require './binding_of_caller'
+
+def a
+  x = 1
+  y = 2
+  b()
+end
+
+def b
+  proc do
+    puts binding.of_caller(2).eval('__method__')
+  end.call
+end
+
+a

data/test/test.rb

@@ -8,52 +8,84 @@ puts "Testing binding_of_caller version #{BindingOfCaller::VERSION}..."
 puts "Ruby version: #{RUBY_VERSION}"
 
 describe BindingOfCaller do
-  it "should fetch immediate caller's binding when 0 is passed" do
-    o = Object.new
-    def o.a
-      var = 1
-      binding.of_caller(0).eval('var')
+  describe "of_caller" do
+    it "should fetch immediate caller's binding when 0 is passed" do
+      o = Object.new
+      def o.a
+        var = 1
+        binding.of_caller(0).eval('var')
+      end
+
+      o. a.should == 1
     end
 
-   o. a.should == 1
-  end
+    it "should fetch parent of caller's binding when 1 is passed" do
+      o = Object.new
+      def o.a
+        var = 1
+        b
+      end
 
-  it "should fetch parent of caller's binding when 1 is passed" do
-    o = Object.new
-    def o.a
-      var = 1
-      b
-    end
+      def o.b
+        binding.of_caller(1).eval('var')
+      end
 
-    def o.b
-      binding.of_caller(1).eval('var')
+      o.a.should == 1
     end
 
-   o.a.should == 1
-  end
+    it "should modify locals in parent of caller's binding" do
+      o = Object.new
+      def o.a
+        var = 1
+        b
+        var
+      end
+
+      def o.b
+        binding.of_caller(1).eval('var = 20')
+      end
 
-  it "should modify locals in parent of caller's binding" do
-    o = Object.new
-    def o.a
-      var = 1
-      b
-      var
+      o.a.should == 20
     end
 
-    def o.b
-      binding.of_caller(1).eval('var = 20')
+    it "should raise an exception when retrieving an out of band binding" do
+      o = Object.new
+      def o.a
+        binding.of_caller(100)
+      end
+
+      lambda { o.a }.should.raise RuntimeError
     end
+  end
 
-   o.a.should == 20
+  describe "frame_count" do
+    it 'frame_count should equal callers.count' do
+      binding.frame_count.should == binding.callers.count
+    end
   end
 
-  it "should raise an exception when retrieving an out of band binding" do
-    o = Object.new
-    def o.a
-      binding.of_caller(100)
+  describe "frame_type" do
+    it 'should return the correct frame types' do
+      o = Object.new
+
+      # method frame
+      def o.a
+        b
+      end
+
+      # method frame
+      def o.b
+        # block frame
+        proc do
+          binding.callers
+        end.call
+      end
+      caller_bindings = o.a
+      caller_bindings[0].frame_type.should == :block
+      caller_bindings[1].frame_type.should == :method
+      caller_bindings[2].frame_type.should == :method
     end
 
-    lambda { o.a }.should.raise RuntimeError
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binding_of_caller
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,21 +9,21 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-22 00:00:00.000000000Z
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &70343943988340 !ruby/object:Gem::Requirement
+  requirement: &70210333909540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *70343943988340
+  version_requirements: *70210333909540
 description: Retrieve the binding of a method's caller. Can also retrieve bindings
-  even further up the stack. Currently only works for MRI 1.9.2.
+  even further up the stack. Currently only works for MRI 1.9.2+
 email: jrmair@gmail.com
 executables: []
 extensions:
@@ -88,7 +88,10 @@ files:
 - ext/binding_of_caller/ruby_headers/193/vm_exec.h
 - ext/binding_of_caller/ruby_headers/193/vm_insnhelper.h
 - ext/binding_of_caller/ruby_headers/193/vm_opts.h
+- lib/binding_of_caller.bundle
+- lib/binding_of_caller.rb
 - lib/binding_of_caller/version.rb
+- lib/tester.rb
 - test/test.rb
 homepage: http://github.com/banister/binding_of_caller
 licenses: []
@@ -110,10 +113,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Retrieve the binding of a method's caller. Can also retrieve bindings even
-  further up the stack. Currently only works for MRI 1.9.2.
+  further up the stack. Currently only works for MRI 1.9.2+
 test_files:
 - test/test.rb