ansi 1.2.5 → 1.3.0

data/LICENSE/MIT.txt

@@ -0,0 +1,21 @@
+MIT License
+
+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.
+

data/LICENSE/RUBY.txt

@@ -0,0 +1,60 @@
+The 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
+(see COPYING.txt file), or the conditions below:
+
+  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.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       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.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  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 this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  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.
+
+  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/NOTICE.rdoc

@@ -1,18 +1,130 @@
 = COPYRIGHT NOTICES
 
+== ANSI
+
+Copyright:: (c) 2004 Rubyworks, Thomas Sawyer
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/ansi
+
+    Copyright 2004 Thomas Sawyer. 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 <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
+    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.
+
+    The views and conclusions contained in the software and documentation are those of the
+    authors and should not be interpreted as representing official policies, either expressed
+    or implied, of <copyright holder>.
+
+
 == ProgressBar
 
+Copyright:: (C) 2001 Satoru Takabayashi
+License:: Ruby License
+Website:: http://0xcc.net/ruby-progressbar/
+
 ProgressBar class is based on the original ProgressBar by Satoru Takabayashi.
 
-Copyright (C) 2001 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)
 
-== Terminal Extensions
+Copyright:: (c) 2006 Gray Productions
+License:: Ruby License
+Website:: http://highline.rubyforge.org/
 
 The terminal extensions are based on HighLine's SystemExtensions
 by James Edward Gray II.
 
-Copyright 2006 Gray Productions
+    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 License
+
+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
+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.
+
+
+= ACKNOWLEDGEMENTS
+
+== ANSIColor
+
+Copyright:: (c) 2002 Florian Frank
+Website:: http://flori.github.com/term-ansicolor
 
-{Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt]
+Albeit the code no long bares any resemblance to it, the ANSI Code module
+(and subsequently the Constants module) originated with the ANSIColor
+library by Florian Frank.
 

data/README.rdoc

