tidy_table 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,9 @@
+== 0.0.4 / 2007-06-27
+
+* Changed default table class name to 'tidy_table' for consistency.
+* Added ability to return a Hash from the block passed to TidyTable#to_html.
+  This allows the :id or :class of the row to be set along with the :data.
+
 == 0.0.3 / 2007-06-24
 
 * Added automatic last_column_class to header row also

data/Rakefile

@@ -15,5 +15,5 @@ end
 
 desc "Test task (actually runs specs)"
 task "test" do
-  system "spec --format specdoc --color spec/*_spec.rb"
+  system "spec --format specdoc --color spec"
 end

data/lib/tidy_table.rb

@@ -15,12 +15,12 @@
 
 class TidyTable
 
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
   ##
   # Make a new TidyTable with a data array and CSS options.
   #
-  # * :table_class -- Defaults to 'tidytable'
+  # * :table_class -- Defaults to 'tidy_table'
   # * :first_row_class -- Defaults to 'first_row'
   # * :first_column_class -- Defaults to 'first_column'
   # * :last_column_class -- Defaults to 'last_column'
@@ -30,7 +30,7 @@ class TidyTable
   def initialize(array, options={})
     @rows = array
     @options = {
-      :table_class => "tidytable",
+      :table_class => "tidy_table",
       :first_row_class => "first_row",
       :first_column_class => "first_column",
       :last_column_class => "last_column"
@@ -38,17 +38,24 @@ class TidyTable
   end
 
   ##
-  # First argument is an array of the names of the fields you want to display.
+  # First argument is an array of column names.
+  # Will also be called as methods on each row object if no block is provided.
   #
   # If given, a block will be called for each row of the array. You should
-  # return an array with the values formatted in the format that you want to see
+  # return an Array with the values formatted in the format that you want to see
   # in the resulting cells.
+  #
+  # Or, return a Hash where
+  #
+  #   :data  => ['contents', 'for', 'cells'],
+  #   :id    => 'id_for_this_row',
+  #   :class => 'extra_classes for_this row'
 
-  def to_html(fields)
+  def to_html(fields)      
     output = []
     output << %(<table class="#{@options[:table_class]}">)
 
-    # First row
+    # First row (header)
     output << %(<tr class="#{@options[:first_row_class]}">)
     fields.each_with_index do |field, index|
       output << %(<th class="#{@options[:first_row_class]} #{column_classes(fields, index)}">#{field}</th>)
@@ -56,13 +63,28 @@ class TidyTable
     output << "</tr>"
 
     @rows.each_with_index do |row, row_index|
-      output << %(<tr class="#{row_index % 2 == 0 ? 'even': 'odd'}">)
       if block_given?
-        formatted_data = yield(row)
-        formatted_data.each_with_index do |data, index|
-          output << %(<td class="#{column_classes(formatted_data, index)}">#{data}</td>)
+        yield_output = yield(row)
+
+        data = []
+        row_options = {}
+        case yield_output
+        when Array
+          data = yield_output
+        when Hash
+          data = yield_output.delete(:data)
+          row_options = yield_output
+        else
+          raise ArgumentError, "TidyTable block expects an Array or Hash, but a #{yield_output.class} was returned."
+        end
+
+        row_classes = [row_index % 2 == 0 ? 'even': 'odd', row_options[:class]].select {|i| !i.nil?}.join(' ')
+        output << %(<tr class="#{row_classes}" #{"id=\"#{row_options[:id]}\"" if row_options.has_key?(:id)}>)
+        data.each_with_index do |item, index|
+          output << %(<td class="#{column_classes(data, index)}">#{item}</td>)
         end
       else
+        output << %(<tr class="#{row_index % 2 == 0 ? 'even': 'odd'}">)
         fields.each_with_index do |field, index|
           output << %(<td class="#{column_classes(fields, index)}">#{row.send(field.to_sym)}</td>)
         end
@@ -77,10 +99,17 @@ class TidyTable
   
   ##
   # Returns "first_column", "last_column", or both.
+  #
+  # additional_class_names is a string of other class names to append to the 
+  # autogenerated classes.
   
-  def column_classes(fields_array, index)
+  def column_classes(fields_array, index, additional_class_names=nil)
     classes = (index == 0 ? @options[:first_column_class] : '')
     classes += (index == fields_array.length - 1 ? @options[:last_column_class] : '')
+    if additional_class_names
+      classes += " " + additional_class_names
+    end
+    classes
   end
   
 end

data/spec/tidy_table_spec.rb

@@ -35,4 +35,27 @@ describe TidyTable do
     content.should match(/the_end_my_friend/)
   end
 
+  it "should set row title" do
+    t = TidyTable.new(@records) 
+    t.to_html([:title, :description]) do |record|
+      {:id => "cheese_1", :data => [record.title, record.description]}
+    end.should match(/tr class="even" id="cheese_1"/)
+  end
+  
+  it "should set row class" do
+    t = TidyTable.new(@records)
+    t.to_html([:title, :description]) do |record|
+      {:class => "cheese_class", :data => [record.title, record.description]}
+    end.should match(/tr class="even cheese_class"/)
+  end
+  
+  it "should raise if wrong argument passed from block" do
+    t = TidyTable.new(@records)
+    lambda {
+      t.to_html([:title, :description]) do |record|
+        Date.new
+      end
+    }.should raise_error(ArgumentError)
+  end
+
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: tidy_table
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-06-24 00:00:00 -07:00
+  version: 0.0.4
+date: 2007-06-27 00:00:00 -07:00
 summary: Yet another library for converting a struct into an HTML table.
 require_paths: 
 - lib