mixit 0.3.0 → 0.4.0

data/README.md

@@ -37,21 +37,15 @@ __WHY?__
 
 __EXAMPLES__
 
-Temporarily mix 'Foo' onto the 'self' referenced by _block_:
+Temporarily mix 'SomeModule' onto the 'self' referenced by _block_:
 
-    module Foo
-      def bar() end
+    Mixit.temporarily SomeModule, :scope => self do 
+      p self.class  # => Object
+      p respond_to?(:some_mixed_method) # => true  
     end
 
-    block = proc { }
-
-    Mixit.temporarily(Foo, block) do 
-      p self.class        # => Object
-      p respond_to?(:bar) # => true  
-    end
-
-    p self.class        # => Object
-    p respond_to?(:bar) # => false
+    p self.class # => Object
+    p respond_to?(:some_mixed_method) # => false
 
 __INSTALL__
 

data/lib/mixit/version.rb

@@ -1,3 +1,3 @@
 class Mixit 
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/mixit.rb

@@ -5,60 +5,78 @@ class Mixit
 
   class << self
     # 
-    # @overload mix(*modules, receiver, &block) 
-    #   Temporarily extends the __receiver__ with methods from __modules__.
+    # @overload mix(*modules, options, &block) 
+    #   Temporarily extends a scope with methods from __modules__.
     #
     #   @param [Module] modules
-    #     A variable number of modules to extend the receiver with.
+    #     A variable number of modules to extend the scope with.
     #
-    #   @param receiver 
-    #     (see Mixit#mix_onto) 
+    #   @param [Hash] options 
     #   
+    #   @option options [Binding, Proc, Object] :scope 
+    #     The scope to extend.
+    #
     #   @param block 
-    #     (see Mixit#mix_onto)
+    #     (see Mixit#mix!)
     #   
     #   @yieldparam object 
-    #     (see Mixit#mix_onto)
+    #     (see Mixit#mix!)
+    #
+    #   @raise [ArgumentError] 
+    #     If the :scope option is missing.
     #
     #   @return [void]
     #     
     def mix(*args, &block)
-      case args.last
-      when Proc
-        scope    = args.pop
-        receiver = scope.binding.eval("self")
-        modules  = args
+      options = args.pop
+      modules = args
+
+      if options.has_key?(:scope)
+        scope = options[:scope]
       else
-        receiver = args.pop
-        modules  = args
+        raise ArgumentError, 'missing :scope option.'
       end
-                
-      new(modules).mix_onto(receiver, &block)
+
+      new(scope, modules).mix!(&block)
     end
     alias_method :temporarily, :mix
   end
 
-
   #
   # @return [Array<Module>] 
   #   An Array of Module objects.
   #
   attr_reader :modules
-  
+ 
+  #
+  # @return [Object]
+  #   The scope.
+  #
+  attr_reader :scope
+
+  #
+  # @param [Binding, Proc, Object] scope
+  #   A scope to extend.
   #
   # @param [Array<Module>] modules
   #   An Array of Module objects.
   #
-  def initialize(modules)
+  def initialize scope, modules
     @modules = modules
     @clones  = []
+
+    case scope
+    when Binding
+      @scope = scope.eval "self"
+    when Proc
+      @scope = scope.binding.eval "self"
+    else
+      @scope = scope
+    end
   end
 
   #
-  # Temporarily extends __receiver__ with methods from {#modules modules}. 
-  #
-  # @param [Object] receiver 
-  #   An object to temporarily extend.
+  # Temporarily extends {#scope} with methods from {#modules modules}. 
   #
   # @param [Proc] block
   #   A block executed while the object is extended. 
@@ -68,48 +86,67 @@ class Mixit
   #
   # @return [void]
   #
-  def mix_onto(receiver, &block)
+  def mix! &block
     if block.arity == 1
-      block.call extend!(receiver, true)
+      block.call extend!(true)
     else
       begin
-        ivars = receiver.instance_variables
-        extend!(receiver, false).instance_eval(&block)
+        extend!(false).instance_eval(&block)
       ensure
-        (receiver.instance_variables - ivars).each do |ivar|
-          receiver.send(:remove_instance_variable, ivar)
-        end
-
-        @clones.each do |mod|
-          mod.instance_methods(false).each do |meth|
-            mod.send(:remove_method, meth)
-          end
-        end
+        remove_methods!
+        trigger_callback!
       end
     end
   end
 
   #
-  # Extends __receiver__ with the methods from {#modules modules}.
-  #
-  # @param receiver 
-  #   (see Mixit#mix_onto)
+  # Extends {#scope} with the methods from {#modules modules}.
   #
   # @param [Boolean] to_be_cloned
-  #   If true, a clone of the receiver is extended.
+  #   If true, a clone of the scope is extended.
   #
   # @return [Object]
   #   Returns the extended object.
   #
