show_for 0.2.5 → 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ec28a78975708c9329cdb9d30f82d98b713ab4f
+  data.tar.gz: 0c59a01bff303106a9a3adbe014ec55656f3b5a5
+SHA512:
+  metadata.gz: 655e5c23fc65094e2c833d985c9fdc4a8575c165d9bb969193ec8522f8efa5ac01f30235685a5cc112fc7b6f0a50220afbc560ba2bfcb40a0cce3544ff306072
+  data.tar.gz: 58ff69a4ffd41d8c628514b7e37064dad1b12a037011ca8b903e391dee776786f54145bfeb5b8a9988d6399d133556229f1ade3a3c12c20bc0f40d276035e4b0

data/CHANGELOG.rdoc

@@ -1,3 +1,16 @@
+== 0.2.6
+
+* enhancements
+  * Ruby 2.0 support.
+  * Add Haml template. (by github.com/nashby) Closes #12.
+  * Add `blank_html` tanslation. (by github.com/nashby)
+  * Add `show_for_class` configuration option. (by github.com/nashby)
+
+* bug fix
+  * Make show_for works with namespaced models. (by github.com/fabiokr)
+  * Add `blank_content_class` to the attributes. (by github.com/blakehilscher). Closes #24.
+  * Don't call `association.map` if association method is nil (by github.com/nashby). Closes #40.
+
 == 0.2.5
 
 * enhancements

data/lib/generators/show_for/install_generator.rb

@@ -2,6 +2,7 @@ module ShowFor
   module Generators
     class InstallGenerator < Rails::Generators::Base
       desc "Copy ShowFor installation files"
+      class_option :template_engine, :desc => 'Template engine to be invoked (erb or haml or slim).'
       source_root File.expand_path('../templates', __FILE__)
 
       def copy_initializers
@@ -13,8 +14,9 @@ module ShowFor
       end
 
       def copy_generator_template
-        copy_file 'show.html.erb', 'lib/templates/erb/scaffold/show.html.erb'
+        engine = options[:template_engine]
+        copy_file "show.html.#{engine}", "lib/templates/#{engine}/scaffold/show.html.#{engine}"
       end
     end
   end
-end
+end

data/lib/generators/show_for/templates/en.yml

@@ -1,5 +1,7 @@
 en:
   show_for:
     blank: "Not specified"
+    # If you want to use html tags with blank value use blank html translation
+    # blank_html: "<span>Not specified</span>"
     "yes": "Yes"
     "no": "No"

data/lib/generators/show_for/templates/show.html.haml

@@ -0,0 +1,8 @@
+= show_for(@<%= singular_name %>) do |s|
+<%- attributes.each do |attribute| -%>
+  = s.<%= attribute.reference? ? :association : :attribute %> :<%= attribute.name %>
+<% end -%>
+
+= link_to 'Edit', edit_<%= singular_name %>_path(@<%= singular_name %>)
+|
+= link_to 'Back', <%= plural_name %>_path

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

@@ -3,6 +3,9 @@ ShowFor.setup do |config|
   # The tag which wraps show_for calls.
   # config.show_for_tag = :div
 
+  # The DOM class set for show_for tag. Default is nil
+  # config.show_for_class = :custom
+
   # The tag which wraps each attribute/association call. Default is :p.
   # config.wrapper_tag = :dl
 

data/lib/show_for/association.rb

@@ -46,7 +46,10 @@ module ShowFor
       end
 
       method = options.delete(:using) || ShowFor.association_methods.find { |m| sample.respond_to?(m) }
-      association.is_a?(Array) ? association.map(&method) : association.try(method)
+
+      if method
+        association.is_a?(Array) ? association.map(&method) : association.try(method)
+      end
     end
   end
-end
+end

data/lib/show_for/builder.rb

@@ -19,17 +19,26 @@ module ShowFor
   protected
 
     def object_name #:nodoc:
-      @object_name ||= @object.class.name.underscore
+      @object_name ||= begin
+                         model_name = @object.class.model_name
+
+                         # TODO Remove this check when we drop support to Rails 3.0
+                         if model_name.respond_to?(:param_key)
+                           model_name.param_key
+                         else
+                           model_name.singular
+                         end
+                       end
     end
 
     def wrap_label_and_content(name, value, options, &block) #:nodoc:
       label = label(name, options, false)
       label += ShowFor.separator.to_s.html_safe if label.present?
-      wrap_with(:wrapper, label + content(value, options, false, &block), options)
+      wrap_with(:wrapper, label + content(value, options, false, &block), apply_wrapper_options!(:wrapper, options, value))
     end
 
     def wrap_content(name, value, options, &block) #:nodoc:
