Easy Table

Table helpers for your views to facilitate creating tables using a nice DSL similar to what 'simpleform' and 'formtastic' are for forms ;)

Note: Updated with some notes on API changes and refactorings planned for the near future

Install

gem install easy-table

Demo

 
  
  data_table @posts, %w{Id Title}, :summary => 'many posts', :caption => 'posts table'  

  =>
  

    

      

        
id
        
title
      
    
    

      

        
1
        
my post
      
      

        
2
        
my other post
      
    
  
  
  

TODO

Encapsulate much of the functionality better

• method table => return EasyTable::Table object
• method row => return EasyTable::Row object
• method t.headers => return EasyTable::Header object

Clean up directory structure to put methods in the right, folders, files and containers. Also, avoid cramming too many functions into the View!

Future API (should be part of tables_on_roles gem)

  data_table posts, %w{id name}, :actions => {:edit => :owner, :delete => :admin}

  # Provide labels and role lists  
  data_table posts, %w{id name}, :actions => {:edit => [:owner, 'Edit post], :delete => [:admin, :owner, 'Delete the post']}  

Helpers

The following is the current Table Helper API.

Note: This API clearly needs to be cleaned up in the "near" future ;)

Table

• data_table
• table => EasyTable::Table
• render_table (rename to table_tag)

Table parts

• table_body (rename to tbody)

The following methods should only be available on the EasyTable::Table object returned by table

• render_tbody -> t.tbody, tbody_tag
• render_caption -> t.caption, caption_tag
• render_header -> t.head, thead_tag
• render_footer -> t.footer, tfoot_tag
• header_row -> t.header

Rows

• data_rows
• data_row
• row : => EasyTable::Row

Cells

• cells, r.cells
• cell, r.cell, cell_tag

Misc

• indent_tag

Usage

The following examples might not all be compatible with any API changes. Please raise an issue if you find a mismatch or have a problem using it ;) Thanks!

Example: Using table helper

  <% table @posts, %w{ID title} do |post, klass| -%>
      
        <%= post.id
        <%= post.title 
      
  <% end -%>  

Example: Using row helper

  <% table @posts, %w{ID title} do |post, klass| -%>
      <% row klass do |post| -%>
        <%= post.id %>
        <%= post.title %>
      <% end -%>
  <% end -%>  

Example: Using row and cell helpers

  <% table @posts, %w{ID title} do |post, klass| -%>
      <% row klass do |post| -%>
        <%= cell post.id %>
        <%= cell post.title %>
      <% end -%>
  <% end -%>  

Example: Using data_row helper

  <% table @posts, %w{ID title} do |post, klass| -%>
      <% data_row post, %w{id title}, klass -%>
  <% end -%>  

Example: Using cells helper

The last argument to cells is the CSS classes to cycle

  <% table @posts, %w{ID title} do |post, klass| -%>
      <% row klass do |post| -%>
        <%= cells post, %w{id title}, %w{number label} %>
      <% end -%>
  <% end -%>  

Example: Using rows helper

  <% render_table 'posts', 'Posts table', do -%>
      <% rows @posts, klass, :id, :title -%>
  <% end -%>  

Example: Using data_table helper

This will by default try to extract attribute names from the headers list!

  <% data_table @posts, %w{ID title}, :summary => 'Posts table' -%>

Supply an :attributes options hash value to select attributes to display

  <% data_table @posts, %w{Number Title}, :attributes => %w{id label} -%>

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) 2010 Kristian Mandrup. See LICENSE for details.