facets 1.1.0 → 1.2.0

data/lib/facets/more/association.rb

@@ -0,0 +1,156 @@
+#--
+# Association
+#
+# Copyright (c) 2005 Thmas Sawyer
+#
+# Ruby License
+#
+# 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.
+#
+# ==========================================================================
+# Revision History ::
+# --------------------------------------------------------------------------
+#  2005-10-25  Trans     * Initial Release
+# ==========================================================================
+#++
+
+#:title: Association
+#
+# Gerenal binary association, useful for creating ordered hashes,
+# or mixed collections.
+#
+# The method :>> is used to construct the association. It is an uncommon
+# method, but wehere is has been used prior a suitable alias has been
+# made, #rshift. For Date class it has ben named #months_later.
+#
+# == Synopsis
+#
+#   c = [ :a >> 1, :b >> 2 ]
+#
+#   c.each { |k,v| puts "#{k} associated with #{v} }
+#
+# _produces_
+#
+#   a associated with 1
+#   b associated with 2
+#
+# == Author(s)
+#
+# * Thomas Sawyer
+#
+
+class Association
+
+  include Comparable
+
+  attr_accessor :index, :value
+
+  def self.[](*args)
+    new(*args)
+  end
+
+  def initialize(index, value=nil)
+    @index = index
+    @value = value
+  end
+
+  def <=>(assoc)
+     return -1 if self.value < assoc.value
+     return 1 if self.value > assoc.value
+     return 0 if self.value == assoc.value
+  end
+
+  def invert!
+    temp = @index
+    @index = @value
+    @value = temp
+  end
+
+  def to_s
+    return "#{index.to_s}#{value.to_s}"
+  end
+
+  def inspect
+    %{#{@index.inspect} >> #{@value.inspect}}
+  end
+
+  def to_ary
+    [ @index, @value ]
+  end
+
+end
+
+# Setup the >> method, aliasing where already used.
+
+class Bignum
+  alias_method( :rshift, :>>) if method_defined?(:>>)
+end
+
+class Fixnum
+  alias_method( :rshift, :>>) if method_defined?(:>>)
+end
+
+class Date
+  alias_method( :months_later, :>>) if method_defined?(:>>)
+end
+
+class IPAddr
+  alias_method( :rshift, :>>) if method_defined?(:>>)
+end
+
+class Process::Status
+  alias_method( :rshift, :>>) if method_defined?(:>>)
+end
+
+class Object
+  def >>(to)
+    Association.new(self, to)
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin test
+
+  require 'test/unit'
+
+  class TC01 < Test::Unit::TestCase
+
+    def setup
+      @complex_hierarchy = [
+        'parent' >> 'child',
+        'childless',
+        'another_parent' >> [
+          'subchildless',
+          'subparent' >> 'subchild'
+        ]
+      ]
+    end
+
+    def test_ohash
+      k,v = [],[]
+      ohash = [ 'A' >> '3', 'B' >> '2', 'C' >> '1' ]
+      ohash.each { |e1,e2| k << e1 ; v << e2 }
+      assert_equal( ['A','B','C'], k )
+      assert_equal( ['3','2','1'], v )
+    end
+
+    def test_complex
+      complex = [ 'Drop Menu' >> [ 'Button 1', 'Button 2', 'Button 3' ], 'Help' ]
+      assert_equal( 'Drop Menu', complex[0].index )
+    end
+
+  end
+
+=end

data/lib/facets/more/basicobject.rb

@@ -0,0 +1,135 @@
+#--
+# BasicObject
+#
+# Copyright (c) 2005 Thomas Sawyer
+# based on BlankSlate, Copyright (c) 2004 by Jim Weirich
+#
+# Ruby License
+#
+# 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.
+#
+# ==========================================================================
+#  Revision History
+# ==========================================================================
+#  2005.10.26
+#  * preserved a few addtional methods --everyhting ending in ?, dup and
+#    object_id.
+#  * changed name from BlankSlate to BasicObject
+#
+#  2005.04.28  trans
+#  * ported to mega and added __class__
+# ==========================================================================
+#
+# TODO Would be nice it there were a factory method to alter which methods
+#      were excluded.
+#
+#++
+
+require 'facets/core/kernel/__class__'
+
+# :title: BasicObject
+#
+# BasicObject provides an abstract base class with no predefined
+# methods, except for <tt>respond_to?</tt>, any method starting in
+# <tt>\_\_</tt> (two underscore, like <tt>\_\_id__</tt>) as well as
+# any method starting with <tt>instance_</ttr>.
+#
+# BasicObject is useful as a base class when writing classes that
+# depend upon <tt>method_missing</tt> (e.g. dynamic proxies).
+#
+# The pattern used to reserve methods is:
+#
+#   /(^__|^instance_|^object_|^null$|^inspect$|^dup$|\?$)/
+#
+# By default these are the reserved methods:
+#
+#   __id__ __class__ __send__ dup eql? equal? frozen? inspect instance_eval
+#   instance_of? instance_variable_get instance_variable_set instance_variables
+#   is_a? kind_of? nil? null object_id respond_to? tainted?
+#
+
+class BasicObject
+
+  #EXCLUDE = /^(__id__|__send__)$/
+  EXCLUDE = /(^__|^instance_|^object_|^null$|^inspect$|^dup$|\?$)/
+
+  def self.hide(name)
+    #if instance_methods.include?(name.to_s) and name !~ EXCLUDE #/^(#{EXCLUDE.join('|')})/
+    if method_defined?(name) and name !~ EXCLUDE
+      undef_method name
+    end
+  end
+
+  instance_methods.each { |m| hide(m) }
+
+end
+
+# Since Ruby is very dynamic, methods added to the ancestors of
+# BasicObject <em>after BasicObject is defined</em> will show up in the
+# list of available BasicObject methods.  We handle this by defining a hook
+# in the Object and Kernel classes that will hide any defined.
+
+module Kernel
+  class << self
+    #alias_method :blank_slate_method_added, :method_added
+    #def method_added(name)
+    #  return if name == :blank_slate_method_added
+    #  blank_slate_method_added(name)
+    madded = instance_method(:method_added)
+    define_method(:method_added) do |name|
+      madded.bind(self).call(name)
+      return if self != Kernel
+      BasicObject.hide(name)
+    end
+  end
+end
+
+class Object
+  class << self
+    madded = instance_method(:method_added)
+    define_method(:method_added) do |name|
+      madded.bind(self).call(name)
+      return if self != Object
+      BasicObject.hide(name)
+    end
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+# TODO
+
+=begin #test
+
+  require 'test/unit'
+
+  class TC_Kernelless < Test::Unit::TestCase
+
+    class A
+      include Kernelless
+    end
+
+    def test_001
+      p A.instance_methods
+    end
+
+    def test_002
+      Kernel.class_eval {
+        def xxx ; end
+      }
+    end
+
+  end
+
+=end

data/lib/facets/more/bbcode.rb

@@ -0,0 +1,388 @@
+#--
+# BBCode
+#
+# Copyright (c) 2002 Thomas-Ivo Heinen
+#
+# Ruby License
+#
+# 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.
+#
+#
+# ==========================================================================
+# Revision History ::
+# --------------------------------------------------------------------------
+#  2002-07-16  TH    Bugfix BBCODE=>ANSI, bbcode_to_html, ansi_to_html,
+#                    html_to_bbcode, html_to_ansi
+#
+#  2002-11-11  TH    Comment fixes, more case insensitive matching,
+#                    convert deprecated HTML styles (<b>, <i>), more
+#                    space-tolerant matching, img-tags in html_to_bbcode
+#                    works now, some error-preventing stripping and
+#                    downcasing.
+# ==========================================================================
+#++
+
+#:title: BBCode
+#
+# This module helps easening 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) )
+#
+# == Author(s)
+#
+# * Thomas-Ivo Heinen
+#
+
+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]")
+
+          ## 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
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin testing
+
+  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
+
+=end