blockenspiel 0.3.1 → 0.3.2

data/Blockenspiel.rdoc

@@ -314,6 +314,8 @@ multiple threads trying to mix methods into the same object concurrently.
 
 * Implementing wildcard DSL methods using <tt>method_missing</tt> doesn't
   work. I haven't yet figured out the right semantics for this case.
+* Including Blockenspiel::DSL in a module is not yet supported, but this
+  is planned in a future release.
 
 === Development and support
 

data/History.rdoc

@@ -1,3 +1,11 @@
+=== 0.3.2 / 2009-11-17
+
+* Modules included in a DSL-ized class now have their methods included in
+  the DSL.
+* Raise a more informative error (for now) when trying to include
+  Blockenspiel::DSL in a module. At some point, we'll support this usage,
+  once I figure out the right semantics for it.
+
 === 0.3.1 / 2009-11-08
 
 * Blockenspiel#invoke can now take its options hash as the second argument

data/README.rdoc

@@ -66,6 +66,8 @@ For an extended analysis of different ways to implement DSL blocks, see
 
 * Implementing wildcard DSL methods using <tt>method_missing</tt> doesn't
   work. I haven't yet figured out the right semantics for this case.
+* Including Blockenspiel::DSL in a module is not yet supported, but this
+  is planned in a future release.
 
 === Development and support
 

data/Rakefile

@@ -192,6 +192,7 @@ task :release_gem_to_gemcutter => [:package] do |t_|
   end
   puts "Releasing blockenspiel #{v_} to GemCutter"
   `cd pkg && gem push blockenspiel-#{v_}.gem`
+  `cd pkg && gem push blockenspiel-#{v_}-java.gem`
 end
 
 

data/lib/blockenspiel/impl.rb

@@ -95,6 +95,12 @@ module Blockenspiel
           ::Blockenspiel::DSLSetupMethods._setup_class(subklass_)
           super
         end
+        class << klass_
+          unless private_method_defined?(:_blockenspiel_default_include)
+            alias_method :_blockenspiel_default_include, :include
+            alias_method :include, :_blockenspiel_custom_include
+          end
+        end
       end
     end
     
@@ -121,10 +127,9 @@ module Blockenspiel
     end
     
     
-    # Hook called when a method is added.
-    # This automatically makes the method a DSL method according to the current setting.
+    # Automatically make the given method a DSL method according to the current setting.
     
-    def method_added(symbol_)  # :nodoc:
+    def _blockenspiel_auto_dsl_method(symbol_)  # :nodoc:
       if @_blockenspiel_active
         dsl_method(symbol_)
       elsif @_blockenspiel_active.nil?
@@ -132,10 +137,34 @@ module Blockenspiel
           dsl_method(symbol_)
         end
       end
+    end
+    
+    
+    # Hook called when a method is added.
+    # This calls _blockenspiel_auto_dsl_method to auto-handle the method,
+    # possibly making it a DSL method according to the current setting.
+    
+    def method_added(symbol_)  # :nodoc:
+      _blockenspiel_auto_dsl_method(symbol_)
       super
     end
     
     
+    # Custom include method. Calls the main include implementation, but also
+    # goes through the public methods of the included module and calls
+    # _blockenspiel_auto_dsl_method on each to make them DSL methods
+    # (possibly) according to the current setting.
+    
+    def _blockenspiel_custom_include(*modules_)  # :nodoc:
+      _blockenspiel_default_include(*modules_)
+      modules_.reverse_each do |mod_|
+        mod_.public_instance_methods.each do |method_|
+          _blockenspiel_auto_dsl_method(method_)
+        end
+      end
+    end
+    
+    
     # Get this class's corresponding DSL module
     
     def _get_blockenspiel_module  # :nodoc:
@@ -328,6 +357,9 @@ module Blockenspiel
   module DSL
     
     def self.included(klass_)  # :nodoc:
+      unless klass_.kind_of?(::Class)
+        raise ::Blockenspiel::BlockenspielError, "You cannot include Blockenspiel::DSL in a module (yet)"
+      end
       klass_.extend(::Blockenspiel::DSLSetupMethods)
     end
     

data/lib/blockenspiel/version.rb

@@ -37,7 +37,7 @@
 module Blockenspiel
   
   # Current gem version, as a frozen string.
-  VERSION_STRING = '0.3.1'.freeze
+  VERSION_STRING = '0.3.2'.freeze
   
   autoload(:VERSION, ::File.dirname(__FILE__)+'/versionomy.rb')
   

data/tests/tc_mixins.rb

@@ -85,6 +85,38 @@ module Blockenspiel
       end
       
       
+      class Target3 < ::Blockenspiel::Base
+        
+        def initialize(hash_)
+          @hash = hash_
+        end
+        
+        def set_value(key_, value_)
+          @hash[key_] = value_
+        end
+        
+        def _helper_method(key_)
+          @hash[key_]
+        end
+        
+        def get_value(key_)
+          @hash[key_]
+        end
+        dsl_method :get_value, false
+        
+        def get_value2(key_)
+          @hash[key_]
+        end
+        dsl_method :get_value2, false
+        
+      end
+      
+      
+      def get_value(key_)
+        :helper
+      end
+      
+      
       # Basic test of mixin mechanism.
       # 
       # * Asserts that the mixin methods are added and removed for a single mixin.
