tabularize 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.1
+-----
+- Multi-line support
+- Vertical alignment
+
 0.2.0
 -----
 - Tabularize::Table class for easy tabularization (doh!)

data/Gemfile.lock

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

data/README.md

@@ -2,7 +2,8 @@ tabularize
 ==========
 
 Formatting tabular data with paddings.
-`tabularize` correctly handles CJK wide characters and ANSI codes.
+[tabularize](https://github.com/junegunn/tabularize) correctly handles
+CJK (Chinese, Japanese and Korean) wide characters and ANSI codes.
 
 Inspired by tabular.vim (https://github.com/godlygeek/tabular)
 
@@ -49,17 +50,19 @@ puts table
  * `:vborder` Character for vertical border
  * `:iborder` Character for intersection point
 * Alignment
- * `:align` Cell alignment. `:left`, `:center`, `:right`, or Array of the three options
+ * `:align` Horizontal alignment. `:left`, `:center`, `:right`, or Array of the three options
+ * `:valign` Vertical alignment. `:top`, `:middle`, `:bottom`, or Array of the three options
 
 ```ruby
-table = Tabularize.new :pad => '.', :pad_left => 2, :pad_right => 0,
+table = Tabularize.new :pad     => '.', :pad_left => 2,  :pad_right => 0,
                        :hborder => '~', :vborder => 'I', :iborder => '#',
-                       :align => [:left, :center, :right]
+                       :align   => [:left, :center, :right],
+                       :valign  => [:top, :bottom, :middle, :middle]
 table << %w[Name Dept Location Phone]
 table.separator!
-table << ['John Doe', 'Finance', 'Los Angeles CA 90089', '555-1555']
+table << ['John Doe', 'Finance', 'Los Angeles CA 90089', "555-1555"]
 table << ['Average Joe', 'Engineering', 'Somewhere over the rainbow', 'N/A']
-table << ['홍길동', '탁상 3부', '서울역 3번 출구 김씨 옆자리', 'N/A']
+table << ['홍길동', '탁상 3부', "서울역 3번 출구 김씨 옆자리\n\n맞습니다", 'N/A']
 puts table
 ```
 
@@ -69,7 +72,9 @@ 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..홍길동.....I...탁상 3부..I..서울역 3번 출구 김씨 옆자리I.......N/AI
+I..홍길동.....I.............I..서울역 3번 출구 김씨 옆자리I..........I
+I.............I.............I.............................I.......N/AI
+I.............I...탁상 3부..I.....................맞습니다I..........I
 #~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
 ```
 
@@ -178,14 +183,25 @@ Hong Gildong | HR_________ | Nowhere___________________ | 555-5555
 
 ANSI codes and CJK wide characters
 ----------------------------------
-`tabularize` correctly calculates each cell width even in the presence of ANSI codes and CJK wide characters.
+[tabularize](https://github.com/junegunn/tabularize) correctly calculates each cell width even in the presence of ANSI codes and CJK wide characters.
 If your data doesn't have any of them, unset `:unicode` and `:ansi` options
-so that `tabularize` can process data more efficiently.
+so that [tabularize](https://github.com/junegunn/tabularize) can process data more efficiently.
 
 ```ruby
 table = Tabularize.new :unicode => false, :ansi => false
 ```
 
+Related work
+------------
+I wasn't aware of [terminal-table](https://github.com/visionmedia/terminal-table)
+when I blindly started building [tabularize](https://github.com/junegunn/tabularize).
+It has more features and clearly is more mature than [tabularize](https://github.com/junegunn/tabularize),
+you should definitely check it out.
+
+There are a couple of things, however, [tabularize](https://github.com/junegunn/tabularize) does better:
+- It correctly formats cells containing CJK wide characters.
+- Vertical alignment for multi-line cells
+
 Copyright
 ---------
 

data/lib/tabularize.rb

@@ -5,6 +5,7 @@ require 'unicode/display_width'
 class Tabularize
   DEFAULT_OPTIONS = {
     :align     => :left,
+    :valign    => :top,
     :pad       => ' ',
     :pad_left  => 0,
     :pad_right => 0,
@@ -63,11 +64,22 @@ class Tabularize
     output = StringIO.new
     output.puts separator
     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
         output.puts separator
       end
-      output.puts v + row.join(v) + v
+      (0...height).each do |line|
+        output.puts v + row.map { |lines|
+          lines[line] || @options[:pad] * Tabularize.cell_width(lines[0], u, a)
+        }.join(v) + v
+      end
+    end
+
+    @seps[rows.length].times do
+      output.puts separator
     end
+
     output.puts separator
     output.string
   end
@@ -97,7 +109,8 @@ class Tabularize
     pad     = options[:pad].to_s
     padl    = options[:pad_left]
     padr    = options[:pad_right]
-    align   = [options[:align]].flatten
+    align   = [*options[:align]]
+    valign  = [*options[:valign]]
     unicode = options[:unicode]
     ansi    = options[:ansi]
 
@@ -113,42 +126,69 @@ class Tabularize
     unless align.all? { |a| [:left, :right, :center].include?(a) }
       raise ArgumentError.new("Invalid alignment")
     end
+    unless valign.all? { |a| [:top, :bottom, :middle].include?(a) }
+      raise ArgumentError.new("Invalid vertical alignment")
+    end
 
-    rows       = []
-    max_widths = []
-    table_data.each do |row|
-      rows << row = [*row].map(&:to_s).map(&:chomp)
+    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|
-        max_widths[idx] = [ Tabularize.cell_width(cell, unicode, ansi), max_widths[idx] || 0 ].max
+        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
 
+    ridx = -1
     rows.map { |row| 
+      ridx += 1
       idx = -1
-      row.map { |str|
-        alen = 
-          if ansi
-            Tabularize.cell_width(str, false, false) -
-              Tabularize.cell_width(str, false, true)
-          else
+      max_height = max_heights[ridx]
+      row.map { |cell|
+        idx += 1
+        lines = cell.lines.to_a
+        offset =
+          case valign[idx] || valign.last
+          when :top
             0
+          when :bottom
+            max_height - lines.length
+          when :middle
+            (max_height - lines.length) / 2
           end
-        slen = str.length - alen
 
-        idx += 1
-        w = max_widths[idx]
-        w += str.length - str.display_width if unicode
-        pad * padl + 
-          case align[idx] || align.last
-          when :left
-            str.ljust(w + alen, pad)
-          when :right
-            str.rjust(w + alen, pad)
-          when :center
-            str.rjust((w - slen) / 2 + slen + alen, pad).ljust(w + alen, pad)
-          end +
-            pad * padr
+        (0...max_height).map { |ln|
+          ln -= offset
+          str = (ln >= 0 && lines[ln]) ? lines[ln].chomp : (pad * max_widths[idx])
+          alen = 
+            if ansi
+              Tabularize.cell_width(str, false, false) -
+                Tabularize.cell_width(str, false, true)
+            else
+              0
+            end
+          slen = str.length - alen
+
+          w = max_widths[idx]
+          w += str.length - str.display_width if unicode
+          pad * padl + 
+            case align[idx] || align.last
+            when :left
+              str.ljust(w + alen, pad)
+            when :right
+              str.rjust(w + alen, pad)
+            when :center
+              str.rjust((w - slen) / 2 + slen + alen, pad).ljust(w + alen, pad)
+            end +
+              pad * padr
+        }.join($/)
       }
     }
   end

data/lib/tabularize/version.rb

@@ -1,3 +1,3 @@
 class Tabularize
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/readme.rb

@@ -8,12 +8,13 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'tabularize'
 
 table = Tabularize.new
-table = Tabularize.new :pad => '.', :pad_left => 2, :pad_right => 0,
+table = Tabularize.new :pad     => '.', :pad_left => 2,  :pad_right => 0,
                        :hborder => '~', :vborder => 'I', :iborder => '#',
-                       :align => [:left, :center, :right]
+                       :align   => [:left, :center, :right],
+                       :valign  => [:top, :bottom, :middle, :middle]
 table << %w[Name Dept Location Phone]
 table.separator!
 table << ['John Doe', 'Finance', 'Los Angeles CA 90089', '555-1555']
 table << ['Average Joe', 'Engineering', 'Somewhere over the rainbow', 'N/A']
-table << ['홍길동', '탁상 3부', '서울역 3번 출구 김씨 옆자리', 'N/A']
+table << ['홍길동', '탁상 3부', "서울역 3번 출구 김씨 옆자리\n\n맞습니다", 'N/A']
 puts table

data/test/test_tabularize.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'rubygems'
 require 'bundler'
 Bundler.setup(:default, :development)
@@ -131,7 +132,9 @@ class TestTabularize < Test::Unit::TestCase
     assert_raise(ArgumentError) { Tabularize.it(5) }
     assert_raise(ArgumentError) { Tabularize.it("hello") }
     assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :align => :noidea) }
+    assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :valign => :noidea) }
     assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :align => [:center, :top]) }
+    assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :valign => [:left, :right]) }
     assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :pad => 'long') }
     assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :pad => ' ', :pad_left => -1) }
     assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :pad => ' ', :pad_left => '') }
@@ -154,4 +157,39 @@ class TestTabularize < Test::Unit::TestCase
 
     puts table.to_s
   end
+
+  def test_table_complex
+    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..홍길동.....I.............I..서울역 3번 출구 김씨 옆자리I..........I
+I.............I.............I.............................I.......N/AI
+I.............I...탁상 3부..I.....................맞습니다I..........I
+#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+    ".strip
+
+    table = Tabularize.new :pad     => '.', :pad_left => 2,  :pad_right => 0,
+                           :hborder => '~', :vborder => 'I', :iborder => '#',
+                           :align   => [:left, :center, :right],
+                           :valign  => [:top, :bottom, :middle, :middle]
+    table << %w[Name Dept Location Phone]
+    table.separator!
+    table << ['John Doe', 'Finance', 'Los Angeles CA 90089', '555-1555']
+    table << ['Average Joe', 'Engineering', 'Somewhere over the rainbow', 'N/A']
+    table << [1]
+    table.separator!
+    table.separator!
+    table << ['홍길동', '탁상 3부', "서울역 3번 출구 김씨 옆자리\n\n맞습니다", 'N/A']
+    table.separator!
+    table.separator!
+    assert_equal output, table.to_s.strip
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tabularize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-10 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print