table_for 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,20 +1,22 @@
-== TableFor
+= TableFor
 
-  Renders a table for your model collection.
-  Like show_for, but for collections...
+Renders a table for your model collection.
+Like show_for, but for collections...
 
 == Disclaimer
 
-  Should not be considered stable at all this point.
-  (The gem have no specs! OMG!)
+Should not be considered stable.
+Briefly tested under rails 3 running ruby 1.8.7 and 1.9.2
+Test coverage not yet up to speed.
 
 == Installation
 
- gem install table_for
+Add the below line to your gem file and run bundle install
+  gem 'table_for'
 
 == Basic Usage
 
-  # In your erb views:
+In your erb views:
   <%= table_for Product, @products do |table| %>
     <%= table.head :name, :size, :description, :price %>
     <%= table.body do |row| %>
@@ -27,7 +29,7 @@
     <% end %>
   <% end %>
 
-  # Or: 
+Or: 
   <%= table_for Product, @products do |table| %>
     <%= table.columns :name, :size, :description, :price %>
     <%= table.foot do %>
@@ -35,8 +37,10 @@
     <% end %>
   <% end %>
 
+The footer if not shown if there is the view helper "admin?" is defined and returns false.
+
 == Credits and contributors
 
-  * Jonas Nicklas (jnickals) who actually wrote mote of the code while we pair-programmed.
-  * Elabs for sponsoring with development time
-  * The authors of show_for for providing the inspiration.
+* Jonas Nicklas (jnicklas) who actually wrote most of the code while we pair-programmed.
+* Elabs for sponsoring with development time.
+* The authors of the show_for gem for providing the inspiration.

data/lib/table_for.rb

@@ -1,4 +1,7 @@
 require 'table_for/helper'
 
 module TableFor
+  autoload :Table, 'table_for/table'
+  autoload :TableBuilder, 'table_for/table_builder'
+  autoload :RowBuilder, 'table_for/row_builder'
 end

data/lib/table_for/helper.rb

@@ -1,93 +1,37 @@
 module TableFor
   module Helper
-    # Create a table for records, using model class for naming things.
+    # Create a html table for records, using model class for naming things.
     #
-    # Example:
+    # Examples:
     #
-    # table_for User @users do |table|
-    # table.columns :first_name, :last_name
-    # end
+    # <tt>table_for Product, @products do |table|
+    #   table.head :name, :size, :description, :price
+    #   table.body do |row|
+    #     row.cell :name
+    #     row.cells :size, :description
+    #     row.cell number_to_currency(row.record.price)
+    #   end
+    #   table.foot do
+    #     link_to "Add product", new_product_path
+    #   end
+    # end</tt>
     #
+    # <tt>table_for Product, @products do |table|
+    #   table.columns :name, :size, :description, :price
+    #   table.foot do
+    #     link_to "Add product", new_product_path
+    #   end
+    # end</tt>
+    #
+    # Returns:
+    #
+    # A string containing the html table
+    #
+    # (Call this method from your erb templates by wrapping each line in <%= %> or <% %>)
+
     def table_for(model_class, records, &block)
       Table.new(self, model_class, records, block).render
     end
-
-    class Table < Struct.new(:template, :model_class, :records, :block)
-      attr_accessor :columns, :rows
-      delegate :capture, :content_tag, :to => :template
-
-      def human_association_name
-        model_class.model_name.human.pluralize
-      end
-
-      def human_column_names
-        columns.map { |column| model_class.human_attribute_name(column) }
-      end
-
-      def row_builders
-        records.map { |record| RowBuilder.new(self, record) }
-      end
-
-      def render
-        content_tag(:table, :class => 'list') do
-          content_tag(:caption, human_association_name) + capture(TableBuilder.new(self), &block)
-        end
-      end
-    end
-
-    class TableBuilder < Struct.new(:table)
-      delegate :template, :human_column_names, :to => :table
-      delegate :capture, :content_tag, :admin?, :to => :template
-
-      def columns(*columns)
-        head(*columns) + body(*columns)
-      end
-
-      def head(*columns)
-        table.columns = columns
-
-        content_tag(:thead) do
-          content_tag(:tr) do
-            human_column_names.map { |column| content_tag(:th, column) }.join
-          end
-        end.html_safe
-      end
-
-      def body(*columns, &block)
-        content_tag(:tbody) do
-          table.row_builders.map do |builder|
-            content_tag(:tr) do
-              if block then capture(builder, &block) else builder.cells(*columns) end
-            end
-          end.join.html_safe
-        end
-      end
-
-      def foot(&block)
-        if admin?
-          content_tag(:tfoot) do
-            content_tag(:tr) do
-              content_tag(:td, capture(&block), :colspan => table.columns.size)
-            end
-          end.html_safe
-        end
-      end
-    end
-
-    class RowBuilder < Struct.new(:table, :record)
-      delegate :template, :to => :table
-      delegate :content_tag, :to => :template
-
-      def cells(*values)
-        values.map { |v| cell(v) }.join.html_safe
-      end
-
-      def cell(value)
-        content_tag(:td) do
-          if value.is_a?(Symbol) then record.send(value).to_s else value.to_s end
-        end
-      end
-    end
   end
 end
 

data/lib/table_for/row_builder.rb

