facets 1.3.3 → 1.4.0

data/lib/facets/more/bbcode.rb

@@ -1,33 +1,25 @@
-#--
-# BBCode
+# = bbCode.rb
 #
-# Copyright (c) 2002 Thomas-Ivo Heinen
+# == Copyright (c) 2002 Thomas-Ivo Heinen
 #
-# Ruby License
+#   Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   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.
+#   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.
 #
+# == Authors and Contributors
 #
-# ==========================================================================
-# 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
+# * Thomas-Ivo Heinen
+
+# Author::    Thomas-Ivo Heinen
+# Copyright:: Copyright (c) 2002 Thomas-Ivo Heinen
+# License::   Ruby License
+
+# = 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
@@ -47,10 +39,6 @@
 #   print( BBCode.bbcode_to_ansi(str) )
 #   print( BBCode.bbcode_to_html(str) )
 #
-# == Author(s)
-#
-# * Thomas-Ivo Heinen
-#
 
 module BBCode
 
@@ -85,7 +73,7 @@ module BBCode
                     "indigo"    => "blue",     "burlywood" => "red",
                     "sandybrown"=> "red",      "sierra"    => "sierra",
                     "chocolate" => "brown",    "teal"      => "teal",
-                    "silver"    => "white",     
+                    "silver"    => "white",
                     "black"     => "black",    "yellow"    => "yellow",
                     "magenta"   => "magenta",  "cyan"      => "cyan",
                     "white"     => "white" 
@@ -213,7 +201,6 @@ module BBCode
       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)
@@ -231,17 +218,17 @@ module BBCode
               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,            "")
@@ -288,7 +275,7 @@ module BBCode
               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>")

data/lib/facets/more/binaryreader.rb

@@ -1,42 +1,33 @@
-#--
-# BinaryReader
+# = binaryreader.rb
 #
-# Copyright (c) 2003 Michael Neumann
+# == Copyright (c) 2003 Michael Neumann
 #
-# Ruby License
+#   Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   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.
+#   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.04.28 Trans  * Minor modifications to documentation.
-# ==========================================================================
-#++
-
-#:title: BinaryReader
-#
-# This mixin solely depends on method read(n), which must be 
-# defined in the class/module where you mix in this module.
-#
-# == Synopsis
-#
-#   # TODO: If anyone has an example of using this, please submit it. -T
-#
-# == Author(s)
+# == Authors and Contributors
 #
 # * Michael Neumann
+
+# Author::    Michael Neumann
+# Copyright:: Copyright (c) 2003 Michael Neumann
+# License::   Ruby License
+
+# = BinaryReader
 #
+# This mixin solely depends on method read(n), which must be
+# defined in the class/module where you mix in this module.
 
 module BinaryReader
 
   #--
-  # Would like to get the core functionality this provides into the
+  # TODO Would like to get the core functionality this provides into the
   # System module and then change BinaryReader to depend on that instead.
   #++
   module ByteOrder
@@ -54,7 +45,7 @@ module BinaryReader
       end
     end
 
-    alias byteorder byte_order 
+    alias_method :byteorder, :byte_order
 
     def little_endian?
       byte_order == LittleEndian
@@ -64,15 +55,15 @@ module BinaryReader
       byte_order == BigEndian
     end
 
-    alias little? little_endian? 
-    alias big? big_endian?
-    alias network? big_endian?
+    alias_method :little?, :little_endian?
+    alias_method :big?, :big_endian?
+    alias_method :network?, :big_endian?
 
     module_function :byte_order, :byteorder
     module_function :little_endian?, :little?
     module_function :big_endian?, :big?, :network?
 
-  end 
+  end
 
   # default is native byte-order
   def byte_order
@@ -231,10 +222,48 @@ end
 
 # TODO
 
-=begin #test
+=begin test
 
   require 'test/unit'
 
+  class TC_ByteOrder < Test::Unit::TestCase
+
+    include BinaryReader
+
+    def test_equal
+      assert_equal ByteOrder.little?, ByteOrder.little_endian?
+      assert_equal ByteOrder.big?, ByteOrder.big_endian?
+      assert_equal ByteOrder.network?, ByteOrder.big_endian?
+      assert_equal ByteOrder.byte_order, ByteOrder.byteorder
+
+      assert_equal ByteOrder::Big, ByteOrder::BigEndian
+      assert_equal ByteOrder::Network, ByteOrder::BigEndian
+      assert_equal ByteOrder::Little, ByteOrder::LittleEndian
+
+      assert_equal ByteOrder.byte_order, ByteOrder::LittleEndian if ByteOrder.little?
+      assert_equal ByteOrder.byte_order, ByteOrder::BigEndian if ByteOrder.big?
+    end
+
+    def test_uname_byteorder
+      assert_equal(ByteOrder.little?, true) if `uname -m` =~ /i386/
+    end
+
+    def test_byteorder
+      if ByteOrder.little?
+        assert_equal "\x12\x34\x56\x78".unpack("L").first, 0x78563412
+        assert_equal "\x78\x56\x34\x12".unpack("L").first, 0x12345678
+        assert_equal [0x12345678].pack("L"), "\x78\x56\x34\x12"
+        assert_equal [0x78563412].pack("L"), "\x12\x34\x56\x78"
+      else
+        assert_equal "\x12\x34\x56\x78".unpack("L").first, 0x12345678
+        assert_equal "\x78\x56\x34\x12".unpack("L").first, 0x78563412 
+        assert_equal [0x12345678].pack("L"), "\x12\x34\x56\x78"
+        assert_equal [0x78563412].pack("L"), "\x78\x56\x34\x12"
+      end
+    end
+
+  end
+
   class TC_BinaryReader < Test::Unit::TestCase
 
     def test_todo

