attrtastic 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Boruta Miroslaw
+
+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

@@ -0,0 +1,17 @@
+= attrtastic
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Boruta Miroslaw. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "attrtastic"
+    gem.summary = %Q{summary}
+    gem.description = %Q{description}
+    gem.email = "boruta.miroslaw@gmail.com"
+    gem.homepage = "http://github.com/MBO/attrtastic"
+    gem.authors = ["Boruta Miroslaw"]
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/attrtastic.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{attrtastic}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Boruta Miroslaw"]
+  s.date = %q{2010-01-03}
+  s.description = %q{description}
+  s.email = %q{boruta.miroslaw@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "attrtastic.gemspec",
+     "lib/attrtastic.rb",
+     "rails/init.rb",
+     "test/helper.rb",
+     "test/test_attribute.rb",
+     "test/test_attributes.rb",
+     "test/test_attrtastic.rb",
+     "test/test_semantic_attributes_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/MBO/attrtastic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{summary}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_attrtastic.rb",
+     "test/test_attribute.rb",
+     "test/test_semantic_attributes_helper.rb",
+     "test/test_attributes.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/attrtastic.rb

@@ -0,0 +1,111 @@
+module Attrtastic
+
+  class SemanticAttributesBuilder
+
+    @@value_methods = %w/ to_label display_name full_name name title username login value to_s /
+
+      attr_reader :record, :template
+
+    def initialize(record, template)
+      @record, @template = record, template
+    end
+
+    def attributes(*args, &block)
+      options = {}
+      if args.last and args.last.kind_of? Hash
+        options = args.last
+        args = args[0 .. -2]
+      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))
+      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>")
+      end
+
+      template.concat("</div>")
+    end
+
+    def attribute(*args, &block)
+      options = {}
+      if args.last and args.last.kind_of? Hash
+        options = args.last
+        args = args[0 .. -2]
+      end
+      options[:html] ||= {}
+
+      method = args.shift
+
+      html_label_class = [ "label", options[:html][:label_class] ].compact.join(" ")
+      html_value_class = [ "value", options[:html][:value_class] ].compact.join(" ")
+      html_class = [ "attribute", options[:html][:class] ].compact.join(" ")
+
+      label = options.key?(:label) ? options[:label] : label_for_attribute(method)
+      label_content = template.content_tag(:span, label, :class => html_label_class)
+
+      unless block_given?
+        value = options.key?(:value) ? options[:value] : value_of_attribute(method)
+        value_content = template.content_tag(:span, value, :class => html_value_class)
+
+        if value.present? or options[:display_empty]
+          content = [ label_content, value_content ].join
+          template.content_tag(:li, content, :class => html_class)
+        end
+      else
+        template.concat(template.tag(:li, {:class => html_class}, true))
+        template.concat(label_content)
+        template.concat(template.tag(:span, {:class => html_value_class}, true))
+        yield
+        template.concat("</span>")
+        template.concat("</li>")
+      end
+    end
+
+    private
+
+    def label_for_attribute(method)
+      if record.class.respond_to?(:human_attribute_name)
+        record.class.human_attribute_name(method.to_s)
+      else
+        method.to_s.send(:humanize)
+      end
+    end
+
+    def value_of_attribute(method)
+      record.send(method).to_s
+    end
+
+  end
+
+  module SemanticAttributesHelper
+
+    def semantic_attributes_for(record, options = {}, &block)
+      options[:html] ||= {}
+
+      html_class = [ "attrtastic", record.class.to_s.underscore, options[:html][:class] ].compact.join(" ")
+
+      concat(tag(:div, { :class => html_class}, true))
+      yield SemanticAttributesBuilder.new(record, self) if block_given?
+      concat("</div>")
+    end
+
+  end
+
+end
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib attrtastic])
+ActionView::Base.send :include, Attrtastic::SemanticAttributesHelper

