ansi 1.2.1 → 1.2.2

data/HISTORY

@@ -9,7 +9,7 @@ is mildly unconvential, but it allows the arguments to be used
 as options with common defaults more elegantly.
 
 Another important change is that ANSI::Code no longer provides
-String extension methods hwen included. For this use the new
+String extension methods when included. For this use the new
 ANSI::Mixin.
 
 Other improvements include a String extension, #ansi, added to

data/PROFILE

@@ -0,0 +1,23 @@
+--- 
+title     : ANSI
+suite     : rubyworks
+summary   : ANSI codes at your fingertips!
+copyright : Copyright (c) 2009 Thomas Sawyer
+license   : MIT
+contact   : rubyworks-mailinglist@googlegroups.com
+created   : 2004-08-01
+
+authors:
+  - Thomas Sawyer
+  - Florian Frank
+
+description:
+  ANSI codes at your fingertips!
+
+resources:
+  homepage    : http://rubyworks.github.com/ansi
+  development : http://github.com/rubyworks/ansi
+  reference   : http://rubyworks.github.com/ansi/rdoc
+  mailinglist : http://groups.google.com/group/rubyworks-mailinglist
+  repository  : git://github.com/rubyworks/ansi.git
+

data/ROADMAP

@@ -0,0 +1,11 @@
+= ROADMAP
+
+== 1.3
+
+=== Tables
+
+Consider adding something a Table class.
+
+See http://github.com/visionmedia/terminal-table
+and http://github.com/aptinio/text-table
+

data/Syckfile

@@ -16,11 +16,8 @@ gemcutter:
 
 box:
   service: Box
+  types  : [gem]
   active : true
-  types  : [gem, gz]
-  include: [bin, demo, lib, meta, plug, test, "[A-Z]*"]
-  exclude: ~
-  master : false
 
 ridoc:
   service: RIDoc

data/VERSION

@@ -0,0 +1,5 @@
+name : ansi
+major: 1
+minor: 2
+patch: 2
+date : 2010-06-11

data/eg/string_vs_block.rb

@@ -0,0 +1,9 @@
+require 'benchmark'
+require 'ansi/code'
+
+n = 50000
+Benchmark.bmbm(10) do |x|
+  x.report("string:"){ n.times{|i| ANSI::Code.red(i.to_s) } }
+  x.report("block :"){ n.times{|i| ANSI::Code.red{i.to_s} } }
+end
+

data/lib/ansi/code.rb

@@ -20,7 +20,7 @@ module ANSI
   #
   # == Supported ANSI Commands
   #
-  # The following is a list of supported codes.
+  # The following is a list of supported display codes.
   #
   #     save
   #     restore
@@ -33,7 +33,8 @@ module ANSI
   #     down
   #     left
   #     right
-  #     display
+  #
+  # The following is a list of supported "style" codes.
   #
   #     clear
   #     reset           # synonym for :clear
@@ -48,6 +49,8 @@ module ANSI
   #     concealed
   #     strikethrough   # not widely implemented
   #
+  # The following is a list of supported color codes.
+  #
   #     black
   #     red
   #     green
@@ -66,13 +69,19 @@ module ANSI
   #     on_cyan
   #     on_white
   #
+  # In addition there are color combinations like +red_on_white+.
+  #
+  # == Acknowledgement
+  #
   # This library is a partial adaptation of ANSIColor by Florian Frank.
   #
   # ANSIColor Copyright (c) 2002 Florian Frank
   #
+  # == Developer's Notes
+  #
   # TODO: Any ANSI codes left to add? Modes?
   #
-  # TODO: up, down, right, left, etc could have yielding methods too
+  # TODO: up, down, right, left, etc could have yielding methods too?
 
   module Code
     extend self
@@ -135,7 +144,7 @@ module ANSI
       module_eval <<-END, __FILE__, __LINE__
         def #{style}(string=nil)
           if string
-            warn "use ANSI block notation for future versions"
+            #warn "use ANSI block notation for future versions"
             return "\#{#{style.upcase}}\#{string}\#{CLEAR}"
           end
           if block_given?
@@ -150,11 +159,13 @@ module ANSI
       %w{black red green yellow blue magenta cyan white}
     end
 
+    # Dynamically create color methods.
+
     colors.each do |color|
       module_eval <<-END, __FILE__, __LINE__
         def #{color}(string=nil)
           if string
