facets 1.3.3 → 1.4.0

data/lib/facets/more/orderedhash.rb

@@ -1,3 +1,7 @@
 require 'facets/more/dictionary'
 
+# = OrderedHash
+#
+# OrderedHash is an alias for the Dictionary class
+
 OrderedHash = Dictionary

data/lib/facets/more/ormsupport.rb

@@ -1,43 +1,28 @@
-#--
-# ORMSupport
-#
-# Copyright (c) 2004,2005 Thomas Sawyer
-#
-# Ruby License
+# = ormsupport.rb
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+# == Copyright (c) 2004 George Moschovitis, Thomas Sawyer
 #
-# 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.
+#   Ruby License
 #
-# ==========================================================================
-#  Revision History
-# ==========================================================================
-#
-#  5.8.25 Trans
-#    - Created based on a set of methods from Rails. Spruced up to support
-#      Multiple frameworks, mainly Nitro.
-#
-# ==========================================================================
-#++
-
-#:title: ORMSupport
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
 #
-# Provides a number of basc convenience methods for working with Object
-# Relational Mappings.
+#   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.
 #
-# == Usage
+# == Special Thanks
 #
-#  TODO
+# Big thanks to DHH and Rails.
 #
 # == Author(s)
 #
-# * D.H.H.
 # * George Moschovitis
 # * Thomas Sawyer
-#
+
+# Author::    George Moschovitis, Thomas Sawyer
+# Copyright:: Copyright (c) 2005 George Moschovitis, Thomas Sawyer
+# License::   Ruby License
 
 require 'facet/inflect'
 
@@ -45,6 +30,10 @@ require 'facet/module/attr_setter'
 require 'facet/module/basename'
 require 'facet/string/to_const'
 
+# = ORMSupport
+#
+# Provides a number of basc convenience methods for working with Object
+# Relational Mapping.
 
 module ORMSupport
 

data/lib/facets/more/overload.rb

@@ -1,6 +1,42 @@
-#!/usr/bin/env ruby
+# = overload.rb
+#
+# == Copyright (c) 2005 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.
+#
+# == Author(s)
+#
+# * Thomas Sawyer
 
-# overload methods
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
+
+# = Overload
+#
+# Overload methods.
+#
+#   class X
+#     def x
+#       "hello"
+#     end
+#
+#     overload :x, Integer do |i|
+#       i
+#     end
+#
+#     overload :x, String, String do |s1, s2|
+#       [s1, s2]
+#     end
+#   end
+#
 
 class Module
 
@@ -13,7 +49,7 @@ class Module
 
     if method_overloads.key?( name )
       method_overloads[name][signiture] = block
-  
+
     else
       method_overloads[name] = {}
       method_overloads[name][signiture] = block

data/lib/facets/more/paramix.rb

@@ -1,30 +1,28 @@
-#--
-# Parametric Mixins
+# = paramix.rb
 #
-# Copyright (c) 2005 Thomas Sawyer and George Moschovitis
+# == Copyright (c) 2005 Thomas Sawyer, 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.
 #
-# ==========================================================================
-#  Revision History
-# --------------------------------------------------------------------------
-#  2005-12-02  trans     * Simplified into fine elegance.
-#  2005-09-19  trans     * Cleaned up and renamed.
-#  2005-04-28  trans     * Added to Calibre.
-# ==========================================================================
+# == Author(s)
 #
-#++
+# * Thomas Sawyer
+# * George Moschovitis
+
+# Author::    Thomas Sawyer, George Moschovitis
+# Copyright:: Copyright (c) 2005 Thomas Sawyer, George Moschovitis
+# License::   Ruby License
 
 require 'facet/module/basename'
 
-#:title: Parametric Mixins
+# = Parametric Mixins
 #
 # Parametric Mixins provides parameters for mixin modules.
 # Module parameters can be set at the time of inclusion or extension,