@@ -0,0 +1,16 @@
+module TableFor
+  class RowBuilder < Struct.new(:table, :record)
+    delegate :template, :to => :table
+    delegate :content_tag, :to => :template
+
+    def cells(*values)
+      values.map { |v| cell(v) }.join.html_safe
+    end
+
+    def cell(value)
+      content_tag(:td) do
+        if value.is_a?(Symbol) then record.send(value).to_s else value.to_s end
+      end
+    end
+  end
+end

data/lib/table_for/table.rb

@@ -0,0 +1,30 @@
+module TableFor
+  class Table < Struct.new(:template, :model_class, :records, :block)
+    attr_accessor :columns, :rows
+    delegate :capture, :content_tag, :to => :template
+
+    def human_column_names
+      columns.map { |column| model_class.human_attribute_name(column) }
+    end
+
+    def row_builders
+      records.map { |record| RowBuilder.new(self, record) }
+    end
+
+    def render
+      content_tag(:table, :class => 'list') do
+        caption + capture(TableBuilder.new(self), &block)
+      end
+    end
+
+  protected
+
+    def caption
+      content_tag(:caption, human_association_name)
+    end
+
+    def human_association_name
+      model_class.model_name.human.pluralize
+    end
+  end
+end

data/lib/table_for/table_builder.rb

@@ -0,0 +1,45 @@
+module TableFor
+  class TableBuilder < Struct.new(:table)
+    delegate :template, :human_column_names, :to => :table
+    delegate :capture, :content_tag, :to => :template
+
+    def columns(*columns)
+      head(*columns) + body(*columns)
+    end
+
+    def head(*columns)
+      table.columns = columns
+
+      content_tag(:thead) do
+        content_tag(:tr) do
+          human_column_names.map { |column| content_tag(:th, column) }.join
+        end
+      end.html_safe
+    end
+
+    def body(*columns, &block)
+      content_tag(:tbody) do
+        table.row_builders.map do |builder|
+          content_tag(:tr) do
+            if block then capture(builder, &block) else builder.cells(*columns) end
+          end
+        end.join.html_safe
+      end
+    end
+
+    def foot(&block)
+      if admin?
+        content_tag(:tfoot) do
+          content_tag(:tr) do
+            content_tag(:td, capture(&block), :colspan => table.columns.size)
+          end
+        end.html_safe
+      end
+    end
+
+    def admin?
+      return true unless template.respond_to?(:admin?)
+      template.admin?
+    end
+  end
+end

data/lib/table_for/version.rb

@@ -1,3 +1,3 @@
 module TableFor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+ENV["RAILS_ENV"] = "test"
+
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rails'
+require 'rubygems'
+require 'bundler/setup'
+require "rails/test_help"
+
+Dir["#{File.expand_path(File.dirname(__FILE__))}/../lib/table_for/*.rb"].each {|f| require(f) unless f =~ /version\.rb$/ }
+Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].each {|f| require(f) }

data/spec/support/user.rb

@@ -0,0 +1,17 @@
+module TestTableFor
+  class User < Struct.new(:first_name, :last_name)
+    class << self
+      def human_attribute_name(attribute)
+        attribute.to_s.humanize
+      end
+
+      def model_name
+        self
+      end
+
+      def human
+        "User"
+      end
+    end
+  end
+end

data/spec/table_for/table_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe TableFor::Table do
+  let(:template) { ActionView::Base.new }
+  let(:users) do
+    [TestTableFor::User.new(:first_name => "Nicklas", :last_name => "Ramhöj"),
+     TestTableFor::User.new(:first_name => "Jonas", :last_name => "Nicklas")]
+  end
+  subject { TableFor::Table.new(template, TestTableFor::User, users, lambda { "content" }) }
+  before { subject.stub(:columns).and_return([:first_name, :last_name]) }
+
+  describe "#human_column_names" do
+    it "returns a list with huminzed column names" do
+      subject.human_column_names.should == ["First name", "Last name"]
+    end
+  end
+
+  describe "#row_builders" do
+    it "returns a row builder for each record" do
+      subject.row_builders.map(&:class).should == [TableFor::RowBuilder, TableFor::RowBuilder]
+    end
+  end
+
+  describe "#render" do
+    it "wrapps the caption, header, body and footer in a table tag" do
+      subject.render.should include(%Q{<table class="list">})
+      subject.render.should include(%Q{<caption>Users</caption>})
+      subject.render.should include(%Q{</table>})
+    end
+  end
+
+  describe "#human_association_name" do
+    it "returns the collection name" do
+      subject.send(:human_association_name).should == "Users"
+    end
+  end
+
+  describe "#caption" do
+    it "wraps the human_association_name in a caption tag" do
+      subject.send(:caption).should == "<caption>Users</caption>"
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: table_for
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Nicklas Ramh\xC3\xB6j"
@@ -16,13 +16,31 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-05 00:00:00 +02:00
+date: 2010-10-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,7 +51,7 @@ dependencies:
         - 0
         version: "3.0"
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 description: Renders a table for your model collection
 email: 
 - ramhoj@gmail.com
@@ -46,8 +64,14 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/table_for/helper.rb
+- lib/table_for/row_builder.rb
+- lib/table_for/table.rb
+- lib/table_for/table_builder.rb
 - lib/table_for/version.rb
 - lib/table_for.rb
+- spec/spec_helper.rb
+- spec/support/user.rb
+- spec/table_for/table_spec.rb
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/ramhoj/table_for