block_helpers 0.3.0 → 0.3.2

data/README.markdown

@@ -11,6 +11,18 @@ Rails already has a great solution for forms with form-builders, using helpers w
 
 This small gem generates helpers similar to the form-builders, but for the general case.
 
+Installation
+============
+
+To use in Rails, add to your `environment.rb`:
+
+    config.gem "block_helpers", :source => "http://gemcutter.org"
+
+for Merb, in `init.rb`:
+
+    dependency "block_helpers"
+
+
 Example usage
 =============
 Please note that these examples are very contrived just for brevity! These block helpers are much more useful than just printing 'Hi there Marmaduke!'
@@ -161,16 +173,58 @@ This generates:
 
 Of course, you could use `display` for more than just surrounding markup.
 
-Installation
-============
+Nesting
+=======
+You can even nest block helpers:
 
-To use in Rails, add to your `environment.rb`:
+    module MyHelper
 
-    config.gem "block_helpers", :lib => "block_helpers", :source => "http://gemcutter.org"
+      class Nav < BlockHelpers::Base
 
-for Merb, in `init.rb`:
+        #...code....
 
-    dependency "block_helpers"
+        class SubNav < BlockHelpers::Base
+
+          #...code...
+
+        end
+
+      end
+
+    end
+
+In the view:
+
+    <% nav do |h| %>
+      ...
+      <% h.sub_nav do %>
+        ...
+      <% end %>
+      ...
+    <% end %>
+    
+However... I'd be careful not to abuse this, as the code could end up more confusing than it needs be.
+Nested block helpers can access the parent block helper by using the `parent` method.
+
+Testing
+=======
+I'm not too sure about other testing frameworks, but with rspec-rails you can use 'eval_erb', e.g.
+
+    eval_erb(%(
+      <% my_block_helper do |h| %>
+        <h2>Hello</h2>
+        <%= h.write_blah %>
+      <% end %>
+    )).should match_html("<h2>Hello</h2> blah blah blah ")
+
+In the above I've used the following simple matcher `match_html`:
+
+    def match_html(html)
+      # Match two strings, but don't care about whitespace
+      simple_matcher("should match #{html}"){|given| given.strip.gsub(/\s+/,' ').gsub('> <','><') == html.strip.gsub(/\s+/,' ').gsub('> <','><') }
+    end
+
+Obviously you test however you want but I've included the above in case it's useful.
 
 Compatibility
 =============

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.2

data/block_helpers.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{block_helpers}
-  s.version = "0.3.0"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Evans"]
-  s.date = %q{2009-10-12}
+  s.date = %q{2009-11-06}
   s.email = %q{mark@new-bamboo.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/block_helpers.rb

@@ -4,37 +4,59 @@ module BlockHelpers
 
   class Base
 
-    def self.inherited(klass)
-      # Define the helper method
-      # e.g. for a class:
-      #   class HelloHelper < BlockHelpers::Base
-      #     #.....
-      #   end
-      #
-      # then we define a helper method 'hello_helper'
-      #
-      method_name = klass.name.split('::').last.underscore
-      klass.parent.class_eval %(
-        def #{method_name}(*args, &block)
-          renderer = #{klass.name}.new(*args)
-          top_level_helper = if self.is_a?(BlockHelpers::Base) 
-            self.helper
-          else
-            self
-          end
-          renderer.send(:helper=, top_level_helper)
-          body = block ? capture(renderer, &block) : nil
-          processed_body = renderer.display(body)
-          if processed_body
-            if top_level_helper.method(:concat).arity == 2
-              concat processed_body, binding
+    class << self
+
+      def inherited(klass)
+        # Define the helper method
+        # e.g. for a class:
+        #   class HelloHelper < BlockHelpers::Base
+        #     #.....
+        #   end
+        #
+        # then we define a helper method 'hello_helper'
+        #
+        method_name = klass.name.split('::').last.underscore
+        klass.parent.class_eval %(
+          def #{method_name}(*args, &block)
+            
+            # Get the current helper object which has all the normal helper methods
+            if self.is_a?(BlockHelpers::Base) 
+              top_level_helper = self.helper
+              parent_block_helper = self
             else
-              concat processed_body
+              top_level_helper = self
+              parent_block_helper = nil
+            end
+            
+            # We need to save the current helper and parent block helper in the class so that
+            # it's visible to the renderer's 'initialize' method...
+            #{klass.name}.current_helper = top_level_helper
+            #{klass.name}.current_parent_block_helper = parent_block_helper
+            renderer = #{klass.name}.new(*args)
+            # ...then set them anyway on the renderer so that renderer methods can use it
+            renderer.send(:helper=, top_level_helper)
+            renderer.send(:parent=, parent_block_helper)
+
+            body = block ? capture(renderer, &block) : nil
+            processed_body = renderer.display(body)
+            if processed_body
+
+              # If concat is the old rails/merb version with 2 args...
+              if top_level_helper.method(:concat).arity == 2
+                concat processed_body, binding
+              # ...otherwise call with one arg
+              else
+                concat processed_body
+              end
+              
             end
+            renderer
           end
-          renderer
-        end
-      )
+        )
+      end
+      
+      attr_accessor :current_helper, :current_parent_block_helper
+    
     end
 
     def display(body)
@@ -47,7 +69,16 @@ module BlockHelpers
 
     protected
 
-    attr_accessor :helper
+    attr_writer :helper, :parent
+
+    # For nested block helpers
+    def parent
+      @parent ||= self.class .current_parent_block_helper
+    end
+    
+    def helper
+      @helper ||= self.class.current_helper
+    end
 
     def method_missing(method, *args, &block)
       if helper.respond_to?(method)

data/spec/helpers/block_helpers_spec.rb

@@ -95,6 +95,21 @@ describe TestHelperModule do
         <% end %>
       )).should match_html("<div>jelly</div>")
     end
+    it "should give the yielded renderer access to normal actionview helper methods even in initialize" do
+      module TestHelperModule
+        class JokeHelper < BlockHelpers::Base
+          def initialize
+            @joke = truncate("What's the different between half a duck?", :length => 6)
+          end
+          attr_reader :joke
+        end
+      end
+      eval_erb(%(
+        <% joke_helper do |r| %>
+          <%= r.joke %>
+        <% end %>
+      )).should match_html("Wha...")
+    end
     it "should give the yielded renderer access to other methods via 'helper'" do
       eval_erb(%(
         <% test_helper do |r| %>
@@ -287,7 +302,7 @@ describe TestHelperModule do
         class OuterHelper < BlockHelpers::Base
           
           def egg
-            'bad egg'
+            'bad egg ' + parent.inspect
           end
           
           def display(body)
@@ -295,8 +310,13 @@ describe TestHelperModule do
           end
           
           class InnerHelper < BlockHelpers::Base
+            
+            def initialize
+              @egg = parent.egg
+            end
+            
             def egg
-              'EGG'
+              @egg + ' ' + parent.egg.upcase
             end
             def display(body)
               "Inner #{body}"
@@ -310,7 +330,7 @@ describe TestHelperModule do
             <%= i.egg %>
           <% end %>
         <% end %>
-      )).should match_html("Outer Inner EGG")
+      )).should match_html("Outer Inner bad egg nil BAD EGG NIL")
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: block_helpers
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors: 
 - Mark Evans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-12 00:00:00 +01:00
+date: 2009-11-06 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency