attrtastic 0.1.3 → 0.2.0

data/Rakefile

@@ -15,6 +15,7 @@ begin
     gem.homepage = "http://github.com/MBO/attrtastic"
     gem.authors = ["Boruta Miroslaw"]
     gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/attrtastic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{attrtastic}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Boruta Miroslaw"]
-  s.date = %q{2010-01-11}
+  s.date = %q{2010-01-15}
   s.description = %q{    Attrtastic, in its assumtion, should be similar in usage to formtastic and
     ease of displaying AR record informations (attributes). It should help
     scafforld show/index pages.
@@ -71,11 +71,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
       s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
     s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end
 

data/lib/attrtastic.rb

@@ -22,8 +22,9 @@ module Attrtastic
     #   Creates attributes list without header, yields block to include each attribute
     #
     #   @param [Hash] options Options for formating attributes block
-    #   @option options [String] :class ('') Name of html class(-es) to add to attributes block
-    #   @option options [String] :header_class ('') Name of html class(-es) to add to header
+    #   @option options [String] :name (nil) Optional header of attributes section
+    #   @option options [String] :class ('') Name of html class to add to attributes block
+    #   @option options [String] :header_class ('') Name of html class to add to header
     #   @yield Block which can call #attribute to include attribute value
     #
     #   @example
@@ -32,14 +33,54 @@ module Attrtastic
     #       <%= attr.attribute :email %>
     #     <% end %>
     #
+    #   @example
+    #     <% attr.attributes :name => "User" do %>
+    #       <%= attr.attribute :name %>
+    #       <%= attr.attribute :email %>
+    #     <% end %>
+    #
+    #   @example
+    #     <% attr.attributes :for => :user do |user| %>
+    #       <%= user.attribute :name %>
+    #       <%= user.attribute :email %>
+    #       <%  user.attribute :profile do %>
+    #         <%= link_to h(user.record.name), user_path(user.record) %>
+    #       <%  end %>
+    #     <% end %>
+    #
+    #   @example
+    #     <% attr.attributes :for => @user do |user| %>
+    #       <%= user.attribute :name %>
+    #       <%= user.attribute :email %>
+    #       <%  user.attribute :profile do %>
+    #         <%= link_to h(@user.name), user_path(@user) %>
+    #       <%  end %>
+    #     <% end %>
+    #
+    #   @example
+    #     <% attr.attributes :for => :posts do |post| %>
+    #       <%= post.attribute :author %>
+    #       <%= post.attribute :title %>
+    #     <% end %>
+    #
+    #   @example
+    #     <% attr.attributes :for => @posts do |post| %>
+    #       <%= post.attribute :author %>
+    #       <%= post.attribute :title %>
+    #     <% end %>
+    #
     # @overload attributes(header, options = {}, &block)
     #   Creates attributes list with header and yields block to include each attribute
     #
     #   @param [String] header Header of attributes section
     #   @param [Hash] options Options for formating attributes block
-    #   @option options [String] :class ('') Name of html class(-es) to add to attributes block
-    #   @option options [String] :header_class ('') Name of html class(-es) to add to header
+    #   @option options [String] :class ('') Name of html class to add to attributes block
+    #   @option options [String] :header_class ('') Name of html class to add to header
+    #   @option optinos [Symbol,Object] :for Optional new record for new builder
+    #     passed as argument block. This new record can be symbol of method name for actual
+    #     record, or any other object which is passed as new record for builder.
     #   @yield Block which can call #attribute to include attribute value
+    #   @yieldparam builder Builder instance holding actual record (retivable via #record)
     #
     #   @example
     #     <% attr.attributes "User info" do %>
@@ -47,29 +88,84 @@ module Attrtastic
     #       <%= attr.attribute :email %>
     #     <% end %>
     #
+    #   @example
+    #     <% attr.attributes "User", :for => :user do |user| %>
+    #       <%= user.attribute :name %>
+    #       <%= user.attribute :email %>
+    #       <%  user.attribute :profile do %>
+    #         <%= link_to h(user.record.name), user_path(user.record) %>
+    #       <%  end %>
+    #     <% end %>
+    #
+    #   @example
+    #     <% attr.attributes "User", :for => @user do |user| %>
+    #       <%= user.attribute :name %>
+    #       <%= user.attribute :email %>
+    #       <%  user.attribute :profile do %>
+    #         <%= link_to h(@user.name), user_path(@user) %>
+    #       <%  end %>
+    #     <% end %>
+    #
+    #   @example
+    #     <% attr.attributes "Post", :for => :posts do |post| %>
+    #       <%= post.attribute :author %>
+    #       <%= post.attribute :title %>
+    #     <% end %>
+    #
+    #   @example
+    #     <% attr.attributes "Post", :for => @posts do |post| %>
+    #       <%= post.attribute :author %>
+    #       <%= post.attribute :title %>
+    #     <% end %>
+    #
     # @overload attributes(*symbols, options = {})
     #   Creates attributes list without header, attributes are given as list of symbols (record properties)
     #
     #   @param [Symbol, ...] symbols List of attributes
     #   @param [Hash] options Options for formating attributes block
-    #   @option options [String] :class ('') Name of html class(-es) to add to attributes block
-    #   @option options [String] :header_class ('') Name of html class(-es) to add to header
+    #   @option options [String] :name (nil) Optional header of attributes section
+    #   @option options [String] :class ('') Name of html class to add to attributes block
+    #   @option options [String] :header_class ('') Name of html class to add to header
     #
     #   @example
     #     <% attr.attributes :name, :email %>
     #
+    #   @example
+    #     <% attr.attributes :name, :email, :for => :author %>
+    #
+    #   @example
+    #     <% attr.attributes :name, :email, :for => @user %>
+    #
+    #   @example
+    #     <% attr.attributes :title, :for => :posts %>
+    #
+    #   @example
+    #     <% attr.attributes :title, :for => @posts %>
+    #
     # @overload attributes(header, *symbols, options = {})
     #   Creates attributes list with header, attributes are given as list of symbols (record properties)
     #
     #   @param [String] header Header of attributes section
     #   @param [Symbol, ...] symbols Optional list of attributes
     #   @param [Hash] options Options for formating attributes block
-    #   @option options [String] :class ('') Name of html class(-es) to add to attributes block
-    #   @option options [String] :header_class ('') Name of html class(-es) to add to header
+    #   @option options [String] :class ('') Name of html class to add to attributes block
+    #   @option options [String] :header_class ('') Name of html class to add to header
     #
     #   @example
     #     <% attr.attributes "User info" :name, :email %>
     #
+    #   @example
+    #     <% attr.attributes "Author", :name, :email, :for => :author %>
+    #
+    #   @example
+    #     <% attr.attributes "Author", :name, :email, :for => @user %>
+    #
+    #   @example
+    #     <% attr.attributes "Post", :title, :for => :posts %>
+    #
+    #   @example
+    #     <% attr.attributes "Post", :title, :for => @posts %>
+    #
     # @example All together
     #   <% attr.attributes "User info", :name, :email, :class => "user_info", :header_class => "header important" %>
     #
@@ -88,28 +184,24 @@ module Attrtastic
       end
       options[:html] ||= {}
 
-      html_class = [ "attributes", options[:html].delete(:class) ].compact.join(" ")
-      html_header_class = [ "legend", options[:html].delete(:header_class) ].compact.join(" ")
-
-      template.concat(template.tag(:div, {:class => html_class}, true))
-
       if args.first and args.first.is_a? String
-        header = args.shift
-        template.concat(template.content_tag(:div, header, :class => html_header_class))
+        options[:name] = args.shift
       end
 
-      if block_given?
-        template.concat(template.tag(:ol, {}, true))
-        yield
-        template.concat("</ol>")
-      elsif args.present?
-        template.concat(template.tag(:ol, {}, true))
-        attrs = args.map {|method| attribute(method, options)}.compact.join
-        template.concat(attrs)
-        template.concat("</ol>")
+      if options[:for].blank?
+        attributes_for(record, args, options, &block)
+      else
+        if options[:for].is_a? Symbol
+          for_value = record.send(options[:for])
+        else
+          for_value = options[:for]
+        end
+
+        [*for_value].each do |value|
+          attributes_for(value, args, options, &block)
+        end
       end
 
-      template.concat("</div>")
     end
 
     ##
@@ -120,7 +212,7 @@ module Attrtastic
     #
     #   @param [Symbol] method Attribute name of given record
     #   @param [Hash] options Options
-    #   @option options [String] :html ({}) Hash with optional :class, :label_class and :value_class names of class for html
+    #   @option options [Hash] :html ({}) Hash with optional :class, :label_class and :value_class names of class for html
     #   @option options [String] :label Label for attribute entry, overrides default label name from symbol
     #   @option options [String] :value Value of attribute entry, overrides default value from record
     #   @option options [Boolean] :display_empty (false) Indicates if print value of given attribute even if it is blank?
@@ -139,24 +231,31 @@ module Attrtastic
     #
     #   @param [Symbol] method Attribute name of given record
     #   @param [Hash] options Options
-    #   @option options [String] :html ({}) Hahs with optional :class, :label_class and :value_class names of class for html
+    #   @option options [Hash] :html ({}) Hash with optional :class, :label_class and :value_class names of classes for html
     #   @option options [String] :label Label for attribute entry, overrides default label name from symbol
-    #   @option options [Boolean] :display_empty (false) Indicates if print value of given attribute even if it is blank?
     #   @yield Block which is executed in place of value for attribute
     #
     #   @example
     #     <% attr.attribute :name do %>
     #       <%= link_to @user.full_name, user_path(@user) %>
     #
+    # @overload attribute(options = {}, &block)
+    #   Creates entry for attribute with given block, options[:label] is mandatory in this case.
+    #
+    #   @param [:Hash] options Options
+    #   @option options [Hash] :html ({}) Hash with optional :class, :label_class and :value_class names of classes for html
+    #   @option options [String] :label Mandatory label for attribute entry
+    #   @yield Block which is executed in place of value for attribute
+    #
     #   @example
-    #     <% attr.attribute :name, :label => "User link" do %>
+    #     <% attr.attribute :label => "User link" do %>
     #       <%= link_to @user.full_name, user_path(@user) %>
     #
     # @example
     #   <%= attr.attribute :name, :display_empty => true %>
     #
     # @example
-    #   <% attr.attribute :name, :label => "User link" do %>
+    #   <% attr.attribute :label => "User link" do %>
     #     <%= link_to @user.full_name, user_path(@user) %>
     #
     def attribute(*args, &block)
@@ -196,6 +295,34 @@ module Attrtastic
 
     private
 
+    def attributes_for(object, methods, options, &block)
+      new_builder = self.class.new(object, template)
+
+      html_class = [ "attributes", options[:html].delete(:class) ].compact.join(" ")
+      html_header_class = [ "legend", options[:html].delete(:header_class) ].compact.join(" ")
+
+      template.concat(template.tag(:div, {:class => html_class}, true))
+
+      header = options[:name]
+
+      if header.present?
+        template.concat(template.content_tag(:div, header, :class => html_header_class))
+      end
+
+      if block_given?
+        template.concat(template.tag(:ol, {}, true))
+        yield(new_builder)
+        template.concat("</ol>")
+      elsif methods.present?
+        template.concat(template.tag(:ol, {}, true))
+        attrs = methods.map {|method| new_builder.attribute(method, options)}.compact.join
+        template.concat(attrs)
+        template.concat("</ol>")
+      end
+
+      template.concat("</div>")
+    end
+
     def label_for_attribute(method)
       if record.class.respond_to?(:human_attribute_name)
         record.class.human_attribute_name(method.to_s)
@@ -204,9 +331,11 @@ module Attrtastic
       end
     end
 
-    #@@value_methods = %w/ to_label display_name full_name name title username login value to_s /
     def value_of_attribute(method)
-      record.send(method).to_s
+      value = record.send(method)
+      value_methods = [ :to_label, :display_name, :full_name, :name, :title, :username, :login, :value ]
+      value_method = value_methods.find { |m| value.respond_to?(m) } || :to_s
+      value.send(value_method)
     end
 
   end

data/test/helper.rb

@@ -1,4 +1,5 @@
 require 'test/unit'
+require 'shoulda'
 require 'action_view'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_attribute.rb

@@ -2,121 +2,146 @@ require 'helper'
 
 class TestAttribute < Test::Unit::TestCase
 
-  def setup
-    setup_fixtures
-  end
+  context "attribute" do
 
-  def test__attribute__output
-    expected = html <<-EOHTML
-      <li class="attribute">
-        <span class="label">Full name</span>
-        <span class="value">Doe, John</span>
-      </li>
-    EOHTML
+    setup do
+      setup_fixtures
+    end
 
-    actual = @user_builder.attribute(:full_name)
-    assert_equal expected, actual
-  end
+    should "generate output" do
+      expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Full name</span>
+          <span class="value">Doe, John</span>
+        </li>
+      EOHTML
 
-  def test__attribute__with_empty_value
-    actual = @user_builder.attribute(:title)
-    assert_nil actual
+      actual = @user_builder.attribute(:full_name)
+      assert_equal expected, actual
+    end
 
-    expected = html <<-EOHTML
-      <li class="attribute">
-        <span class="label">Title</span>
-        <span class="value"></span>
-      </li>
-    EOHTML
+    should "not show attribute when value is blank" do
+      actual = @user_builder.attribute(:title)
+      assert_nil actual
+    end
 
-    actual = @user_builder.attribute(:title, :display_empty => true)
-    assert_equal expected, actual
-  end
+    should "show attribute with :display_empty => true" do
+      expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Title</span>
+          <span class="value"></span>
+        </li>
+      EOHTML
 
-  def test__attribute__with_custom_label
-    expected = html <<-EOHTML
-      <li class="attribute">
-        <span class="label">Name</span>
-        <span class="value">Doe, John</span>
-      </li>
-    EOHTML
+      actual = @user_builder.attribute(:title, :display_empty => true)
+      assert_equal expected, actual
+    end
 
-    actual = @user_builder.attribute(:full_name, :label => "Name")
-    assert_equal expected, actual
-  end
+    should "convert nested object to value" do
+      expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Author</span>
+          <span class="value">Doe, John</span>
+        </li>
+      EOHTML
 
-  def test__attribute__with_custom_value
-    expected = html <<-EOHTML
-      <li class="attribute">
-        <span class="label">Full name</span>
-        <span class="value">Sir Doe, John</span>
-      </li>
-    EOHTML
+      actual = @blog_builder.attribute(:author_full_name, :label => "Author")
+      assert_equal expected, actual
 
-    actual = @user_builder.attribute(:full_name, :value => "Sir #{@user.full_name}")
-    assert_equal expected, actual
-  end
+      actual = @blog_builder.attribute(:author)
+      assert_equal expected, actual
+    end
 
-  def test__attribute__with_empty_custom_value
-    assert_nil @user_builder.attribute(:full_name, :value => nil)
-    assert_nil @user_builder.attribute(:full_name, :value => "")
+    should "show custom label" do
+      expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Name</span>
+          <span class="value">Doe, John</span>
+        </li>
+      EOHTML
 
-    expected = html <<-EOHTML
-      <li class="attribute">
-        <span class="label">Full name</span>
-        <span class="value"></span>
-      </li>
-    EOHTML
+      actual = @user_builder.attribute(:full_name, :label => "Name")
+      assert_equal expected, actual
+    end
 
-    actual = @user_builder.attribute(:full_name, :value => nil, :display_empty => true)
-    assert_equal expected, actual
+    should "show custom value" do
+      expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Full name</span>
+          <span class="value">Sir Doe, John</span>
+        </li>
+      EOHTML
 
-    actual = @user_builder.attribute(:full_name, :value => "", :display_empty => true)
-    assert_equal expected, actual
-  end
+      actual = @user_builder.attribute(:full_name, :value => "Sir #{@user.full_name}")
+      assert_equal expected, actual
+    end
+
+    should "work with custom value blank" do
+      assert_nil @user_builder.attribute(:full_name, :value => nil)
+      assert_nil @user_builder.attribute(:full_name, :value => "")
+
+      expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Full name</span>
+          <span class="value"></span>
+        </li>
+      EOHTML
 
-  def test__attribute__with_block
-    block_run = false
-    @user_builder.attribute :full_name do
-      block_run = true
+      actual = @user_builder.attribute(:full_name, :value => nil, :display_empty => true)
+      assert_equal expected, actual
+
+      actual = @user_builder.attribute(:full_name, :value => "", :display_empty => true)
+      assert_equal expected, actual
     end
-    assert block_run
-  end
 
-  def test__attribute__output_with_block
-    expected = html <<-EOHTML
-      <li class="attribute">
-        <span class="label">Full name</span>
-        <span class="value">John Doe!!!</span>
-      </li>
-    EOHTML
-
-    @user_builder.attribute :full_name do
-      @user_builder.template.output_buffer << "John Doe"
-      3.times do
-        @user_builder.template.output_buffer << "!"
+
+    context "with block" do
+
+      should "yield block" do
+        block_run = false
+        @user_builder.attribute :full_name do
+          block_run = true
+        end
+        assert block_run
       end
-    end
-    actual = @template.output_buffer.to_s
-    assert_equal expected, actual
-  end
 
-  def test__attribute__with_block_and_custom_label
-    expected = html <<-EOHTML
-      <li class="attribute">
-        <span class="label">Full name</span>
-        <span class="value">John Doe!!!</span>
-      </li>
-    EOHTML
-
-    @user_builder.attribute :label => "Full name" do
-      @user_builder.template.output_buffer << "John Doe"
-      3.times do
-        @user_builder.template.output_buffer << "!"
+      should "generate output" do
+        expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Full name</span>
+          <span class="value">John Doe!!!</span>
+        </li>
+        EOHTML
+
+        @user_builder.attribute :full_name do
+          @user_builder.template.output_buffer << "John Doe"
+          3.times do
+            @user_builder.template.output_buffer << "!"
+          end
+        end
+        actual = @template.output_buffer.to_s
+        assert_equal expected, actual
       end
+
+      should "show custom label" do
+        expected = html <<-EOHTML
+        <li class="attribute">
+          <span class="label">Full name</span>
+          <span class="value">John Doe!!!</span>
+        </li>
+        EOHTML
+
+        @user_builder.attribute :label => "Full name" do
+          @user_builder.template.output_buffer << "John Doe"
+          3.times do
+            @user_builder.template.output_buffer << "!"
+          end
+        end
+        actual = @template.output_buffer.to_s
+        assert_equal expected, actual
+      end
+
     end
-    actual = @template.output_buffer.to_s
-    assert_equal expected, actual
   end
 
 end