visionmedia-terminal-table 1.1.0 → 1.2.0

data/History.rdoc

@@ -1,4 +1,16 @@
 
+=== 1.2.0 / 2009-08-06
+
+* Added colspan support to table
+
+=== 1.1.0 / 2009-08-06
+
+* Added colspan support to table
+
+=== 1.1.0 / 2009-07-13
+
+* Added Table#==
+
 === 1.0.5 / 2009-03-14
 
 * Allowing nil to be passed to table for headings
@@ -11,4 +23,4 @@
 
 === 1.0.0 / 2009-01-13
 
-* Initial release
+* Initial release

data/README.rdoc

@@ -9,98 +9,116 @@ Simple, feature rich ASCII table generator.
 * Simple
 * Optional headings
 * Alignment of columns, headings, or cells
+* Supports column span
 * Easy modification of table strings (+, -, |)
 
 == Examples:
 
-   require 'rubygems'
-   require 'terminal-table/import'
+  require 'rubygems'
+  require 'terminal-table/import'
    
-   puts table(['a', 'b'], [1, 2], [3, 4])
+  puts table(['a', 'b'], [1, 2], [3, 4])
    
-   t = table ['a', 'b']
-   t << [1, 2]
-   t << [3, 4]
-   puts t
+  t = table ['a', 'b']
+  t << [1, 2]
+  t << [3, 4]
+  puts t
    
-   user_table = table do |t|
-     t.headings = 'First Name', 'Last Name', 'Email'
-     t << ['TJ',  'Holowaychuk', 'tj@vision-media.ca']
-     t << ['Bob', 'Someone',     'bob@vision-media.ca']
-     t << ['Joe', 'Whatever',    'joe@vision-media.ca']
-   end
-   puts user_table
+  user_table = table do |t|
+    t.headings = 'First Name', 'Last Name', 'Email'
+    t << ['TJ',  'Holowaychuk', 'tj@vision-media.ca']
+    t << ['Bob', 'Someone',     'bob@vision-media.ca']
+    t << ['Joe', 'Whatever',    'joe@vision-media.ca']
+  end
+  puts user_table
    
-   user_table = table do
-     self.headings = 'First Name', 'Last Name', 'Email'
-     add_row ['TJ',  'Holowaychuk', { :value => 'tj@vision-media.ca', :align => :right }]
-     add_row ['Bob', 'Someone',     'bob@vision-media.ca']
-     add_row ['Joe', 'Whatever',    'joe@vision-media.ca']
-     align_column 1, :center
-   end
-   puts user_table
+  user_table = table do
+    self.headings = 'First Name', 'Last Name', 'Email'
+    add_row ['TJ',  'Holowaychuk', { :value => 'tj@vision-media.ca', :align => :right }]
+    add_row ['Bob', 'Someone',     'bob@vision-media.ca']
+    add_row ['Joe', 'Whatever',    'joe@vision-media.ca']
+    align_column 1, :center
+  end
+  puts user_table
+
+  puts
+  user_table = table do
+    self.headings = ['First Name', 'Last Name', {:value => 'Phones', :colspan => 2, :alignment => :center}]
+    add_row ['Bob', 'Someone',     '123', '456']
+    add_row ['TJ',  'Holowaychuk', {:value => "No phones", :colspan => 2, :alignment => :center}]
+    add_row ['Joe', 'Whatever',    '4324', '343242']
+  end
+  puts user_table
    
-   rows = []
-   rows << ['Lines',      100]
-   rows << ['Comments',   20]
-   rows << ['Ruby',       70]
-   rows << ['JavaScript', 30]
-   puts table([nil, 'Lines'], *rows)
+  rows = []
+  rows << ['Lines',      100]
+  rows << ['Comments',   20]
+  rows << ['Ruby',       70]
+  rows << ['JavaScript', 30]
+  puts table([nil, 'Lines'], *rows)
    
