binding_of_caller 0.6.3 → 0.7.3.pre1

data/lib/binding_of_caller/jruby_interpreted.rb

@@ -0,0 +1,64 @@
+class org::jruby::runtime::ThreadContext
+  java_import org.jruby.runtime.Binding
+  java_import org.jruby.RubyBinding
+  java_import org.jruby.RubyInstanceConfig::CompileMode
+
+  field_accessor :frameStack, :frameIndex,
+    :scopeStack, :scopeIndex,
+    :backtrace, :backtraceIndex
+
+  def binding_of_caller(index)
+    unless JRuby.runtime.instance_config.compile_mode == CompileMode::OFF
+      raise RuntimeError, "caller binding only supported in interpreter"
+    end
+
+    index += 1 # always omit this frame
+
+    raise RuntimeError, "Invalid frame, gone beyond end of stack!" if index > frameIndex
+
+    frame = frameStack[frameIndex - index]
+
+    return binding_of_caller(index - 1) if index > scopeIndex
+
+    scope = scopeStack[scopeIndex - index]
+    element = backtrace[backtraceIndex - index]
+
+    binding = Binding.new(frame, scope.static_scope.module, scope, element.clone)
+
+    JRuby.dereference(RubyBinding.new(JRuby.runtime, Binding, binding))
+  end
+end
+
+module BindingOfCaller
+  module BindingExtensions
+    def of_caller(index = 1)
+      index += 1 # always omit this frame
+      JRuby.runtime.current_context.binding_of_caller(index)
+    end
+
+    def callers
+      ary = []
+      n = 2
+      loop do
+        ary << of_caller(n) rescue break
+        n += 1
+      end
+      ary
+    end
+
+    def frame_count
+      callers.count - 1
+    end
+  end
+end
+
+class ::Binding
+  include BindingOfCaller::BindingExtensions
+  extend BindingOfCaller::BindingExtensions
+end
+
+class Java::OrgJrubyRuntime::Binding
+  def eval(code)
+    Kernel.eval code, self
+  end
+end

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) 
+          rescue ArgumentError
+            break
+          end
+
+          if b
+            b.instance_variable_set(:@iseq, i.frame_iseq(n))
+            ary << b
+          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,67 @@
+module BindingOfCaller
+  module BindingExtensions
+
+    # Retrieve the binding of the nth caller of the current frame.
+    # @return [Binding]
+    def of_caller(n)
+      location = Rubinius::VM.backtrace(1 + n, true).first
+
+      raise RuntimeError, "Invalid frame, gone beyond end of stack!" if location.nil?
+
+      setup_binding_from_location(location)
+    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
+      Rubinius::VM.backtrace(1, true).map &(method(:setup_binding_from_location).
+                                            to_proc)
+    end
+
+    # Number of parent frames available at the point of call.
+    # @return [Fixnum]
+    def frame_count
+      Rubinius::VM.backtrace(1).count
+    end
+
+    # The type of the frame.
+    # @return [Symbol]
+    def frame_type
+      if compiled_code.for_module_body?
+        :class
+      elsif compiled_code.for_eval?
+        :eval
+      elsif compiled_code.is_block?
+        :block
+      else
+        :method
+      end
+    end
+
+    protected
+
+    def setup_binding_from_location(location)
+      binding = Binding.setup location.variables,
+                              location.variables.method,
+                              location.constant_scope,
+                              location.variables.self,
+                              location
+
+      binding.instance_variable_set :@frame_description,
+                                   location.describe.gsub("{ } in", "block in")
+
+      binding
+    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.6.3"
-end
+module BindingOfCaller
+  VERSION = "0.7.3.pre1"
+end

data/lib/binding_of_caller.rb

@@ -1,82 +1,16 @@
-dlext = Config::CONFIG['DLEXT']
+dlext = RbConfig::CONFIG['DLEXT']
 
-if RUBY_ENGINE && RUBY_ENGINE == "ruby"
-  require "binding_of_caller.#{dlext}"
+def mri_2?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" &&
+    RUBY_VERSION =~ /^2/
+end
 
+if mri_2?
+  require 'binding_of_caller/mri2'
+elsif defined?(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
+  require 'binding_of_caller/rubinius'
+elsif defined?(JRuby)
+  require 'binding_of_caller/jruby_interpreted'
 end

data/test/test_binding_of_caller.rb

@@ -0,0 +1,161 @@
+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/i
+      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
+
+    describe "when inside a class definition" do
+      before do
+        class HorseyMalone
+          @binding = binding.of_caller(0)
+          def self.binding; @binding; end
+        end
+        @binding = HorseyMalone.binding
+      end
+
+      it 'returns :class' do
+        @binding.frame_type.should == :class
+      end
+    end
+
+    describe "when evaluated" do
+      before { @binding = eval("binding.of_caller(0)") }
+
+      it 'returns :eval' do
+        @binding.frame_type.should == :eval
+      end
+    end
+
+    describe "when inside a block" do
+      before { @binding = proc { binding.of_caller(0) }.call }
+
+      it 'returns :block' do
+        @binding.frame_type.should == :block
+      end
+    end
+
+    describe "when inside an instance method" do
+      before do
+        o = Object.new
+        def o.a; binding.of_caller(0); end
+        @binding = o.a;
+      end
+
+      it 'returns :method' do
+        @binding.frame_type.should == :method
+      end
+    end
+  end
+end
+

metadata

@@ -1,49 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: binding_of_caller
 version: !ruby/object:Gem::Version
-  version: 0.6.3
-  prerelease: 
+  version: 0.7.3.pre1
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-29 00:00:00.000000000 Z
+date: 2014-08-20 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: &70210333909540 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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: '1.1'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70210333909540
+  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. Currently only works for MRI 1.9.2+
+  even further up the stack.
 email: jrmair@gmail.com
 executables: []
 extensions:
 - ext/binding_of_caller/extconf.rb
 extra_rdoc_files: []
 files:
-- .gemtest
-- .gitignore
-- .yardopts
+- ".gemtest"
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
 - HISTORY
 - LICENSE
 - README.md
 - Rakefile
+- binding_of_caller.gemspec
+- examples/benchmark.rb
 - 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
@@ -51,6 +84,7 @@ files:
 - 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/rubys_gc.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
@@ -67,7 +101,6 @@ files:
 - 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
@@ -78,6 +111,7 @@ files:
 - 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/rubys_gc.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
@@ -88,35 +122,35 @@ 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/jruby_interpreted.rb
+- lib/binding_of_caller/mri2.rb
+- lib/binding_of_caller/rubinius.rb
 - lib/binding_of_caller/version.rb
-- lib/tester.rb
-- test/test.rb
+- test/test_binding_of_caller.rb
 homepage: http://github.com/banister/binding_of_caller
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 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.
 test_files:
-- test/test.rb
+- test/test_binding_of_caller.rb

data/lib/tester.rb

@@ -1,15 +0,0 @@
-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