data/lib/facets/more/bitmask.rb

@@ -1,38 +1,31 @@
-#--
-# Bitmask
+# = bitmask.rb
 #
-# Copyright (c) 2005 George Moschovitis
+# == Copyright (c) 2005 George Moschovitis
 #
-# Ruby License
+#   Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   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.
+#   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.
 #
-#================================================================================
-# ChangeLog
-#================================================================================
-# 05.11.25  trans  Released.
-#================================================================================
-#++
-
-#:title: Bitmask
+# == Authors and Contributors
+#
+# * Thomas Sawyer
+
+# Author::    George Moschovitis
+# Copyright:: Copyright (c) 2005 George Moschovitis
+# License::   Ruby License
+
+# = Bitmask
 #
 # Bitmask extends the Integer class to allow for easy manipulation
 # of a number as a bit field.
 #
 #   0xb0100.clear_bit(3)  #=> 0
 #
-#
-
-module Kernel
-  def bitmask(bit)
-    1 << bit
-  end
-end
 
 class Integer
 
@@ -69,6 +62,13 @@ class Integer
 end
 
 
+module Kernel
+  def bitmask(bit)
+    1 << bit
+  end
+end
+
+
 #  _____         _
 # |_   _|__  ___| |_
 #   | |/ _ \/ __| __|

data/lib/facets/more/blankslate.rb

@@ -1,3 +1,7 @@
 require 'facets/more/basicobject'
 
+# = BlankSlate
+#
+# BlankSlate is an alias (and the original name) of BasicObject.
+
 BlankSlate = BasicObject

data/lib/facets/more/builderobject.rb

@@ -1,29 +1,28 @@
-#--
-# BuilderObject
-# Copyright (c) 2006 Thomas Sawyer
+# = builderobject.rb
 #
-# Ruby License
+# == Copyright (c) 2006 Thomas Sawyer
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   Ruby License
 #
-# 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.
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
 #
-# ==========================================================================
-# Revision Notes
-# --------------------------------------------------------------------------
-#  2006-04-18  trans  Created.
-# ==========================================================================
-#++
+#   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.
+#
+# == Authors and Contributors
+#
+# * Thomas Sawyer
 
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 #require 'facets/more/basicobject'
 require 'facets/more/functor'
 
-
-# :title: BuilderObject
+# = BuilderObject
 #
 # Build content programatically with Ruby and Ruby's blocks.
 #
@@ -42,9 +41,6 @@ require 'facets/more/functor'
 # routes all builder method vis the #out method.
 #
 # NOTE The name of this method (#out) may be changed.
-#
-# AUTHORS:: Thomas Sawyer
-#
 
 class BuilderObject < BasicObject
 

data/lib/facets/more/bytes.rb

@@ -1,42 +1,61 @@
-#--
-# Binary Multipliers
+# = bytes.rb
 #
-# Copyright (c) 2005 Thomas Sawyer
-# Copyright (c) 2004 Rich Kilmer
+# == Copyright (c) 2005 Rich Kilmer, Thomas Sawyer
 #
-# Ruby License
+#  Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   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.
+#   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.08.10  trans   * Made a module. Added in_* methods.
-#  2005.07.28  trans   * Rewrote lib to work in bits instead of bytes.
-#  2005.04.28  trans   * Ported from Rich Kilmer's lib.
-# ==========================================================================
+# == Special Thanks
 #
-# CREDIT Credit goes to Richard Kilmer for the orignal work and
-#        Alexander Kellett for suggesting it be included here.
+# Special thanks to Richard Kilmer for the orignal work.
+# This library is based on the original library bytes.rb
+# Copyright (c) 2004 by Rich Kilmer.
 #
-#++
+# Also thanks to Alexander Kellett for suggesting it be
+# included in Facets.
+#
+# == Authors and Contributors
+#
+# * Rich Kilmer
+# * Thomas Sawyer
+#
+# == Developer Notes
+#
+#   TODO Currently kilo, mega, etc. are all powers of two and not ten,
+#        which technically isn't corrent even though it is common usage.
+#
+#   TODO The in_* notation is weak. If a better nomentclature is thought
+#        of then consider changing this.
 
-#:title: Binary Multipliers
+# Author::    Rich Kilmer, Thomas Sawyer
+# Copyright:: Copyright (c) 2005 Thomas Sawyer, Rich Kilmer
+# License::   Ruby License
+
+# = Binary Multipliers
+#
+# Additional methods for Numeric class to make working with
+# bits and bytes easier. Bits are used as the base value and
+# these methods can be used to convert between different
+# magnitudes.
 #
-# Mixin for Numeric to make working with bits and bytes easier.
-# These are numerous and therefore provided via a mega-module
-# called BinaryMultiplers, rather then individual nano-methods.
+# == Synopisis
 #
 #   1.byte               #=> 8
 #   2.bytes              #=> 16
 #   1.kilobit            #=> 1024
 #   1.kilobyte           #=> 8192
 #
+# Use the in_* methods to perform the inverse operations.
+#
+#   8192.in_kilobytes    #=> 1
+#   1024.in_kilobits     #=> 1
+#
 
 class Numeric