columnize 0.3.4 → 0.3.5

data/Makefile

@@ -1,8 +1,11 @@
 # I'll admit it -- I'm an absent-minded old-timer who has trouble
 # learning new tricks.
 test: check
+
+#: Same as "make check"
 all: check
 	true
 
+#: Same as corresponding rake task
 %: 
 	rake $@

data/NEWS

@@ -1,3 +1,6 @@
+0.3.5 Nov 24, 2011 
+- Handle situation where an array element is larger than the display width.
+
 0.3.4 July 4, 2011 
 
 - Change to Ruby License

data/README.md

@@ -0,0 +1,84 @@
+Columnize - Format an Array as a Column-aligned String
+============================================================================
+
+In showing a long lists, sometimes one would prefer to see the value
+arranged aligned in columns. Some examples include listing methods of
+an object, listing debugger commands, or showing a numeric array with data
+aligned.
+
+Setup
+-----
+
+    $ irb
+    >> a = (1..10).to_a
+    => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+    >> require 'columnize'
+    => true
+    >> include Columnize
+    => Object
+    >> g = %w(bibrons golden madascar leopard mourning suras tokay)
+    => ["bibrons", "golden", "madascar", "leopard", "mourning", "suras", "tokay"]
+
+With numeric data
+-----------------
+
+    columnize(a) 
+    => "1  2  3  4  5  6  7  8  9  10\n"
+    >> puts Columnize::columnize(a, :arrange_array => true, :displaywidth => 10)
+    [1,  2
+     3,  4
+     5,  6
+     7,  8
+     9, 10
+    ]
+    => nil
+    >> puts Columnize::columnize(a, :arrange_array => true, :displaywidth => 20)
+    [1, 2, 3,  4,  5,  6
+     7, 8, 9, 10
+    ]
+
+With String data
+----------------
+
+    >> puts columnize g, :displaywidth => 15
+    bibrons   suras
+    golden    tokay
+    madascar
+    leopard 
+    mourning
+    => nil
+
+    >> puts columnize g, {:displaywidth => 19, :colsep => ' | '}
+    bibrons  | suras
+    golden   | tokay
+    madascar
+    leopard 
+    mourning
+    => nil
+
+    >> puts columnize g, {:displaywidth => 18, :colsep => ' | ', :ljust=>false}
+
+    bibrons  | mourning
+    golden   | suras   
+    madascar | tokay   
+    leopard 
+
+Credits
+-------
+
+This is adapted from a method of the same name from Python's cmd module.
+
+Other stuff
+-----------
+
+Author:   Rocky Bernstein <rockyb@rubyforge.org>
+
+License:  Copyright (c) 2011 Rocky Bernstein
+
+Warranty
+--------
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.

data/columnize.gemspec

@@ -42,10 +42,10 @@ require "columnize"
   spec.summary      = 'Module to format an Array as an Array of String aligned in columns'
   spec.version      = Columnize::VERSION
   spec.has_rdoc     = true
-  spec.extra_rdoc_files = %w(README lib/columnize.rb COPYING)
+  spec.extra_rdoc_files = %w(README.md lib/columnize.rb COPYING)
 
   # Make the readme file the start page for the generated html
-  spec.rdoc_options += %w(--verbose --main README)
+  spec.rdoc_options += %w(--main README)
   spec.rdoc_options += ['--title', "Columnize #{Columnize::VERSION} Documentation"]
 
 end

data/lib/columnize.rb

@@ -1,7 +1,5 @@
 # Module to format an Array as an Array of String aligned in columns.
 #
-# :main:README.md
-#
 # == Summary
 # Display a list of strings as a compact set of columns.
 #
