terminal-table 1.4.1 → 1.4.2

data/History.rdoc

@@ -1,4 +1,9 @@
 
+1.4.2 / 2010-01-14
+==================
+
+  * Fixed some bugs with colspan
+  
 === 1.4.1 / 2009-12-18
 
 * Fix column alignment with separators.

data/examples/examples.rb

@@ -57,15 +57,11 @@ rows << ['Ruby',       70]
 rows << ['JavaScript', 30]
 puts table(nil, *rows)
 
-
-$VERBOSE = nil
-Terminal::Table::X = '='
-Terminal::Table::Y = '!'
-Terminal::Table::I = '*'
-
 rows = []
-rows << [nil,  nil, nil]
-rows << [nil, ':)', nil]
-rows << [nil,  nil, nil]
-puts table(nil, *rows)
-
+rows << ['Lines',      100]
+rows << ['Comments',   20]
+rows << ['Ruby',       70]
+rows << ['JavaScript', 30]
+table = table([{ :value => 'Stats', :colspan => 2, :alignment => :center }], *rows)
+table.align_column 1, :right
+puts table

data/lib/terminal-table/table.rb

@@ -75,7 +75,7 @@ module Terminal
         separator
       else
         Y + row.map_with_index do |cell, i|
-          render_cell(cell, i)
+          render_cell(cell, row_to_index(row, i))
         end.join(Y) + Y
       end
     end
@@ -138,7 +138,38 @@ module Terminal
     # Return _n_ column including headings.
     
     def column_with_headings n
-      headings_with_rows.map { |row| row[n] }.compact  
+      headings_with_rows.map { |row| row_with_hash(row)[n] }.compact
+    end
+
+    def row_with_hash row
+      # this method duplicates the multi-column columns in each column they are in
+      index = 0
+      row.inject [] do |columns, column|
+        if column.is_a?(Hash) && column[:colspan] && column[:colspan] > 1
+          column[:start_index] = index
+          column[:colspan].times do
+            columns << column
+            index += 1
+          end
+        else
+          columns << column
+          index += 1
+        end
+        columns
+      end
+    end
+
+    def row_to_index row, index
+      new_index = -1
+      0.upto(index) do |i|
+        column = row[i]
+        if column.is_a?(Hash) && column[:colspan] && column[:colspan] > 1 && index != i
+          new_index = new_index + column[:colspan]
+        else
+          new_index += 1
+        end
+      end
+      return new_index
     end
     
     ##
@@ -149,22 +180,63 @@ module Terminal
     end
     
     ##
-    # Return the largest cell found within column _n_.
-    
-    def largest_cell_in_column n
-      column_with_headings(n).sort_by do |cell| 
-        Cell.new(0, cell).length 
-      end.last
+    # Return the length of the largest cell found within column _n_.
+
+    def length_of_largest_cell_in_column n
+      column_with_headings(n).map do |cell|
+        if cell.is_a? Hash
+          if cell[:colspan] && cell[:colspan] > 1
+            if (cell[:value].to_s.length <= length_of_single_columns_where_multicolumn_is(cell[:start_index],cell[:colspan]))
+              0
+            else
+              spacing_length = (3 * (cell[:colspan] - 1))
+              length_in_columns = (cell[:value].to_s.length - spacing_length)
+              (length_in_columns.to_f / cell[:colspan]).ceil
+            end
+          else
+            cell[:value].to_s.length
+          end
+        else
+          cell.to_s.length
+        end
+      end.sort.last
+    end
+
+    ##
+    # Returns the length of the largest single column cell found within column _n_.
+
+    def length_of_largest_single_column_cell_in_column n
+      column_with_headings(n).map do |cell|
+        if cell.is_a? Hash
+          if cell[:colspan] && cell[:colspan] > 1
+            0
+          else
+            cell[:value].to_s.length
+          end
+        else
+          cell.to_s.length
+        end
+      end.sort.last
+    end
+
+    ##
+    # Returns the length of the single columns starting from _n_ and going through _length_ columns.
+
+    def length_of_single_columns_where_multicolumn_is(n,length)
+      total_length = 0
+      spacing_length = (3 * (length - 1))
+      total_length = total_length + spacing_length
+      n.upto(n + length - 1) do |i|
+        total_length = total_length + length_of_largest_single_column_cell_in_column(i)
+      end
+      return total_length
     end
     
     ##
     # Return length of column _n_.
     
     def length_of_column n
-      largest_cell = largest_cell_in_column n
-      Hash === largest_cell ?
-        largest_cell[:value].to_s.length :
-          largest_cell.to_s.length
+      length_of_largest_cell_in_column n      
     end
     
     ##

data/lib/terminal-table/version.rb

@@ -1,6 +1,6 @@
 
 module Terminal
   class Table
-    VERSION = '1.4.1'
+    VERSION = '1.4.2'
   end
 end

data/spec/table_spec.rb

@@ -13,6 +13,43 @@ module Terminal
       @table.column(1).should == ['bar', 'big foo bar']
     end
 
