mixit 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+*.rbc

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.8.7 
+  - 1.9.2
+  - 1.9.3
+  - rbx-2.0
+  - jruby
+  - ruby-head
+  - ree
+
+notifications:
+  irc: "irc.freenode.org#flowof.info"
+  recipients:
+    - rob@flowof.info

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in inject.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+| Project         | Mixit   
+|:----------------|:--------------------------------------------------
+| Homepage        | https://github.com/robgleeson/Mixit
+| Documentation   | http://rubydoc.info/gems/Mixit/frames 
+| Author          | Rob Gleeson             
+
+
+__DESCRIPTION__
+
+  Mixit can be used to temporarily extend the calling scope of a block or object with instance methods from a module.   
+  It is written to help Domain Specific Language(DSL) writers provide a DSL with their own methods 
+  without losing the calling scope of the caller.
+
+__WHY?__
+
+  Some Ruby DSL approaches already exist(maybe one suits you):
+
+  * `instance_eval`  
+    The calling scope is lost, and internal state is exposed to the user of the DSL.
+
+  * `instance_eval` via "EmptyContext"  
+    The calling scope is lost, but the object is void of any state.
+
+  * Pass `self` onto the calling block.  
+    The cleanest approach but some of the beauty of the DSL can be lost.
+
+  All these approaches(but the last) lose the calling scope, and that's why I created 'Mixit'.  
+  I wanted the user of the DSL to have access to the calling scope, but have access to my DSL as
+  implicit receivers of 'self' as well.
+
+  This approach is by no means 'perfect', or even 'good'.   
+  If you use it wisely, though, it can be a cool way to build nice DSLs.
+
+
+
+__EXAMPLES__
+
+Mix 'Foo' onto the 'self' referenced by _block_:
+
+    module Foo 
+      def bar
+      end 
+    end
+
+    def DSL(&block)
+      Mixit.mix(Foo, block)
+    end
+
+    DSL do 
+      p respond_to?(:bar) # => true
+    end
+
+    p respond_to?(:bar) # => false
+
+__INSTALL__
+
+  gem install mixit
+
+__LICENSE__
+
+  
+  See LICENSE.txt
+
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.name       = :test
+  t.test_files = FileList["test/setup.rb", "test/*.rb"]
+end
+
+task :default => :test

data/lib/mixit/core_ext/object.rb

@@ -0,0 +1,3 @@
+def Mix *args, &block
+  Mixit.mix(*args, &block)
+end

data/lib/mixit/version.rb

@@ -0,0 +1,3 @@
+class Mixit 
+  VERSION = '0.1.0'
+end

data/lib/mixit.rb

@@ -0,0 +1,60 @@
+require "mixit/core_ext/object"
+require "mixit/version"
+
+class Mixit
+
+  class << self
+
+    def mix(*args, &block)
+      case args.last
+      when Proc
+        scope    = args.pop
+        receiver = scope.binding.eval("self")
+        modules  = args
+      else
+        receiver = args.pop
+        modules  = args
+      end
+                
+      new(modules).mix_onto(receiver, &block)
+    end
+  end
+
+  def initialize(modules)
+    @modules = modules.map(&:clone)
+  end
+
+  def mix_onto(receiver, &block)
+    if block.arity == 1
+      block.call extend!(receiver, true)
+    else
+      ivars = receiver.instance_variables
+      extend!(receiver, false).instance_eval(&block)
+
+      # Remove instance variables added by @modules, or &block from 'receiver'.
+      # We want to restore the calling scope to its previous state.
+      (receiver.instance_variables - ivars).each do |ivar|
+        receiver.send(:remove_instance_variable, ivar)
+      end
+
+      # Remove methods added by @modules from 'receiver'.
+      # We want to restore the calling scope to its previous state.
+      @modules.each do |mod|
+        mod.instance_methods(false).each do |meth|
+          mod.send(:remove_method, meth)
+        end
+      end
+    end
+  end
+
+  def extend!(receiver, to_be_cloned=false)
+    if to_be_cloned
+      receiver = receiver.clone
+    end
+
+    @modules.inject(receiver) { |obj, mod| obj.extend(mod) }
+  end
+  private :extend!
+
+end
+

