columnize 0.3.3 → 0.3.4

data/.gitignore

@@ -0,0 +1 @@
+/pkg

data/COPYING

@@ -1,340 +1,57 @@
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
+Columnize is copyrighted free software by Rocky Bernstein <rocky@rubyforge.org>.
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-     51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
+You can redistribute it and/or modify it under either the terms of the GPL
+version 2 (see the file GPL), or the conditions below:
 
-			    Preamble
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
 
-  The licenses for most software are designed to take away your
-freedom to share and change it.  By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users.  This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it.  (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.)  You can apply it to
-your programs, too.
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
 
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
 
-  To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
+       b) use the modified software only within your corporation or
+          organization.
 
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have.  You must make sure that they, too, receive or can get the
-source code.  And you must show them these terms so they know their
-rights.
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
 
-  We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
+       d) make other distribution arrangements with the author.
 
-  Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software.  If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
 
-  Finally, any free program is threatened constantly by software
-patents.  We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary.  To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
 
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-		    GNU GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+       b) accompany the distribution with the machine-readable source of
+	  the software.
 
-  0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License.  The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language.  (Hereinafter, translation is included without limitation in
-the term "modification".)  Each licensee is addressed as "you".
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
 
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope.  The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
+       d) make other distribution arrangements with the author.
 
-  1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
 
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
 
-  2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
 
