ansi 1.0.1 → 1.1.0

data/{LICENSE → COPYING}

@@ -164,7 +164,7 @@ apply, that proxy's public statement of acceptance of any version is
 permanent authorization for you to choose that version for the
 Library.
 
------------------------------------------------------------------------
+----
 
 = GNU GENERAL PUBLIC LICENSE
 

data/MANIFEST

@@ -1,23 +1,21 @@
-HISTORY
-LICENSE
-MANIFEST
-README
+#!mast bin demo lib meta test [A-Z]*
 demo
 demo/logger.rd
 demo/progressbar.rd
 lib
 lib/ansi
-lib/ansi.rb
+lib/ansi/bbcode.rb
 lib/ansi/code.rb
 lib/ansi/logger.rb
 lib/ansi/progressbar.rb
 lib/ansi/string.rb
 lib/ansi/terminal
-lib/ansi/terminal.rb
 lib/ansi/terminal/curses.rb
 lib/ansi/terminal/stty.rb
 lib/ansi/terminal/termios.rb
 lib/ansi/terminal/win32.rb
+lib/ansi/terminal.rb
+lib/ansi.rb
 meta
 meta/abstract
 meta/authors
@@ -34,4 +32,8 @@ meta/title
 meta/version
 test
 test/test_ansicode.rb
-test/test_progressbar.rb
+test/test_bbcode.rb
+test/test_progressbar.rb
+README
+HISTORY
+COPYING

data/README

@@ -1,7 +1,7 @@
 = ANSI
 
-* http://death.rubyforge.org
-* http://death.rubyforge.org/ansi
+* http://rubyworks.github.com/ansi
+* http://github.com/rubyworks/ansi
 
 
 == DESCRIPTION

data/lib/ansi/bbcode.rb