-            warn "use ANSI block notation for future versions"
+            #warn "use ANSI block notation for future versions"
             return "\#{#{color.upcase}}\#{string}\#{CLEAR}"
           end
           if block_given?
@@ -165,7 +176,7 @@ module ANSI
 
         def on_#{color}(string=nil)
           if string
-            warn "use ANSI block notation for future versions"
+            #warn "use ANSI block notation for future versions"
             return "\#{ON_#{color.upcase}}\#{string}\#{CLEAR}"
           end
           if block_given?
@@ -181,7 +192,11 @@ module ANSI
     colors.each do |color|
       colors.each do |on_color|
         module_eval <<-END, __FILE__, __LINE__
-          def #{color}_on_#{on_color}
+          def #{color}_on_#{on_color}(string=nil)
+            if string
+              #warn "use ANSI block notation for future versions"
+              return #{color.upcase} + ON_#{color.upcase} + string + CLEAR
+            end
             if block_given?
               #{color.upcase} + ON_#{on_color.upcase} + yield.to_s + CLEAR
             else
@@ -192,10 +207,12 @@ module ANSI
       end
     end
 
+    # Clear code.
     def clear
       CLEAR
     end
 
+    # Reset code.
     def reset
       RESET
     end
@@ -230,13 +247,22 @@ module ANSI
       CLS
     end
 
-    #--
-    #def position
-    #  "\e[#;#R"
-    #end
-    #++
+    # 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"
+      end
+      result
+    end
 
-    # Move curose to line and column.
+    # Move cursor to line and column.
     def move(line, column=0)
       "\e[#{line.to_i};#{column.to_i}H"
     end
@@ -261,52 +287,42 @@ module ANSI
       "\e[#{spaces.to_i}C"
     end
 
-    # 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"
-      end
-      result
-    end
+    ##
+    #def position
+    #  "\e[#;#R"
+    #end
 
+    # Apply ansi codes to block yield.
     #
-    def style(*codes)
+    #   style(:red, :on_white){ "Valentine" }
+    #
+    def style(*codes) #:yield:
       s = ""
       codes.each do |code|
         s << "\e[#{TABLE[code]}m"
       end
-      s << yield
+      s << yield.to_s
       s << CLEAR
     end
 
+    # Alternate term for #style.
     alias_method :color, :style
 
     #
-    def unstyle
+    def unstyle #:yield:
       if block_given?
         yield.gsub(PATTERN, '')
-      #elsif string
-      #  string.gsub(ColoredRegexp, '')
       else
         ''
       end
     end
 
+    #
     alias_method :uncolor, :unstyle
 
-    # This old term will be deprecated.
+    # DEPRECATE: This old term will be deprecated.
     def uncolered(string=nil)
-      warn "use #uncolor in block form for future version"
+      warn "ansi: use #uncolor or #unansi for future version"
       if block_given?
         yield.gsub(PATTERN, '')
       elsif string
@@ -316,6 +332,27 @@ module ANSI
       end
     end
 
