active_helper 0.2.0 → 0.2.1

data/README.textile

@@ -10,10 +10,10 @@ Helpers suck. They've always sucked, and they will suck on if we keep them in mo
 ActiveHelper is an attempt to pack helpers into *classes*. This brings us a few benefits
 
 * *inheritance* helpers can be derived other helpers
-* *delegation* helpers are no longer mixed into a target- the targets @use@ the helper, where the new 
+* *delegation* helpers are no longer mixed into a target- the targets @import@ the helper, where the new 
 methods are _delegated_ to the helper instances
 * *proper encapsulation* helpers don't rely blindly on instance variables - a helper defines its @needs@, the target has to provide readers
-* *interfaces* a helper clearly @provides@ methods and might @use@ additional helpers 
+* *interfaces* a helper clearly @provides@ methods and might @import@ additional helpers 
 
 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)!
 
@@ -38,12 +38,14 @@ The view wants to render tags using the TagHelper.
 <pre>
 class View
   include ActiveHelper
+  import TagHelper
 end
 
-> view.use TagHelper
 </pre>
 
-To pull-in ("import") a helper we invoke @use@ on the target instance.
+To pull-in a helper we invoke @import@ in the target class.
+
+Note that you can also use @import@ on an object to limit the helper's scope to that instance, only.
 
 
 h3. Interfaces
@@ -84,7 +86,7 @@ end
 That's _a bit_ cleaner than blindly including 30 helper modules in another helper in another helper, isn't it?
 
 <pre>
-> view.use FormHelper
+> view.import FormHelper
 > view.tag(:form)               # => "<form>"
 > view.form('apotomo.de')       # => "<form action=apotomo.de>"
 </pre>
@@ -109,7 +111,7 @@ In ActiveHelper this is slightly different.
 <pre>
 class FormHelper < TagHelper
   provides :form_tag
-  uses UrlHelper
+  import UrlHelper
   
   def form_tag(destination)
     destination = url_for(destination)  # in UrlHelper.
@@ -120,9 +122,9 @@ end
 
 Hmm, our _FormHelper_ is already derived from _ActiveHelper_, how do we import additional methods?
 
-Easy as well, the helper class @uses@ it.
+Easy as well, the helper class @import@s it.
 
-So we have to know _#url_for_ is located in the _UrlHelper_ and we even have to declare our helper @uses@ another one.
+So we have to know _#url_for_ is located in the _UrlHelper_ and we even have to @import@ that one.
 That's a good thing for a) *code tidiness*, b) *good architecture* and c) *debugging*.
 
 How would the _UrlHelper_ look like?
@@ -183,10 +185,41 @@ Now, does it work?
 
 Yeah.
 
+h2. Rails Bindings
+
+Use ActiveHelper in your Rails app! Assuming you'd be writing a helper for text munging, you would
+
+1. Write your helper and put it in @app/active_helpers/text_munging_helper.rb@.
+
+<pre>
+class TextMungingHelper < ActiveHelper::Base
+  provides :munge
+  
+  def munge(text)
+    text.rot13
+  end
+end
+</pre>
+
+2. Prepare your controller.
+
+<pre>
+class StupidController < ActionController::Base
+  active_helper TextMungingHelper
+</pre>
+
+3. Use the imported methods in your views, just as you know it from other helpers.
+
+<pre>
+<p>
+  Your Email is <%= munge @user.email %>.
+</p>
+</pre>
+
+
 h2. Concepts
 * Helpers are instances, when accessing a raw @@ivar@ it refers to their own instance variables
 * Dependencies between different helpers and between the target (e.g. a _View_ instance) are modelled with OOP strategies: Inheritance and the declarative @#needs@.
-* Naturally helpers can @use@ other helpers on instance level, a helper class @uses@ supporting helpers.
 
 h2. License
 

data/Rakefile

@@ -2,7 +2,7 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
-require File.join(File.dirname(__FILE__), 'lib', 'active_helper', 'version')
+require File.join(File.dirname(__FILE__), 'lib', 'active_helper')
 
 desc 'Default: run unit tests.'
 task :default => :test

data/lib/active_helper.rb

