binding_of_caller 0.2.0 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb405aa7190a04a128baff727db90ef40ae1468c
+  data.tar.gz: 43cc746def25b335c279df78b070d926bdb43ebc
+SHA512:
+  metadata.gz: 2352e3c209510a9bed92399403425165c3b18bdaa559803d6a042ff5b98b52e70fb9b299236dad9d9895e06b533bcee7a3f1952bd8e7fea972d944b244e8e345
+  data.tar.gz: 7e47b06c1867cec238f1a772a8659acc738b328fd4425601b7a0bb7ce55925be0ebbbee43709bc453efef4ba41e989eed560d6ed7232fc030b83b2c17185910a

data/.gitignore

@@ -0,0 +1,7 @@
+Makefile
+*.so
+*.o
+*.def
+doc/
+pkg/
+.yardoc/

data/.travis.yml

@@ -0,0 +1,22 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+
+notifications:
+  irc: "irc.freenode.org#pry"
+  recipients:
+    - jrmair@gmail.com
+
+branches:
+  only:
+    - master
+
+#script: rake test --trace
+#
+#before_install:
+#  - gem update --system
+#  - gem --version
+#  - gem install rake bacon
+#  - rake gem
+#  - gem install pkg/*.gem

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+License
+-------
+
+(The MIT License) 
+
+Copyright (c) 2011 John Mair (banisterfiend)
+
+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/README.md

