ansi 1.1.0 → 1.2.0

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2004 Thomas Sawyer
+
+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/README.rdoc

@@ -0,0 +1,85 @@
+= ANSI
+
+* http://rubyworks.github.com/ansi
+* http://github.com/rubyworks/ansi
+
+
+== 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.
+
+This collection is based on a set of scripts spun-off from
+Ruby Facets. Include are Code (used to be ANSICode), Logger,
+ProgressBar and String. In addition the library includes
+Terminal which provides information about the current output
+device.
+
+
+== FEATURES/ISSUES
+
+* ANSI::Code can be used as a mixin or for module functions.
+* ANSI::Mixin provides an alternative mixin like +colored+ gem.
+* Single extension to String class makes common usage very elegant.
+* Very Good coverage of standard ANSI codes.
+
+
+== RELEASE NOTES
+
+Please see HISTORY file.
+
+
+== SYNOPSIS
+
+There are a number of modules and classes provided by the ANSI
+package. To get a good unserstanding of them it is best to puruse 
+the QED documents[http://github.com/rubyworks/ansi/tree/master/qed/]
+or the API documentation[http://rubyworks.github.com/ansi/rdoc/].
+
+At the heart of all the provided libraries lies the ANSI::Code module
+which defines ANSI codes as constants and methods. For exmaple:
+
+  require 'ansi/code'
+
+  include ANSI::Code
+
+  red + "Hello" + blue + "World"
+  => "\e[31mHello\e[34mWorld"
+
+Or in block form.
+
+  red{ "Hello" } + blue{ "World" }
+  => "\e[31mHello\e[0m\e[34mWorld\e[0m"
+
+Rather than include +ANSI::Code+, these mehods 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.
+
+
+== HOW TO INSTALL
+
+To install with RubyGems simply open a console and type:
+
+  $ sudo gem install ansi
+
+Local installation requires Setup.rb (gem install setup),
+then download[http://github.com/rubyworks/ansi/download] the tarball package and type:
+
+  $ tar -xvzf ansi-1.0.0.tgz
+  $ cd ansi-1.0.0
+  $ sudo setup.rb all
+
+Windows users use 'ruby setup.rb all'.
+
+
+== LICENSE/COPYRIGHT
+
+Copyright (c) 2004 Thomas Sawyer
+
+This program is ditributed unser the terms of the MIT license.
+
+See LICENSE file for details.
+

data/Syckfile

@@ -0,0 +1,77 @@
+---
+email:
+  service : Email
+  file    : ~
+  subject : ~
+  mailto  : ruby-talk@ruby-lang.org
+  active  : true
+
+grancher:
+  service: grancher
+  active: true
+
+gemcutter:
+  service: GemCutter
+  active: true
+
+box:
+  service: Box
+  active : true
+  types  : [gem, gz]
+  include: [bin, demo, lib, meta, plug, test, "[A-Z]*"]
+  exclude: ~
+  master : false
+
+ridoc:
+  service: RIDoc
+  include: ~
+  exclude: ~
+  active : true
+
+rdoc:
+  service : RDoc
+  template: newfish
+  include : ~
+  exclude : [ Syckfile ]
+  active  : true
+
+syntax:
+  service  : Syntax
+  loadpath : ~
+  exclude  : ~
+  active   : false
+
+testrb:
+  service  : testrb
+  tests    : ~
+  exclude  : ~
+  loadpath : ~
+  requires : ~
+  live     : false   
+  active   : false
+
+dnote:
+  service  : DNote
+  loadpath : ~
+  labels   : ~
+  exclude  : [work]
+  output   : ~
+  format   : ~
+  active   : true
+
+stats:
+  service  : Stats
+  title    : ~
+  loadpath : ~
+  exclude  : ~
+  output   : ~
+  active   : true
+
+vclog:
+  service  : VClog
+  formats  : [json]
+  #layout   : rel    # gnu
+  typed    : false
+  output   : ~
+  active   : false
+

data/lib/ansi/code.rb

@@ -1,18 +1,9 @@
-# Ansi::Code Copyright (c) 2009 Thomas Sawyer, LGPL
-#
-# This library is a partial adaptation of ANSIColor by Florian Frank.
-#
-# ANSIColor Copyright (c) 2002 Florian Frank, LGPL
-#
-# TODO: Need to add rest of ANSI codes. Include modes?
-# TODO: Re-evaluate how color/yielding methods are defined.
-# TODO: Maybe up, down, right, left should have yielding methods too?
+require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
 
-#
 module ANSI
 
-  # Currently Windows is not supported.
-  SUPPORTED = !(RUBY_PLATFORM =~ /win/)
+  # deprecate
+  SUPPORTED = true
 
   # = ANSI Codes
   #
@@ -21,10 +12,10 @@ module ANSI
   #
   #   include Ansi::Code
   #
-  #   p red, "Hello", blue, "World"
+  #   red + "Hello" + blue + "World"
   #   => "\e[31mHello\e[34mWorld"
   #
-  #   p red { "Hello" } + blue { "World" }
+  #   red { "Hello" } + blue { "World" }
   #   => "\e[31mHello\e[0m\e[34mWorld\e[0m"
   #
   # == Supported ANSI Commands
@@ -75,31 +66,169 @@ module ANSI
   #     on_cyan
   #     on_white
   #
-  module Code
+  # This library is a partial adaptation of ANSIColor by Florian Frank.
+  #
+  # ANSIColor Copyright (c) 2002 Florian Frank
+  #
+  # TODO: Any ANSI codes left to add? Modes?
+  #
+  # TODO: up, down, right, left, etc could have yielding methods too
 
+  module Code
     extend self
 
+    CLEAR      = "\e[0m"
+    RESET      = "\e[0m"
+    BOLD       = "\e[1m"
+    DARK       = "\e[2m"
+    ITALIC     = "\e[3m"  # not widely implemented
+    UNDERLINE  = "\e[4m"
+    UNDERSCORE = "\e[4m"
+    BLINK      = "\e[5m"
+    RAPID      = "\e[6m"  # not widely implemented
+    REVERSE    = "\e[7m"
+    NEGATIVE   = "\e[7m"  # alternate to reverse because of String#reverse
+    CONCEALED  = "\e[8m"
+    STRIKE     = "\e[9m"  # not widely implemented
+
+    BLACK      = "\e[30m"
+    RED        = "\e[31m"
+    GREEN      = "\e[32m"
+    YELLOW     = "\e[33m"
+    BLUE       = "\e[34m"
+    MAGENTA    = "\e[35m"
+    CYAN       = "\e[36m"
+    WHITE      = "\e[37m"
+
+    ON_BLACK   = "\e[40m"
+    ON_RED     = "\e[41m"
+    ON_GREEN   = "\e[42m"
+    ON_YELLOW  = "\e[43m"
+    ON_BLUE    = "\e[44m"
+    ON_MAGENTA = "\e[45m"
+    ON_CYAN    = "\e[46m"
+    ON_WHITE   = "\e[47m"
+
+    # Save current cursor positon.
+    SAVE       = "\e[s"
+
+    # Restore saved cursor positon.
+    RESTORE    = "\e[u"
+
+    # Clear to the end of the current line.
+    CLEAR_LINE = "\e[K"
+
+    # Clear to the end of the current line.
+    CLR        = "\e[K"
+
+    # Clear the screen and move cursor to home.
+    CLEAR_SCREEN = "\e[2J"
+
+    # Clear the screen and move cursor to home.
+    CLS          = "\e[2J"
+
+    def self.styles
+      %w{bold dark italic underline underscore blink rapid reverse negative concealed strike}
+    end
+
+    styles.each do |style|
+      module_eval <<-END, __FILE__, __LINE__
+        def #{style}(string=nil)
+          if string
+            warn "use ANSI block notation for future versions"
+            return "\#{#{style.upcase}}\#{string}\#{CLEAR}"
+          end
+          if block_given?
+            return "\#{#{style.upcase}}\#{yield}\#{CLEAR}"
+          end
+          #{style.upcase}
+        end
+      END
+    end
+
+    def self.colors
+      %w{black red green yellow blue magenta cyan white}
+    end
+
+    colors.each do |color|
+      module_eval <<-END, __FILE__, __LINE__
+        def #{color}(string=nil)
+          if string
+            warn "use ANSI block notation for future versions"
+            return "\#{#{color.upcase}}\#{string}\#{CLEAR}"
+          end
+          if block_given?
+            return "\#{#{color.upcase}}\#{yield}\#{CLEAR}"
+          end
+          #{color.upcase}
+        end
+
+        def on_#{color}(string=nil)
+          if string
+            warn "use ANSI block notation for future versions"
+            return "\#{ON_#{color.upcase}}\#{string}\#{CLEAR}"
+          end
+          if block_given?
+            return "\#{ON_#{color.upcase}}\#{yield}\#{CLEAR}"
+          end
+          ON_#{color.upcase}
+        end
+      END
+    end
+
+    # Dynamically create color on color methods.
+
+    colors.each do |color|
+      colors.each do |on_color|
+        module_eval <<-END, __FILE__, __LINE__
+          def #{color}_on_#{on_color}
+            if block_given?
+              #{color.upcase} + ON_#{on_color.upcase} + yield.to_s + CLEAR
+            else
+              #{color.upcase} + ON_#{on_color.upcase}
+            end
+          end
+        END
+      end
+    end
+
+    def clear
+      CLEAR
+    end
+
+    def reset
+      RESET
+    end
+
     # Save current cursor positon.
     def save
-      "\e[s"
+      SAVE
     end
 
     # Restore saved cursor positon.
     def restore
-      "\e[u"
+      RESTORE
+    end
+
+    # Clear to the end of the current line.
+    def clear_line
+      CLEAR_LINE
+    end
+
+    # Clear to the end of the current line.
+    def clr
+      CLR
     end
 
     # Clear the screen and move cursor to home.
     def clear_screen
-      "\e[2J"
+      CLEAR_SCREEN
     end
-    alias_method :cls, :clear_screen
 
-    # Clear to the end of the current line.
-    def clear_line
-      "\e[K"
+    # Clear the screen and move cursor to home.
+    def cls
+      CLS
     end
-    alias_method :clr, :clear_line
 
     #--
     #def position
@@ -108,126 +237,131 @@ module ANSI
     #++
 
     # Move curose to line and column.
-    def move( line, column=0 )
+    def move(line, column=0)
       "\e[#{line.to_i};#{column.to_i}H"
     end
 
     # Move cursor up a specificed number of spaces.
-    def up( spaces=1 )
+    def up(spaces=1)
       "\e[#{spaces.to_i}A"
     end
 
     # Move cursor down a specificed number of spaces.
-    def down( spaces=1 )
+    def down(spaces=1)
       "\e[#{spaces.to_i}B"
     end
 
     # Move cursor left a specificed number of spaces.
-    def left( spaces=1 )
+    def left(spaces=1)
       "\e[#{spaces.to_i}D"
     end
 
     # Move cursor right a specificed number of spaces.
-    def right( spaces=1 )
+    def right(spaces=1)
       "\e[#{spaces.to_i}C"
     end
 
-    # Like +move+ but returns to original positon
-    # after yielding block or adding string argument.
-    def display( line, column=0, string=nil ) #:yield:
+    # Like +move+ but returns to original positon after
+    # yielding the block.
+    def display(line, column=0) #:yield:
       result = "\e[s"
       result << "\e[#{line.to_i};#{column.to_i}H"
       if block_given?
         result << yield
         result << "\e[u"
-      elsif string
-        result << string
-        result << "\e[u"
-      elsif respond_to?(:to_str)
-        result << self
-        result << "\e[u"
+      #elsif string
+      #  result << string
+      #  result << "\e[u"
+      #elsif respond_to?(:to_str)
+      #  result << self
+      #  result << "\e[u"
       end
-      return result
+      result
     end
 
-    # Define color codes.
-    def self.define_ansicolor_method(name,code)
-      class_eval <<-HERE
-        def #{name.to_s}(string = nil)
-            result = "\e[#{code}m"
-            if block_given?
-                result << yield
-                result << "\e[0m"
-            elsif string
-                result << string
-                result << "\e[0m"
-            elsif respond_to?(:to_str)
-                result << self
-                result << "\e[0m"
-            end
-            return result
-        end
-      HERE
-    end
-
-    @@colors = [
-      [ :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 ],
-    ]
-
-    @@colors.each do |c, v|
-      define_ansicolor_method(c, v)
-    end
-
-    ColoredRegexp = /\e\[([34][0-7]|[0-9])m/
-
-    module_function
+    #
+    def style(*codes)
+      s = ""
+      codes.each do |code|
+        s << "\e[#{TABLE[code]}m"
+      end
+      s << yield
+      s << CLEAR
+    end
+
+    alias_method :color, :style
 
     #
-    def uncolored(string = nil)
+    def unstyle
       if block_given?
-        yield.gsub(ColoredRegexp, '')
-      elsif string
-        string.gsub(ColoredRegexp, '')
-      elsif respond_to?(:to_str)
-        gsub(ColoredRegexp, '')
+        yield.gsub(PATTERN, '')
+      #elsif string
+      #  string.gsub(ColoredRegexp, '')
       else
         ''
       end
     end
 
-    #
-    def colors
-      @@colors.map { |c| c[0] }
+    alias_method :uncolor, :unstyle
+
+    # This old term will be deprecated.
+    def uncolered(string=nil)
+      warn "use #uncolor in block form for future version"
+      if block_given?
+        yield.gsub(PATTERN, '')
+      elsif string
+        string.gsub(PATTERN, '')
+      else
+        ''
+      end
     end
 
+    # Regexp for matching style and color codes.
+    PATTERN = /\e\[([34][0-7]|[0-9])m/
+
+    # Table of style and color codes.
+    TABLE = {
+      :clear        =>   0,
+      :reset        =>   0,
+      :bold         =>   1,
+      :dark         =>   2,
+      :italic       =>   3,
+      :underline    =>   4,
+      :underscore   =>   4,
+      :blink        =>   5,
+      :rapid        =>   6,
+      :reverse      =>   7,
+      :negative     =>   7,
+      :concealed    =>   8,
+      :strike       =>   9,
+      :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
+    }
   end
 
+  extend Code
+
+end
+
+#
+class String
+  #
+  def ansi(*codes)
+    ANSI::Code.style(*codes){ self }
+  end
 end