binding_of_caller 0.7.1 → 1.0.0

data/lib/binding_of_caller.rb

@@ -1,14 +1,13 @@
-dlext = RbConfig::CONFIG['DLEXT']
+require "binding_of_caller/version"
 
-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}"
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
+  if RUBY_VERSION =~ /^[23]/
+    require 'binding_of_caller/mri'
+  else
+    puts "This version of binding_of_caller doesn't support this version of Ruby"
+  end
 elsif defined?(Rubinius)
   require 'binding_of_caller/rubinius'
+elsif defined?(JRuby)
+  require 'binding_of_caller/jruby_interpreted'
 end

data/lib/binding_of_caller/jruby_interpreted.rb

@@ -0,0 +1,123 @@
+module BindingOfCaller
+  class JRubyBindingHolder
+    java_import org.jruby.RubyBinding
+
+    def initialize(binding)
+      @binding = binding
+    end
+
+    def eval(code, file = nil, line = nil)
+      b = JRuby.dereference(RubyBinding.new(JRuby.runtime, Binding, @binding))
+      if (file == nil)
+        Kernel.eval code, b
+      else
+        Kernel.eval code, b, file, line
+      end
+    end
+
+    def frame_type
+      case
+        when block?
+          :block
+        when eval?
+          :eval
+        when top?
+          :top
+        else
+          :method
+      end
+    end
+
+    def frame_description
+      "#{block_desc}#{method_desc}"
+    end
+
+    private
+
+    def block?
+      @binding.getDynamicScope().getStaticScope().isBlockScope()
+    end
+
+    def eval?
+      @binding.getFrame().getKlazz().nil? && @binding.getLine() != 0
+    end
+
+    def top?
+      @binding.getFrame().getKlazz().nil? && @binding.getLine() == 0
+    end
+
+    def block_desc
+      if frame_type == :block
+        "block in "
+      end
+    end
+
+    def method_desc
+      @binding.getFrame().getName() || "<main>"
+    end
+  end
+
+  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
+      while binding = of_caller(n)
+        ary << binding
+        n += 1
+      end
+      ary
+    end
+
+    def frame_count
+      callers.count - 1
+    end
+
+    def frame_type
+      nil
+    end
+
+    def frame_description
+      nil
+    end
+  end
+end
+
+
+class org::jruby::runtime::ThreadContext
+  java_import org.jruby.runtime.Binding
+  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
+
+    return nil 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)
+
+    BindingOfCaller::JRubyBindingHolder.new(binding)
+  end
+end
+
+class ::Binding
+  include BindingOfCaller::BindingExtensions
+end

data/lib/binding_of_caller/{mri2.rb → mri.rb}

@@ -17,25 +17,19 @@ module BindingOfCaller
     # @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
+      RubyVM::DebugInspector.open do |dc|
+        locs = dc.backtrace_locations
+
+        locs.size.times do |i|
+          b = dc.frame_binding(i)
+          if b
+            b.instance_variable_set(:@iseq, dc.frame_iseq(i))
+            ary << b
           end
-          n += 1
         end
       end
-      
+
       ary.drop(1)
     end
 

data/lib/binding_of_caller/rubinius.rb

@@ -4,21 +4,11 @@ module BindingOfCaller
     # 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
+      location = Rubinius::VM.backtrace(1 + n, true).first
 
-      b = Binding.setup(
-                        bt.variables,
-                        bt.variables.method,
-                        bt.static_scope,
-                        bt.variables.self,
-                        bt
-                        )
+      raise RuntimeError, "Invalid frame, gone beyond end of stack!" if location.nil?
 
-      b.instance_variable_set(:@frame_description, bt.describe)
-
-      b
-    rescue
-      raise RuntimeError, "Invalid frame, gone beyond end of stack!"
+      setup_binding_from_location(location)
     end
 
     # The description of the frame.
@@ -30,44 +20,44 @@ module BindingOfCaller
     # 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)
+      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
-      callers.size - 1
+      Rubinius::VM.backtrace(1).count
     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/
+      if compiled_code.for_module_body?
+        :class
+      elsif compiled_code.for_eval?
         :eval
+      elsif compiled_code.is_block?
+        :block
       else
-        if frame_description =~ /__(?:class|module)_init__/
-          :class
-        else
-          :method
-        end
+        :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
 

data/lib/binding_of_caller/version.rb

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

metadata

@@ -1,154 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: binding_of_caller
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0
 platform: ruby
 authors:
 - John Mair (banisterfiend)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2020-12-28 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
-  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
-  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
+description: |
+  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.
+email:
+- jrmair@gmail.com
 executables: []
-extensions:
-- ext/binding_of_caller/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
-- .gemtest
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".gemtest"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".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/jruby_interpreted.rb
+- lib/binding_of_caller/mri.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: 
+homepage: https://github.com/banister/binding_of_caller
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/banister/binding_of_caller/releases
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.0.rc.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 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
+summary: Retrieve the binding of a method's caller, or further up the stack.
+test_files: []