terminal-table 1.3.0 → 1.4.0

data/History.rdoc

@@ -1,4 +1,9 @@
 
+=== 1.4.0 / 2009-12-18
+
+* Can now add :seperator arbitrarily in a table [thanks splattael]
+* Fix common typo: seperator -> separator [thanks splattael]
+
 === 1.3.0 / 2009-10-16
 
 * Major refactoring (functionality remains the same)

data/README.rdoc

@@ -22,11 +22,13 @@ Simple, feature rich ASCII table generator.
   require 'rubygems'
   require 'terminal-table/import'
    
-  puts table(['a', 'b'], [1, 2], [3, 4])
+  puts table(['a', 'b'], [1, 2], [3, 4], :separator, [4, 6])
    
   t = table ['a', 'b']
   t << [1, 2]
   t << [3, 4]
+  t.add_separator
+  t << [4, 6]
   puts t
    
   user_table = table do |t|
@@ -39,7 +41,7 @@ Simple, feature rich ASCII table generator.
    
   user_table = table do
     self.headings = 'First Name', 'Last Name', 'Email'
-    add_row ['TJ',  'Holowaychuk', { :value => 'tj@vision-media.ca', :align => :right }]
+    add_row ['TJ',  'Holowaychuk', { :value => 'tj@vision-media.ca', :alignment => :right }]
     add_row ['Bob', 'Someone',     'bob@vision-media.ca']
     add_row ['Joe', 'Whatever',    'joe@vision-media.ca']
     align_column 1, :center
@@ -77,6 +79,9 @@ Simple, feature rich ASCII table generator.
   | 1 | 2 |
   | 3 | 4 |
   +---+---+
+  | 4 | 6 |
+  +---+---+
+
    
   +---+---+
   | a | b |
@@ -84,6 +89,8 @@ Simple, feature rich ASCII table generator.
   | 1 | 2 |
   | 3 | 4 |
   +---+---+
+  | 4 | 6 |
+  +---+---+
    
   +------------+-------------+---------------------+
   | First Name | Last Name   | Email               |

data/Todo.rdoc

@@ -5,7 +5,7 @@
 
 == Minor:
 
-* Programmatically add seperator rows
+* Programmatically add separator rows
 * Arbitrary dimensions
 * Add multi-column sorting
 * Change; pre-create Cell and Heading objects to clean up Table a bit

data/examples/examples.rb

@@ -9,6 +9,8 @@ puts
 t = table ['a', 'b']
 t << [1, 2]
 t << [3, 4]
+t << :separator
+t << [4, 6]
 puts t
 
 puts
@@ -23,9 +25,11 @@ puts user_table
 puts
 user_table = table do
   self.headings = 'First Name', 'Last Name', 'Email'
-  add_row ['TJ',  'Holowaychuk', ['tj@vision-media.ca', :right]]
+  add_row ['TJ',  'Holowaychuk', 'tj@vision-media.ca']
   add_row ['Bob', 'Someone',     'bob@vision-media.ca']
   add_row ['Joe', 'Whatever',    'joe@vision-media.ca']
+  add_separator
+  add_row ['Total', { :value => '3', :colspan => 2, :alignment => :right }]
   align_column 1, :center
 end
 puts user_table

data/lib/terminal-table/table.rb

@@ -6,7 +6,7 @@ module Terminal
     # Exceptions
     #++
     
-    class Error < StandardError; end
+    Error = Class.new StandardError
     
     ##
     # Table characters, x axis, y axis, and intersection.
@@ -36,44 +36,70 @@ module Terminal
     # Render the table.
   
     def render
-      buffer = seperator << "\n" 
+      buffer = [separator, "\n"]
       if has_headings?
-        buffer << Y + headings.map_with_index do |heading, i|
-          width = 0
-          if Hash === heading and not heading[:colspan].nil?
-            i.upto(i + heading[:colspan] - 1) do |col|
-              width += length_of_column(col)
-            end
-            width += (heading[:colspan] - 1) * (Y.length + 2)
-          else
-            width = length_of_column i
-          end
-          Heading.new(width, heading).render
-        end.join(Y) + Y
-        buffer << "\n#{seperator}\n"
+        buffer << render_headings
+        buffer << "\n" << separator << "\n"
       end
-      buffer << rows.map do |row| 
-        Y + row.map_with_index do |cell, i|
-          width = 0
-          if Hash === cell and not cell[:colspan].nil?
-            i.upto(i + cell[:colspan] - 1) do |col|
-              width += length_of_column(col)
-            end
-            width += (cell[:colspan] - 1) * (Y.length + 2)
-          else
-            width = length_of_column i
-          end
-          Cell.new(width, cell).render
-        end.join(Y) + Y 
+      buffer << @rows.map do |row| 
+        render_row(row)
       end.join("\n")
-      buffer << "\n#{seperator}\n"
+      buffer << "\n" << separator << "\n"
+      buffer.join
     end
     alias :to_s :render
     
     ##