-      wrap_with(:wrapper, content(value, options, false, &block), options)
+      wrap_with(:wrapper, content(value, options, false, &block), apply_wrapper_options!(:wrapper, options, value))
     end
 
     # Set "#{object_name}_#{attribute_name}" as in the wrapper tag.
@@ -39,6 +48,12 @@ module ShowFor
       wrapper_html[:class] = "#{html_class} #{wrapper_html[:class]}".rstrip
     end
 
+    def apply_wrapper_options!(type, options, value)
+      options[:"#{type}_html"] ||= {}
+      options[:"#{type}_html"][:class] = [options[:"#{type}_html"][:class], ShowFor.blank_content_class].join(' ') if value.blank? && value != false
+      options
+    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.

data/lib/show_for/content.rb

@@ -1,9 +1,12 @@
 module ShowFor
   module Content
     def content(value, options={}, apply_options=true, &block)
+
+      # cache value for apply_wrapper_options!
+      sample_value = value
+
       if value.blank? && value != false
-        value = options.delete(:if_blank) || I18n.t(:'show_for.blank', :default => "Not specified")
-        options[:class] = [options[:class], ShowFor.blank_content_class].join(' ')
+        value = blank_value(options)
       end
 
       # We need to convert value to_a because when dealing with ActiveRecord
@@ -24,11 +27,15 @@ module ShowFor
         when NilClass, Numeric
           value.to_s
         else
-          value
+          if block
+            template.capture(value, &block)
+          else
+            value
+          end
       end
 
       options[:content_html] = options.except(:content_tag) if apply_options
-      wrap_with(:content, content, options)
+      wrap_with(:content, content, apply_wrapper_options!(:content, options, sample_value) )
     end
 
   protected
@@ -42,5 +49,17 @@ module ShowFor
 
       wrap_with(:collection, response, options)
     end
+
+    def translate_blank_html
+      template.t(:'show_for.blank_html', :default => translate_blank_text)
+    end
+
+    def translate_blank_text
+      I18n.t(:'show_for.blank', :default => "Not specified")
+    end
+
+    def blank_value(options)
+      options.delete(:if_blank) || translate_blank_html
+    end
   end
 end

data/lib/show_for/helper.rb

@@ -10,16 +10,24 @@ module ShowFor
     #   end
     #
     def show_for(object, html_options={}, &block)
+      html_options = html_options.dup
+
       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]}".rstrip
+      html_options[:class] = show_for_html_class(object, html_options)
 
       builder = html_options.delete(:builder) || ShowFor::Builder
       content = capture(builder.new(object, self), &block)
 
       content_tag(tag, content, html_options)
     end
+
+    private
+
+    def show_for_html_class(object, html_options)
+      "show_for #{dom_class(object)} #{html_options[:class]} #{ShowFor.show_for_class}".squeeze(" ").rstrip
+    end
   end
 end
 

data/lib/show_for/version.rb

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

data/lib/show_for.rb

@@ -7,6 +7,9 @@ module ShowFor
   mattr_accessor :show_for_tag
   @@show_for_tag = :div
 
+  mattr_accessor :show_for_class
+  @@show_for_class = nil
+
   mattr_accessor :label_tag
   @@label_tag = :strong
 

data/test/association_test.rb

@@ -30,6 +30,26 @@ class AssociationTest < ActionView::TestCase
     assert_select "div.show_for p.wrapper ul.collection li", "Tag 3"
   end
 
+  test "show_for works with has_many/has_and_belongs_to_many blank associations" do
+    def @user.tags
+      []
+    end
+
+    swap ShowFor, :association_methods => [:name] do
+      with_association_for @user, :tags
+      assert_no_select "div.show_for p.wrapper ul.collection"
+      assert_no_select "div.show_for p.wrapper", /Enumerator/
+    end
+  end
+
+  test "show_for accepts a block with an argument in belongs_to associations" do
+    with_association_for @user, :company do |company|
+      company.name.upcase
+    end
+
+    assert_select "div.show_for p.wrapper", /PLATAFORMATEC/
+  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"

data/test/attribute_test.rb

@@ -114,6 +114,13 @@ class AttributeTest < ActionView::TestCase
     end
   end
 
+  test "show_for accepts not spcified message can be localized with html" do
+    store_translations(:en, :show_for => { :blank_html => "<span>OMG! It's blank!</span>" }) do
+      with_attribute_for @user, :description
+      assert_select "div.show_for p.wrapper span", "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/
@@ -126,6 +133,13 @@ class AttributeTest < ActionView::TestCase
     assert_select "div.show_for p.wrapper", /This description/
   end
 
+  test "show_for#content given a block should be wrapped in the result" do
+    with_attribute_for @user, :name do |name|
+      "<div class='block'>#{name}</div>".html_safe
+    end
+    assert_select "p.wrapper.user_name div.block", /ShowFor/
+  end
+
   test "show_for escapes content by default" do
     @user.name = "<b>hack you!</b>"
     with_attribute_for @user, :name
