ansi 1.3.0 → 1.4.0

data/README.rdoc

@@ -1,5 +1,13 @@
 = ANSI
 
+{Home}[http://rubyworks.github.com/ansi] |
+{API}[http://rubydoc.info/gems/ansi/frames] |
+{Code}[http://github.com/rubyworks/ansi] |
+{Mail}[http://googlegroups.com/group/rubyworks-mailinglist]
+
+{<img src="http://travis-ci.org/rubyworks/ansi.png" />}[http://travis-ci.org/rubyworks/ansi]
+
+
 == DESCRIPTION
 
 The ANSI project is a collection of ANSI escape code related libraries
@@ -21,12 +29,6 @@ device.
 * Very Good coverage of standard ANSI codes.
 
 
-== RESOURCES
-
-* home: http://rubyworks.github.com/ansi
-* code: http://github.com/rubyworks/ansi
-
-
 == RELEASE NOTES
 
 Please see HISTORY file.

data/lib/ansi.rb

@@ -1,19 +1,4 @@
-# ANSI module contains all the ANSI related classes.
-module ANSI
-  # Returns Hash table of project metadata.
-  def self.meta
-    @spec ||= (
-      require 'yaml'
-      YAML.load(File.new(File.dirname(__FILE__) + '/ansi.yml'))
-    )
-  end
-
-  # Check metadata for missing constants.
-  def self.const_missing(name)
-    meta[name.to_s.downcase] || super(name)
-  end
-end
-
+require 'ansi/version'
 require 'ansi/core'
 require 'ansi/code'
 require 'ansi/bbcode'

data/lib/ansi.yml

@@ -1,47 +1,52 @@
---- 
-name: ansi
-version: 1.3.0
-title: ANSI
-summary: ANSI codes at your fingertips!
-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.
-loadpath: 
-- lib
-manifest: Manifest
-requires: 
+---
+source:
+- meta
+authors:
+- name: Thomas Sawyer
+- name: Florian Frank
+copyrights:
+- holder: Rubyworks
+  year: '2009'
+replacements: []
+alternatives: []
+requirements:
 - name: detroit
-  version: 0+
-  group: 
+  groups:
   - build
+  development: true
 - name: qed
-  version: 0+
-  group: 
+  groups:
   - test
+  development: true
 - name: lemon
-  version: 0+
-  group: 
+  groups:
   - test
+  development: true
+dependencies: []
 conflicts: []
-
-replaces: []
-
-engine_check: []
-
-organization: RubyWorks
-contact: rubyworks-mailinglist@googlegroups.com
-created: 2004-08-01
-copyright: Copyright (c) 2009 Thomas Sawyer
-licenses: 
-- Apache 2.0
-authors: 
-- Thomas Sawyer
-- Florian Frank
-maintainers: []
-
-resources: 
+repositories:
+- uri: git://github.com/rubyworks/ansi.git
+  scm: git
+  name: upstream
+resources:
   home: http://rubyworks.github.com/ansi
-  work: http://github.com/rubyworks/ansi
-  api: http://rubyworks.github.com/ansi/rdoc
+  code: http://github.com/rubyworks/ansi
+  docs: http://rubydoc.info/gems/ansi
   mail: http://groups.google.com/group/rubyworks-mailinglist
-repositories: 
-  public: git://github.com/rubyworks/ansi.git
-spec_version: 1.0.0
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-08-01'
+summary: ANSI at your fingertips!
+title: ANSI
+version: 1.4.0
+name: 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.'
+organization: Rubyworks
+date: '2011-11-05'

data/lib/ansi/chart.rb

@@ -1,5 +1,7 @@
 module ANSI
 
+  require 'ansi/version'
+
   # Table of codes used throughout the system.
   #
   # @see http://en.wikipedia.org/wiki/ANSI_escape_code

data/lib/ansi/code.rb

@@ -1,6 +1,13 @@
 module ANSI
 
-  require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /(win32|w32)/
+  if RUBY_PLATFORM =~ /(win32|w32)/
+    begin
+      require 'Win32/Console/ANSI'
+    rescue
+      warn "ansi: 'gem install win32console' to use color on Windows"
+      $ansi = false
+    end
+  end
 
   require 'ansi/constants'
 

data/lib/ansi/hexdump.rb

@@ -0,0 +1,122 @@
+module ANSI
+
+  require 'ansi/code'
+
+  # TODO: split dump method into two parts, the first should create a hex table
+  # then the second, #dump method, will print it out.
+
+  # Create a colorized hex dump of byte string.
+  # 
+  # Output looks something like the following, but colorized.
+  # 
+  #   000352c0:  ed 33 8c 85 6e cc f6 f7  72 79 1c e3 3a b4 c2 c6  |.3..n...ry..:...|
+  #   000352d0:  c8 8d d6 ee 3e 68 a1 a5  ae b2 b7 97 a4 1d 5f a7  |....>h........_.|
+  #   000352e0:  d8 7d 28 db f6 8a e7 8a  7b 8d 0b bd 35 7d 25 3c  |.}(.....{...5}%<|
+  #   000352f0:  8b 3c c8 9d ec 04 85 54  92 a0 f7 a8 ed cf 05 7d  |.<.....T.......}|
+  #   00035300:  b5 e3 9e 35 f0 79 9f 51  74 e3 60 ee 0f 03 8e 3f  |...5.y.Qt.`....?|
+  #   00035310:  05 5b 91 87 e6 48 48 ee  a3 77 ae ad 5e 2a 56 a2  |.[...HH..w..^*V.|
+  #   00035320:  b6 96 86 f3 3c 92 b3 c8  62 4a 6f 96 10 5c 9c bb  |....<...bJo..\..|
+  #
+  # In the future, we will make the colorization more customizable and
+  # allow the groupings to be selectable at 2, 4, 8 or 16.
+  #
+  class HexDump
+
+    # Printable ASCII codes.
+    ASCII_PRINTABLE = (33..126)
+
+    #
+    def initialize(options={})
+      @offset = 0
+
+      options.each do |k,v|
+        __send__("#{k}=", v)
+      end
+
+      @color = true if color.nil?
+    end
+
+    # Use color?
+    attr_accessor :color
+
+    # Show index?
+    attr_accessor :index
+
+    # Offset byte count.
+    attr_accessor :offset
+
+    # Dump data string as colorized hex table.
+    #
+    # @param data [String]
+    #   String to convert to hex and display.
+    #
+    def dump(data)
+      lines             = data.to_s.scan(/.{1,16}/m)
+      max_offset        = (offset + data.size) / 256  #16 * 16
+      max_offset_width  = max_offset.to_s.size + 1
+      max_hex_width     = 49  #3 * 16 + 1
+
+      out = template()
+      off = offset()
+
+      if index?
+        puts((' ' * max_offset_width) + "    0  1  2  3  4  5  6  7   8  9  A  B  C  D  E  F\n")
+      end
+
+      lines.each_with_index do |line, n|
+        offset = off + n * 16
+        bytes  = line.unpack("C*")
+        hex    = bytes.map{ |c| "%0.2x" % c }.insert(8, '').join(' ')
+
+        plain = bytes.map do |c|
+          if ASCII_PRINTABLE.include?(c)
+            c = c.chr
+          else
+            color ? Code::WHITE + Code::STRIKE + '.' + Code::CLEAR : '.' 
+          end
+        end.join('')
+
+        fill = [offset.to_s.rjust(max_offset_width), hex.ljust(max_hex_width), plain]
+
+        puts(out % fill)
+      end      
+    end
+
+    # Hex dump a random string.
+    #
+    def dump_random(size=64)
+      data = (0..size).map{ rand(255).chr }.join('')
+      dump(data)
+    end
+
+    #
+    def index?
+      @index
+    end
+
+  private
+
+    # Hex dump line template.
+    #
+    # @return [String] hex dump line template
+    def template
+      if color
+        Code::CYAN +
+        "%s:  " +
+        Code::YELLOW +
+        "%s " +
+        Code::BLUE +
+        "|" +
+        Code::CLEAR +
+        "%s" +
+        Code::BLUE +
+        "|" +
+        Code::CLEAR
+      else
+        "%s:  %s |%s|"
+      end
+    end
+
+  end
+
+end

data/lib/ansi/table.rb

@@ -1,4 +1,4 @@
-require 'ansi'
+require 'ansi/core'
 require 'ansi/terminal'
 
 module ANSI
@@ -70,7 +70,8 @@ module ANSI
          body_row = []
          row.each_with_index do |cell, c|
            t = cell_template(max[c])
-           body_row << (t % cell.to_s).ansi(*ansi_formating(cell, c, r))
+           s = t % cell.to_s
+           body_row << apply_format(s, cell, c, r)
          end
          body << "| " + body_row.join(' | ') + " |"
       end
@@ -84,7 +85,7 @@ module ANSI
       "#{top}\n#{body}\n#{bot}\n"
     end
 
-    private
+  private
 
     # TODO: look at the lines and figure out how many columns will fit
     def fit_width
@@ -92,12 +93,15 @@ module ANSI
       ((width.to_f / column_size) - (padding + 3)).to_i
     end
 
+    # Calculate the maximun column sizes.
     #
+    # @return [Array] maximum size for each column
     def max_columns(fit=false)
       max = Array.new(column_size, 0)
       table.each do |row|
         row.each_with_index do |col, index|
           col = col.to_s
+          col = col.unansi
           if fit
             max[index] = [max[index], col.size, fit_width].max
           else
@@ -108,7 +112,9 @@ module ANSI
       max
     end
 
-    # Number of columns.
+    # Number of columns based on the first row of table.
+    #
+    # @return [Integer] number of columns
     def column_size
       table.first.size
     end
@@ -123,6 +129,30 @@ module ANSI
       end
     end
 
+    # TODO: make more efficient
+    def dividing_line
+      tmp = max_columns(fit).map{ |m| "%#{m}s" }.join(" | ")
+      tmp = "| #{tmp} |"
+      lin = (tmp % (['-'] * column_size)).gsub(/[^\|]/, '-').gsub('|', '+')
+    end
+
+    #def dividing_line_top
+    #  dividing_line.gsub('+', '.')
+    #end
+
+    #def dividing_line_bottom
+    #  dividing_line.gsub('+', "'")
+    #end
+
+    #
+    def apply_format(str, cell, col, row)
+      if @format
+        str.ansi(*ansi_formating(cell, col, row))
+      else
+        str
+      end 
+    end
+
     #
     def ansi_formating(cell, col, row)
       if @format
@@ -142,21 +172,6 @@ module ANSI
       [f].flatten.compact
     end
 
-    # TODO: make more efficient
-    def dividing_line
-      tmp = max_columns(fit).map{ |m| "%#{m}s" }.join(" | ")
-      tmp = "| #{tmp} |"
-      lin = (tmp % (['-'] * column_size)).gsub(/[^\|]/, '-').gsub('|', '+')
-    end
-
-    #def dividing_line_top
-    #  dividing_line.gsub('+', '.')
-    #end
-
-    #def dividing_line_bottom
-    #  dividing_line.gsub('+', "'")
-    #end
-
   end
 
 end

data/lib/ansi/version.rb

@@ -0,0 +1,16 @@
+# ANSI module contains all the ANSI related classes.
+module ANSI
+  # Returns Hash table of project metadata.
+  def self.meta
+    @spec ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/../ansi.yml'))
+    )
+  end
+
+  # Check metadata for missing constants.
+  def self.const_missing(name)
+    meta[name.to_s.downcase] || super(name)
+  end
+end
+

data/test/case_ansicode.rb

@@ -1,3 +1,4 @@
+require 'test_helper'
 require 'ansi/code'
 
 testcase ANSI::Code do

data/test/case_bbcode.rb

@@ -1,27 +1,35 @@
+require 'test_helper'
 require 'ansi/bbcode'
 
 testcase ANSI::BBCode do
 
-  meta :bbcode_to_ansi do
-    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"
-    out.assert == ANSI::BBCode.bbcode_to_ansi(str)
+  class_method :bbcode_to_ansi do
+    test do
+      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"
+      out.assert == ANSI::BBCode.bbcode_to_ansi(str)
+    end
   end
 
-  meta :bbcode_to_html do
-    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"
-    out.assert == ANSI::BBCode.bbcode_to_html(str)
+  class_method :bbcode_to_html do
+    test do
+      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"
+      out.assert == ANSI::BBCode.bbcode_to_html(str)
+    end
   end
 
-  meta :ansi_to_html do
-    str = "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n" +
-          "this is a line without any ansi code\n" +
-          "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n"
-    out = "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n" +
-          "this is a line without any ansi code<br />\n" +
-          "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n"
-    out.assert == ANSI::BBCode.ansi_to_html(str)
+  class_method :ansi_to_html do
+    test do
+      str = "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n" +
+            "this is a line without any ansi code\n" +
+            "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n"
+      out = "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n" +
+            "this is a line without any ansi code<br />\n" +
+            "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n"
+      out.assert == ANSI::BBCode.ansi_to_html(str)
+    end
   end
 
 end
+