binding_of_caller 0.6.6 → 0.6.7

data/README.md

@@ -1,9 +1,11 @@
+[![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
 
-_Retrieve the binding of a method's caller in MRI 1.9.2+_
+_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.
 
@@ -13,7 +15,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 and 1.9.3**
+**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`
 * See the [source code](http://github.com/banister/binding_of_caller)
@@ -50,7 +52,7 @@ This project is a spinoff from the [Pry REPL project.](http://pry.github.com)
 Features and limitations
 -------------------------
 
-* Only works with MRI 1.9.2 and 1.9.3
+* 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

data/Rakefile

@@ -83,18 +83,6 @@ namespace :ruby do
   end
 end
 
-# namespace :rbx do
-#   spec = Gem::Specification.new do |s|
-#     apply_spec_defaults(s)
-#     s.platform = Gem::Platform::RUBY #.new(["universal", "rubinius"])
-#   end
-
-#   Gem::PackageTask.new(spec) do |pkg|
-#     pkg.need_zip = false
-#     pkg.need_tar = false
-#   end
-# end
-
 desc "build the binaries"
 task :compile do
   chdir "./ext/#{PROJECT_NAME}/" do

data/binding_of_caller.gemspec

@@ -2,18 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = "binding_of_caller"
-  s.version = "0.6.6"
+  s.version = "0.6.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mair (banisterfiend)"]
-  s.date = "2012-03-01"
+  s.date = "2012-03-06"
   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/version.rb", "test/test_binding_of_caller.rb"]
   s.homepage = "http://github.com/banister/binding_of_caller"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.12"
+  s.rubygems_version = "1.8.16"
   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"]
 

data/lib/binding_of_caller.rb

@@ -1,13 +1,15 @@
 dlext = RbConfig::CONFIG['DLEXT']
 direc = File.dirname(__FILE__)
 
-if RUBY_ENGINE && RUBY_ENGINE == "ruby"
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
   require "binding_of_caller.#{dlext}"
 
 elsif defined?(Rubinius)
   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
 
@@ -26,41 +28,38 @@ elsif defined?(Rubinius)
           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 {
+        loop do
           begin
             ary << Binding.of_caller(n)
           rescue
             break
           end
-
           n += 1
-        }
-
-        ary
+        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
-        n = 1
-        loop {
-          begin
-            Binding.of_caller(n)
-          rescue
-            break
-          end
-
-          n += 1
-        }
-
-        n
+        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/

data/lib/binding_of_caller/version.rb

@@ -1,3 +1,3 @@
 module BindingOfCaller
-  VERSION = "0.6.6"
+  VERSION = "0.6.7"
 end

data/test/test_binding_of_caller.rb

@@ -1,91 +1,108 @@
-unless Object.const_defined? :BindingOfCaller
-  $:.unshift File.expand_path '../../lib', __FILE__
-  require 'binding_of_caller'
-  require 'binding_of_caller/version'
-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 "frame_count" do
-    it 'frame_count should equal callers.count' do
-      binding.frame_count.should == binding.callers.count
-    end
-  end
-
-  describe "frame_type" do
-    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
-
-  end
-end
-
+unless Object.const_defined? :BindingOfCaller
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'binding_of_caller'
+  require 'binding_of_caller/version'
+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_type" do
+    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
+
+  end
+end
+

metadata

@@ -1,59 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: binding_of_caller
-version: !ruby/object:Gem::Version 
-  hash: 1509392978297545075
+version: !ruby/object:Gem::Version
+  version: 0.6.7
   prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 6
-  version: 0.6.6
 platform: ruby
-authors: 
+authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bacon
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70355084206460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 2002549777813010636
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70355084206460
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70355084206040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 2002549777813010636
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack.
+  prerelease: false
+  version_requirements: *70355084206040
+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
@@ -120,36 +107,28 @@ files:
 - test/test_binding_of_caller.rb
 homepage: http://github.com/banister/binding_of_caller
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
-summary: Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack.
-test_files: 
+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