ansi 1.4.1 → 1.4.2

data/.ruby

@@ -1,6 +1,6 @@
 ---
 source:
-- meta
+- var
 authors:
 - name: Thomas Sawyer
   email: transfire@gmail.com
@@ -41,13 +41,15 @@ revision: 0
 created: '2009-08-01'
 summary: ANSI at your fingertips!
 title: ANSI
-version: 1.4.1
+version: 1.4.2
 name: ansi
-description: ! 'The ANSI project is a collection of ANSI escape code related libraries
-  enabling
+description: ! 'The ANSI project is a superlative collection of ANSI escape code related
+  libraries
 
-  ANSI code based colorization and stylization of output. It is very nice for
+  enabling ANSI colorization and stylization of console output. Byte for byte
 
-  beautifying shell output.'
+  ANSI is the best ANSI code library available for the Ruby programming
+
+  language.'
 organization: Rubyworks
-date: '2011-11-09'
+date: '2012-01-29'

data/{LICENSE.rdoc → COPYING.rdoc}

@@ -1,6 +1,168 @@
-= Licenses
+= COPYRIGHT
 
-== BSD 2-Clause License
+== NOTICES
+
+=== ANSI
+
+Copyright:: (c) 2009 {Rubyworks}[http://rubyworks.github.com]
+License:: {BSD-2-Clause}[http://spdx.org/licenses/BSD-2-Clause]
+Website:: http://rubyworks.github.com/ansi
+
+    Copyright 2009 Rubyworks.
+
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without modification, are
+    permitted provided that the following conditions are met:
+
+       1. Redistributions of source code must retain the above copyright notice, this list of
+          conditions and the following disclaimer.
+
+       2. Redistributions in binary form must reproduce the above copyright notice, this list
+          of conditions and the following disclaimer in the documentation and/or other materials
+          provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESS OR IMPLIED
+    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+    FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
+    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+    (http://spdx.org/licenses/BSD-2-Clause)
+
+
+=== ProgressBar
+
+Copyright:: (c) 2001 Satoru Takabayashi
+License:: {Ruby}[http://spdx.org/licenses/Ruby]
+Website:: http://0xcc.net/ruby-progressbar
+
+ProgressBar class is based on the original ProgressBar by Satoru Takabayashi.
+
+    Ruby/ProgressBar - a text progress bar library
+
+    Copyright (C) 2001-2005 Satoru Takabayashi <satoru@namazu.org>
+        All rights reserved.
+        This is free software with ABSOLUTELY NO WARRANTY.
+
+    You can redistribute it and/or modify it under the terms
+    of Ruby's license.
+
+
+=== HighLine (Terminal Extensions)
+
+Copyright:: (c) 2006 Gray Productions
+License:: {Ruby}[http://spdx.org/licenses/Ruby]
+Website:: http://highline.rubyforge.org
+
+The terminal extensions are based on HighLine's SystemExtensions
+by James Edward Gray II.
+
+    Copyright 2006 Gray Productions
+
+    Distributed under the user's choice of the {GPL Version 2}[http://www.gnu.org/licenses/old-licenses/gpl-2.0.html]
+    (see GPL-2.0.txt for details) or the {Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt]
+    by James Edward Gray II and Greg Brown.
+
+    Please email James[mailto:james@grayproductions.net] with any questions.
+
+
+== BBCode
+
+Copyright:: (c) 2002 Thomas-Ivo Heinen
+License:: {Ruby}[http://spdx.org/licenses/Ruby]
+
+BBCode module is a derivative of BBCode by Thomas-Ivo Heinen.
+
+    Copyright (c) 2002 Thomas-Ivo Heinen
+
+    This module is free software. You may use, modify, and/or redistribute this
+    software under the same terms as Ruby.
+
+    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.
+
+
+== Rainbow (XTerm Color Support)
+
+Copyright:: (c) Marcin Kulik
+License:: {MIT}[http://spdx.org/licenses/MIT]
+Website:: http://github.com/sickill/rainbow
+
+Rainbox provided the bases for building the XTerm 256 color code
+support into the ANSI::Code module.
+
+    Copyright (c) Marcin Kulik
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+=== Paint
+
+Copyright:: (c) 2011 Jan Lelis
+License:: {MIT}[http://spdx.org/licenses/MIT]
+Website:: https://github.com/janlelis/paint
+
+Some of the latest ANSI code names, and inspiration to check out Rainbow
+and include XTerm 256 color codes, came from Paint.
+
+    Copyright (c) 2011 Jan Lelis
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+=== ANSIColor
+
+Copyright:: (c) 2002 Florian Frank
+Website:: http://flori.github.com/term-ansicolor
+
+Albeit the code no long bares much if any resemblance to it, the ANSI Code
+module (and subsequently the Constants module) originated with the
+ANSIColor library by Florian Frank.
+
+
+== LICENSES
+
+=== BSD 2-Clause License
 
   Redistribution and use in source and binary forms, with or without modification, are
   permitted provided that the following conditions are met:
@@ -12,9 +174,9 @@
         of conditions and the following disclaimer in the documentation and/or other materials
         provided with the distribution.
 
-  THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND ANY EXPRESS OR IMPLIED
-  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR
+  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
@@ -23,7 +185,7 @@
   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
-== MIT License
+=== MIT License
 
   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the
@@ -45,7 +207,7 @@
   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
-== Ruby License
+=== Ruby License
 
   Ruby is copyrighted free software by <COPYRIGHT HOLDER>.
   You can redistribute it and/or modify it under either the terms of the GPL
@@ -106,7 +268,7 @@
        PURPOSE.
 
 
-== GPL 2 License
+=== GPL 2 License
 
                      GNU GENERAL PUBLIC LICENSE
                          Version 2, June 1991

data/HISTORY.rdoc

@@ -1,5 +1,26 @@
 = RELEASE HISTORY
 
+== 1.4.2 | 2012-01-29
+
+ANSI chains are a new feature inspired by Kazuyoshi Tlacaelel's Isna project.
+It is a fluid notation for the String#ansi method, e.g. `"foo".red.on_white`.
+Also, ASNI now supports "smart codes", preventing previously applied codes
+from undermining the applicaiton of additional codes --a subtle issue that
+most other ANSI libraries overlook. Plus a few other improvements including
+that of the API documentation.
+
+Changes:
+
+* Add ANSI::Chains, extending String#ansi method.
+* Support smart code application.
+* Add Diff#to_a and shortcut to it via Diff.diff().
+* Improve #colorize method in ProgressBar.
+* Change ProgressBar's default mark to `|` instead of `o`.
+* Fix Curses return order of screen cols and rows.
+* Support center alignment in Columns.
+* Support custom padding for Columns.
+
+
 == 1.4.1 | 2011-11-09
 
 This release simply fixes a documentation issue, to make sure

data/QED.rdoc

@@ -48,29 +48,16 @@ The ANSI::Code module supports most standard ANSI codes, though
 not all platforms support every code, so YMMV.
 
 
-= ANSI::BBCode
-
-The BBCode module provides methods for converting between
-BBCodes, basic HTML and ANSI codes.
-
-  require 'ansi/bbcode'
-
-BBCodes are color and style codes in square brackets, quite
-popular with on line forums.
-
-  bbcode = "this is [COLOR=red]red[/COLOR], this is [B]bold[/B]"
-
-We can convert this to ANSI code simply enough:
-
-  ansi = ANSI::BBCode.bbcode_to_ansi(bbcode)
-
-  ansi.assert == "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n"
+= String Extensions
 
-In addition the BBCode module supports conversion to simple HTML.
+In addition the library offers an extension to String class
+called #ansi, which allows some of the ANSI::Code methods
+to be called in a more object-oriented fashion.
 
-  html = ANSI::BBCode.bbcode_to_html(bbcode)
+  require 'ansi/core'
 
-  html.assert == "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n"
+  str = "Hello".ansi(:red) + "World".ansi(:blue)
+  str.assert == "\e[31mHello\e[0m\e[34mWorld\e[0m"
 
 
 = ANSI::Logger
@@ -384,15 +371,85 @@ The output will be:
 
 
 
-= String Extensions
+= ANSI::Diff
 
-In addition the library offers an extension to String class
-called #ansi, which allows some of the ANSI::Code methods
-to be called in a more object-oriented fashion.
+  require 'ansi/diff'
 
-  require 'ansi/core'
+  a = 'abcYefg'
+  b = 'abcXefg'
 
-  str = "Hello".ansi(:red) + "World".ansi(:blue)
-  str.assert == "\e[31mHello\e[0m\e[34mWorld\e[0m"
+  diff = ANSI::Diff.new(a,b)
+
+  diff.to_s.assert == "\e[31mabc\e[0m\e[33mYefg\e[0m\n\e[31mabc\e[0mXefg"
+
+Try another.
+
+  a = 'abc'
+  b = 'abcdef'
+
+  diff = ANSI::Diff.new(a,b)
+
+  diff.to_s.assert == "\e[31mabc\e[0m\n\e[31mabc\e[0mdef"
+
+And another.
+
+  a = 'abcXXXghi'
+  b = 'abcdefghi'
+
+  diff = ANSI::Diff.new(a,b)
+
+  diff.to_s.assert == "\e[31mabc\e[0m\e[33mXXXghi\e[0m\n\e[31mabc\e[0mdefghi"
+
+And another.
+
+  a = 'abcXXXdefghi'
+  b = 'abcdefghi'
+
+  diff = ANSI::Diff.new(a,b)
+
+  diff.to_s.assert == "\e[31mabc\e[0m\e[33mXXX\e[0m\e[35mdefghi\e[0m\n\e[31mabc\e[0m\e[35mdefghi\e[0m"
+
+Comparison that is mostly different.
+
+  a = 'abcpppz123'
+  b = 'abcxyzzz43'
+
+  diff = ANSI::Diff.new(a,b)
+
+  diff.to_s.assert == "\e[31mabc\e[0m\e[33mpppz123\e[0m\n\e[31mabc\e[0mxyzzz43"
+
+
+= ANSI::BBCode
+
+The BBCode module provides methods for converting between
+BBCodes, basic HTML and ANSI codes.
+
+  require 'ansi/bbcode'
+
+BBCodes are color and style codes in square brackets, quite
+popular with on line forums.
+
+  bbcode = "this is [COLOR=red]red[/COLOR], this is [B]bold[/B]"
+
+We can convert this to ANSI code simply enough:
+
+  ansi = ANSI::BBCode.bbcode_to_ansi(bbcode)
+
+  ansi.assert == "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n"
+
+In addition the BBCode module supports conversion to simple HTML.
+
+  html = ANSI::BBCode.bbcode_to_html(bbcode)
+
+  html.assert == "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n"
+
+
+= ANSI::Terminal
+
+We should be ables to get the terminal width via the `terminal_width` method.
+
+  width = ANSI::Terminal.terminal_width
+
+  Fixnum.assert === width
 
 

data/README.rdoc

@@ -1,8 +1,8 @@
 = ANSI
 
-{Home}[http://rubyworks.github.com/ansi] |
-{API}[http://rubydoc.info/gems/ansi/frames] |
-{Code}[http://github.com/rubyworks/ansi] |
+{Home}[http://rubyworks.github.com/ansi] /
+{API}[http://rubydoc.info/gems/ansi/frames] /
+{Code}[http://github.com/rubyworks/ansi] /
 {Mail}[http://googlegroups.com/group/rubyworks-mailinglist]
 
 {<img src="http://travis-ci.org/rubyworks/ansi.png" />}[http://travis-ci.org/rubyworks/ansi]
@@ -27,6 +27,7 @@ device.
 * String#ansi makes common usage very easy and elegant.
 * ANSI::Mixin provides an alternative mixin (like +colored+ gem).
 * Very Good coverage of standard ANSI codes.
+* Additional clases for colorized columns, tables, loggers and more.
 
 
 == RELEASE NOTES
@@ -58,7 +59,7 @@ The methods defined by this module are used throughout the rest of
 the system.
 
 
-== HOW TO INSTALL
+== INSTALLATION
 
 To install with RubyGems simply open a console and type:
 
@@ -74,10 +75,13 @@ then download[http://github.com/rubyworks/ansi/download] the tarball package and
 Windows users use 'ruby setup.rb all'.
 
 
-== LICENSE & COPYRIGHT
+== LICENSE & COPYRIGHTS
 
 Copyright (c) 2009 Rubyworks
 
-This program is distributed under the terms of the BSD 2-clause license.
+This program is redistributable under the terms of the *FreeBSD* license.
+
+Some pieces of the code are copyrighted by others.
+
+See COPYING.rdoc file for details.
 
-See NOTICE.rdoc file and LICENSE directory for details.

data/lib/ansi.rb

@@ -1,3 +1,7 @@
+# ANSI namespace module contains all the ANSI related classes.
+module ANSI
+end
+
 require 'ansi/version'
 require 'ansi/core'
 require 'ansi/code'

data/lib/ansi.yml

@@ -1,6 +1,6 @@
 ---
 source:
-- meta
+- var
 authors:
 - name: Thomas Sawyer
   email: transfire@gmail.com
@@ -41,13 +41,15 @@ revision: 0
 created: '2009-08-01'
 summary: ANSI at your fingertips!
 title: ANSI
-version: 1.4.1
+version: 1.4.2
 name: ansi
-description: ! 'The ANSI project is a collection of ANSI escape code related libraries
-  enabling
+description: ! 'The ANSI project is a superlative collection of ANSI escape code related
+  libraries
 
-  ANSI code based colorization and stylization of output. It is very nice for
+  enabling ANSI colorization and stylization of console output. Byte for byte
 
-  beautifying shell output.'
+  ANSI is the best ANSI code library available for the Ruby programming
+
+  language.'
 organization: Rubyworks
-date: '2011-11-09'
+date: '2012-01-29'