tabula_rasa 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85b6138d31f80d0ef643af81a02b77bcea0fc4b2
-  data.tar.gz: 787437faf4bd0631fd23cc2ec3e64e8e48c2079a
+  metadata.gz: e1d7fbe18b2b3b9d85b7a5cd7677e246ad3333fd
+  data.tar.gz: 5902b713adcff3c7b639eaf75fc95a3e5ba757e6
 SHA512:
-  metadata.gz: 0647a914557c4b474c43013f1693e3454826feed995410445d39165f3dc270f07aba2805b9addf321aacfe634f57bc4a81dce0ac421d38348b6352ed12940c20
-  data.tar.gz: 86b608afad417372b5eb3610823e6625e7cc8c6c42ae2a087e02ce6caa1ac72df3c4bd88397f4baf3b56c7130cc2251390337bf26f0461e2b8815aac9bc84bc3
+  metadata.gz: f1b741f7851cf06aac649649c46c39f8b91ba3ff4cc5ec73978633214def1848af0d7914785403a492805ccbec114396c8ba40f10c3974916a96856e5edd70b7
+  data.tar.gz: 41c3aaf92b875314a8069e3fdf5a03d4a9bba30e5753e4fff58bbb73bb5c5b7814a78794c2a4be69a77b44a7093039556d7505269e4ad33771fa1c389568b643

data/README.md

@@ -3,7 +3,7 @@
 
 An opinionated yet simple table generator for Rails<sup>1</sup>.
 
-TabulaRasa is designed to leverage ActiveRecord::Relation instances and conventions<sup>2</sup> to make table generation a snap but still readable and editable.
+TabulaRasa is designed to leverage ActiveRecord::Relation instances and conventions to make table generation a snap but still readable and editable.
 
 ## Installation
 
@@ -21,7 +21,98 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+TabulaRasa is designed to make it easy to make valid HTML[5] tables for ActiveRecord::Relations. Here are examples on how to set attributes:
+
+```ruby
+# TABLE
+# NOTE: special options here:
+# * zebra: Accepts boolean or array of string values for ActionView's cycle helper. Defaults to true, creating zebra-striped tables (using 'even' and 'odd' values) out of the box.
+# * dom_id: Accepts boolean, for setting TBODY TR id attribute to dom_id for the row's instance. Defaults to false.
+# * dom_class: Accepts boolean, for adding dom_class for the row's instance to the TBODY TR class attribute. Defaults to false.
+tabula_rasa @collection id: 'foo' do |table|
+  t.column :foo
+end
+
+# THEAD
+tabula_rasa @collection, head: {id: 'foo'} do |table|
+  t.column :foo
+end
+
+# THEAD TR not supported. There's only one row. Use the THEAD TR selector instead.
+
+# TH
+tabula_rasa @collection do |table|
+  t.column :foo, head: {id: 'foo'}
+  # You can also set both TH and TD attributes with the same values
+  t.column :bar, shared: {class: 'bar'}
+  # NOTE: block column arguments are not supported for TH element
+end
+
+# TBODY
+tabula_rasa @collection, body: {id: 'foo'} do |table|
+  t.column :foo
+end
+
+# TBODY TR
+tabula_rasa @collection do |table|
+  t.column :foo # Just here for validity
+  # This is the code that actually does the work for the TR
+  t.row class: 'foobar'
+  # OR you can use a block argument. Do note though...
+  # Defining the row twice in real code will raise ArgumentError.
+  t.row do |row|
+    row.id do |instance|
+      dom_id instance
+    end
+    # Sets attribute 'data-foo'
+    row.data :foo do |instance|
+      "foo-#{instance.id}"
+    end
+  end
+end
+
+# TD
+tabula_rasa @collection do |table|
+  t.column :foo, body: {class: 'foo'}
+  t.column :bar do |column|
+    column.class do |instance|
+      instance.bar? ? 'bar' : 'unbar'
+    end
+    # Just an example of another attribute where setting by string might make sense. Use CSS for this really!
+    column.attribute :width, '100'
+  end
+  # You can also set both TH and TD attributes with the same values
+  t.column :baz, shared: {class: 'baz'}
+end
+```
+
+Cell values default to the attribute name [for the TH element] and value [for the TD element]. You can easily override this by using the :value key for the :head or :body options for the column method as seen below:
+
+```ruby
+tabula_rasa @collection do |table|
+  t.column :foo, head: {value: 'Foo Header'}, body: {value: 'Foo Body Content'}
+end
+```
+
+Most use cases for overriding the body value though would be better served by using a block which provides access to the collection member for that row.
+
+```ruby
+tabula_rasa @collection do |table|
+  t.column :foo do |column|
+    column.value do |instance|
+      "A massaged value for instance #{instance.id}"
+    end
+  end
+end
+```
+
+A lot of the time though you should just be able to get by with a simple symbol argument, since you aren't limited to simple attributes but can use methods that massage attribute data.
+
+```ruby
+tabula_rasa @collection do |table|
+  t.column :foo
+end
+```
 
 ## Contributing
 