@@ -36,7 +34,7 @@ module Columnize
   DEFAULT_OPTS = {
     :arrange_array     => false,
     :arrange_vertical  => true,
-    :array_prefix      => false,
+    :array_prefix      => '',
     :array_suffix      => '',
     :colsep            => '  ',
     :displaywidth      => 80,
@@ -115,22 +113,21 @@ module Columnize
   def columnize(*args)
 
     list, opts = parse_columnize_options(args)
+
     # Some degenerate cases
-    if not list.is_a?(Array)
-      return ''
-    end
-    if list.size == 0
-      return  "<empty>\n"
-    end
+    return '' if not list.is_a?(Array)
+    return  "<empty>\n" if list.empty?
     l = list.map{|li| li.to_s}
-    if 1 == l.size
-      return "#{l[0]}\n"
-    end
+    return "%s%s%s\n" % [opts[:array_prefix], l[0], 
+                         opts[:array_suffix]] if 1 == l.size
 
     nrows = ncols = 0  # Make nrows, ncols have more global scope
     colwidths = []     # Same for colwidths
-    opts[:displaywidth] = [4, 
-                           opts[:displaywidth] - opts[:lineprefix].length].max
+    if opts[:displaywidth] - opts[:lineprefix].length < 4
+      opts[:displaywidth] = opts[:lineprefix].length + 4
+    else
+      opts[:displaywidth] -= opts[:lineprefix].length
+    end
     if opts[:arrange_vertical]
       array_index = lambda {|num_rows, row, col| num_rows*col + row }
       # Try every row count from 1 upwards
@@ -140,57 +137,51 @@ module Columnize
         colwidths = []
         totwidth = -opts[:colsep].length
 
-        0.upto(ncols-1) do |_col|
-          col = _col
+        0.upto(ncols-1) do |col|
           # get max column width for this column
           colwidth = 0
           0.upto(nrows-1) do |_row|
             row = _row
             i = array_index.call(nrows, row, col)
-            if i >= l.size
-              break
-            end
+            break if i >= l.size
             colwidth = [colwidth, cell_size(l[i], opts[:term_adjust])].max
           end
-          colwidths << colwidth
+          colwidths.push(colwidth)
           totwidth += colwidth + opts[:colsep].length
           if totwidth > opts[:displaywidth]
             ncols = col
             break
           end
         end
-        if totwidth <= opts[:displaywidth]
-          break
-        end
+        break if totwidth <= opts[:displaywidth]
       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.
+      ncols = 1 if ncols < 1
+      nrows = l.size if ncols == 1
+      # 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| 
         row = _row
         texts = []
-        0.upto(ncols-1) do |_col|
-          col = _col
+        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]
+          texts.push(x)
         end
+        texts.pop while !texts.empty? and texts[-1] == ''
         if texts.size > 0
-          0.upto(texts.size-1) do |_col|
-            col = _col
-            if opts[:ljust]
+          0.upto(texts.size-1) do |col|
+            unless ncols == 1 && opts[:ljust]
+              if opts[:ljust]
                 texts[col] = texts[col].ljust(colwidths[col])
-            else
+              else
                 texts[col] = texts[col].rjust(colwidths[col])
+              end
             end
           end
           s += "%s%s\n" % [opts[:lineprefix], texts.join(opts[:colsep])]
@@ -199,10 +190,10 @@ module Columnize
       return s
     else
       array_index = lambda {|num_rows, row, col| ncols*(row-1) + col }
-      # Try every column count from size downwards
-      # Assign to make enlarge scope of loop variables 
+      # Assign to make enlarge scope of loop variables.
       totwidth = i = rounded_size = 0  
-      l.size.downto(0) do |_ncols|
+      # Try every column count from size downwards.
+      l.size.downto(1) do |_ncols|
         ncols = _ncols
         # Try every row count from 1 upwards
         min_rows = (l.size+ncols-1) / ncols
@@ -212,23 +203,17 @@ module Columnize
           colwidths = []
           totwidth = -opts[:colsep].length
           colwidth = row = 0
-          0.upto(ncols-1) do |_col|
-            col = _col
+          0.upto(ncols-1) do |col|
             # get max column width for this column
             1.upto(nrows) do |_row|
               row = _row
               i = array_index.call(nrows, row, col)
