tabularize 0.2.5 → 0.2.7

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+0.2.7
+-----
+- Customizable border
+```ruby
+  :hborder      => '─',
+  :vborder      => '│',
+  :iborder      => %w[┌ ┬ ┐ ├ ┼ ┤ └ ┴ ┘],
+```
+- `:border_color`
+- Predefined border styles. `:border_style => :unicode`
+
 0.2.5
 -----
 - Minor bug fixes

data/Gemfile.lock

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

data/README.md

@@ -46,9 +46,11 @@ puts table
  * `:pad_left` Size of left padding
  * `:pad_right` Size of right padding
 * Border
+ * `:border_style` Predefined border styles. `:ascii` (default) and `:unicode`
+ * `:border_color` ANSI color code for borders
  * `:hborder` Character for horizontal border
  * `:vborder` Character for vertical border
- * `:iborder` Character for intersection point
+ * `:iborder` Array of 9 characters for intersection points. e.g. `%w[┌ ┬ ┐ ├ ┼ ┤ └ ┴ ┘]`
 * Alignment
  * `:align` Horizontal alignment. `:left`, `:center`, `:right`, or Array of the three options
  * `:valign` Vertical alignment. `:top`, `:middle`, `:bottom`, or Array of the three options
@@ -57,7 +59,11 @@ puts table
  * `:ellipsis` Ellipsis string when cells are cut off. Default: `>`
 
 ```ruby
+require 'ansi'
+
 table = Tabularize.new :pad     => '.', :pad_left => 2,  :pad_right => 0,
+                       :border_style => :unicode,
+                       :border_color => ANSI::Code.red,
                        :hborder => '~', :vborder => 'I', :iborder => '#',
                        :align   => [:left, :center, :right],
                        :valign  => [:top, :bottom, :middle, :middle],
@@ -71,15 +77,15 @@ puts table
 ```
 
 ```
-#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~X
-I..Name.......I.....Dept....I.....................LocationI.....PhoneX
-#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~X
-I..John Doe...I....Finance..I.........Los Angeles CA 90089I..555-1555X
-I..Average JoeI..EngineeringI...Somewhere over the rainbowI.......N/AX
-I..홍길동.....I.............I..서울역 3번 출구 김씨 옆자리I..........X
-I.............I.............I.............................I.......N/AX
-I.............I...탁상 3부..I.....................맞습니다I..........X
-#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~X
+┌─────────────┬─────────────┬─────────────────────────────┬──────────~
+│..Name.......│.....Dept....│.....................Location│.....Phone~
+├─────────────┼─────────────┼─────────────────────────────┼──────────~
+│..John Doe...│....Finance..│.........Los Angeles CA 90089│..555-1555~
+│..Average Joe│..Engineering│...Somewhere over the rainbow│.......N/A~
+│..홍길동.....│.............│..서울역 3번 출구 김씨 옆자리│..........~
+│.............│.............│.............................│.......N/A~
+│.............│...탁상 3부..│.....................맞습니다│..........~
+└─────────────┴─────────────┴─────────────────────────────┴──────────~
 ```
 
 Tabularize.it
