table_for_collection 1.0

data/Changelog

@@ -0,0 +1,7 @@
+== v.0.2
+
+Packaged as a gem.
+
+== v.0.1
+
+Initial version: table_for method added.

data/Gemfile

@@ -0,0 +1,16 @@
+source :gemcutter
+
+gem "rails"
+
+group :development, :test do
+  gem "rspec", ">=2.0.0"
+  gem "autotest"
+  gem "webrat"
+
+  case RUBY_VERSION
+  when /^1\.9/
+    gem 'ruby-debug19'
+  when /^1\.8/
+    gem 'ruby-debug'
+  end
+end

data/README.rdoc

@@ -0,0 +1,99 @@
+== Description
+
+table_for_collection is a simple gem used to render tables based on the given collection.
+
+=== Simplest examle
+
+  <%= table_for @users do -%>
+    <% columns :name, :email, :address %>
+  <% end %>
+
+In this case you just put fields list to the :columns method.
+This ruby code will produce following HTML:
+
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Email</th>
+        <th>Address</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>John Smith</td>
+        <td>john.smith@example.com</td>
+        <td>100 Spear St., NY, USA</td>
+      </tr>
+    </tbody>
+  </table>
+
+=== Simple examle
+
+  <%= table_for @users, :html => {
+    :class => "simple-table",
+    :id => "users",
+    :width => "100%",
+    :tr => {
+      :class => "simple-row"
+    }
+  } do -%>
+    <% column :name %>
+    <% column :email %>
+    <% column :address, :title => "Home" %>
+  <% end %>
+  
+You can put :html hash to the options list. In this case table will be created with
+given html attributes. Also :title value in the :column method will be used as column's
+title. It will produce HTML similar to:
+  
+  <table class="simple-table" id="users" width="100%">
+    <thead>
+      <tr>
+        <td>Name</td>
+        <td>Email</td>
+        <td>Home</td>
+      </tr>
+    </thead>
+    <tbody>
+      <tr class="simple-row"
+        ...
+      </tr>
+    </tbody>
+  </table>
+
+=== More complex example
+
+  <%= table_for @users do -%>
+    <% column :login, :title => "User name" %>
+    <% column :email %>
+    <% column :title => "Full name" do |user| %>
+      <% [user.first_name, user.last_name].join(" ") %>
+    <% end %>
+    <% column :title => "Actions" do |user| %>
+      <% [link_to("Show", user), link_to("Delete", user, :method => :delete)].join(" | ") %>
+    <% end %>
+  <% end %>
+
+=== Example with colorized rows
+
+  <%= table_for @users, :html => { :tr => { :class => "row" } }, :stripes => %w{even odd} do %>
+    <% column :name %>
+    <% column :email %>
+    <% column :address %>
+  <% end %>
+  
+Also class given by :stripe option will be merged with options[:html][:tr] so this code will produce following HTML:
+
+  <tr class="row even">...
+  <tr class="row odd">...
+  <tr class="row even">...
+  <tr class="row odd">...
+  
+== Known issues
+
+Unfortunately it works incorrect if there is no "-" before %> in this code:
+
+  <%= table_for @users do -%>
+  
+We hope it will be fixed soon.

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+desc "Test the table_for plugin."
+RSpec::Core::RakeTask.new('spec')
+

data/init.rb

@@ -0,0 +1 @@
+require 'table_for'

data/lib/core_ex/array.rb

@@ -0,0 +1,13 @@
+module CoreEx
+  module ArrayIterator
+    def next
+      unless self.size.zero?
+        res = (@current ||= 0)
+        if self.size == (@current += 1)
+          @current = 0
+        end
+        self[res]
+      end
+    end
+  end
+end

data/lib/table_for/callback_column.rb

@@ -0,0 +1,11 @@
+module TableHelper
+  class CallbackColumn < Column # :nodoc:
+    def initialize(template, obj, ops)
+      super
+      @title = @options.delete(:title) || "&nbsp;"
+    end
+    def content_for(record)
+      @attr.call(record)
+    end
+  end
+end

data/lib/table_for/column.rb

@@ -0,0 +1,12 @@
+module TableHelper
+  class Column # :nodoc:
+    attr_reader :title
+    def initialize(template, obj, ops)
+      @template, @options, @attr, @title = template, ops, obj, ""
+    end
+  
+    def content_for
+      raise NoMethodError, "Use SimpleColumn or CallbackColumn"
+    end
+  end
+end

data/lib/table_for/helper.rb