@@ -234,6 +266,28 @@ module Blockenspiel
       end
       
       
+      # Test mixin omissions.
+      # 
+      # * Asserts that underscore methods are not mixed in.
+      # * Asserts that methods that are turned off after the fact cannot be called.
+      
+      def test_omissions
+        hash_ = ::Hash.new
+        block_ = ::Proc.new do
+          set_value(:a, 1)
+          assert(!self.respond_to?(:_helper_method))
+          assert_equal(:helper, get_value(:a))
+          assert_raise(::NoMethodError) do
+            get_value2(:a)
+          end
+        end
+        target_ = Target3.new(hash_)
+        ::Blockenspiel.invoke(block_, target_)
+        assert(!self.respond_to?(:set_value))
+        assert_equal(1, target_.get_value(:a))
+      end
+      
+      
     end
     
   end

data/tests/tc_modules.rb

@@ -0,0 +1,188 @@
+# -----------------------------------------------------------------------------
+# 
+# Blockenspiel module tests
+# 
+# This file contains tests for DSL module inclusion.
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2008-2009 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 'test/unit'
+require ::File.expand_path("#{::File.dirname(__FILE__)}/../lib/blockenspiel.rb")
+
+
+module Blockenspiel
+  module Tests  # :nodoc:
+    
+    class TestBasic < ::Test::Unit::TestCase  # :nodoc:
+      
+      
+      class Target1
+        include ::Blockenspiel::DSL
+        
+        def initialize
+          @hash = ::Hash.new
+        end
+        
+        def set_value(key_, value_)
+          @hash[key_] = value_
+        end
+        
+        def _helper_method(key_, value_)
+          @hash[key_] = value_
+        end
+        
+        def get_value(key_)
+          @hash[key_]
+        end
+        dsl_method :get_value, false
+        
+        def get_value2(key_)
+          @hash[key_]
+        end
+        dsl_method :get_value2, false
+        
+      end
+      
+      
+      module Module2
+        
+        def set_value(key_, value_)
+          @hash[key_] = value_
+        end
+        
+        def _get_value(key_)
+          @hash[key_]
+        end
+        
+      end
+      
+      class Target2a
+        include ::Blockenspiel::DSL
+        
+        def initialize
+          @hash = ::Hash.new
+        end
+        
+        include Module2
+      end
+      
+      class Target2b
+        include ::Blockenspiel::DSL
+        
+        def initialize
+          @hash = ::Hash.new
+        end
+      end
+      
+      class Target2c < Target2b
+        include Module2
+      end
+      
+      
+      # Helper method
+      
+      def get_value(key_)
+        return :helper
+      end
+      
+      
+      # Test simple usage.
+      # 
+      # * 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_simple_target
+        block_ = ::Proc.new do
+          set_value(:a, 1)
+        end
+        target_ = Target1.new
+        ::Blockenspiel.invoke(block_, target_)
+        assert(!self.respond_to?(:set_value))
+        assert_equal(1, target_.get_value(:a))
+      end
+      
+      
+      # Test omissions.
+      # 
+      # * Asserts that underscore methods are not mixed in.
+      # * Asserts that methods that are turned off after the fact cannot be called.
+      
+      def test_omissions
+        block_ = ::Proc.new do
+          set_value(:a, 1)
+          assert(!self.respond_to?(:_helper_method))
+          assert_equal(:helper, get_value(:a))
+          assert_raise(::NoMethodError) do
+            get_value2(:a)
+          end
+        end
+        target_ = Target1.new
+        ::Blockenspiel.invoke(block_, target_)
+      end
+      
+      
+      # Test module inclusion.
+      # 
+      # * Asserts that methods from an included module are handled.
+      
+      def test_simple_module_inclusion
+        block_ = ::Proc.new do
+          set_value(:a, 1)
+          assert(!self.respond_to?(:_get_value))
+        end
+        target_ = Target2a.new
+        ::Blockenspiel.invoke(block_, target_)
+        assert_equal(1, target_._get_value(:a))
+      end
+      
+      
+      # Test module inclusion from a subclass
+      # 
+      # * Asserts that a module can be included from a DSL subclass.
+      
+      def test_simple_module_inclusion_from_subclass
+        block_ = ::Proc.new do
+          set_value(:a, 1)
+          assert(!self.respond_to?(:_get_value))
+        end
+        target_ = Target2c.new
+        ::Blockenspiel.invoke(block_, target_)
+        assert_equal(1, target_._get_value(:a))
+      end
+      
+      
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blockenspiel
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-08 00:00:00 -08:00
+date: 2009-11-17 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -39,6 +39,7 @@ files:
 - tests/tc_dsl_methods.rb
 - tests/tc_dynamic.rb
 - tests/tc_mixins.rb
+- tests/tc_modules.rb
 - Blockenspiel.rdoc
 - History.rdoc
 - ImplementingDSLblocks.rdoc
@@ -79,3 +80,4 @@ test_files:
 - tests/tc_dsl_methods.rb
 - tests/tc_dynamic.rb
 - tests/tc_mixins.rb
+- tests/tc_modules.rb