columnize 0.2.1 → 0.3.0

data/ChangeLog

@@ -1,3 +1,16 @@
+2009-01-08 09:27  rockyb
+
+	* ChangeLog, NEWS, VERSION, lib/columnize.rb,
+	  test/test-columnize.rb: Fix bad bug in arranging horizontally
+
+2009-01-01 04:15  rockyb
+
+	* NEWS: Merge NEWS
+
+2009-01-01 03:59  rockyb
+
+	* NEWS, VERSION: Ooops 0.2 release done. Go for 0.2.1
+
 2009-01-01 03:55  rockyb
 
 	* ChangeLog: Get ready for release 0.2

data/NEWS

@@ -1,12 +1,18 @@
-0.2.1
-12-31-08
-Add ability to run columns horizontally
+0.3.0  (01-10-09) - Sam Woodward Release
+
+- Fix bad bug in arranging horizontally
+
+0.2.1 (12-31-08)
+
+- Add ability to run columns horizontally
 
 0.2
+
 - Minor - get rid of hacky $0 test
 
 0.1
+
 - Initial release of Columnize, a module to print an Array in
   column-sorted order
 
-$Id: NEWS 155 2009-01-01 04:15:10Z rockyb $
+$Id: NEWS 160 2009-01-10 19:02:28Z rockyb $

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/columnize.rb

@@ -1,6 +1,6 @@
-# $Id: columnize.rb 150 2009-01-01 03:52:54Z rockyb $
+# $Id: columnize.rb 159 2009-01-08 09:27:51Z rockyb $
 # 
-#   Copyright (C) 2007, 2008 Rocky Bernstein <rockyb@rubyforge.net>
+#   Copyright (C) 2007, 2008, 2009 Rocky Bernstein <rockyb@rubyforge.net>
 #
 #    This program is free software; you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -37,15 +37,26 @@
 
 module Columnize
 
-  # Return a string with embedded newlines (\n) arranging +list+ in
-  # column-order so that each line is no larger than +displaywidth+.
-  # If +list+ is not an array, the empty string, '', is returned.
-  # +colsep+ contains the string to use to separate entries. Normally,
-  # consecutive items go down from the top to bottom from the
-  # left-most column to the right-most. If +arrange_vertical+ is set
-  # false, consecutive items will go across, left to right, top to
-  # bottom.
-  def columnize(list, displaywidth=80, colsep = '  ', arrange_vertical=true)
+  # Return a list of strings with embeeded newlines (\n) as a compact
+  # set of columns arranged horizontally or vertically.
+  #
+  # For example, for a line width of 4 characters (arranged vertically):
+  #     ['1', '2,', '3', '4'] => '1  3\n2  4\n'
+   
+  # or arranged horizontally:
+  #     ['1', '2,', '3', '4'] => '1  2\n3  4\n'
+  #     
+  # Each column is only as wide possible, no larger than
+  # +displaywidth'.  If +list+ is not an array, the empty string, '',
+  # is returned. By default, columns are separated by two spaces - one
+  # was not legible enough. Set +colsep+ to adjust the string separate
+  # columns. If +arrange_vertical+ is set false, consecutive items
+  # will go across, left to right, top to bottom.
+
+  def columnize(list, displaywidth=80, colsep = '  ', 
+                arrange_vertical=true, ljust=true)
+
+    # Some degenerate cases
     if not list.is_a?(Array)
       return ''
     end
@@ -56,83 +67,154 @@ module Columnize
     if 1 == l.size
       return "#{l[0]}\n"
     end
-    # Consider arranging list in 1 rows total, then 2 rows...
-    # Stop when at the smallest number of rows which
-    # can be arranged less than the display width.
-    nrows = 0; ncols = l.size
-    
+
+    nrows = ncols = 0  # Make nrows, ncols have more global scope
+    colwidths = []     # Same for colwidths
     if arrange_vertical
       array_index = lambda {|nrows, row, col| nrows*col + row }
-    else
-      array_index = lambda {|nrows, row, col| nrows*row + col }
-    end
+      # Try every row count from 1 upwards
+      1.upto(l.size-1) do |nrows|
+        ncols = (l.size + nrows-1) / nrows
+        colwidths = []
+        totwidth = -colsep.length
 
