epitools 0.3.0 → 0.3.1

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/epitools.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{epitools}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["epitron"]
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "lib/epitools/browser.rb",
     "lib/epitools/browser/browser_cache.rb",
     "lib/epitools/browser/mechanize_progressbar.rb",
+    "lib/epitools/colored.rb",
     "lib/epitools/hexdump.rb",
     "lib/epitools/highlight.rb",
     "lib/epitools/http.rb",

data/lib/epitools/colored.rb

@@ -0,0 +1,224 @@
+require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
+require 'set'
+
+##
+# cute.
+# 
+#   >> "this is red".red
+#  
+#   >> "this is red with a blue background (read: ugly)".red_on_blue
+#
+#   >> "this is red with an underline".red.underline
+#
+#   >> "this is really bold and really blue".bold.blue
+#
+#   >> Colored.red "This is red" # but this part is mostly untested
+module Colored
+  extend self
+
+  ###########################################################################
+  
+  @@is_tty = STDOUT.isatty
+
+  COLORS = { 
+    'black'   => 30,
+    'red'     => 31, 
+    'green'   => 32, 
+    'yellow'  => 33,
+    'blue'    => 34,
+    'magenta' => 35,
+    'cyan'    => 36,
+    'white'   => 37
+  }
+
+  EXTRAS = {
+    'clear'     => 0, 
+    'bold'      => 1,
+    'light'     => 1,
+    'underline' => 4,
+    'reversed'  => 7
+  }
+  
+  #
+  # BBS-style numeric color codes.
+  #
+  BBS_COLOR_TABLE = {
+    0   => :black,
+    1   => :blue,
+    2   => :green,
+    3   => :cyan,
+    4   => :red,
+    5   => :magenta,
+    6   => :yellow,
+    7   => :white,
+    8   => :light_black,
+    9   => :light_blue,
+    10  => :light_green,
+    11  => :light_cyan,
+    12  => :light_red,
+    13  => :light_magenta,
+    14  => :light_yellow,
+    15  => :light_white,
+  }
+
+  VALID_COLORS = Set.new(
+    COLORS.keys +
+    COLORS.map { |k,v| "light_#{k}" } +
+    COLORS.map { |k,v| "bold_#{k}"  }
+  )
+  
+  ###########################################################################
+
+  COLORS.each do |color, value|
+    define_method(color) do 
+      colorize(self, :foreground => color)
+    end
+
+    define_method("on_#{color}") do
+      colorize(self, :background => color)
+    end
+
+    define_method("light_#{color}") do
+      colorize(self, :foreground => color, :extra => 'bold')
+    end
+
+    COLORS.each do |highlight, value|
+      next if color == highlight
+      define_method("#{color}_on_#{highlight}") do
+        colorize(self, :foreground => color, :background => highlight)
+      end
+    end
+  end
+
+  EXTRAS.each do |extra, value|
+    next if extra == 'clear'
+    define_method(extra) do 
+      colorize(self, :extra => extra)
+    end
+  end
+
+  define_method(:to_eol) do
+    tmp = sub(/^(\e\[[\[\e0-9;m]+m)/, "\\1\e[2K")
+    if tmp == self
+      return "\e[2K" << self
+    end
+    tmp
+  end
+
+  ###########################################################################
+
+  def colorize(string=nil, options = {})
+    if string == nil
+      return tagged_colors(self)
+    end
+    
+    if @@is_tty
+      colored = [color(options[:foreground]), color("on_#{options[:background]}"), extra(options[:extra])].compact * ''
+      colored << string
+      colored << extra(:clear)
+    else
+      string
+    end
+  end
+
+  def colors
+    @@colors ||= COLORS.keys.sort
+  end
+
+  def extra(extra_name)
+    extra_name = extra_name.to_s
+    "\e[#{EXTRAS[extra_name]}m" if EXTRAS[extra_name]
+  end
+
+  def color(color_name)
+    background = color_name.to_s =~ /on_/
+    color_name = color_name.to_s.sub('on_', '')
+    return unless color_name && COLORS[color_name]
+    "\e[#{COLORS[color_name] + (background ? 10 : 0)}m" 
+  end
+
+  ###########################################################################
+
+  def enable!
+    @@is_tty = true
+  end
+  
+  alias_method :force!, :enable!
+  
+  def disable!
+    @@is_tty = false
+  end
+
+  def is_tty?
+    @@is_tty
+  end
+  
+  #
+  # Is this string legal?
+  #     
+  def valid_tag?(tag)
+    VALID_COLORS.include?(tag) or
+    (
+      string =~ /^\d+$/ and
+      BBS_COLOR_TABLE.include?(tag.to_i)
+    )
+  end
+    
+  #
+  # Colorize a string that has "color tags".
+  #
+  # Examples:
+  #
+  # Colors as words:
+  #    puts "<light_yellow><light_white>*</light_white> Hey mom! I am <light_green>SO</light_green> colourized right now.</light_yellow>".colorize
+  #
+  # Numeric ANSI colors (from the BBS days):
+  #    puts "<10><5>*</5> Hey mom! I am <9>SO</9> colourized right now.</10>".colorize
+  #
+  def tagged_colors(string)
+    stack = []
+
+    # split the string into tags and literal strings
+    tokens          = string.split(/(<\/?[\w\d_]+>)/)
+    tokens.delete_if { |token| token.size == 0 }
+    
+    result        = ""
+
+    tokens.each do |token|
+
+      # token is an opening tag!
+      
+      if /<([\w\d_]+)>/ =~ token and valid_tag?($1)
+        stack.push $1
+
+      # token is a closing tag!      
+      
+      elsif /<\/([\w\d_]+)>/ =~ token and valid_tag?($1)
+
+        # if this color is on the stack somwehere...
+        if pos = stack.rindex($1)
+          # close the tag by removing it from the stack
+          stack.delete_at pos
+        else
+          raise "Error: tried to close an unopened color tag -- #{token}"
+        end
+
+      # token is a literal string!
+      
+      else
+
+        color = (stack.last || "white")
+        color = BBS_COLOR_TABLE[color.to_i] if color =~ /^\d+$/
+        result << token.send(color)
+        
+      end
+      
+    end
+    
+    result
+  end  
+
+
+end unless Object.const_defined? :Colored
+
+String.send(:include, Colored)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - epitron
@@ -81,6 +81,7 @@ files:
 - lib/epitools/browser.rb
 - lib/epitools/browser/browser_cache.rb
 - lib/epitools/browser/mechanize_progressbar.rb
+- lib/epitools/colored.rb
 - lib/epitools/hexdump.rb
 - lib/epitools/highlight.rb
 - lib/epitools/http.rb