@@ -1,8 +1,11 @@
+gem 'activesupport', '~>2.3'
 require 'active_support'
 require 'forwardable'
 
 
 module ActiveHelper
+  VERSION = '0.2.1'
+  
   module GenericMethods
     def use_for(classes, target)
       classes.each do |helper_class|
@@ -44,10 +47,36 @@ module ActiveHelper
   #
   #   view = View.new
   #   view.use UrlHelper, DataMapperHelper
-  def use (*classes)
+  def import(*classes)
     setup_delegator_strategy!
     use_for(classes, self)
   end
+  alias_method :use, :import
+  
+  module ClassMethods
+    include GenericMethods
+    
+    # Imports the provided methods from +classes+ into the target (the receiver).
+    # All imported helper methods in the target will be delegated back to the helpers.
+    #
+    # Example:
+    #   class View
+    #     uses UrlHelper, DataMapperHelper
+    #   end
+    def import(*classes)
+      setup_delegator_strategy!
+      use_for(classes, self)
+    end
+    
+    protected
+      def setup_delegator_strategy!
+        extend Forwardable
+      end
+  end
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
 end
 
 require 'active_helper/base'

data/lib/active_helper/base.rb

@@ -60,9 +60,10 @@ module ActiveHelper
       use_class_helpers!
     end
     
-    def use(*classes)
+    def import(*classes)
       use_for(classes, parent) # in GenericMethods.
     end
+    alias_method :use, :import
     
     protected
       # Delegates methods declared with #needs back to parent.

data/lib/active_helper/rails.rb

@@ -19,7 +19,7 @@ class ActionController::Base
   
   def initialize_template_class_with_active_helper(response)
     initialize_template_class_without_active_helper(response)
-    response.template.use *self.class.active_helpers
+    response.template.import *self.class.active_helpers
   end
   
   alias_method_chain :initialize_template_class, :active_helper

data/test/active_helper_test.rb

@@ -39,12 +39,12 @@ class ActiveHelperTest < Test::Unit::TestCase
       should "delegate the method to the parent when called" do
         @helper_class.instance_eval { needs :bottle }
         @helper = @helper_class.new(@target)
-        @target.use @helper.class
+        @target.import @helper.class
         
         assert_equal "cheers!", @helper.bottle
       end
       
-      # DiningHelper.use GreedyHelper
+      # DiningHelper.import GreedyHelper
       #
       # GreedyHelper
       #   needs :bottle
@@ -56,14 +56,14 @@ class ActiveHelperTest < Test::Unit::TestCase
         @greedy_class.instance_eval { needs :bottle }
         
         @dining = helper_mock(@target)
-        @dining.use @greedy_class
+        @dining.import @greedy_class
         
         assert_equal 'cheers!', helper_in(@greedy_class, @dining).bottle
       end
     end
   end
   
-  context "With #parent_readers and #uses," do
+  context "With #parent_readers and #import," do
     setup do
       @target = Object.new
       @target.class.instance_eval { include ::ActiveHelper }
@@ -131,29 +131,29 @@ class ActiveHelperTest < Test::Unit::TestCase
   
   context "On a Helper" do
     setup do
-      assert_respond_to ::ActiveHelper::Base, :uses
+      assert_respond_to ::ActiveHelper::Base, :import
       @helper = Class.new(::ActiveHelper::Base).new
-      assert_respond_to @helper.class, :uses
+      assert_respond_to @helper.class, :import
       assert ! @helper.respond_to?(:eat)
       
       
     end
     
-    context "#use" do
+    context "#import" do
       should "delegate the new Helper methods" do
-        @helper.use GreedyHelper
+        @helper.import GreedyHelper
         assert_respond_to @helper, :eat
       end
       
       should "set @parent => @target in the used Helper" do
         @target = Object.new
         @helper = Class.new(::ActiveHelper::Base).new(@target)
-        @helper.use GreedyHelper
+        @helper.import 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
+        @helper.import GreedyHelper, ThirstyHelper
         assert_respond_to @helper, :eat
         assert_respond_to @helper, :drink
         assert_respond_to @helper, :booze
