term-ansicolor 1.0.2 → 1.0.3

data/CHANGES

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

data/Rakefile

@@ -26,43 +26,20 @@ task :clean do
 end
 
 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 = ""
 
-  #### Dependencies and requirements.
-
-  #s.add_dependency('log4r', '> 1.0.4')
-  #s.requirements << ""
-
   s.files = PKG_FILES
 
-  #### C code extensions.
-
-  #s.extensions << "ext/extconf.rb"
-
-  #### 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.bindir = "bin"                               # Use these for applications.
-  #s.executables = ["bla.rb"]
-  #s.default_executable = "bla.rb"
-
-  #### Documentation and testing.
-
-  #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.
+  s.has_rdoc = true
+  s.rdoc_options <<
+      '--title' <<  'Term::ANSIColor' <<
+      '--inline-source' <<
+      '--line-numbers'
 
   s.author = "Florian Frank"
   s.email = "flori@ping.de"

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/install.rb

@@ -5,9 +5,9 @@ include Config
 require 'fileutils'
 include FileUtils::Verbose
 
-destdir = "#{ENV["DESTDIR"]}"
+destdir = "#{ENV['DESTDIR']}"
 libdir = CONFIG["sitelibdir"]
 dest = destdir + File.join(libdir, 'term')
 mkdir_p dest
-install('lib/term/ansicolor.rb', dest)
+install 'lib/term/ansicolor.rb', dest
   # vim: set et sw=2 ts=2:

data/lib/term/ansicolor.rb

@@ -1,6 +1,128 @@
+# = 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" }
 module Term
+  # The ANSIColor module can be used for namespacing and mixed into your own
+  # classes.
   module ANSIColor
-    @@attributes = [
+    # :stopdoc:
+    ATTRIBUTES = [
       [ :clear        ,   0 ], 
       [ :reset        ,   0 ],     # synonym for :clear
       [ :bold         ,   1 ], 
@@ -31,25 +153,28 @@ module Term
       [ :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
+      @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
+      @coloring = val
     end
     self.coloring = true
 
-    @@attributes.each do |c, v|
+    ATTRIBUTES.each do |c, v|
       eval %Q{
           def #{c}(string = nil)
             result = ''
-            result << "\e[#{v}m" if @@coloring 
+            result << "\e[#{v}m" if Term::ANSIColor.coloring?
             if block_given?
               result << yield
             elsif string
@@ -59,14 +184,14 @@ module Term
             else
               return result #only switch on
             end
-            result << "\e[0m" if @@coloring
+            result << "\e[0m" if Term::ANSIColor.coloring?
             result
           end
       }
     end
 
-    # Regular expression that is used to scan for ANSI-sequences. It is used to
-    # uncolor strins.
+    # 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
@@ -87,7 +212,7 @@ module Term
 
     # Returns an array of all Term::ANSIColor attributes as symbols.
     def attributes
-      @@attributes.map { |c| c.first }
+      ATTRIBUTE_NAMES
     end
     extend self
   end

data/make_doc.rb

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-$outdir = 'doc/'
-puts "Creating documentation in '#$outdir'."
-system "rdoc -d -o #$outdir lib/term/ansicolor.rb"
-    # vim: set et sw=4 ts=4:
+puts "Creating documentation."
+system "rdoc --line-numbers --inline-source --title Term::ANSIColor -d #{Dir['lib/**/*.rb'] * ' '}"
+  # vim: set et sw=2 ts=2:

metadata

@@ -1,51 +1,61 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.4
 specification_version: 1
 name: term-ansicolor
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2005-11-12 00:00:00 +01:00
+  version: 1.0.3
+date: 2007-10-05 00:00:00 +02:00
 summary: Ruby library that colors strings using ANSI escape sequences
 require_paths: 
-  - lib
+- lib
 email: flori@ping.de
 homepage: http://term-ansicolor.rubyforge.org
 rubyforge_project: term-ansicolor
-description: ''
-autorequire: term/ansicolor
+description: ""
+autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
-  - Florian Frank
+- Florian Frank
 files: 
-  - examples
-  - install.rb
-  - GPL
-  - Rakefile
-  - VERSION
-  - CHANGES
-  - lib
-  - make_doc.rb
-  - README.en
-  - examples/example.rb
-  - examples/cdiff.rb
-  - lib/term
-  - lib/term/ansicolor.rb
+- install.rb
+- lib
+- make_doc.rb
+- CHANGES
+- README.en
+- VERSION
+- Rakefile
+- GPL
+- examples
+- lib/term
+- lib/term/ansicolor.rb
+- examples/cdiff.rb
+- examples/example.rb
 test_files: []
-rdoc_options: []
+
+rdoc_options: 
+- --title
+- Term::ANSIColor
+- --inline-source
+- --line-numbers
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+