binding_of_caller 0.2.0 → 0.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3fb3c7ee20b9b9ca1237d0540c2768efc657111
+  data.tar.gz: be4845aeca79432000b44be789993c23c1955715
+SHA512:
+  metadata.gz: 3fd5d2a9ffbda43fcc2d8afa739ec51052f5dacc8632c3e88b60b7be90c2bd67c8a813156dab341e9f3399e46db667f3a1246043d50f1f60b6654d5c07e4e93c
+  data.tar.gz: 13fe3b6ab87052403c99be357fb91ea3ed2c9e9e5a8bafadc3123293bbb0a47bd7a235c67f7d25adb020f07bef0dee6d5a00424c7f59bf4c8b59dfc1f691d5c8

data/.gitignore

@@ -0,0 +1,8 @@
+Makefile
+*.so
+*.o
+*.def
+doc/
+pkg/
+.yardoc/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,23 @@
+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/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+License
+-------
+
+(The MIT License) 
+
+Copyright (c) 2011 John Mair (banisterfiend)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,27 +1,59 @@
+[![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
+(C) John Mair (banisterfiend) 2012
+
+_Retrieve the binding of a method's caller in MRI 1.9.2+, MRI 2.0 and RBX (Rubinius)_
+
+The `binding_of_caller` gem provides the `Binding#of_caller` method.
 
-FIXME: _tagline_
+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.
 
-FIXME: _description goes here_
+**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)**
 
 * Install the [gem](https://rubygems.org/gems/binding_of_caller): `gem install binding_of_caller`
-* Read the [documentation](http://rdoc.info/github/banister/binding_of_caller/master/file/README.markdown)
 * See the [source code](http://github.com/banister/binding_of_caller)
 
-Example: Example description
+Example: Modifying a local inside the caller of a caller
 --------
 
-Example preamble
+```ruby
+def a
+  var = 10
+  b
+  puts var
+end
+
+def b
+  c
+end
+
+def c
+  binding.of_caller(2).eval('var = :hello')
+end
+
+a()
+
+# OUTPUT
+# => hello
+```
+
+Spinoff project
+-------
 
-    puts "example code"
+This project is a spinoff from the [Pry REPL project.](http://pry.github.com)
 
 Features and limitations
 -------------------------
 
-Feature List Preamble
+* Only works with MRI 1.9.2, 1.9.3, 2.0 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
 -------
@@ -32,9 +64,9 @@ Problems or questions contact me at [github](http://github.com/banister)
 License
 -------
 
-(The MIT License) 
+(The MIT License)
 
-Copyright (c) 2011 (John Mair)
+Copyright (c) 2012 (John Mair)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,99 +1,134 @@
-dlext = Config::CONFIG['DLEXT']
-direc = File.dirname(__FILE__)
-
-PROJECT_NAME = "binding_of_caller"
-
-require 'rake/clean'
-require 'rake/gempackagetask'
-require "#{direc}/lib/#{PROJECT_NAME}/version"
-
-CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
-CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
-              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
-              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
-
-def apply_spec_defaults(s)
-  s.name = PROJECT_NAME
-  s.summary = "FIX ME"
-  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_development_dependency("bacon",">=1.1.0")
-  s.homepage = "http://banisterfiend.wordpress.com"
-  s.has_rdoc = 'yard'
-  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
-                     "test/*.rb", "HISTORY", "README.md", "Rakefile"]
-end
-
-desc "run tests"
-task :test do
-  sh "bacon -k #{direc}/test/test.rb"
-end
-
-[:mingw32, :mswin32].each do |v|
-  namespace v do
-    spec = Gem::Specification.new do |s|
-      apply_spec_defaults(s)        
-      s.platform = "i386-#{v}"
-      s.files += FileList["lib/**/*.#{dlext}"].to_a
-    end
-
-    Rake::GemPackageTask.new(spec) do |pkg|
-      pkg.need_zip = false
-      pkg.need_tar = false
-    end
-  end
-end
-
-namespace :ruby do
-  spec = Gem::Specification.new do |s|
-    apply_spec_defaults(s)        
-    s.platform = Gem::Platform::RUBY
-    s.extensions = ["ext/#{PROJECT_NAME}/extconf.rb"]
-  end
-  
-  Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = false
-    pkg.need_tar = false
-  end
-end
-
-directories = ["#{direc}/lib/1.8", "#{direc}/lib/1.9"]
-directories.each { |d| directory d }
-
-desc "build the 1.8 and 1.9 binaries from source and copy to lib/"
-task :compile => directories do
-  build_for = proc do |pik_ver, ver|
-    sh %{ \
-          c:\\devkit\\devkitvars.bat && \
-          pik #{pik_ver} && \
-          ruby extconf.rb && \
-          make clean && \
-          make && \
-          cp *.so #{direc}/lib/#{ver} \
-        }
-  end
-  
-  chdir("#{direc}/ext/#{PROJECT_NAME}") do
-    build_for.call("187", "1.8")
-    build_for.call("192", "1.9")
-  end
-end
-
-desc "build all platform gems at once"
-task :gems => [:clean, :rmgems, "mingw32:gem", "mswin32:gem", "ruby:gem"]
-
-desc "remove all platform gems"
-task :rmgems => ["ruby:clobber_package"]
-
-desc "build and push latest gems"
-task :pushgems => :gems do
-  chdir("#{direc}/pkg") do
-    Dir["*.gem"].each do |gemfile|
-      sh "gem push #{gemfile}"
-    end
-  end
-end
+dlext = RbConfig::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+$:.unshift 'lib'
+
+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

data/binding_of_caller.gemspec

@@ -0,0 +1,37 @@
+# -*- 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"])
+  end
+end

data/examples/example.rb

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