table_cloth 0.3.2 → 0.4.0

data/CHANGELOG

@@ -0,0 +1,5 @@
+Unfortunately I'm not used to making a changelog, this changelog starts at v0.4.0.
+
+* v0.4.0
+
+Change how the default presenter renders tables using ElementFactory. (https://github.com/bobbytables/element_factory)

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tablecloth.gemspec
-gemspec
-
-gem 'actionpack', '>= 3.0', '< 4.1', github: 'rails/rails', branch: 'master'
+gemspec

data/README.md

@@ -13,7 +13,9 @@ Follow me! [@robertoross](http://twitter.com/robertoross)
 
 Add this line to your application's Gemfile:
 
-    gem 'table_cloth'
+```ruby
+gem 'table_cloth'
+```
 
 And then execute:
 
@@ -31,7 +33,7 @@ $ rails g table User
 
 It will make this:
 
-```
+```ruby
 class UserTable < TableCloth::Base
   # Define columns with the #column method
   # column :name, :email
@@ -66,14 +68,14 @@ end
 Go ahead and modify it to suit your needs, pick the columns, conditions, actions, etc...
 
 In your view, you would then use this code:
-```
-<%= simple_table_for @users, with: UserTable %>
 
+```erb
+<%= simple_table_for @users, with: UserTable %>
 ```
 
-The second approach to making tables with Table Cloth is in the view.
+Or if you want more customization:
 
-```
+```erb
 <%= simple_table_for @users do |t| %>
   <% t.column :name %>
   <% t.column :email %>
@@ -95,8 +97,9 @@ class ImageColumn < TableCloth::Column
 end
 ```
 
-In your table
-```
+In your table:
+
+```erb
 <%= simple_table_for @users do |table| %>
   <% table.column :name %>
   <% table.column :image, using: ImageColumn %>
@@ -105,9 +108,9 @@ In your table
 
 ## Actions
 
-A lot of tables have an actions column to give you the full CRUD effect. They can be painful but Table Cloth incorporates a way to easily add them to your definition.
+A lot of tables have an actions column to give you the full CRUD effect. They can be painful but Table Cloth incorporates a way to easily add them to your definition:
 
-```
+```ruby
 class UserTable < TableCloth::Base
   column :name
 
@@ -127,7 +130,7 @@ end
 
 Create an initializer called ```table_cloth.rb```
 
-Configuration looks like this:
+It should look like this:
 
 ```ruby
 TableCloth::Configuration.configure do |config|
@@ -140,7 +143,7 @@ TableCloth::Configuration.configure do |config|
 end
 ```
 
-You can also configure specific tables separately.
+You can also configure specific tables separately:
 
 ```ruby
 class UserTable < TableCloth::Base
@@ -182,7 +185,6 @@ class UserTable < TableCloth::Base
     [user.name, {class: "#{user.type}-user"}]
   end
 end
-
 ```
 
 This would render something alow the lines of:

data/lib/table_cloth.rb

@@ -1,4 +1,5 @@
 require "action_view"
+require "element_factory"
 require "active_support/core_ext/class"
 require "table_cloth/version"
 

data/lib/table_cloth/presenter.rb

@@ -12,11 +12,11 @@ module TableCloth
       raise NoMethodError, "You must override the .render method"
     end
 
-    def render_header
+    def thead
       raise NoMethodError, "You must override the .header method"
     end
 
-    def render_rows
+    def tbody
       raise NoMethodError, "You must override the .rows method"
     end
 
@@ -45,16 +45,6 @@ module TableCloth
       end
     end
 
-    def wrapper_tag(type, value=nil, options={}, &block)
-      options = tag_options(type, options)
-
-      if block_given?
-        view_context.content_tag(type, options, &block)
-      else
-        view_context.content_tag(type, value, options)
-      end
-    end
-
     private
 
     def tag_options(type, options={})

data/lib/table_cloth/presenters/default.rb

@@ -2,24 +2,43 @@ module TableCloth
   module Presenters
     class Default < ::TableCloth::Presenter
       def render_table
-        wrapper_tag :table do
-          render_header + render_rows
+        @render_table ||= ElementFactory::Element.new(:table, tag_options(:table)).tap do |table|
+          table << thead
+          table << tbody
         end
       end
 
-      def render_rows
-        wrapper_tag :tbody do
-          v.raw objects.inject("") {|r, object| r + render_row(object) }
+      def thead
+        @thead ||= ElementFactory::Element.new(:thead, tag_options(:thead)).tap do |thead|
+          thead << thead_row
         end
       end
 
-      def render_row(object)
-        wrapper_tag :tr do
-          v.raw columns.inject("") {|tds, column| tds + render_td(column, object) }
+      def tbody
+        @tbody ||= ElementFactory::Element.new(:tbody, tag_options(:tbody)).tap do |tbody|
+          objects.each {|object| tbody << row_for_object(object) }
         end
       end
 
-      def render_td(column, object)
+      private
+
+      def thead_row
+        @thead_row ||= ElementFactory::Element.new(:tr, tag_options(:tr)).tap do |row|
+          column_names.each do |name|
+            row << ElementFactory::Element.new(:th, tag_options(:th).merge(text: name))
+          end
+        end
+      end
+
+      def row_for_object(object)
+        ElementFactory::Element.new(:tr, tag_options(:tr)).tap do |row|
+          columns.each do |column|
+            row << column_for_object(column, object)
+          end
+        end
+      end
+
+      def column_for_object(column, object)
         td_options = column.options[:td_options] || {}
         value = column.value(object, view_context, table)
 
@@ -30,15 +49,13 @@ module TableCloth
           td_options.update(options)
         end
 
-        wrapper_tag(:td, value, td_options)
-      end
-
-      def render_header
-        wrapper_tag :thead do
-          wrapper_tag :tr do
-            v.raw column_names.inject("") {|tags, name| tags + wrapper_tag(:th, name) }
-          end
+        if value.html_safe?
+          td_options[:inner_html] = value
+        else
+          td_options[:text] = value
         end
+
+        ElementFactory::Element.new(:td, tag_options(:td).merge(td_options))
       end
     end
   end

data/lib/table_cloth/version.rb

@@ -1,3 +1,3 @@
 module TableCloth
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/lib/action_view_extension_spec.rb

@@ -15,7 +15,6 @@ describe 'Action View Extension' do
       table.column :name, :email
     end
 
-    doc = Nokogiri::HTML(table)
-    expect(doc.at_xpath('//table')).to be_present
+    expect(table).to have_tag "table"
   end
 end

data/spec/lib/presenter_spec.rb

@@ -53,47 +53,4 @@ describe TableCloth::Presenter do
     expected = objects.map {|o| [o.id, o.name, o.email] }
     expect(subject.rows).to eq(expected)
   end
-
-  context '.wrapper_tag' do
-    it "creates a tag with a block" do
-      table = subject.wrapper_tag(:table) { "Hello" }
-      element = to_element(table, "table")
-      expect(element).to be_present
-      expect(element.text).to eq("Hello")
-    end
-
-    it "creates a tag without a block" do
-      table = subject.wrapper_tag(:table, "Hello")
-      element = to_element(table, "table")
-      expect(element).to be_present
-      expect(element.text).to eq("Hello")
-    end
-
-    context "config" do
-      let(:config) { double("config", config_for: { class: "table_class" }) }
-
-      it "inherits options from global config" do
-        TableCloth.config.stub config_for: {class: "global_class"}
-        tag = subject.wrapper_tag(:table, "Hello")
-        element = to_element(tag, "table")
-
-        expect(element[:class]).to eq("global_class")
-      end
-
-      it "includes config sent to it" do
-        tag = subject.wrapper_tag(:table, "Hello", {class: "passed_class"})
-        element = to_element(tag, "table")
-
-        expect(element[:class]).to eq("passed_class")
-      end
-
-      it "includes config from the table instance" do
-        dummy_table.stub config: config
-        tag = subject.wrapper_tag(:table, "Hello", {class: "passed_class"})
-        element = to_element(tag, "table")
-
-        expect(element[:class]).to eq("table_class")
-      end
-    end
-  end
 end

data/spec/lib/presenters/default_spec.rb

@@ -11,74 +11,60 @@ describe TableCloth::Presenters::Default do
   let(:view_context) { ActionView::Base.new }
   subject { TableCloth::Presenters::Default.new(objects, dummy_table, view_context) }
 
-  context "header" do
+  describe "#thead" do
     let(:column_names) { ["Col1", "Col2"] }
+    let(:thead) { Nokogiri::HTML(subject.thead.to_s) }
 
     before(:each) do
       subject.stub column_names: column_names
     end
 
     it "creates a thead" do
-      expect(subject.render_header).to have_tag "thead"
+      expect(thead).to have_tag "thead"
     end
 
     it "creates th's" do
-      header = Nokogiri::HTML(subject.render_header)
-      expect(header.css("th").size).to be 2
+      expect(thead.css("th").size).to be 2
     end
 
     it "creates th's with the correct text" do
-      header = Nokogiri::HTML(subject.render_header)
-      header.css("th").each_with_index {|th, i| expect(th.text).to eq(column_names[i]) }
+      thead.css("th").each_with_index do |th, i|
+        expect(th.text).to eq(column_names[i])
+      end
     end
   end
 
-  context "rows" do
-    it 'creates a tbody' do
-      expect(subject.render_rows).to have_tag "tbody"
-    end
+  describe "#render_table" do
+    let(:table) { Nokogiri::HTML(subject.render_table.to_s) }
 
-    it "creates a row in the tbody" do
-      tbody = Nokogiri::HTML(subject.render_rows)
-      expect(tbody.css('tr').size).to be 3
+    it "renders a table tag" do
+      expect(table).to have_tag "table"
     end
   end
 
-  context 'escaped values' do
-    let(:objects) do
-      FactoryGirl.build_list(:dummy_model, 1, 
-        name: "<script>alert(\"Im in your columns, snatching your main thread.\")</script>"
-      )
-    end
-
-    it 'does not allow unescaped values in columns' do
-      tbody = Nokogiri::HTML(subject.render_rows).at_xpath('//tbody')
-
-      tbody.xpath('//td').each do |td|
-        td.at_xpath('.//script').should_not be_present
-      end
+  describe "#tbody" do
+    it 'creates a tbody' do
+      expect(subject.tbody.to_s).to have_tag "tbody"
     end
-  end
 
-  context "column configuration" do
-    let(:column) { FactoryGirl.build(:column, options: {td_options: {class: "email_column"}}) }
-    let(:model) { FactoryGirl.build(:dummy_model) }
-
-    it "td has a class set" do
-      td = Nokogiri::HTML(subject.render_td(column, model)).at_css("td")
-      expect(td[:class]).to eq "email_column"
+    it "creates a row in the tbody" do
+      tbody = Nokogiri::HTML(subject.tbody.to_s)
+      expect(tbody.css('tr').size).to be 3
     end
 
-    context "by value of row column" do
-      before(:each) do
-        column.stub value: ["robert@example.com", {class: "special-class"}]
+    context 'escaped values' do
+      let(:objects) do
+        FactoryGirl.build_list(:dummy_model, 1,
+          name: "<script>alert(\"Im in your columns, snatching your main thread.\")</script>"
+        )
       end
 
-      specify "column has options because of value" do
-        td = Nokogiri::HTML(subject.render_td(column, model)).at_css("td")
+      it 'does not allow unescaped values in columns' do
+        tbody = Nokogiri::HTML(subject.tbody.to_s).at_xpath('//tbody')
 
-        expect(td.text).to include "robert@example.com"
-        expect(td[:class]).to eq("special-class")
+        tbody.xpath('//td').each do |td|
+          td.at_xpath('.//script').should_not be_present
+        end
       end
     end
   end

data/spec/support/matchers/element_matchers.rb

@@ -1,6 +1,15 @@
+require "nokogiri"
+
 RSpec::Matchers.define :have_tag do |tag|
   match do |string|
-    document = Nokogiri::HTML(string)
-    !!document.at_xpath(".//#{tag}")
+    document = Nokogiri::HTML(string.to_s)
+    !!document.at_css(tag)
+  end
+end
+
+RSpec::Matchers.define :have_xpath do |tag|
+  match do |string|
+    document = Nokogiri::HTML(string.to_s)
+    !!document.at_xpath(tag)
   end
 end

data/table_cloth.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rb-fsevent', '~> 0.9.1')
 
   gem.add_dependency('actionpack', '>= 3.1', '< 4.1')
+  gem.add_dependency('element_factory', '~> 0.1.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_cloth
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -177,6 +177,22 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: element_factory
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: Table Cloth helps you create tables easily.
 email:
 - robert@creativequeries.com
@@ -187,6 +203,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - Guardfile
 - LICENSE.txt