show_for 0.2.4 → 0.2.5

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 0.2.5
+
+* enhancements
+  * Add a :value option for attribute (by github.com/ml-gt)
+  * Add label_class, content_class, wrapper_class and content_class configuration options (by github.com/wojtekmach)
+
+* bug fix
+  * Fix problem with label => false and html_safe (label => false) (by github.com/nashby)
+
 == 0.2.4
 
 * enhancements

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 PlataformaTec http://blog.plataformatec.com.br/
+Copyright (c) 2012 PlataformaTec http://blog.plataformatec.com.br/
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/generators/show_for/templates/show_for.rb

@@ -22,7 +22,7 @@ ShowFor.setup do |config|
   # config.collection_tag = :ul
 
   # The default iterator to be used when invoking a collection/association.
-  # config.default_collection_proc = lambda { |value| "<li>#{value}</li>" }
+  # config.default_collection_proc = lambda { |value| "<li>#{ERB::Util.h(value)}</li>".html_safe }
 
   # The default format to be used in I18n when localizing a Date/Time.
   # config.i18n_format = :default

data/lib/show_for/association.rb

@@ -21,7 +21,7 @@ module ShowFor
         block
       else
         association = @object.send(association_name)
-        values = retrieve_values_from_association(association, options)
+        values = values_from_association(association, options)
 
         if options.delete(:to_sentence)
           values.to_sentence
@@ -37,7 +37,7 @@ module ShowFor
 
   protected
 
-    def retrieve_values_from_association(association, options) #:nodoc:
+    def values_from_association(association, options) #:nodoc:
       sample = association.is_a?(Array) ? association.first : association
 
       if options[:method]

data/lib/show_for/attribute.rb

@@ -2,15 +2,10 @@ module ShowFor
   module Attribute
     def attribute(attribute_name, options={}, &block)
       apply_default_options!(attribute_name, options)
+      block = block_from_value_option(attribute_name, options) unless block
       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
+      value = attribute_value(attribute_name, &block)
 
       wrap_label_and_content(attribute_name, value, options, &collection_block)
     end
@@ -19,20 +14,48 @@ module ShowFor
       apply_default_options!(attribute_name, options)
       collection_block, block = block, nil if collection_block?(block)
 
-      value = if block
+      value = attribute_value(attribute_name, &block)
+
+      wrap_content(attribute_name, value, options, &collection_block)
+    end
+
+    def attributes(*attribute_names)
+      attribute_names.map do |attribute_name|
+        attribute(attribute_name)
+      end.join.html_safe
+    end
+
+  private
+
+    def attribute_value(attribute_name, &block)
+      if block
         block
       elsif @object.respond_to?(:"human_#{attribute_name}")
         @object.send :"human_#{attribute_name}"
       else
         @object.send(attribute_name)
       end
-      wrap_content(attribute_name, value, options, &collection_block)
     end
 
-    def attributes(*attribute_names)
-      attribute_names.map do |attribute_name|
-        attribute(attribute_name)
-      end.join.html_safe
+    def block_from_value_option(attribute_name, options)
+      case options[:value]
+      when nil
+        nil
+      when Symbol
+        block_from_symbol(attribute_name, options)
+      else
+        lambda { options[:value] }
+      end
+    end
+
+    def block_from_symbol(attribute_name, options)
+      attribute = @object.send(attribute_name)
+      case attribute
+      when Array, Hash
+        lambda { |element| element.send(options[:value]) }
+      else
+        lambda { attribute.send(options[:value]) }
+      end
     end
   end
 end

data/lib/show_for/builder.rb

@@ -36,7 +36,7 @@ module ShowFor
     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
+      wrapper_html[:class] = "#{html_class} #{wrapper_html[:class]}".rstrip
     end
 
     # Gets the default tag set in ShowFor module and apply (if defined)
@@ -45,15 +45,14 @@ module ShowFor
     def wrap_with(type, content, options) #:nodoc:
       tag = options.delete(:"#{type}_tag") || ShowFor.send(:"#{type}_tag")
 
-      html = if tag
+      if tag
+        type_class = ShowFor.send :"#{type}_class"
         html_options = options.delete(:"#{type}_html") || {}
-        html_options[:class] = "#{type} #{html_options[:class]}".strip
+        html_options[:class] = "#{type_class} #{html_options[:class]}".rstrip
         @template.content_tag(tag, content, html_options)
       else
         content
       end
-
-      html
     end
 
     # Returns true if the block is supposed to iterate through a collection,

data/lib/show_for/content.rb

@@ -27,7 +27,7 @@ module ShowFor
           value
       end
 
-      options[:content_html] = options.dup if apply_options
+      options[:content_html] = options.except(:content_tag) if apply_options
       wrap_with(:content, content, options)
     end
 
@@ -35,13 +35,12 @@ module ShowFor
 
     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
+      response = value.map do |item|
+        template.capture(item, &iterator)
+      end.join.html_safe
 
-      wrap_with(:collection, response.html_safe, options)
+      wrap_with(:collection, response, options)
     end
   end
-end
+end

data/lib/show_for/helper.rb

@@ -13,7 +13,7 @@ module ShowFor
       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
+      html_options[:class] = "show_for #{dom_class(object)} #{html_options[:class]}".rstrip
 
       builder = html_options.delete(:builder) || ShowFor::Builder
       content = capture(builder.new(object, self), &block)

data/lib/show_for/label.rb

