tabularize 0.2.2 → 0.2.4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.4
+-----
+- Improvment: Caching result of table generator
+- Bug fix/feature: Handling rows of different number of cells
+
 0.2.2
 -----
 - `screen_width` and `ellipsis` options to cut off trailing cells exceeding specified screen width

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tabularize (0.2.2)
+    tabularize (0.2.3)
       unicode-display_width (~> 0.1.1)
 
 GEM

data/lib/tabularize.rb

@@ -33,6 +33,7 @@ class Tabularize
     @options = DEFAULT_OPTIONS.
                merge(DEFAULT_OPTIONS_GENERATOR).
                merge(options)
+    @cache   = {}
   end
 
   # @since 0.2.0
@@ -51,8 +52,31 @@ class Tabularize
   # @return [String]
   # @since 0.2.0
   def to_s
-    rows = Tabularize.it(@rows, @options)
-    return nil if rows.empty?
+    return nil if @rows.empty?
+
+    # Invalidate cache if needed
+    num_cached_rows = @cache[:num_rows] || 0
+    analysis = Tabularize.analyze(@rows[num_cached_rows..-1], @options.merge(@cache[:analysis] || {}))
+
+    unless @cache.empty?
+      cmw = @cache[:analysis][:max_widths]
+      mw  = analysis[:max_widths]
+      if mw.zip(cmw).any? { |pair| pair.first > (pair.last || 0) }
+        @cache = {}
+        num_cached_rows = 0
+      else
+        [@seps[@rows.length] - @cache[:last_seps], 0].max.times do
+          @cache[:string_io].puts @cache[:separator]
+        end
+        @cache[:last_seps] = @seps[@rows.length]
+
+        if num_cached_rows == @rows.length
+          return @cache[:string_io].string + @cache[:separator]
+        end
+      end
+    end
+    
+    rows = Tabularize.it(@rows[num_cached_rows..-1], @options.merge(analysis))
 
     h  = @options[:hborder]
     v  = @options[:vborder]
@@ -64,26 +88,32 @@ class Tabularize
     sw = @options[:screen_width]
     el = @options[:ellipsis].length
 
-    separator = ''
-    rows[0].each_with_index do |c, idx|
-      new_sep = separator + i + h * Tabularize.cell_width(c, u, a)
+    separator = @cache[:separator]
+    col_count = @cache[:col_count]
+    unless separator
+      separator = ''
+      rows[0].each_with_index do |c, idx|
+        new_sep = separator + i + h * Tabularize.cell_width(c, u, a)
 
-      if sw && Tabularize.cell_width(new_sep, u, a) > sw - el
-        rows = rows.map { |line| line[0, idx] }
-        vl = il = @options[:ellipsis]
-        break
-      else
-        separator = new_sep
+        if sw && Tabularize.cell_width(new_sep, u, a) > sw - el
+          col_count = idx
+          break
+        else
+          separator = new_sep
+        end
       end
+      separator += il
     end
-    separator += il
 
-    output = StringIO.new
-    output.puts separator
+    output = @cache[:string_io] || StringIO.new.tap { |io| io.puts separator }
+    if col_count
+      rows = rows.map { |line| line[0, col_count] }
+      vl = il = @options[:ellipsis]
+    end
     rows.each_with_index do |row, idx|
       row = row.map { |val| val.lines.to_a.map(&:chomp) }
       height = row[0] ? row[0].count : 1
-      @seps[idx].times do
+      @seps[idx + num_cached_rows].times do
         output.puts separator
       end
       (0...height).each do |line|
@@ -94,12 +124,22 @@ class Tabularize
       end
     end
 
-    @seps[rows.length].times do
+    @seps[rows.length + num_cached_rows].times do
       output.puts separator
     end
 
-    output.puts separator
-    output.string
+    @cache = {
+      :analysis  => analysis,
+      :separator => separator,
+      :col_count => col_count,
+      :num_rows  => @rows.length,
+      :string_io => output,
+      :last_seps => @seps[rows.length]
+    }
+    output.string + separator
+  rescue Exception
+    @cache = {}
+    raise
   end
 
   # Returns the display width of a String