data/test/helper.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'action_view'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'attrtastic'
+
+class Test::Unit::TestCase
+  def html(string)
+    string.split(/\n/m).map(&:strip).join
+  end
+  def setup_fixtures
+    @user = User.new.tap do |u|
+      u.first_name,u.last_name = "John","Doe"
+      u.email = "john@doe.com"
+    end
+    @blog = Blog.new.tap{|b| b.name,b.url,b.author = "IT Pro Blog","http://www.it.pro.blog",@user}
+    @blog.posts = [
+      Post.new.tap{|p| p.title,p.content = "Hello World!","Hello World!\nInitial post"},
+      Post.new.tap{|p| p.title,p.content = "Sorry","Sorry for long delay. Had much stuff on my head..."},
+    ]
+
+    ActionView::Base.send :include, Attrtastic::SemanticAttributesHelper
+    @template = ActionView::Base.new.tap{ |av| av.output_buffer = "" }
+    @user_builder = Attrtastic::SemanticAttributesBuilder.new(@user, @template)
+    @blog_builder = Attrtastic::SemanticAttributesBuilder.new(@blog, @template)
+  end
+end
+
+class User
+  attr_accessor :first_name, :last_name, :email, :title
+
+  def full_name
+    [last_name,first_name].join(", ")
+  end
+end
+
+class Blog
+  attr_accessor :name, :url, :author, :posts
+  delegate :full_name, :to => :author, :prefix => true
+end
+
+class Post
+  attr_accessor :title, :content
+end

data/test/test_attribute.rb

@@ -0,0 +1,123 @@
+require 'helper'
+
+class TestAttribute < Test::Unit::TestCase
+
+  def setup
+    setup_fixtures
+  end
+
+  def test__attribute__output
+    expected = html <<-EOHTML
+      <li class="attribute">
+        <span class="label">Full name</span>
+        <span class="value">Doe, John</span>
+      </li>
+    EOHTML
+
+    actual = @user_builder.attribute(:full_name)
+    assert_equal expected, actual
+  end
+
+  def test__attribute__with_empty_value
+    actual = @user_builder.attribute(:title)
+    assert_nil actual
+
+    expected = html <<-EOHTML
+      <li class="attribute">
+        <span class="label">Title</span>
+        <span class="value"></span>
+      </li>
+    EOHTML
+
+    actual = @user_builder.attribute(:title, :display_empty => true)
+    assert_equal expected, actual
+  end
+
+  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(:full_name, :label => "Name")
+    assert_equal expected, actual
+  end
+
+  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 = @user_builder.attribute(:full_name, :value => "Sir #{@user.full_name}")
+    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 => "")
+
+    expected = html <<-EOHTML
+      <li class="attribute">
+        <span class="label">Full name</span>
+        <span class="value"></span>
+      </li>
+    EOHTML
+
+    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
+
+  def test__attribute__with_block
+    block_run = false
+    @user_builder.attribute :full_name do
+      block_run = true
+    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 << "!"
+      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 << "!"
+      end
+    end
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+  end
+
+end
+

data/test/test_attributes.rb

@@ -0,0 +1,105 @@
+require 'helper'
+
+class TestAttributes < Test::Unit::TestCase
+
+  def setup
+    setup_fixtures
+  end
+
+  def test__attributes__shoul_run_block
+    block_run = false
+    @user_builder.attributes do
+      block_run = true
+    end
+
+    assert block_run
+  end
+
+  def test__attributes__output_without_block
+    expected = html <<-EOHTML
+      <div class="attributes">
+      </div>
+    EOHTML
+
+    @user_builder.attributes
+    actual = @template.output_buffer.to_s
+
+    assert_equal expected, actual
+  end
+
+  def test__attributes__output
+    expected = html <<-EOHTML
+      <div class="attributes">
+        <ol>
+        </ol>
+      </div>
+    EOHTML
+
+    @user_builder.attributes do end
+    actual = @template.output_buffer.to_s
+
+    assert_equal expected, actual
+  end
+
+  def test__attributes__with_header
+    expected = html <<-EOHTML
+      <div class="attributes">
+        <div class="legend">Legend</div>
+        <ol>
+        </ol>
+      </div>
+    EOHTML
+
+    @user_builder.attributes "Legend" do end
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+  end
+
+  def test__attributes__with_fields_list
+    expected = html <<-EOHTML
+      <div class="attributes">
+        <ol>
+          <li class="attribute">
+            <span class="label">Full name</span>
+            <span class="value">Doe, John</span>
+          </li>
+          <li class="attribute">
+            <span class="label">Email</span>
+            <span class="value">john@doe.com</span>
+          </li>
+        </ol>
+      </div>
+    EOHTML
+
+    @user_builder.attributes :full_name, :email
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+  end
+
+  def test__attributes__with_fields_list_header_and_options
+    expected = html <<-EOHTML
+      <div class="attributes contact">
+        <div class="legend">Contact</div>
+        <ol>
+          <li class="attribute">
+            <span class="label">Full name</span>
+            <span class="value">Doe, John</span>
+          </li>
+          <li class="attribute">
+            <span class="label">Title</span>
+            <span class="value"></span>
+          </li>
+          <li class="attribute">
+            <span class="label">Email</span>
+            <span class="value">john@doe.com</span>
+          </li>
+        </ol>
+      </div>
+    EOHTML
+
+    @user_builder.attributes "Contact", :full_name, :title, :email, :html => {:class => "contact"}, :display_empty => true
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+  end
+
+end