@@ -0,0 +1,42 @@
+module TableHelper
+  # Simplest examle:
+  # 
+  #   <%= table_for @users do -%>
+  #     <% columns :name, :email, :address %>
+  #   <% end %>
+  # 
+  # Simple examle:
+  # 
+  #   <%= table_for @users, :http => { :class => "simple-table", :id => "users" } do -%>
+  #     <% column :name %>
+  #     <% column :email %>
+  #     <% column :address %>
+  #   <% end %>
+  # 
+  # More complex example:
+  # 
+  #   <%= table_for @users do -%>
+  #     <% column :login, :title => "User name" %>
+  #     <% column :email %>
+  #     <% column :title => "Full name" do |user| %>
+  #       <% [user.first_name, user.last_name].join(" ") %>
+  #     <% end %>
+  #     <% column :title => "Actions" do |user| %>
+  #       <% link_to "Show", user %>
+  #       <% link_to "Delete", user, :method => :delete %>
+  #     <% end %>
+  #   <% end %>
+  #
+  def table_for(records, *args, &proc)
+    raise ArgumentError, "Missing block" unless block_given?
+    options = args.extract_options!
+    raise ArgumentError, "Records should be array" unless records.is_a? Enumerable
+    t = Table.new(self, records, options)
+    t.instance_eval(&proc)
+    t.draw
+  end
+end
+
+ActionView::Base.class_eval {
+  include TableHelper
+}

data/lib/table_for/simple_column.rb

@@ -0,0 +1,11 @@
+module TableHelper
+  class SimpleColumn < Column # :nodoc:
+    def initialize(template, obj, ops)
+      super
+      @title = @options.delete(:title) || @attr.to_s.humanize || "&nbsp;"
+    end
+    def content_for(record)
+      record.send(@attr)
+    end
+  end
+end

data/lib/table_for/table.rb

@@ -0,0 +1,96 @@
+require "core_ex/array"
+
+module TableHelper
+  class Table # :nodoc:
+    delegate :content_tag, :to => :@template
+
+    def initialize(template, records, options = {})
+      @template, @records, @columns = template, records, []
+      # table's html options
+      @table_html_options = options.delete(:html) || {}
+      # trs' html options
+      @tr_html_options = @table_html_options.delete(:tr) || {}
+      # stripes (cycling)
+      @stripes = options.delete(:stripes) || []
+      @stripes.extend CoreEx::ArrayIterator
+    end
+
+    def columns(*args)
+      unless args.blank?
+        args.each do |arg|
+          self.column(arg)
+        end
+      else
+        raise ArgumentError, "At least one attribute name should be given"
+      end
+    end
+
+    def column(*args, &block)
+      col_options = args.extract_options!
+      unless args.blank?
+        attr = args.shift
+        @columns << SimpleColumn.new(@template, attr, col_options)
+      else
+        if block_given?
+          @columns << CallbackColumn.new(@template, block, col_options)
+        else
+          raise ArgumentError, "Attribute name or block should be given"
+        end
+      end
+    end
+
+    def draw
+      content_tag :table, @table_html_options do
+        head + body
+      end
+    end
+
+  protected
+
+    def method_missing(method, *args, &proc)
+      @template.send(method, *args, &proc)
+    end
+
+  private
+
+    def head
+      content_tag :thead do
+        content_tag :tr do
+          @columns.map do |col|
+            content_tag :th do
+              col.title
+            end
+          end.join
+        end
+      end
+    end
+
+    def body
+      content_tag :tbody do
+        @records.map do |rec|
+          content_tag(:tr, tr_options) do
+            @columns.map do |col|
+              content_tag :td do
+                col.content_for(rec).to_s
+              end
+            end.join
+          end
+        end.join
+      end
+    end
+    
+    def tr_options
+      res = @tr_html_options.nil? ? {} : @tr_html_options.clone
+      html_class = @stripes.next
+      unless html_class.nil?
+        if res.has_key?(:class)
+          res[:class] += " " + html_class
+        else
+          res.merge!({ :class => html_class })
+        end
+      end
+      res
+    end
+
+  end
+end

data/lib/table_for/version.rb

@@ -0,0 +1,4 @@
+module TableHelper
+  GEM_NAME = "table_for_collection"
+  VERSION  = "1.0"
+end

data/lib/table_for_collection.rb

