blockenspiel 0.0.1

data/tests/tc_basic.rb

@@ -0,0 +1,135 @@
+# -----------------------------------------------------------------------------
+# 
+# Blockenspiel basic tests
+# 
+# This file contains tests for the simple use cases.
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2008 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+
+
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/blockenspiel.rb")
+
+
+module Blockenspiel
+  module Tests  # :nodoc:
+    
+    class TestBasic < Test::Unit::TestCase  # :nodoc:
+      
+      
+      class SimpleTarget < Blockenspiel::Base
+        
+        def initialize
+          @hash = Hash.new
+        end
+        
+        def set_value(key_, value_)
+          @hash[key_] = value_
+        end
+        
+        def set_value_by_block(key_)
+          @hash[key_] = yield
+        end
+       
+        def get_value(key_)
+          @hash[key_]
+        end
+        dsl_method :get_value, false
+        
+      end
+      
+      
+      # Test basic usage with a parameter object.
+      # 
+      # * Asserts that methods are not mixed in to self.
+      # * Asserts that the specified target object does in fact receive the block messages.
+      
+      def test_basic_param
+        block_ = proc do |t_|
+          t_.set_value(:a, 1)
+          t_.set_value_by_block(:b){ 2 }
+          assert(!self.respond_to?(:set_value))
+          assert(!self.respond_to?(:set_value_by_block))
+        end
+        target_ = SimpleTarget.new
+        Blockenspiel.invoke(block_, target_)
+        assert_equal(1, target_.get_value(:a))
+        assert_equal(2, target_.get_value(:b))
+      end
+      
+      
+      # Test basic usage with a mixin.
+      # 
+      # * Asserts that methods are mixed in to self.
+      # * Asserts that methods are removed from self afterward.
+      # * Asserts that the specified target object still receives the messages.
+      
+      def test_basic_mixin
+        block_ = proc do
+          set_value(:a, 1)
+          set_value_by_block(:b){ 2 }
+        end
+        target_ = SimpleTarget.new
+        Blockenspiel.invoke(block_, target_)
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value_by_block))
+        assert_equal(1, target_.get_value(:a))
+        assert_equal(2, target_.get_value(:b))
+      end
+      
+      
+      # Test basic usage with a builder.
+      # 
+      # * Asserts that the receivers are called.
+      # * Asserts that receivers with blocks are handled properly.
+      
+      def test_basic_builder
+        block_ = proc do
+          set_value(:a, 1)
+          set_value_by_block(:b){ 2 }
+        end
+        hash_ = Hash.new
+        Blockenspiel.invoke(block_) do
+          add_method(:set_value) do |key_, value_|
+            hash_[key_] = value_
+          end
+          add_method(:set_value_by_block, :receive_block => true) do |key_, bl_|
+            hash_[key_] = bl_.call
+          end
+        end
+        assert_equal(1, hash_[:a])
+        assert_equal(2, hash_[:b])
+      end
+      
+      
+    end
+    
+  end
+end

data/tests/tc_dsl_methods.rb