@@ -9,7 +9,7 @@ module ShowFor
         human_attribute_name(text_or_attribute)
       end
 
-      return nil.to_s if label == false
+      return ''.html_safe if label == false
       options[:label_html] = options.dup if apply_options
 
       label = ShowFor.label_proc.call(label) if options.fetch(:wrap_label, true) && ShowFor.label_proc

data/lib/show_for/version.rb

@@ -1,3 +1,3 @@
 module ShowFor
-  VERSION = "0.2.4".freeze
+  VERSION = "0.2.5".freeze
 end

data/lib/show_for.rb

@@ -1,3 +1,4 @@
+require 'action_view'
 require 'show_for/helper'
 
 module ShowFor
@@ -9,21 +10,33 @@ module ShowFor
   mattr_accessor :label_tag
   @@label_tag = :strong
 
+  mattr_accessor :label_class
+  @@label_class = :label
+
   mattr_accessor :separator
   @@separator = "<br />"
 
   mattr_accessor :content_tag
   @@content_tag = nil
 
+  mattr_accessor :content_class
+  @@content_class = :content
+
   mattr_accessor :blank_content_class
   @@blank_content_class = "blank"
 
   mattr_accessor :wrapper_tag
   @@wrapper_tag = :p
 
+  mattr_accessor :wrapper_class
+  @@wrapper_class = :wrapper
+
   mattr_accessor :collection_tag
   @@collection_tag = :ul
 
+  mattr_accessor :collection_class
+  @@collection_class = :collection
+
   mattr_accessor :default_collection_proc
   @@default_collection_proc = lambda { |value| "<li>#{ERB::Util.html_escape(value)}</li>".html_safe }
 
@@ -32,7 +45,7 @@ module ShowFor
 
   mattr_accessor :association_methods
   @@association_methods = [ :name, :title, :to_s ]
-  
+
   mattr_accessor :label_proc
   @@label_proc = nil
 
@@ -45,4 +58,4 @@ module ShowFor
   def self.setup
     yield self
   end
-end
+end

data/test/association_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class AssociationTest < ActionView::TestCase
+  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 :using as option to tell how to retrieve association value" do
+    with_association_for @user, :company, :using => :alternate_name
+    assert_select "div.show_for p.wrapper", /Alternate PlataformaTec/
+  end
+
+  test "show_for accepts :in to tell to retrieve an attribute from association" do
+    with_attribute_for @user, :alternate_name, :in => :company
+    assert_select "div.show_for p.wrapper", /Alternate PlataformaTec/
+  end
+
+  test "show_for forwards all options send with :in to association" do
+    with_attribute_for @user, :alternate_name, :in => :tags, :to_sentence => true
+    assert_no_select "div.show_for p.wrapper ul.collection"
+    assert_select "div.show_for p.wrapper", /Alternate Tag 1, Alternate Tag 2, and Alternate Tag 3/
+  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 :using as option to tell how to retrieve association values" do
+    with_association_for @user, :tags, :using => :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/attribute_test.rb

@@ -0,0 +1,167 @@
+require 'test_helper'
+
+class AttributeTest < ActionView::TestCase
+  # 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 treats symbol for :value as method on each element of collection" do
+    with_attribute_for @user, :scopes, :value => :upcase
+    @user.scopes.each do |scope|
+      assert_select "div.show_for p.wrapper ul.collection", /#{scope.upcase}/
+    end
+  end
+
+  test "show_for allows collection tag to be configured globally" do
+    swap ShowFor, :collection_tag => :ol, :collection_class => "my_collection" do
+      with_attribute_for @user, :scopes
+      assert_select "div.show_for p.wrapper ol.my_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
+
+  # CONTENT
+  test "show_for allows content tag to be configured globally" do
+    swap ShowFor, :content_tag => :span, :content_class => :my_content do
+      with_attribute_for @user, :name
+      assert_select "div.show_for p.wrapper span.my_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", /Not specified/
+  end
+
+  test "show_for accepts not spcified message can be localized" do
+    store_translations(:en, :show_for => { :blank => "OMG! It's blank!" }) do
+      with_attribute_for @user, :description
+      assert_select "div.show_for p.wrapper", /OMG! It's blank!/
+    end
+  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 works with html_safe marked strings" do
+    @user.name = "<b>hack you!</b>".html_safe
+    with_attribute_for @user, :name
+    assert_select "div.show_for p.wrapper b", "hack you!"
+  end
+
+  test "show_for uses :value if supplied" do
+    with_attribute_for @user, :name, :value => "Calculated Value"
+    assert_select "div.show_for p.wrapper", /Calculated Value/
+  end
+
+  test "show_for ignores :value if a block is supplied" do
+    with_attribute_for @user, :name, :value => "Calculated Value" do
+      @user.name.upcase
+    end
+    assert_select "div.show_for p.wrapper", /#{@user.name.upcase}/
+  end
+
+  test "show_for treats symbol for :value as method on attribute" do
+    with_attribute_for @user, :name, :value => :upcase
+    assert_select "div.show_for p.wrapper", /#{@user.name.upcase}/
+  end
+
+  # ATTRIBUTES
+  test "show_for attributes wraps each attribute with a label and content" do
+    with_attributes_for @user, :name, :email
+    assert_select "div.show_for p.user_name.wrapper", /ShowFor/
+    assert_select "p.user_name strong.label", "Super User Name!"
+    assert_select "div.show_for p.user_email.wrapper", /Not specified/
+    assert_select "p.user_email strong.label", "Email"
+  end
+end