boc 0.3.2

data/CHANGES.rdoc

@@ -0,0 +1,16 @@
+
+= boc Changes
+
+== Version 0.3.2
+
+* "rake test" now works without rake-compiler on Windows
+* additions to readme
+
+== Version 0.3.1
+
+* add prototype for rb_funcall_passing block
+  (http://redmine.ruby-lang.org/issues/4504)
+
+== Version 0.3.0
+
+* birthday

data/MANIFEST

@@ -0,0 +1,14 @@
+CHANGES.rdoc
+MANIFEST
+README.rdoc
+Rakefile
+devel/levitate.rb
+ext/boc/boc.c
+ext/boc/extconf.rb
+lib/boc.rb
+lib/boc/binding_of_caller.rb
+lib/boc/version.rb
+test/basic_test.rb
+test/main.rb
+test/readme_test.rb
+test/shim_test.rb

data/README.rdoc

@@ -0,0 +1,119 @@
+
+= boc
+
+== Summary
+
+Binding of caller.
+
+== Synopsis
+
+  require 'boc'
+
+  class A
+    def f
+      p eval("x", Boc.value)
+    end
+  end
+
+  Boc.enable A, :f
+  x = 33
+  A.new.f  # => 33
+
+== Install
+
+  % gem install boc
+
+Or from inside an unpacked .tgz download, <code>rake install</code> /
+<code>rake uninstall</code>.
+
+== Description
+
+Binding of caller: obtain a caller's binding.
+
+MRI 1.9.2 is required. Support for other Ruby platforms is a goal.
+
+== <code>Binding.of_caller</code>
+
+<code>require 'boc/binding_of_caller'</code> will define
+<code>Binding.of_caller</code> (not present by default).
+
+  require 'boc/binding_of_caller'
+
+  class A
+    def f
+      Binding.of_caller do |bind|
+        p eval("x", bind)
+      end
+    end
+  end
+
+  Boc.enable A, :f
+  x = 33
+  A.new.f  # => 33
+
+This is not an actual compatibility layer since the call to +enable+
+is still necessary. <code>Binding.of_caller</code> is merely a
+convenience method for existing 1.8 code.
+
+== Links
+
+* Home: http://quix.github.com/boc
+* Feature Requests, Bug Reports: http://github.com/quix/boc/issues
+* Manual Download: http://github.com/quix/boc/archives/master
+* Repository: http://github.com/quix/boc
+
+== Implementation
+
+<code>Boc.enable(A, :f)</code> is essentially
+
+  class A
+    alias_method :f__impl, :f
+  end
+
+followed by a redefinition of +f+. The new +f+ is a native method
+which sets <code>Boc.value</code> and then forwards the incoming
+arguments to +f__impl+.
+
+== Background
+
+After adapting the old continuation-based
+<code>Binding.of_caller</code> to 1.9.2
+(http://quix.github.com/binding_of_caller), I found the result
+unsatisfying. There were syntax restrictions surrounding the use of
+it, and though workaroundable they raised practical problems.
+
+While a caller's binding might be obtained by accessesing VM innards,
+this approach would be subject to future breakage. The implementation
+presented herein is a compromise. In exchange for restricting
+functionality (the additional requirement of +enable+),
+binding-of-caller may be implemented straightforwardly with only the
+public C API, meaning that it should work in future MRI releases.
+
+== Author
+
+* James M. Lawrence < quixoticsycophant@gmail.com >
+
+== License
+  
+  Copyright (c) 2011 James M. Lawrence. All rights reserved.
+  
+  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/Rakefile

@@ -0,0 +1,13 @@
+require_relative 'devel/levitate'
+
+Levitate.new "boc" do |s|
+  s.developers << ["James M. Lawrence", "quixoticsycophant@gmail.com"]
+  s.username = "quix"
+  s.required_ruby_version = ">= 1.9.2"
+  s.development_dependencies << ["rake-compiler", "~> 0.7.6"]
+
+  s.rdoc_files = %w[
+    lib/boc.rb
+    lib/boc/version.rb
+  ]
+end