-    # Create a seperator based on colum lengths.
+    # Render headings.
+
+    def render_headings
+      Y + headings.map_with_index do |heading, i|
+        width = 0
+        if heading.is_a?(Hash) and !heading[:colspan].nil?
+          i.upto(i + heading[:colspan] - 1) do |col|
+            width += length_of_column(col)
+          end
+          width += (heading[:colspan] - 1) * (Y.length + 2)
+        else
+          width = length_of_column(i)
+        end
+        Heading.new( width, heading).render
+      end.join(Y) + Y
+    end
+    
+    ##
+    # Render the given _row_.
+
+    def render_row row
+      if row == :separator
+        separator
+      else
+        Y + row.map_with_index do |cell, i|
+          render_cell(cell, i)
+        end.join(Y) + Y
+      end
+    end
     
-    def seperator
+    ##
+    # Render the given _cell_ at index _i_.
+
+    def render_cell cell, i
+      width = 0
+      if cell.is_a?(Hash) and !cell[:colspan].nil?
+        i.upto(i + cell[:colspan] - 1) do |col|
+          width += length_of_column(col)
+        end
+        width += (cell[:colspan] - 1) * (Y.length + 2)
+      else
+        width = length_of_column(i)
+      end
+      Cell.new(width, cell).render
+    end
+    
+    ##
+    # Create a separator based on colum lengths.
+    
+    def separator
       I + columns.collect_with_index do |col, i| 
         X * (length_of_column(i) + 2) 
       end.join(I) + I 
@@ -83,12 +109,19 @@ module Terminal
     # Add a row. 
     
     def add_row row
-      rows << row
+      @rows << row
     end
     alias :<< :add_row
 
     ##
-    # Check if headings are present.
+    # Add a separator.
+
+    def add_separator
+      @rows << :separator
+    end
+
+    ##
+    # Weither or not any headings are present, since they are optional.
     
     def has_headings?
       not headings.empty?
@@ -157,7 +190,21 @@ module Terminal
     def headings_with_rows
       [headings] + rows
     end
-    
+
+    ##
+    # Return rows without separator rows.
+
+    def rows
+      @rows.reject { |row| row == :separator }
+    end
+
+    ##
+    # Return rows including separator rows.
+
+    def all_rows
+      @rows
+    end
+
     ##
     # Check if _other_ is equal to self. _other_ is considered equal
     # if it contains the same headings and rows.

data/lib/terminal-table/version.rb

@@ -1,6 +1,6 @@
 
 module Terminal
   class Table
-    VERSION = '1.3.0'
+    VERSION = '1.4.0'
   end
 end

data/spec/table_spec.rb

@@ -56,10 +56,18 @@ module Terminal
       @table.length_of_column(1).should == 18
     end
 
-    it "should render seperators" do
+    it "should render separators" do
       @table.headings = ['Char', 'Num']
       @table << ['a', 1]
-      @table.seperator.should == '+------+-----+'
+      @table.separator.should == '+------+-----+'
+    end
+
+    it "should add separator" do
+      @table << ['a', 1]
+      @table.add_separator
+      @table << ['b', 2]
+      @table.rows.size.should == 2
+      @table.all_rows.size.should == 3
     end
 
     it "should bitch and complain when you have no rows" do
@@ -95,6 +103,24 @@ module Terminal
       EOF
     end
 
+    it "should render separators" do
+      @table.headings = ['Char', 'Num']
+      @table << ['a', 1]
+      @table << ['b', 2]
+      @table.add_separator
+      @table << ['c', 3]
+      @table.render.should == <<-EOF.deindent
+        +------+-----+
+        | Char | Num |
+        +------+-----+
+        | a    | 1   |
+        | b    | 2   |
+        +------+-----+
+        | c    | 3   |
+        +------+-----+
+      EOF
+    end
+
     it "should render properly using block syntax" do
       table = Terminal::Table.new do |t|
         t << ['a', 1]
@@ -214,7 +240,7 @@ module Terminal
         table_one = Table.new
         table_two = Table.new
 
-        table_one.rows << "a"
+        table_one.add_row "a"
 
         table_one.should_not == table_two
         table_two.should_not == table_one

data/terminal-table.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{terminal-table}
-  s.version = "1.3.0"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-10-16}
+  s.date = %q{2009-12-18}
   s.description = %q{Simple, feature rich ascii table generation library}
   s.email = %q{tj@vision-media.ca}
   s.extra_rdoc_files = ["README.rdoc", "lib/terminal-table.rb", "lib/terminal-table/cell.rb", "lib/terminal-table/core_ext.rb", "lib/terminal-table/heading.rb", "lib/terminal-table/import.rb", "lib/terminal-table/table.rb", "lib/terminal-table/table_helper.rb", "lib/terminal-table/version.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: terminal-table
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-16 00:00:00 -07:00
+date: 2009-12-18 00:00:00 -08:00
 default_executable: 
 dependencies: []