binding_of_caller 0.7.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f3fb3c7ee20b9b9ca1237d0540c2768efc657111
-  data.tar.gz: be4845aeca79432000b44be789993c23c1955715
+SHA256:
+  metadata.gz: 25a588cad50a78180a488286806d6b5c8d0f2864426d4b496046fdbe6af8a102
+  data.tar.gz: dc2c3f0ca27db62f5ea170ee471c4a1342f955b7f3e0f7fdfdaef2492c984031
 SHA512:
-  metadata.gz: 3fd5d2a9ffbda43fcc2d8afa739ec51052f5dacc8632c3e88b60b7be90c2bd67c8a813156dab341e9f3399e46db667f3a1246043d50f1f60b6654d5c07e4e93c
-  data.tar.gz: 13fe3b6ab87052403c99be357fb91ea3ed2c9e9e5a8bafadc3123293bbb0a47bd7a235c67f7d25adb020f07bef0dee6d5a00424c7f59bf4c8b59dfc1f691d5c8
+  metadata.gz: 5dc8dfc7d1b014e12f0fde271d9822da537d3a3e230bba5569e3cce5af7cc89841bd798a6e03ca6b3d8063d2113621892079a0bdc1f31a2d8cc80fcf5dcaa522
+  data.tar.gz: 89d5fc7e71b1138db085625d671b164234832b5942ad5c16e9ead8c20abc2b13caf1fa0ccab64e082e3ddc76af312db4fa778c8c26a52edcad6c91f9359ba45c

data/.github/workflows/test.yml

@@ -0,0 +1,103 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  schedule:
+    - cron: '0 0 11,25 * *' # roughly every two weeks to run on new Ruby versions
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: "Unit"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.1"
+          - "2.2"
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+
+    steps:
+
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Test
+      run: bundle exec rspec -f doc
+
+  system:
+    name: "System"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        ruby:
+          - "2"
+          - "3.0"
+          - "jruby"
+          - "truffleruby"
+        exclude:
+          # Windows releases of jruby and truffleruby have issues. Skip them for now.
+          - { ruby: "jruby", os: "windows-latest" }
+          - { ruby: "truffleruby", os: "windows-latest" }
+
+    steps:
+
+    - uses: actions/checkout@v2
+
+    - name: Determine ruby version name
+      id: ruby_version
+      run: |
+        if [[ $OS == 'windows-latest' && $RUBY == '3.0' ]]; then
+          # Windows doesn't have 3.0, so run head there but nowhere else.
+          echo "::set-output name=release::head"
+        else
+          echo "::set-output name=release::$RUBY"
+        fi
+      shell: bash
+      env:
+        OS: ${{ matrix.os }}
+        RUBY: ${{ matrix.ruby }}
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ steps.ruby_version.outputs.release }}
+        bundler-cache: true
+
+    - name: Install gem
+      run: bundle exec rake install
+
+    - name: Create directory for gem test
+      run: mkdir -p tmp/gem-test
+
+    - name: Create test Gemfile
+      run: echo "gem 'binding_of_caller'" > Gemfile
+      working-directory: ./tmp/gem-test
+
+    - name: Test gem load
+      run: bundle exec ruby -e "require 'binding_of_caller'"
+
+    - name: Test gem functionality
+      if: ${{ matrix.ruby != 'jruby' && matrix.ruby != 'truffleruby' }}
+      run: bundle exec ruby -e "require 'binding_of_caller'; binding.of_caller(0).eval('var = :hello')"
+      env:
+        JRUBY_OPTS: "--dev" # This will support JRuby once the gem is updated to support JRuby 9.x

data/.gitignore

@@ -1,8 +1,13 @@
-Makefile
-*.so
-*.o
-*.def
-doc/
-pkg/
-.yardoc/
 Gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/Gemfile

@@ -1,2 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in binding_of_caller.gemspec
 gemspec
+
+gem "rake"
+gem "rspec"

data/HISTORY