@@ -206,6 +212,7 @@ There are a few things, however, [tabularize](https://github.com/junegunn/tabula
 - It correctly formats cells containing CJK wide characters.
 - Vertical alignment for multi-line cells
 - Cutting off trailing cells when the width of the output string exceeds specified screen width
+- Customizable border style
 
 Copyright
 ---------

data/lib/tabularize.rb

@@ -1,21 +1,22 @@
+# encoding: utf-8
+
 require "tabularize/version"
 require 'stringio'
 require 'unicode/display_width'
 
 class Tabularize
   DEFAULT_OPTIONS = {
-    :align     => :left,
-    :valign    => :top,
-    :pad       => ' ',
-    :pad_left  => 0,
-    :pad_right => 0,
+    :align        => :left,
+    :valign       => :top,
+    :pad          => ' ',
+    :pad_left     => 0,
+    :pad_right    => 0,
 
-    :hborder   => '-',
-    :vborder   => '|',
-    :iborder   => '+',
+    :border_style => :ascii,
+    :border_color => nil,
 
-    :unicode   => true,
-    :ansi      => true,
+    :unicode      => true,
+    :ansi         => true,
 
     :ellipsis     => '>',
     :screen_width => nil,
@@ -26,6 +27,19 @@ class Tabularize
     :pad_right => 1,
   }
 
+  BORDER_STYLE = {
+    :ascii => {
+      :hborder      => '-',
+      :vborder      => '|',
+      :iborder      => %w[+ + + + + + + + +],
+    },
+    :unicode => {
+      :hborder      => '─',
+      :vborder      => '│',
+      :iborder      => %w[┌ ┬ ┐ ├ ┼ ┤ └ ┴ ┘],
+    }
+  }
+
   # @since 0.2.0
   def initialize options = {}
     @rows    = []
@@ -33,6 +47,14 @@ class Tabularize
     @options = DEFAULT_OPTIONS.
                merge(DEFAULT_OPTIONS_GENERATOR).
                merge(options)
+    if @options[:border_style]
+      @options = BORDER_STYLE[@options[:border_style]].merge(@options)
+
+      # Backward-compatibility
+      unless @options[:iborder].is_a?(Array)
+        @options[:iborder] = [@options[:iborder]] * 9
+      end
+    end
     @cache   = {}
   end
 
@@ -66,12 +88,12 @@ class Tabularize
         num_cached_rows = 0
       else
         [@seps[@rows.length] - @cache[:last_seps], 0].max.times do
-          @cache[:string_io].puts @cache[:separator]
+          @cache[:string_io].puts @cache[:separators][1]
         end
         @cache[:last_seps] = @seps[@rows.length]
 
         if num_cached_rows == @rows.length
-          return @cache[:string_io].string + @cache[:separator]
+          return @cache[:string_io].string + @cache[:separators].last
         end
       end
     end
@@ -80,63 +102,73 @@ class Tabularize
 
     h  = @options[:hborder]
     v  = @options[:vborder]
-    i  = @options[:iborder]
     vl = @options[:vborder]
-    il = @options[:iborder]
+    i9 = @options[:iborder]
+    e  = @options[:ellipsis]
+    c  = @options[:border_color] || ''
+    r  = c.empty? ? '' : "\e[0m"
     u  = @options[:unicode]
     a  = @options[:ansi]
     sw = @options[:screen_width]
-    el = Tabularize.cell_width(@options[:ellipsis], u, a)
+    el = Tabularize.cell_width(e, u, a)
 
-    separator = @cache[:separator]
+    separators = @cache[:separators]
     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
-          col_count = idx
-          break
+    separators ||= 
+      Array.new(3) {''}.zip(i9.each_slice(3).to_a).map { |separator, i3|
+        rows[0].each_with_index do |ch, idx|
+          new_sep = separator + i3[idx == 0 ? 0 : 1] + h * Tabularize.cell_width(ch, u, a)
+
+          if sw && Tabularize.cell_width(new_sep, u, a) > sw - el
+            col_count = idx
+            break
+          else
+            separator = new_sep
+          end
+        end
+        separator += col_count ? e : i3.last
+        if c
+          c + separator + r
         else
-          separator = new_sep
+          separator
         end
-      end
-      separator += il
-    end
+      }
 
-    output = @cache[:string_io] || StringIO.new.tap { |io| io.puts separator }
+    output = @cache[:string_io] || StringIO.new.tap { |io| 
+      io.set_encoding 'UTF-8' if io.respond_to? :set_encoding
+      io.puts separators.first
+    }
     if col_count
       rows = rows.map { |line| line[0, col_count] }
-      vl = il = @options[:ellipsis]
+      vl = e
     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 + num_cached_rows].times do
-        output.puts separator
+        output.puts separators[1]
       end
       (0...height).each do |line|
-        output.print v unless row.empty?
+        output.print c + v + r unless row.empty?
         output.puts row.map { |lines|
           lines[line] || @options[:pad] * Tabularize.cell_width(lines[0], u, a)
-        }.join(v) + vl
+        }.join(c + v + r) + c + vl + r
       end
     end
 
     @seps[rows.length + num_cached_rows].times do
