facets 1.3.3 → 1.4.0

data/lib/facets/more/lisp.rb

@@ -1,31 +1,33 @@
-#--
-# Lisp Mixin
+# = lisp.rb
 #
-# Copyright (C) 2003,2004 Florian Frank
+# == Copyright (C) 2003 Florian Frank
 #
-# 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.
 #
+# == Author(s)
+#
+# * Florian Frank
 #
-# ==========================================================================
-# Revision History ::
-# --------------------------------------------------------------------------
-#  2005.04.12  1.1  TO   * Changed the name of Pair class to DottedPair.
-#                        * Added a new method #pair! which converts an array 
-#                          to a DottedPair. This is then used in #car and
-#                          #cdr to automatically convert arrays passed to 'em.
-#                        * Note: There may be other places that #pair! 
-#                          conversion is needed.
-# ==========================================================================
-#++
-
-#:title: Lisp Mixin
+# == Developers Notes
+#
+#   TODO Changed the name of Pair class to DottedPair (good change?)
+#        and then added a new method #pair! which converts an array
+#        to a DottedPair. This is then used in #car and
+#        #cdr to automatically convert arrays passed to 'em.
+#        There may be other places that #pair! conversion is needed.
+
+# Author::    Florian Frank
+# Copyright:: Copyright (c) 2003 Florian Frank
+# License::   Ruby License
+
+# = Lisp Mixin
 #
 # This module provides Lisp-like functional notation.
 # With this module it almost possible to write real
@@ -44,11 +46,6 @@
 #   end)
 #
 # A real programmer can write LISP in any language ;)
-#
-# == Author(s)
-#
-# * Florian Frank
-#
 
 module Lisp
 

data/lib/facets/more/lisp_format.rb

@@ -1,79 +1,92 @@
-#:title: Lisp Format
-#--
-# Lisp Format
-# v 0.3
+# = lisp_format.rb
 #
-# Copyright (C) 2003 Nikolai Weibull <source@pcppopper.org>.
+# == Copyright (C) 2003 Nikolai Weibull
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
+#   GNU Lesser General Public License (LGPL)
 #
-# This library 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.  See the GNU
-# Lesser General Public License for more details.
+#   This library is free software; you can redistribute it and/or
+#   modify it under the terms of the GNU Lesser General Public
+#   License as published by the Free Software Foundation; either
+#   version 2.1 of the License, or (at your option) any later version.
 #
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
+#   This library 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.  See the GNU
+#   Lesser General Public License for more details.
 #
-# ==========================================================================
-# Revision History ::
-# --------------------------------------------------------------------------
-# 2004-11-16  0.3  TO    * Ported en-masse as a "sub-space" of Lisp.
-# 2003-12-08  0.2  NW    * Releasing version 0.2.
-# ==========================================================================
-# To Do ::
-# * the floating point functions are rather horendous
-# ==========================================================================
-#++
-
-# = Description
+#   You should have received a copy of the GNU Lesser General Public
+#   License along with this library; if not, write to the Free Software
+#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 #
-# "So what is *ruby-lisp*?", you ask.  Well, it is a module for implementing nice
-# Lisp features for use in Ruby.  Currently the only sub-module that exists is
-# Lisp::Format, which implements Lisp's (format) function and its formatting
-# language.  For people not familiar with this language, it is a very expressive
-# string formatting language, much like sprintf()'s, but much more powerful.  It
-# allows for iteration, case conversion, conditionals, and much more.  If you
-# have ever felt stupid while creating a string iteratively, to print an array or
-# some such, this is definitely for you!
+# == Developer Notes
 #
-# This module contains various Lisp facilities that are of general usefulness.
-# Lisp's rich string formatting language is implemented in the Format module.
-# More modules may be added later.
+#   TODO The floating point functions are rather horendous.
 #
-# This has been (very simply) integrated into the namespace of Lsip from lisp.rb.
+#   TODO More modules may be added later.
 #
 # == Author(s)
 #
-# * Nikolai Weibull <source@pcppopper.org>
+# * Nikolai Weibull
 #
-# == More Information
+# == Additional Information
 #
 # The project website for ruby-lisp is currently located at
 # http://ned.rubyforge.org/.
-#
 
-#--
-# This module contains various Lisp facilities that are of general usefulness.
-# Lisp's rich string formatting language is implemented in the Format module.
-# More modules may be added later.
-#
-# TODO: the floating point functions are rather horendous.
-#++
+# Author::    Nikolai Weibull
+# Copyright:: Copyright (c) 2003 Nikolai Weibull <source@pcppopper.org>
+# License::   General Public License (GPL)
+
+# Lisp namespace.
 
 module Lisp
 
+  # Apply lisp format.
+
+  def self.format(format, *args)
+    begin
+      state = Format::State.new(args, Format::Output.new)
+      formatter = Format::Formatter.new(format, state)
+      formatter.run
+    rescue => e
+      puts 'Format error: ' + e.message
+      puts format
+      puts ' ' * (e.pos - 1) + '^' if e.respond_to? :pos
+      raise
+    end
+  end
+
+  # See Lisp::format.
+
+  def format(format, *args)
+    Lisp.format(format, *args)
+  end
+
+  # = Lisp::Format
+  #
+  # "So what is *ruby-lisp*?", you ask.  Well, it is a module for implementing nice
+  # Lisp features for use in Ruby.  Currently the only sub-module that exists is
+  # Lisp::Format, which implements Lisp's (format) function and its formatting
+  # language.  For people not familiar with this language, it is a very expressive
+  # string formatting language, much like sprintf()'s, but much more powerful.  It
+  # allows for iteration, case conversion, conditionals, and much more.  If you
+  # have ever felt stupid while creating a string iteratively, to print an array or
+  # some such, this is definitely for you!
+  #
+  # This module contains various Lisp facilities that are of general usefulness.
+  # Lisp's rich string formatting language is implemented in the Format module.
+  # More modules may be added later.
+  #
+  # This has been (very simply) integrated into the namespace of Lisp from lisp.rb.
+  #
   # This module implements the Common Lisp (format) function and it's language.
+
   module Format
 
     # An error, positioned somewhere in the input format.  This is used to be
     # able to show the user exactly where something failed in the input format
     # string.
-    module Positioned
+    module Positioned #:nodoc:
       # Create at a given position.
       def initialize(pos = -1)
         @pos = pos
@@ -83,32 +96,44 @@ module Lisp
       attr :pos, true
     end
 
-    # An argument was of the wrong type, or there aren't enough arguments. 
-    class ArgumentError < ArgumentError; include Positioned; end
+    # An argument was of the wrong type, or there aren't enough arguments.
+    class ArgumentError < ArgumentError #:nodoc:
+      include Positioned
+    end
 
     # An index was not valid.  Used for argument jumping errors.
-    class IndexError < IndexError; include Positioned; end
+    class IndexError < IndexError #:nodoc:
+      include Positioned
+    end
 
     # A parameter was wrong in some sense.
-    class ParameterError < ArgumentError; include Positioned; end
+    class ParameterError < ArgumentError #:nodoc:
+      include Positioned
+    end
 
     # The format string contained a syntax error.
-    class SyntaxError < SyntaxError; include Positioned; end
+    class SyntaxError < SyntaxError #:nodoc:
+      include Positioned
+    end
 
     # The format string was ended before a parameter could be read.
-    class MissingParameterError < SyntaxError; end
+    class MissingParameterError < SyntaxError #:nodoc:
+    end  
 
     # The format string was ended before a parameter could be completed.
-    class IncompleteParameterError < SyntaxError; end
+    class IncompleteParameterError < SyntaxError #:nodoc:
+    end
 
     # The format string was malformed somehow.
-    class MalformedError < SyntaxError; end
+    class MalformedError < SyntaxError #:nodoc:
+    end
 
     # A modifier was wrongly given, or there were too many of the same.
-    class ModifierError < SyntaxError; end
+    class ModifierError < SyntaxError #:nodoc:
+    end
 
     # Represents output for a State object.
-    class Output
+    class Output #:nodoc:
       # Create a new Output object.
       def initialize(str = '', col = 0)
         @output, @col = str, col
@@ -141,7 +166,7 @@ module Lisp
 
     # This class represents the state of a given Formatter.  It keeps track of
     # output gathered and arguments left to be processed.
-    class State
+    class State #:nodoc:
       # Create a state from arguments and a destination output
       def initialize(args, output)
         @args = args
@@ -212,12 +237,12 @@ module Lisp
     end
 
     # Given a format string, this class lexes it and returns directives it
-    # finds.  This includes gathering parameters and modifiers for the coming
+    # finds. This includes gathering parameters and modifiers for the coming
     # directives.  The necessary information to create a directive is gathered
     # and then passed to Directives::Factory#build.  Error checking
     # is performed, so that incomplete parameters are caught and malformed
     # modifiers are supressed.
-    class Lexer
+    class Lexer #:nodoc:
       @@errorstates = {
         :START => [MissingParameterError,
           'format string ended before parameter was found'],
@@ -374,7 +399,7 @@ module Lisp
     # directives/tokens are added to the current stack level.  When a directive
     # removes a level of nesting the previous level's last directive gets
     # connected, using Directive#connect.
-    class Parser
+    class Parser #:nodoc:
       # Create a Parser, given a Lexer, +lexer+.
       def initialize(lexer)
         @lexer = lexer
@@ -410,7 +435,7 @@ module Lisp
     # Engine for the format Lexer and Parser.  Given an input format string and
     # an initial State, it lets the Parser create the directives and then
     # simply iterates over them, Directive#execute:ing them each.
-    class Formatter
+    class Formatter #:nodoc:
       # Create a Formatter from a String +format+ and a State +state+.
       def initialize(format, state)
         @parser, @state = Parser.new(Lexer.new(format)), state
@@ -425,7 +450,7 @@ module Lisp
 
     # This module includes format parameter representation classes.  These are
     # passed to directives when they are created.
-    module Parameters
+    module Parameters #:nodoc: all
       # Base class from which the sub-classes get their behavior.  Every
       # parameter should sub-class from this class.
       class Parameter
@@ -494,7 +519,7 @@ module Lisp
     # the Lisp formatting embedded language.  The base class for all directives
     # is aptly named Directive, and all directive classes should sub-class from
     # it.
-    module Directives
+    module Directives #:nodoc: all
       # An unknown directive was found in the format string.
       class UnknownDirectiveError < SyntaxError; end
 
@@ -1789,23 +1814,6 @@ module Lisp
 
   end #module Format
 
-  def Lisp.format(format, *args)
-    begin
-      state = Format::State.new(args, Format::Output.new)
-      formatter = Format::Formatter.new(format, state)
-      formatter.run
-    rescue => e
-      puts 'Format error: ' + e.message
-      puts format
-      puts ' ' * (e.pos - 1) + '^' if e.respond_to? :pos
-      raise
-    end
-  end
-
-  def format(format, *args)
-    Lisp.format(format, *args)
-  end
-
 end #module Lisp
 
 

data/lib/facets/more/lrucache.rb

@@ -1,25 +1,25 @@
-#--
-# LRUCache
+# = lrucache.rb
 #
-# Copyright (c) 2004-2005 Navel
+# == Copyright (c) 2004 Navel
 #
-# 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.05.10  Trans   * Added to Calibre
-# ============================================================================
-#++
-
-# :title: Least Recently Used Cache
+# == Author(s)
+#
+# * George Moschovitis
+
+# Author::    George Moschovitis, Anastasios Koutoumanos
+# Copyright:: Copyright (c) 2005 Navel
+# License::   Ruby License
+
+# = LRUCache
 #
 # A cache utilizing a simple LRU (Least Recently Used) policy.
 # The items managed by this cache must respond to the #key method.
@@ -28,16 +28,6 @@
 # LRU semantics are enforced by inserting the items in a queue.
 # The lru item is always at the tail. Two special sentinels
 # (head, tail) are used to simplify (?) the code.
-#
-# == Usage
-#
-#   TODO: If you have an example of using this, please submit. -T
-#
-# == Author(s)
-#
-# * George Moschovitis  <gm@navel.gr>
-# * Anastasios Koutoumanos  <ak@navel.gr>
-#
 
 class LRUCache < Hash
 

data/lib/facets/more/mathconstants.rb

@@ -1,44 +1,33 @@
-#--
-# Math Constants
+# = mathconstants.rb
 #
-# Copyright (C) 1996, 1997, 1998, 1999, 2000 Brian Gough
-# Copyright (C) 2003 Daniel Carrera
+# == Copyright (C) 2003 Daniel Carrera, Brian Gough
 #
-# GNU General Public License
+#   GNU General Public License
 #
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or (at
-# your option) any later version.
+#   This program is free software; you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation; either version 2 of the License, or (at
+#   your option) any later version.
 #
-# 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.  See the GNU
-# General Public License for more details.
+#   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.  See the GNU
+#   General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#   You should have received a copy of the GNU General Public License
+#   along with this program; if not, write to the Free Software
+#   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 #
-# ==========================================================================
-# Revision History
-# --------------------------------------------------------------------------
-#  2004.12.01  Trans
-#    - Ported to Ruby Calibre.
-#
-#  2003.01.01  Daniel
-#    - Made the installation script a bit nicer.
-#    - Reorganized the documentation.
-#    - Added a few aliases (e.g. ATOMIC_MASS == UNIFIED_ATOMIC_MASS)
-#    - Changed a few constant names.
+# == Author(s)
 #
-#  2000.01.01  Brian
-#    - First stable version.
-#    - There should be no bugs at this point.
-# ==========================================================================
-#++
+# * Daniel Carrera
+# * Brian Gough
+
+# Author::    Daniel Carrera, Brian Gough
+# Copyright:: Copyright (c) 2003 Daniel Carrera, Brian Gough
+# License::   GNU General Public License (GPL)
 
-#:title: Math Constants
+# = Math Constants
 #
 # Large assortment of real world contants. The constants are stored in
 # the Math::Constants module, but this is included in Math for direct
@@ -47,18 +36,11 @@
 #
 # == Synopsis
 #
-#   require 'facet/mathconstants'
-#
 #   Math::SPEED_OF_LIGHT                   #=> 2.99792458e8
 #   Math::CGS::SPEED_OF_LIGHT              #=> 2.99792458e10
 #   Math::Constants::SPEED_OF_LIGHT        #=> 2.99792458e8
 #   Math::Constants::CGS::SPEED_OF_LIGHT   #=> 2.99792458e10
 #
-# == Author(s)
-#
-# * Brian Gough
-# * Daniel Carrera
-#
 
 module Math