-   rows = []
-   rows << ['Lines',      100]
-   rows << ['Comments',   20]
-   rows << ['Ruby',       70]
-   rows << ['JavaScript', 30]
-   puts table(nil, *rows)
+  rows = []
+  rows << ['Lines',      100]
+  rows << ['Comments',   20]
+  rows << ['Ruby',       70]
+  rows << ['JavaScript', 30]
+  puts table(nil, *rows)
 
 == Results:
 
-   +---+---+
-   | a | b |
-   +---+---+
-   | 1 | 2 |
-   | 3 | 4 |
-   +---+---+
+  +---+---+
+  | a | b |
+  +---+---+
+  | 1 | 2 |
+  | 3 | 4 |
+  +---+---+
    
-   +---+---+
-   | a | b |
-   +---+---+
-   | 1 | 2 |
-   | 3 | 4 |
-   +---+---+
+  +---+---+
+  | a | b |
+  +---+---+
+  | 1 | 2 |
+  | 3 | 4 |
+  +---+---+
    
-   +------------+-------------+---------------------+
-   | First Name | Last Name   | Email               |
-   +------------+-------------+---------------------+
-   | TJ         | Holowaychuk | tj@vision-media.ca  |
-   | Bob        | Someone     | bob@vision-media.ca |
-   | Joe        | Whatever    | joe@vision-media.ca |
-   +------------+-------------+---------------------+
+  +------------+-------------+---------------------+
+  | First Name | Last Name   | Email               |
+  +------------+-------------+---------------------+
+  | TJ         | Holowaychuk | tj@vision-media.ca  |
+  | Bob        | Someone     | bob@vision-media.ca |
+  | Joe        | Whatever    | joe@vision-media.ca |
+  +------------+-------------+---------------------+
    
-   +------------+-----------------------------+---------------------+
-   | First Name | Last Name                   | Email               |
-   +------------+-----------------------------+---------------------+
-   | TJ         |         Holowaychuk         |  tj@vision-media.ca |
-   | Bob        |           Someone           | bob@vision-media.ca |
-   | Joe        |          Whatever           | joe@vision-media.ca |
-   +------------+-----------------------------+---------------------+
-
-   +------------+-------+
-   |            | Lines |
-   +------------+-------+
-   | Lines      | 100   |
-   | Comments   | 20    |
-   | Ruby       | 70    |
-   | JavaScript | 30    |
-   +------------+-------+
-
-   +------------+-----+
-   | Lines      | 100 |
-   | Comments   | 20  |
-   | Ruby       | 70  |
-   | JavaScript | 30  |
-   +------------+-----+
+  +------------+-----------------------------+---------------------+
+  | First Name | Last Name                   | Email               |
+  +------------+-----------------------------+---------------------+
+  | TJ         |         Holowaychuk         |  tj@vision-media.ca |
+  | Bob        |           Someone           | bob@vision-media.ca |
+  | Joe        |          Whatever           | joe@vision-media.ca |
+  +------------+-----------------------------+---------------------+
+
+  +------------+-------------+-----------+--------+
+  | First Name | Last Name   |       Phones       |
+  +------------+-------------+-----------+--------+
+  | Bob        | Someone     | 123       | 456    |
+  | TJ         | Holowaychuk |     No phones      |
+  | Joe        | Whatever    | 4324      | 343242 |
+  +------------+-------------+-----------+--------+
+
+  +------------+-------+
+  |            | Lines |
+  +------------+-------+
+  | Lines      | 100   |
+  | Comments   | 20    |
+  | Ruby       | 70    |
+  | JavaScript | 30    |
+  +------------+-------+
+
+  +------------+-----+
+  | Lines      | 100 |
+  | Comments   | 20  |
+  | Ruby       | 70  |
+  | JavaScript | 30  |
+  +------------+-----+
 
 == License:
 

data/examples/examples.rb

@@ -30,6 +30,15 @@ user_table = table do
 end
 puts user_table
 
