show_for 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e66b71c090111795d5eefc080a133ef63f3c752
-  data.tar.gz: 6751105eb644a59ced4b9f3e96ce94c3ad791dc3
+  metadata.gz: bf7d8896e8ef6cf4029dec5b1be980ab4fdda13c
+  data.tar.gz: 8bcebe6966ece81c1485ce5fb94b691601817433
 SHA512:
-  metadata.gz: 0e139c076881532aca65b6678797499cd4fafe74e32d620a993d17bc6ac4cfa734988f44b445b2ac245ae4cd86c5949ded1afad7fe5b12c2b3f4078b6f62936a
-  data.tar.gz: 4626283fc1e8e5f72b987f986010e8f591e20a25cfb95a77553e0b9c9f86af356bc7670a610f310b1c9c73048f33e408b9a04aef0585b0801817896bfe0043db
+  metadata.gz: 2f87342c9090ec41e3e52e12a2aa5b78f54707060c26240b23d91f50a2f1883aa3c3e95c87b6d53064bf9c1168e2f12105db5c7c16caef43a5b9f1d0c287ec74
+  data.tar.gz: 90ae998a6a90834359f9df100d55e7fb525a3e5d97ecc0b90e6c70fcb311f93b9a6cfd2aee8e2931ef18448f9c46017298577306b337829562c10d8b4a5c77de

data/CHANGELOG.md