data/mixit.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mixit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mixit"
+  s.version     = Mixit::VERSION
+  s.authors     = ["Rob Gleeson"]
+  s.email       = ["rob@flowof.info"]
+  s.homepage    = ""
+  s.summary     = %q{Temporarily extend the calling scope of a block with instance methods from a module.}
+  s.description = s.summary
+
+  s.rubyforge_project = "mixit"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"     , "~> 0.9.2"
+  s.add_development_dependency "minitest" , "~> 2.5"
+end

data/test/setup.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'mixit'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+alias :context :describe

data/test/test_mixit.rb

@@ -0,0 +1,109 @@
+context Mixit do
+  
+  context 'mix' do
+    context 'When receiving a block.' do 
+      before do
+        @module = Module.new do
+          def callme
+            :ok
+          end
+
+          def i
+            @i = 'asdf'
+          end
+        end
+      end
+
+      context 'When extending the calling scope of a Proc.' do
+        context 'Without cloning the receiver.' do
+          it 'must provide access to mixed in module methoss' do        
+            block = proc { }
+
+            Mixit.mix(@module, block) do 
+              callme.must_equal(:ok)
+            end
+          end
+
+          it 'must provide access to surrounding locals.' do
+            block = proc { }
+            local = :ok
+          
+            Mixit.mix(@module, block) do 
+              local.must_equal(:ok)
+            end
+          end
+
+          it 'must provide access to surrounding methods.' do
+            def callme_() :ok end
+            block = proc { }
+
+            Mixit.mix(@module, block) do
+              callme_.must_equal(:ok)
+            end
+          end
+
+          it 'must remove instance variables added by the passed block.' do
+            block = proc { }
+
+            Mixit.mix(@module, block) do 
+              @ok = :no
+            end
+
+            instance_variable_defined?(:@ok).must_equal(false)
+          end
+
+          it 'must remove instance variables added by the mixed in modules.' do 
+            block = proc { }
+
+            Mixit.mix(@module, block) do
+              i
+              instance_variable_defined?(:@i).must_equal(true)
+            end
+
+            instance_variable_defined?(:@i).must_equal(false)
+          end
+
+          it 'must not remove instance variables set before the scope is extended.' do
+            block = proc {}
+            @ok   = :ok
+
+            Mixit.mix(@module, block) do
+              nil
+            end
+            
+            instance_variable_defined?(:@ok).must_equal(true)
+          end
+
+          it 'must remove methods added by mixed in modules.' do
+            block = proc {}
+            
+            Mixit.mix(@module, block) do
+              nil
+            end
+
+            respond_to?(:callme).must_equal(false)
+          end
+        end
+      end
+
+      context 'With the receiver cloned.' do
+        it 'must provide access to mixed in module methods.' do
+          block = proc {}
+
+          Mixit.mix(@module, block) do |receiver|
+            receiver.callme.must_equal(:ok)
+          end
+        end
+
+        it 'must not extending the original receiver with mixed in module methods.' do
+          block = proc {}
+
+          Mixit.mix(@module, block) do |receiver|
+            respond_to?(:callme).must_equal(false) 
+          end
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: mixit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rob Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70294493576860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70294493576860
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70294493576360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70294493576360
+description: Temporarily extend the calling scope of a block with instance methods
+  from a module.
+email:
+- rob@flowof.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/mixit.rb
+- lib/mixit/core_ext/object.rb
+- lib/mixit/version.rb
+- mixit.gemspec
+- test/setup.rb
+- test/test_mixit.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4457976507324133179
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4457976507324133179
+requirements: []
+rubyforge_project: mixit
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Temporarily extend the calling scope of a block with instance methods from
+  a module.
+test_files:
+- test/setup.rb
+- test/test_mixit.rb