-  def extend!(receiver, to_be_cloned=false)
-    if to_be_cloned
-      receiver = receiver.clone
+  def extend! clone_scope 
+    if clone_scope
+      scope = @scope.clone
+    else
+      scope = @scope
     end
 
     @clones = @modules.map(&:clone)
-    @clones.inject(receiver) { |obj, mod| obj.extend(mod) }
+    @clones.inject(scope) { |obj, mod| obj.extend(mod) }
   end
   private :extend!
 
+  #
+  # Remove methods used to extend {#scope} from module(s).  
+  #
+  # @return [void]
+  #
+  def remove_methods!
+    @clones.each do |clone|
+      clone.instance_methods(false).each do |meth|
+        clone.send(:remove_method, meth)
+      end
+    end
+  end
+  private :remove_methods!
+
+  #
+  # Calls cleanup! on module(s) used to extend a scope.
+  #
+  # @return [void]
+  #
+  def trigger_callback!
+    @clones.each do |clone|
+      if clone.respond_to?(:cleanup!)
+        clone.cleanup!(@scope)  
+      end
+    end
+  end
+  private :trigger_callback!
+
 end
 

data/test/test_mixit.rb

@@ -6,10 +6,6 @@ context Mixit do
         def callme
           :ok
         end
-
-        def set_ivar
-          @set_ivar = 'asdf'
-        end
       end
     end
 
@@ -17,7 +13,7 @@ context Mixit do
       it 'must provide access to mixed-in methods' do        
         block = proc { }
 
-        Mixit.mix(@module, block) do 
+        Mixit.mix(@module, :scope => block) do 
           callme.must_equal(:ok)
         end
       end
@@ -26,7 +22,7 @@ context Mixit do
         block = proc { }
         local = :ok
       
-        Mixit.mix(@module, block) do 
+        Mixit.mix(@module, :scope => block) do 
           local.must_equal(:ok)
         end
       end
@@ -35,7 +31,7 @@ context Mixit do
         def callme_() :ok end
         block = proc { }
 
-        Mixit.mix(@module, block) do
+        Mixit.mix(@module, :scope => block) do
           callme_.must_equal(:ok)
         end
       end
@@ -43,39 +39,23 @@ context Mixit do
       it 'must remove instance variables added by the calling block.' do
         block = proc { }
 
-        Mixit.mix(@module, block) do 
-          @ok = :no
+        @module.instance_eval do
+          def cleanup!(scope)
+            scope.send(:remove_instance_variable, :@ok)
+          end
         end
 
-        instance_variable_defined?(:@ok).must_equal(false)
-      end
-
-      it 'must remove instance variables added by mixed-in modules.' do 
-        block = proc { }
-
-        Mixit.mix(@module, block) do
-          set_ivar
-          instance_variable_defined?(:@set_ivar).must_equal(true)
+        Mixit.mix(@module, :scope => block) do 
+          @ok = :no
         end
 
-        instance_variable_defined?(:@set_ivar).must_equal(false)
-      end
-
-      it 'must not remove pre-existing instance variables.' do
-        block = proc {}
-        @ok   = :ok
-
-        Mixit.mix(@module, block) do
-          nil
-        end
-        
-        instance_variable_defined?(:@ok).must_equal(true)
+        instance_variable_defined?(:@ok).must_equal(false)
       end
 
-      it 'must remove methods added by mixed-in modules.' do
+     it 'must remove methods added by mixed-in modules.' do
         block = proc {}
         
-        Mixit.mix(@module, block) do
+        Mixit.mix(@module, :scope => block) do
           nil
         end
 
@@ -87,7 +67,7 @@ context Mixit do
       it 'must provide access to mixed-in methods.' do
         block = proc {}
 
-        Mixit.mix(@module, block) do |receiver|
+        Mixit.mix(@module, :scope => block) do |receiver|
           receiver.callme.must_equal(:ok)
         end
       end
@@ -95,7 +75,7 @@ context Mixit do
       it 'must not extend the original receiver with mixed-in methods.' do
         block = proc {}
 
-        Mixit.mix(@module, block) do |receiver|
+        Mixit.mix(@module, :scope => block) do |receiver|
           respond_to?(:callme).must_equal(false) 
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-21 00:00:00.000000000 Z
+date: 2011-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70339179578900 !ruby/object:Gem::Requirement
+  requirement: &70097654179640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70339179578900
+  version_requirements: *70097654179640
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70339179578400 !ruby/object:Gem::Requirement
+  requirement: &70097654179140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *70339179578400
+  version_requirements: *70097654179140
 description: Temporarily extend the calling scope of a block with instance methods
   from a module.
 email:
@@ -68,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2621427566551580532
+      hash: -1392924086282936836
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2621427566551580532
+      hash: -1392924086282936836
 requirements: []
 rubyforge_project: mixit
 rubygems_version: 1.8.11