@@ -0,0 +1,283 @@
+# -----------------------------------------------------------------------------
+# 
+# Blockenspiel dsl method tests
+# 
+# This file contains tests for the dsl method directives.
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2008 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+
+
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/blockenspiel.rb")
+
+
+module Blockenspiel
+  module Tests  # :nodoc:
+    
+    class TestDSLMethods < Test::Unit::TestCase  # :nodoc:
+      
+      
+      class Target1 < Blockenspiel::Base
+        
+        def initialize(hash_)
+          @hash = hash_
+        end
+        
+        def set_value1(key_, value_)
+          @hash["#{key_}1"] = value_
+        end
+        
+        def set_value2(key_)
+          @hash["#{key_}2"] = yield
+        end
+        
+        def _set_value3(key_, value_)
+          @hash["#{key_}3"] = value_
+        end
+        
+      end
+      
+      
+      class Target2 < Blockenspiel::Base
+        
+        def initialize(hash_)
+          @hash = hash_
+        end
+        
+        dsl_methods false
+        
+        def set_value1(key_, value_)
+          @hash["#{key_}1"] = value_
+        end
+        
+        dsl_methods true
+        
+        def set_value2(key_)
+          @hash["#{key_}2"] = yield
+        end
+        
+        def _set_value3(key_, value_)
+          @hash["#{key_}3"] = value_
+        end
+        
+      end
+      
+      
+      class Target3 < Blockenspiel::Base
+        
+        def initialize(hash_)
+          @hash = hash_
+        end
+        
+        dsl_methods false
+        
+        def set_value1(key_, value_)
+          @hash["#{key_}1"] = value_
+        end
+        dsl_method :set_value1
+        
+        def set_value2(key_)
+          @hash["#{key_}2"] = yield
+        end
+        dsl_method :renamed_set_value2, :set_value2
+        dsl_method :another_set_value2, :set_value2
+        
+      end
+      
+      
+      class Target4 < Blockenspiel::Base
+        
+        def initialize(hash_)
+          @hash = hash_
+        end
+        
+        def set_value1(key_, value_)
+          @hash["#{key_}1"] = value_
+        end
+        dsl_method :set_value1, false
+        
+        def set_value2(key_)
+          @hash["#{key_}2"] = yield
+        end
+        dsl_method :set_value2, false
+        dsl_method :renamed_set_value2, :set_value2
+        
+      end
+      
+      
+      class Target5a < Blockenspiel::Base
+        
+        def initialize(hash_)
+          @hash = hash_
+        end
+        
+        def set_value1(key_, value_)
+          @hash["#{key_}1"] = value_
+        end
+        
+        def set_value2(key_)
+          @hash["#{key_}2"] = yield
+        end
+        
+        def set_value3(key_, value_)
+          @hash["#{key_}3"] = value_
+        end
+        
+        def set_value4(key_, value_)
+          @hash["#{key_}4"] = value_
+        end
+        dsl_method :set_value4, false
+        dsl_method :renamed_set_value4, :set_value4
+        
+      end
+      
+      
+      class Target5b < Target5a
+        
+        def set_value1(key_, value_)
+          @hash["#{key_}1sub"] = value_
+        end
+        
+        dsl_method :set_value3, false
+        
+        def set_value5(key_, value_)
+          @hash["#{key_}5"] = value_
+        end
+        
+      end
+      
+      
+      # Test default dsl method setting.
+      # 
+      # * Asserts the right dsl methods are added for the default setting.
+      
+      def test_default_setting
+        hash_ = Hash.new
+        block_ = proc do
+          set_value1('a', 1)
+          set_value2('b'){ 2 }
+          assert_raise(NoMethodError){ _set_value3('c', 3) }
+        end
+        Blockenspiel.invoke(block_, Target1.new(hash_))
+        assert_equal(1, hash_['a1'])
+        assert_equal(2, hash_['b2'])
+        assert_nil(hash_['c3'])
+      end
+      
+      
+      # Test dsl_methods true and false switching.
+      # 
+      # * Asserts that dsl_methods false turns off automatic method creation.
+      # * Asserts that dsl_methods true turns on automatic method creation.
+      # * Asserts that underscore methods are added in dsl_methods true mode.
+      
+      def test_onoff_switching
+        hash_ = Hash.new
+        block_ = proc do
+          assert_raise(NoMethodError){ _set_value1('a', 1) }
+          set_value2('b'){ 2 }
+          _set_value3('c', 3)
+        end
+        Blockenspiel.invoke(block_, Target2.new(hash_))
+        assert_nil(hash_['a1'])
+        assert_equal(2, hash_['b2'])
+        assert_equal(3, hash_['c3'])
+      end
+      
+      
+      # Test dsl_methods explicit adding.
+      # 
+      # * Asserts that adding an explicit dsl method works.
+      # * Asserts that adding an explicit dsl method with a different name works.
+      
+      def test_explicit_add
+        hash_ = Hash.new
+        block_ = proc do
+          set_value1('a', 1)
+          assert_raise(NoMethodError){ set_value2('b'){ 2 } }
+          renamed_set_value2('c'){ 3 }
+          another_set_value2('d'){ 4 }
+        end
+        Blockenspiel.invoke(block_, Target3.new(hash_))
+        assert_equal(1, hash_['a1'])
+        assert_nil(hash_['b2'])
+        assert_equal(3, hash_['c2'])
+        assert_equal(4, hash_['d2'])
+      end
+      
+      
+      # Test dsl_methods explicit removing.
+      # 
+      # * Asserts that removing a dsl method works.
+      # * Asserts that re-adding a removed method with a different name works.
+      
+      def test_explicit_removing
+        hash_ = Hash.new
+        block_ = proc do
+          assert_raise(NoMethodError){ set_value1('a', 1) }
+          assert_raise(NoMethodError){ set_value2('b'){ 2 } }
+          renamed_set_value2('c'){ 3 }
+        end
+        Blockenspiel.invoke(block_, Target4.new(hash_))
+        assert_nil(hash_['a1'])
+        assert_nil(hash_['b2'])
+        assert_equal(3, hash_['c2'])
+      end
+      
+      
+      # Test dsl method setting with subclasses
+      # 
+      # * Asserts that modules are properly inherited.
+      # * Asserts that method overriding is done correctly.
+      
+      def test_subclassing
+        hash_ = Hash.new
+        block_ = proc do
+          set_value1('a', 1)
+          set_value2('b'){ 2 }
+          assert_raise(NoMethodError){ set_value3('c', 3) }
+          assert_raise(NoMethodError){ set_value4('d', 4) }
+          renamed_set_value4('e', 5)
+          set_value5('f', 6)
+        end
+        Blockenspiel.invoke(block_, Target5b.new(hash_))
+        assert_equal(1, hash_['a1sub'])
+        assert_equal(2, hash_['b2'])
+        assert_nil(hash_['c3'])
+        assert_nil(hash_['d4'])
+        assert_equal(5, hash_['e4'])
+        assert_equal(6, hash_['f5'])
+      end
+      
+      
+    end
+    
+  end
+end