@@ -0,0 +1,339 @@
+# = BBCode
+#
+# Copyright (c) 2002 Thomas-Ivo Heinen
+#
+# This module is free software. You may use, modify, and/or redistribute this
+# software under the same terms as Ruby.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.
+
+module ANSI
+
+  # = BBCode
+  #
+  # The BBCode module helps ease the separation of core and frontend with the
+  # core (or submodules) being still able to say, what colors shall be used
+  # in it's responses. This is achieved by encoding formatting information
+  # using the BBCode tokens. This enables you to "pipe" layout information
+  # such as colors, style, fonttype, size and alignment through the core to
+  # the frontend.
+  #
+  # Additionally it converts markups/codes between ANSI, HTML and BBCode
+  # almost freely ;)
+  #
+  # == Usage
+  #
+  #   # Converting a bbcode string to ANSI and XHTML
+  #
+  #   str = "this is [COLOR=red]red[/COLOR], this is [B]bold[/B]"
+  #   print( BBCode.bbcode_to_ansi(str) )
+  #   print( BBCode.bbcode_to_html(str) )
+  #
+  module BBCode
+
+    ## ANSIname => ANSIcode LUT
+    ANSINAME2CODE= {  "reset"     => "\e[0m",    "bold"       => "\e[1m",
+                      "underline" => "\e[4m",    "blink"      => "\e[5m",
+                      "reverse"   => "\e[7m",    "invisible"  => "\e[8m",
+                      "black"     => "\e[0;30m", "darkgrey"   => "\e[1;30m",
+                      "red"       => "\e[0;31m", "lightred"   => "\e[1;31m",
+                      "green"     => "\e[0;32m", "lightgreen" => "\e[1;32m",
+                      "brown"     => "\e[0;33m", "yellow"     => "\e[1;33m",
+                      "blue"      => "\e[0;34m", "lightblue"  => "\e[1;34m",
+                      "purple"    => "\e[0;35m", "magenta"    => "\e[1;35m",
+                      "cyan"      => "\e[1;36m", "lightcyan"  => "\e[1;36m",
+                      "grey"      => "\e[0;37m", "white"      => "\e[1;37m",
+                      "bgblack"   => "\e[40m",   "bgred"      => "\e[41m",
+                      "bggreen"   => "\e[42m",   "bgyellow"   => "\e[43m",
+                      "bgblue"    => "\e[44m",   "bgmagenta"  => "\e[45m",
+                      "bgcyan"    => "\e[46m",   "bgwhite"    => "\e[47m"
+                    }
+
+    ## BBColor => ANSIname LUT
+    BBCOLOR2ANSI  = { "skyblue"   => "blue",     "royalblue" => "blue",
+                      "blue"      => "blue",     "darkblue"  => "blue",
+                      "orange"    => "red",      "orangered" => "red",
+                      "crimson"   => "red",      "red"       => "lightred",
+                      "firebrick" => "red",      "darkred"   => "red",
+                      "green"     => "green",    "limegreen" => "green",
+                      "seagreen"  => "green",    "darkgreen" => "green",
+                      "deeppink"  => "magenta",  "tomato"    => "red",
+                      "coral"     => "cyan",     "purple"    => "purple",
+                      "indigo"    => "blue",     "burlywood" => "red",
+                      "sandybrown"=> "red",      "sierra"    => "sierra",
+                      "chocolate" => "brown",    "teal"      => "teal",
+                      "silver"    => "white",
+                      "black"     => "black",    "yellow"    => "yellow",
+                      "magenta"   => "magenta",  "cyan"      => "cyan",
+                      "white"     => "white"
+                    }
+
+    ## ANSInames => BBCode LUT
+    ANSINAME2BBCODE = { "bold" => "B", "underline" => "U", "reverse" => "I",
+
+                        "red"    => "COLOR=red",      "blue"   => "COLOR=blue",
+                        "green"  => "COLOR=green",    "cyan"   => "COLOR=cyan",
+                        "magenta"=> "COLOR=deeppink", "purple" => "COLOR=purple",
+                        "black"  => "COLOR=black",    "white"  => "COLOR=white",
+                        "yellow" => "COLOR=yellow",   "brown"  => "COLOR=chocolate"
+                      }
+
+    ## Needed for alignments
+    @@width = 80
+
+
+    # ---------------------------
+
+    # Returns the ANSI sequence for given color, if existant
+    def BBCode.ansi(colorname)
+        colorname.strip!
+        return ANSINAME2CODE[ colorname.downcase ]
+    end
+
+    # --- strip_bbcode( string )
+    # Will strip any BBCode tags from the given string.
+    def BBCode.strip_bbcode(string)
+        string.strip!
+        return string.gsub(/\[[A-Za-z0-9\/=]+\]/, "")
+    end
+
+    # Returns the string with all ansi escape sequences converted to BBCodes
+    def BBCode.ansi_to_bbcode(string)
+        return "" if string.nil? || string.to_s.strip.empty?
+        result = ""
+        tagstack = []
+
+        ## Iterate over input lines
+        string.split("\n").each do |line|
+            ansi = line.scan(/\e\[[0-9;]+m/)
+            continue if ansi.nil? || ansi.empty?
+
+            ## Iterate over found ansi sequences
+            ansi.each do |seq|
+                ansiname = ANSINAME2CODE.invert["#{seq}"]
+
+                ## Pop last tag and form closing tag
+                if ansiname == "reset"
+                    lasttag = tagstack.pop
+                    bbname = "/" + String.new( lasttag.split("=")[0] )
+
+                ## Get corresponding BBCode tag + Push to stack
+                else
+                    bbname   = ANSINAME2BBCODE[ansiname]
+                    tagstack.push(bbname)
+                end
+
+                ## Replace ansi sequence by BBCode tag
+                replace = sprintf("[%s]", bbname)
+                line.sub!("#{Regexp.quote(seq)}", replace)
+            end
+
+            ## Append converted line
+            result << sprintf("%s\n", line)
+        end
+
+
+        ## Some tags are unclosed
+        while !tagstack.empty?
+            result << sprintf("[/%s]", String.new(tagstack.pop.split("=")[0])  )
+        end
+
+        return result
+    end
+
+    # Converts a BBCode string to one with ANSI sequences.
+    # Returns the string with all formatting instructions in BBCodes converted
+    # to ANSI code sequences / aligned with spaces to specified width.
+    def BBCode.bbcode_to_ansi(string, usecolors = true)
+        return "" if string.nil? || string.to_s.strip.empty?
+        result = ""
+
+        return BBCode.strip_bbcode(string) if !usecolors
+
+        ## Iterate over lines
+        string.split("\n").each do |line|
+
+            ## TODO: stacking? other styles!
+            ANSINAME2BBCODE.each do |key,val|
+                line.gsub!(/\[#{val}\]/, ANSINAME2CODE[key])
+                line.gsub!(/\[\/#{val}\]/, ANSINAME2CODE["reset"])
+            end
+
+            ## Fonttypes and sizes not available
+            line.gsub!(/\[SIZE=\d\]/, "")
+            line.gsub!(/\[\/SIZE\]/, "")
+            line.gsub!(/\[FONT=[^\]]*\]/, "")
+            line.gsub!(/\[\/FONT\]/, "")
+
+            ## Color-mapping
+            colors = line.scan(/\[COLOR=(.*?)\]/i)
+            colors = colors.collect{|s|  s[0].to_s} if !colors.nil?
+            colors.each do |col|
+                name = BBCOLOR2ANSI[col.downcase]
+                name = BBCOLOR2ANSI["white"] if name.nil?
+                code = ANSINAME2CODE[name]
+
+                line.gsub!(/\[COLOR=#{col}\]/i, code)
+            end
+            line.gsub!(/\[\/COLOR\]/, ANSINAME2CODE["reset"])
+
+            ## TODO: Alignment
+            ## TODO: IMGs
+            ## TODO: EMAILs
+            ## TODO: URLs
+            ## TODO: QUOTEs
+            ## TODO: LISTs
+
+            result << sprintf("%s\n", line)
+        end
+
+        return result
+    end
+
+    # Converts a HTML string into one with BBCode markup (TODO)
+    # Returns the (X)HTML markup string as BBCode
+    def BBCode.html_to_bbcode(string)
+        return "" if string.nil? || string.to_s.strip.empty?
+        result = ""
+
+        ## Iterate over lines
+        string.split(/<br *\/?>/i).each do |line|
+            styles = { "strong" => "b", "b" => "b",
+                        "em"     => "i", "i" => "i",
+                        "u"      => "u" }
+
+            ## preserve B, I, U
+            styles.each do |html,code|
+                line.gsub!(/<#{html}>/i, "[#{code.upcase}]")
+                line.gsub!(/<\/#{html}>/i, "[/#{code.upcase}]")
+            end
+
+            ## TODO: COLORs
+            ## TODO: SIZEs
+            ## TODO: FONTs
+
+            ## EMAIL
+            line.gsub!(/<a +href *= *\"mailto:(.*?)\".*?>.*?<\/a>/i, "[EMAIL]\\1[/EMAIL]")
+
+            ## URL
+            line.gsub!(/<a +href *= *\"((?:https?|ftp):\/\/.*?)\".*?>(.*?)<\/a>/i, "[URL=\\1]\\2[/URL]")
+
+            ## Other refs + closing tags => throw away
+            line.gsub!(/<a +href *= *\".*?\".*?>/i, "")
+            line.gsub!(/<\/a>/i,            "")
+
+            ## IMG
+            #line.gsub!(/<img +src *= *\"(.*?)\".*?\/?>/i, "[IMG=\\1]")
+            line.gsub!(/<img +src *= *\"(.*?)\".*?\/?>/i, "[IMG]\\1[/IMG]")
+
+            ## CENTER (right/left??)
+            line.gsub!(/<center>/i,   "[ALIGN=center]")
+            line.gsub!(/<\/center>/i, "[/ALIGN]")
+
+            ## QUOTE
+            line.gsub!(/<(?:xmp|pre)>/i,   "[QUOTE]")
+            line.gsub!(/<\/(?:xmp|pre)>/i, "[/QUOTE]")
+
+            ## LIST
+            line.gsub!(/<ul>/i,      "\n[LIST]\n")
+            line.gsub!(/<\/ul>/i,    "\n[/LIST]\n")
+            line.gsub!(/<li *\/?> */i, "\n[*] ")
+
+            ## Unkown tags => throw away
+            line.gsub!(/<.*? *\/?>/, "")
+
+            result << sprintf("%s<br />\n", line)
+        end
+
+        return result.gsub!(/<br *\/?>/i, "\n")
+    end
+
+    # Converts a BBCode string to one with HTML markup.
+    # Returns the string with all formatting instructions in
+    # BBCodes converted to XHTML markups.
+    def BBCode.bbcode_to_html(string)
+        return "" if string.nil? || string.to_s.strip.empty?
+        result = ""
+        quote = 0
+
+        ## Iterate over lines
+        string.split("\n").each do |line|
+            styles = { "b" => "strong", "i" => "em", "u" => "u" }
+
+            ## preserve B, I, U
+            styles.each do |code,html|
+                line.gsub!(/\[#{code}\]/i, "<#{html}>")
+                line.gsub!(/\[\/#{code}\]/i, "</#{html}>")
+            end
+
+            ## COLOR => font color=... (TODO: should be numeric!)
+            line.gsub!(/\[COLOR=(.*?)\]/i, "<font color=\"\\1\">")
+            line.gsub!(/\[\/COLOR\]/i,     "</font>")
+
+            ## SIZE => font size=...
+            line.gsub!(/\[SIZE=(.*?)\]/i, "<font size=\"\\1\">")
+            line.gsub!(/\[\/SIZE\]/i,     "</font>")
+
+            ## URL
+            line.gsub!(/\[URL\]([^\[]+?)\[\/URL\]/i, "<a href=\"\\1\">\\1</a>")
+            line.gsub!(/\[URL=(.*?)\](.+?)\[\/URL\]/i, "<a href=\"\\1\">\\2</a>")
+
+            ## IMG
+            line.gsub!(/\[IMG=(.*?)\]/i, "<img src=\"\\1\" />")
+
+            ## ALIGN=center (TODO: right, left)
+            line.gsub!(/\[ALIGN=center\]/i, "<center>")
+            line.gsub!(/\[ALIGN=right\]/i,  "<center>")
+            line.gsub!(/\[ALIGN=left\]/i,   "<center>")
+            line.gsub!(/\[\/ALIGN\]/i,      "</center>")
+
+            ## QUOTE
+            quote+=1 if line =~ /\[QUOTE\]/i
+            quote-=1 if (line =~ /\[\/QUOTE\]/i) && (quote > -1)
+            line.gsub!(/\[QUOTE\]/i,   "<pre>\n")
+            line.gsub!(/\[\/QUOTE\]/i, "</pre>\n")
+            line.gsub!(/^/, "&#62;"*quote) if quote > 0
+
+            ## EMAIL
+            line.gsub!(/\[EMAIL\](.*?)\[\/EMAIL\]/i, "<a href=\"mailto:\\1\">\\1</a>")
+
+            ## LIST (TODO: LIST=1, LIST=A)
+            line.gsub!(/\[LIST(?:=(.*?))?\]/i, "\n<ul>\n")
+            line.gsub!(/\[\/LIST\]/i,          "\n</ul>\n")
+            line.gsub!(/\[\*\]/i,              "\n<li />")
+
+            ## FONT => font ??????
+            ## ?BLUR?, FADE?
+
+            result << sprintf("%s<br />\n", line)
+        end
+
+        return result
+    end
+
+
+    # -- Transitive methods ---------------
+
+    # Converts a ANSI string to one with HTML markup.
+    # Returns the string with ANSI code sequences converted to XHTML markup.
+    def BBCode.ansi_to_html(string)
+        bbcoded = BBCode.ansi_to_bbcode(string )
+        htmled  = BBCode.bbcode_to_html(bbcoded)
+
+        return htmled
+    end
+
+    # Returns the (X)HTML markup code as ANSI sequences
+    def BBCode.html_to_ansi(string)
+        bbcoded = BBCode.html_to_bbcode(string )
+        ansied  = BBCode.bbcode_to_ansi(bbcoded)
+
+        return ansied
+    end
+
+  end #module BBCode
+
+end
+

data/lib/ansi/code.rb

@@ -8,11 +8,14 @@
 # TODO: Re-evaluate how color/yielding methods are defined.
 # TODO: Maybe up, down, right, left should have yielding methods too?
 
+#
 module ANSI
 
   # Currently Windows is not supported.
   SUPPORTED = !(RUBY_PLATFORM =~ /win/)
 
+  # = ANSI Codes
+  #
   # Ansi::Code module makes it very easy to use ANSI codes.
   # These are esspecially nice for beautifying shell output.
   #
@@ -227,3 +230,4 @@ module ANSI
   end
 
 end
+

data/lib/ansi/logger.rb

@@ -8,8 +8,8 @@ require "ansi/code"
 
 # = ANSI::Logger
 #
-# Extended variation of Ruby's standard Logger library.
-# Mainly for compatibility purposes (with what?)
+# Extended variation of Ruby's standard Logger library that supports
+# color output.
 #
 #   log = ANSI::Logger.new
 #
@@ -30,12 +30,14 @@ class ANSI::Logger < Logger
   SIMPLE_FORMAT   = "%5s: %s\n"
   DETAILED_FORMAT = "%s %5s: %s\n"
 
-  #
-  class ::Logger::LogDevice
-    attr_writer :ansicolor
+  # TODO: Not sure I like this approach.
+  class ::Logger #:nodoc:
+    class LogDevice #:nodoc:
+      attr_writer :ansicolor
 
-    def ansicolor?
-      @ansicolor.nil? ? true : @ansicolor
+      def ansicolor?
+        @ansicolor.nil? ? true : @ansicolor
+      end
     end
   end
 

data/lib/ansi/progressbar.rb

@@ -7,7 +7,9 @@
 
 require 'ansi/code'
 
-# ProgressBar is a text-based progressbar library.
+# = Progressbar
+#
+# Progressbar is a text-based progressbar library.
 #
 #   pbar = Progressbar.new( "Demo", 100 )
 #   100.times { pbar.inc }

data/lib/ansi/string.rb

@@ -7,8 +7,10 @@ def ANSI.string(str)
   ANSI::String.new(str)
 end
 
-# Clio Strings stores a regular string (@text) and
-# a Hash mapping character index to ansicodes (@marks).
+# = String
+#
+# ANSI Strings store a regular string (@text) and
+# a Hash mapping character index to ANSI codes (@marks).
 # For example is we have the string:
 #
 #   "Big Apple"
@@ -18,7 +20,8 @@ end
 #   { 0=>[:red] , 9=>[:clear] }
 #
 # TODO: In the future we may be able to subclass String,
-# instead of delegating via @text, but not until it is more compatible.
+# instead of delegating via @text, but not until it is more
+# compatible.
 #
 class ANSI::String
 

data/lib/ansi/terminal.rb

@@ -1,13 +1,13 @@
-#
-# This library is based of HighLine's SystemExtensions
-# by James Edward Gray II.
-#
-#   Copyright 2006 Gray Productions. All rights reserved.
-#
-# This is Free Software.  See LICENSE and COPYING for details.
-
 module ANSI
 
+  # = Terminal
+  #
+  # This library is based of HighLine's SystemExtensions
+  # by James Edward Gray II.
+  #
+  #   Copyright 2006 Gray Productions.
+  #
+  # This is Free Software. See LICENSE and COPYING for details.
   #
   module Terminal
 

data/meta/authors

@@ -1,3 +1,2 @@
+Thomas Sawyer
 Florian Frank
-Trans <transfire@gmail.com>
-

data/meta/homepage

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

data/meta/repository

@@ -1 +1 @@
-svn://rubyforge.org/var/svn/death/ansicode
+git://github.com/rubyworks/ansi.git

data/meta/version

@@ -1 +1 @@
-1.0.1
+1.1.0

data/test/test_bbcode.rb

@@ -0,0 +1,19 @@
+require 'ansi/bbcode'
+require 'test/unit'
+
+class TC_BBCode < Test::Unit::TestCase
+
+  def test_to_ansi
+    str = "this is [COLOR=red]red[/COLOR], this is [B]bold[/B]"
+    out = "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n"
+    assert_equal( out, BBCode.bbcode_to_ansi(str) )
+  end
+
+  def test_to_html
+    str = "this is [COLOR=red]red[/COLOR], this is [B]bold[/B]"
+    out = "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n"
+    assert_equal( out, BBCode.bbcode_to_html(str) )
+  end
+
+end
+

metadata

@@ -1,21 +1,30 @@
 --- !ruby/object:Gem::Specification 
 name: ansi
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
+- Thomas Sawyer
 - Florian Frank
-- Trans <transfire@gmail.com>
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-09-05 00:00:00 -04:00
+date: 2009-10-03 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: The ANSI project is a collection of ANSI 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 include Terminal which provides information about the current output device.
-email: Florian Frank
+description: |-
+  The ANSI project is a collection of ANSI 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 include
+  Terminal which provides information about the current output
+  device.
+email: Thomas Sawyer
 executables: []
 
 extensions: []
@@ -23,25 +32,22 @@ extensions: []
 extra_rdoc_files: 
 - README
 - MANIFEST
-- LICENSE
 - HISTORY
+- COPYING
 files: 
-- HISTORY
-- LICENSE
-- MANIFEST
-- README
 - demo/logger.rd
 - demo/progressbar.rd
-- lib/ansi.rb
+- lib/ansi/bbcode.rb
 - lib/ansi/code.rb
 - lib/ansi/logger.rb
 - lib/ansi/progressbar.rb
 - lib/ansi/string.rb
-- lib/ansi/terminal.rb
 - lib/ansi/terminal/curses.rb
 - lib/ansi/terminal/stty.rb
 - lib/ansi/terminal/termios.rb
 - lib/ansi/terminal/win32.rb
+- lib/ansi/terminal.rb
+- lib/ansi.rb
 - meta/abstract
 - meta/authors
 - meta/created
@@ -56,9 +62,14 @@ files:
 - meta/title
 - meta/version
 - test/test_ansicode.rb
+- test/test_bbcode.rb
 - test/test_progressbar.rb
+- README
+- HISTORY
+- COPYING
+- MANIFEST
 has_rdoc: true
-homepage: http://death.rubyforge.org/ansicode
+homepage: http://death.rubyforge.org/ansi
 licenses: []
 
 post_install_message: 
@@ -91,4 +102,5 @@ specification_version: 3
 summary: ANSI codes at your fingertips!
 test_files: 
 - test/test_ansicode.rb
+- test/test_bbcode.rb
 - test/test_progressbar.rb