local_eval 0.2.0

data/README.markdown

@@ -0,0 +1,78 @@
+LocalEval
+=============
+
+(C) John Mair (banisterfiend) 2010
+
+_instance\_eval without changing self_
+
+Using `local_eval` you get most of the benefits of `instance_eval`
+with very few of the drawbacks: local instance variables are
+accessible within the block and method lookups are directed to the
+correct receiver. Unlike `instance_eval` the `self` of the
+block is not changed.
+
+LocalEval provides the `local_eval` and `local_eval_with` methods.
+
+* Install the [gem](https://rubygems.org/gems/local_eval): `gem install local_eval`
+* Read the [documentation](http://rdoc.info/github/banister/local_eval/master/file/README.markdown)
+* See the [source code](http://github.com/banister/local_eval)
+
+example: local_eval
+--------------------------
+
+Using `local_eval` we can add the functionality of the receiver to the
+block:
+
+
+    class C
+      def hello(name)
+        "hello #{name}!"
+      end
+    end
+
+    o = C.new
+
+    @name = "John"
+    o.local_eval { hello(@name) } #=> "hello John!"
+    
+example: capture
+--------------------
+
+`gen_extend` lets us mix objects into objects:
+
+    o = Object.new
+    class << o
+      def bye
+        :bye
+      end
+    end
+
+    n = Object.new
+    n.gen_extend o
+    n.bye #=> :bye
+    
+How it works
+--------------
+
+Object2module simply removes the check for `T_MODULE` from `rb_include_module()`
+
+Companion Libraries
+--------------------
+
+Remix is one of a series of experimental libraries that mess with
+the internals of Ruby to bring new and interesting functionality to
+the language, see also:
+
+* [Remix](http://github.com/banister/remix) - Makes ancestor chains read/write
+* [Include Complete](http://github.com/banister/include_complete) - Brings in
+  module singleton classes during an include. No more ugly ClassMethods and included() hook hacks.
+* [Prepend](http://github.com/banister/prepend) - Prepends modules in front of a class; so method lookup starts with the module
+* [GenEval](http://github.com/banister/gen_eval) - A strange new breed of instance_eval
+
+Contact
+-------
+
+Problems or questions contact me at [github](http://github.com/banister)
+
+
+

data/Rakefile

@@ -0,0 +1,58 @@
+dlext = Config::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+require "#{direc}/lib/local_eval/version"
+
+CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
+CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "ext/**/*.def", "ext/**/*.pdb")
+
+def apply_spec_defaults(s)
+  s.name = "local_eval"
+  s.summary = "instance_eval without changing self"
+  s.version = LocalEval::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("remix",">=0.4.8")
+  s.add_dependency("object2module",">=0.4.3")
+  s.homepage = "http://banisterfiend.wordpress.com"
+  s.has_rdoc = 'yard'
+  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
+                     "test/*.rb", "CHANGELOG", "README.markdown", "Rakefile"]
+end
+
+task :test do
+  sh "bacon -k #{direc}/test/test.rb"
+end
+
+namespace :ruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)        
+    s.platform = Gem::Platform::RUBY
+  end
+  
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+
+desc "build all platform gems at once"
+task :gems => [:rmgems, "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

data/lib/local_eval/version.rb

@@ -0,0 +1,3 @@
+module LocalEval
+  VERSION = "0.2.0"
+end

data/lib/local_eval/version_flymake.rb

@@ -0,0 +1,3 @@
+module LocalEval
+  VERSION = "0.2.0"
+end

data/lib/local_eval.rb

@@ -0,0 +1,71 @@
+direc = File.dirname(__FILE__)
+
+require "#{direc}/local_eval/version"
+require 'remix'
+require 'object2module'
+
+module LocalEval
+
+  # Thread-local name for the hidden self used by `capture`
+  # @return [String] The name of the hidden self used by `capture`
+  def self.context_self_name
+    "@__self__#{Thread.current.object_id}"
+  end
+
+  module ClassExtensions
+    
+    # Find the instance associated with the singleton class
+    # @return [Object] Instance associated with the singleton class
+    def __attached__
+      ObjectSpace.each_object(self).first
+    end
+  end
+  
+  module ObjectExtensions
+
+    def local_eval(*objs, &block)
+      objs = Array(self) if objs.empty?
+      context = eval('self', block.binding)
+
+      # if the receiver is the same as the block context then don't
+      # mix in anything, as functionality is already present.
+      if objs.include?(context)
+        objs.delete(context)
+        return yield if objs.empty?
+      end
+
+      # add functionality to anonymous module to ease mixing and unmixing
+      functionality = Module.new.gen_include *objs.map { |o| o.is_a?(Module) ? o.singleton_class : o }
+      
+      # mix the anonymous module into the block context
+      context.temp_extend functionality, &block
+    end
+    alias_method :local_eval_with, :local_eval
+
+    # This form is meant to be called without a receiver
+    private :local_eval_with
+
+    def capture(&block)
+      
+      # 1. Get name of enclosing method (method that invoked
+      # `capture ` block)
+      # 2. Find owner of enclosing method (owner is guaranteed to be
+      # a singleton class)
+      # 4. Find associated object (attached object) of the singleton class
+      # 5. This object will be the receiver of the method call, so
+      # instance_eval on it.
+      method_name = eval('__method__', block.binding)
+      method_owner = method(method_name).owner
+      attached_object = method_owner.__attached__
+      attached_object.instance_eval &block
+    end
+  end
+end
+
+class Class
+  include LocalEval::ClassExtensions
+end
+
+class Object
+  include LocalEval::ObjectExtensions
+end

data/test/helper1.rb

@@ -0,0 +1,73 @@
+class Module
+  public :remove_const, :include, :remove_method
+end
+
+Reset = proc do 
+  O = Object.new
+  O2 = Object.new
+
+  class A
+    def self.a
+      :a
+    end
+  end
+
+  class B
+    def self.b
+      :b
+    end
+  end
+
+  class << O
+    def hello
+      :o
+    end
+
+    def ivar_set(var, val)
+      instance_variable_set(var, val)
+    end
+
+    def receiver_ivar_set
+      capture {
+        @receiver_ivar = :receiver
+      }
+    end
+    
+  end
+
+  class << O2
+    def receiver_ivar_set2
+      capture {
+        @receiver_ivar2 = :receiver2
+      }
+    end
+  end
+
+  class C
+    def self.build_proc
+      proc { love }
+    end
+    
+    def self.hello
+      :c
+    end
+
+    def self.c
+      :c
+    end
+
+    def self.ivar(v)
+      v
+    end
+  end
+
+  module M
+    def self.hello
+      :m
+    end
+
+    def m
+      :m
+    end
+  end
+end

data/test/test.rb

@@ -0,0 +1,142 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/local_eval"
+require "#{direc}/helper1"
+
+puts "Testing LocalEval version #{LocalEval::VERSION}..."
+puts "With Remix version #{Remix::VERSION} and Object2module version #{Object2module::VERSION}"
+puts "Ruby version #{RUBY_VERSION}"
+
+describe LocalEval do
+  before do
+    Reset.call
+  end
+
+  after do
+    [:A, :B, :C, :M, :O, :O2].each do |c|
+      Object.remove_const(c)
+    end
+  end
+  
+  describe 'mixing in an object' do
+    it 'should mix in and mixout the object and make functionality available to block' do
+      lambda { hello }.should.raise NameError
+      O.local_eval { hello }.should == :o
+      lambda { hello }.should.raise NameError
+    end
+
+    it 'should not error when receiver is the same as block context' do
+      lambda { local_eval { :hello } }.should.not.raise ArgumentError
+      local_eval { :hello }.should == :hello
+    end
+
+    it 'should mix implicit self into context of block' do
+      def self.love; :love; end
+      local_eval(&C.build_proc).should == :love
+      self.singleton_class.remove_method(:love)
+    end
+  end
+
+  describe 'local_eval_with' do
+    it 'should mix in multiple objects and make functionality available to the block' do
+      lambda { a }.should.raise NameError
+      lambda { b }.should.raise NameError
+      lambda { local_eval_with(A, B) { a; b; } }.should.not.raise NameError
+      lambda { a }.should.raise NameError
+      lambda { b }.should.raise NameError
+    end
+
+    it 'should not error when mixing in multiple objects that include the context of the block' do
+      lambda { local_eval_with(self, A, B) { a; b } }.should.not.raise NameError
+    end
+  end
+  
+  describe 'mixing in a class' do
+    it 'should mix in and mixout the class' do
+      lambda { hello }.should.raise NameError
+      C.local_eval { c }.should == :c
+      lambda { hello }.should.raise NameError
+    end
+
+    it 'should mixin and mixout a class/module chain' do
+      C.extend M
+      lambda { c }.should.raise NameError
+      lambda { m }.should.raise NameError
+      C.local_eval { c.should == :c; m.should == :m }
+      lambda { c }.should.raise NameError
+      lambda { m }.should.raise NameError
+    end
+  end
+
+  describe 'ivars in the block' do
+    it 'should make ivars accessible to, and modifiable by, block' do
+      O.local_eval { @x = 5 }
+      @x.should == 5
+    end
+
+    it 'should make the method set a local ivar' do
+      instance_variable_defined?(:@v).should == false
+      lambda { ivar_set }.should.raise NameError
+      O.local_eval { ivar_set(:@v, 10) }
+      lambda { ivar_set }.should.raise NameError
+      @v.should == 10
+    end
+      
+    it 'should make local ivars accessible to mixed in methods' do
+      @y = 10
+      lambda { ivar(@y) }.should.raise NameError
+      C.local_eval { ivar(@y) }.should == 10
+      @y.should == 10
+      lambda { ivar(@y) }.should.raise NameError
+    end
+  end
+
+  describe 'capture block' do
+    it 'should make capture evaluate the method in receiver context' do
+      instance_variable_defined?(:@receiver_ivar).should == false
+      lambda { receiver_ivar_set }.should.raise NameError
+      O.local_eval { receiver_ivar_set }
+      instance_variable_defined?(:@receiver_ivar).should == false
+      O.instance_variable_get(:@receiver_ivar).should == :receiver
+    end
+
+    it 'should redirect methods to appropriate receivers' do
+      O.instance_variable_defined?(:@receiver_ivar2).should == false
+      O2.instance_variable_defined?(:@receiver_ivar2).should == false
+      instance_variable_defined?(:@receiver_ivar).should == false
+      instance_variable_defined?(:@receiver_ivar2).should == false
+      lambda { receiver_ivar_set; receiver_ivar_set2 }.should.raise NameError
+      local_eval_with(O, O2) { receiver_ivar_set; receiver_ivar_set2 }
+      instance_variable_defined?(:@receiver_ivar).should == false
+      instance_variable_defined?(:@receiver_ivar2).should == false
+      O.instance_variable_get(:@receiver_ivar).should == :receiver
+      O2.instance_variable_get(:@receiver_ivar2).should == :receiver2
+    end
+
+    it 'should not prevent method lookup on capture-methods on objects that are not involved in the local_eval' do
+      O2.instance_variable_defined?(:@receiver_ivar2).should == false
+      O.local_eval { O2.receiver_ivar_set2.should == :receiver2 }
+      O2.instance_variable_get(:@receiver_ivar2).should == :receiver2
+    end
+
+    it 'should work properly with nested local_evals' do
+      O.local_eval do
+        O2.local_eval { receiver_ivar_set2 }
+        lambda { receiver_ivar_set2 }.should.raise NameError
+        receiver_ivar_set
+      end
+
+      O2.instance_variable_get(:@receiver_ivar2).should == :receiver2
+      O.instance_variable_get(:@receiver_ivar).should == :receiver
+    end
+  end
+  
+  describe 'mixing in a module' do
+    it 'should mix in and mixout the module' do
+      lambda { hello }.should.raise NameError
+      M.local_eval { hello }.should == :m
+      lambda { hello }.should.raise NameError
+    end
+  end  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: local_eval
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- John Mair (banisterfiend)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: remix
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 8
+        version: 0.4.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: object2module
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 3
+        version: 0.4.3
+  type: :runtime
+  version_requirements: *id002
+description: instance_eval without changing self
+email: jrmair@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/local_eval/version.rb
+- lib/local_eval/version_flymake.rb
+- lib/local_eval.rb
+- test/helper1.rb
+- test/test.rb
+- CHANGELOG
+- README.markdown
+- Rakefile
+has_rdoc: yard
+homepage: http://banisterfiend.wordpress.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: instance_eval without changing self
+test_files: []
+