binding_of_caller 0.7.2 → 1.0.0

data/lib/binding_of_caller/rubinius.rb

@@ -4,22 +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
 
-      raise RuntimeError, "Invalid frame, gone beyond end of stack!" if bt.nil?
+      raise RuntimeError, "Invalid frame, gone beyond end of stack!" if location.nil?
 
-      b = Binding.setup(
-                        bt.variables,
-                        bt.variables.method,
-                        bt.constant_scope,
-                        bt.variables.self,
-                        bt
-                        )
-
-      b.instance_variable_set :@frame_description,
-                              bt.describe.gsub("{ } in", "block in")
-
-      b
+      setup_binding_from_location(location)
     end
 
     # The description of the frame.
@@ -31,25 +20,14 @@ 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.
@@ -65,6 +43,21 @@ module BindingOfCaller
         :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.2"
+  VERSION = "1.0.0"
 end

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

metadata

@@ -1,154 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: binding_of_caller
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 1.0.0
 platform: ruby
 authors:
 - John Mair (banisterfiend)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-06-07 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/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/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.3
-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: []

data/.travis.yml

@@ -1,23 +0,0 @@
-rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - rbx-19mode
-
-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/examples/example.rb

@@ -1,41 +0,0 @@
-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,225 +0,0 @@
-/* (c) 2011 John Mair (banisterfiend), MIT license */
-
-#include <ruby.h>
-#include "vm_core.h"
-#include "rubys_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)
-{
-  return ptr ? sizeof(rb_binding_t) : 0;
-}
-
-static void
-binding_free(void *ptr)
-{
-  rb_binding_t *bind;
-  RUBY_FREE_ENTER("binding");
-  if (ptr) {
-    bind = ptr;
-    ruby_xfree(ptr);
-  }
-  RUBY_FREE_LEAVE("binding");
-}
-
-static void
-binding_mark(void *ptr)
-{
-  rb_binding_t *bind;
-  RUBY_MARK_ENTER("binding");
-  if (ptr) {
-    bind = ptr;
-    RUBY_MARK_UNLESS_NULL(bind->env);
-
-#ifdef RUBY_192
-    RUBY_MARK_UNLESS_NULL(bind->filename);
-#endif
-
-  }
-  RUBY_MARK_LEAVE("binding");
-}
-
-static const rb_data_type_t binding_data_type = {
-  "binding",
-  binding_mark,
-  binding_free,
-  binding_memsize,
-};
-
-static VALUE
-binding_alloc(VALUE klass)
-{
-  VALUE obj;
-  rb_binding_t *bind;
-  obj = TypedData_Make_Struct(klass, rb_binding_t, &binding_data_type, bind);
-  return obj;
-}
-
-static bool ifunc_p(rb_control_frame_t * cfp) {
-  return (cfp->flag & VM_FRAME_MAGIC_MASK) == VM_FRAME_MAGIC_IFUNC;
-}
-
-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);
-}
-
-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 (cfp >= limit_cfp)
-      return NULL;
-
-    if (valid_frame_p(cfp, limit_cfp))
-      return cfp;
-  }
-
-  // beyond end of stack
-  return NULL;
-}
-
-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;
-  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);
-
-  // attempt to locate the nth parent control frame
-  for (int i = 0; i < level; i++) {
-    cfp = RUBY_VM_PREVIOUS_CONTROL_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)
-    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()
-{
-  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,33 +0,0 @@
-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"
-
-  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
-
-  create_makefile('binding_of_caller')
-end
-

data/ext/binding_of_caller/ruby_headers/192/debug.h

@@ -1,36 +0,0 @@
-/**********************************************************************
-
-  debug.h - YARV Debug function interface
-
-  $Author$
-  created at: 04/08/25 02:33:49 JST
-
-  Copyright (C) 2004-2007 Koichi Sasada
-
-**********************************************************************/
-
-#ifndef RUBY_DEBUG_H
-#define RUBY_DEBUG_H
-
-#include "ruby/ruby.h"
-#include "node.h"
-
-#define dpv(h,v) ruby_debug_print_value(-1, 0, h, v)
-#define dp(v)    ruby_debug_print_value(-1, 0, "", v)
-#define dpi(i)   ruby_debug_print_id(-1, 0, "", i)
-#define dpn(n)   ruby_debug_print_node(-1, 0, "", n)
-
-#define bp()     ruby_debug_breakpoint()
-
-VALUE ruby_debug_print_value(int level, int debug_level, const char *header, VALUE v);
-ID    ruby_debug_print_id(int level, int debug_level, const char *header, ID id);
-NODE *ruby_debug_print_node(int level, int debug_level, const char *header, const NODE *node);
-int   ruby_debug_print_indent(int level, int debug_level, int indent_level);
-void  ruby_debug_breakpoint(void);
-void  ruby_debug_gc_check_func(void);
-
-#ifdef RUBY_DEBUG_ENV
-void ruby_set_debug_option(const char *str);
-#endif
-
-#endif /* RUBY_DEBUG_H */

data/ext/binding_of_caller/ruby_headers/192/dln.h

@@ -1,41 +0,0 @@
-/**********************************************************************
-
-  dln.h -
-
-  $Author$
-  created at: Wed Jan 19 16:53:09 JST 1994
-
-  Copyright (C) 1993-2007 Yukihiro Matsumoto
-
-**********************************************************************/
-
-#ifndef DLN_H
-#define DLN_H
-
-#ifdef __cplusplus
-# ifndef  HAVE_PROTOTYPES
-#  define HAVE_PROTOTYPES 1
-# endif
-# ifndef  HAVE_STDARG_PROTOTYPES
-#  define HAVE_STDARG_PROTOTYPES 1
-# endif
-#endif
-
-#undef _
-#ifdef HAVE_PROTOTYPES
-# define _(args) args
-#else
-# define _(args) ()
-#endif
-
-DEPRECATED(char *dln_find_exe(const char*,const char*));
-DEPRECATED(char *dln_find_file(const char*,const char*));
-char *dln_find_exe_r(const char*,const char*,char*,size_t);
-char *dln_find_file_r(const char*,const char*,char*,size_t);
-
-#ifdef USE_DLN_A_OUT
-extern char *dln_argv0;
-#endif
-
-void *dln_load(const char*);
-#endif