@@ -37,26 +37,21 @@ Please see HISTORY file.
 There are a number of modules and classes provided by the ANSI
 package. To get a good understanding of them it is best to pursue 
 the QED documents[http://github.com/rubyworks/ansi/tree/master/qed/]
-or the API documentation[http://rubyworks.github.com/ansi/rdoc/].
+or the API documentation[http://rubyworks.github.com/ansi/api/index.html].
 
 At the heart of all the provided libraries lies the ANSI::Code module
 which defines ANSI codes as constants and methods. For example:
 
   require 'ansi/code'
 
-  include ANSI::Code
-
-  red + "Hello" + blue + "World"
+  ANSI.red + "Hello" + ANSI.blue + "World"
   => "\e[31mHello\e[34mWorld"
 
 Or in block form.
 
-  red{ "Hello" } + blue{ "World" }
+  ANSI.red{ "Hello" } + ANSI.blue{ "World" }
   => "\e[31mHello\e[0m\e[34mWorld\e[0m"
 
-Rather than include +ANSI::Code+, these methods can also be called as module
-methods. Either as <code>ANSI::Code.red</code> or just <code>ANSI.red</code>.
-
 The methods defined by this module are used throughout the rest of
 the system.
 
@@ -77,11 +72,10 @@ then download[http://github.com/rubyworks/ansi/download] the tarball package and
 Windows users use 'ruby setup.rb all'.
 
 
-== LICENSE/COPYRIGHT
+== LICENSE & COPYRIGHT
 
 Copyright (c) 2004 Thomas Sawyer
 
-This program is distributed under the terms of the Apache 2 license.
-
-See LICENSE file for details.
+This program is distributed under the terms of the BSD 2-clause license.
 
+See NOTICE.rdoc file and LICENSE directory for details.

data/lib/ansi.rb

@@ -14,6 +14,7 @@ module ANSI
   end
 end
 
+require 'ansi/core'
 require 'ansi/code'
 require 'ansi/bbcode'
 require 'ansi/columns'
@@ -25,3 +26,8 @@ require 'ansi/string'
 require 'ansi/table'
 require 'ansi/terminal'
 
+# Kernel method
+def ansi(string, *codes)
+  ANSI::Code.ansi(string, *codes)
+end
+

data/lib/ansi.rbz

@@ -0,0 +1,40 @@
+# ANSI Module provides a Bezel interface as follows:
+#
+#     ANSI = lib('ansi', '1.2.6')
+#
+#     module MyAPP
+#       include ANSI
+#     end
+#
+# Examples
+#
+#     def hello_world
+#       puts ansi("Hello World", :red)
+#     end
+#
+#     # automatically included with ANSI 1.3.
+#     def ansi(string, *codes)
+#       ANSI::Code.ansi(string, *codes)
+#     end
+#
+# Or
+#
+#     def hello_world
+#       puts "Hello World".ansi(:red)
+#     end
+#   
+# NOTE: Core extensions need stable interfaces!
+#
+module ANSI; end
+
+import 'ansi/code'
+import 'ansi/bbcode'
+import 'ansi/columns'
+import 'ansi/diff'
+import 'ansi/logger'
+import 'ansi/mixin'
+import 'ansi/progressbar'
+import 'ansi/string'
+import 'ansi/table'
+import 'ansi/terminal'
+

data/lib/ansi.yml

@@ -1,44 +1,47 @@
 --- 
-spec_version: 1.0.0
-replaces: []
-
-loadpath: 
-- lib
 name: ansi
-repositories: {}
-
-conflicts: []
-
-engine_check: []
-
+version: 1.3.0
 title: ANSI
-contact: rubyworks-mailinglist@googlegroups.com
-resources: 
-  repository: git://github.com/rubyworks/ansi.git
-  api: http://rubyworks.github.com/ansi/rdoc
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-  home: http://rubyworks.github.com/ansi
-  work: http://github.com/rubyworks/ansi
-maintainers: []
-
+summary: ANSI codes at your fingertips!
+description: The ANSI project is a collection of ANSI escape code related libraries enabling ANSI code based colorization and stylization of output. It is very nice for beautifying shell output.
+loadpath: 
+- lib
+manifest: Manifest
 requires: 
-- group: 
+- name: detroit
+  version: 0+
+  group: 
   - build
-  name: syckle
+- name: qed
   version: 0+
-- group: 
+  group: 
   - test
-  name: ko
+- name: lemon
   version: 0+
-manifest: MANIFEST
-version: 1.2.5
+  group: 
+  - test
+conflicts: []
+
+replaces: []
+
+engine_check: []
+
+organization: RubyWorks
+contact: rubyworks-mailinglist@googlegroups.com
+created: 2004-08-01
+copyright: Copyright (c) 2009 Thomas Sawyer
 licenses: 
 - Apache 2.0
-copyright: Copyright (c) 2009 Thomas Sawyer
 authors: 
 - Thomas Sawyer
 - Florian Frank
-organization: RubyWorks
-description: The ANSI project is a collection of ANSI escape code related libraries enabling ANSI code based colorization and stylization of output. It is very nice for beautifying shell output.
-summary: ANSI codes at your fingertips!
-created: 2004-08-01
+maintainers: []
+
+resources: 
+  home: http://rubyworks.github.com/ansi
+  work: http://github.com/rubyworks/ansi
+  api: http://rubyworks.github.com/ansi/rdoc
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+repositories: 
+  public: git://github.com/rubyworks/ansi.git
+spec_version: 1.0.0

data/lib/ansi/bbcode.rb

@@ -31,6 +31,9 @@ module ANSI
   #   print( BBCode.bbcode_to_ansi(str) )
   #   print( BBCode.bbcode_to_html(str) )
   #
+  #--
+  # TODO: integrate with Code module.
+  #++
   module BBCode
 
     ## ANSIname => ANSIcode LUT

data/lib/ansi/chart.rb

@@ -0,0 +1,95 @@
+module ANSI
+
+  # Table of codes used throughout the system.
+  #
+  # @see http://en.wikipedia.org/wiki/ANSI_escape_code
+  CHART = {
+    :clear            => 0,
+    :reset            => 0,
+    :bright           => 1,
+    :bold             => 1, 
+    :faint            => 2,
+    :dark             => 2,
+    :italic           => 3,
+    :underline        => 4,
+    :underscore       => 4,
+    :blink            => 5,
+    :slow_blink       => 5,
+    :rapid            => 6,
+    :rapid_blink      => 6,
+    :inverse          => 7,
+    :reverse          => 7,
+    :negative         => 7,
+    :concealed        => 8,
+    :swap             => 7,
+    :conceal          => 8,
+    :concealed        => 8,
+    :hide             => 9,
+    :strike           => 9,
+
+    :default_font     => 10,
+    :font_default     => 10,
+    :font0            => 10,
+    :font1            => 11,
+    :font2            => 12,
+    :font3            => 13,
+    :font4            => 14,
+    :font5            => 15,
+    :font6            => 16,
+    :font7            => 17,
+    :font8            => 18,
+    :font9            => 19,
+    :fraktur          => 20,
+    :bright_off       => 21,
+    :bold_off         => 21,
+    :double_underline => 21,
+    :clean            => 22,
+    :italic_off       => 23,
+    :fraktur_off      => 23,
+    :underline_off    => 24,
+    :blink_off        => 25,
+    :inverse_off      => 26,
+    :positive         => 26,
+    :conceal_off      => 27,
+    :show             => 27,
+    :reveal           => 27,
+    :crossed_off      => 29,
+    :crossed_out_off  => 29,
+
+    :black            => 30,
+    :red              => 31,
+    :green            => 32,
+    :yellow           => 33,
+    :blue             => 34,
+    :magenta          => 35,
+    :cyan             => 36,
+    :white            => 37,
+
+    :on_black         => 40,
+    :on_red           => 41,
+    :on_green         => 42,
+    :on_yellow        => 43,
+    :on_blue          => 44,
+    :on_magenta       => 45,
+    :on_cyan          => 46,
+    :on_white         => 47,
+
+    :frame            => 51,
+    :encircle         => 52,
+    :overline         => 53,
+    :frame_off        => 54,
+    :encircle_off     => 54,
+    :overline_off     => 55,
+  }
+
+  #
+  SPECIAL_CHART = {
+    :save             => "\e[s",   # Save current cursor positon.
+    :restore          => "\e[u",   # Restore saved cursor positon.
+    :clear_line       => "\e[K",   # Clear to the end of the current line.
+    :clr              => "\e[K",   # Clear to the end of the current line.
+    :clear_screen     => "\e[2J",  # Clear the screen and move cursor to home.
+    :cls              => "\e[2J",  # Clear the screen and move cursor to home.
+  }
+
+end