@@ -1,27 +1,59 @@
+[![Build Status](https://secure.travis-ci.org/banister/binding_of_caller.png)](http://travis-ci.org/banister/binding_of_caller)
+
 binding_of_caller
 ===========
 
 (C) John Mair (banisterfiend) 2011
 
-FIXME: _tagline_
+_Retrieve the binding of a method's caller in MRI 1.9.2+, and RBX (Rubinius)_
+
+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.
 
-FIXME: _description goes here_
+**Recommended for use only in debugging situations. Do not use this in production apps.**
+
+**Only works in MRI Ruby 1.9.2, 1.9.3 and RBX (Rubinius)**
 
 * 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, 1.9.3 and RBX (Rubinius)
+* 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 +64,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

@@ -1,99 +1,134 @@
-dlext = Config::CONFIG['DLEXT']
-direc = File.dirname(__FILE__)
-
-PROJECT_NAME = "binding_of_caller"
-
-require 'rake/clean'
-require 'rake/gempackagetask'
-require "#{direc}/lib/#{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")
-
-def apply_spec_defaults(s)
-  s.name = PROJECT_NAME
-  s.summary = "FIX ME"
-  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.homepage = "http://banisterfiend.wordpress.com"
-  s.has_rdoc = 'yard'
-  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
-                     "test/*.rb", "HISTORY", "README.md", "Rakefile"]
-end
-
-desc "run tests"
-task :test do
-  sh "bacon -k #{direc}/test/test.rb"
-end
-
-[:mingw32, :mswin32].each do |v|
-  namespace v do
-    spec = Gem::Specification.new do |s|
-      apply_spec_defaults(s)        
-      s.platform = "i386-#{v}"
-      s.files += FileList["lib/**/*.#{dlext}"].to_a
-    end
-
-    Rake::GemPackageTask.new(spec) do |pkg|
-      pkg.need_zip = false
-      pkg.need_tar = false
-    end
-  end
-end
-
-namespace :ruby do
-  spec = Gem::Specification.new do |s|
-    apply_spec_defaults(s)        
-    s.platform = Gem::Platform::RUBY
-    s.extensions = ["ext/#{PROJECT_NAME}/extconf.rb"]
-  end
-  
-  Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = false
-    pkg.need_tar = false
-  end
-end
-
-directories = ["#{direc}/lib/1.8", "#{direc}/lib/1.9"]
-directories.each { |d| directory d }
-
-desc "build the 1.8 and 1.9 binaries from source and copy to lib/"
-task :compile => directories do
-  build_for = proc do |pik_ver, ver|
-    sh %{ \
-          c:\\devkit\\devkitvars.bat && \
-          pik #{pik_ver} && \
-          ruby extconf.rb && \
-          make clean && \
-          make && \
-          cp *.so #{direc}/lib/#{ver} \
-        }
-  end
-  
-  chdir("#{direc}/ext/#{PROJECT_NAME}") do
-    build_for.call("187", "1.8")
-    build_for.call("192", "1.9")
-  end
-end
-
-desc "build all platform gems at once"
-task :gems => [:clean, :rmgems, "mingw32:gem", "mswin32:gem", "ruby:gem"]
-
-desc "remove all platform gems"
-task :rmgems => ["ruby:clobber_package"]
-
-desc "build and push latest gems"
-task :pushgems => :gems do
-  chdir("#{direc}/pkg") do
-    Dir["*.gem"].each do |gemfile|
-      sh "gem push #{gemfile}"
-    end
-  end
-end
+dlext = RbConfig::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+$:.unshift 'lib'
+
+require 'rake/clean'
+require 'rubygems/package_task'
+
+require "binding_of_caller/version"
+
+CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
+CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
+              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake", "**/*.rbc")
+
+def mri_2?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" &&
+    RUBY_VERSION =~ /^2/
+end
+
+def apply_spec_defaults(s)
+  s.name = "binding_of_caller"
+  s.summary = "Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack."
+  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_dependency 'debug_inspector', '>= 0.0.1'
+  s.add_development_dependency 'bacon'
+  s.add_development_dependency 'rake'
+  s.homepage = "http://github.com/banister/binding_of_caller"
+  s.has_rdoc = 'yard'
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end
+
+desc "Show version"
+task :version do
+  puts "BindingOfCaller version: #{BindingOfCaller::VERSION}"
+end
+
+desc "run tests"
+task :default => [:test]
+
+desc "Run tests"
+task :test do
+  unless defined?(Rubinius)
+    Rake::Task['compile'].execute
+  end
+
+  $stdout.puts("\033[33m")
+  sh "bacon -Itest -rubygems -a -q"
+  $stdout.puts("\033[0m")
+
+  unless defined?(Rubinius)
+    Rake::Task['cleanup'].execute
+  end
+end
+
+task :pry do
+  puts "loading binding_of_caller into pry"
+  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)
+    s.platform = Gem::Platform::RUBY
+    s.extensions = ["ext/binding_of_caller/extconf.rb"]
+  end
+
+  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
+
+desc "build the binaries"
+task :compile => :cleanup do
+  if !mri_2?  
+    chdir "./ext/binding_of_caller/" do
+      sh "ruby extconf.rb"
+      sh "make"
+      sh "cp *.#{dlext} ../../lib/"
+    end
+  end
+end
+
+desc 'cleanup the extensions'
+task :cleanup do
+  if !mri_2?
+    sh 'rm -rf lib/binding_of_caller.so'
+    chdir "./ext/binding_of_caller/" do
+      sh 'make clean' 
+    end
+  end
+end
+
+desc "reinstall gem"
+task :reinstall => :gems do
+  sh "gem uninstall binding_of_caller" rescue nil
+  sh "gem install #{direc}/pkg/binding_of_caller-#{BindingOfCaller::VERSION}.gem"
+end
+
+task :install => :reinstall
+
+desc "build all platform gems at once"
+task :gems => [:clean, :rmgems, "ruby:gem"]
+
+task :gem => [:gems]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("./pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end

data/binding_of_caller.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "binding_of_caller"
+  s.version = "0.6.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mair (banisterfiend)"]
+  s.date = "2013-02-14"
+  s.description = "Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack."
+  s.email = "jrmair@gmail.com"
+  s.extensions = ["ext/binding_of_caller/extconf.rb"]
+  s.files = [".gemtest", ".gitignore", ".travis.yml", ".yardopts", "Gemfile", "HISTORY", "LICENSE", "README.md", "Rakefile", "binding_of_caller.gemspec", "examples/example.rb", "ext/binding_of_caller/binding_of_caller.c", "ext/binding_of_caller/extconf.rb", "ext/binding_of_caller/ruby_headers/192/debug.h", "ext/binding_of_caller/ruby_headers/192/dln.h", "ext/binding_of_caller/ruby_headers/192/eval_intern.h", "ext/binding_of_caller/ruby_headers/192/gc.h", "ext/binding_of_caller/ruby_headers/192/id.h", "ext/binding_of_caller/ruby_headers/192/iseq.h", "ext/binding_of_caller/ruby_headers/192/method.h", "ext/binding_of_caller/ruby_headers/192/node.h", "ext/binding_of_caller/ruby_headers/192/regenc.h", "ext/binding_of_caller/ruby_headers/192/regint.h", "ext/binding_of_caller/ruby_headers/192/regparse.h", "ext/binding_of_caller/ruby_headers/192/thread_pthread.h", "ext/binding_of_caller/ruby_headers/192/thread_win32.h", "ext/binding_of_caller/ruby_headers/192/timev.h", "ext/binding_of_caller/ruby_headers/192/transcode_data.h", "ext/binding_of_caller/ruby_headers/192/version.h", "ext/binding_of_caller/ruby_headers/192/vm_core.h", "ext/binding_of_caller/ruby_headers/192/vm_exec.h", "ext/binding_of_caller/ruby_headers/192/vm_insnhelper.h", "ext/binding_of_caller/ruby_headers/192/vm_opts.h", "ext/binding_of_caller/ruby_headers/193/addr2line.h", "ext/binding_of_caller/ruby_headers/193/atomic.h", "ext/binding_of_caller/ruby_headers/193/constant.h", "ext/binding_of_caller/ruby_headers/193/debug.h", "ext/binding_of_caller/ruby_headers/193/dln.h", "ext/binding_of_caller/ruby_headers/193/encdb.h", "ext/binding_of_caller/ruby_headers/193/eval_intern.h", "ext/binding_of_caller/ruby_headers/193/gc.h", "ext/binding_of_caller/ruby_headers/193/id.h", "ext/binding_of_caller/ruby_headers/193/internal.h", "ext/binding_of_caller/ruby_headers/193/iseq.h", "ext/binding_of_caller/ruby_headers/193/method.h", "ext/binding_of_caller/ruby_headers/193/node.h", "ext/binding_of_caller/ruby_headers/193/parse.h", "ext/binding_of_caller/ruby_headers/193/regenc.h", "ext/binding_of_caller/ruby_headers/193/regint.h", "ext/binding_of_caller/ruby_headers/193/regparse.h", "ext/binding_of_caller/ruby_headers/193/revision.h", "ext/binding_of_caller/ruby_headers/193/thread_pthread.h", "ext/binding_of_caller/ruby_headers/193/thread_win32.h", "ext/binding_of_caller/ruby_headers/193/timev.h", "ext/binding_of_caller/ruby_headers/193/transcode_data.h", "ext/binding_of_caller/ruby_headers/193/transdb.h", "ext/binding_of_caller/ruby_headers/193/version.h", "ext/binding_of_caller/ruby_headers/193/vm_core.h", "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.rb", "lib/binding_of_caller/mri2.rb", "lib/binding_of_caller/rubinius.rb", "lib/binding_of_caller/version.rb", "test/test_binding_of_caller.rb"]
+  s.homepage = "http://github.com/banister/binding_of_caller"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.0.rc.2"
+  s.summary = "Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack."
+  s.test_files = ["test/test_binding_of_caller.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<debug_inspector>, [">= 0.0.1"])
+      s.add_development_dependency(%q<bacon>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<debug_inspector>, [">= 0.0.1"])
+      s.add_dependency(%q<bacon>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<debug_inspector>, [">= 0.0.1"])
+    s.add_dependency(%q<bacon>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+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

@@ -1,22 +1,32 @@
 /* (c) 2011 John Mair (banisterfiend), MIT license */
 
 #include <ruby.h>