-              if i >= rounded_size 
-                break
-              elsif i < l.size
-                colwidth = [colwidth, cell_size(l[i], opts[:term_adjust])].max
-              end
+              break if i >= l.size
+              colwidth = [colwidth, cell_size(l[i], opts[:term_adjust])].max
             end
-            colwidths << colwidth
+            colwidths.push(colwidth)
             totwidth += colwidth + opts[:colsep].length
-            if totwidth > opts[:displaywidth]
-              break
-            end
+            break if totwidth > opts[:displaywidth];
           end
           if totwidth <= opts[:displaywidth]
             # Found the right nrows and ncols
@@ -239,16 +224,19 @@ module Columnize
             break
           end
         end
-        if totwidth <= opts[:displaywidth] and i >= rounded_size-1
-            break
-        end
+        break if totwidth <= opts[:displaywidth] and i >= rounded_size-1
       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.
+      ncols = 1 if ncols < 1
+      nrows = l.size if ncols == 1
+      # 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 = ''
-      prefix = opts[:array_prefix] || opts[:lineprefix]
+      prefix = if opts[:array_prefix].empty?
+                 opts[:lineprefix] 
+               else 
+                 opts[:array_prefix]
+               end
       1.upto(nrows) do |row| 
         texts = []
         0.upto(ncols-1) do |col|
@@ -258,13 +246,15 @@ module Columnize
           else
             x = l[i]
           end
-          texts << x
+          texts.push(x)
         end
         0.upto(texts.size-1) do |col|
-          if opts[:ljust]
-            texts[col] = texts[col].ljust(colwidths[col])
-          else
-            texts[col] = texts[col].rjust(colwidths[col])
+          unless ncols == 1 && opts[:ljust]
+            if opts[:ljust]
+              texts[col] = texts[col].ljust(colwidths[col]) if ncols != 1
+            else
+              texts[col] = texts[col].rjust(colwidths[col])
+            end
           end
         end
         s += "%s%s\n" % [prefix, texts.join(opts[:colsep])]
@@ -279,17 +269,22 @@ if __FILE__ == $0
   #
   include Columnize
   
+  line = 'require "irb"';
+  puts cell_size(line, true);
+  puts cell_size(line, false);
+
   [[4, 4], [4, 7], [100, 80]].each do |width, num|
-    data = (1..num).map{|i| i.to_s}
+    data = (1..num).map{|i| i}
     [[false, 'horizontal'], [true, 'vertical']].each do |bool, dir|
       puts "Width: #{width}, direction: #{dir}"
-      print columnize(data, width, '  ', arrange_vertical=bool)
+      print columnize(data, :displaywidth => width, :colsep => '  ', 
+                      :arrange_vertical => bool, :ljust => :auto)
       end
   end
 
   puts Columnize::columnize(5)
   puts columnize([])