+    it "should select the column with headings at an index" do
+      @table << [1,2,3]
+      @table << [4,5,6]
+      @table.column_with_headings(2).should == [3,6]
+    end
+
+    it "should select the columns with colspans > 1 in the index" do
+      @table << [1,{:value => 2, :colspan => 2}]
+      @table << [{:value => 3, :colspan => 2}, 4]
+    end
+
+    it "should account for the colspan when selecting columns" do
+      @table << [1,2,3]
+      @table << [{:value => "4,5", :colspan => 2}, 6]
+      @table.column_with_headings(0).should == [1,{:start_index => 0, :value => "4,5", :colspan => 2}]
+      @table.column_with_headings(1).should == [2,{:start_index => 0, :value => "4,5", :colspan => 2}]
+      @table.column_with_headings(2).should == [3,6]
+    end
+
+    it "should render tables with colspan properly" do
+      @table << [1,2,3]
+      @table << [4,5,6]
+      @table << [{:value => "7", :colspan => 2}, 88]
+      @table.render.should == <<-EOF.deindent
+        +---+---+----+
+        | 1 | 2 | 3  |
+        | 4 | 5 | 6  |
+        | 7     | 88 |
+        +---+---+----+
+      EOF
+    end
+
+    it "should convert rows to indexes" do
+      @table << [{:value => '7', :colspan => 2}, 88]
+      @table.row_to_index(@table.rows[0], 1).should == 2
+    end
+
     it "should count columns" do
       @table << [1, 2, 3]
       @table.number_of_columns.should == 3
@@ -37,10 +74,42 @@ module Terminal
       @table.column(0).should == [{ :value => 'a', :align => :left }, 'b', 'c']
     end
 
-    it "should select largest cell in a column" do
+    it "should determine length of 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'
+      @table.length_of_largest_cell_in_column(1).should == 11
+    end
+
+    it "should determine length of largest cell in a column with multi-column rows" do
+      @table << [1,2]
+      @table << [{:value => '123456789', :colspan => 2}]
+      # +-----+-----+
+      # | 1   | 2   |
+      # | 123456789 |
+      #
+      @table.length_of_largest_cell_in_column(0).should == 3
+      @table.length_of_largest_cell_in_column(1).should == 3
+
+      @table.render.should == <<-EOF.deindent
+        +-----+-----+
+        | 1   | 2   |
+        | 123456789 |
+        +-----+-----+
+      EOF
+    end
+
+    it "should determine length of largest cell in a column with multi-column rows, rounding up" do
+      @table << [1,2]
+      @table << [{:value => '1234567890', :colspan => 2}]
+      @table.length_of_largest_cell_in_column(0).should == 4
+      @table.length_of_largest_cell_in_column(1).should == 4
+
+      @table.render.should == <<-EOF.deindent
+        +------+------+
+        | 1    | 2    |
+        | 1234567890  |
+        +------+------+
+      EOF
     end
 
     it "should find column length" do
@@ -285,27 +354,66 @@ module Terminal
       @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 |
-        +-----+-----+---+
+        +-----+---+---+
+        | 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], [{:value => "joined", :colspan => 2,:alignment => :center}, 'c']]
+      @table.render.should == <<-EOF.deindent
+        +-----+-----+-------+
+        | one | two | three |
+        +-----+-----+-------+
+        | a   | 1   | 2     |
+        | b   | 3   | 4     |
+        |  joined   | c     |
+        +-----+-----+-------+
+      EOF
+    end
+
+    it "should handle colspan inside cells regardless of colspan position" 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     |
-        +-----+--------+-------+
+        +-----+-----+-------+
+        | one | two | three |
+        +-----+-----+-------+
+        | a   | 1   | 2     |
+        | b   | 3   | 4     |
+        | c   |   joined    |
+        +-----+-----+-------+
+      EOF
+    end
+
+    it "should handle overflowing colspans" do
+      @table.headings = ['one', 'two', 'three']
+      @table.rows = [['a', 1, 2], ['b', 3, 4], ['c', {:value => "joined that is very very long", :colspan => 2,:alignment => :center}]]
+      @table.render.should == <<-EOF.deindent
+        +-----+---------------+---------------+
+        | one | two           | three         |
+        +-----+---------------+---------------+
+        | a   | 1             | 2             |
+        | b   | 3             | 4             |
+        | c   | joined that is very very long |
+        +-----+---------------+---------------+
+      EOF
+    end
+
+    it "should only increase column size for multi-column if it is unavoidable" do
+      @table << [12345,2,3]
+      @table << [{:value => 123456789, :colspan => 2}, 4]
+      @table.render.should == <<-EOF.deindent
+        +-------+---+---+
+        | 12345 | 2 | 3 |
+        | 123456789 | 4 |
+        +-------+---+---+
       EOF
     end
 
@@ -330,13 +438,13 @@ module Terminal
       @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 |
-        +------+--------+---+---+
+        +------+---+---+---+
+        | name | values    |
+        +------+---+---+---+
+        | a    | 1 | 2 | 3 |
+        | b    | 4 | 5 | 6 |
+        | c    | 7 | 8 | 9 |
+        +------+---+---+---+
       EOF
     end
   end

data/terminal-table.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{terminal-table}
-  s.version = "1.4.1"
+  s.version = "1.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-12-18}
+  s.date = %q{2010-01-14}
   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.4.1
+  version: 1.4.2
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-18 00:00:00 -08:00
+date: 2010-01-14 00:00:00 -08:00
 default_executable: 
 dependencies: []