data/tests/tc_mixins.rb

@@ -0,0 +1,206 @@
+# -----------------------------------------------------------------------------
+# 
+# Blockenspiel mixin tests
+# 
+# This file contains tests for various mixin cases,
+# including nested blocks and multithreading.
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2008 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+
+
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/blockenspiel.rb")
+
+
+module Blockenspiel
+  module Tests  # :nodoc:
+    
+    class TestMixins < Test::Unit::TestCase  # :nodoc:
+      
+      
+      class Target1 < Blockenspiel::Base
+        
+        def initialize(hash_)
+          @hash = hash_
+        end
+        
+        def set_value(key_, value_)
+          @hash["#{key_}1"] = value_
+        end
+        
+        def set_value2(key_)
+          @hash["#{key_}1"] = yield
+        end
+        
+      end
+      
+      
+      class Target2 < Blockenspiel::Base
+        
+        dsl_methods false
+        
+        def initialize(hash_=nil)
+          @hash = hash_ || Hash.new
+        end
+        
+        def set_value(key_, value_)
+          @hash["#{key_}2"] = value_
+        end
+        dsl_method :set_value
+        
+        def set_value2(key_)
+          @hash["#{key_}2"] = yield
+        end
+        dsl_method :set_value2_inmixin, :set_value2
+        
+      end
+      
+      
+      # Basic test of mixin mechanism.
+      # 
+      # * Asserts that the mixin methods are added and removed for a single mixin.
+      # * Asserts that the methods properly delegate to the target object.
+      # * Asserts that self doesn't change, and instance variables are preserved.
+      
+      def test_basic_mixin
+        hash_ = Hash.new
+        saved_object_id_ = self.object_id
+        @my_instance_variable_test = :hello
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        block_ = proc do
+          set_value('a', 1)
+          set_value2('b'){ 2 }
+          assert_equal(:hello, @my_instance_variable_test)
+          assert_equal(saved_object_id_, self.object_id)
+        end
+        Blockenspiel.invoke(block_, Target1.new(hash_))
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        assert_equal(1, hash_['a1'])
+        assert_equal(2, hash_['b1'])
+      end
+      
+      
+      # Test renaming of mixin methods.
+      # 
+      # * Asserts that correctly renamed mixin methods are added and removed.
+      # * Asserts that the methods properly delegate to the target object.
+      
+      def test_mixin_with_renaming
+        hash_ = Hash.new
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        assert(!self.respond_to?(:set_value2_inmixin))
+        block_ = proc do
+          set_value('a', 1)
+          set_value2_inmixin('b'){ 2 }
+          assert(!self.respond_to?(:set_value2))
+        end
+        Blockenspiel.invoke(block_, Target2.new(hash_))
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        assert(!self.respond_to?(:set_value2_inmixin))
+        assert_equal(1, hash_['a2'])
+        assert_equal(2, hash_['b2'])
+      end
+      
+      
+      # Test of two different nested mixins.
+      # 
+      # * Asserts that the right methods are added and removed at the right time.
+      # * Asserts that the methods delegate to the right target object, even when
+      #   multiple mixins add the same method name
+      
+      def test_nested_different
+        hash_ = Hash.new
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        assert(!self.respond_to?(:set_value2_inmixin))
+        Blockenspiel.invoke(proc do
+          set_value('a', 1)
+          set_value2('b'){ 2 }
+          assert(!self.respond_to?(:set_value2_inmixin))
+          Blockenspiel.invoke(proc do
+            set_value('c', 1)
+            set_value2_inmixin('d'){ 2 }
+          end, Target2.new(hash_))
+          assert(!self.respond_to?(:set_value2_inmixin))
+          set_value('e', 1)
+          set_value2('f'){ 2 }
+        end, Target1.new(hash_))
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        assert(!self.respond_to?(:set_value2_inmixin))
+        assert_equal(1, hash_['a1'])
+        assert_equal(2, hash_['b1'])
+        assert_equal(1, hash_['c2'])
+        assert_equal(2, hash_['d2'])
+        assert_equal(1, hash_['e1'])
+        assert_equal(2, hash_['f1'])
+      end
+      
+      
+      # Test of the same mixin nested in itself.
+      # 
+      # * Asserts that the methods are added and removed at the right time.
+      
+      def test_nested_same
+        hash_ = Hash.new
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        assert(!self.respond_to?(:set_value2_inmixin))
+        Blockenspiel.invoke(proc do
+          set_value('a', 1)
+          set_value2_inmixin('b'){ 2 }
+          Blockenspiel.invoke(proc do
+            set_value('c', 1)
+            set_value2_inmixin('d'){ 2 }
+            assert(!self.respond_to?(:set_value2))
+          end, Target2.new(hash_))
+          set_value('e', 1)
+          set_value2_inmixin('f'){ 2 }
+        end, Target2.new(hash_))
+        assert(!self.respond_to?(:set_value))
+        assert(!self.respond_to?(:set_value2))
+        assert(!self.respond_to?(:set_value2_inmixin))
+        assert_equal(1, hash_['a2'])
+        assert_equal(2, hash_['b2'])
+        assert_equal(1, hash_['c2'])
+        assert_equal(2, hash_['d2'])
+        assert_equal(1, hash_['e2'])
+        assert_equal(2, hash_['f2'])
+      end
+      
+      
+    end
+    
+  end
+end