@@ -82,12 +80,6 @@ require 'facet/module/basename'
 # We would prefer to have passed the parameters through the #included callback
 # method itself, but implementation of such a feature is much more complicated.
 # If a reasonable solution presents itself in the future however, we will fix.
-#
-# == Author(s)
-#
-# * George Moschovitis
-# * Thomas Sawyer
-#
 
 class Module
 

data/lib/facets/more/pathlist.rb

@@ -1,27 +1,25 @@
-#--
-# PathList
+# = pathlist.rb
 #
-# Copyright (c) 2004,2005 Thomas Sawyer
+# == Copyright (c) 2005 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 History
-# ==========================================================================
-#
-# * Empty
+# == Author(s)
 #
-# ==========================================================================
-#++
+# * Jonas Pfenniger
+
+# Author::    Jonas Pfenniger
+# Copyright:: Copyright (c) 2005 Jonas Pfenniger
+# License::   Ruby License
 
-#:title: PathList
+# = PathList
 #
 # A Path is an array containing 1..n paths. It is useful to regroup paths and
 # make lookups on them.
@@ -38,10 +36,6 @@
 #
 #  $:.find 'uri'              #=> "/usr/lib/ruby/1.8/uri.rb"
 #
-# == Author(s)
-#
-# * Jonas Pfenniger
-#
 
 class PathList < Array
 
@@ -94,8 +88,8 @@ $:.find_ext = 'rb'
 
   require 'test/unit'
 
-  # It is not possible to test file lookups in a platform independent manner
-
+  # Needs a Mockup
+  # It is not possible to test file lookups in a platform independent manner.
 
   class TC_PathList < Test::Unit::TestCase
 

data/lib/facets/more/pool.rb

@@ -1,44 +1,36 @@
-#--
-# Pool
+# = pool.rb
 #
-# 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.
-#
-# ==========================================================================
-# Revision History ::
-# --------------------------------------------------------------------------
-#  05.04.11  Trans   * Ported.
-# ==========================================================================
-#
-# INVESTIGATE Could use the SizedQueue/Queue.
-#
-#++
-
-#:title: Pool
-#
-# Generalized object pool implementation. Implemented as a thread 
-# safe stack. Exclusive locking is needed both for push and pop. 
-#
-# == Usage
-#
-#   TODO
+#   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)
 #
-# * George Moschovitis  <gm@navel.gr>
+# * George Moschovitis
+#
+# == Developer Notes
 #
+#   TODO Could use the SizedQueue/Queue ?
+
+# Author::    George Moschovitis
+# Copyright:: Copyright (c) 2004 Navel
+# License::   Ruby License
 
 require 'thread'
 require 'monitor'
 
+# = Pool
+#
+# Generalized object pool implementation. Implemented as a thread 
+# safe stack. Exclusive locking is needed both for push and pop. 
+
 class Pool < Array
 
   include MonitorMixin

data/lib/facets/more/pqueue.rb

