show_for 0.1

data/README.rdoc

@@ -0,0 +1,150 @@
+== ShowFor
+
+ShowFor allows you to quickly show a model information with I18n features.
+
+  <% show_for @user do |u| %>
+    <%= u.attribute :name %>
+    <%= u.attribute :confirmed? %>
+    <%= u.attribute :created_at, :format => :short %>
+    <%= u.attribute :last_sign_in_at, :if_blank => "User did not access yet"
+                    :wrapper_html => { :id => "sign_in_timestamp" } %>
+
+    <% u.attribute :photo do
+      <%= image_url(@user.photo_url) %>
+    end %>
+
+    <%= u.association :company %>
+    <%= u.association :tags, :to_sentence => true %>
+  <% end %>
+
+== Installation
+
+Install the gem:
+
+  sudo gem install show_for
+
+Configure simple_form gem inside your app:
+
+  config.gem 'show_for'
+
+Run the generator:
+
+  ruby script/generate show_for_install
+
+And you're ready to go.
+
+== Usage
+
+ShowFor allows you to quickly show a model information with I18n features.
+
+  <% show_for @admin do |a| %>
+    <%= a.attribute :name %>
+    <%= a.attribute :confirmed? %>
+    <%= a.attribute :created_at, :format => :short %>
+    <%= a.attribute :last_sign_in_at, :if_blank => "Administrator did not access yet"
+                    :wrapper_html => { :id => "sign_in_timestamp" } %>
+
+    <% a.attribute :photo do %>
+      <%= image_url(@admin.photo_url) %>
+    <% end %>
+  <% end %>
+
+Will generate something like:
+
+  <div id="admin_1" class="show_for admin">
+    <p class="wrapper admin_name">
+      <b class="label">Name</b><br />
+      José Valim
+    </p>
+    <p class="wrapper admin_confirmed">
+      <b class="label">Confirmed?</b><br />
+      Yes
+    </p>
+    <p class="wrapper admin_created_at">
+      <b class="label">Created at</b><br />
+      13/12/2009 - 19h17
+    </p>
+    <p id="sign_in_timestamp" class="wrapper admin_last_sign_in_at">
+      <b class="label">Last sign in at</b><br />
+      Administrator did not access yet
+    </p>
+    <p class="wrapper admin_photo">
+      <b class="label">Photo</b><br />
+      <img src="path/to/photo" />
+    </p>
+  </div>
+
+== Value lookup
+
+To show the proper value, before retrieving the attribute value, show_for first looks if a
+block without argument was given, otherwise checks if a :"human_#{attribute}" method is defined
+and, if not, only then retrieve the attribute.
+
+== Options
+
+show_for handles a series of options. Those are:
+
+* :escape * - When the attribute should be escaped. True by default.
+
+* :format * - Sent to I18n.localize when the attribute is a date/time object.
+
+* :if_blank * - An object to be used if the value is blank. Not escaped as well.
+
+Besides, all containers (:label, :content and :wrapper) can have their html
+options configured through the :label_html, :content_html and :wrapper_html
+options. Containers can have their tags configured on demand as well through
+:label_tag, :content_tag and :wrapper_tag options.
+
+== Label
+
+show_for also exposes the label method. In case you want to use the default
+human_attribute_name lookup and the default wrapping:
+
+  a.label :name                     #=> <b class="label">Name</b>
+  a.label "Name", :id => "my_name"  #=> <b class="label" id="my_name">Name</b>
+
+== Associations
+
+show_for also supports associations.
+
+  <% show_for @artwork do |a| %>
+    <%= a.association :artist %>
+    <%= a.association :artist, :method => :name_with_title %>
+
+    <%= a.association :tags %>
+    <%= a.association :tags, :to_sentence => true %>
+    <% a.association :tags do
+      @artwork.tags.map(&:name).to_sentence
+    end %>
+
+    <% a.association :fans, :collection_tag => :ol do |fan| %>
+      <li><%= link_to fan.name, fan %></li>
+    <% end %>
+  <% end %>
+
+The first is a has_one or belongs_to association, which works like an attribute
+to show_for, except it will retrieve the artist association and try to find a
+proper method from ShowFor.association_methods to be used. You can pass
+the option :method to tell (and not guess) which method from the association
+to use.
+
+:tags is a has_and_belongs_to_many association which will return a collection.
+show_for can handle collections by default by wrapping them in list (<ul> with
+each item wrapped by an <li>). However, it also allows you to give :to_sentence
+or :join it you want to render them inline.
+
+You can also pass a block which expects an argument to association. In such cases,
+a wrapper for the collection is still created and the block just iterates over the
+collection objects.
+
+== Contributors
+
+* José Valim (http://github.com/josevalim)
+
+== Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on GitHub.
+
+http://github.com/plataformatec/show_for/issues
+
+MIT License. Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/generators/show_for_install/USAGE

@@ -0,0 +1,3 @@
+To copy a ShowFor initializer to your Rails App, with some configuration values, just do:
+
+    script/generate show_for_install

data/generators/show_for_install/show_for_install_generator.rb

@@ -0,0 +1,19 @@
+class ShowForInstallGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory 'config/initializers'
+      m.template  'show_for.rb', 'config/initializers/show_for.rb'
+
+      m.directory 'config/locales'
+      m.template  locale_file, 'config/locales/show_for.en.yml'
+    end
+  end
+
+  private
+
+    def locale_file
+      @locale_file ||= '../../../lib/show_for/locale/en.yml'
+    end
+
+end

data/generators/show_for_install/templates/show_for.rb

@@ -0,0 +1,30 @@
+# Use this setup block to configure all options available in ShowFor.
+ShowFor.setup do |config|
+  # The tag which wraps show_for calls.
+  # config.show_for_tag = :div
+
+  # The tag which wraps each attribute/association call. Default is :p.
+  # config.wrapper_tag = :dl
+
+  # The tag used to wrap each label. Default is :strong.
+  # config.label_tag = :dt
+
+  # The tag used to wrap each content (value). Default is nil.
+  # config.content_tag = :dd
+
+  # The separator between label and content. Default is "<br />".
+  # config.separator = "<br />"
+
+  # The tag used to wrap collections. Default is :ul.
+  # config.collection_tag = :ul
+
+  # The default iterator to be used when invoking a collection/association.
+  # config.default_collection_proc = lambda { |value| "<li>#{value}</li>" }
+
+  # The default format to be used in I18n when localizing a Date/Time.
+  # config.i18n_format = :default
+
+  # Whenever a association is given, the first method in association_methods
+  # in which the association responds to is used to retrieve the association labels.
+  # config.association_methods = [ :name, :title, :to_s ]
+end

data/init.rb

@@ -0,0 +1 @@
+require 'show_for'

data/lib/show_for/builder.rb

@@ -0,0 +1,98 @@
+require 'show_for/content'
+require 'show_for/label'
+
+module ShowFor
+  class Builder
+    include ShowFor::Content
+    include ShowFor::Label
+
+    attr_reader :object, :template
+
+    def initialize(object, template)
+      @object, @template = object, template
+    end
+
+    def attribute(attribute_name, options={}, &block)
+      apply_default_options!(attribute_name, options)
+      collection_block, block = block, nil if collection_block?(block)
+
+      value = if block
+        block
+      elsif @object.respond_to?(:"human_#{attribute_name}")
+        @object.send :"human_#{attribute_name}"
+      else
+        @object.send(attribute_name)
+      end
+
+      wrap_label_and_content(attribute_name, value, options, &collection_block)
+    end
+
+    def association(association_name, options={}, &block)
+      apply_default_options!(association_name, options)
+    
+      # If a block with an iterator was given, no need to calculate the labels
+      # since we want the collection to be yielded. Otherwise, calculate the values.
+      value = if collection_block?(block)
+        collection_block = block
+        @object.send(association_name)
+      elsif block
+        block
+      else
+        association = @object.send(association_name)
+        values = retrieve_values_from_association(association, options)
+
+        if options.delete(:to_sentence)
+          values.to_sentence
+        elsif joiner = options.delete(:join)
+          values.join(joiner)
+        else
+          values
+        end
+      end
+
+      wrap_label_and_content(association_name, value, options, &collection_block)
+    end
+
+  protected
+
+    def object_name #:nodoc:
+      @object_name ||= @object.class.name.underscore
+    end
+
+    def wrap_label_and_content(name, value, options, &block) #:nodoc:
+      wrap_with(:wrapper, label(name, options, false) + ShowFor.separator.to_s +
+        content(value, options, false, &block), options, true, value.is_a?(Proc))
+    end
+
+    # Set "#{object_name}_#{attribute_name}" as in the wrapper tag.
+    def apply_default_options!(name, options) #:nodoc:
+      html_class = "#{object_name}_#{name}".gsub(/\W/, '')
+      wrapper_html = options[:wrapper_html] ||= {}
+      wrapper_html[:class] = "#{html_class} #{wrapper_html[:class]}".strip
+    end
+
+    # Gets the default tag set in ShowFor module and apply (if defined)
+    # around the given content. It also check for html_options in @options
+    # hash related to the current type.
+    def wrap_with(type, content, options, safe=false, concat=false) #:nodoc:
+      tag = options.delete(:"#{type}_tag") || ShowFor.send(:"#{type}_tag")
+
+      html = if tag
+        html_options = options.delete(:"#{type}_html") || {}
+        html_options[:class] = "#{type} #{html_options[:class]}".strip
+        @template.content_tag(tag, content, html_options)
+      else
+        content
+      end
+
+      html.html_safe! if safe && html.respond_to?(:html_safe!)
+      concat ? @template.concat(html) : html
+    end
+
+    def retrieve_values_from_association(association, options) #:nodoc:
+      sample = association.is_a?(Array) ? association.first : association
+      method = options[:method] || ShowFor.association_methods.find { |m| sample.respond_to?(m) }
+      association.is_a?(Array) ? association.map(&method) : association.try(method)
+    end
+  end
+end

data/lib/show_for/content.rb

@@ -0,0 +1,49 @@
+module ShowFor
+  module Content
+    def content(value, options={}, apply_options=true, &block)
+      value = options.delete(:if_blank) if value.blank? && value != false
+
+      content = case value
+        when Date, Time, DateTime
+          I18n.l value, :format => options.delete(:format) || ShowFor.i18n_format
+        when TrueClass
+          I18n.t :"show_for.yes", :default => "Yes"
+        when FalseClass
+          I18n.t :"show_for.no", :default => "No"
+        when Array, Hash
+          options[:escape] = false
+          collection_handler(value, options, &block)
+        when Proc
+          options[:escape] = false
+          @template.capture(&value)
+        when NilClass
+          ""
+        else
+          value
+      end
+
+      content = @template.send(:h, content) unless options.delete(:escape) == false
+      options[:content_html] = options.dup if apply_options
+      wrap_with(:content, content, options)
+    end
+
+  protected
+
+    def collection_handler(value, options, &block) #:nodoc:
+      iterator = collection_block?(block) ? block : ShowFor.default_collection_proc
+      response = ""
+
+      value.each do |item|
+        response << template.capture(item, &iterator)
+      end
+
+      wrap_with(:collection, response, options)
+    end
+
+    # Returns true if the block is supposed to iterate through a collection,
+    # i.e. it has arity equals to one.
+    def collection_block?(block) #:nodoc:
+      block && block.arity == 1
+    end
+  end
+end

data/lib/show_for/helper.rb

@@ -0,0 +1,25 @@
+module ShowFor
+  module Helper
+    # Creates a div around the object and yields a builder.
+    #
+    # Example:
+    #
+    #   show_for @user do |f|
+    #     f.attribute :name
+    #     f.attribute :email
+    #   end
+    #
+    def show_for(object, html_options={}, &block)
+      tag = html_options.delete(:show_for_tag) || ShowFor.show_for_tag
+
+      html_options[:id]  ||= dom_id(object)
+      html_options[:class] = "show_for #{dom_class(object)} #{html_options[:class]}".strip
+
+      concat(content_tag(tag, html_options) do
+        yield ShowFor::Builder.new(object, self)
+      end)
+    end
+  end
+end
+
+ActionView::Base.send :include, ShowFor::Helper

data/lib/show_for/label.rb

@@ -0,0 +1,23 @@
+module ShowFor
+  module Label
+    def label(text_or_attribute, options={}, apply_options=true)
+      label = if text_or_attribute.is_a?(String)
+        text_or_attribute
+      elsif options.key?(:label)
+        options.delete(:label)
+      else
+        human_attribute_name(text_or_attribute)
+      end
+
+      return "" if label == false
+      options[:label_html] = options.dup if apply_options
+      wrap_with :label, label, options
+    end
+
+  protected
+
+    def human_attribute_name(attribute) #:nodoc:
+      @object.class.human_attribute_name(attribute.to_s)
+    end
+  end
+end

data/lib/show_for/locale/en.yml

@@ -0,0 +1,4 @@
+en:
+  show_for:
+    "yes": 'Yes'
+    "no": 'No'

data/lib/show_for/version.rb

@@ -0,0 +1,3 @@
+module ShowFor
+  VERSION = "0.1".freeze
+end

data/lib/show_for.rb

@@ -0,0 +1,42 @@
+require 'show_for/helper'
+
+module ShowFor
+  autoload :Builder, 'show_for/builder'
+
+  mattr_accessor :show_for_tag
+  @@show_for_tag = :div
+
+  mattr_accessor :label_tag
+  @@label_tag = :strong
+
+  mattr_accessor :separator
+  @@separator = "<br />"
+
+  mattr_accessor :content_tag
+  @@content_tag = nil
+
+  mattr_accessor :wrapper_tag
+  @@wrapper_tag = :p
+
+  mattr_accessor :collection_tag
+  @@collection_tag = :ul
+
+  mattr_accessor :default_collection_proc
+  @@default_collection_proc = lambda { |value| "<li>#{value}</li>" }
+
+  mattr_accessor :i18n_format
+  @@i18n_format = :default
+
+  mattr_accessor :association_methods
+  @@association_methods = [ :name, :title, :to_s ]
+
+  # Yield self for configuration block:
+  #
+  #   ShowFor.setup do |config|
+  #     config.i18n_format = :long
+  #   end
+  #
+  def self.setup
+    yield self
+  end
+end

data/test/builder_test.rb

@@ -0,0 +1,305 @@
+require 'test_helper'
+
+class BuilderTest < ActionView::TestCase
+
+  def with_attribute_for(object, attribute, options={}, &block)
+    show_for object do |o|
+      concat(o.attribute(attribute, options, &block))
+    end
+  end
+
+  def with_association_for(object, association, options={}, &block)
+     show_for object do |o|
+       concat(o.association(association, options, &block))
+     end
+   end
+
+  def with_label_for(object, attribute, options={})
+    show_for object do |o|
+      concat o.label attribute, options
+    end
+  end
+
+  def with_content_for(object, value, options={})
+    show_for object do |o|
+      concat o.content value, options
+    end
+  end
+
+  # WRAPPER 
+  test "show_for attribute wraps each attribute with a label and content" do
+    with_attribute_for @user, :name
+    assert_select "div.show_for p.user_name.wrapper"
+    assert_select "div.show_for p.wrapper strong.label"
+    assert_select "div.show_for p.wrapper"
+  end
+
+  test "show_for allows wrapper tag to be changed by attribute" do
+    with_attribute_for @user, :name, :wrapper_tag => :span
+    assert_select "div.show_for span.user_name.wrapper"
+  end
+
+  test "show_for allows wrapper html to be configured by attribute" do
+    with_attribute_for @user, :name, :wrapper_html => { :id => "thewrapper", :class => "special" }
+    assert_select "div.show_for p#thewrapper.user_name.wrapper.special"
+  end
+
+  # SEPARATOR
+  test "show_for uses a separator if requested" do
+    with_attribute_for @user, :name
+    assert_select "div.show_for p.wrapper br"
+  end
+
+  test "show_for does not blow if a separator is not set" do
+    swap ShowFor, :separator => nil do
+      with_attribute_for @user, :name
+      assert_select "div.show_for p.wrapper"
+    end
+  end
+
+  # LABEL
+  test "show_for shows a label using the humanized attribute name from model" do
+    with_attribute_for @user, :name
+    assert_select "div.show_for p.wrapper strong.label", "Super User Name!"
+  end
+
+  test "show_for skips label if requested" do
+    with_attribute_for @user, :name, :label => false
+    assert_no_select "div.show_for p.wrapper strong.label"
+  end
+
+  test "show_for allows label to be configured globally" do
+    swap ShowFor, :label_tag => :span do
+      with_attribute_for @user, :name
+      assert_select "div.show_for p.wrapper span.label"
+    end
+  end
+
+  test "show_for allows label to be changed by attribute" do
+    with_attribute_for @user, :name, :label_tag => :span
+    assert_select "div.show_for p.wrapper span.label"
+  end
+
+  test "show_for allows label html to be configured by attribute" do
+    with_attribute_for @user, :name, :label_html => { :id => "thelabel", :class => "special" }
+    assert_select "div.show_for p.wrapper strong#thelabel.special.label"
+  end
+
+  test "show_for allows label to be set without lookup" do
+    with_attribute_for @user, :name, :label => "Special Label"
+    assert_select "div.show_for p.wrapper strong.label", "Special Label"
+  end
+
+  test "show_for#label accepts the text" do
+    with_label_for @user, "Special Label"
+    assert_select "div.show_for strong.label", "Special Label"
+  end
+
+  test "show_for#label accepts an attribute name" do
+    with_label_for @user, :name
+    assert_select "div.show_for strong.label", "Super User Name!"
+  end
+
+  test "show_for#label accepts html options" do
+    with_label_for @user, :name, :id => "thelabel", :class => "special"
+    assert_select "div.show_for strong#thelabel.special.label"
+  end
+
+  # CONTENT
+  test "show_for allows content tag to be configured globally" do
+    swap ShowFor, :content_tag => :span do
+      with_attribute_for @user, :name
+      assert_select "div.show_for p.wrapper span.content"
+    end
+  end
+
+  test "show_for allows content tag to be changed by attribute" do
+    with_attribute_for @user, :name, :content_tag => :span
+    assert_select "div.show_for p.wrapper span.content"
+  end
+
+  test "show_for allows content tag html to be configured by attribute" do
+    with_attribute_for @user, :name, :content_tag => :span, :content_html => { :id => "thecontent", :class => "special" }
+    assert_select "div.show_for p.wrapper span#thecontent.special.content"
+  end
+
+  test "show_for accepts an attribute as string" do
+    with_attribute_for @user, :name
+    assert_select "div.show_for p.wrapper", /ShowFor/
+  end
+
+  test "show_for accepts an attribute as time" do
+    with_attribute_for @user, :created_at
+    assert_select "div.show_for p.wrapper", /#{Regexp.escape(I18n.l(@user.created_at))}/
+  end
+
+  test "show_for accepts an attribute as date" do
+    with_attribute_for @user, :updated_at
+    assert_select "div.show_for p.wrapper", /#{Regexp.escape(I18n.l(@user.updated_at))}/
+  end
+
+  test "show_for accepts an attribute as time with format options" do
+    with_attribute_for @user, :created_at, :format => :long
+    assert_select "div.show_for p.wrapper", /#{Regexp.escape(I18n.l(@user.created_at, :format => :long))}/
+  end
+
+  test "show_for accepts an attribute as true" do
+    with_attribute_for @user, :active
+    assert_select "div.show_for p.wrapper", /Yes/
+  end
+
+  test "show_for accepts an attribute as true which can be localized" do
+    store_translations(:en, :show_for => { :yes => "Hell yeah!" }) do
+      with_attribute_for @user, :active
+      assert_select "div.show_for p.wrapper", /Hell yeah!/
+    end
+  end
+
+  test "show_for accepts an attribute as false" do
+    with_attribute_for @user, :invalid
+    assert_select "div.show_for p.wrapper", /No/
+  end
+
+  test "show_for accepts an attribute as false which can be localized" do
+    store_translations(:en, :show_for => { :no => "Hell no!" }) do
+      with_attribute_for @user, :invalid
+      assert_select "div.show_for p.wrapper", /Hell no!/
+    end
+  end
+
+  test "show_for accepts nil and or blank attributes" do
+    with_attribute_for @user, :description
+    assert_select "div.show_for p.wrapper", "Description"
+  end
+
+  test "show_for uses :if_blank if attribute is blank" do
+    with_attribute_for @user, :description, :if_blank => "No description provided"
+    assert_select "div.show_for p.wrapper", /No description provided/
+  end
+
+  test "show_for accepts a block to supply the content" do
+    with_attribute_for @user, :description do
+      "This description is not blank"
+    end
+    assert_select "div.show_for p.wrapper", /This description/
+  end
+
+  test "show_for escapes content by default" do
+    @user.name = "<b>hack you!</b>"
+    with_attribute_for @user, :name
+    assert_no_select "div.show_for p.wrapper b"
+    assert_select "div.show_for p.wrapper", /&lt;b&gt;/
+  end
+
+  test "show_for does not escape content if chosen" do
+    @user.name = "<b>hack you!</b>"
+    with_attribute_for @user, :name, :escape => false
+    assert_select "div.show_for p.wrapper b", "hack you!"
+  end
+
+  test "show_for#content accepts any object" do
+    with_content_for @user, "Special content"
+    assert_select "div.show_for", "Special content"
+  end
+
+  test "show_for#content accepts :if_blank as option" do
+     with_content_for @user, "", :if_blank => "Got blank"
+     assert_select "div.show_for", "Got blank"
+   end
+
+  test "show_for#content accepts html options" do
+    with_content_for @user, "Special content", :content_tag => :b, :id => "thecontent", :class => "special"
+    assert_select "div.show_for b#thecontent.special.content", "Special content"
+  end
+
+  # COLLECTIONS
+  test "show_for accepts an attribute as a collection" do
+    with_attribute_for @user, :scopes
+    assert_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper ul.collection li", :count => 3
+  end
+
+  test "show_for accepts an attribute as a collection with a block to iterate the collection" do
+    with_attribute_for @user, :scopes do |scope|
+      content_tag :span, scope
+    end
+    assert_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper ul.collection span", :count => 3
+  end
+
+  test "show_for allows collection tag to be configured globally" do
+    swap ShowFor, :collection_tag => :ol do
+      with_attribute_for @user, :scopes
+      assert_select "div.show_for p.wrapper ol.collection"
+    end
+  end
+
+  test "show_for allows collection tag to be changed by attribute" do
+    with_attribute_for @user, :scopes, :collection_tag => :ol
+    assert_select "div.show_for p.wrapper ol.collection"
+  end
+
+  test "show_for allows collection tag html to be configured by attribute" do
+    with_attribute_for @user, :scopes, :collection_html => { :id => "thecollection", :class => "special" }
+    assert_select "div.show_for p.wrapper ul#thecollection.special.collection"
+  end
+
+  # ASSOCIATIONS
+  test "show_for works with belongs_to/has_one associations" do
+    with_association_for @user, :company
+    assert_select "div.show_for p.wrapper", /PlataformaTec/
+  end
+
+  test "show_for accepts :method as option to tell how to retrieve association value" do
+    with_association_for @user, :company, :method => :alternate_name
+    assert_select "div.show_for p.wrapper", /Alternate PlataformaTec/
+  end
+
+  test "show_for works with has_many/has_and_belongs_to_many associations" do
+    with_association_for @user, :tags
+    assert_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper ul.collection li", "Tag 1"
+    assert_select "div.show_for p.wrapper ul.collection li", "Tag 2"
+    assert_select "div.show_for p.wrapper ul.collection li", "Tag 3"
+  end
+
+  test "show_for accepts :method as option to tell how to retrieve association values" do
+    with_association_for @user, :tags, :method => :alternate_name
+    assert_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper ul.collection li", "Alternate Tag 1"
+    assert_select "div.show_for p.wrapper ul.collection li", "Alternate Tag 2"
+    assert_select "div.show_for p.wrapper ul.collection li", "Alternate Tag 3"
+  end
+
+  test "show_for accepts :to_sentence as option in collection associations" do
+    with_association_for @user, :tags, :to_sentence => true
+    assert_no_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper", /Tag 1, Tag 2, and Tag 3/
+  end
+
+  test "show_for accepts :join as option in collection associations" do
+    with_association_for @user, :tags, :join => ", "
+    assert_no_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper", /Tag 1, Tag 2, Tag 3/
+  end
+
+  test "show_for accepts a block without argument in collection associations" do
+    with_association_for @user, :tags do
+      @user.tags.map(&:name).to_sentence
+    end
+    assert_no_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper", /Tag 1, Tag 2, and Tag 3/
+  end
+
+  test "show_for accepts a block with argument in collection associations" do
+    with_association_for @user, :tags, :collection_tag => :p do |tag|
+      assert_kind_of Tag, tag
+      content_tag(:span, tag.name)
+    end
+    assert_no_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper p.collection"
+    assert_select "div.show_for p.wrapper p.collection span", "Tag 1"
+    assert_select "div.show_for p.wrapper p.collection span", "Tag 2"
+    assert_select "div.show_for p.wrapper p.collection span", "Tag 3"
+  end
+end

data/test/helper_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+class HelperTest < ActionView::TestCase
+  test "show for yields an instance of ShowFor::Builder" do
+    show_for @user do |f|
+      assert f.instance_of?(ShowFor::Builder)
+    end
+  end
+
+  test "show for should add default class to form" do
+    show_for @user do |f| end
+    assert_select "div.show_for"
+  end
+
+  test "show for should add object class name as css class to form" do
+    show_for @user do |f| end
+    assert_select "div.show_for.user"
+  end
+
+  test "show for should pass options" do
+    show_for @user, :id => "my_div", :class => "common" do |f| end
+    assert_select "div#my_div.show_for.user.common"
+  end
+
+  test "show for tag should be configurable" do
+    swap ShowFor, :show_for_tag => :p do
+      show_for @user do |f| end
+      assert_select "p.show_for"
+    end
+  end
+end

data/test/support/misc_helpers.rb

@@ -0,0 +1,29 @@
+module MiscHelpers
+  def store_translations(locale, translations, &block)
+    begin
+      I18n.backend.store_translations locale, translations
+      yield
+    ensure
+      I18n.reload!
+    end
+  end
+
+  def assert_no_select(*args)
+    assert_raise Test::Unit::AssertionFailedError do
+      assert_select(*args)
+    end
+  end
+
+  def swap(object, new_values)
+    old_values = {}
+    new_values.each do |key, value|
+      old_values[key] = object.send key
+      object.send :"#{key}=", value
+    end
+    yield
+  ensure
+    old_values.each do |key, value|
+      object.send :"#{key}=", value
+    end
+  end
+end

data/test/support/models.rb

@@ -0,0 +1,45 @@
+require 'ostruct'
+
+class Company < Struct.new(:id, :name)
+  def alternate_name
+    "Alternate #{self.name}"
+  end
+end
+
+class Tag < Struct.new(:id, :name)
+  def self.all(options={})
+    (1..3).map{ |i| Tag.new(i, "Tag #{i}") }
+  end
+
+  def alternate_name
+    "Alternate #{self.name}"
+  end
+end
+
+class User < OpenStruct
+  # Get rid of deprecation warnings
+  undef_method :id
+
+  def tags
+    Tag.all
+  end
+
+  def company
+    Company.new(1, "PlataformaTec")
+  end
+
+  def self.human_attribute_name(attribute)
+    case attribute
+      when 'name'
+        'Super User Name!'
+      when 'company'
+        'Company Human Name!'
+      else
+        attribute.humanize
+    end
+  end
+
+  def self.human_name
+    "User"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'test/unit'
+
+require 'action_controller'
+require 'action_view/test_case'
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib', 'show_for')
+require 'show_for'
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each { |f| require f }
+I18n.default_locale = :en
+
+class ActionView::TestCase
+  include MiscHelpers
+
+  tests ShowFor::Helper
+
+  setup :setup_new_user
+
+  def setup_new_user(options={})
+    @user = User.new({
+      :id => 1,
+      :name => 'ShowFor',
+      :description => '',
+      :active => true,
+      :invalid => false,
+      :scopes => ["admin", "manager", "visitor"],
+      :created_at => Time.now,
+      :updated_at => Date.today
+    }.merge(options))
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: show_for
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Jos\xC3\xA9 Valim"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-08 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Wrap your objects with a helper to easily show them
+email: contact@plataformatec.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- generators/show_for_install/USAGE
+- generators/show_for_install/show_for_install_generator.rb
+- generators/show_for_install/templates/show_for.rb
+- init.rb
+- lib/show_for.rb
+- lib/show_for/builder.rb
+- lib/show_for/content.rb
+- lib/show_for/helper.rb
+- lib/show_for/label.rb
+- lib/show_for/locale/en.yml
+- lib/show_for/version.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/plataformatec/show_for
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Wrap your objects with a helper to easily show them
+test_files: 
+- test/builder_test.rb
+- test/helper_test.rb
+- test/support/misc_helpers.rb
+- test/support/models.rb
+- test/test_helper.rb