facets 1.3.3 → 1.4.0

data/lib/facets/more/coroutine.rb

@@ -1,25 +1,25 @@
-#--
-# Coroutine
+# = coroutine.rb
 #
-# Copyright (c) 2005 Florian Frank
+# == Copyright (c) 2005 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.
 #
-# ==========================================================================
-# Revision History
-# ==========================================================================
-#  2005.04.28  1.0  Trans     * Ported to Calibre.
-# ==========================================================================
-#++
-
-#:title: Coroutine
+# == Author(s)
+#
+# * Florian Frank
+
+# Author::    Florian Frank
+# Copyright:: Copyright (c) 2005 Florian Frank
+# License::   Ruby License
+
+# = Coroutine
 #
 # Coroutines are program components like subroutines. Coroutines are more
 # generic and flexible than subroutines, but are less widely used in
@@ -63,10 +63,6 @@
 #
 #   Controller.run
 #
-# == Author(s)
-#
-# * Florian Frank
-#
 
 class Coroutine
 

data/lib/facets/more/crypt.rb

@@ -1,18 +1,39 @@
-# Crypt(3)
-# Version 0.2.0 2005-09-28
-
-# adapted by guillaume__dot__pierronnet_at__laposte__dot_net
-# based on http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/325204/index_txt
+# = crypt.rb
+#
+# == Copyright (c) 2005
+#
+#   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.
+#
+# == Special Thanks
+#
+# Adapted by guillaume__dot__pierronnet_at__laposte__dot_net based on
+# * http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/325204/index_txt
 # which is based on FreeBSD src/lib/libcrypt/crypt.c 1.2
-# http://www.freebsd.org/cgi/cvsweb.cgi/~checkout~/src/lib/libcrypt/crypt.c?rev=1.2&content-type=text/plain
+# * http://www.freebsd.org/cgi/cvsweb.cgi/~checkout~/src/lib/libcrypt/crypt.c?rev=1.2&content-type=text/plain
+#
+# Original License
+#
+#   "THE BEER-WARE LICENSE" (Revision 42):
+#   <phk@login.dknet.dk> wrote this file.  As long as you retain this notice you
+#   can do whatever you want with this stuff. If we meet some day, and you think
+#   this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
+#
+# == Authors and Contributors
+#
+# * Poul-Henning Kamp
 
-# Original license:
-# * "THE BEER-WARE LICENSE" (Revision 42):
-# * <phk@login.dknet.dk> wrote this file.  As long as you retain this notice you
-# * can do whatever you want with this stuff. If we meet some day, and you think
-# * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
+# Author::    Poul-Henning Kamp
+# Copyright:: Copyright (c) 2002 Poul-Henning Kamp
+# License::   Ruby License
 
-# This port adds no further stipulations.  I forfeit any copyright interest.
+# = Crypt(3)
 
 module Crypt
 

data/lib/facets/more/dictionary.rb

@@ -1,38 +1,33 @@
-#--
-# Dictionary
+# = dictionary.rb
 #
-# Copyright (c) 2005 Thomas Sawyer, Jan Molic
-# ported from OrderHash 2.0, Copyright (c) 2005 jan molic
+# == Copyright (c) 2005 Jan Molic, 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.
 #
-# ==========================================================================
-#  History
-# --------------------------------------------------------------------------
-#  2005-12-09 trans
-#  * Added #order_by, with which one can set internal sort order.
-#  * Added #<<, takes a two element [k,v] array and inserts.
-#  * Added ::auto which creates Dictionay sub-entries as needed.
-#  * Added ::alpha which creates a new Dictionary sorted by key.
+# == Special Thanks
 #
-#  2005-10-26  trans
-#  * changed name of class to Dictionary
-#  * fixed #update method
-#  * added #dup and #insert
+# Ported from OrderHash 2.0, Copyright (c) 2005 jan molic
 #
-#  2055-02-01  trans
-#  * ported from jan molic's OrderHash
-# ==========================================================================
-#++
+# Thanks to Andrew Johnson for his suggestions and fixes of Hash[],
+# merge, to_a, inspect and shift.
+#
+# == Authors and Contributors
+#
+# * Jan Molic
+# * Thomas Sawyer
+
+# Author::    Jan Molic, Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Jan Molic, Thomas Sawyer
+# License::   Ruby License
 
-#:title: Dictionary
+# = Dictionary
 #
 # The Dictionary class is a Hash that preserves order.
 # So it has some array-like extensions also. By defualt
@@ -68,16 +63,12 @@
 #   p hsh.keys                     #=> ["to_begin", "a", "c", "z"]
 #   p hsh.shift                    #=> ["to_begin", 30], if nothing remains, return nil
 #
-# == Author(s)
-#
-# * jan molic
-# * trans
-#
-# == Thanks
-#
-# Andrew Johnson for his suggestions and fixes of Hash[], merge,
-# to_a, inspect and shift.
+# == Usage Notes
 #
+# * You can use #order_by to set internal sort order.
+# * #<< takes a two element [k,v] array and inserts.
+# * Use ::auto which creates Dictionay sub-entries as needed.
+# * And ::alpha which creates a new Dictionary sorted by key.
 
 class Dictionary < Hash
 

data/lib/facets/more/downloader.rb

@@ -1,25 +1,29 @@
-#--
-# Downloader
+# = downloader.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-28 trans
-#  Moved to Calibre from Baker project.
-# ==========================================================================
+# == Authors and Contributors
 #