@@ -0,0 +1,10 @@
+require "action_view"
+require "table_for/helper"
+
+module TableHelper
+  private
+    autoload :Column, "table_for/column"
+    autoload :SimpleColumn, "table_for/simple_column"
+    autoload :CallbackColumn, "table_for/callback_column"
+    autoload :Table, "table_for/table"
+end

data/spec/core_ex/array_spec.rb

@@ -0,0 +1,39 @@
+require 'core_ex/array'
+
+describe Array do
+  describe "when non-empty" do
+    let(:array) do
+      [1, 2, 3]
+    end
+    before(:each) do
+      array.extend CoreEx::ArrayIterator
+    end
+    it "should have :next method" do
+      array.should respond_to(:next)
+    end
+    describe "method :next" do
+      it "should return valid values" do
+        array.next.should == 1
+        array.next.should == 2
+        array.next.should == 3
+        array.next.should == 1
+      end
+    end
+  end
+  describe "when empty" do
+    let(:array) do
+      []
+    end
+    before(:each) do
+      array.extend CoreEx::ArrayIterator
+    end
+    it "should have :next method" do
+      array.should respond_to(:next)
+    end
+    it "should return nil" do
+      array.next.should be_nil
+      array.next.should be_nil
+      array.next.should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "table_for"
+require "webrat"
+
+RSpec.configure do |config|
+  config.include(Webrat::Matchers)
+end

data/spec/table_for_collection/table_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe TableHelper::Table do
+  # ActionView::Base instance
+  let(:template) do
+    ActionView::Base.new
+  end
+  # users list (stubbed data)
+  let(:users) do
+    [
+      mock({
+        :name => "John Smith",
+        :email => "tester@example.com",
+        :address => "100, Spear Street, NY, USA",
+      })
+    ]
+  end
+  # table instance
+  let(:table) do
+    TableHelper::Table.new(template, users)
+  end
+  # check are methods available
+  describe "should respond_to" do
+    [:columns, :column, :draw, :content_tag].each do |method|
+      it "#{method}" do
+        table.should respond_to(method)
+      end
+    end
+  end
+end

data/spec/table_for_collection_spec.rb