@@ -164,4 +178,13 @@ class AttributeTest < ActionView::TestCase
     assert_select "div.show_for p.user_email.wrapper", /Not specified/
     assert_select "p.user_email strong.label", "Email"
   end
+
+  test "show_for should wrap blank attributes with no_attribute" do
+    swap ShowFor, :blank_content_class => 'no_attribute' do
+      with_attributes_for @user, :name, :birthday
+      assert_select ".wrapper.user_birthday.no_attribute"
+      assert_select ".wrapper.user_name.no_attribute", false
+    end
+  end
+
 end

data/test/builder_test.rb

@@ -18,6 +18,15 @@ class BuilderTest < ActionView::TestCase
     assert_select "div.show_for p.wrapper"
   end
 
+  test "show_for properly deals with namespaced models" do
+    @user = Namespaced::User.new(:id => 1, :name => "ShowFor")
+
+    with_attribute_for @user, :name
+    assert_select "div.show_for p.namespaced_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"

data/test/generators/show_for_generator_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class ShowForGeneratorTest < Rails::Generators::TestCase
+  tests ShowFor::Generators::InstallGenerator
+  destination File.expand_path('../../tmp', __FILE__)
+  setup :prepare_destination
+  teardown { rm_rf(destination_root) }
+
+  test 'generates example locale file' do
+    run_generator
+    assert_file 'config/locales/show_for.en.yml'
+  end
+
+  test 'generates the show_for initializer' do
+    run_generator
+    assert_file 'config/initializers/show_for.rb',
+      /config.show_for_tag = :div/
+  end
+
+  %W(erb haml).each do |engine|
+    test "generates the scaffold template when using #{engine}" do
+      run_generator ['-e', engine]
+      assert_file "lib/templates/#{engine}/scaffold/show.html.#{engine}"
+    end
+  end
+end

data/test/helper_test.rb

@@ -37,4 +37,18 @@ class HelperTest < ActionView::TestCase
       assert_select "p.show_for"
     end
   end
+
+  test "show for class should be configurable" do
+    swap ShowFor, :show_for_class => :awesome do
+      concat(show_for(@user) do |f| end)
+      assert_select "div.show_for.user.awesome"
+    end
+  end
+  
+  test "show for options hash should not be modified" do
+    html_options = { :show_for_tag => :li }
+    concat(show_for(@user, html_options) do |f| end)
+    assert_equal({ :show_for_tag => :li }, html_options)
+  end
+  
 end

data/test/support/models.rb

@@ -49,3 +49,8 @@ class User < OpenStruct
     "User"
   end
 end
+
+module Namespaced
+  class User < ::User
+  end
+end

data/test/test_helper.rb

@@ -9,6 +9,9 @@ require 'action_view'
 require 'action_view/template'
 require 'action_view/test_case'
 
+require "rails/generators/test_case"
+require 'generators/show_for/install_generator'
+
 $:.unshift File.expand_path("../../lib", __FILE__)
 require 'show_for'
 

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: show_for
 version: !ruby/object:Gem::Version
-  version: 0.2.5
-  prerelease: 
+  version: 0.2.6
 platform: ruby
 authors:
 - José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-12 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70225886718860 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70225886718860
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70225886718220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70225886718220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Wrap your objects with a helper to easily show them
 email: contact@plataformatec.com.br
 executables: []
@@ -44,6 +49,7 @@ files:
 - lib/generators/show_for/install_generator.rb
 - lib/generators/show_for/templates/en.yml
 - lib/generators/show_for/templates/show.html.erb
+- lib/generators/show_for/templates/show.html.haml
 - lib/generators/show_for/templates/show_for.rb
 - lib/generators/show_for/USAGE
 - lib/show_for/association.rb
@@ -58,6 +64,7 @@ files:
 - test/attribute_test.rb
 - test/builder_test.rb
 - test/content_test.rb
+- test/generators/show_for_generator_test.rb
 - test/helper_test.rb
 - test/label_test.rb
 - test/support/misc_helpers.rb
@@ -66,39 +73,33 @@ files:
 - test/value_test.rb
 homepage: http://github.com/plataformatec/show_for
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4500315708210946925
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4500315708210946925
 requirements: []
 rubyforge_project: show_for
-rubygems_version: 1.8.17
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wrap your objects with a helper to easily show them
 test_files:
 - test/association_test.rb
 - test/attribute_test.rb
 - test/builder_test.rb
 - test/content_test.rb
+- test/generators/show_for_generator_test.rb
 - test/helper_test.rb
 - test/label_test.rb
 - test/support/misc_helpers.rb