+puts
+user_table = table do
+  self.headings = ['First Name', 'Last Name', {:value => 'Phones', :colspan => 2, :alignment => :center}]
+  add_row ['Bob', 'Someone',     '123', '456']
+  add_row ['TJ',  'Holowaychuk', {:value => "No phones", :colspan => 2, :alignment => :center}]
+  add_row ['Joe', 'Whatever',    '4324', '343242']
+end
+puts user_table
+
 rows = []
 rows << ['Lines',      100]
 rows << ['Comments',   20]

data/lib/terminal-table/cell.rb

@@ -3,10 +3,20 @@ module Terminal
   class Table
     class Cell
       
-      attr_accessor :value, :alignment
+      attr_accessor :value, :alignment, :colspan
       
-      def initialize width, value = nil, alignment = :left
-        @width, @alignment, @value = width, alignment, value
+      def initialize width, params
+        @width = width
+        @alignment = :left
+        @colspan = 1
+
+        if params.is_a? Hash
+          @value = params[:value]
+          @alignment = params[:alignment] unless params[:alignment].nil?
+          @colspan = params[:colspan] unless params[:colspan].nil?
+        else
+          @value = params
+        end
       end
       
       def render
@@ -15,9 +25,8 @@ module Terminal
       alias :to_s :render
       
       def length
-        value.to_s.length + 2
+        @value.to_s.length + 2
       end
-      
     end
   end
 end

data/lib/terminal-table/heading.rb

@@ -2,7 +2,7 @@
 module Terminal
   class Table
     class Heading < Cell
-      def initialize width, value = nil, alignment = :center
+      def initialize width, params
         super
       end
     end

data/lib/terminal-table/table.rb

@@ -58,14 +58,32 @@ module Terminal
     def render
       buffer = seperator << "\n" 
       if has_headings?
-        buffer << Y + headings.map_with_index do |heading, i| 
-          Heading.new(length_of_column(i), *heading).render 
+        buffer << 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
         buffer << "\n#{seperator}\n"
       end
       buffer << rows.map do |row| 
         Y + row.map_with_index do |cell, i|
-          Cell.new(length_of_column(i), *cell).render 
+          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.join(Y) + Y 
       end.join("\n")
       buffer << "\n#{seperator}\n"
@@ -121,14 +139,19 @@ module Terminal
     # Return the largest cell found within column +n+.
     
     def largest_cell_in_column n
-      column_with_headings(n).sort_by { |cell| Cell.new(0, *cell).length }.last
+      column_with_headings(n).sort_by { |cell| Cell.new(0, cell).length }.last
     end
     
     ##
     # Return length of column +n+.
     
     def length_of_column n
-      largest_cell_in_column(n).to_s.length
+      largest_cell = largest_cell_in_column(n)
+      if largest_cell.is_a? Hash
+        largest_cell[:value].length# - 2
+      else
+        largest_cell.to_s.length
+      end
     end
     
     ##
@@ -144,7 +167,7 @@ module Terminal
     
     def align_column n, alignment
       column(n).each_with_index do |col, i|
-        @rows[i][n] = [col, alignment] unless col.is_a? Array
+        @rows[i][n] = {:value => col, :alignment => alignment} unless col.is_a? Hash
       end
     end
     

data/lib/terminal-table/version.rb

@@ -1,6 +1,6 @@
 
 module Terminal
   class Table
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/spec/cell_spec.rb

@@ -11,7 +11,7 @@ describe Terminal::Table do
   end
 
   it "should override alignment" do
-    cell = Cell.new 0, 'foo', :center
+    cell = Cell.new 0, {:value => 'foo', :alignment => :center}
     cell.value.should == 'foo'
     cell.alignment.should == :center
   end

data/spec/table_spec.rb

@@ -5,66 +5,66 @@ module Terminal
     before :each do
       @table = Table.new
     end
-     
+    
     it "should select columns" do
       @table << ['foo', 'bar']
       @table << ['big foo', 'big foo bar']
       @table.column(1).should == ['bar', 'big foo bar']
     end
-    
+
     it "should count columns" do
       @table << [1, 2, 3]
       @table.number_of_columns.should == 3
     end
