show_for 0.2.3 → 0.2.4

data/.gitignore

@@ -0,0 +1 @@
+.bundle/

data/CHANGELOG.rdoc

@@ -0,0 +1,67 @@
+== 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
+
+* bugfix
+  * 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/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem 'rails', '~> 3.0.0'
+
+if RUBY_VERSION < "1.9"
+  gem "ruby-debug"
+else
+  gem "test-unit"
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.4)
+    builder (2.1.2)
+    columnize (0.3.1)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    linecache (0.43)
+    mail (2.2.10)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (~> 3.0.0)
+  ruby-debug

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 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
+"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.rdoc

@@ -24,9 +24,13 @@ Install the gem:
 
   sudo 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
+  rails generate show_for:install
 
 And you are ready to go. Since this branch is aims Rails 3 support,
 if you want to use it with Rails 2.3 you should check this branch:
@@ -47,6 +51,8 @@ ShowFor allows you to quickly show a model information with I18n features.
     <% a.attribute :photo do %>
       <%= image_tag(@admin.photo_url) %>
     <% end %>
+
+    <% a.value :biography %>
   <% end %>
 
 Will generate something like:
@@ -72,6 +78,11 @@ Will generate something like:
       <strong class="label">Photo</strong><br />
       <img src="path/to/photo" />
     </p>
+    <p 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.
+    </p>
   </div>
 
 You also have the possibility to show a list of attributes, useful if you don't need to change any configuration:
@@ -168,3 +179,4 @@ If you discover any bugs or want to drop a line, feel free to create an issue on
 http://github.com/plataformatec/show_for/issues
 
 MIT License. Copyright 2010 Plataforma Tecnologia. http://blog.plataformatec.com.br
+

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the show_form plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the show_for plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ShowFor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

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

@@ -33,5 +33,5 @@ ShowFor.setup do |config|
 
   # If you want to wrap the text inside a label (e.g. to append a semicolon),
   # specify label_proc - it will be automatically called, passing in the label text.
-  # config.label_proc = lambda { |l| c + ":" }
+  # config.label_proc = lambda { |l| l + ":" }
 end

data/lib/show_for/attribute.rb

@@ -15,10 +15,25 @@ module ShowFor
       wrap_label_and_content(attribute_name, value, options, &collection_block)
     end
 
+    def value(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_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
   end
-end
+end
+

data/lib/show_for/builder.rb

@@ -23,8 +23,13 @@ module ShowFor
     end
 
     def wrap_label_and_content(name, value, options, &block) #:nodoc:
-      wrap_with(:wrapper, label(name, options, false) + ShowFor.separator.to_s.html_safe +
-        content(value, options, false, &block), options)
+      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)
+    end
+
+    def wrap_content(name, value, options, &block) #:nodoc:
+      wrap_with(:wrapper, content(value, options, false, &block), options)
     end
 
     # Set "#{object_name}_#{attribute_name}" as in the wrapper tag.
@@ -57,4 +62,5 @@ module ShowFor
       block && block.arity == 1
     end
   end
-end
+end
+

data/lib/show_for/label.rb

@@ -9,7 +9,7 @@ module ShowFor
         human_attribute_name(text_or_attribute)
       end
 
-      return "" if label == false
+      return nil.to_s 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
@@ -22,4 +22,4 @@ module ShowFor
       @object.class.human_attribute_name(attribute.to_s)
     end
   end
-end
+end

data/lib/show_for/version.rb

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

data/lib/show_for.rb

@@ -25,7 +25,7 @@ module ShowFor
   @@collection_tag = :ul
 
   mattr_accessor :default_collection_proc
-  @@default_collection_proc = lambda { |value| "<li>#{value}</li>" }
+  @@default_collection_proc = lambda { |value| "<li>#{ERB::Util.html_escape(value)}</li>".html_safe }
 
   mattr_accessor :i18n_format
   @@i18n_format = :default

data/show_for.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "show_for/version"
+
+Gem::Specification.new do |s|
+  s.name        = "show_for"
+  s.version     = ShowFor::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Wrap your objects with a helper to easily show them"
+  s.email       = "contact@plataformatec.com.br"
+  s.homepage    = "http://github.com/plataformatec/show_for"
+  s.description = "Wrap your objects with a helper to easily show them"
+  s.authors     = ['José Valim']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.rubyforge_project = "show_for"
+end

data/test/builder_test.rb

