tubular 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tubular.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryan Closner
+
+MIT License
+
+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.md

@@ -0,0 +1,141 @@
+# Tubular
+
+Tubular helps you quickly and easily generate HTML tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tubular'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tubular
+
+## Usage
+
+Tubular was designed with collections in mind.
+
+Given a model like the following:
+
+```ruby
+  class User < ActiveRecord::Base
+    attr_accesible :first_name, :last_name, :email
+  end
+```
+
+And a collection populated with instances of the given model:
+
+```ruby
+  @users = [
+    User.new(:first_name => "John",    :last_name => "Wayne",    :email => "john@wayne.com"),
+    User.new(:first_name => "Air",     :last_name => "Jordan",   :email => "air@jordan.com"),
+    User.new(:first_name => "Charles", :last_name => "Bukowski", :email => "c@bukowski.com")
+  ]
+```
+
+One can easily generate an HTML table in the following manner:
+
+```erb
+  <%= table_for(@users) do %>
+    <% column :first_name %>
+    <% column :last_name %>
+    <% column :email %>
+  <% end %>
+```
+
+This ERB template would generate the following HTML:
+
+```html
+  <table>
+    <thead>
+      <tr>
+        <th>First Name</th>
+        <th>Last Name</th>
+        <th>Email</th>
+      <tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>John</td>
+        <td>Wayne</td>
+        <td>john@wayne.com</td>
+      </tr>
+      <tr>
+        <td>Air</td>
+        <td>Jordan</td>
+        <td>air@jordan.com</td>
+      </tr>
+      <tr>
+        <td>Charles</td>
+        <td>Bukowski</td>
+        <td>c@bukowski.com</td>
+      </tr>
+    </tbody>
+  </table>
+```
+
+# API
+
+In order to customize the output of the generated HTML, one can pass the following
+options:
+
+```erb
+  <%= table_for(@users, :table_html => { :class => "index_table" }) do %>
+    <% column :first_name, :header_html    => { :class => "sortable" } %> 
+    <% column :last_name,  :cell_html      => { :class => "featured" } %> 
+    <% column :email,      :header_content => proc { "Email #{1 + 1}" } %>
+    <% column :full_name,  :header_content => "Full Name", :cell_content => proc {|user| "#{ user.first_name } #{ user.last_name }" } %>
+    <% column :actions,    :header_content => "",          :cell_content => "Some action." %>
+  <% end %>
+```
+This ERB template would generate the following HTML:
+
+```html
+  <table class="index_table">
+    <thead>
+      <tr>
+        <th class="sortable">First Name</th>
+        <th>Last Name</th>
+        <th>Email 2</th>
+        <th>Full Name</th>
+        <th></th>
+      <tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>John</td>
+        <td class="featured">Wayne</td>
+        <td>john@wayne.com</td>
+        <td>John Wayne</td>
+        <td>Some action.</td>
+      </tr>
+      <tr>
+        <td>Air</td>
+        <td class="featured">Jordan</td>
+        <td>air@jordan.com</td>
+        <td>Air Jordan</td>
+        <td>Some action.</td>
+      </tr>
+      <tr>
+        <td>Charles</td>
+        <td class="featured">Bukowski</td>
+        <td>c@bukowski.com</td>
+        <td>Charles Bukowski</td>
+        <td>Some action.</td>
+      </tr>
+    </tbody>
+  </table>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tubular/builder.rb

@@ -0,0 +1,66 @@
+module Tubular
+  class Builder
+
+    delegate :content_tag, :to => :context
+
+    def self.render(*args, &block)
+      new(*args, &block).render
+    end
+
+    def initialize(attributes, &block)
+      @context    = attributes.fetch(:context)
+      @collection = attributes.fetch(:collection, []) 
+      @table_html = attributes.fetch(:table_html, {})
+      @columns    = []
+
+      if block_given?
+        instance_eval(&block)
+      end
+    end
+
+    def render
+      content_tag(:table, table_html) do
+        (render_table_head + render_table_body) if columns.size > 0
+      end
+    end
+
+    def column(*args, &block)
+      columns << build_column(*args, &block) 
+    end
+
+    protected
+
+    attr_reader :context, :collection, :columns, :table_html
+
+    def build_column(*args, &block)
+      Column.new(context, *args, &block)
+    end
+
+    def render_table_head
+      content_tag(:thead) do
+        content_tag(:tr) do
+          columns.map do |column| 
+            content_tag(:th, column.header_html) do
+              column.render_header_content
+            end
+          end.join.html_safe
+        end
+      end
+    end
+
+    def render_table_body
+      content_tag(:tbody) do
+        collection.map do |record|
+          content_tag(:tr) do
+            columns.map do |column|
+              content_tag(:td, column.cell_html) do
+                column.render_body_content(record)
+              end
+            end.join.html_safe
+          end
+        end.join.html_safe
+      end
+    end
+
+  end # class Builder
+end # module Tubular

data/lib/tubular/column.rb

@@ -0,0 +1,53 @@
+module Tubular
+  class Column
+
+    attr_reader :context, :method_name, :header_html,
+      :header_content, :cell_html, :cell_content
+
+    delegate :t, :to => :context
+
+    def initialize(context, *args, &block)
+      attributes = args.extract_options!
+
+      @context        = context
+      @method_name    = attributes.fetch(:method_name, args.shift)
+      @header_html    = attributes.fetch(:header_html, {})
+      @header_content = attributes.fetch(:header_content, nil)
+      @cell_html      = attributes.fetch(:cell_html, {})
+      @cell_content   = attributes.fetch(:cell_content, nil)
+
+      if block_given?
+        @cell_content = block
+      end
+    end
+
+    def render_header_content
+      case header_content
+      when Proc 
+        header_content.call
+      when String, Symbol
+        t(header_content)
+      when NilClass
+        method_name ? t(method_name) : nil
+      end
+    end
+
+    def render_body_content(record)
+      case cell_content
+      when Proc
+        call_content_proc(cell_content, record)
+      when NilClass
+        method_name && record.respond_to?(method_name) ? record.send(method_name) : nil
+      else
+        cell_content.to_s
+      end
+    end
+
+    protected
+
+    def call_content_proc(content, record = nil)
+      content.arity > 0 ? content.call(record) : content.call
+    end
+
+  end # class Column
+end # module Tubular

data/lib/tubular/helper.rb

@@ -0,0 +1,12 @@
+module Tubular
+  module Helper
+    def table_for(collection, options = {}, &block)
+      options.merge!({
+        :context    => self,
+        :collection => collection
+      })
+
+      Builder.render(options, &block)
+    end
+  end
+end

data/lib/tubular/railtie.rb

@@ -0,0 +1,7 @@
+require "tubular/helper"
+
+class Tubular::Railtie < Rails::Railtie
+  config.before_initialize do
+    ActionView::Base.send(:include, Tubular::Helper)
+  end
+end

data/lib/tubular/version.rb

@@ -0,0 +1,3 @@
+module Tubular
+  VERSION = "0.0.2"
+end

data/lib/tubular.rb

@@ -0,0 +1,6 @@
+require "tubular/railtie" if defined?(Rails)
+require "tubular/builder"
+require "tubular/column"
+
+module Tubular
+end

data/tubular.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tubular/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tubular"
+  gem.version       = Tubular::VERSION
+  gem.authors       = ["Ryan Closner"]
+  gem.email         = ["ryan@ryanclosner.com"]
+  gem.description   = %q{Helper to quickly and easily generate HTML tables}
+  gem.summary       = %q{Helper to quickly and easily generate HTML tables}
+  gem.homepage      = "http://github.com/rclosner/tubular"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tubular
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -17,7 +17,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tubular.rb
+- lib/tubular/builder.rb
+- lib/tubular/column.rb
+- lib/tubular/helper.rb
+- lib/tubular/railtie.rb
+- lib/tubular/version.rb
+- tubular.gemspec
 homepage: http://github.com/rclosner/tubular
 licenses: []
 post_install_message: 
@@ -43,4 +55,3 @@ signing_key:
 specification_version: 3
 summary: Helper to quickly and easily generate HTML tables
 test_files: []
-has_rdoc: