active_helper 0.1.0 → 0.1.1

data/README.textile

@@ -17,6 +17,13 @@ methods are _delegated_ to the helper instances
 
 Note that ActiveHelper is a generic helper framework. Not coupled to anything like Rails or Merb. Not providing any concrete helpers. Feel free to use clean helpers in _any_ framework (including Rails and friends)!
 
+h2. Installation
+
+<pre>
+> gem install active_helper
+</pre>
+
+
 h2. Example
 
 Let's use the bloody MVC-View example as we find in Rails or Merb (Sinatra, too?).

data/lib/active_helper/base.rb

@@ -11,15 +11,39 @@ module ActiveHelper
     
     class << self
       # Add public methods to the helper's interface. Only methods listed here will 
-      # be used to expand the target.
+      # be imported into the target.
+      #
+      # Example:
+      #   class UrlHelper < ActiveHelper::Base
+      #     provides :url_for, :link_to
       def provides(*methods)
         helper_methods.push(*methods)
       end
       
+      # Define a dependency to another ActiveHelper. All provided methods by the needed
+      # helper will be imported into the helper that called needs.
+      #
+      # Example:
+      #   class UrlHelper < ActiveHelper::Base
+      #     needs TagHelper
+      #
+      # will import #tag into UrlHelper.
       def needs(*methods)
         parent_readers.push(*methods).uniq!
       end
       
+      # Define a dependency to methods in target. Calls to that methods will be delegated
+      # simply back to target.
+      #
+      # Note: This can also be used to call a helper method from a non-ActiveHelper, which
+      # was preliminary included in target.
+      #
+      # Example:
+      #   class UrlHelper < ActiveHelper::Base
+      #     uses controller
+      #
+      # will deletegate calls to #controller to target (i.e. the view instance that #use's 
+      # UrlHelper).
       def uses(*classes)
         class_helpers.push(*classes).uniq!
       end
@@ -31,23 +55,24 @@ module ActiveHelper
     
     def initialize(parent=nil)
       @parent = parent
-      extend SingleForwardable
-      add_parent_readers!
-      add_class_helpers!
+      setup_delegator_strategy! # in GenericMethods.
+      delegate_parent_readers!
+      use_class_helpers!
     end
     
-    def use(helper_class)
-      use_for(helper_class, parent) # in GenericMethods.
+    def use(*classes)
+      use_for(classes, parent) # in GenericMethods.
     end
     
     protected
       # Delegates methods declared with #needs back to parent.
-      def add_parent_readers!
+      def delegate_parent_readers!
         return if @parent.blank? or self.class.parent_readers.blank?
-        def_delegator(:@parent, self.class.parent_readers)
+        delegate_methods_to(self.class.parent_readers, :@parent)  # in GenericMethods.
       end
       
-      def add_class_helpers!
+      # Imports foreign methods from other use'd helpers.
+      def use_class_helpers!
         self.class.class_helpers.each { |helper| use helper }
       end
   end

data/lib/active_helper/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module ActiveHelper
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'
 end

data/lib/active_helper.rb

@@ -4,20 +4,28 @@ require 'forwardable'
 
 module ActiveHelper
   module GenericMethods
-    def use_for(helper_class, target)
-      extend ::SingleForwardable
-      
-      helper_ivar_name  = ivar_name_for(helper_class)
-      helper_instance   = helper_class.new(target)
-      
-      instance_variable_set(helper_ivar_name, helper_instance) 
-      helper_class.helper_methods.each do |meth|
-        def_delegator helper_ivar_name, meth
+    def use_for(classes, target)
+      classes.each do |helper_class|
+        helper_ivar_name  = ivar_name_for(helper_class)
+        helper_instance   = helper_class.new(target)
+        
+        instance_variable_set(helper_ivar_name, helper_instance) 
+        delegate_methods_to(helper_class.helper_methods, helper_ivar_name)
       end
     end
     
     protected
-      # Unique ivar name for the helper class in the expanding target.
+      def setup_delegator_strategy!
+        extend SingleForwardable
+      end
+      
+      # Implements the actual delegation.
+      def delegate_methods_to(methods, ivar)
+        return if methods.blank?
+        def_delegators ivar, *methods
+      end
+      
+      # Unique ivar name for the helper instance in the expanding target.
       def ivar_name_for(object)
         ('@__active_helper_'+("#{object.to_s}".underscore.gsub(/[\/<>@#:]/, ""))).to_sym
       end
@@ -25,10 +33,20 @@ module ActiveHelper
   
   
   include GenericMethods
-  # Expands the target *instance* with the provided methods from +helper_class+ by delegating 'em back to a private helper
-  # Expands only the helped instance itself, not the class.
-  def use (helper_class)
-    use_for(helper_class, self)
+  # Imports the provided methods from +classes+ into the target *instance* (the receiver).
+  # All new methods in the target will be delegated back to the helpers.
+  # 
+  # Note: Imports only into the helped instance itself, not the class.
+  #
+  # Example:
+  #   class View
+  #   end
+  #
+  #   view = View.new
+  #   view.use UrlHelper, DataMapperHelper
+  def use (*classes)
+    setup_delegator_strategy!
+    use_for(classes, self)
   end
 end
 

data/test/active_helper_test.rb

@@ -1,6 +1,15 @@
 require File.dirname(__FILE__) + '/test_helper'
 
 class ActiveHelperTest < Test::Unit::TestCase
+  class GreedyHelper < ::ActiveHelper::Base
+    provides :eat
+  end
+  
+  class ThirstyHelper < ::ActiveHelper::Base
+    provides :drink, :booze
+  end
+  
+  
   def helper_mock(*args)
     Class.new(::ActiveHelper::Base).new(*args)
   end
@@ -136,7 +145,7 @@ class ActiveHelperTest < Test::Unit::TestCase
       assert_respond_to @helper.class, :uses
       assert ! @helper.respond_to?(:eat)
       
-      class GreedyHelper < ::ActiveHelper::Base; provides :eat; end
+      
     end
     
     context "#use" do
@@ -151,6 +160,20 @@ class ActiveHelperTest < Test::Unit::TestCase
         @helper.use GreedyHelper
         assert_equal @target, helper_in(GreedyHelper, @helper).parent # parent of used handler is target, not the using handler!
       end
+      
+      should "accept multiple helper classes" do
+        @helper.use GreedyHelper, ThirstyHelper
+        assert_respond_to @helper, :eat
+        assert_respond_to @helper, :drink
+        assert_respond_to @helper, :booze
+      end
+      
+      should "accept empty helpers with no methods" do
+        @empty_helper = helper_mock
+        @helper.use  @empty_helper.class
+        assert helper_in(@empty_helper.class, @helper)
+      end
+      
     end
     
     context "#uses" do    
@@ -209,8 +232,6 @@ class ActiveHelperTest < Test::Unit::TestCase
       
       @target = @target_class.new
       assert ! @target.respond_to?(:eat)
-      
-      class GreedyHelper < ::ActiveHelper::Base; provides :eat; end
     end
     
     context "#use" do
@@ -223,6 +244,13 @@ class ActiveHelperTest < Test::Unit::TestCase
         @target.use GreedyHelper
         assert_equal @target, helper_in(GreedyHelper, @target).parent
       end
+      
+      should "accept multiple helper classes" do
+        @target.use GreedyHelper, ThirstyHelper
+        assert_respond_to @target, :eat
+        assert_respond_to @target, :drink
+        assert_respond_to @target, :booze
+      end
     end
     
     #context "#uses" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_helper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-30 00:00:00 +02:00
+date: 2010-04-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency