totally_tabular 0.1.0

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 Joe Fiorini
+
+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.textile

@@ -0,0 +1,79 @@
+h1. Totally Tabular!
+
+  Assuming I have 5 people with:
+
+    * first_name
+    * last_name
+    * registration_status
+
+  My pointy-haired boss wants to see a list of these people on our
+  administrative dashboard. Sure, I could write some ugly ERB like so:
+
+<pre>
+  <code>
+    <table class="people">
+      <thead>
+      <tr>
+        <th class="header">First Name</th>
+        <th>Last Name</th>
+        <th>Registration Status</th>
+      </tr>
+      </thead>
+      <tbody>
+      <% @people.each do |person| %>
+        <tr class="<%= person.registration_status %>">
+          <td>Michael Bluth</td>
+          <td>Bluth</td>
+          <td>
+            <% if person.registered? %>
+              <strong>Registered</strong>
+            <% else %>
+              <em>Unregistered</em>
+            <% end %>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </code>
+</pre>
+
+  But why? I mean, we're using Ruby for Pete's sake! How about a cleaner way to do the same thing?
+
+<pre>
+  <code>
+    <%= person_table(people_presenter.people, :class => 'people') %>
+  </code>
+</pre>
+
+  Okay, so that's just a custom Rails helper method. Nothing special. But let's look at the definition of the helper method! That's where the special sauce is.
+
+<pre>
+  <code>
+    def person_table(people, attributes={})
+      TableView.new(@people, :class => 'people') do
+        define_column("First Name") do |person|
+          header_attributes!(:class => 'header')
+          row_attributes!(:class => person.registration_status)
+          template! do
+            person.first_name
+          end
+        end
+        define_column("Last Name") do |person|
+          template! do
+            person.last_name
+          end
+        end
+        define_column("Registration Status") do |person|
+          template! do
+            if person.registered?
+              content_tag(:strong, "Registered")
+            else
+              content_tag(:em, "Unregistered")
+            end
+          end
+        end
+      end
+    end
+  </code>
+</pre>
+

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "totally_tabular"
+    gem.summary = %Q{DSL for creating HTML tables}
+    gem.description = %Q{HTML tables are a pain in the ass. Use totaly_tabular to help make creating tables a breeze!}
+    gem.email = "joe@joefiorini.com"
+    gem.homepage = "http://github.com/faithfulgeek/totally_tabular"
+    gem.authors = ["Joe Fiorini"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+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.0

data/lib/core_ext/object.rb

@@ -0,0 +1,8 @@
+class Object
+  unless defined? instance_exec # 1.9
+    def instance_exec(*arguments, &block)
+      block.bind(self)[*arguments]
+    end
+  end
+end
+

data/lib/core_ext/proc.rb

@@ -0,0 +1,13 @@
+class Proc #:nodoc:
+  def bind(object)
+    block, time = self, Time.now
+    (class << object; self end).class_eval do
+      method_name = "__bind_#{time.to_i}_#{time.usec}"
+      define_method(method_name, &block)
+      method = instance_method(method_name)
+      remove_method(method_name)
+      method
+    end.bind(object)
+  end
+end
+

data/lib/totally_tabular/column.rb

@@ -0,0 +1,30 @@
+module TotallyTabular
+  class Column
+    attr_accessor :name, :template, :header_attributes, :row_attributes, :definition, :cell_attributes
+
+    def initialize(name, &block)
+      @name = name
+      @header_attributes = {}
+      @row_attributes = {}
+      @cell_attributes = {}
+      @definition = block
+    end
+
+    def template!(&block)
+      @template = block
+    end
+
+    def header_attributes!(attributes={})
+      @header_attributes = attributes
+    end
+
+    def row_attributes!(attributes={})
+      @row_attributes = attributes
+    end
+
+    def cell_attributes!(attributes={})
+      @cell_attributes = attributes
+    end
+
+  end
+end

data/lib/totally_tabular/html_helper.rb

@@ -0,0 +1,21 @@
+module TotallyTabular
+  class HtmlHelper
+
+    EMPTY_TAG = /br|hr|img|meta|link|input|base|area|col|frame|param/
+
+    def content_tag(tag, content="", attributes={})
+      if tag.to_s =~ EMPTY_TAG
+        "<%s%s>" % [tag, attrs(attributes)]
+      else
+        "<%s%s>%s</%s>" % [tag, attrs(attributes), content, tag]
+      end
+    end
+
+    private
+
+    def attrs(attributes)
+      return "" if attributes.empty?
+      attr_string = ' %s' % attributes.map { |attr| '%s="%s"' % attr }.join(" ")
+    end
+  end
+end

data/lib/totally_tabular/row.rb

@@ -0,0 +1,19 @@
+module TotallyTabular
+  class Row
+
+    def initialize
+      @helper = HtmlHelper.new
+      @attributes = {}
+    end
+
+    def attributes!(attributes={})
+      @attributes = attributes
+    end
+
+    def render(content)
+      if !content.empty?
+        @helper.content_tag(:tr, content, @attributes)
+      end.to_s
+    end
+  end
+end

data/lib/totally_tabular/table.rb

@@ -0,0 +1,18 @@
+module TotallyTabular
+  class Table
+    attr_reader :columns
+
+    def initialize
+      @columns = []
+    end
+
+    def define_column(name, header_attributes={}, &block)
+      column = Column.new(name, &block)
+      @columns << column
+    end
+
+    def columns_count
+      @columns.length
+    end
+  end
+end

data/lib/totally_tabular/table_view.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/table'
+require File.dirname(__FILE__) + '/column'
+require File.dirname(__FILE__) + '/row'
+require File.dirname(__FILE__) + '/html_helper'
+
+module TotallyTabular
+  class TableView
+
+    def initialize(collection, options={}, &block)
+      @collection = collection
+      @options = options
+      @column_definition = block
+      @helper = HtmlHelper.new
+    end
+
+    def render
+      table = Table.new
+      table.instance_eval(&@column_definition)
+      rows = build_rows(@collection, table.columns)
+      headers = if @collection.empty?
+                  ""
+                else
+                  build_headers(table.columns)
+                end
+      tbody = @helper.content_tag(:tbody, rows.join)
+      thead = @helper.content_tag(:thead, headers)
+      tfoot = @helper.content_tag(:tfoot)
+      @helper.content_tag(:table, [thead, tbody, tfoot], options)
+    end
+
+    def options
+      @options
+    end
+
+    private
+
+    def build_rows(collection, columns)
+      collection.map do |item|
+        row = Row.new
+        row_attributes = nil
+        row.render(columns.map do |column|
+          column.instance_exec(item, &column.definition)
+          row.attributes!(column.row_attributes)
+          @helper.content_tag(:td, column.template.call(item, row), column.cell_attributes)
+        end.join)
+      end
+    end
+
+    def build_headers(columns)
+      headers = columns.map do |column|
+        @helper.content_tag(:th, column.name, column.header_attributes)
+      end
+      Row.new.render(headers)
+    end
+
+  end
+end

data/lib/totally_tabular.rb

@@ -0,0 +1,3 @@
+module TotallyTabular; end
+
+require 'totally_tabular/table_view'

data/spec/lib/core_ext/instance_exec_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "instance_exec" do
+
+  it "should have instance_exec method on object" do
+    Object.new.should respond_to(:instance_exec)
+  end
+
+  it "should provide arguments in a block" do
+    the_object = Object.new
+    final_object = nil
+    b = Proc.new { |o| final_object = o }
+    Object.new.instance_exec(the_object, &b)
+    final_object.should == the_object
+  end
+end

data/spec/lib/totally_tabular/html_helper_spec.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+include TotallyTabular
+
+describe HtmlHelper do
+
+  before do
+    @helper = HtmlHelper.new
+  end
+
+  it "is instantiated" do
+    @helper.should_not be_nil
+  end
+
+  it "returns an empty table tag" do
+    @helper.content_tag(:table).should == "<table></table>"
+  end
+
+  it "returns an empty br tag" do
+    @helper.content_tag(:br).should == "<br>"
+  end
+
+  it "returns an empty input tag" do
+    @helper.content_tag(:input).should == "<input>"
+  end
+
+  it "returns an empty img tag" do
+    @helper.content_tag(:img).should == "<img>"
+  end
+
+  it "returns a tag with content" do
+    @helper.content_tag(:strong, "blah").should == "<strong>blah</strong>"
+  end
+
+  it "renders with a class specified" do
+    @helper.content_tag(:strong, "blah", :class => "diddy").should =~ /class=\"diddy\"/
+  end
+
+  it "renders with a href attribute specified" do
+    url = "http://www.google.com"
+    @helper.content_tag(:a, "blah", :href => url).should =~ /href=\"#{url}\"/
+  end
+
+  it "renders empty tags with attributes" do
+    src = "http://www.asite.com/images/my_image.jpg"
+    @helper.content_tag(:img, "", :src => src).should =~ /src=\"#{src}\"/
+  end
+end

data/spec/lib/totally_tabular/table_view_spec.rb

@@ -0,0 +1,180 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+require 'ostruct'
+require 'nokogiri'
+
+include TotallyTabular
+
+describe TableView do
+
+  def selector(string, selector)
+    Nokogiri(string).css(selector)
+  end
+
+  before do
+    @table_view = TableView.new([]) do
+      define_column("col") do |o|
+      end
+    end
+  end
+
+  it "should be instantiated" do
+    @table_view.should_not be_nil
+  end
+
+  it "should take a collection when initialized" do
+    lambda { TableView.new }.should raise_error(ArgumentError)
+  end
+
+  it "should take a hash of options" do
+    lambda { TableView.new(mock, {}) }.should_not raise_error
+  end
+
+  it "should render an empty table" do
+    @table_view.render.should == "<table><thead></thead><tbody></tbody><tfoot></tfoot></table>"
+  end
+
+  it "should render with a class" do
+    table_class = "CLASS"
+
+    t = TableView.new([], :class => table_class) do |table|
+      table.define_column("col") do |o|
+      end
+    end
+
+    selector(t.render, "table.#{table_class}").should_not be_empty
+  end
+
+  it "should render with cellpadding, cellspacing" do
+    t = TableView.new([], :cellpadding => 0, :cellspacing => 0) do |table|
+      table.define_column("col") do |o|
+      end
+    end
+
+    selector(t.render, "table[cellpadding='0']").should_not be_empty
+    selector(t.render, "table[cellspacing='0']").should_not be_empty
+  end
+
+  context "displaying multiple objects in rows" do
+
+    before do
+      o = OpenStruct.new(:name => "Joe", :coolness => "Really cool!", :age => 28)
+      o2 = OpenStruct.new(:name => "Jonathan", :coolness => "Kinda cool.", :age => 33)
+      o3 = OpenStruct.new(:name => "Gary", :coolness => "Eh.", :age => 26)
+      o4 = OpenStruct.new(:name => "Josh", :coolness => "Lame.", :age => 26)
+      @table_view = TableView.new([o, o2, o3, o4]) do |t|
+        t.define_column("Name") do |o|
+          template! do
+            "%s is %s" % [o.name, o.coolness]
+          end
+        end
+        t.define_column("Age") do |o|
+          template! do
+            o.age
+          end
+        end
+      end
+      @result = @table_view.render
+    end
+
+    it "should display 4 rows" do
+      selector(@result, "table tbody tr").length.should == 4
+    end
+
+    it "should have 2 column headers" do
+      selector(@result, "table thead th").length.should == 2
+    end
+
+    it "should have 2 columns" do
+      selector(@result, "table tr:first-child td").length.should == 2
+    end
+  end
+
+  context "defining columns" do
+
+    it "allows defining class on header" do
+      t = TableView.new([1]) do
+        define_column("Blah") do |o|
+          header_attributes!(:class => 'blahdiddy')
+          template! do
+          end
+        end
+      end
+
+      selector(t.render, "table th.blahdiddy").length.should == 1
+    end
+
+    it "allows defining a class on row" do
+      t = TableView.new([1]) do
+        define_column("Blah") do |o|
+          row_attributes!(:class => 'diddy')
+          template! do
+          end
+        end
+      end
+
+      selector(t.render, "table tr.diddy").length.should == 1
+    end
+
+    it "allows defining a class from an object attribute" do
+      obj = OpenStruct.new(:status => 'unread')
+      t = TableView.new([obj]) do
+        define_column("Blah") do |o|
+          row_attributes!(:class => o.status)
+          template! do
+          end
+        end
+      end
+
+      selector(t.render, "table tr.unread").length.should == 1
+    end
+
+    it "allows defining a class on the cell" do
+      t = TableView.new([1]) do
+        define_column("Blah") do |o|
+          cell_attributes!(:class => 'diddy')
+          template! {}
+        end
+      end
+
+      selector(t.render, "table td.diddy").length.should == 1
+    end
+
+    it "should take a block and give a table class" do
+      table = TableView::Table.new
+      TableView::Table.stub!(:new).and_return(table)
+
+      column_definition = Proc.new {  }
+      table_view = TableView.new([], {}, &column_definition)
+
+      table.should_receive(:instance_eval)
+
+      table_view.render
+    end
+
+    it "should allow me to define a column" do
+      column_definition = Proc.new do
+        define_column("Joe") do
+          template! do
+          end
+        end
+      end
+
+      t = TableView.new([], {}, &column_definition)
+      lambda { t.render }.should_not raise_error
+    end
+
+    it "should allow defining the column body when defining the column" do
+      t = TableView.new(["Judge"]) do
+        define_column("Name") do |item|
+          template! do
+            "My name is %s." % item
+          end
+        end
+      end
+
+      selector(t.render, "table tr td").inner_html.should == "My name is Judge."
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'totally_tabular'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/totally_tabular_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "TotallyTabular" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/totally_tabular.gemspec

@@ -0,0 +1,71 @@
+# 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{totally_tabular}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joe Fiorini"]
+  s.date = %q{2010-01-17}
+  s.description = %q{HTML tables are a pain in the ass. Use totaly_tabular to help make creating tables a breeze!}
+  s.email = %q{joe@joefiorini.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/core_ext/object.rb",
+     "lib/core_ext/proc.rb",
+     "lib/totally_tabular.rb",
+     "lib/totally_tabular/column.rb",
+     "lib/totally_tabular/html_helper.rb",
+     "lib/totally_tabular/row.rb",
+     "lib/totally_tabular/table.rb",
+     "lib/totally_tabular/table_view.rb",
+     "spec/lib/core_ext/instance_exec_spec.rb",
+     "spec/lib/totally_tabular/html_helper_spec.rb",
+     "spec/lib/totally_tabular/table_view_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/totally_tabular_spec.rb",
+     "totally_tabular.gemspec"
+  ]
+  s.homepage = %q{http://github.com/faithfulgeek/totally_tabular}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{DSL for creating HTML tables}
+  s.test_files = [
+    "spec/lib/core_ext/instance_exec_spec.rb",
+     "spec/lib/totally_tabular/html_helper_spec.rb",
+     "spec/lib/totally_tabular/table_view_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/totally_tabular_spec.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<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: totally_tabular
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joe Fiorini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !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: HTML tables are a pain in the ass. Use totaly_tabular to help make creating tables a breeze!
+email: joe@joefiorini.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/core_ext/object.rb
+- lib/core_ext/proc.rb
+- lib/totally_tabular.rb
+- lib/totally_tabular/column.rb
+- lib/totally_tabular/html_helper.rb
+- lib/totally_tabular/row.rb
+- lib/totally_tabular/table.rb
+- lib/totally_tabular/table_view.rb
+- spec/lib/core_ext/instance_exec_spec.rb
+- spec/lib/totally_tabular/html_helper_spec.rb
+- spec/lib/totally_tabular/table_view_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/totally_tabular_spec.rb
+- totally_tabular.gemspec
+has_rdoc: true
+homepage: http://github.com/faithfulgeek/totally_tabular
+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: DSL for creating HTML tables
+test_files: 
+- spec/lib/core_ext/instance_exec_spec.rb
+- spec/lib/totally_tabular/html_helper_spec.rb
+- spec/lib/totally_tabular/table_view_spec.rb
+- spec/spec_helper.rb
+- spec/totally_tabular_spec.rb