markevans-block_helpers 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Evans
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,141 @@
+Block Helpers
+=============
+
+When we write ERB views in Rails, etc., we generally DRY up the markup using helpers or partials.
+
+However, it's quite common to overdo the 'DRYing up'.
+
+When you find yourself passing in optional arguments to a helper/partial such as `:extra_text => 'eggs', :to_s_method => 'cheese'`, you know that there must be a better way.
+
+Rails already has a great solution for forms with form-builders, using helpers which yield an object which can be used for further rendering.
+
+This small gem generates helpers similar to the form-builders, but for the general case.
+
+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!'
+
+Simple case
+-----------
+
+In the helper file:
+
+    module MyHelper
+    
+      class MyBlockHelper < BlockHelpers::BlockHelper
+      
+        def hello(name)
+          "<p>Hi there #{name}!</p>"
+        end
+      
+      end
+    
+    end
+
+This has generated a helper called `my_block_helper`.
+So in the view:
+
+    <% my_block_helper do |h| %>
+      Here goes...
+      <%= h.hello('Marmaduke') %>
+      ...hooray!
+    <% end %>
+
+This will generate the following:
+
+    Here goes...
+    <p>Hi there Marmaduke!</p>
+    ...hooray!
+
+Using arguments
+---------------
+
+You can pass in arguments to the helper, and these will be passed through to the class's `initialize` method.
+In the helper:
+
+    module MyHelper
+
+      class MyBlockHelper < BlockHelpers::BlockHelper
+  
+        def initialize(tag_type)
+          @tag_type = tag_type
+        end
+  
+        def hello(name)
+          content_tag @tag_type, "Hi there #{name}!"
+        end
+  
+      end
+
+    end
+
+In the view:
+
+    <% my_block_helper(:span) do |h| %>
+      <%= h.hello('Marmaduke') %>
+    <% end %>
+
+This generates:
+
+    <span>Hi there Marmaduke!</span>
+    
+Note that methods available in the helper (e.g. `content_tag`) are also available in the block helper class.
+
+Surrounding markup
+------------------
+
+Use the `to_s` method to surround the block with markup, e.g.
+In the helper:
+
+    module MyHelper
+
+      class RoundedBox < BlockHelpers::BlockHelper
+
+        def to_s(body)
+          %(
+            <div class="tl">
+              <div class="tr">
+                <div class="bl">
+                  <div class="br">
+                    #{body}
+                  </div>
+                </div>
+              </div>
+            </div>
+          )
+        end
+
+      end
+
+    end
+
+In the view:
+
+    <% rounded_box do %>
+      Oi oi!!!
+    <% end %>
+
+This generates:
+
+    <div class="tl">
+      <div class="tr">
+        <div class="bl">
+          <div class="br">
+            Oi oi!!!
+          </div>
+        </div>
+      </div>
+    </div>
+
+
+Installation
+============
+
+To use in Rails, add to your `environment.rb`:
+
+    config.gem "markevans-block_helpers", :lib => "block_helpers", :source => "http://gems.github.com"
+
+Copyright
+========
+
+Copyright (c) 2009 Mark Evans. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "block_helpers"
+    gem.summary = %Q{TODO}
+    gem.email = "mark@new-bamboo.co.uk"
+    gem.homepage = "http://github.com/markevans/block_helpers"
+    gem.authors = ["Mark Evans"]
+    gem.add_dependency('activesupport', '>= 2.0')
+    gem.add_dependency('actionpack', '>= 2.0')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "block_helpers #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/block_helpers.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{block_helpers}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Evans"]
+  s.date = %q{2009-07-20}
+  s.email = %q{mark@new-bamboo.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "block_helpers.gemspec",
+     "lib/block_helpers.rb",
+     "spec/for_spec_rails/application.rb",
+     "spec/helpers/block_helpers_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/markevans/block_helpers}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "spec/for_spec_rails/application.rb",
+     "spec/helpers/block_helpers_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0"])
+      s.add_runtime_dependency(%q<actionpack>, [">= 2.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.0"])
+      s.add_dependency(%q<actionpack>, [">= 2.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.0"])
+    s.add_dependency(%q<actionpack>, [">= 2.0"])
+  end
+end

data/lib/block_helpers.rb

@@ -0,0 +1,35 @@
+require 'activesupport'
+require 'action_view'
+
+module BlockHelpers
+  
+  class BlockHelper
+    
+    def self.inherited(klass)
+      # Define the helper method
+      # e.g. for a class:
+      #   class HelloHelper < BlockHelpers::BlockHelper
+      #     #.....
+      #   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)
+          if renderer.public_methods(false).include? 'to_s'
+            concat renderer.to_s(capture(renderer, &block))
+          else
+            block.call(renderer)
+          end
+        end
+      )
+      klass.class_eval do
+        include klass.parent
+      end
+    end
+    
+  end
+  
+end

data/spec/for_spec_rails/application.rb

@@ -0,0 +1,10 @@
+# Hacks to get spec/rails to work
+
+class ApplicationController < ActionController::Base
+end
+
+module Rails
+  module VERSION
+    STRING = '2.3.0'
+  end
+end

data/spec/helpers/block_helpers_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module TestHelperModule
+end
+
+describe TestHelperModule do
+
+  describe "simple block_helper" do
+    
+    before(:each) do
+      class TestHelperModule::TestHelper < BlockHelpers::BlockHelper
+        def hello
+          'Hi there'
+        end
+      end
+    end
+    
+    it "should make the named helper available" do
+      helper.should respond_to(:test_helper)
+    end
+    
+    it "should work for a simple yielded object" do
+      eval_erb(%(
+        <% test_helper do |h| %>
+          <p>Before</p>
+          <%= h.hello %>
+          <p>After</p>
+        <% end %>
+      )).should match_html("<p>Before</p> Hi there <p>After</p>")
+    end
+    
+  end
+  
+  describe "access to other methods" do
+    before(:each) do
+      module TestHelperModule
+        def yoghurt; 'Yoghurt'; end
+        class TestHelper
+          def yog
+            yoghurt[0..2]
+          end
+        end
+      end
+    end
+    it "should give the yielded renderer access to other methods" do
+      eval_erb(%(
+        <% test_helper do |r| %>
+          <%= r.yog %>
+        <% end %>
+      )).should match_html("Yog")
+    end
+  end
+  
+  describe "surrounding the block" do
+
+    before(:each) do
+      class TestHelperModule::TestHelperSurround < BlockHelpers::BlockHelper
+        def to_s(body)
+          %(
+            <p>Before</p>
+            #{body}
+            <p>After</p>
+          )
+        end
+      end
+    end
+
+    it "should surround a simple block" do
+      eval_erb(%(
+        <% test_helper_surround do %>
+          Body here!!!
+        <% end %>
+      )).should match_html("<p>Before</p> Body here!!! <p>After</p>")
+    end
+  end
+  
+  describe "block helpers with arguments" do
+    before(:each) do
+      class TestHelperModule::TestHelperWithArgs < BlockHelpers::BlockHelper
+        def initialize(id, klass)
+          @id, @klass = id, klass
+        end
+        def hello
+          %(<p class="#{@klass}" id="#{@id}">Hello</p>)
+        end
+      end
+    end
+    it "should use the args passed in" do
+      eval_erb(%(
+        <% test_helper_with_args('hello', 'there') do |r| %>
+          <%= r.hello %>
+        <% end %>
+      )).should match_html(%(<p class="there" id="hello">Hello</p>))
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+gem 'activesupport'
+gem 'actionpack'
+require File.dirname(__FILE__)+'/../lib/block_helpers'
+
+# Hacks to get spec/rails to work
+require 'action_controller'
+$:.unshift File.dirname(__FILE__)+'/for_spec_rails'
+RAILS_ENV = 'test'
+
+require 'spec'
+require 'spec/rails'
+
+Spec::Runner.configure do |config|
+end
+
+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
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: markevans-block_helpers
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+description: 
+email: mark@new-bamboo.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- block_helpers.gemspec
+- lib/block_helpers.rb
+- spec/for_spec_rails/application.rb
+- spec/helpers/block_helpers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/markevans/block_helpers
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- spec/for_spec_rails/application.rb
+- spec/helpers/block_helpers_spec.rb
+- spec/spec_helper.rb