@@ -0,0 +1,35 @@
+## 0.7.3.pre1 / 2014-08-20
+
+This release includes compatibility fixes for different ruby versions
+and some minor enhancements.
+
+*   C Extensions are only compiled on MRI 1.9.x.
+
+    For MRI >= 2 the native API is used, so this should speedup
+    installation.
+
+    For JRuby this will avoid crashes on gem installation.
+
+    This was alredy being checked for Rubinius.
+
+    *Amadeus Folego*
+
+*    Added experimental JRuby support for 1.7.x series.
+
+     Only the main API is implemented and `Binding#eval` is
+     monkey-patched as it is private on JRuby.
+
+     This requires the compiler to be run on interpreted mode,
+     otherwise an exception will be thrown when `of_caller` is called.
+
+    *Charles Nutter*
+
+*   Remove executability from non-executable files.
+
+    *David Celis*
+
+*   Test and notice MRI 2.1 as a working Ruby implementation.
+
+    *Lennart Fridén*
+
+## 0.7.2 / 2013-06-07

data/README.md

@@ -1,11 +1,12 @@
-[![Build Status](https://secure.travis-ci.org/banister/binding_of_caller.png)](http://travis-ci.org/banister/binding_of_caller)
+[![Build Status](https://github.com/banister/binding_of_caller/workflows/Test/badge.svg?branch=master&event=push)](https://github.com/banister/binding_of_caller/actions?query=branch%3Amaster)
+[![Gem Version](https://img.shields.io/gem/v/binding_of_caller.svg)](https://rubygems.org/gems/binding_of_caller)
 
 binding_of_caller
-===========
+=================
 
 (C) John Mair (banisterfiend) 2012
 
-_Retrieve the binding of a method's caller in MRI 1.9.2+, MRI 2.0 and RBX (Rubinius)_
+_Retrieve the binding of a method's caller in MRI (>= 2.0.0) and RBX (Rubinius)_
 
 The `binding_of_caller` gem provides the `Binding#of_caller` method.
 
@@ -15,7 +16,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, 1.9.3, 2.0 and RBX (Rubinius)**
+**Works in MRI Ruby (>= 2.0) and RBX (Rubinius)**
 
 * 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)
@@ -52,8 +53,19 @@ This project is a spinoff from the [Pry REPL project.](http://pry.github.com)
 Features and limitations
 -------------------------
 
-* Only works with MRI 1.9.2, 1.9.3, 2.0 and RBX (Rubinius)
+* Works in MRI (>= 2.0.0) and RBX (Rubinius)
+* For MRI 1.9.x, use version "~> 0.8" of the gem, which included support for MRI before 2.0.
 * Does not work in 1.8.7, but there is a well known (continuation-based) hack to get a `Binding#of_caller` there.
+* There is experimental support for jruby 1.7.x, but it only works in interpreted
+mode (i.e. use the option `-Djruby.compile.mode=OFF` or append
+`compile.mode=OFF` to your `.jrubyrc`)
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 Contact
 -------

data/Rakefile

@@ -1,134 +1,6 @@
-dlext = RbConfig::CONFIG['DLEXT']
-direc = File.dirname(__FILE__)
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-$:.unshift 'lib'
+RSpec::Core::RakeTask.new(:spec)
 
-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
+task :default => :spec

data/binding_of_caller.gemspec

@@ -1,37 +1,35 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = "binding_of_caller"
-  s.version = "0.7.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Mair (banisterfiend)"]
-  s.date = "2013-06-07"
-  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/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/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", "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/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/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", "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.3"
-  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"])
+require_relative 'lib/binding_of_caller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "binding_of_caller"
+  spec.version       = BindingOfCaller::VERSION
+  spec.authors       = ["John Mair (banisterfiend)"]
+  spec.email         = ["jrmair@gmail.com"]
+
+  spec.summary       = %q{Retrieve the binding of a method's caller, or further up the stack.}
+  spec.description   = <<-TXT
+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.
+TXT
+  spec.homepage      = "https://github.com/banister/binding_of_caller"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+
+  spec.metadata = {
+    "changelog_uri"  => "https://github.com/banister/binding_of_caller/releases",
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|examples|bin)/}) }
   end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "debug_inspector", ">= 0.0.1"
 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) 
-          rescue ArgumentError
-            break
-          end
 
+      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, i.frame_iseq(n))
+            b.instance_variable_set(:@iseq, dc.frame_iseq(i))
             ary << b
           end
-          
-          n += 1
         end
       end
-      
+
       ary.drop(1)
     end