term-ansicolor 1.0.4 → 1.0.5

data/CHANGES

@@ -1,3 +1,9 @@
+2010-03-10 - 1.0.5 * Added cdiff example as an executable.
+                   * Disabled building of gemspec file.
+                   * Made an decolor executable, that removes colors from an io
+                     stream.
+                   * Match an additional way to clear the color in the
+                     COLORED_REGEXP for the uncolored method.
 2009-07-23 - 1.0.4 * Some cleanup.
                    * Build a gemspec file.
 2007-10-05 - 1.0.3 * Better documentation + some code clean up.

data/README

@@ -1,5 +1,10 @@
-Installation
-============
+== ANSI escape sequences in Ruby
+
+=== Description
+
+This library can be used to color/decolor strings using ANSI escape sequences.
+
+=== Installation
 
 Just type into the command line as root:
 
@@ -14,18 +19,119 @@ installs it for you:
 
 # gem install term-ansicolor
 
-Documentation
-=============
+=== Download
+
+The latest version of this library can be downloaded at
+
+* http://www.ping.de/~flori
+
+The homepage of this library is located at
+
+* http://flori.github.com/term-ansicolor
+
+=== Examples
+
+Additional to the two executables cdiff and decolor, 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
+      extend Term::ANSIColor
+    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"
 
-Look into examples/example.rb to get an idea how this library is used.
+    print "Send symbols to strings:".send(:red).send(:bold), "\n"
+    print symbols[12, 8].map { |c| c.to_s.send(c) }, "\n\n"
 
-Author
-======
+    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" }
 
-Florian Frank <flori@ping.de>
+=== Author
 
-License
-=======
+Florian Frank mailto:flori@ping.de
 
-GNU General Public License (GPL)
+=== 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

data/Rakefile

@@ -23,37 +23,28 @@ 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 = ""
+  spec = 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.files = PKG_FILES.to_a.sort
 
-  s.require_path = 'lib'
+    s.require_path = 'lib'
 
-  s.has_rdoc = true
-  s.extra_rdoc_files << 'doc-main.txt'
-  s.rdoc_options << '--main' <<  'doc-main.txt'
+    s.has_rdoc = true
+    s.extra_rdoc_files << 'README'
+    s.executables << 'cdiff' << 'decolor'
+    s.rdoc_options << '--main' <<  'README' << '--title' << 'Term::ANSIColor'
+    s.test_files = Dir['tests/*.rb']
 
-  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
+    s.author = "Florian Frank"
+    s.email = "flori@ping.de"
+    s.homepage = "http://flori.github.com/#{PKG_NAME}"
+    s.rubyforge_project = PKG_NAME
   end
 
-  spec = eval(spec_src)
   Rake::GemPackageTask.new(spec) do |pkg|
     pkg.need_tar = true
     pkg.package_files += PKG_FILES
@@ -79,8 +70,19 @@ EOT
   end
 end
 
+desc "Run tests"
+task :tests do
+  sh 'testrb -Ilib tests/*.rb'
+end
+task :test => :tests
+
+desc "Run tests with coverage"
+task :coverage do
+  sh 'rcov -Ilib tests/*.rb'
+end
+
 desc "Default"
-task :default => [ :version, :gemspec ]
+task :default => [ :version ]
 
 desc "Prepare a release"
-task :release => [ :clean, :version, :gemspec, :package ]
+task :release => [ :clean, :version, :package ]

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.0.5

data/{examples/cdiff.rb → bin/cdiff}

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-## Little unix filter that colorizes diff output
+## Little unix filter that colorizes diff output.
 #
 
 require 'term/ansicolor'
@@ -8,7 +8,7 @@ require 'term/ansicolor'
 include Term::ANSIColor
 
 ARGF.each do |line|
