tabularize 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.0
+-----
+- Tabularize::Table class for easy tabularization (doh!)
+- Correctly handles ANSI codes
+
 0.1.1
 -----
 - :unicode_display option added for CJK wide characters.

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    tabularize (0.1.1)
+    tabularize (0.2.0)
       unicode-display_width (~> 0.1.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    ansi (1.4.3)
     awesome_print (1.0.2)
     unicode-display_width (0.1.1)
 
@@ -15,5 +16,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  ansi
   awesome_print
   tabularize!

data/README.md

@@ -2,6 +2,7 @@ tabularize
 ==========
 
 Formatting tabular data with paddings.
+`tabularize` correctly handles CJK wide characters and ANSI codes.
 
 Inspired by tabular.vim (https://github.com/godlygeek/tabular)
 
@@ -12,10 +13,75 @@ Installation
 gem install tabularize
 ```
 
-Basic usage
------------
+Table generator
+---------------
 
-### Formatting CSV data
+```ruby
+require 'tabularize'
+
+table = Tabularize.new
+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']
+puts table
+```
+
+```
++-------------+-------------+-----------------------------+----------+
+| Name        | Dept        | Location                    | Phone    |
++-------------+-------------+-----------------------------+----------+
+| John Doe    | Finance     | Los Angeles CA 90089        | 555-1555 |
+| Average Joe | Engineering | Somewhere over the rainbow  | N/A      |
+| 홍길동      | 탁상 3부    | 서울역 3번 출구 김씨 옆자리 | N/A      |
++-------------+-------------+-----------------------------+----------+
+```
+
+### With options: Padding, border and alignment
+
+* Padding
+ * `:pad` Padding character
+ * `:pad_left` Size of left padding
+ * `:pad_right` Size of right padding
+* Border
+ * `:hborder` Character for horizontal border
+ * `:vborder` Character for vertical border
+ * `:iborder` Character for intersection point
+* Alignment
+ * `:align` Cell alignment. `:left`, `:center`, `:right`, or Array of the three options
+
+```ruby
+table = Tabularize.new :pad => '.', :pad_left => 2, :pad_right => 0,
+                       :hborder => '~', :vborder => 'I', :iborder => '#',
+                       :align => [:left, :center, :right]
+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']
+puts table
+```
+
+```
+#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+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
+#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+```
+
+Tabularize.it
+-------------
+`Tabularize` table generator is built on top of low-level `Tabularize.it` class method.
+(actually it was the only method provided in the earlier versions prior to 0.2.0)
+
+It simply returns two-dimensional array of padded and aligned Strings,
+so the rest of the formatting is pretty much up to you.
+
+### Example: formatting CSV data
 
 #### Sample data in CSV
 
@@ -24,6 +90,7 @@ 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
 ```
 
 #### Tabularize.it
@@ -80,7 +147,7 @@ ap Tabularize.it(data).map { |row| row.join ' | ' }
 ```ruby
 puts Tabularize.it(data, :align => :right).map { |row| row.join ' | ' }
 puts
-puts Tabularize.it(data, :align => :center).map { |row| row.join ' | ' }
+puts Tabularize.it(data, :align => [:left, :center]).map { |row| row.join ' | ' }
 ```
 
 ```
@@ -89,8 +156,8 @@ puts Tabularize.it(data, :align => :center).map { |row| row.join ' | ' }
  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
+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
 ```
@@ -106,20 +173,17 @@ 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
 ```
 
-#### CJK wide characters
+ANSI codes and CJK wide characters
+----------------------------------
+`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.
 
 ```ruby
-puts Tabularize.it(data, :unicode_display => true).map { |row| row.join ' | ' }
-```
-
-```
-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
+table = Tabularize.new :unicode => false, :ansi => false
 ```
 
 Copyright

data/lib/tabularize.rb

@@ -1,12 +1,88 @@
 require "tabularize/version"
+require 'stringio'
+require 'unicode/display_width'
 
-module Tabularize
+class Tabularize
   DEFAULT_OPTIONS = {
-    :pad => ' ',
-    :align => :left,
-    :unicode_display => false
+    :align     => :left,
+    :pad       => ' ',
+    :pad_left  => 0,
+    :pad_right => 0,
+
+    :hborder   => '-',
+    :vborder   => '|',
+    :iborder   => '+',
+
+    :unicode   => true,
+    :ansi      => true,
+  }
+
+  DEFAULT_OPTIONS_GENERATOR = {
+    :pad_left  => 1,
+    :pad_right => 1,
   }
 
+  # @since 0.2.0
+  def initialize options = {}
+    @rows    = []
+    @seps    = Hash.new { |h, k| h[k] = 0 }
+    @options = DEFAULT_OPTIONS.
+               merge(DEFAULT_OPTIONS_GENERATOR).
+               merge(options)
+  end
+
+  # @since 0.2.0
+  def separator!
+    @seps[@rows.length] += 1
+    nil
+  end
+  
+  # @param [Array] row
+  # @since 0.2.0
+  def << row
+    @rows << row
+    nil
+  end
+
+  # @return [String]
+  # @since 0.2.0
+  def to_s
+    rows = Tabularize.it(@rows, @options)
+    return nil if rows.empty?
+
+    h = @options[:hborder]
+    v = @options[:vborder]
+    i = @options[:iborder]
+    u = @options[:unicode]
+    a = @options[:ansi]
+
+    separator = i + rows[0].map { |c|
+      h * Tabularize.cell_width(c, u, a)
+    }.join( i ) + i
+
+    output = StringIO.new
+    output.puts separator
+    rows.each_with_index do |row, idx|
+      @seps[idx].times do
+        output.puts separator
+      end
+      output.puts v + row.join(v) + v
+    end
+    output.puts separator
+    output.string
+  end
+
+  # Returns the display width of a String
+  # @param [String] str Input String
+  # @param [Boolean] unicode Set to true when the given String can include CJK wide characters
+  # @param [Boolean] ansi Set to true When the given String can include ANSI codes
+  # @return [Fixnum] Display width of the given String
+  # @since 0.2.0
+  def self.cell_width str, unicode, ansi
+    str = str.gsub(/\e\[\d*(?:;\d+)*m/, '') if ansi
+    str.send(unicode ? :display_width : :length)
+  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.
@@ -19,19 +95,24 @@ module Tabularize
 
     options = DEFAULT_OPTIONS.merge(options)
     pad     = options[:pad].to_s
-    align   = options[:align]
-    unicode = options[:unicode_display]
-    raise ArgumentError.new("Invalid padding") unless pad.length == 1
-    raise ArgumentError.new("Invalid alignment") unless
-        [:left, :right, :center].include?(align)
-
-    l = 
-      if unicode
-        require 'unicode/display_width'
-        :display_width
-      else
-        :length
-      end
+    padl    = options[:pad_left]
+    padr    = options[:pad_right]
+    align   = [options[:align]].flatten
+    unicode = options[:unicode]
+    ansi    = options[:ansi]
+
+    unless pad.length == 1
+      raise ArgumentError.new("Invalid padding") 
+    end
+    unless padl.is_a?(Fixnum) && padl >= 0
+      raise ArgumentError.new(":pad_left must be a non-negative Fixnum")
+    end
+    unless padr.is_a?(Fixnum) && padr >= 0
+      raise ArgumentError.new(":pad_right must be a non-negative Fixnum")
+    end
+    unless align.all? { |a| [:left, :right, :center].include?(a) }
+      raise ArgumentError.new("Invalid alignment")
+    end
 
     rows       = []
     max_widths = []
@@ -39,26 +120,35 @@ module Tabularize
       rows << row = [*row].map(&:to_s).map(&:chomp)
 
       row.each_with_index do |cell, idx|
-        max_widths[idx] = [ cell.send(l), max_widths[idx] || 0 ].max
+        max_widths[idx] = [ Tabularize.cell_width(cell, unicode, ansi), max_widths[idx] || 0 ].max
       end
     end
 
     rows.map { |row| 
       idx = -1
       row.map { |str|
+        alen = 
+          if ansi
+            Tabularize.cell_width(str, false, false) -
+              Tabularize.cell_width(str, false, true)
+          else
+            0
+          end
+        slen = str.length - alen
+
         idx += 1
         w = max_widths[idx]
-        if unicode
-          w += str.length - str.display_width
-        end
-        case align
-        when :left
-          str.ljust(w, pad)
-        when :right
-          str.rjust(w, pad)
-        when :center
-          str.rjust((w - str.length) / 2 + str.length, pad).ljust(w, pad)
-        end
+        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
       }
     }
   end

data/lib/tabularize/version.rb

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

data/tabularize.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "awesome_print"
+  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'ansi'
   s.add_runtime_dependency 'unicode-display_width', '~> 0.1.1'
 end

data/test/readme.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'rubygems'
+require 'ansi'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tabularize'
+
+table = Tabularize.new
+table = Tabularize.new :pad => '.', :pad_left => 2, :pad_right => 0,
+                       :hborder => '~', :vborder => 'I', :iborder => '#',
+                       :align => [:left, :center, :right]
+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']
+puts table

data/test/test_tabularize.rb

@@ -6,6 +6,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'tabularize'
 require 'awesome_print'
 require 'csv'
+require 'ansi'
 
 class TestTabularize < Test::Unit::TestCase
   DATA0 = %w[a aa aaa aaaa aaaaa]
@@ -104,21 +105,24 @@ class TestTabularize < Test::Unit::TestCase
   # TODO: Need assertion
   def test_tabularize_csv
     {
-      'test.csv' => false,
-      'test_unicode.csv' => true
-    }.each do |file, unicode|
+      'test.csv' => [false, false],
+      'test_unicode.csv' => [true, false],
+      '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, :unicode_display => unicode).map { |row| row.join ' | ' }
+      output = Tabularize.it(data, opts).map { |row| row.join '|' }
       ap output
       puts
       puts output
 
-      puts Tabularize.it(data, :align => :right, :unicode_display => unicode).map { |row| row.join ' | ' }
+      puts Tabularize.it(data, opts.merge(:align => :right)).map { |row| row.join '|' }
       puts
-      puts Tabularize.it(data, :align => :center, :unicode_display => unicode).map { |row| row.join ' | ' }
+      puts Tabularize.it(data, opts.merge(:align => :center)).map { |row| row.join '|' }
       puts
-      puts Tabularize.it(data, :pad => '_', :unicode_display => unicode).map { |row| row.join ' | ' }
+      puts Tabularize.it(data, opts.merge(:pad => '_')).map { |row| row.join '|' }
 
     end
   end
@@ -127,6 +131,27 @@ 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], :align => [:center, :top]) }
     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 => '') }
+    assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :pad => ' ', :pad_right => -1) }
+    assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :pad => ' ', :pad_right => '') }
+  end
+
+  def test_table
+    table = Tabularize.new :align => :center, :pad => ',',
+      :pad_left => 3, :pad_right => 5, :hborder => '=', :vborder => 'I', :iborder => '#'
+    table << DATA2[0]
+    table.separator!
+    table << DATA2[0]
+    table.separator!
+    table.separator!
+    table << DATA2[1]
+    table.separator!
+    table << DATA2[2]
+    table << DATA2[3]
+
+    puts table.to_s
   end
 end

data/test/test_unicode_ansi.csv

@@ -0,0 +1,5 @@
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tabularize
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
@@ -60,9 +76,11 @@ files:
 - lib/tabularize.rb
 - lib/tabularize/version.rb
 - tabularize.gemspec
+- test/readme.rb
 - test/test.csv
 - test/test_tabularize.rb
 - test/test_unicode.csv
+- test/test_unicode_ansi.csv
 homepage: ''
 licenses: []
 post_install_message: 
@@ -83,12 +101,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: tabularize
-rubygems_version: 1.8.18
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Formatting tabular data
 test_files:
+- test/readme.rb
 - test/test.csv
 - test/test_tabularize.rb
 - test/test_unicode.csv
-has_rdoc: 
+- test/test_unicode_ansi.csv