binding_of_caller 0.3.0 → 0.4.0

data/README.md

@@ -3,25 +3,56 @@ binding_of_caller
 
 (C) John Mair (banisterfiend) 2011
 
-FIXME: _tagline_
+_Retrieve the binding of a method's caller in MRI 1.9.2_
 
-FIXME: _description goes here_
+The `binding_of_caller` gem provides the `Binding#of_caller` method.
+
+Using `binding_of_caller` we can grab bindings from higher up the call
+stack and evaluate code in that context. Allows access to bindings arbitrarily far up the
+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**
 
 * Install the [gem](https://rubygems.org/gems/binding_of_caller): `gem install binding_of_caller`
-* Read the [documentation](http://rdoc.info/github/banister/binding_of_caller/master/file/README.markdown)
 * See the [source code](http://github.com/banister/binding_of_caller)
 
-Example: Example description
+Example: Modifying a local inside the caller of a caller
 --------
 
-Example preamble
+```ruby
+def a
+  var = 10
+  b
+  puts var
+end
+
+def b
+  c
+end
+
+def c
+  binding.of_caller(2).eval('var = :hello')
+end
+
+a()
+
+# OUTPUT
+# => hello
+```
+
+Spinoff project
+-------
 
-    puts "example code"
+This project is a spinoff from the [Pry REPL project.](http://pry.github.com)
 
 Features and limitations
 -------------------------
 
-Feature List Preamble
+* Only works with MRI 1.9.2
+* Broken in 1.9.3, support will hopefully be provided in the near future.
+* Does not work in 1.8.7, but there is a well known (continuation-based) hack to get a `Binding#of_caller` there.
 
 Contact
 -------
@@ -32,7 +63,7 @@ Problems or questions contact me at [github](http://github.com/banister)
 License
 -------
 
-(The MIT License) 
+(The MIT License)
 
 Copyright (c) 2011 (John Mair)
 

data/Rakefile

@@ -52,7 +52,7 @@ namespace :ruby do
   end
 end
 
-desc "build the biinaries"
+desc "build the binaries"
 task :compile do
   chdir "./ext/#{PROJECT_NAME}/" do
     sh "ruby extconf.rb"
@@ -72,7 +72,7 @@ task :rmgems => ["ruby:clobber_package"]
 
 desc "build and push latest gems"
 task :pushgems => :gems do
-  chdir("#{direc}/pkg") do
+  chdir("./pkg") do
     Dir["*.gem"].each do |gemfile|
       sh "gem push #{gemfile}"
     end

data/examples/example.rb

@@ -0,0 +1,41 @@
+unless Object.const_defined? :BindingOfCaller
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'binding_of_caller'
+  require 'binding_of_caller/version'
+end
+
+outer = 10
+
+class Z
+  def z
+    u = 10
+    A.new.a
+  end
+end
+
+class A
+  def a
+    y = 10
+    B.new.b
+  end
+end
+
+class B
+  def b
+    x = 10
+    puts binding.of_caller(0).eval('local_variables')
+    puts binding.of_caller(1).eval('local_variables')
+    puts binding.of_caller(2).eval('local_variables')
+    puts binding.of_caller(3).eval('local_variables')
+    puts binding.of_caller(400).eval('local_variables')
+  end
+end
+
+Z.new.z
+
+# output:
+# => x
+# => y
+# => u
+# => outer
+# Exception

data/ext/binding_of_caller/binding_of_caller.c

@@ -2,10 +2,10 @@
 
 #include <ruby.h>
 
-# include <ruby/io.h>
-# include <ruby/re.h>
-# include "vm_core.h"
-# include "gc.h"
+#include <ruby/io.h>
+#include <ruby/re.h>
+#include "vm_core.h"
+#include "gc.h"
 
 typedef enum { false, true } bool;
 
@@ -58,24 +58,25 @@ binding_alloc(VALUE klass)
   return obj;
 }
 
-static bool valid_frame_p(rb_control_frame_t * cfp) {
+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) {
+static rb_control_frame_t * find_valid_frame(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
   int error_count = 0;
 
   while (error_count <= max_frame_errors) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
-    if (valid_frame_p(cfp))
+    if (valid_frame_p(cfp, limit_cfp))
       return cfp;
     else
       error_count += 1;
   }
 
-  rb_raise(rb_eRuntimeError, "No valid stack frame found.");
-
   // never reached
   return 0;
 }
@@ -84,15 +85,17 @@ static VALUE binding_of_caller(VALUE self, VALUE rb_level)
 {
   rb_thread_t *th = GET_THREAD();
   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);
 
   // attempt to locate the nth parent control frame
-  for (int i = 0; i < level; i++)
+  for (int i = 0; i < level; i++) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
-  // if did not find a valid one, then search for a valid one
-  if (!valid_frame_p(cfp))
-    cfp = find_valid_frame(cfp);
+    // skip invalid frames
+    if (!valid_frame_p(cfp, limit_cfp))
+      cfp = find_valid_frame(cfp, limit_cfp);
+  }
 
   VALUE bindval = binding_alloc(rb_cBinding);
   rb_binding_t *bind;

data/lib/binding_of_caller/version.rb

@@ -1,3 +1,3 @@
 module BindingOfCaller
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: binding_of_caller
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 Z
+date: 2011-10-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bacon
@@ -39,9 +39,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/example.rb
 - ext/binding_of_caller/binding_of_caller.c
-- ext/binding_of_caller/compat.h
-- ext/binding_of_caller/example.rb
 - ext/binding_of_caller/extconf.rb
 - ext/binding_of_caller/ruby_headers/192/debug.h
 - ext/binding_of_caller/ruby_headers/192/dln.h

data/ext/binding_of_caller/compat.h

@@ -1,57 +0,0 @@
-/* contains basic macros to facilitate ruby 1.8 and ruby 1.9 compatibility */
-
-#ifndef GUARD_COMPAT_H
-#define GUARD_COMPAT_H
-
-#include <ruby.h>
-
-/* test for 1.9 */
-#if !defined(RUBY_19) && defined(ROBJECT_EMBED_LEN_MAX)
-# define RUBY_19
-#endif
-
-/* macros for backwards compatibility with 1.8 */
-#ifndef RUBY_19
-# define RCLASS_M_TBL(c) (RCLASS(c)->m_tbl)
-# define RCLASS_SUPER(c) (RCLASS(c)->super)
-# define RCLASS_IV_TBL(c) (RCLASS(c)->iv_tbl)
-# define OBJ_UNTRUSTED OBJ_TAINTED
-# include "st.h"
-#endif
-
-#ifdef RUBY_19
-inline static VALUE
-class_alloc(VALUE flags, VALUE klass)
-{
-  rb_classext_t *ext = ALLOC(rb_classext_t);
-  NEWOBJ(obj, struct RClass);
-  OBJSETUP(obj, klass, flags);
-  obj->ptr = ext;
-  RCLASS_IV_TBL(obj) = 0;
-  RCLASS_M_TBL(obj) = 0;
-  RCLASS_SUPER(obj) = 0;
-  RCLASS_IV_INDEX_TBL(obj) = 0;
-  return (VALUE)obj;
-}
-#endif
-
-inline static VALUE
-create_class(VALUE flags, VALUE klass)
-{
-#ifdef RUBY_19
-  VALUE new_klass = class_alloc(flags, klass);
-#else
-  NEWOBJ(new_klass, struct RClass);
-  OBJSETUP(new_klass, klass, flags);
-#endif
-
-  return (VALUE)new_klass;
-}
-  
-# define FALSE 0
-# define TRUE 1
-
-/* a useful macro. cannot use ordinary CLASS_OF as it does not return an lvalue */
-#define KLASS_OF(c) (RBASIC(c)->klass)
-
-#endif

data/ext/binding_of_caller/example.rb

@@ -1,39 +0,0 @@
-require './binding_of_caller'
-
-outer = 10
-
-class Z
-  def z
-    u = 10
-    A.new.a
-  end
-end
-
-class A
-  def a
-    y = 10
-    B.new.b
-  end
-end
-
-class B
-  def b
-    x = 10
-    puts binding_of_caller(0).eval('local_variables')
-    puts binding_of_caller(1).eval('local_variables')
-    puts binding_of_caller(2).eval('local_variables')
-    puts binding_of_caller(3).eval('local_variables')
-    puts binding_of_caller(400).eval('local_variables')
-  end
-end
-
-def a; b; end; def b; binding_of_caller(10); end; a;
-
-# Z.new.z
-
-# output:
-# => x
-# => y
-# => u
-# => outer
-# Exception