@@ -0,0 +1,117 @@
+## 0.4.0
+
+### enhancements
+  * Change default `wrapper_tag` to generate a `div` instead of `p`. The `p` tag generates
+    invalid HTML with collections: `p > ul`, and failed tests on Rails 4.2. If you depend
+    on the `p` tag being generated, change your Show For config to set `wrapper_tag` to `:p`.
+  * Remove deprecated `:method` in favor of `:using`.
+  * Improve support to Rails 4.x associations with more duck typing instead of Array checks.
+  * Support Rails 4.1/4.2 and Ruby 2.1/2.2.
+  * Add `skip_blanks` configuration option to skip generating blank attributes
+    instead of generating them with a default message. (by github.com/moktin)
+  * Add `slim` template for the install generator. (by github.com/voanhduy1512)
+  * Add `separator` option that overrides the global configuration (by github.com/bernardofire)
+
+### bugfix
+  * Do not yield default blank value to the block when using an empty association. (by github.com/aptinio)
+
+## 0.3.0
+
+### bug fix
+  * Fix blank value not being applied when using a block. (by github.com/tfwright)
+
+## 0.3.0.rc
+
+### enhancements
+  * Support Rails 4.
+  * Drop support to Rails < 3.2 and Ruby 1.8.
+
+## 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
+  * Add a `:value` option for attribute (by github.com/ml-gt)
+  * Add `label_class`, `content_class`, `wrapper_class` and `collection_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
+  * Do not add separator if label is not present (by github.com/eugenebolshakov)
+  * Add method for output value only (by github.com/jenkek)
+
+### bug fix
+  * Fix empty labels to be `html_safe` (label => false) (by github.com/eugenebolshakov)
+
+## 0.2.3
+
+### enhancements
+  * added :attributes method to generate all attributes given
+  * update generator to use the new syntax show_for:install
+
+### bug fix
+  * fix numeric types
+
+## 0.2.2
+
+### bug fix
+  * allow show_for to work with AR association proxies
+
+### enhancements
+  * improvements on html safe and output buffers
+
+## 0.2.1
+
+### enhancements
+  * added label_proc
+  * compatibility with latest Rails
+
+## 0.2.0
+
+### enhancements
+  * Rails 3 compatibility
+
+## 0.1.4
+
+### bug fix
+  * allow show_for to work with AR association proxies
+
+## 0.1.3
+
+### enhancements
+  * allow builder to be given to show_for
+
+### bug fix
+  * Fix typo in yaml
+
+## 0.1.2
+
+### enhancements
+  * allow `f.attribute :nickname, :in => :profile` as association shortcut
+
+### deprecations
+  * `:method` now becomes `:using`
+
+## 0.1.1
+
+### enhancements
+  * HAML compatibility (by github.com/grimen)
+  * blank_content support (by github.com/grimen)
+
+## 0.1
+
+### First release

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 PlataformaTec http://blog.plataformatec.com.br/
+Copyright (c) 2012-2015 Plataformatec http://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/README.md

@@ -0,0 +1,225 @@
+# ShowFor
+
+[![Gem Version](https://fury-badge.herokuapp.com/rb/show_for.png)](http://badge.fury.io/rb/show_for)
+[![Build Status](https://api.travis-ci.org/plataformatec/show_for.png?branch=master)](http://travis-ci.org/plataformatec/show_for)
+[![Code Climate](https://codeclimate.com/github/plataformatec/show_for.png)](https://codeclimate.com/github/plataformatec/show_for)
+
+ShowFor allows you to quickly show a model information with I18n features.
+
+```erb
+<%= show_for @user do |u| %>
+  <%= u.attribute :name %>
+  <%= u.attribute :nickname, :in => :profile %>
+  <%= 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_tag(@user.photo_url) %>
+  <% end %>
+
+  <%= u.association :company %>
+  <%= u.association :tags, :to_sentence => true %>
+<% end %>
+```
+
+## Installation
+
+Install the gem:
+
+    gem install show_for
+
+Or add ShowFor to your Gemfile and bundle it up:
+
+    gem 'show_for'
+
+Run the generator:
+
+    rails generate show_for:install
+
+And you are ready to go.
+
+Note: This branch aims Rails 3.2 and 4 support, so if you want to use it with
+older versions of Rails, check out the available branches.
+
+## Usage
+
+ShowFor allows you to quickly show a model information with I18n features.
+
+```erb
+<%= show_for @admin do |a| %>
+  <%= a.attribute :name %>
+  <%= a.attribute :login, :value => :upcase %>
+  <%= 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_tag(@admin.photo_url) %>
+  <% end %>
+
+  <% a.value :biography %>
+<% end %>
+```
+
+Will generate something like:
+
+```html
+<div id="admin_1" class="show_for admin">
+  <div class="wrapper admin_name">
+    <strong class="label">Name</strong><br />
+    José Valim
+  </div>
+  <div class="wrapper admin_login">
+    <strong class="label">Login</strong><br />
+    JVALIM
+  </div>
+  <div class="wrapper admin_confirmed">
+    <strong class="label">Confirmed?</strong><br />
+    Yes
+  </div>
+  <div class="wrapper admin_created_at">
+    <strong class="label">Created at</strong><br />
+    13/12/2009 - 19h17
+  </div>
+  <div id="sign_in_timestamp" class="wrapper admin_last_sign_in_at">
+    <strong class="label">Last sign in at</strong><br />
+    Administrator did not access yet
+  </div>
+  <div class="wrapper admin_photo">
+    <strong class="label">Photo</strong><br />
+    <img src="path/to/photo" />
+  </div>
+  <div class="wrapper admin_biography">
+    Etiam porttitor eros ut diam vestibulum et blandit lectus tempor. Donec
+    venenatis fermentum nunc ac dignissim. Pellentesque volutpat eros quis enim
+    mollis bibendum. Ut cursus sem ac sem accumsan nec porttitor felis luctus.
+    Sed purus nunc, auctor vitae consectetur pharetra, tristique non nisi.
+  </div>
+</div>
+```
+
+You can also show a list of attributes, useful if you don't need to change any configuration:
+
+```erb
+<%= show_for @admin do |a| %>
+  <%= a.attributes :name, :confirmed?, :created_at %>
+<% end %>
+```
+
+## Value lookup
+
+ShowFor uses the following sequence to get the attribute value:
+
+* use the output of a block argument if given
+* use the output of the `:value` argument if given
+* check if a `:"human_#{attribute}"` method is defined
+* retrieve the attribute directly.
+
+## Options
+
+ShowFor handles a series of options. Those are:
+
+* __:format__ - Sent to `I18n.localize` when the attribute is a date/time object.
+
+* __:value__ - Can be used instead of block. If a `Symbol` is called as instance method.
+
+* __:if_blank__ - An object to be used if the value is blank. Not escaped as well.
+
+* __:separator__ - The piece of html that separates label and content, overriding the global configuration.
+
+In addition, 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
+
+ShowFor also exposes the label method. In case you want to use the default
+`human_attribute_name` lookup and the default wrapping:
+
+```ruby
+a.label :name                     #=> <strong class="label">Name</strong>
+a.label "Name", :id => "my_name"  #=> <strong class="label" id="my_name">Name</strong>
+```
+
+Optionally, if you want to wrap the inner part of the label with some text
+(e.g. adding a semicolon), you can do so by specifying a proc for `ShowFor.label_proc`
+that will be called with any label text. E.g.:
+
+```ruby
+  ShowFor.label_proc = lambda { |l| l + ":" }
+```
+
+When taking this route, you can also skip on a per label basis by passing the
+`:wrap_label` option with a value of false.
+
+## Associations
+
+ShowFor also supports associations.
+
+```erb
+<%= show_for @artwork do |a| %>
+  <%= a.association :artist %>
+  <%= a.association :artist, :using => :name_with_title %>
+  <%= a.attribute :name_with_title, :in => :artist %>
+
+  <%= 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 ShowFor, 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 :using 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.
+ShowFor 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.
+
+Here are some other examples of the many possibilites to custom the output content:
+
+```erb
+<%= u.association :relationships, :label => 'test' do  %>
+  <% @user.relationships.each do |relation| %>
+    <%= relation.related_user.name if relation.related_user_role == 'supervisor' %>
+  <% end %>
+<% end %>
+
+<%= u.attribute :gender do  %>
+  <%= content_tag :span, t("helpers.enum_select.user.gender.#{@user.gender}") %>
+<% end %>
+```
+
+## Maintainers
+
+* José Valim (http://github.com/josevalim)
+* Carlos Antonio da Silva (https://github.com/carlosantoniodasilva)
+
+## Contributors
+
+* Jonas Grimfelt (http://github.com/grimen)
+
+## 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 2012-2015 Plataformatec. http://plataformatec.com.br

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

@@ -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

@@ -9,21 +9,36 @@ ShowFor.setup do |config|
   # The tag which wraps each attribute/association call. Default is :p.
   # config.wrapper_tag = :dl
 
+  # The DOM class set for the wrapper tag. Default is :wrapper.
+  # config.wrapper_class = :custom
+
   # The tag used to wrap each label. Default is :strong.
   # config.label_tag = :dt
 
+  # The DOM class of each label tag. Default is :label.
+  # config.label_class = :custom
+
   # The tag used to wrap each content (value). Default is nil.
   # config.content_tag = :dd
 
+  # The DOM class of each content tag. Default is :content.
+  # config.content_class = :custom
+
   # The DOM class set for blank content tags. Default is "blank".
   # config.blank_content_class = 'no_content'
 
+  # Skip blank attributes instead of generating with a default message. Default is false.
+  # config.skip_blanks = true
+
   # 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 DOM class set for the collection tag. Default is :collection.
+  # config.collection_class = :custom
+
   # The default iterator to be used when invoking a collection/association.
   # config.default_collection_proc = lambda { |value| "<li>#{ERB::Util.h(value)}</li>".html_safe }
 

data/lib/show_for.rb

@@ -28,8 +28,11 @@ module ShowFor
   mattr_accessor :blank_content_class
   @@blank_content_class = "blank"
 
+  mattr_accessor :skip_blanks
+  @@skip_blanks = false
+
   mattr_accessor :wrapper_tag
-  @@wrapper_tag = :p
+  @@wrapper_tag = :div
 
   mattr_accessor :wrapper_class
   @@wrapper_class = :wrapper

data/lib/show_for/association.rb

@@ -38,17 +38,11 @@ module ShowFor
   protected
 
     def values_from_association(association, options) #:nodoc:
-      sample = association.is_a?(Array) ? association.first : association
-
-      if options[:method]
-        options[:using] = options.delete(:method)
-        ActiveSupport::Deprecation.warn ":method is deprecated. Please use :using instead", caller
-      end
-
+      sample = association.respond_to?(:to_ary) ? association.first : association
       method = options.delete(:using) || ShowFor.association_methods.find { |m| sample.respond_to?(m) }
 
       if method
-        association.is_a?(Array) ? association.map(&method) : association.try(method)
+        association.respond_to?(:to_ary) ? association.map(&method) : association.try(method)
       end
     end
   end

data/lib/show_for/builder.rb

@@ -32,8 +32,11 @@ module ShowFor
     end
 
     def wrap_label_and_content(name, value, options, &block) #:nodoc:
+      return if skip_blanks?(value)
       label = label(name, options, false)
-      label += ShowFor.separator.to_s.html_safe if label.present?
+      if label.present? && separator = options.fetch(:separator) { ShowFor.separator }
+        label += separator.html_safe
+      end
       wrap_with(:wrapper, label + content(value, options, false, &block), apply_wrapper_options!(:wrapper, options, value))
     end
 
@@ -58,6 +61,7 @@ module ShowFor
     # around the given content. It also check for html_options in @options
     # hash related to the current type.
     def wrap_with(type, content, options) #:nodoc:
+      return if skip_blanks?(content)
       tag = options.delete(:"#{type}_tag") || ShowFor.send(:"#{type}_tag")
 
       if tag
@@ -75,6 +79,11 @@ module ShowFor
     def collection_block?(block) #:nodoc:
       block && block.arity == 1
     end
+
+    # Verifies whether the value is blank and its configured to skip blank values.
+    def skip_blanks?(value) #:nodoc:
+      ShowFor.skip_blanks && value.blank? && value != false
+    end
   end
 end