facets 1.3.3 → 1.4.0

data/lib/facets/more/timer.rb

@@ -1,38 +1,40 @@
-#--
-# Timer
+# = timer.rb
 #
-# Copyright (c) 2004,2005 Thomas Sawyer
+# == Copyright (c) 2004 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
-# ==========================================================================
+# == SPECIAL THANKS
 #
-#  2005-05-05 Trans
-#    - Merged Paul Brannan's TimeLimit with Minero Aoki's Timer.
+# Thanks to Paul Brannan for TimeLimit and Minero Aoki for Timer.
+# These two libraries served as models for building this class.
 #
-# ==========================================================================
-#++
+# == Author(s)
+#
+# * Minero Aoki
+# * Paul Brannan
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2005 Thomas Sawyer
+# License::   Ruby License
 
-require 'timeout'    # for TimeoutError
+require 'timeout'  # for TimeoutError
 
-#:title: Timer
+# = Timer
 #
 # Provides a strightforward means for controlling time critical execution.
 # Can be used as a "stop watch" timer or as a "time bomb" timer.
 #
 # == Usage
 #
-#   require 'mega/timer'
-#
 #   t = Timer.new(10) { raise TimeoutError, "timeout!" }
 #   t.start
 #     :      # done within 10sec timeout
@@ -66,12 +68,6 @@ require 'timeout'    # for TimeoutError
 #
 #   }
 #
-# == Author(s)
-#
-# * Minero Aoki
-# * Paul Brannan
-# * Thomas Sawyer
-#
 
 class Timer
 

data/lib/facets/more/times.rb

@@ -1,39 +1,39 @@
-#--
-# Time In English
+# = times.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.04.28 trans  Ported from Rich Kilmer's lib.
-# ===========================================================================
+# == SPECIAL THANKS
 #
-# TODO Extra methods
-# Add in_* methods, like in_days, in_hours, etc.
+# Thanks to Richard Kilmer for the orignal work and
+# Alexander Kellett for suggesting it for Facets.
 #
-# CREDIT
-# Credit goes to Richard Kilmer for the orignal work and
-# Alexander Kellett for suggesting them for Nano (then Facets).
+# == Author(s)
 #
-#++
+# * Rich Kilmer
+# * Thomas Sawyer
+#
+# == Developer Notes
+#
+#   TODO Extra Add in_* methods, like in_days, in_hours, etc.
+
+# Author::    Rich Kilmer
+# Copyright:: Copyright (c) 2005 Rich Kilmer
+# License::   Ruby License
 
 require 'facet/time/change'
 
-#:title: Time In English
+# = Time In English
 #
 # Plain-English convenience methods for dealing with dates and times.
-#
 
 class Numeric
 

data/lib/facets/more/tracepoint.rb

@@ -1,29 +1,33 @@
-#--
-# TracePoint
+# = tracepoint.rb
 #
-# Copyright (c) 2005 Thomas Sawyer
+# == Copyright (c) 2005 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
-# ============================================================================
+# == Author(s)
 #
-#  2004.05.24  trans  Wrote originally for AOP work.
-#  2005.08.24  trans  Minor modifications to documentation.
-#
-# ============================================================================
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2005 Thomas Sawyer
+# License::   Ruby License
+
+require 'facet/binding'
+
+# = CodePoint
 #
-#++
+# This is the same as a Binding. Not really needed, but I like consistency :)
+
+CodePoint = Binding
 
-#:title: TracePoint
+# = TracePoint
 #
 # A TracePoint is a Binding with the addition of event information.
 # Among other things, it functions very well as the join-point for
@@ -44,13 +48,10 @@
 #   Fixnum  +       c-call     false   false
 #   Fixnum  +       c-return   false   false
 #
-
-require 'facet/binding'
-
-# This is the same as a Binding. Not really needed, but I like consistency :)
-CodePoint = Binding
-
+# == Notes
+#
 # You can't subclass Binding, so we delegate (which is better anyway).
+
 class TracePoint  #< Codepoint
 
   # -- class ---------------------

data/lib/facets/more/tuple.rb

@@ -1,47 +1,35 @@
-#--
-# Tuple
-# Copyright (c) 2005 Thomas Sawyer
+# = tuple.rb
 #
-# Ruby License
+# == Copyright (c) 2005 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 History:
-# ==========================================================================
+#   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.
 #
-#  2006-04-10 trans
-#    Made thread safe (I hope) by using Multiton; No longer subclass
-#    of Array; and improved generally.
+# ===Author(s)
 #
-#  2005-11-16 trans
-#    Improved comparison operators to convert non-tuple parameters
-#    into Tuples.
-#
-#  2005.04.24 trans
-#    Adjusted to use Tuple::[] instead of ::new, which now takes a single
-#    argument, either an Array or a String which it splits.
-#
-#  2005.04.24 trans
-#    Created.
+# * Thomas Sawyer
 #
-# ==========================================================================
+# ===Developer Notes
 #