-      output.puts separator
+      output.puts separators[1]
     end
 
     @cache = {
-      :analysis  => analysis,
-      :separator => separator,
-      :col_count => col_count,
-      :num_rows  => @rows.length,
-      :string_io => output,
-      :last_seps => @seps[rows.length]
+      :analysis   => analysis,
+      :separators => separators,
+      :col_count  => col_count,
+      :num_rows   => @rows.length,
+      :string_io  => output,
+      :last_seps  => @seps[rows.length]
     }
-    output.string + separator
+    output.string + separators.last
   rescue Exception
     @cache = {}
     raise

data/lib/tabularize/version.rb

@@ -1,3 +1,3 @@
 class Tabularize
-  VERSION = "0.2.5"
+  VERSION = "0.2.7"
 end

data/test/readme.rb

@@ -9,10 +9,11 @@ require 'tabularize'
 
 table = Tabularize.new
 table = Tabularize.new :pad     => '.', :pad_left => 2,  :pad_right => 0,
-                       :hborder => '~', :vborder => 'I', :iborder => '#',
+                       :border_style => :unicode,
+                       :border_color => ANSI::Code.red,
                        :align   => [:left, :center, :right],
                        :valign  => [:top, :bottom, :middle, :middle],
-                       :screen_width => 75, :ellipsis => 'X'
+                       :screen_width => 75, :ellipsis => '~'
 table << %w[Name Dept Location Phone Description]
 table.separator!
 table << ['John Doe', 'Finance', 'Los Angeles CA 90089', '555-1555', 'Just a guy']

data/test/test_tabularize.rb

@@ -118,6 +118,8 @@ class TestTabularize < Test::Unit::TestCase
 
   # TODO: Need assertion
   def test_tabularize_csv
+    return if RUBY_VERSION =~ /^1\.8\./
+
     sio = StringIO.new
 
     {
@@ -141,7 +143,7 @@ class TestTabularize < Test::Unit::TestCase
 
   def test_invalid_arguments
     assert_raise(ArgumentError) { Tabularize.it(5) }
-    assert_raise(ArgumentError) { Tabularize.it("hello") }
+    assert_raise(ArgumentError) { Tabularize.it("hello") } unless RUBY_VERSION =~ /^1\.8\./
     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]) }
@@ -263,7 +265,32 @@ I..This should change everything doh!I.............I............................
       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]) }
+      assert t.to_s.lines.all? { |line| line.chomp.reverse[0, 1] == '>' }
     end
   end
+
+  def test_readme
+    table = Tabularize.new
+    table = Tabularize.new :pad     => '.', :pad_left => 2,  :pad_right => 0,
+                           :border_style => :unicode,
+                           :align   => [:left, :center, :right],
+                           :valign  => [:top, :bottom, :middle, :middle],
+                           :screen_width => 75, :ellipsis => '~'
+    table << %w[Name Dept Location Phone Description]
+    table.separator!
+    table << ['John Doe', 'Finance', 'Los Angeles CA 90089', '555-1555', 'Just a guy']
+    table << ['Average Joe', 'Engineering', 'Somewhere over the rainbow', 'N/A', 'Unknown']
+    table << ['홍길동', '탁상 3부', "서울역 3번 출구 김씨 옆자리\n\n맞습니다", 'N/A', 'No description']
+    assert_equal "
+┌─────────────┬─────────────┬─────────────────────────────┬──────────~
+│..Name.......│.....Dept....│.....................Location│.....Phone~
+├─────────────┼─────────────┼─────────────────────────────┼──────────~
+│..John Doe...│....Finance..│.........Los Angeles CA 90089│..555-1555~
+│..Average Joe│..Engineering│...Somewhere over the rainbow│.......N/A~
+│..홍길동.....│.............│..서울역 3번 출구 김씨 옆자리│..........~
+│.............│.............│.............................│.......N/A~
+│.............│...탁상 3부..│.....................맞습니다│..........~
+└─────────────┴─────────────┴─────────────────────────────┴──────────~
+".strip, table.to_s
+  end
 end

metadata

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