+    # This method is just like #style, except it takes a string
+    # rather than a block. The primary purpose of this method
+    # is to speed up the String#ansi call.
+    #
+    #   ansi("Valentine", :red, :on_white)
+    #
+    def ansi(string, *codes)
+      s = ""
+      codes.each do |code|
+        s << "\e[#{TABLE[code]}m"
+      end
+      s << string
+      s << CLEAR
+    end
+
+    # Remove ansi codes from +string+. This method is like unstyle,
+    # but takes a string rather than a block.
+    def unansi(string)
+      string.gsub(PATTERN, '')
+    end
+
     # Regexp for matching style and color codes.
     PATTERN = /\e\[([34][0-7]|[0-9])m/
 
@@ -354,14 +391,28 @@ module ANSI
   end
 
   extend Code
-
 end
 
 #
 class String
   #
   def ansi(*codes)
-    ANSI::Code.style(*codes){ self }
+    ANSI::Code.ansi(self, *codes)
+  end
+
+  #
+  def ansi!(*codes)
+    replace(ansi(*codes))
+  end
+
+  #
+  def unansi
+    ANSI::Code.unansi(self)
+  end
+
+  #
+  def unansi!
+    replace(unansi)
   end
 end
 

data/lib/ansi/mixin.rb

@@ -107,6 +107,16 @@ module ANSI
     def white_on_magenta  ; ANSI::Code.white_on_magenta  { to_s } ; end
     def white_on_cyan     ; ANSI::Code.white_on_cyan     { to_s } ; end
 
+    # Move cursor to line and column, insert +self.to_s+ and return to
+    # original positon.
+    def display(line, column=0)
+      result = "\e[s"
+      result << "\e[#{line.to_i};#{column.to_i}H"
+      result << to_s
+      result << "\e[u"
+      result
+    end
+
   end
 
 end

data/test/test_mixin.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'ansi/mixin'
+
+class TestANSIMixin < Test::Unit::TestCase
+
+  class ::String
+    include ANSI::Mixin
+  end
+
+  def test_methods
+    str = "Hello".red + "World".blue
+    out = "\e[31mHello\e[0m\e[34mWorld\e[0m"
+    assert_equal(out, str)
+  end
+
+  def test_display
+    str = "Hello".display(4,10)
+    out = "\e[s\e[4;10HHello\e[u"
+    assert_equal(out, str)
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 2
+  version: 1.2.2
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -15,19 +15,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-10 00:00:00 -04:00
+date: 2010-06-12 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
 description: ANSI codes at your fingertips!
-email: 
+email: rubyworks-mailinglist@googlegroups.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
+- Syckfile
+- eg/string_vs_block.rb
 - lib/ansi/bbcode.rb
 - lib/ansi/code.rb
 - lib/ansi/logger.rb
@@ -40,38 +42,26 @@ files:
 - lib/ansi/terminal/win32.rb
 - lib/ansi/terminal.rb
 - lib/ansi.rb
-- meta/authors
-- meta/collection
-- meta/copyright
-- meta/created
-- meta/description
-- meta/license
-- meta/name
-- meta/released
-- meta/ruby
-- meta/sites/development
-- meta/sites/documentation
-- meta/sites/homepage
-- meta/sites/mailinglist
-- meta/sites/repository
-- meta/summary
-- meta/title
-- meta/version
 - test/test_ansicode.rb
 - test/test_bbcode.rb
+- test/test_mixin.rb
 - test/test_progressbar.rb
+- PROFILE
 - LICENSE
 - README.rdoc
 - HISTORY
-- Syckfile
+- ROADMAP
+- VERSION
 has_rdoc: true
-homepage: http://death.rubyforge.org/ansi
+homepage: http://rubyworks.github.com/ansi
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --title
 - ANSI API
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -90,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: death
+rubyforge_project: ansi
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
@@ -98,4 +88,5 @@ summary: ANSI codes at your fingertips!
 test_files: 
 - test/test_ansicode.rb
 - test/test_bbcode.rb
+- test/test_mixin.rb
 - test/test_progressbar.rb

data/meta/authors

@@ -1,2 +0,0 @@
-Thomas Sawyer
-Florian Frank

data/meta/collection

@@ -1 +0,0 @@
-death

data/meta/copyright

@@ -1 +0,0 @@
-Copyright (c) 2009 Thomas Sawyer

data/meta/created

@@ -1 +0,0 @@
-2004-08-01

data/meta/description

@@ -1 +0,0 @@
-ANSI codes at your fingertips!

data/meta/license

@@ -1 +0,0 @@
-LGPLv3

data/meta/name

@@ -1 +0,0 @@
-ansi

data/meta/released

@@ -1 +0,0 @@
-2010-05-10

data/meta/ruby

@@ -1 +0,0 @@
-1.8.7

data/meta/sites/development

@@ -1 +0,0 @@
-http://github.com/rubyworks/ansi/

data/meta/sites/documentation

@@ -1 +0,0 @@
-http://rubyworks.github.com/ansi/rdoc/

data/meta/sites/homepage

@@ -1 +0,0 @@
-http://death.rubyforge.org/ansi

data/meta/sites/mailinglist

@@ -1 +0,0 @@
-http://groups.google.com/group/rubyworks-mailinglist/

data/meta/sites/repository

@@ -1 +0,0 @@
-git://github.com/rubyworks/ansi.git

data/meta/summary

@@ -1 +0,0 @@
-ANSI codes at your fingertips!

data/meta/title

@@ -1 +0,0 @@
-ANSI

data/meta/version

@@ -1 +0,0 @@
-1.2.1