-    a) You must cause the modified files to carry prominent notices
-    stating that you changed the files and the date of any change.
-
-    b) You must cause any work that you distribute or publish, that in
-    whole or in part contains or is derived from the Program or any
-    part thereof, to be licensed as a whole at no charge to all third
-    parties under the terms of this License.
-
-    c) If the modified program normally reads commands interactively
-    when run, you must cause it, when started running for such
-    interactive use in the most ordinary way, to print or display an
-    announcement including an appropriate copyright notice and a
-    notice that there is no warranty (or else, saying that you provide
-    a warranty) and that users may redistribute the program under
-    these conditions, and telling the user how to view a copy of this
-    License.  (Exception: if the Program itself is interactive but
-    does not normally print such an announcement, your work based on
-    the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole.  If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-  3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
-    a) Accompany it with the complete corresponding machine-readable
-    source code, which must be distributed under the terms of Sections
-    1 and 2 above on a medium customarily used for software interchange; or,
-
-    b) Accompany it with a written offer, valid for at least three
-    years, to give any third party, for a charge no more than your
-    cost of physically performing source distribution, a complete
-    machine-readable copy of the corresponding source code, to be
-    distributed under the terms of Sections 1 and 2 above on a medium
-    customarily used for software interchange; or,
-
-    c) Accompany it with the information you received as to the offer
-    to distribute corresponding source code.  (This alternative is
-    allowed only for noncommercial distribution and only if you
-    received the program in object code or executable form with such
-    an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it.  For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable.  However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-  4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License.  Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-  5. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Program or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
-  6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
-  7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-  8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
-
-  9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number.  If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation.  If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
-  10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission.  For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this.  Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
-			    NO WARRANTY
-
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
-		     END OF TERMS AND CONDITIONS
-
-	    How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    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
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    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.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
-    Gnomovision version 69, Copyright (C) year  name of author
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
-  <signature of Ty Coon>, 1 April 1989
-  Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs.  If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Library General
-Public License instead of this License.
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/ChangeLog

@@ -1,3 +1,7 @@
+2011-06-09  rocky <rockyb@rubyforge.org>
+
+	* ChangeLog, NEWS, Rakefile: Get ready for new release.
+
 2011-04-27  r <rocky@gnu.org>
 
 	* README.md: Fix code example.

data/NEWS

@@ -1,3 +1,11 @@
+0.3.4 July 4, 2011 
+
+- Change to Ruby License
+- Add option 'term_adjust' to ignore terminal sequences in text
+- Add :ljust => :auto to decide whether or not to automatically
+  left or right justify. When passing a hash parameter, the default
+  is :auto.
+
 0.3.3 June 12, 2011 Fleetwood release
 
 - More general but simpler inteface using an options
@@ -33,5 +41,3 @@
 
 - Initial release of Columnize, a module to print an Array in
   column-sorted order
-
-$Id$

data/README

@@ -0,0 +1,78 @@
+= 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.

data/Rakefile

@@ -10,14 +10,15 @@ ROOT_DIR = File.dirname(__FILE__)
 require File.join(ROOT_DIR, '/lib/version')
 
 def gemspec
-  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+  @gemspec ||= eval(File.read('columnize.gemspec'), 
+                    binding, 'columnize.gemspec')
 end
 
 desc "Build the gem"
 task :package=>:gem
 task :gem=>:gemspec do
   Dir.chdir(ROOT_DIR) do
-    sh "gem build .gemspec"
+    sh "gem build columnize.gemspec"
     FileUtils.mkdir_p 'pkg'
     FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
   end

data/columnize.gemspec

@@ -0,0 +1,51 @@
+# -*- Ruby -*-
+# -*- encoding: utf-8 -*-
+require 'rake'
+require 'rubygems' unless 
+  Object.const_defined?(:Gem)
+require File.dirname(__FILE__) + "/lib/version" unless 
+  Object.const_defined?(:'Columnize')
+
+Gem::Specification.new do |spec|
+  spec.authors      = ['R. Bernstein']
+  spec.date         = Time.now
+  spec.description  = '
+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 or debugger commands. 
+
+An Example:
+```
+require "columnize"
+  Columnize.columnize((1..100).to_a, :displaywidth=>60)
+  puts Columnize.columnize((1..100).to_a, :displaywidth=>60)
+  1   8  15  22  29  36  43  50  57  64  71  78  85  92   99
+  2   9  16  23  30  37  44  51  58  65  72  79  86  93  100
+  3  10  17  24  31  38  45  52  59  66  73  80  87  94
+  4  11  18  25  32  39  46  53  60  67  74  81  88  95
+  5  12  19  26  33  40  47  54  61  68  75  82  89  96
+  6  13  20  27  34  41  48  55  62  69  76  83  90  97
+  7  14  21  28  35  42  49  56  63  70  77  84  91  98
+
+  See Examples in the rdoc documentation for more examples.
+```
+'
+  spec.email        = 'rockyb@rubyforge.net'
+  spec.files        = `git ls-files`.split("\n")
+  spec.homepage     = 'https://github.com/rocky/columnize'
+  spec.name         = 'columnize'
+  spec.licenses     = ['Ruby', 'GPL2']
+  spec.platform     = Gem::Platform::RUBY
+  spec.require_path = 'lib'
+  spec.required_ruby_version = '>= 1.8.2'
+  spec.rubyforge_project = '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)
+
+  # Make the readme file the start page for the generated html
+  spec.rdoc_options += %w(--verbose --main README)
+  spec.rdoc_options += ['--title', "Columnize #{Columnize::VERSION} Documentation"]
+
+end

data/lib/columnize.rb

@@ -1,28 +1,8 @@
-#   Copyright (C) 2007, 2008, 2009, 2010, 2011 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
-#    the Free Software Foundation; either version 2 of the License, or
-#    (at your option) any later version.
-#
-#    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.
-#
-#    You should have received a copy of the GNU General Public License
-#    along with this program; if not, write to the Free Software
-#    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-#    02110-1301 USA.
-#
-
-# Author::    Rocky Bernstein  (mailto:rockyb@rubyforge.net)
-#
-# = Columnize
 # Module to format an Array as an Array of String aligned in columns.
 #
-# == SYNOPSIS
+# :main:README.md
+#
+# == Summary
 # Display a list of strings as a compact set of columns.
 #
 #   For example, for a line width of 4 characters (arranged vertically):
@@ -32,30 +12,73 @@
 #        ['1', '2,', '3', '4'] => '1  2\n3  4\n'
 #        
 # Each column is only as wide as necessary.  By default, columns are
-# separated by two spaces (one was not legible enough).  
-
-
-# Adapted from
-# the routine of the same name in cmd.py
+# separated by two spaces. Options are avalable for setting
+# * the display width
+# * the column separator
+# * the line prefix
+# * whether to ignore terminal codes in text size calculation
+# * whether to left justify text instead of right justify
+#
+# == License 
+#
+# Columnize is copyright (C) 2007, 2008, 2009, 2010, 2011 Rocky Bernstein
+# <rockyb@rubyforge.net>
+#
+# All rights reserved.  You can redistribute and/or modify it under
+# the same terms as Ruby.
+#
+# Adapted from the routine of the same name in Python +cmd.py+.
 
 module Columnize
 
+  # When an option is not specified for the below keys, these
+  # are the defaults.
   DEFAULT_OPTS = {
-    :displaywidth      => 80,
+    :arrange_array     => false,
+    :arrange_vertical  => true,
+    :array_prefix      => false,
+    :array_suffix      => '',
     :colsep            => '  ',
-    :ljust             => true,
+    :displaywidth      => 80,
     :lineprefix        => '',
-    :arrange_vertical  => true
+    :ljust             => :auto,
+    :term_adjust       => false
   }
 
   module_function
+
+  # Options parsing routine for Columnize::columnize. In the preferred
+  # newer style, +args+ is either a hash where each key is one of the option
+  # names: 
+  #
+  # [arrange_vertical] Arrange list vertically rather than horizontally. This is the default
+  # [colsep] String used to separate columns
+  # [displaywidth] Maximum width of each line
+  # [ljust] Boolean or +:auto+: Left-justify fields in a column? The default is +true+. If
+  # the :auto, then right-justify if every element of the data is a kind of Numeric.
+  # [lineprefix] String: string to prepend to each line. The default is ''.
+  # 
+  # In the older style positional arguments are used and the positions
+  # are in the order: +displaywidth+, +colsep+, +arrange_vertical+,
+  # +ljust+, and +lineprefix+.
   def parse_columnize_options(args)
     list = args.shift
     if 1 == args.size && args[0].kind_of?(Hash)
-      return list, DEFAULT_OPTS.merge(args[0])
+      opts = DEFAULT_OPTS.merge(args[0])
+      if opts[:arrange_array]
+        opts[:array_prefix] = '['
+        opts[:lineprefix]   = ' '
+        opts[:array_suffix] = "]\n"
+        opts[:colsep]       = ', '
+        opts[:arrange_vertical] = false
+      end
+      opts[:ljust] = !(list.all?{|datum| datum.kind_of?(Numeric)}) if 
+        opts[:ljust] == :auto
+      return list, opts
     else      
       opts = DEFAULT_OPTS.dup
-      %w(displaywidth colsep arrange_vertical ljust lineprefix).each do |field|
+      %w(displaywidth colsep arrange_vertical ljust lineprefix
+        ).each do |field|
         break if args.empty?
         opts[field.to_sym] = args.shift
       end
@@ -63,6 +86,16 @@ module Columnize
     end
   end
 
+  # Return the length of String +cell+. If Boolean +term_adjust+ is true,
+  # ignore terminal sequences in +cell+.
+  def cell_size(cell, term_adjust)
+    if term_adjust
+      cell.gsub(/\e\[.*?m/, '')
+    else
+      cell
+    end.size
+  end
+
   # Return a list of strings with embedded newlines (\n) as a compact
   # set of columns arranged horizontally or vertically.
   #
@@ -96,7 +129,8 @@ module Columnize
 
     nrows = ncols = 0  # Make nrows, ncols have more global scope
     colwidths = []     # Same for colwidths
-    opts[:displaywidth] = [4, opts[:displaywidth] - opts[:lineprefix].length].max
+    opts[:displaywidth] = [4, 
+                           opts[:displaywidth] - opts[:lineprefix].length].max
     if opts[:arrange_vertical]
       array_index = lambda {|num_rows, row, col| num_rows*col + row }
       # Try every row count from 1 upwards
@@ -116,7 +150,7 @@ module Columnize
             if i >= l.size
               break
             end
-            colwidth = [colwidth, l[i].size].max
+            colwidth = [colwidth, cell_size(l[i], opts[:term_adjust])].max
           end
           colwidths << colwidth
           totwidth += colwidth + opts[:colsep].length
@@ -141,7 +175,7 @@ module Columnize
           col = _col
           i = array_index.call(nrows, row, col)
           if i >= l.size
-            x = ""
+            x = ''
           else
             x = l[i]
           end
@@ -187,7 +221,7 @@ module Columnize
               if i >= rounded_size 
                 break
               elsif i < l.size
-                colwidth = [colwidth, l[i].size].max
+                colwidth = [colwidth, cell_size(l[i], opts[:term_adjust])].max
               end
             end
             colwidths << colwidth
@@ -214,6 +248,7 @@ module Columnize
       # Now we just have to format each of the
       # rows.
       s = ''
+      prefix = opts[:array_prefix] || opts[:lineprefix]
       1.upto(nrows) do |row| 
         texts = []
         0.upto(ncols-1) do |col|
@@ -232,8 +267,10 @@ module Columnize
             texts[col] = texts[col].rjust(colwidths[col])
           end
         end
-        s += "%s%s\n" % [opts[:lineprefix], texts.join(opts[:colsep])]
+        s += "%s%s\n" % [prefix, texts.join(opts[:colsep])]
+        prefix = opts[:lineprefix]
       end
+      s += opts[:array_suffix]
       return s
     end
   end

data/lib/version.rb

@@ -1,3 +1,7 @@
+# Sets constant Columnize::VERSION, the version number of
+# this package. It is used in Gem creation but can also be consulted after
+# require'ing 'columnize'.
 module Columnize
-  VERSION = '0.3.3'
+  # The current version of this package
+  VERSION = '0.3.4'
 end

data/test/test-columnize.rb

@@ -8,6 +8,13 @@ class TestColumnize < Test::Unit::TestCase
   require File.join(@@TOP_SRC_DIR, 'columnize.rb')
   include Columnize
   
+  def test_cell_size
+    assert_equal(3, cell_size('abc', false))
+    assert_equal(3, cell_size('abc', true))
+    assert_equal(6, cell_size("\e[0;31mObject\e[0;4m", true))
+    assert_equal(19, cell_size("\e[0;31mObject\e[0;4m", false))
+  end
+
   # test columnize
   def test_basic
     # Try at least one test where we give the module name explicitely.

data/test/test-hashparm.rb

@@ -17,10 +17,64 @@ class TestHashFormat < Test::Unit::TestCase
     assert_equal 70, opts[:displaywidth]
     assert_equal '|', opts[:colsep]
   end
-  
-  def basic
-    opts = {:xxx => 10, :yyy => ', '}
+
+  def test_parse_columnize_ljust
+    list, opts = parse_columnize_options([[1.5, 2, 3], {:ljust => :auto}])
+    assert_equal false, opts[:ljust]
+    list, opts = parse_columnize_options([[1.5, 2, 3], {:ljust => false}])
+    assert_equal false, opts[:ljust]
+    list, opts = parse_columnize_options([[1.5, 2, 3], {:ljust => true}])
+    assert_equal true, opts[:ljust]
+    list, opts = parse_columnize_options([[1, 2, 'b'], {:ljust => :auto}])
+    assert_equal true, opts[:ljust]
+  end
+
+  def test_new_hash
+    list, opts = parse_columnize_options([[], {:displaywidth => 40,
+                                          :colsep => ', ',
+                                          :term_adjust => true,
+                                          }])
+    [[:displaywidth, 40], [:colsep, ', '], [:term_adjust, true]].each do 
+       |field, value|
+       assert_equal(value , opts[field])
+     end
+    list, opts = parse_columnize_options([[], {:displaywidth => 40,
+                                          :colsep => ', ',
+                                          }])
+    assert_equal(false , opts[:term_adjust])
+    opts = {:colsep => ', '}
     assert_equal("1, 2, 3\n", 
                  Columnize::columnize([1, 2, 3], opts))
   end
+  
+  def test_array
+    data = (0..54).to_a
+    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" + 
+             "]\n",
+            columnize(data, 
+                      :arrange_array => true, :ljust => false,
+                      :displaywidth  => 39))
+  end
+
+  def test_justify
+    data = (0..54).to_a
+    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" + 
+             "]\n",
+            columnize(data, 
+                      :arrange_array => true,
+                      :displaywidth  => 39))
+  end
+
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: columnize
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - R. Bernstein
@@ -9,78 +14,78 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-11 00:00:00 -04:00
+date: 2011-07-05 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: |
-  
-  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 or debugger commands. 
-  
-  An Example:
-  require "columnize"
-    print columnize((1..100).to_a.map{|x| "%2d" % x}, 60)
-  
-     1   8  15  22  29  36  43  50  57  64  71  78  85  92  99 
-     2   9  16  23  30  37  44  51  58  65  72  79  86  93  100
-     3  10  17  24  31  38  45  52  59  66  73  80  87  94
-     4  11  18  25  32  39  46  53  60  67  74  81  88  95
-     5  12  19  26  33  40  47  54  61  68  75  82  89  96
-     6  13  20  27  34  41  48  55  62  69  76  83  90  97
-     7  14  21  28  35  42  49  56  63  70  77  84  91  98
-
+description: "\n\
+  In showing a long lists, sometimes one would prefer to see the value\n\
+  arranged aligned in columns. Some examples include listing methods\n\
+  of an object or debugger commands. \n\n\
+  An Example:\n\
+  ```\n\
+  require \"columnize\"\n  Columnize.columnize((1..100).to_a, :displaywidth=>60)\n  puts Columnize.columnize((1..100).to_a, :displaywidth=>60)\n  1   8  15  22  29  36  43  50  57  64  71  78  85  92   99\n  2   9  16  23  30  37  44  51  58  65  72  79  86  93  100\n  3  10  17  24  31  38  45  52  59  66  73  80  87  94\n  4  11  18  25  32  39  46  53  60  67  74  81  88  95\n  5  12  19  26  33  40  47  54  61  68  75  82  89  96\n  6  13  20  27  34  41  48  55  62  69  76  83  90  97\n  7  14  21  28  35  42  49  56  63  70  77  84  91  98\n\n  See Examples in the rdoc documentation for more examples.\n\
+  ```\n"
 email: rockyb@rubyforge.net
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.md
+- README
 - lib/columnize.rb
 - COPYING
 files: 