@@ -0,0 +1,190 @@
+# = pqueue.rb
+#
+# == Copyright (c) 2005 K.Kodama
+#
+#   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 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.
+#
+# == Special Thanks
+#
+# Rick Bradley 2003/02/02, patch for Ruby 1.6.5. Thank you!
+#
+# == Author(s)
+#
+# * K.Kodama
+
+# Author::    K.Kodama
+# Copyright:: Copyright (c) 2005 K.Kodama
+# License::   Ruby License
+
+# = PQueue
+#
+# Priority queue with array based heap.
+
+class PQueue
+
+  attr_accessor :qarray # format: [nil, e1, e2, ..., en]
+  attr_reader :size # number of elements
+  attr_reader :gt # compareProc
+
+  def initialize(compareProc=lambda{|x,y| x>y})
+    # By default, retrieves maximal elements first. 
+    @qarray=[nil]; @size=0; @gt=compareProc; make_legal
+  end
+  private :initialize
+
+  def upheap(k)
+    k2=k.div(2); v=@qarray[k];
+    while ((k2>0)and(@gt[v,@qarray[k2]]));
+      @qarray[k]=@qarray[k2]; k=k2; k2=k2.div(2)
+    end;
+    @qarray[k]=v;
+  end
+  private :upheap
+
+  def downheap(k)
+    v=@qarray[k]; q2=@size.div(2)
+    loop{
+      if (k>q2); break; end;
+      j=k+k; if ((j<@size)and(@gt[@qarray[j+1],@qarray[j]])); j=j+1; end;
+      if @gt[v,@qarray[j]]; break; end;
+      @qarray[k]=@qarray[j]; k=j;
+    }
+    @qarray[k]=v;
+  end;
+  private :downheap
+
+  def make_legal
+    for k in 2..@size do; upheap(k); end;
+  end;
+
+  def empty?
+    return (0==@size)
+  end
+
+  def clear
+    @qarray.replace([nil]); @size=0;
+  end;
+
+  def replace_array(arr=[])
+    # Use push_array.
+    @qarray.replace([nil]+arr); @size=arr.size; make_legal
+  end;
+
+  def clone
+    q=new; q.qarray=@qarray.clone; q.size=@size; q.gt=@gt; return q;
+  end;
+
+  def push(v)
+    @size=@size+1; @qarray[@size]=v; upheap(@size);
+  end;
+
+  def push_array(arr=[])
+    @qarray[@size+1,arr.size]=arr; arr.size.times{@size+=1; upheap(@size)}
+  end;
+
+  def pop
+    # return top element.  nil if queue is empty.
+    if @size>0;
+      res=@qarray[1]; @qarray[1]=@qarray[@size]; @size=@size-1;
+      downheap(1);
+      return res;
+    else return nil
+    end;
+  end;
+
+  def pop_array(n=@size)
+    # return top n-element as an sorted array. (i.e. The obtaining array is decreasing order.)
+    # See also to_a.
+    a=[]
+    n.times{a.push(pop)}
+    return a
+  end;
+
+  def to_a
+    # array sorted as increasing order.
+    # See also pop_array.
+    res=@qarray[1..@size];
+    res.sort!{|x,y| if @gt[x,y]; 1;elsif @gt[y,x]; -1; else 0; end;}
+    return res
+  end
+
+  def top
+    # top element. not destructive.
+    if @size>0; return @qarray[1]; else return nil; end;
+  end;
+
+  def replace_top_low(v)
+    # replace top element if v<top element.
+    if @size>0; @qarray[0]=v; downheap(0); return @qarray[0];
+    else @qarray[1]=v; return nil;
+    end;
+  end;
+
+  def replace_top(v)
+    # replace top element
+    if @size>0; res=@qarray[1]; @qarray[1]=v; downheap(1); return res;
+    else @qarray[1]=v; return nil;
+    end;
+  end;
+
+  def each_pop
+    # iterate pop. destructive. Use as self.each_pop{|x| ... }. 
+    while(@size>0); yield self.pop; end;
+  end;
+
+  def each_with_index
+    # Not ordered. Use as self.each_with_index{|e,i| ... }. 
+    for i in 1..@size do; yield @qarray[i],i; end;
+  end
+
+end # class PQueue
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin test
+
+  require 'test/unit'
+
+  # TODO Expand on these tests.
+
+  class TC01 < Test::Unit::TestCase
+
+    def setup
+      @pq=PQueue.new(proc{|x,y| x>y})
+    end
+
+    def test_01
+      @pq.push(2)
+      @pq.push(3)
+      @pq.push(4)
+      @pq.push(3)
+      @pq.push(2)
+      @pq.push(4)
+      @pq.push_array([3,5,4])
+      assert_equal( 9, @pq.size )
+      assert_equal( [2, 2, 3, 3, 3, 4, 4, 4, 5], @pq.to_a )
+    end
+  end
+
+=end