-//#include "compat.h"
-
-//#ifdef RUBY_19
-# include <ruby/io.h>
-# include <ruby/re.h>
-# include "vm_core.h"
-# include "gc.h"
-/* #else */
-/* # include "re.h" */
-/* # include "env.h" */
-/* # include "node.h" */
-/* # include "rubysig.h" */
-/* # include "rubyio.h" */
-/* #endif */
-
-extern rb_thread_t *ruby_current_thread;
+#include "vm_core.h"
+#include "gc.h"
+
+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_threadptr_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)
@@ -44,7 +54,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");
 }
@@ -65,60 +79,147 @@ binding_alloc(VALUE klass)
   return obj;
 }
 
-typedef enum { false, true } bool;
-
-static bool valid_frame_p(rb_control_frame_t * cfp) {
-  return cfp->iseq && !NIL_P(cfp->self);
+static bool ifunc_p(rb_control_frame_t * cfp) {
+  return (cfp->flag & VM_FRAME_MAGIC_MASK) == VM_FRAME_MAGIC_IFUNC;
 }
 
-static rb_control_frame_t * find_valid_frame(rb_control_frame_t * cfp) {
-  int error_count = 0;
+static bool valid_frame_p(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
+  return cfp->iseq && !ifunc_p(cfp) && !NIL_P(cfp->self);
+}
 
-  while (error_count <= 4) {
+static rb_control_frame_t * find_valid_frame(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
+  while (cfp < limit_cfp) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
-    if (valid_frame_p(cfp))
+    if (cfp >= limit_cfp)
+      return NULL;
+
+    if (valid_frame_p(cfp, limit_cfp))
       return cfp;
-    else
-      error_count += 1;
   }
 
-  rb_raise(rb_eRuntimeError, "No valid stack frame found.");
+  // beyond end of stack
+  return NULL;
+}
 
-  // never reached
-  return 0;
+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_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);
 
-  for (int i = 0; i < level; i++)
+  // attempt to locate the nth parent control frame
+  for (int i = 0; i < level; i++) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
-  if (!valid_frame_p(cfp))
-    cfp = find_valid_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);
+  }
 
   VALUE bindval = binding_alloc(rb_cBinding);
   rb_binding_t *bind;
 
