tabularize 0.2.1 → 0.2.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.2.2
+-----
+- `screen_width` and `ellipsis` options to cut off trailing cells exceeding specified screen width
+
 0.2.1
 -----
 - Multi-line support

data/Gemfile.lock

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

data/README.md

@@ -52,30 +52,34 @@ puts table
 * 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
+* Ellipses: Cut off trailing cells if the total width exceeds the specified screen width
+ * `:screen_width` The number of columns for the current terminal. Default: unlimited.
+ * `:ellipsis` Ellipsis string when cells are cut off. Default: `>`
 
 ```ruby
 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]
+                       :valign  => [:top, :bottom, :middle, :middle],
+                       :screen_width => 75, :ellipsis => 'X'
+table << %w[Name Dept Location Phone Description]
 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\n맞습니다", 'N/A']
+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']
 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.............I..서울역 3번 출구 김씨 옆자리I..........I
-I.............I.............I.............................I.......N/AI
-I.............I...탁상 3부..I.....................맞습니다I..........I
-#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~#
+#~~~~~~~~~~~~~#~~~~~~~~~~~~~#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#~~~~~~~~~~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
 ```
 
 Tabularize.it
@@ -167,7 +171,7 @@ Average Joe  | Engineering | Somewhere over the rainbow |   N/A
 Hong Gildong |     HR      |          Nowhere           | 555-5555
 ```
 
-#### Padding with other characters
+#### Padding with characters other than space
 
 ```ruby
 puts Tabularize.it(data, :pad => '_').map { |row| row.join ' | ' }
@@ -178,13 +182,13 @@ 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
+홍길동______ | 탁상 3부___ | 서울역 3번 출구 김씨 옆자리 | N/A_____
 ```
 
 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
+However, if your data doesn't have any of them, unset `:unicode` and `:ansi` in options hash,
 so that [tabularize](https://github.com/junegunn/tabularize) can process data more efficiently.
 
 ```ruby
@@ -198,9 +202,10 @@ when I blindly started building [tabularize](https://github.com/junegunn/tabular
 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:
+There are a few things, however, [tabularize](https://github.com/junegunn/tabularize) does better:
 - 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
 
 Copyright
 ---------

data/lib/tabularize.rb

@@ -16,6 +16,9 @@ class Tabularize
 
     :unicode   => true,
     :ansi      => true,
+
+    :ellipsis     => '>',
+    :screen_width => nil,
   }
 
   DEFAULT_OPTIONS_GENERATOR = {
@@ -51,15 +54,29 @@ class Tabularize
     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
+    h  = @options[:hborder]
+    v  = @options[:vborder]
+    i  = @options[:iborder]
+    vl = @options[:vborder]
+    il = @options[:iborder]
+    u  = @options[:unicode]
+    a  = @options[:ansi]
+    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)
+
+      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
+      end
+    end
+    separator += il
 
     output = StringIO.new
     output.puts separator
@@ -70,9 +87,10 @@ class Tabularize
         output.puts separator
       end
       (0...height).each do |line|
-        output.puts v + row.map { |lines|
+        output.print v unless row.empty?
+        output.puts row.map { |lines|
           lines[line] || @options[:pad] * Tabularize.cell_width(lines[0], u, a)
-        }.join(v) + v
+        }.join(v) + vl
       end
     end
 
@@ -113,15 +131,16 @@ class Tabularize
     valign  = [*options[:valign]]
     unicode = options[:unicode]
     ansi    = options[:ansi]
+    screenw = options[:screen_width]
 
     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")
+      raise ArgumentError.new(":pad_left must be a non-negative integer")
     end
     unless padr.is_a?(Fixnum) && padr >= 0
-      raise ArgumentError.new(":pad_right must be a non-negative Fixnum")
+      raise ArgumentError.new(":pad_right must be a non-negative integer")
     end
     unless align.all? { |a| [:left, :right, :center].include?(a) }
       raise ArgumentError.new("Invalid alignment")
@@ -129,6 +148,9 @@ class Tabularize
     unless valign.all? { |a| [:top, :bottom, :middle].include?(a) }
       raise ArgumentError.new("Invalid vertical alignment")
     end
+    unless screenw.nil? || (screenw.is_a?(Fixnum) && screenw > 0)
+      raise ArgumentError.new(":screen_width must be a positive integer")
+    end
 
     rows        = []
     max_widths  = []

data/lib/tabularize/version.rb

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

data/test/readme.rb

@@ -11,10 +11,11 @@ table = Tabularize.new
 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]
+                       :valign  => [:top, :bottom, :middle, :middle],
+                       :screen_width => 75, :ellipsis => 'X'
+table << %w[Name Dept Location Phone Description]
 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\n맞습니다", 'N/A']
+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']
 puts table

data/test/test_tabularize.rb

@@ -140,6 +140,7 @@ class TestTabularize < Test::Unit::TestCase
     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 => '') }
+    assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :screen_width => -2) }
   end
 
   def test_table
@@ -192,4 +193,15 @@ I.............I...탁상 3부..I.....................맞습니다I..........I
     table.separator!
     assert_equal output, table.to_s.strip
   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
+      end
+      puts t
+      assert t.to_s.lines.all? { |line| line.chomp.length <= w }
+    end
+  end
 end

metadata

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