@@ -8,6 +8,12 @@ class BuilderTest < ActionView::TestCase
     end)
   end
 
+  def with_value_for(object, attribute, options={}, &block)
+    concat(show_for(object) do |o|
+      concat o.value(attribute, options, &block)
+    end)
+  end
+
   def with_association_for(object, association, options={}, &block)
      concat(show_for(object) do |o|
        concat o.association(association, options, &block)
@@ -72,6 +78,7 @@ class BuilderTest < ActionView::TestCase
   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"
+    assert_no_select "div.show_for p.wrapper br"
   end
 
   test "show_for allows label to be configured globally" do
@@ -246,6 +253,93 @@ class BuilderTest < ActionView::TestCase
     end
   end
 
+  # VALUE
+  test "show_for allows content tag to be configured globally, without label and separator" do
+    swap ShowFor, :content_tag => :span do
+      with_value_for @user, :name
+      assert_no_select "div.show_for p.wrapper strong.label"
+      assert_no_select "div.show_for p.wrapper br"
+      assert_select "div.show_for p.wrapper span.content"
+    end
+  end
+
+  test "show_for allows content with tag to be changed by attribute, without label and separator" do
+    with_value_for @user, :name, :content_tag => :p
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper p.content"
+  end
+
+  test "show_for allows content tag html to be configured by attribute, without label and separator" do
+    with_value_for @user, :name, :content_tag => :span, :content_html => { :id => "thecontent", :class => "special" }
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper span#thecontent.special.content"
+  end
+
+  test "show_for accepts an attribute as string, without label and separator" do
+    with_value_for @user, :name
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper", /ShowFor/
+  end
+
+  test "show_for accepts an attribute as time, without label and separator" do
+    with_value_for @user, :created_at
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper", /#{Regexp.escape(I18n.l(@user.created_at))}/
+  end
+
+  test "show_for accepts an attribute as date, without label and separator" do
+    with_value_for @user, :updated_at
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    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, without label and separator" do
+    with_value_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 nil, without label and separator" do
+    c = with_value_for @user, :birthday
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper", /Not specified/
+  end
+
+  test "show_for accepts blank attributes, without label and separator" do
+    with_value_for @user, :description
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper", /Not specified/
+  end
+
+  test "show_for uses :if_blank if attribute is nil, without label and separator" do
+    with_value_for @user, :birthday, :if_blank => "No description provided"
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper", /No description provided/
+  end
+
+  test "show_for uses :if_blank if attribute is blank, without label and separator" do
+    with_value_for @user, :description, :if_blank => "No description provided"
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_select "div.show_for p.wrapper", /No description provided/
+  end
+
+  test "show_for escapes content by default, without label and separator" do
+    @user.name = "<b>hack you!</b>"
+    with_value_for @user, :name
+    assert_no_select "div.show_for p.wrapper strong.label"
+    assert_no_select "div.show_for p.wrapper br"
+    assert_no_select "div.show_for p.wrapper b"
+    assert_select "div.show_for p.wrapper", /&lt;b&gt;/
+  end
+
   # COLLECTIONS
   test "show_for accepts an attribute as a collection" do
     with_attribute_for @user, :scopes
@@ -356,4 +450,5 @@ class BuilderTest < ActionView::TestCase
     assert_select "div.show_for p.user_email.wrapper", /Not specified/
     assert_select "p.user_email strong.label", "Email"
   end
-end
+end
+

data/test/test_helper.rb

@@ -31,8 +31,10 @@ class ActionView::TestCase
       :active => true,
       :invalid => false,
       :scopes => ["admin", "manager", "visitor"],
+      :birthday => nil,
       :created_at => Time.now,
       :updated_at => Date.today
     }.merge(options))
   end
 end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: show_for
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 31
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-25 00:00:00 +02:00
+date: 2011-02-06 00:00:00 -02:00
 default_executable: 
 dependencies: []
 
@@ -25,9 +25,16 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
 - init.rb
 - lib/generators/show_for/USAGE
 - lib/generators/show_for/install_generator.rb
@@ -42,7 +49,7 @@ files:
 - lib/show_for/helper.rb
 - lib/show_for/label.rb
 - lib/show_for/version.rb
-- README.rdoc
+- show_for.gemspec
 - test/builder_test.rb
 - test/helper_test.rb
 - test/support/misc_helpers.rb
@@ -53,8 +60,8 @@ homepage: http://github.com/plataformatec/show_for
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -77,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: show_for
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Wrap your objects with a helper to easily show them