term-ansicolor 0.0.4 → 1.0.0

data/CHANGES

@@ -1,3 +1,7 @@
+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

data/README.en

@@ -5,12 +5,15 @@ Just type into the command line as root:
 
 # ruby install.rb
 
+Or if you prefer using Rake, try:
+
+# rake install
+
 Documentation
 =============
 
 Look into examples/example.rb to get an idea how this library is used.
 
-
 Author
 ======
 

data/Rakefile

@@ -8,65 +8,74 @@ include Config
 PKG_NAME = 'term-ansicolor'
 PKG_VERSION = File.read('VERSION').chomp
 PKG_FILES = Dir.glob("**/*").delete_if { |item|
-    item.include?("CVS") or item.include?("pkg")
+  item.include?("CVS") or item.include?("pkg")
 }
 
 desc "Installing library"
 task :install  do
-    libdir = CONFIG["sitelibdir"]
-    dest = File.join(libdir, 'term')
-    install('lib/term/ansicolor.rb', dest)
+  libdir = CONFIG["sitelibdir"]
+  dest = File.join(libdir, 'term')
+  install('lib/term/ansicolor.rb', dest)
 end
 
-spec = Gem::Specification.new do |s|
+desc "Making rdoc documentation"
+task :doc do
+  load "make_doc.rb"
+end
+
+task :clean do
+	rm_r 'doc'
+end
 
-    #### Basic information.
+spec = Gem::Specification.new do |s|
+	#### Basic information.
 
-    s.name = 'term-ansicolor'
-    s.version = PKG_VERSION
-    s.summary = "Ruby library that colors strings using ANSI escape sequences"
-    s.description = ""
+	s.name = 'term-ansicolor'
+	s.version = PKG_VERSION
+	s.summary = "Ruby library that colors strings using ANSI escape sequences"
+	s.description = ""
 
-    #### Dependencies and requirements.
+	#### Dependencies and requirements.
 
-    #s.add_dependency('log4r', '> 1.0.4')
-    #s.requirements << ""
+	#s.add_dependency('log4r', '> 1.0.4')
+	#s.requirements << ""
 
-    s.files = PKG_FILES
+	s.files = PKG_FILES
 
-    #### C code extensions.
+	#### C code extensions.
 
-    #s.extensions << "ext/extconf.rb"
+	#s.extensions << "ext/extconf.rb"
 
-    #### Load-time details: library and application (you will need one or both).
+	#### Load-time details: library and application (you will need one or both).
 
-    s.require_path = 'lib'                         # Use these for libraries.
-    #s.autorequire = 'term/ansicolor'
+	s.require_path = 'lib'                         # Use these for libraries.
+	s.autorequire = 'term/ansicolor'
 
-    #s.bindir = "bin"                               # Use these for applications.
-    #s.executables = ["bla.rb"]
-    #s.default_executable = "bla.rb"
+	#s.bindir = "bin"                               # Use these for applications.
+	#s.executables = ["bla.rb"]
+	#s.default_executable = "bla.rb"
 
-    #### Documentation and testing.
+	#### Documentation and testing.
 
-    s.has_rdoc = false
-    #s.has_rdoc = true
-    #s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-    #s.rdoc_options <<
-    #  '--title' <<  'Rake -- Ruby Make' <<
-    #  '--main' << 'README' <<
-    #  '--line-numbers'
+	#s.has_rdoc = true
+	#s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+	#s.rdoc_options <<
+	#	'--title' <<  'Term::ANSIColor -- ANSI color escape sequences' <<
+	# '--main' << 'README' <<
+	#	'--line-numbers'
 
-    #### Author and project details.
+	#### Author and project details.
 
-    s.author = "Florian Frank"
-    s.email = "flori@ping.de"
-    s.homepage = "http://term-ansicolor.rubyforge.org"
-    s.rubyforge_project = "term-ansicolor"
+	s.author = "Florian Frank"
+	s.email = "flori@ping.de"
+	s.homepage = "http://term-ansicolor.rubyforge.org"
+	s.rubyforge_project = "term-ansicolor"
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_tar = true
-    pkg.package_files += PKG_FILES
+  pkg.need_tar = true
+  pkg.package_files += PKG_FILES
 end
-    # vim: set et sw=4 ts=4:
+
+task :release => :package
+    # vim: set noet sw=2 ts=2:

data/VERSION

@@ -1 +1 @@
-0.0.4
+1.0.0

data/examples/example.rb

@@ -14,6 +14,14 @@ 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
@@ -31,7 +39,7 @@ print clear, "clear", reset, reset, "reset", 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 functions:", reset, "\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",

data/lib/term/ansicolor.rb

@@ -1,78 +1,95 @@
 module Term
+  module ANSIColor
+    @@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 ], 
+    ]
 
-module ANSIColor
+    # Returns true, if the coloring function of this module
+    # is switched on, false otherwise.
+    def self.coloring?
+      @@coloring
+    end
 
-  @@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 ], 
-  ]
+    # 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.to_s}(string = nil)
-            result = "\e[#{v}m"
+    @@attributes.each do |c, v|
+      eval %Q{
+          def #{c}(string = nil)
+            result = ''
+            result << "\e[#{v}m" if @@coloring 
             if block_given?
-                result << yield
-                result << "\e[0m"
+              result << yield
             elsif string
-                result << string
-                result << "\e[0m"
+              result << string
             elsif respond_to?(:to_str)
-                result << self
-                result << "\e[0m"
+              result << self
+            else
+              return result #only switch on
             end
-            return result
-        end
-    }
-  end
+            result << "\e[0m" if @@coloring
+            result
+          end
+      }
+    end
 
-  ColoredRegexp = /\e\[([34][0-7]|[0-9])m/
+    # Regular expression that is used to scan for ANSI-sequences. It is used to
+    # uncolor strins.
+    COLORED_REGEXP = /\e\[([34][0-7]|[0-9])m/
 
-  def uncolored(string = nil)
-    if block_given?
-      yield.gsub(ColoredRegexp, '')
-    elsif string
-      string.gsub(ColoredRegexp, '')
-    elsif respond_to?(:to_str)
-      gsub(ColoredRegexp, '')
-    else
-      ''
+    # 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
-  end
 
-  module_function
-    
-  def attributes
-    @@attributes.map { |c| c[0] }
-  end
-    
-end
+    module_function
 
+    # Returns an array of all Term::ANSIColor attributes as symbols.
+    def attributes
+      @@attributes.map { |c| c.first }
+    end
+    extend self
+  end
 end
     # vim: set et sw=2 ts=2:

metadata

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.1
+rubygems_version: 0.8.10
 specification_version: 1
 name: term-ansicolor
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2004-09-29
+  version: 1.0.0
+date: 2005-04-15
 summary: Ruby library that colors strings using ANSI escape sequences
 require_paths: 
   - lib
-author: Florian Frank
 email: flori@ping.de
 homepage: http://term-ansicolor.rubyforge.org
 rubyforge_project: term-ansicolor
 description: ''
-autorequire: 
+autorequire: term/ansicolor
 default_executable: 
 bindir: bin
 has_rdoc: false
@@ -25,8 +24,12 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version: 
 platform: ruby
+authors: 
+  - Florian Frank
 files: 
   - examples
+  - examples/cdiff.rb
+  - examples/example.rb
   - CHANGES
   - GPL
   - README.en
@@ -34,8 +37,6 @@ files:
   - VERSION
   - install.rb
   - lib
-  - examples/cdiff.rb
-  - examples/example.rb
   - lib/term
   - lib/term/ansicolor.rb
 test_files: []