-    
+
     it "should iterate columns" do
       @table << [1, 2, 3]
       @table << [4, 5, 6]
       @table.columns.should == [[1, 4], [2, 5], [3, 6]]
     end
-    
+
     it "should select columns" do
       @table.headings = ['one', 'two']
       @table << ['foo', 'bar']
       @table << ['big foo', 'big foo bar']
       @table.column(1).should == ['bar', 'big foo bar']
     end
-    
+
     it "should select columns when using hashes" do
       @table.headings = ['one', 'two']
       @table.rows = [[{ :value => 'a', :align => :left }, 1], ['b', 2], ['c', 3]]
       @table.column(0).should == [{ :value => 'a', :align => :left }, 'b', 'c']
     end
-    
+
     it "should select largest cell in a column" do
       @table << ['foo', 'bar']
       @table << ['big foo', 'big foo bar']
       @table.largest_cell_in_column(1).should == 'big foo bar'
     end
-    
+
     it "should find column length" do
       @table << ['foo', 'bar', 'a']
       @table << ['big foo', 'big foo bar']
       @table.length_of_column(1).should == 11
     end
-    
+
     it "should find column length with headings" do
       @table.headings = ['one', 'super long heading']
       @table << ['foo', 'bar', 'a']
       @table << ['big foo', 'big foo bar']
       @table.length_of_column(1).should == 18
     end
-    
+
     it "should render seperators" do
       @table.headings = ['Char', 'Num']
       @table << ['a', 1]
       @table.seperator.should == '+------+-----+'
     end
-    
+
     it "should bitch and complain when you have no rows" do
       lambda { @table.render }.should raise_error(Terminal::Table::Error)
     end
-        
+
     it "should render properly" do
       @table.headings = ['Char', 'Num']
       @table << ['a', 1]
@@ -80,7 +80,7 @@ module Terminal
         +------+-----+
       EOF
     end
-    
+
     it "should render properly without headings" do
       @table << ['a', 1]
       @table << ['b', 2]
@@ -93,7 +93,7 @@ module Terminal
         +---+---+
       EOF
     end
-    
+
     it "should render properly using block syntax" do
       table = Terminal::Table.new do |t|
         t << ['a', 1]
@@ -108,7 +108,7 @@ module Terminal
         +---+---+
       EOF
     end
-    
+
     it "should render properly using instance_eval block syntax" do
       table = Terminal::Table.new do
         add_row ['a', 1]
@@ -123,7 +123,7 @@ module Terminal
         +---+---+
       EOF
     end
-    
+
     it "should allows a hash of options for creation" do
       headings = ['Char', 'Num']
       rows = [['a', 1], ['b', 2], ['c', 3]]
@@ -137,7 +137,7 @@ module Terminal
         +------+-----+
       EOF
     end
-    
+
     it "should flex for large cells" do
       @table.headings = ['Just some characters', 'Num']
       @table.rows = [['a', 1], ['b', 2], ['c', 3]]
@@ -151,10 +151,10 @@ module Terminal
         +----------------------+-----+
       EOF
     end
-    
+
     it "should allow alignment of headings and cells" do
-      @table.headings = ['Characters', ['Nums', :right ]]
-      @table << [['a', :center ], 1]
+      @table.headings = ['Characters', {:value => 'Nums', :alignment => :right} ]
+      @table << [{:value => 'a', :alignment => :center}, 1]
       @table << ['b', 222222222222222]
       @table << ['c', 3]
       @table.render.should == <<-EOF.deindent
@@ -166,12 +166,12 @@ module Terminal
         | c          | 3               |
         +------------+-----------------+
       EOF
-      
+
     end
-    
+
     it "should align columns, but allow specifics to remain" do
       @table.headings = ['Just some characters', 'Num']
-      @table.rows = [[['a', :left], 1], ['b', 2], ['c', 3]]
+      @table.rows = [[{:value => 'a', :alignment => :left}, 1], ['b', 2], ['c', 3]]
       @table.align_column 0, :center
       @table.align_column 1, :right
       @table.render.should == <<-EOF.deindent