@@ -113,6 +153,41 @@ class Tabularize
     str.send(unicode ? :display_width : :length)
   end
 
+  # Determines maximum widths of cells and maximum heights of rows
+  def self.analyze data, options = {}
+    unicode     = options[:unicode]
+    ansi        = options[:ansi]
+    max_widths  = (options[:max_widths] || []).dup
+    max_heights = (options[:max_heights] || []).dup
+    rows        = []
+
+    data.each_with_index do |row, ridx|
+      rows << row = [*row].map(&:to_s)
+
+      row.each_with_index do |cell, idx|
+        nlines = 0
+        cell.lines do |c|
+          max_widths[idx] = [ Tabularize.cell_width(c.chomp, unicode, ansi), max_widths[idx] || 0 ].max
+          nlines += 1
+        end
+        max_heights[ridx] = [ nlines, max_heights[ridx] || 1 ].max
+      end
+    end
+
+    num_cells = max_widths.length
+    rows.each do |row|
+      [num_cells - row.length, 0].max.times do
+        row << ''
+      end
+    end
+
+    {
+      :rows        => rows,
+      :max_widths  => max_widths,
+      :max_heights => max_heights,
+    }
+  end
+
   # Formats two-dimensional tabular data.
   # One-dimensional data (e.g. Array of Strings) is treated as tabular data 
   # of which each row has only one column.
@@ -152,21 +227,10 @@ class Tabularize
       raise ArgumentError.new(":screen_width must be a positive integer")
     end
 