-    colwidths = []
-    1.upto(l.size) do 
-      colwidths = []
-      nrows += 1
-      totwidth = -colsep.length
-      col = 0
-      0.upto(ncols-1) do |col|
-        # get max column width for this column
-        colwidth = 0
-        0.upto(nrows-1) do |row|
-          i = array_index.call(nrows, row, col)
-          if i >= l.size
+        0.upto(ncols-1) do |col|
+          # get max column width for this column
+          colwidth = 0
+          0.upto(nrows-1) do |row|
+            i = array_index.call(nrows, row, col)
+            if i >= l.size
+              break
+            end
+            colwidth = [colwidth, l[i].size].max
+          end
+          colwidths << colwidth
+          totwidth += colwidth + colsep.length
+          if totwidth > displaywidth
+            ncols = col
             break
           end
-          colwidth = [colwidth, l[i].size].max
         end
-        colwidths << colwidth
-        totwidth += colwidth + colsep.length
-        if totwidth > displaywidth
-          ncols = col
+        if totwidth <= displaywidth
           break
         end
       end
-      if totwidth <= displaywidth
-        break
+      # The smallest number of rows computed and the
+      # max widths for each column has been obtained.
+      # Now we just have to format each of the
+      # rows.
+      s = ''
+      0.upto(nrows-1) do |row| 
+        texts = []
+        0.upto(ncols-1) do |col|
+          i = array_index.call(nrows, row, col)
+          if i >= l.size
+            x = ""
+          else
+            x = l[i]
+          end
+          texts << x
+        end
+        while texts and texts[-1] == ''
+          texts = texts[0..-2]
+        end
+        if texts.size > 0
+          0.upto(texts.size-1) do |col|
+            if ljust
+                texts[col] = texts[col].ljust(colwidths[col])
+            else
+                texts[col] = texts[col].rjust(colwidths[col])
+            end
+          end
+          s += "%s\n" % texts.join(colsep)
+        end
       end
-    end
-    # The smallest number of rows computed and the
-    # max widths for each column has been obtained.
-    # Now we just have to format each of the
-    # rows.
-    s = ''
-    0.upto(nrows-1) do |row| 
-      texts = []
-      0.upto(ncols-1) do |col|
-        i = array_index.call(nrows, row, col)
-        if i >= l.size
-          if arrange_vertical:
-              x = ""
-          else 
+      return s
+    else
+      array_index = lambda {|nrows, row, col| ncols*(row-1) + col }
+      # Try every column count from size downwards
+      # Assign to make enlarge scope of loop variables 
+      totwidth = i = rounded_size = 0  
+      l.size.downto(0) do |ncols|
+        # Try every row count from 1 upwards
+        min_rows = (l.size+ncols-1) / ncols
+        min_rows.upto(l.size) do |nrows|
+          rounded_size = nrows * ncols
+          colwidths = []
+          totwidth = -colsep.length
+          colwidth = row = 0
+          0.upto(ncols-1) do |col|
+            # get max column width for this column
+            1.upto(nrows) do |row|
+              i = array_index.call(nrows, row, col)
+              if i >= rounded_size 
+                break
+              elsif i < l.size
+                colwidth = [colwidth, l[i].size].max
+              end
+            end
+            colwidths << colwidth
+            totwidth += colwidth + colsep.length
+            if totwidth > displaywidth
+              break
+            end
+          end
+          if totwidth <= displaywidth
+            # Found the right nrows and ncols
+            nrows  = row
+            break
+          elsif totwidth >= displaywidth
+            # Need to reduce ncols
             break
           end
-        else
-          x = l[i]
         end
-        texts << x
-      end
-      while texts and texts[-1] == ''
-        texts = texts[0..-2]
+        if totwidth <= displaywidth and i >= rounded_size-1
+            break
+        end
       end
-      if texts.size > 0
+      # The smallest number of rows computed and the
+      # max widths for each column has been obtained.
+      # Now we just have to format each of the
+      # rows.
+      s = ''
+      1.upto(nrows) do |row| 
+        texts = []
+        0.upto(ncols-1) do |col|
+          i = array_index.call(nrows, row, col)
+          if i >= l.size
+            break
+          else
+            x = l[i]
+          end
+          texts << x
+        end
         0.upto(texts.size-1) do |col|