-  print(
+  STDOUT.print(
     case line
     when /^\+/ then green { line }
     when /^-/ then red { line }

data/bin/decolor

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+#
+## Little unix filter that uncolorizes any input stream.
+#
+
+require 'term/ansicolor'
+
+include Term::ANSIColor
+
+ARGF.each do |line|
+  puts line.uncolored
+end

data/examples/example.rb

@@ -4,9 +4,7 @@ require 'term/ansicolor'
 # happens if you just include Term::ANSIColor:
 
 class Color
-  class << self
-    include Term::ANSIColor
-  end
+  extend Term::ANSIColor
 end
 
 print Color.red, Color.bold, "No Namespace cluttering:", Color.clear, "\n"
@@ -84,6 +82,9 @@ 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" }
+print [
+    "red".red,
+    "not red anymore".red.uncolored,
+    uncolored { "not red anymore".red },
+    uncolored("not red anymore".red)
+  ].map { |x| x + "\n" }

data/lib/term/ansicolor.rb

@@ -63,7 +63,7 @@ module Term
             elsif string
               result << string
             elsif respond_to?(:to_str)
-              result << self
+              result << to_str
             else
               return result #only switch on
             end
@@ -75,7 +75,7 @@ module Term
 
     # Regular expression that is used to scan for ANSI-sequences while
     # uncoloring strings.
-    COLORED_REGEXP = /\e\[([34][0-7]|[0-9])m/
+    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.
@@ -85,7 +85,7 @@ module Term
       elsif string
         string.gsub(COLORED_REGEXP, '')
       elsif respond_to?(:to_str)
-        gsub(COLORED_REGEXP, '')
+        to_str.gsub(COLORED_REGEXP, '')
       else
         ''
       end

data/lib/term/ansicolor/version.rb

@@ -1,7 +1,7 @@
 module Term
   module ANSIColor
     # Term::ANSIColor version
-    VERSION         = '1.0.4'
+    VERSION         = '1.0.5'
     VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
     VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
     VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/tests/ansicolor_test.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'term/ansicolor'
+
+class String
+  include Term::ANSIColor
+end
+
+class Color
+  extend Term::ANSIColor
+end
+
+class ANSIColorTest < Test::Unit::TestCase
+  include Term::ANSIColor
+
+  def setup
+    @string = "red"
+    @string_red = "\e[31mred\e[0m"
+    @string_red_on_green = "\e[42m\e[31mred\e[0m\e[0m"
+  end
+
+  attr_reader :string, :string_red, :string_red_on_green
+
+  def test_red
+    assert_equal string_red, string.red
+    assert_equal string_red, Color.red(string)
+    assert_equal string_red, Color.red { string }
+    assert_equal string_red, Term::ANSIColor.red { string }
+    assert_equal string_red, red { string }
+  end
+
+  def test_red_on_green
+    assert_equal string_red_on_green, string.red.on_green
+    assert_equal string_red_on_green, Color.on_green(Color.red(string))
+    assert_equal string_red_on_green, Color.on_green { Color.red { string } }
+    assert_equal string_red_on_green,
+      Term::ANSIColor.on_green { Term::ANSIColor.red { string } }
+    assert_equal string_red_on_green, on_green { red { string } }
+  end
+
+
+  def test_uncolored
+    assert_equal string, string_red.uncolored
+    assert_equal string, Color.uncolored(string_red)
+    assert_equal string, Color.uncolored { string_red }
+    assert_equal string, Term::ANSIColor.uncolored { string_red }
+    assert_equal string, uncolored { string }
+  end
+
+  def test_attributes
+    foo = 'foo'
+    for (a, _) in Term::ANSIColor.attributes
+      assert_not_equal foo, foo_colored = foo.__send__(a)
+      assert_equal foo, foo_colored.uncolored
+      assert_not_equal foo, foo_colored = Color.__send__(a, foo)
+      assert_equal foo, Color.uncolored(foo_colored)
+      assert_not_equal foo, foo_colored = Color.__send__(a) { foo }
+      assert_equal foo, Color.uncolored { foo_colored }
+      assert_not_equal foo, foo_colored = Term::ANSIColor.__send__(a) { foo }
+      assert_equal foo, Term::ANSIColor.uncolored { foo_colored }
+      assert_not_equal foo, foo_colored = __send__(a) { foo }
+      assert_equal foo, uncolored { foo }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: term-ansicolor
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Florian Frank
@@ -9,39 +9,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-23 00:00:00 +02:00
+date: 2010-03-12 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
 description: ""
 email: flori@ping.de
-executables: []
-
+executables: 
+- cdiff
+- decolor
 extensions: []
 
 extra_rdoc_files: 
-- doc-main.txt
+- README
 files: 
 - CHANGES
 - COPYING
 - README
 - Rakefile
 - VERSION
-- examples/cdiff.rb
+- bin/cdiff
+- bin/decolor
 - examples/example.rb
 - install.rb
 - lib/term/ansicolor.rb
 - lib/term/ansicolor/version.rb
-- term-ansicolor.gemspec
-- doc-main.txt
+- tests/ansicolor_test.rb
 has_rdoc: true
-homepage: http://term-ansicolor.rubyforge.org
+homepage: http://flori.github.com/term-ansicolor
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- doc-main.txt
+- README
+- --title
+- Term::ANSIColor
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -59,9 +62,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: term-ansicolor
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby library that colors strings using ANSI escape sequences
-test_files: []
-
+test_files: 
+- tests/ansicolor_test.rb

data/doc-main.txt

@@ -1,119 +0,0 @@
-== 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" }

data/term-ansicolor.gemspec

@@ -1,20 +0,0 @@
-# -*- 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