@@ -0,0 +1,203 @@
+require "spec_helper"
+
+describe ActionView::Base do
+  # ActionView::Base instance
+  let(:template) do
+    ActionView::Base.new
+  end
+  # users list (stubbed data)
+  let(:users) do
+    [
+      mock({
+        :id => 1209,
+        :name => "John Smith",
+        :email => "smith@matrix.net",
+        :address => "100, Spear Street, NY, USA",
+      }),
+      mock({
+        :id => 2123,
+        :name => "Thomas Anderson",
+        :email => "neo@matrix.net",
+        :address => "200, Spear Street, NY, USA",
+      }),
+      mock({
+        :id => 3323,
+        :name => "Trinity",
+        :email => "trinity@matrix.net",
+        :address => "300, Spear Street, NY, USA",
+      }),
+      mock({
+        :id => 4912,
+        :name => "Morpheus",
+        :email => "morpheus@matrix.net",
+        :address => "400, Spear Street, NY, USA",
+      })
+    ]
+  end
+  # check if method available
+  it "should respond to :table_for" do
+    template.should respond_to(:table_for)
+  end
+  
+  # main method
+  describe ":table_for method" do
+    # <%= table_for @users %>
+    it "should raise if no block given" do
+      lambda do
+        template.table_for(users)
+      end.should raise_error(ArgumentError)
+    end
+    # <%= table_for @users do %>
+    #   <% column :name %>
+    # <% end %>
+    describe "with simple column" do
+      before(:each) do
+        @html = template.table_for(users) do
+          column :name
+        end
+      end
+      it "should render valid HTML" do
+        @html.should have_selector("table") do |table|
+          table.should have_selector("thead/tr/th") do |th|
+            th.should contain("Name")
+          end
+          table.should have_selector("tbody/tr") do |tr|
+            users.each do |user|
+              tr.should have_selector("td") do |td|
+                td.should contain(user.name)
+              end
+            end
+          end
+        end
+      end
+    end
+    # <%= table_for @users do %>
+    #   <% columns :name, :email, :address %>
+    # <% end %>
+    describe "with columns" do
+      before(:each) do
+        @html = template.table_for(users) do
+          columns :id, :name, :email, :address
+        end
+      end
+      it "should render valid HTML" do
+        @html.should have_selector("table") do |table|
+          table.should have_selector("thead/tr") do |tr|
+            ["Id", "Name", "Email", "Address"].each do |field|
+              tr.should have_selector("th") do |th|
+                th.should contain(field)
+              end
+            end
+          end
+        end
+      end
+    end
+    
+    # <%= table_for @users, :html => { :id => "users", :class => "simple-table" } do %>
+    #   <% column :name %>
+    # <% end %>
+    describe "with given :html options" do
+      before(:each) do
+        @html = template.table_for(users, :html => { :id => "users", :class => "simple-table" }) do
+          column :name
+        end
+      end
+      it "should render specialized table" do
+        @html.should have_selector("table#users.simple-table")
+      end
+    end
+    # <%= table_for @users do %>
+    #   <% column :name, :title => "User's name" %>
+    # <% end %>
+    describe "with titled column" do
+      before(:each) do
+        @html = template.table_for(users) do
+          column :email, :title => "Email address"
+        end
+      end
+      it "should render valid HTML" do
+        @html.should have_selector("table") do |table|
+          table.should have_selector("thead/tr/th") do |th|
+            th.should contain("Email address")
+          end
+          table.should have_selector("tbody/tr") do |tr|
+            users.each do |user|
+              tr.should have_selector("td") do |td|
+                td.should contain(user.email)
+              end
+            end
+          end
+        end
+      end
+    end
+    # <%= table_for @users do %>
+    #   <% column :title => "User's name" do |user| %>
+    #     <% content_tag :div do %>
+    #       <% [user.first_name, user.last_name].join(" ") %>
+    #     <% end %>
+    #   <% end %>
+    # <% end %>
+    describe "with callback column" do
+      before(:each) do
+        @html = template.table_for(users) do
+          column :id
+          column :title => "Addr" do |user|
+            content_tag :div do
+              user.address[0,10]
+            end
+          end
+        end
+      end
+      it "should render valid HTML" do
+        @html.should have_selector("table") do |table|
+          table.should have_selector("thead/tr/th") do |th|
+            th.should contain("Addr")
+          end
+          table.should have_selector("tbody/tr") do |tr|
+            users.each do |user|
+              tr.should have_selector("td") do |td|
+                td.should contain(user.id.to_s)
+              end
+              tr.should have_selector("td/div") do |td|
+                td.should contain(user.address[0,10])
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # <%= table_for @users, :stripes => ["odd", "even"] do %>
+    #   <% column :name %>
+    # <% end %>
+    describe "with cycling stripes" do
+      before(:each) do
+        @html = template.table_for(users, :stripes => %w{s-one s-two s-three}) do
+          column :name
+        end
+      end
+
+      it "should have valid classes" do
+        @html.should have_selector("tr.s-one", :count => 2)
+        @html.should have_selector("tr.s-two", :count => 1)
+        @html.should have_selector("tr.s-three", :count => 1)
+      end
+    end
+    
+    # <%= table_for @users, :stripes => ["odd", "even"], :html => { :tr => { :class => "table-row" } } do %>
+    #   <% column :name %>
+    # <% end %>
+    describe "with tr html" do
+      before(:each) do
+        @html = template.table_for(users, :stripes => ["odd", "even"], :html => { :tr => { :class => "table-row" } }) do
+          column :name
+        end
+      end
+
+      it "should have valid classes" do
+        @html.should have_selector("tr.odd.table-row", :count => 2)
+        @html.should have_selector("tr.even.table-row", :count => 2)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: table_for_collection
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Dima Lunich
+- Andrey Savchenko
+- Dmitry Shaposhnik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-24 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: This gem builds HTML-table using given array
+email: 
+- dima.lunich@gmail.com
+- andrey@aejis.eu
+- dmitry@shaposhnik.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/core_ex/array.rb
+- lib/table_for/callback_column.rb
+- lib/table_for/column.rb
+- lib/table_for/helper.rb
+- lib/table_for/simple_column.rb
+- lib/table_for/table.rb
+- lib/table_for/version.rb
+- lib/table_for_collection.rb
+- spec/core_ex/array_spec.rb
+- spec/spec_helper.rb
+- spec/table_for_collection/table_spec.rb
+- spec/table_for_collection_spec.rb
+- README.rdoc
+- Rakefile
+- Changelog
+- Gemfile
+- init.rb
+has_rdoc: true
+homepage: http://github.com/lunich/table_for
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ""
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: table_for_collection-1.0
+test_files: 
+- spec/core_ex/array_spec.rb
+- spec/spec_helper.rb
+- spec/table_for_collection/table_spec.rb
+- spec/table_for_collection_spec.rb