data/test/test_attrtastic.rb

@@ -0,0 +1,88 @@
+require 'helper'
+
+class TestAttrtastic < Test::Unit::TestCase
+
+  def setup
+    setup_fixtures
+  end
+
+  def test_attrtastic_verbose
+    expected = html <<-EOHTML
+      <div class="attrtastic user">
+        <div class="attributes">
+          <div class="legend">User</div>
+          <ol>
+            <li class="attribute strong">
+              <span class="label">First name</span>
+              <span class="value">John</span>
+            </li>
+            <li class="attribute">
+              <span class="label">Last name</span>
+              <span class="value">Doe</span>
+            </li>
+          </ol>
+        </div>
+
+        <div class="attributes">
+          <div class="legend">Contact</div>
+          <ol>
+            <li class="attribute">
+              <span class="label">Email</span>
+              <span class="value">john@doe.com</span>
+            </li>
+          </ol>
+        </div>
+      </div>
+    EOHTML
+
+    @template.semantic_attributes_for(@user) do |attr|
+      attr.attributes "User" do
+        @template.output_buffer << (attr.attribute :first_name, :html => {:class => :strong}).to_s
+        @template.output_buffer << (attr.attribute :last_name).to_s
+        @template.output_buffer << (attr.attribute :title).to_s
+      end
+      attr.attributes "Contact" do
+        @template.output_buffer << (attr.attribute :email).to_s
+      end
+    end
+
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+  end
+
+  def test_attrtastic_compct
+    expected = html <<-EOHTML
+      <div class="attrtastic user">
+        <div class="attributes">
+          <div class="legend">User</div>
+          <ol>
+            <li class="attribute">
+              <span class="label">First name</span>
+              <span class="value">John</span>
+            </li>
+            <li class="attribute">
+              <span class="label">Last name</span>
+              <span class="value">Doe</span>
+            </li>
+          </ol>
+        </div>
+
+        <div class="attributes">
+          <div class="legend">Contact</div>
+          <ol>
+            <li class="attribute">
+              <span class="label">Email</span>
+              <span class="value">john@doe.com</span>
+            </li>
+          </ol>
+        </div>
+      </div>
+    EOHTML
+
+    @template.semantic_attributes_for(@user) do |attr|
+      attr.attributes "User", :first_name, :last_name, :title
+      attr.attributes "Contact", :email
+    end
+  end
+
+end

data/test/test_semantic_attributes_helper.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+class TestSemanticAttributesHelper < Test::Unit::TestCase
+
+  def setup
+    setup_fixtures
+  end
+
+  def test__semantic_attributes_for__output_with_no_block
+    expected = html <<-EOHTML
+      <div class="attrtastic user">
+      </div>
+    EOHTML
+
+    @template.semantic_attributes_for(@user)
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+
+    @template.output_buffer.clear
+
+    expected = html <<-EOHTML
+      <div class="attrtastic blog">
+      </div>
+    EOHTML
+
+    @template.semantic_attributes_for(@blog)
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+  end
+
+  def test__semantic_attributes_for__should_run_block
+    block_run = false
+    @template.semantic_attributes_for(@user) do |attr|
+      block_run = true
+    end
+
+    assert block_run
+  end
+
+  def test__semantic_attributes_for__with_options
+    expected = html <<-EOHTML
+      <div class="attrtastic user simple show">
+      </div>
+    EOHTML
+
+    @template.semantic_attributes_for(@user, :html => {:class => 'simple show'})
+    actual = @template.output_buffer.to_s
+    assert_equal expected, actual
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: attrtastic
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Boruta Miroslaw
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: description
+email: boruta.miroslaw@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- attrtastic.gemspec
+- lib/attrtastic.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_attribute.rb
+- test/test_attributes.rb
+- test/test_attrtastic.rb
+- test/test_semantic_attributes_helper.rb
+has_rdoc: true
+homepage: http://github.com/MBO/attrtastic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: summary
+test_files: 
+- test/helper.rb
+- test/test_attrtastic.rb
+- test/test_attribute.rb
+- test/test_semantic_attributes_helper.rb
+- test/test_attributes.rb