-  puts columnize(["a", 2, "c"], 10, ', ')
+  puts columnize(["a", 2, "c"], :displaywidth =>10, :colsep => ', ')
   puts columnize(["oneitem"])
   puts columnize(["one", "two", "three"])
   data = ["one",       "two",         "three",

data/lib/version.rb

@@ -3,5 +3,5 @@
 # require'ing 'columnize'.
 module Columnize
   # The current version of this package
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
 end

data/test/test-issue3.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+
+# Test of Columnize module
+class TestIssue3 < Test::Unit::TestCase
+  @@TOP_SRC_DIR = File.join(File.expand_path(File.dirname(__FILE__)), 
+                            '..', 'lib')
+  require File.join(@@TOP_SRC_DIR, 'columnize.rb')
+  include Columnize
+  # test columnize
+  def test_long_column
+    data = ["what's", "upppppppppppppppppp"]
+    # Try at least one test where we give the module name explicitely.
+    assert_equal("what's\nupppppppppppppppppp\n", 
+                 Columnize::columnize(data, :arrange_vertical => false,
+                                      :displaywidth => 7))
+    assert_equal("what's\nupppppppppppppppppp\n", 
+                 Columnize::columnize(data, :arrange_vertical => true,
+                                      :displaywidth => 7))
+    data = ["whaaaaaat's", "up"]
+    assert_equal("whaaaaaat's\n         up\n",
+                 Columnize::columnize(data, 
+                                      :arrange_vertical => false,
+                                      :ljust => false,
+                                      :displaywidth => 7))
+    assert_equal("whaaaaaat's\nup\n",
+                 Columnize::columnize(data, 
+                                      :arrange_vertical => false,
+                                      :ljust => true,
+                                      :displaywidth => 7))
+    assert_equal("whaaaaaat's\nup\n",
+                 Columnize::columnize(data, 
+                                      :arrange_vertical => true,
+                                      :ljust => true,
+                                      :displaywidth => 7))
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - R. Bernstein
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 -04:00
+date: 2011-11-24 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -32,7 +32,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 - lib/columnize.rb
 - COPYING
 files: 
@@ -42,7 +42,7 @@ files:
 - ChangeLog
 - Makefile
 - NEWS
-- README
+- README.md
 - Rakefile
 - columnize.gemspec
 - lib/Makefile
@@ -50,6 +50,7 @@ files:
 - lib/version.rb
 - test/test-columnize.rb
 - test/test-hashparm.rb
+- test/test-issue3.rb
 has_rdoc: true
 homepage: https://github.com/rocky/columnize
 licenses: 
@@ -57,11 +58,10 @@ licenses:
 - GPL2
 post_install_message: 
 rdoc_options: 
-- --verbose
 - --main
 - README
 - --title
-- Columnize 0.3.4 Documentation
+- Columnize 0.3.5 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README

@@ -1,78 +0,0 @@
-= Columnize - Module to show an Array formatted as a String aligned in columns. 
-
-== Summary
-
-In showing a long lists, sometimes one would prefer to see the value
-arranged aligned in columns. Some examples include listing methods of
-an object, listing debugger commands, or showing a numeric array with data
-aligned.
-
-=== Setup
-
-  $ irb
-  >> a = (1..10).to_a
-  => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
-  >> require 'columnize'
-  => true
-  >> include Columnize
-  => Object
-  >> g = %w(bibrons golden madascar leopard mourning suras tokay)
-  => ["bibrons", "golden", "madascar", "leopard", "mourning", "suras", "tokay"]
-
-=== With numeric data
-
-  columnize(a) 
-  => "1  2  3  4  5  6  7  8  9  10\n"
-  >> puts Columnize::columnize(a, :arrange_array => true, :displaywidth => 10)
-  [1,  2
-   3,  4
-   5,  6
-   7,  8
-   9, 10
-  ]
-  => nil
-  >> puts Columnize::columnize(a, :arrange_array => true, :displaywidth => 20)
-  [1, 2, 3,  4,  5,  6
-   7, 8, 9, 10
-  ]
-
-=== With String data
-
-  >> puts columnize g, :displaywidth => 15
-  bibrons   suras
-  golden    tokay
-  madascar
-  leopard 
-  mourning
-  => nil
-
-  >> puts columnize g, {:displaywidth => 18, :colsep => ' | '}
-  bibrons  | suras
-  golden   | tokay
-  madascar
-  leopard 
-  mourning
-  => nil
-
-  >> puts columnize g, {:displaywidth => 18, :colsep => ' | ', :ljust=>false}
-   bibrons | suras
-    golden | tokay
-  madascar
-   leopard
-
-== Credits
-
-  This is adapted from a method of the same name from Python's cmd module.
-
-== Other stuff
-
-Author::   Rocky Bernstein <rockyb@rubyforge.net>
-License::  Copyright (c) 2007, 2011 Rocky Bernstein
-           Released under the GNU GPL 2 license
-
-== Warranty
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.