+- .gitignore
 - AUTHORS
 - COPYING
 - ChangeLog
 - Makefile
 - NEWS
-- README.md
+- README
 - Rakefile
+- columnize.gemspec
+- lib/Makefile
 - lib/columnize.rb
 - lib/version.rb
-- lib/Makefile
 - test/test-columnize.rb
 - test/test-hashparm.rb
 has_rdoc: true
-homepage: http://rubyforge.org/projects/rocky-hacks/columnize
+homepage: https://github.com/rocky/columnize
 licenses: 
+- Ruby
 - GPL2
 post_install_message: 
 rdoc_options: 
+- --verbose
 - --main
-- README.md
+- README
 - --title
-- Columnize 0.3.3 Documentation
+- Columnize 0.3.4 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 2
       version: 1.8.2
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: columnize
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Module to format an Array as an Array of String aligned in columns

data/README.md

@@ -1,40 +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 or debugger commands.
-
-```
-  require 'columnize'
-  columnize([1, 2, 3])
-   1 2 3 
-  a  = (1..100).to_a
-  print columnize((1..100).to_a.map{|x| "%2d" % x}, 60)
-
-   1   8  15  22  29  36  43  50  57  64  71  78  85  92  99 
-   2   9  16  23  30  37  44  51  58  65  72  79  86  93  100
-   3  10  17  24  31  38  45  52  59  66  73  80  87  94
-   4  11  18  25  32  39  46  53  60  67  74  81  88  95
-   5  12  19  26  33  40  47  54  61  68  75  82  89  96
-   6  13  20  27  34  41  48  55  62  69  76  83  90  97
-   7  14  21  28  35  42  49  56  63  70  77  84  91  98
-```
-
-## 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.