-          texts[col] = texts[col].ljust(colwidths[col]) if 
-            colwidths[col]
+          if ljust
+            texts[col] = texts[col].ljust(colwidths[col])
+          else
+            texts[col] = texts[col].rjust(colwidths[col])
+          end
         end
         s += "%s\n" % texts.join(colsep)
       end
+      return s
     end
-    return s
   end
   module_function :columnize
 end
 if __FILE__ == $0
   #
-  puts Columnize::columnize(5)
   include Columnize
+  
+  [[4, 4], [4, 7], [100, 80]].each do |width, num|
+    data = (1..num).map{|i| i.to_s}
+    [[false, 'horizontal'], [true, 'vertical']].each do |bool, dir|
+      puts "Width: #{width}, direction: #{dir}"
+      print columnize(data, width, '  ', arrange_vertical=bool)
+      end
+  end
+
+  puts Columnize::columnize(5)
   puts columnize([])
   puts columnize(["a", 2, "c"], 10, ', ')
   puts columnize(["oneitem"])

data/test/test-columnize.rb

@@ -19,7 +19,30 @@ class TestColumnize < Test::Unit::TestCase
     assert_equal("1  2\n3  4\n", 
                  columnize(['1', '2', '3', '4'], 4, '  ', false))
     assert_equal("<empty>\n", columnize([]))
+    
+    
     assert_equal("oneitem\n", columnize(["oneitem"]))
+    
+    data = (0..54).map{|i| i.to_s}
+    assert_equal(
+            "0,  6, 12, 18, 24, 30, 36, 42, 48, 54\n" + 
+            "1,  7, 13, 19, 25, 31, 37, 43, 49\n" +
+            "2,  8, 14, 20, 26, 32, 38, 44, 50\n" +
+            "3,  9, 15, 21, 27, 33, 39, 45, 51\n" +
+            "4, 10, 16, 22, 28, 34, 40, 46, 52\n" +
+            "5, 11, 17, 23, 29, 35, 41, 47, 53\n",
+            columnize(data, 39, ', ', true, false))
+
+    assert_equal(
+            " 0,  1,  2,  3,  4,  5,  6,  7,  8,  9\n" +
+            "10, 11, 12, 13, 14, 15, 16, 17, 18, 19\n" +
+            "20, 21, 22, 23, 24, 25, 26, 27, 28, 29\n" +
+            "30, 31, 32, 33, 34, 35, 36, 37, 38, 39\n" +
+            "40, 41, 42, 43, 44, 45, 46, 47, 48, 49\n" +
+            "50, 51, 52, 53, 54\n",
+            columnize(data, 39, ', ', false, false))
+
+
     data = ["one",       "two",         "three",
             "for",       "five",        "six",
             "seven",     "eight",       "nine",
@@ -31,11 +54,11 @@ class TestColumnize < Test::Unit::TestCase
             "twentyfive","twentysix",   "twentyseven"]
 
      assert_equal(
- "one         two        three        for        five         six       \n" +
- "seven       eight      nine         ten        eleven       twelve    \n" +
- "thirteen    fourteen   fifteen      sixteen    seventeen    eightteen \n" +
- "nineteen    twenty     twentyone    twentytwo  twentythree  twentyfour\n" +
- "twentyfive  twentysix  twentyseven\n", columnize(data, 80, '  ', false))
+"one         two         three        for          five         six        \n" +
+"seven       eight       nine         ten          eleven       twelve     \n" +
+"thirteen    fourteen    fifteen      sixteen      seventeen    eightteen  \n" +
+"nineteen    twenty      twentyone    twentytwo    twentythree  twentyfour \n" +
+"twentyfive  twentysix   twentyseven\n", columnize(data, 80, '  ', false))
 
     assert_equal(
 "one    five   nine    thirteen  seventeen  twentyone    twentyfive \n" +

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: columnize
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2008-12-31 00:00:00 -05:00
+  version: 0.3.0
+date: 2009-01-10 00:00:00 -05:00
 summary: Read file with caching
 require_paths: 
 - lib