-  if (cfp == 0) {
+  if (cfp == 0)
     rb_raise(rb_eRuntimeError, "Can't create Binding Object on top of Fiber.");
-  }
 
   GetBindingPtr(bindval, bind);
+
   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()
 {
-  rb_define_method(rb_cObject, "binding_of_caller", binding_of_caller, 1);
-
+  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

@@ -1,14 +1,33 @@
-require 'mkmf'
+def fake_makefile
+  File.open(File.join(File.dirname(__FILE__), "Makefile"), "w") do |f|
+    f.puts %[install:\n\techo "Nada."]
+  end
+end
+
+def mri_2?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" &&
+    RUBY_VERSION =~ /^2/
+end
+
+def rbx?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /rbx/
+end
+
+if mri_2? || rbx?
+  fake_makefile
+else
+  require 'mkmf'
+
+  $CFLAGS += " -O0"
+  $CFLAGS += " -std=c99"
 
-$CFLAGS += " -O0"
-$CFLAGS += " -std=c99"
+  case RUBY_VERSION
+  when /1.9.2/
+    $CFLAGS += " -I./ruby_headers/192/ -DRUBY_192"
+  when /1.9.3/
+    $CFLAGS += " -I./ruby_headers/193/ -DRUBY_193"
+  end
 
-case RUBY_VERSION
-when /1.9.2/
-  $CFLAGS += " -I./ruby_headers/192/"
-when /1.9.3/
-  puts "hit 193"
-  $CFLAGS += " -I./ruby_headers/193/"
+  create_makefile('binding_of_caller')
 end
 
-create_makefile('binding_of_caller')

data/lib/binding_of_caller/mri2.rb

@@ -0,0 +1,69 @@
+require 'debug_inspector'
+
+module BindingOfCaller
+  module BindingExtensions
+    # Retrieve the binding of the nth caller of the current frame.
+    # @return [Binding]
+    def of_caller(n)
+      c = callers.drop(1)
+      if n > (c.size - 1)
+        raise "No such frame, gone beyond end of stack!"
+      else
+        c[n]
+      end
+    end
+
+    # Return bindings for all caller frames.
+    # @return [Array<Binding>]
+    def callers
+      ary = []
+    
+      RubyVM::DebugInspector.open do |i|
+        n = 0
+        loop do
+          begin
+            b = i.frame_binding(n) 
+
+            if b
+              iseq = i.frame_iseq(n) 
+              b.instance_variable_set(:@iseq, iseq)
+              ary << b
+            end
+          rescue ArgumentError
+            break
+          end
+          n += 1
+        end
+      end
+      
+      ary.drop(1)
+    end
+
+    # Number of parent frames available at the point of call.
+    # @return [Fixnum]
+    def frame_count
+      callers.size - 1
+    end
+
+    # The type of the frame.
+    # @return [Symbol]
+    def frame_type
+      return nil if !@iseq
+      
+      # apparently the 9th element of the iseq array holds the frame type
+      # ...not sure how reliable this is.
+      @frame_type ||= @iseq.to_a[9]
+    end
+
+    # The description of the frame.
+    # @return [String]
+    def frame_description
+      return nil if !@iseq
+      @frame_description ||= @iseq.label
+    end
+  end
+end
+
+class ::Binding
+  include BindingOfCaller::BindingExtensions
+end

data/lib/binding_of_caller/rubinius.rb

@@ -0,0 +1,77 @@
+module BindingOfCaller
+  module BindingExtensions
+
+    # Retrieve the binding of the nth caller of the current frame.
+    # @return [Binding]
+    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
+
+    # The description of the frame.
+    # @return [String]
+    def frame_description
+      @frame_description
+    end
+
+    # Return bindings for all caller frames.
+    # @return [Array<Binding>]
+    def callers
+      ary = []
+      n = 0
+      loop do
+        begin
+          ary << Binding.of_caller(n)
+        rescue
+          break
+        end
+        n += 1
+      end
+      ary.drop_while do |v|
+        !(v.frame_type == :method && v.eval("__method__") == :callers)
+      end.drop(1)
+    end
+
+    # Number of parent frames available at the point of call.
+    # @return [Fixnum]
+    def frame_count
+      callers.size - 1
+    end
+
+    # The type of the frame.
+    # @return [Symbol]
+    def frame_type
+      case self.variables.method.metadata.to_a.first.to_s
+      when /block/
+        :block
+      when /eval/
+        :eval
+      else
+        if frame_description =~ /__(?:class|module)_init__/
+          :class
+        else
+          :method
+        end
+      end
+    end
+
+  end
+end
+
+class ::Binding
+  include BindingOfCaller::BindingExtensions
+  extend BindingOfCaller::BindingExtensions
+end

data/lib/binding_of_caller/version.rb

@@ -1,3 +1,3 @@
-module BindingOfCaller
-  VERSION = "0.2.0"
-end     
+module BindingOfCaller
+  VERSION = "0.7.1"
+end

data/lib/binding_of_caller.rb

@@ -1,22 +1,14 @@
-# binding_of_caller.rb
-# (C) John Mair (banisterfiend); MIT license
+dlext = RbConfig::CONFIG['DLEXT']
 
-direc = File.dirname(__FILE__)
-
-require "#{direc}/binding_of_caller/version"
-
-begin
-  if RUBY_VERSION =~ /1.9/
-    require "#{direc}/1.9/binding_of_caller"
-  else
-    require "#{direc}/1.8/binding_of_caller"
-  end
-rescue LoadError => e
-  require "rbconfig"
-  dlext = Config::CONFIG['DLEXT']
-  require "#{direc}/binding_of_caller.#{dlext}"
+def mri_2?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" &&
+    RUBY_VERSION =~ /^2/
 end
 
-module BindingOfCaller
-end  
-
+if mri_2?
+  require 'binding_of_caller/mri2'
+elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
+  require "binding_of_caller.#{dlext}"
+elsif defined?(Rubinius)
+  require 'binding_of_caller/rubinius'
+end

data/test/test_binding_of_caller.rb

@@ -0,0 +1,149 @@
+unless Object.const_defined? :BindingOfCaller
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'binding_of_caller'
+  require 'binding_of_caller/version'
+end
+
+class Module
+  public :remove_const
+end
+
+puts "Testing binding_of_caller version #{BindingOfCaller::VERSION}..."
+puts "Ruby version: #{RUBY_VERSION}"
+
+describe BindingOfCaller do
+  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
+
+    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
+
+      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
+
+      o.a.should == 20
+    end
+
+    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
+
+  describe "callers" do
+    before do
+      @o = Object.new
+    end
+
+    it 'should return the first non-internal binding when using callers.first' do
+      def @o.meth
+        x = :a_local
+        [binding.callers.first, binding.of_caller(0)]
+      end
+
+      b1, b2 = @o.meth
+      b1.eval("x").should == :a_local
+      b2.eval("x").should == :a_local
+    end
+  end
+
+  describe "frame_count" do
+    it 'frame_count should equal callers.count' do
+      binding.frame_count.should == binding.callers.count
+    end
+  end
+  
+  describe "frame_descripton" do
+    it 'can be called on ordinary binding without raising' do
+      lambda { binding.frame_description }.should.not.raise 
+    end
+    
+    it 'describes a block frame' do
+      binding.of_caller(0).frame_description.should =~ /block/
+    end
+
+    it 'describes a method frame' do
+      o = Object.new
+      def o.horsey_malone
+        binding.of_caller(0).frame_description.should =~ /horsey_malone/
+      end
+      o.horsey_malone
+    end
+
+    it 'describes a class frame' do
+      class HorseyMalone
+        binding.of_caller(0).frame_description.should =~ /class/
+      end
+      Object.remove_const(:HorseyMalone)
+    end
+  end
+
+  describe "frame_type" do
+    it 'can be called on ordinary binding without raising' do
+      lambda { binding.frame_type }.should.not.raise 
+    end
+    
+    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
+
+    it 'identifies a class frame' do
+      class HorseyMalone
+        binding.of_caller(0).frame_type.should == :class
+      end
+
+      Object.remove_const(:HorseyMalone)
+    end
+
+  end
+end
+

metadata

@@ -1,39 +1,78 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: binding_of_caller
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.7.1
 platform: ruby
-authors: 
+authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug_inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
   name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: FIX ME
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Retrieve the binding of a method's caller. Can also retrieve bindings
+  even further up the stack.
 email: jrmair@gmail.com
 executables: []
-
-extensions: 
+extensions:
 - ext/binding_of_caller/extconf.rb
 extra_rdoc_files: []
-
-files: 
+files:
+- .gemtest
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- HISTORY
+- LICENSE
+- README.md
+- Rakefile
+- binding_of_caller.gemspec
+- examples/example.rb
+- ext/binding_of_caller/binding_of_caller.c
 - ext/binding_of_caller/extconf.rb
-- ext/binding_of_caller/compat.h
 - ext/binding_of_caller/ruby_headers/192/debug.h
 - ext/binding_of_caller/ruby_headers/192/dln.h
 - ext/binding_of_caller/ruby_headers/192/eval_intern.h
@@ -82,39 +121,34 @@ 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
-- ext/binding_of_caller/binding_of_caller.c
-- lib/binding_of_caller/version.rb
 - lib/binding_of_caller.rb
-- test/test.rb
-- HISTORY
-- README.md
-- Rakefile
-homepage: http://banisterfiend.wordpress.com
+- lib/binding_of_caller/mri2.rb
+- lib/binding_of_caller/rubinius.rb
+- lib/binding_of_caller/version.rb
+- test/test_binding_of_caller.rb
+homepage: http://github.com/banister/binding_of_caller
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
-summary: FIX ME
-test_files: []
-
+specification_version: 4
+summary: Retrieve the binding of a method's caller. Can also retrieve bindings even
+  further up the stack.
+test_files:
+- test/test_binding_of_caller.rb

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/test/test.rb

@@ -1,12 +0,0 @@
-direc = File.dirname(__FILE__)
-
-require 'rubygems'
-require "#{direc}/../lib/binding_of_caller"
-require 'bacon'
-
-puts "Testing binding_of_caller version #{BindingOfCaller::VERSION}..." 
-puts "Ruby version: #{RUBY_VERSION}"
-
-describe BindingOfCaller do
-end
-