-    rows        = []
-    max_widths  = []
-    max_heights = []
-    table_data.each_with_index do |row, ridx|
-      rows << row = [*row].map(&:to_s)
-
-      row.each_with_index do |cell, idx|
-        nlines = 0
-        cell.lines do |c|
-          max_widths[idx] = [ Tabularize.cell_width(c.chomp, unicode, ansi), max_widths[idx] || 0 ].max
-          nlines += 1
-        end
-        max_heights[ridx] = [ nlines, max_heights[ridx] || 1 ].max
-      end
-    end
+    # Analyze data
+    ret = options[:analysis] || Tabularize.analyze(table_data, options)
+    rows, max_widths, max_heights =
+      [:rows, :max_widths, :max_heights].map { |k| ret[k] }
 
     ridx = -1
     rows.map { |row| 
@@ -175,7 +239,7 @@ class Tabularize
       max_height = max_heights[ridx]
       row.map { |cell|
         idx += 1
-        lines = cell.lines.to_a
+        lines = cell.to_s.lines.to_a
         offset =
           case valign[idx] || valign.last
           when :top

data/lib/tabularize/version.rb

@@ -1,3 +1,3 @@
 class Tabularize
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/test/fixture/tabularize_csv.txt

@@ -0,0 +1,56 @@
+Name        |Dept       |Location                  |Phone   
+John Doe    |Finance    |Los Angeles, CA 90089     |555-1555
+Average Joe |Engineering|Somewhere over the rainbow|N/A     
+Hong Gildong|HR         |Nowhere                   |555-5555
+        Name|       Dept|                  Location|   Phone
+    John Doe|    Finance|     Los Angeles, CA 90089|555-1555
+ Average Joe|Engineering|Somewhere over the rainbow|     N/A
+Hong Gildong|         HR|                   Nowhere|555-5555
+    Name    |   Dept    |         Location         | Phone  
+  John Doe  |  Finance  |  Los Angeles, CA 90089   |555-1555
+Average Joe |Engineering|Somewhere over the rainbow|  N/A   
+Hong Gildong|    HR     |         Nowhere          |555-5555
+Name________|Dept_______|Location__________________|Phone___
+John Doe____|Finance____|Los Angeles, CA 90089_____|555-1555
+Average Joe_|Engineering|Somewhere over the rainbow|N/A_____
+Hong Gildong|HR_________|Nowhere___________________|555-5555
+Name        |Dept       |Location                   |Phone   
+John Doe    |Finance    |Los Angeles, CA 90089      |555-1555
+Average Joe |Engineering|Somewhere over the rainbow |N/A     
+Hong Gildong|HR         |Nowhere                    |555-5555
+홍길동      |탁상 3부   |서울역 3번 출구 김씨 옆자리|N/A     
+        Name|       Dept|                   Location|   Phone
+    John Doe|    Finance|      Los Angeles, CA 90089|555-1555
+ Average Joe|Engineering| Somewhere over the rainbow|     N/A
+Hong Gildong|         HR|                    Nowhere|555-5555
+      홍길동|   탁상 3부|서울역 3번 출구 김씨 옆자리|     N/A
+    Name    |   Dept    |         Location          | Phone  
+  John Doe  |  Finance  |   Los Angeles, CA 90089   |555-1555
+Average Joe |Engineering|Somewhere over the rainbow |  N/A   
+Hong Gildong|    HR     |          Nowhere          |555-5555
+   홍길동   | 탁상 3부  |서울역 3번 출구 김씨 옆자리|  N/A   
+Name________|Dept_______|Location___________________|Phone___
+John Doe____|Finance____|Los Angeles, CA 90089______|555-1555
+Average Joe_|Engineering|Somewhere over the rainbow_|N/A_____
+Hong Gildong|HR_________|Nowhere____________________|555-5555
+홍길동______|탁상 3부___|서울역 3번 출구 김씨 옆자리|N/A_____
+Name        |Dept       |Location                   |Phone   
+John Doe    |Finance    |Los Angeles, CA 90089      |555-1555
+Average Joe |Engineering|Somewhere over the rainbow |N/A     
+Hong Gildong|HR         |Nowhere                    |555-5555
+홍길동      |탁상 3부   |서울역 3번 출구 김씨 옆자리|N/A     
+        Name|       Dept|                   Location|   Phone
+    John Doe|    Finance|      Los Angeles, CA 90089|555-1555
+ Average Joe|Engineering| Somewhere over the rainbow|     N/A
+Hong Gildong|         HR|                    Nowhere|555-5555
+      홍길동|   탁상 3부|서울역 3번 출구 김씨 옆자리|     N/A
+    Name    |   Dept    |         Location          | Phone  
+  John Doe  |  Finance  |   Los Angeles, CA 90089   |555-1555
+Average Joe |Engineering|Somewhere over the rainbow |  N/A   
+Hong Gildong|    HR     |          Nowhere          |555-5555
+   홍길동   | 탁상 3부  |서울역 3번 출구 김씨 옆자리|  N/A   
+Name________|Dept_______|Location___________________|Phone___
+John Doe____|Finance____|Los Angeles, CA 90089______|555-1555
+Average Joe_|Engineering|Somewhere over the rainbow_|N/A_____
+Hong Gildong|HR_________|Nowhere____________________|555-5555
+홍길동______|탁상 3부___|서울역 3번 출구 김씨 옆자리|N/A_____

data/test/test_tabularize.rb

@@ -68,22 +68,22 @@ class TestTabularize < Test::Unit::TestCase
       :left =>
         [
           "a                   |aa  |aaa|aaaa",
-          "cccccccccccccccccccc",
-          "ddd                 |dddd|d  ",
+          "cccccccccccccccccccc|    |   |    ",
+          "ddd                 |dddd|d  |    ",
           "bbbb                |bbb |bb |b   "
         ],
       :right =>
         [
           "                   a|  aa|aaa|aaaa",
-          "cccccccccccccccccccc",
-          "                 ddd|dddd|  d",
+          "cccccccccccccccccccc|    |   |    ",
+          "                 ddd|dddd|  d|    ",
           "                bbbb| bbb| bb|   b"
         ],
       :center =>
         [
           "         a          | aa |aaa|aaaa",
-          "cccccccccccccccccccc",
-          "        ddd         |dddd| d ",
+          "cccccccccccccccccccc|    |   |    ",
+          "        ddd         |dddd| d |    ",
           "        bbbb        |bbb |bb | b  "
         ]
     }
@@ -96,36 +96,47 @@ class TestTabularize < Test::Unit::TestCase
       [ '.', '_' ].each do |pad|
         [:left, :right, :center].each do |align|
           result = Tabularize.it(data, :pad => pad, :align => align)
-          ap :align => align, :pad => pad, :from => data, :to => result.map { |r| r.join('|') }
           assert_equal RESULT[data][align], result.map { |row| row.join('|').gsub(pad, ' ') }
         end
       end
     end
   end
 
+  def test_analyze
+    data = []
+    data << %w[a bb ccc]
+    data << %w[aa bb cc]
+    data << %w[aaa bb cc]
+    data << %w[aaa bb cc] + ["dddd\neee"]
+    data << %w[f]
+    ret = Tabularize.analyze(data, :unicode => true, :ansi => true)
+    assert_equal [%w[a bb ccc].push(''), %w[aa bb cc].push(''), %w[aaa bb cc].push(''),
+                  %w[aaa bb cc] + ["dddd\neee"], %w[f] + [''] * 3], ret[:rows]
+    assert_equal [1, 1, 1, 2, 1], ret[:max_heights]
+    assert_equal [3, 2, 3, 4], ret[:max_widths]
+  end
+
   # TODO: Need assertion
   def test_tabularize_csv
+    sio = StringIO.new
+
     {
-      'test.csv' => [false, false],
-      'test_unicode.csv' => [true, false],
-      'test_unicode_ansi.csv' => [true, true]
+      'fixture/test.csv' => [false, false],
+      'fixture/test_unicode.csv' => [true, false],
+      'fixture/test_unicode_ansi.csv' => [true, true]
     }.each do |file, unicode_ansi|
       unicode, ansi = unicode_ansi
       opts = { :unicode => unicode, :ansi => ansi }
       data = CSV.read(File.join(File.dirname(__FILE__), file), :col_sep => '|')
-      ap data
       output = Tabularize.it(data, opts).map { |row| row.join '|' }
-      ap output
-      puts
-      puts output
-
-      puts Tabularize.it(data, opts.merge(:align => :right)).map { |row| row.join '|' }
-      puts
-      puts Tabularize.it(data, opts.merge(:align => :center)).map { |row| row.join '|' }
-      puts
-      puts Tabularize.it(data, opts.merge(:pad => '_')).map { |row| row.join '|' }
 
+      sio.puts output
+      sio.puts Tabularize.it(data, opts.merge(:align => :right)).map { |row| row.join '|' }
+      sio.puts Tabularize.it(data, opts.merge(:align => :center)).map { |row| row.join '|' }
+      sio.puts Tabularize.it(data, opts.merge(:pad => '_')).map { |row| row.join '|' }
     end
+
+    assert_equal File.read(File.join(File.dirname(__FILE__), 'fixture/tabularize_csv.txt')), sio.string
   end
 
   def test_invalid_arguments
@@ -156,17 +167,29 @@ class TestTabularize < Test::Unit::TestCase
     table << DATA2[2]
     table << DATA2[3]
 
-    puts table.to_s
+    assert_equal(
+'#============================#============#===========#============#
+I,,,,,,,,,,,,a,,,,,,,,,,,,,,,I,,,,aa,,,,,,I,,,aaa,,,,,I,,,aaaa,,,,,I
+#============================#============#===========#============#
+I,,,,,,,,,,,,a,,,,,,,,,,,,,,,I,,,,aa,,,,,,I,,,aaa,,,,,I,,,aaaa,,,,,I
+#============================#============#===========#============#
+#============================#============#===========#============#
+I,,,cccccccccccccccccccc,,,,,I,,,,,,,,,,,,I,,,,,,,,,,,I,,,,,,,,,,,,I
+#============================#============#===========#============#
+I,,,,,,,,,,,ddd,,,,,,,,,,,,,,I,,,dddd,,,,,I,,,,d,,,,,,I,,,,,,,,,,,,I
+I,,,,,,,,,,,bbbb,,,,,,,,,,,,,I,,,bbb,,,,,,I,,,bb,,,,,,I,,,,b,,,,,,,I
+#============================#============#===========#============#', table.to_s)
   end
 
   def test_table_complex
+    separator = '#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#'
     output = "
 #~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
 I..Name.......I.....Dept....I.....................LocationI.....PhoneI
 #~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
 I..John Doe...I....Finance..I.........Los Angeles CA 90089I..555-1555I
 I..Average JoeI..EngineeringI...Somewhere over the rainbowI.......N/AI
-I..1..........I
+I..1..........I.............I.............................I..........I
 #~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
 #~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
 I..홍길동.....I.............I..서울역 3번 출구 김씨 옆자리I..........I
@@ -191,17 +214,56 @@ I.............I...탁상 3부..I.....................맞습니다I..........I
     table << ['홍길동', '탁상 3부', "서울역 3번 출구 김씨 옆자리\n\n맞습니다", 'N/A']
     table.separator!
     table.separator!
+
+    100.times do
+      assert_equal output, table.to_s.strip
+    end
+    table.separator!
+    table.separator!
+    assert_equal [output, separator, separator].join($/), table.to_s.strip
+    assert_equal [output, separator, separator].join($/), table.to_s.strip
+    table << "This should change everything doh!"
+    output = "
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+I..Name..............................I.....Dept....I.....................LocationI.....PhoneI
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+I..John Doe..........................I....Finance..I.........Los Angeles CA 90089I..555-1555I
+I..Average Joe.......................I..EngineeringI...Somewhere over the rainbowI.......N/AI
+I..1.................................I.............I.............................I..........I
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+I..홍길동............................I.............I..서울역 3번 출구 김씨 옆자리I..........I
+I....................................I.............I.............................I.......N/AI
+I....................................I...탁상 3부..I.....................맞습니다I..........I
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+I..This should change everything doh!I.............I.............................I..........I
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#".strip
+    assert_equal output, table.to_s.strip
     assert_equal output, table.to_s.strip
+
+    separator = '#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#'
+    line = 'I..a.................................I.......b.....I............................cI.........dI'
+    10.times do |i|
+      table << %w[a b c d]
+      expected = (output.lines.to_a[0..-2].map(&:chomp) + [line] * (i+1) + [separator]).join($/)
+      assert_equal expected, table.to_s
+    end
   end
 
   def test_screen_width
     [1, 3, 9, 50, 80].each do |w|
       t = Tabularize.new :screen_width => w
       10.times do
-        t << ['12345'] * 80
+        t << ['12345'] * 20
       end
-      puts t
       assert t.to_s.lines.all? { |line| line.chomp.length <= w }
+      t << %w[12345]
+      puts t.to_s
+      assert t.to_s.lines.all? { |line| line.chomp.length <= w }
+      assert t.to_s.lines.all? { |line| %w[+ >].include?(line.chomp.reverse[0, 1]) }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tabularize
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-21 00:00:00.000000000 Z
+date: 2012-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -76,11 +76,12 @@ files:
 - lib/tabularize.rb
 - lib/tabularize/version.rb
 - tabularize.gemspec
+- test/fixture/tabularize_csv.txt
+- test/fixture/test.csv
+- test/fixture/test_unicode.csv
+- test/fixture/test_unicode_ansi.csv
 - test/readme.rb
-- test/test.csv
 - test/test_tabularize.rb
-- test/test_unicode.csv
-- test/test_unicode_ansi.csv
 homepage: ''
 licenses: []
 post_install_message: 
@@ -106,8 +107,9 @@ signing_key:
 specification_version: 3
 summary: Formatting tabular data
 test_files:
+- test/fixture/tabularize_csv.txt
+- test/fixture/test.csv
+- test/fixture/test_unicode.csv
+- test/fixture/test_unicode_ansi.csv
 - test/readme.rb
-- test/test.csv
 - test/test_tabularize.rb
-- test/test_unicode.csv
-- test/test_unicode_ansi.csv