-# TODO The #hash method needs a touch-up.
+#   TODO The #hash method needs a touch-up.
 #
-# TODO There are a few more methods yet to borrow from Array.
-#      Consider how #+, #-, etc. ought to work.
+#   TODO There are a few more methods yet to borrow from Array.
+#        Consider how #+, #-, etc. ought to work.
 #
-#++
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2005 Thomas Sawyer
+# License::   Ruby License
 
 require 'facets/more/multiton'
 
-#:title: Tuple
+# = Tuple
 #
 # Tuple is essentially an Array, but Comaparable and Immutable.
 #
@@ -66,11 +54,6 @@ require 'facets/more/multiton'
 #   t1 == t2  #=> true
 #
 # Keep in mind that Tuple[1,2,3] is not the same as Tuple['1','2','3'].
-#
-# == Author(s)
-#
-# * Thomas Sawyer
-#
 
 class ::Tuple
 
@@ -231,17 +214,17 @@ public
 
     # Parses a constraint returning the operation as a lambda.
 
-    def parse_constraint( constraint )
+    def parse_constraint( constraint, &yld )
       constraint = constraint.strip
-      re = %r{^(=~|~>|<=|>=|==|=|<|>)?(\d+(:?[-.]\d+)*)$}
+      re = %r{^(=~|~>|<=|>=|==|=|<|>)?\s*(\d+(:?[-.]\d+)*)$}
       if md = re.match( constraint )
         if op = md[1]
           op = '=~' if op == '~>'
           op = '==' if op == '='
-          val = new( md[2] )
+          val = cast_from_string( md[2], &yld ) #new( md[2] )
         else
           op = '=='
-          val = new( constraint )
+          val = cast_from_string( constraint, &yld ) #new( constraint )
         end
       else
         raise ArgumentError, "invalid constraint"
@@ -249,8 +232,8 @@ public
       return op, val
     end
 
-    def constraint_to_lambda( constraint )
-      op, val = *parse_constraint( constraint )
+    def constraint_to_lambda( constraint, &yld )
+      op, val = *parse_constraint( constraint, &yld )
       lambda { |t| t.send(op, val) }
     end
 

data/lib/facets/more/typecast.rb

@@ -1,28 +1,37 @@
-#--
-# TypeCast
+# = typecast.rb
 #
-# Copyright (c) 2004,2005 Jonas Pfenniger
+# == Copyright (c) 2004 Jonas Pfenniger
 #
-# 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 Notes
-# ==========================================================================
-#  Consider how this might fit in with method signitures, overloading,
-#  and expiremental euphoria-like type system.
-# ==========================================================================
+# == Author(s)
+#
+# * Jonas Pfenniger
 #
-# TODO : look to implement to_int, to_mailtext, to_r, to_rfc822text and to_str
-#++
+# == Developer Notes
+#
+#   TODO Consider how this might fit in with method signitures, overloading,
+#        and expiremental euphoria-like type system.
+#
+#   TODO Look to implement to_int, to_mailtext, to_r, to_rfc822text and to_str.
+
+# Author::    Jonas Pfenniger
+# Copyright:: Copyright (c) 2004 Jonas Pfenniger
+# License::   Ruby License
+
+require 'time'
+
+require 'facet/string/methodize'
+require 'facet/string/modulize'
 
-#:title: TypeCast
+# = TypeCast
 #
 # Provides a generic simple type conversion utility. All the ruby core
 # conversions are available by default.
@@ -79,15 +88,6 @@
 #   time you call cast_to, you either get your result, either a
 #   TypeCastException
 #
-# == Author(s)
-#
-# * Jonas Pfenniger
-#
-
-require 'time'
-
-require 'facet/string/methodize'
-require 'facet/string/modulize'
 
 class Object
 
@@ -119,8 +119,6 @@ class Object
   end
 end
 
-# Extend the ruby core
-
 class Array
   class << self
     def cast_from(object, options={})

data/lib/facets/more/uninheritable.rb

@@ -1,28 +1,25 @@
-#--
-# Uninheritable
+# = uninheritable.rb
 #
-# Copyright (c) 2003 Austin Ziegler
+# == Copyright (c) 2003 Austin Ziegler
 #
-# 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
-# ==========================================================================
-#
-#  2003.9.17  Austin Ziegler
-#    - Minor modifications to documentation.
+# == Author(s)
 #
-# ==========================================================================
-#++
+# * Austin Ziegler
+
+# Author::    Austin Ziegler
+# Copyright:: Copyright (c) 2003 Austin Ziegler
+# License::   Ruby License
 
-#:title: Uninheritable
+# = Uninheritable
 #
 # Allows an object to declare itself as unable to be subclassed. The
 # technique behind this is very simple (redefinition of #inherited), so this
@@ -37,10 +34,6 @@
 #
 #   class B < A; end # => raises TypeError
 #
-# == Author(s)
-#
-# * Austin Ziegler
-#
 
 module Uninheritable
   # Redefines a class's #inherited definition to prevent subclassing of the