-#++
+# * Thomas Sawyer
+#
+# == Developer Noters
+#
+#   TODO This should be divied into two classes. The main Downloader
+#        should be independent of any interface. The second Console::Downloader
+#        using the first but with a console interface.
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 require 'digest/md5'
 require 'open-uri'
@@ -27,7 +31,7 @@ require 'open-uri'
 require 'facet/string/unbracket'
 require 'facets/more/progressbar'
 
-# :title: Downloader
+# = Downloader
 #
 # Tool module for downloading files and extracting
 # archive files. Currently this is console-based

data/lib/facets/more/elementor.rb

@@ -1,6 +1,28 @@
+# = elementor.rb
+#
+# == Copyright (c) 2006 Thomas 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.
+#
+# == Authors and Contributors
+#
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 require 'facets/more/basicobject'
 
+# = Elementor
+#
 # Elementor is an Array which applies calls elementwise.
 # Depending on the mode the call will return a
 # new elementor, the same elementor, a new array,

data/lib/facets/more/enumerablepass.rb

@@ -1,34 +1,32 @@
-#--
-# EnumerablePass
+# = enumerablepass.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.
 #
+# == Authors and Contributors
 #
-# ==========================================================================
-#  Changes
-# --------------------------------------------------------------------------
-#  05.10.31  Trans  Rewrote to use Enumerator and to build methods
-#                   dynamically based on Enumerable. So it essentially
-#                   always in sync. Renamed to EnumerablePass too.
-#
-#  04.06.01  Trans  Minor modifications to documentation.
-# ==========================================================================
-#++
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
+
+require 'enumerator'
 
-#:title: EnumerablePass
+# = EnumerablePass
 #
 # This is a simple reimplementation of the core Enumerable module
 # to allow the methods to take and pass-on arbitrary arguments to the
-# underlying #each call.
+# underlying #each call. This library uses Enumerator and scans
+# Enumerable so it can alwasy stay in sync.
 #
 # NOTE Any Enumerable method with a negative arity cannot do pass arguments
 # due to ambiguity in the argument count. So the methods #inject and #zip
@@ -53,12 +51,6 @@
 #   t.collect(4)
 #   #=> [5,6,7]
 #
-# == Author(s)
-#
-#   Thomas Sawyer
-#
-
-require 'enumerator'
 
 module EnumerablePass
 

data/lib/facets/more/expirable.rb

@@ -1,37 +1,27 @@
-#--
-# Expirable
+# = expirable.rb
 #
-# George Moschovitis
-# Copyright (c) 2004-2005 Navel, all rights reserved.
+# == 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-08-07  trans   * Ported to Calibre.
-# ==========================================================================
-#++
-
-#:title: Expirable
-#
-# Very generic expirability mixin.
-#
-# == Usage
-#
-#   TODO
-#
-# == Author(s)
+# == Author/Contributor
 #
 # * George Moschovitis
+
+# Author::    George Moschovitis
+# Copyright:: Copyright (c) 2004 Navel
+# License::   Ruby License
+
+# = Expirable
 #
+# Generic expirability mixin.
 
 module Expirable
 
@@ -61,9 +51,9 @@ module Expirable
   end
 
   # Update the expiration period. Override in your application.
-  
+
   def touch!
-  end  
+  end
 
 end
 

data/lib/facets/more/filelist.rb

@@ -1,37 +1,41 @@
-#--
-# FileList (ported from Rake)
+# = filelist.rb
 #
-# Copyright (C) 2002-2005 Jim Weirich
+# == Copyright (C) 2002-2005 Jim Weirich
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
+#   General Public License (GPL)
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+#   Permission is hereby granted, free of charge, to any person obtaining
+#   a copy of this software and associated documentation files (the
+#   "Software"), to deal in the Software without restriction, including
+#   without limitation the rights to use, copy, modify, merge, publish,
+#   distribute, sublicense, and/or sell copies of the Software, and to
+#   permit persons to whom the Software is furnished to do so, subject to
+#   the following conditions:
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#   The above copyright notice and this permission notice shall be
+#   included in all copies or substantial portions of the Software.
 #
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
-# ==========================================================================
-# Revision History ::
-# --------------------------------------------------------------------------
-#  05-09-06 v0.6.0 trans  * Ported from Rake
-#  05-04-28 v0.4.x trans  * Ported from Rake
-# ==========================================================================
-#++
-
-#:title: FileList
+# == Special Thanks
+#
+# FileList was ported from Jim Weirich's Rake.
+#
+# == Authors and Contributors
+#
+# * Jim Weirich
+
+# Author::    Jim Weirich
+# Copyright:: Copyright (c) 2002 Jim Weirich
+# License::   General Public License (GPL)
+
+# = FileList
 #
 # A FileList is essentially an array with helper methods
 # to make file manipulation easier.
@@ -67,7 +71,6 @@ class FileList
   end
   alias_method :dup, :clone
 
-
   # == Method Delegation
   #
   # The lazy evaluation magic of FileLists happens by implementing
@@ -201,7 +204,6 @@ class FileList
     self
   end
 
-
   # Clear all the exclude patterns so that we exclude nothing.
   def clear_exclude
     @exclude_patterns = []
@@ -338,7 +340,6 @@ class FileList
     collect { |fn| fn.ext(newext) }
   end
 
-
   # Grep each of the files in the filelist using the given pattern.
   # If a block is given, call the block on each matching line,
   # passing the file name, line number, and the matching line of
@@ -457,7 +458,7 @@ end # FileList
 # Need a  better solution, is there a way to fake the
 # filesystem?
 
-=begin #no test yet
+=begin #no test
 
   require 'test/unit'