@@ -33,12 +124,8 @@ TODO: Write usage instructions here
 
 ## TODO
 
-* Write usage instructions
-* Support for 'zebra-striping'
-* TD dom_id and dom_class
+* Discover more things to do
 
 ## Footnotes
 
 <sup>1</sup> TabulaRasa really only relies on ActiveRecord and ActionView/ActionPack so you could use in a non-Rails stack that had those two elements but it seemed silly to differentiate this in the summary sentence.
-
-<sup>2</sup> These conventions may only be my own. Time will tell.

data/lib/tabula_rasa/base.rb

@@ -13,18 +13,24 @@ module TabulaRasa
       @options = options
       @view = view
       @klass = collection.klass
-      @columns = []
+      @column_collection = []
       yield self if block_given?
       ensure_row
     end
 
     def render
-      return if columns.empty?
+      return if column_collection.empty?
       content_tag :table, content, table_options
     end
 
     def column(*args, &block)
-      @columns << Column.new(self, *args, &block)
+      @column_collection << Column.new(self, *args, &block)
+    end
+
+    def columns(*args)
+      args.each do |arg|
+        @column_collection << Column.new(self, arg)
+      end
     end
 
     def row(options = {}, &block)
@@ -34,7 +40,7 @@ module TabulaRasa
 
   private
 
-    attr_reader :view, :klass, :columns
+    attr_reader :view, :klass, :column_collection
 
     def content
       safe_join [thead, tbody]
@@ -43,7 +49,7 @@ module TabulaRasa
     def thead
       content_tag :thead, options[:head] do
         content_tag :tr do
-          safe_join columns.map(&:head_content)
+          safe_join column_collection.map(&:head_content)
         end
       end
     end
@@ -57,7 +63,7 @@ module TabulaRasa
     def collection_body
       rows = collection.map do |member|
         content_tag :tr, @row.options_for(member) do
-          cells = columns.map do |column|
+          cells = column_collection.map do |column|
             column.body_content_for member
           end
           safe_join cells
@@ -68,7 +74,7 @@ module TabulaRasa
 
     def empty_body
       content_tag :tr, class: 'empty' do
-        content_tag :td, colspan: columns.size do
+        content_tag :td, colspan: column_collection.size do
           "No #{klass.table_name.downcase} present"
         end
       end

data/lib/tabula_rasa/version.rb

@@ -1,3 +1,3 @@
 module TabulaRasa
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/tabula_rasa/helper_body_spec.rb

@@ -335,5 +335,22 @@ describe TabulaRasa::Helpers, 'Head Specs' do
       cell.children.first.must_be :text?
       cell.text.must_equal 'No survivors present'
     end
+
+    it 'can use multiple single arguments via internal columns method to set multiple columns' do
+      captured = capture do
+        tabula_rasa @survivors do |t|
+          t.columns :first_name, :last_name
+        end
+      end
+      rows = extract_all('table tbody tr', captured)
+
+      rows.each_with_index do |row, n|
+        survivor = @survivors[n]
+        cells = row.search('td')
+        cells.size.must_equal 2
+        cells[0].text.must_equal survivor.first_name
+        cells[1].text.must_equal survivor.last_name
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabula_rasa
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - RSL
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler