facets 1.3.3 → 1.4.0

data/lib/facets/more/units.rb

@@ -1,27 +1,32 @@
-#--
-# Units
+# = units.rb
 #
-# Copyright (c) 2005 Peter Vanbroekhoven & Thomas Sawyer
+# == Copyright (c) 2005 Peter Vanbroekhoven
 #
-# 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.10.01  peter   Finished
-#  2005.08.01  trans   Started
-# ==========================================================================
+# == Author(s)
 #
-#++
+# * Peter Vanbroekhoven
+
+# Author::    Peter Vanbroekhoven
+# Copyright:: Copyright (c) 2005 Peter Vanbroekhoven
+# License::   Ruby License
 
-# :title: Units
+require 'rbconfig'
+require 'soap/wsdlDriver'
+require 'yaml'
+
+# this is needed until RubyGems provides fix to access data path
+require 'facet/gem/self/gempath'
+
+# = Units
 #
 # This is a very extensive SI units system.
 #
@@ -41,19 +46,8 @@
 #   1.mile.to(km)
 #   1.usd.to(twd)
 #
-# == Author(s)
+# == Notes
 #
-# * Peter Vanbroekhoven
-# * Thomas Sawyer
-#
-
-require 'rbconfig'
-require 'soap/wsdlDriver'
-require 'yaml'
-
-# this is needed until RubyGems provides fix to access data path
-require 'facet/gem/self/gempath'
-
 # The namespace for all unit related classes. Mixing this in has the additional effect
 # of making Units.with_unit_converter available without the <code>Units.</code> prefix,
 # as well as the shortcuts for creating Units (see Units#method_missing).

data/lib/facets/more/xmlbuilder.rb

@@ -1,34 +1,32 @@
-#--
-# XMLBuilder
-# Copyright (c) 2006 Thomas Sawyer
+# = xmlbuilder.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 History
-# --------------------------------------------------------------------------
-#  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.
+#
+# == Author(s)
+#
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 require 'facets/more/builderobject.rb'
 require 'facets/more/xmlhelper.rb'
 
-#:title: XMLBuilder
-#
-# XMLBuilder follows the _Builder Pattern_ allowing XML markup to be
-# constructed via Ruby method calls and block structures.
+# = XMLBuilder
 #
-# Author::   Thomas Sawyer
-# Copright:: Copyright (c) 2006 Thomas Sawyer
-# License::  Ruby License
+# XMLBuilder follows the <em>Builder Pattern</em> allowing XML markup to be
+# constructed via Ruby method calls and block structures. XMLBuilder is
+# a subclass of BuilderObject --see BuilderObject for more details.
 
 class XMLBuilder < BuilderObject
 

data/lib/facets/more/xmlhelper.rb

@@ -1,24 +1,25 @@
-#--
-# XMLHelper
-# Copyright (c) 2006 Thomas Sawyer
+# = xmlhelper.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 History
-# --------------------------------------------------------------------------
-#  2006-04-18  trans  Created.
-# ==========================================================================
-#++
-
-# :title: XMLHelper
+#   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)
+#
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
+
+# = XMLHelper
 #
 # XMLHelper is a utility module which provides methods the ease the
 # creation of XML markup.
@@ -32,10 +33,6 @@
 #
 #   <a><b>X</b></a>
 #
-# == Author(s)
-#
-# * Thomas Sawer
-#
 
 module XMLHelper
 

data/lib/facets/more/xoxo.rb

@@ -1,21 +1,33 @@
-#--
-# XOXO
+# = xoxo.rb
 #
-# Ported from xoxo.rb at http://chneukirchen.org/repos/xoxo-rb/
-# Copyright (C) 2006 Christian Neukirchen
+# == Copyright (C) 2006 Christian Neukirchen
 #
-# 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.
+#
+# == Special Thanks
+#
+# Special thanks go to Christian Neukirchen for xoxo.rb.
+# * http://chneukirchen.org/repos/xoxo-rb/.
+#
+# == Author(s)
+#
+# * Christian Neukirchen
+
+# Author::    Christian Neukirchen
+# Copyright:: Copyright (c) 2006 Christian Neukirchen
+# License::   Ruby License
 
 require 'rexml/parsers/pullparser'
 
+# = XOXO
+#
 # XOXO is a Ruby XOXO parser and generator. It provides
 # a Ruby API similar to Marshal and YAML (though more
 # specific) to load and dump XOXO[http://microformats.org/wiki/xoxo],

data/lib/facets/more/yamlstruct.rb

@@ -1,37 +1,40 @@
-#--
-# YAMLStruct
+# = yamlstruct.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
-# ==========================================================================
-#  2005-09-13  trans  Created.
-# ==========================================================================
+# == Author(s)
+#
+# * Thomas Sawyer
 #
-# TODO Currently only supports YAML documents with a map at the top level.
+# == Developer Notes
 #
-#++
+#   TODO Currently only supports YAML documents with a map at the top-level.
+#        Conceivably it could support any object.
+#
+#   TODO Is this the best name for this class? Maybe YAMLObject would be better?
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 require 'yaml'
 
-#:title: YAMLStruct
+# = YAMLStruct
 #
-# TODO
-#
-# == Author(s)
-#
-# * Thomas Sawyer
+# Takes a YAML document and makes it accessable via a delgate object.
 #
+# Currently this only supports YAML documents with a map at the top-level.
+# But this should be easy enough to adjust in the future if it proves
+# useful.
 
 class YAMLStruct
 

data/test/lib/facets/core/array/test_at_rand.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/at_rand.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_delete_unless.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/delete_unless.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_delete_values.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/delete_values.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_delete_values_at.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/delete_values_at.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_first.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/first.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_head.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/head.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_last_index.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/last_index.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_merge.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/merge.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_mid.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/mid.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_middle.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/middle.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_op_fetch.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/op_fetch.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_op_store.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/op_store.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_pick.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/pick.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_pos.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/pos.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_pot.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/pot.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_pull.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/pull.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #
 

data/test/lib/facets/core/array/test_rand_index.rb

@@ -6,7 +6,7 @@
 #
 # for lib/facets/core/array/rand_index.rb
 #
-# Extracted Thu May 04 17:46:31 EDT 2006
+# Extracted Mon Jun 05 08:14:29 EDT 2006
 # Unit Tools Reap Test Extractor
 #