Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

first commit

  • Loading branch information...
commit e6d124af246385b07132a1b26f5a45768ab0a6b2 0 parents
Florian Frank authored
3  .gitignore
@@ -0,0 +1,3 @@
+*.sw[pon]
+coverage
+pkg
22 CHANGES
@@ -0,0 +1,22 @@
+2009-07-23 - 1.0.4 * Some cleanup.
+ * Build a gemspec file.
+2007-10-05 - 1.0.3 * Better documentation + some code clean up.
+ * Deleted autorequire from Rakefile.
+2005-11-12 - 1.0.2 * Added DESTDIR in front of install path to make repackaging
+ easier. Thanks to Tilman Sauerbeck <tilman@code-monkey.de>
+ for giving the hint.
+2005-09-05 - 1.0.1 * Fixed install bug in Rakefile, reported by
+ Martin DeMello <martindemello@gmail.com>
+2004-12-23 - 1.0.0 * Added Term::ANSIColor.coloring[?=]? methods.
+ Thanks, Thomas Husterer for the contribution.
+ * Minor cleanup of code.
+ * Documented visible methods in the module.
+2004-09-28 - 0.0.4 * First release on Rubyforge
+ * Supports Rubygems now
+2003-10-09 - 0.0.3 * Added uncolored method as suggested by
+ Thomas Husterer <Thomas.Husterer@heidelberg.com>
+ * Added attribute methods with string arguments
+ * Deleted now unused files
+2002-07-27 - 0.0.2 * Minor Code Cleanup
+ * Added cdiff.rb
+2002-06-12 - 0.0.1 * Initial Release
340 COPYING
@@ -0,0 +1,340 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 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.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 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".
+
+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.
+
+ 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.
+
+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.
+
+ 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:
+
+ 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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.
31 README
@@ -0,0 +1,31 @@
+Installation
+============
+
+Just type into the command line as root:
+
+# ruby install.rb
+
+Or if you prefer using Rake, try:
+
+# rake install
+
+Or if you want to use rubygems just type this and rubygems fetches the gem and
+installs it for you:
+
+# gem install term-ansicolor
+
+Documentation
+=============
+
+Look into examples/example.rb to get an idea how this library is used.
+
+Author
+======
+
+Florian Frank <flori@ping.de>
+
+License
+=======
+
+GNU General Public License (GPL)
+
86 Rakefile
@@ -0,0 +1,86 @@
+begin
+ require 'rake/gempackagetask'
+rescue LoadError
+end
+require 'rake/clean'
+require 'rbconfig'
+include Config
+
+PKG_NAME = 'term-ansicolor'
+PKG_VERSION = File.read('VERSION').chomp
+PKG_FILES = FileList['**/*'].exclude(/(CVS|\.svn|pkg|coverage|doc)/)
+CLEAN.include 'coverage', 'doc'
+
+desc "Installing library"
+task :install do
+ ruby 'install.rb'
+end
+
+desc "Creating documentation"
+task :doc do
+ ruby 'make_doc.rb'
+end
+
+
+if defined? Gem
+ spec_src =<<GEM
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+ s.name = '#{PKG_NAME}'
+ s.version = '#{PKG_VERSION}'
+ s.summary = "Ruby library that colors strings using ANSI escape sequences"
+ s.description = ""
+
+ s.files = #{PKG_FILES.to_a.sort.inspect}
+
+ s.require_path = 'lib'
+
+ s.has_rdoc = true
+ s.extra_rdoc_files << 'doc-main.txt'
+ s.rdoc_options << '--main' << 'doc-main.txt'
+
+ s.author = "Florian Frank"
+ s.email = "flori@ping.de"
+ s.homepage = "http://#{PKG_NAME}.rubyforge.org"
+ s.rubyforge_project = '#{PKG_NAME}'
+end
+GEM
+
+ desc 'Create a gemspec file'
+ task :gemspec do
+ File.open("#{PKG_NAME}.gemspec", 'w') do |f|
+ f.puts spec_src
+ end
+ end
+
+ spec = eval(spec_src)
+ Rake::GemPackageTask.new(spec) do |pkg|
+ pkg.need_tar = true
+ pkg.package_files += PKG_FILES
+ end
+end
+
+desc m = "Writing version information for #{PKG_VERSION}"
+task :version do
+ puts m
+ File.open(File.join('lib', 'term', 'ansicolor', 'version.rb'), 'w') do |v|
+ v.puts <<EOT
+module Term
+ module ANSIColor
+ # Term::ANSIColor version
+ VERSION = '#{PKG_VERSION}'
+ VERSION_ARRAY = VERSION.split(/\\./).map { |x| x.to_i } # :nodoc:
+ VERSION_MAJOR = VERSION_ARRAY[0] # :nodoc:
+ VERSION_MINOR = VERSION_ARRAY[1] # :nodoc:
+ VERSION_BUILD = VERSION_ARRAY[2] # :nodoc:
+ end
+end
+EOT
+ end
+end
+
+desc "Default"
+task :default => [ :version, :gemspec ]
+
+desc "Prepare a release"
+task :release => [ :clean, :version, :gemspec, :package ]
1  VERSION
@@ -0,0 +1 @@
+1.0.4
119 doc-main.txt
@@ -0,0 +1,119 @@
+== Term::ANSIColor - ANSI escape sequences in Ruby
+
+=== Description
+
+This library can be used to color/uncolor strings using ANSI escape sequences.
+
+=== Author
+
+Florian Frank mailto:flori@ping.de
+
+=== License
+
+This is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License Version 2 as published by the Free
+Software Foundation: www.gnu.org/copyleft/gpl.html
+
+=== Download
+
+The latest version of this library can be downloaded at
+
+* http://rubyforge.org/frs?group_id=391
+
+The homepage of this library is located at
+
+* http://term-ansicolor.rubyforge.org
+
+=== Examples
+
+The file examples/example.rb in the source/gem-distribution shows how
+this library can be used:
+ require 'term/ansicolor'
+
+ # Use this trick to work around namespace cluttering that
+ # happens if you just include Term::ANSIColor:
+
+ class Color
+ class << self
+ include Term::ANSIColor
+ end
+ end
+
+ print Color.red, Color.bold, "No Namespace cluttering:", Color.clear, "\n"
+ print Color.green + "green" + Color.clear, "\n"
+ print Color.on_red(Color.green("green")), "\n"
+ print Color.yellow { Color.on_black { "yellow on_black" } }, "\n\n"
+
+ # Or shortcut Term::ANSIColor by assignment:
+ c = Term::ANSIColor
+
+ print c.red, c.bold, "No Namespace cluttering (alternative):", c.clear, "\n"
+ print c.green + "green" + c.clear, "\n"
+ print c.on_red(c.green("green")), "\n"
+ print c.yellow { c.on_black { "yellow on_black" } }, "\n\n"
+
+ # Anyway, I don't define any of Term::ANSIColor's methods in this example
+ # and I want to keep it short:
+ include Term::ANSIColor
+
+ print red, bold, "Usage as constants:", reset, "\n"
+ print clear, "clear", reset, reset, "reset", reset,
+ bold, "bold", reset, dark, "dark", reset,
+ underscore, "underscore", reset, blink, "blink", reset,
+ negative, "negative", reset, concealed, "concealed", reset, "|\n",
+ black, "black", reset, red, "red", reset, green, "green", reset,
+ yellow, "yellow", reset, blue, "blue", reset, magenta, "magenta", reset,
+ cyan, "cyan", reset, white, "white", reset, "|\n",
+ on_black, "on_black", reset, on_red, "on_red", reset,
+ on_green, "on_green", reset, on_yellow, "on_yellow", reset,
+ on_blue, "on_blue", reset, on_magenta, "on_magenta", reset,
+ on_cyan, "on_cyan", reset, on_white, "on_white", reset, "|\n\n"
+
+ print red, bold, "Usage as unary argument methods:", reset, "\n"
+ print clear("clear"), reset("reset"), bold("bold"), dark("dark"),
+ underscore("underscore"), blink("blink"), negative("negative"),
+ concealed("concealed"), "|\n",
+ black("black"), red("red"), green("green"), yellow("yellow"),
+ blue("blue"), magenta("magenta"), cyan("cyan"), white("white"), "|\n",
+ on_black("on_black"), on_red("on_red"), on_green("on_green"),#
+ on_yellow("on_yellow"), on_blue("on_blue"), on_magenta("on_magenta"),
+ on_cyan("on_cyan"), on_white("on_white"), "|\n\n"
+
+ print red { bold { "Usage as block forms:" } }, "\n"
+ print clear { "clear" }, reset { "reset" }, bold { "bold" },
+ dark { "dark" }, underscore { "underscore" }, blink { "blink" },
+ negative { "negative" }, concealed { "concealed" }, "|\n",
+ black { "black" }, red { "red" }, green { "green" },
+ yellow { "yellow" }, blue { "blue" }, magenta { "magenta" },
+ cyan { "cyan" }, white { "white" }, "|\n",
+ on_black { "on_black" }, on_red { "on_red" }, on_green { "on_green" },
+ on_yellow { "on_yellow" }, on_blue { "on_blue" },
+ on_magenta { "on_magenta" }, on_cyan { "on_cyan" },
+ on_white { "on_white" }, "|\n\n"
+
+ # Usage as Mixin into String or its Subclasses
+ class String
+ include Term::ANSIColor
+ end
+
+ print "Usage as String Mixins:".red.bold, "\n"
+ print "clear".clear, "reset".reset, "bold".bold, "dark".dark,
+ "underscore".underscore, "blink".blink, "negative".negative,
+ "concealed".concealed, "|\n",
+ "black".black, "red".red, "green".green, "yellow".yellow,
+ "blue".blue, "magenta".magenta, "cyan".cyan, "white".white, "|\n",
+ "on_black".on_black, "on_red".on_red, "on_green".on_green,
+ "on_yellow".on_yellow, "on_blue".on_blue, "on_magenta".on_magenta,
+ "on_cyan".on_cyan, "on_white".on_white, "|\n\n"
+
+ symbols = Term::ANSIColor::attributes
+ print red { bold { "All supported attributes = " } },
+ blue { symbols.inspect }, "\n\n"
+
+ print "Send symbols to strings:".send(:red).send(:bold), "\n"
+ print symbols[12, 8].map { |c| c.to_s.send(c) }, "\n\n"
+
+ print red { bold { "Make strings monochromatic again:" } }, "\n"
+ print [ "red".red, "not red anymore".red.uncolored,
+ uncolored { "not red anymore".red }, uncolored("not red anymore".red)
+ ].map { |x| x + "\n" }
19 examples/cdiff.rb
@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+## Little unix filter that colorizes diff output
+#
+
+require 'term/ansicolor'
+
+include Term::ANSIColor
+
+ARGF.each do |line|
+ print(
+ case line
+ when /^\+/ then green { line }
+ when /^-/ then red { line }
+ when /^(@@|diff)/ then blue { line }
+ else line
+ end
+ )
+end
89 examples/example.rb
@@ -0,0 +1,89 @@
+require 'term/ansicolor'
+
+# Use this trick to work around namespace cluttering that
+# happens if you just include Term::ANSIColor:
+
+class Color
+ class << self
+ include Term::ANSIColor
+ end
+end
+
+print Color.red, Color.bold, "No Namespace cluttering:", Color.clear, "\n"
+print Color.green + "green" + Color.clear, "\n"
+print Color.on_red(Color.green("green")), "\n"
+print Color.yellow { Color.on_black { "yellow on_black" } }, "\n\n"
+
+# Or shortcut Term::ANSIColor by assignment:
+c = Term::ANSIColor
+
+print c.red, c.bold, "No Namespace cluttering (alternative):", c.clear, "\n"
+print c.green + "green" + c.clear, "\n"
+print c.on_red(c.green("green")), "\n"
+print c.yellow { c.on_black { "yellow on_black" } }, "\n\n"
+
+# Anyway, I don't define any of Term::ANSIColor's methods in this example
+# and I want to keep it short:
+include Term::ANSIColor
+
+print red, bold, "Usage as constants:", reset, "\n"
+print clear, "clear", reset, reset, "reset", reset,
+ bold, "bold", reset, dark, "dark", reset,
+ underscore, "underscore", reset, blink, "blink", reset,
+ negative, "negative", reset, concealed, "concealed", reset, "|\n",
+ black, "black", reset, red, "red", reset, green, "green", reset,
+ yellow, "yellow", reset, blue, "blue", reset, magenta, "magenta", reset,
+ cyan, "cyan", reset, white, "white", reset, "|\n",
+ on_black, "on_black", reset, on_red, "on_red", reset,
+ on_green, "on_green", reset, on_yellow, "on_yellow", reset,
+ on_blue, "on_blue", reset, on_magenta, "on_magenta", reset,
+ on_cyan, "on_cyan", reset, on_white, "on_white", reset, "|\n\n"
+
+print red, bold, "Usage as unary argument methods:", reset, "\n"
+print clear("clear"), reset("reset"), bold("bold"), dark("dark"),
+ underscore("underscore"), blink("blink"), negative("negative"),
+ concealed("concealed"), "|\n",
+ black("black"), red("red"), green("green"), yellow("yellow"),
+ blue("blue"), magenta("magenta"), cyan("cyan"), white("white"), "|\n",
+ on_black("on_black"), on_red("on_red"), on_green("on_green"),#
+ on_yellow("on_yellow"), on_blue("on_blue"), on_magenta("on_magenta"),
+ on_cyan("on_cyan"), on_white("on_white"), "|\n\n"
+
+print red { bold { "Usage as block forms:" } }, "\n"
+print clear { "clear" }, reset { "reset" }, bold { "bold" },
+ dark { "dark" }, underscore { "underscore" }, blink { "blink" },
+ negative { "negative" }, concealed { "concealed" }, "|\n",
+ black { "black" }, red { "red" }, green { "green" },
+ yellow { "yellow" }, blue { "blue" }, magenta { "magenta" },
+ cyan { "cyan" }, white { "white" }, "|\n",
+ on_black { "on_black" }, on_red { "on_red" }, on_green { "on_green" },
+ on_yellow { "on_yellow" }, on_blue { "on_blue" },
+ on_magenta { "on_magenta" }, on_cyan { "on_cyan" },
+ on_white { "on_white" }, "|\n\n"
+
+# Usage as Mixin into String or its Subclasses
+class String
+ include Term::ANSIColor
+end
+
+print "Usage as String Mixins:".red.bold, "\n"
+print "clear".clear, "reset".reset, "bold".bold, "dark".dark,
+ "underscore".underscore, "blink".blink, "negative".negative,
+ "concealed".concealed, "|\n",
+ "black".black, "red".red, "green".green, "yellow".yellow,
+ "blue".blue, "magenta".magenta, "cyan".cyan, "white".white, "|\n",
+ "on_black".on_black, "on_red".on_red, "on_green".on_green,
+ "on_yellow".on_yellow, "on_blue".on_blue, "on_magenta".on_magenta,
+ "on_cyan".on_cyan, "on_white".on_white, "|\n\n"
+
+symbols = Term::ANSIColor::attributes
+print red { bold { "All supported attributes = " } },
+ blue { symbols.inspect }, "\n\n"
+
+print "Send symbols to strings:".send(:red).send(:bold), "\n"
+print symbols[12, 8].map { |c| c.to_s.send(c) }, "\n\n"
+
+print red { bold { "Make strings monochromatic again:" } }, "\n"
+print [ "red".red, "not red anymore".red.uncolored,
+ uncolored { "not red anymore".red }, uncolored("not red anymore".red)
+ ].map { |x| x + "\n" }
15 install.rb
@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'rbconfig'
+include Config
+require 'fileutils'
+include FileUtils::Verbose
+
+destdir = "#{ENV['DESTDIR']}"
+libdir = CONFIG["sitelibdir"]
+dest = destdir + File.join(libdir, 'term')
+mkdir_p dest
+install 'lib/term/ansicolor.rb', dest
+dest = destdir + File.join(libdir, 'term', 'ansicolor')
+mkdir_p dest
+install 'lib/term/ansicolor/version.rb', dest
102 lib/term/ansicolor.rb
@@ -0,0 +1,102 @@
+require 'term/ansicolor/version'
+
+module Term
+ # The ANSIColor module can be used for namespacing and mixed into your own
+ # classes.
+ module ANSIColor
+ # :stopdoc:
+ ATTRIBUTES = [
+ [ :clear , 0 ],
+ [ :reset , 0 ], # synonym for :clear
+ [ :bold , 1 ],
+ [ :dark , 2 ],
+ [ :italic , 3 ], # not widely implemented
+ [ :underline , 4 ],
+ [ :underscore , 4 ], # synonym for :underline
+ [ :blink , 5 ],
+ [ :rapid_blink , 6 ], # not widely implemented
+ [ :negative , 7 ], # no reverse because of String#reverse
+ [ :concealed , 8 ],
+ [ :strikethrough, 9 ], # not widely implemented
+ [ :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 ],
+ ]
+
+ ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
+ # :startdoc:
+
+ # Returns true, if the coloring function of this module
+ # is switched on, false otherwise.
+ def self.coloring?
+ @coloring
+ end
+
+ # Turns the coloring on or off globally, so you can easily do
+ # this for example:
+ # Term::ANSIColor::coloring = STDOUT.isatty
+ def self.coloring=(val)
+ @coloring = val
+ end
+ self.coloring = true
+
+ ATTRIBUTES.each do |c, v|
+ eval %Q{
+ def #{c}(string = nil)
+ result = ''
+ result << "\e[#{v}m" if Term::ANSIColor.coloring?
+ if block_given?
+ result << yield
+ elsif string
+ result << string
+ elsif respond_to?(:to_str)
+ result << self
+ else
+ return result #only switch on
+ end
+ result << "\e[0m" if Term::ANSIColor.coloring?
+ result
+ end
+ }
+ end
+
+ # Regular expression that is used to scan for ANSI-sequences while
+ # uncoloring strings.
+ COLORED_REGEXP = /\e\[([34][0-7]|[0-9])m/
+
+ # Returns an uncolored version of the string, that is all
+ # ANSI-sequences are stripped from the string.
+ def uncolored(string = nil) # :yields:
+ if block_given?
+ yield.gsub(COLORED_REGEXP, '')
+ elsif string
+ string.gsub(COLORED_REGEXP, '')
+ elsif respond_to?(:to_str)
+ gsub(COLORED_REGEXP, '')
+ else
+ ''
+ end
+ end
+
+ module_function
+
+ # Returns an array of all Term::ANSIColor attributes as symbols.
+ def attributes
+ ATTRIBUTE_NAMES
+ end
+ extend self
+ end
+end
0  lib/term/ansicolor/.keep
No changes.
10 lib/term/ansicolor/version.rb
@@ -0,0 +1,10 @@
+module Term
+ module ANSIColor
+ # Term::ANSIColor version
+ VERSION = '1.0.4'
+ VERSION_ARRAY = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
+ VERSION_MAJOR = VERSION_ARRAY[0] # :nodoc:
+ VERSION_MINOR = VERSION_ARRAY[1] # :nodoc:
+ VERSION_BUILD = VERSION_ARRAY[2] # :nodoc:
+ end
+end
4 make_doc.rb
@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+puts "Creating documentation."
+system "rdoc --main doc-main.txt -d doc-main.txt #{Dir['lib/**/*.rb'] * ' '}"
20 term-ansicolor.gemspec
@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+ s.name = 'term-ansicolor'
+ s.version = '1.0.4'
+ s.summary = "Ruby library that colors strings using ANSI escape sequences"
+ s.description = ""
+
+ s.files = ["CHANGES", "COPYING", "README", "Rakefile", "VERSION", "examples", "examples/cdiff.rb", "examples/example.rb", "install.rb", "lib", "lib/term", "lib/term/ansicolor", "lib/term/ansicolor.rb", "lib/term/ansicolor/version.rb", "term-ansicolor.gemspec"]
+
+ s.require_path = 'lib'
+
+ s.has_rdoc = true
+ s.extra_rdoc_files << 'doc-main.txt'
+ s.rdoc_options << '--main' << 'doc-main.txt'
+
+ s.author = "Florian Frank"
+ s.email = "flori@ping.de"
+ s.homepage = "http://term-ansicolor.rubyforge.org"
+ s.rubyforge_project = 'term-ansicolor'
+end
Please sign in to comment.
Something went wrong with that request. Please try again.