@@ -161,7 +161,7 @@ class ActiveHelperTest < Test::Unit::TestCase
       
       should "accept empty helpers with no methods" do
         @empty_helper = helper_mock
-        @helper.use  @empty_helper.class
+        @helper.import  @empty_helper.class
         assert helper_in(@empty_helper.class, @helper)
       end
       
@@ -196,14 +196,14 @@ class ActiveHelperTest < Test::Unit::TestCase
       end
       
       should "respond to the new delegated Helper methods" do
-        @helper.class.uses GreedyHelper
+        @helper.class.import GreedyHelper
         assert_respond_to @helper.class.new, :eat
       end
       
       should "inherit helper methods to ancestors" do
         class DiningHelper < ::ActiveHelper::Base
           provides :drink
-          uses GreedyHelper
+          import GreedyHelper
           
           def drink;end
         end
@@ -219,50 +219,44 @@ class ActiveHelperTest < Test::Unit::TestCase
     setup do
       @target_class = Class.new(Object) # don't pollute Object directly.
       @target_class.instance_eval { include ::ActiveHelper }
-      assert_respond_to @target_class, :use
+      assert_respond_to @target_class, :import
       
       @target = @target_class.new
       assert ! @target.respond_to?(:eat)
     end
     
-    context "#use" do
+    context "#import" do
       should "delegate new delegated helper methods" do
-        @target.use GreedyHelper
+        @target.import GreedyHelper
         assert_respond_to @target, :eat
       end
       
       should "set @parent => @target in the used Helper" do
-        @target.use GreedyHelper
+        @target.import GreedyHelper
         assert_equal @target, helper_in(GreedyHelper, @target).parent
       end
       
       should "accept multiple helper classes" do
-        @target.use GreedyHelper, ThirstyHelper
+        @target.import GreedyHelper, ThirstyHelper
         assert_respond_to @target, :eat
         assert_respond_to @target, :drink
         assert_respond_to @target, :booze
       end
     end
     
-    #context "#uses" do
-    #  should "delegate new delegated helper methods" do
-    #    @target.class.uses GreedyHelper
-    #    assert_respond_to @target, :eat
-    #  end
-    #  
-    #  should "inherit helper methods to non-helper class" do
-    #    class DiningHelper < ::ActiveHelper::Base
-    #      provides :drink
-    #      uses GreedyHelper
-    #      
-    #      def drink;end
-    #    end
-    #    
-    #    @helper = Class.new(DiningHelper).new
-    #    assert_respond_to @helper, :eat   # from uses GreedyHelper.
-    #    assert_respond_to @helper, :drink # from DiningHelper inheritance.
-    #  end
-    #end
+    context "Class#import" do
+      should "delegate helper methods" do
+        @target.class.import GreedyHelper
+        assert_respond_to @target, :eat
+      end
+      
+      should "accept multiple helper classes" do
+        @target.class.import GreedyHelper, ThirstyHelper
+        assert_respond_to @target, :eat
+        assert_respond_to @target, :drink
+        assert_respond_to @target, :booze
+      end
+    end
   end
   
   context "#ivar_name_for" do

data/test/rails_test.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper'
 
+gem 'actionpack', '~>2.3'
 require 'action_controller'
 require 'action_view'
 require 'active_helper/rails' # usually happens in active_helper.rb

metadata

@@ -1,12 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_helper
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,23 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 +02:00
+date: 2010-06-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 0
         version: 2.3.0
-  type: :runtime
-  version_requirements: *id001
+    version: 
 description: Finally - helpers with proper encapsulation, delegation, interfaces and inheritance!
 email: apotonick@gmail.com
 executables: []
@@ -45,7 +36,6 @@ files:
 - lib/active_helper.rb
 - lib/active_helper/base.rb
 - lib/active_helper/rails.rb
-- lib/active_helper/version.rb
 - rails/init.rb
 - test/active_helper_test.rb
 - test/helpers/helpers.rb
@@ -64,20 +54,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Finally - helpers with proper encapsulation, delegation, interfaces and inheritance!

data/lib/active_helper/version.rb

@@ -1,5 +0,0 @@
-# encoding: utf-8
-
-module ActiveHelper
-  VERSION = '0.2.0'
-end