@@ -184,7 +184,7 @@ module Terminal
         +----------------------+-----+
       EOF
     end
-   
+
     describe "#==" do
       it "should be equal to itself" do
         t = Table.new
@@ -194,7 +194,7 @@ module Terminal
       it "should be equal with two empty tables" do
         table_one = Table.new
         table_two = Table.new
-   
+
         table_one.should == table_two
         table_two.should == table_one
       end
@@ -204,7 +204,7 @@ module Terminal
         table_two = Table.new
 
         table_one.headings << "a"
-   
+
         table_one.should_not == table_two
         table_two.should_not == table_one
       end
@@ -214,7 +214,7 @@ module Terminal
         table_two = Table.new
 
         table_one.rows << "a"
-   
+
         table_one.should_not == table_two
         table_two.should_not == table_one
       end
@@ -233,5 +233,64 @@ module Terminal
         table_one.should_not == table_two
       end
     end
+
+    it "should handle colspan inside heading" do
+      @table.headings = ['one', { :value => 'two', :alignment => :center, :colspan => 2}]
+      @table.rows = [['a', 1, 2], ['b', 3, 4], ['c', 3, 4]]
+      @table.render.should == <<-EOF.deindent
+        +-----+-----+---+
+        | one |   two   |
+        +-----+-----+---+
+        | a   | 1   | 2 |
+        | b   | 3   | 4 |
+        | c   | 3   | 4 |
+        +-----+-----+---+
+      EOF
+    end
+
+    it "should handle colspan inside cells" do
+      @table.headings = ['one', 'two', 'three']
+      @table.rows = [['a', 1, 2], ['b', 3, 4], ['c', {:value => "joined", :colspan => 2,:alignment => :center}]]
+      @table.render.should == <<-EOF.deindent
+        +-----+--------+-------+
+        | one | two    | three |
+        +-----+--------+-------+
+        | a   | 1      | 2     |
+        | b   | 3      | 4     |
+        | c   |     joined     |
+        +-----+--------+-------+
+      EOF
+    end
+
+
+    it "should handle colspan 1" do
+      @table.headings = ['name', { :value => 'values', :colspan => 1}]
+      @table.rows = [['a', 1], ['b', 4], ['c', 7]]
+      @table.render.should == <<-EOF.deindent
+        +------+--------+
+        | name | values |
+        +------+--------+
+        | a    | 1      |
+        | b    | 4      |
+        | c    | 7      |
+        +------+--------+
+      EOF
+    end
+
+    it "should handle big colspan" do
+      @table.headings = ['name', { :value => 'values', :alignment => :right, :colspan => 3}]
+      @table.headings = ['name', { :value => 'values', :colspan => 3}]
+      @table.rows = [['a', 1, 2, 3], ['b', 4, 5, 6], ['c', 7, 8, 9]]
+      
+      @table.render.should == <<-EOF.deindent
+        +------+--------+---+---+
+        | name | values         |
+        +------+--------+---+---+
+        | a    | 1      | 2 | 3 |
+        | b    | 4      | 5 | 6 |
+        | c    | 7      | 8 | 9 |
+        +------+--------+---+---+
+      EOF
+    end
   end
 end

data/terminal-table.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{terminal-table}
-  s.version = "1.1.0"
+  s.version = "1.2.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-07-13}
+  s.date = %q{2009-08-06}
   s.description = %q{Simple,}
   s.email = %q{tj@vision-media.ca}
   s.extra_rdoc_files = ["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", "lib/terminal-table.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Terminal-table", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{terminal-table}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Simple,}
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-terminal-table
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-13 00:00:00 -07:00
+date: 2009-08-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -60,6 +60,7 @@ files:
 - Todo.rdoc
 has_rdoc: false
 homepage: http://github.com/visionmedia/terminal-table
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -85,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: terminal-table
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Simple,