facets 2.4.5 → 2.5.0

data/lib/core/facets/class/cattr.rb

@@ -8,9 +8,7 @@ class Class
   # method is not carried along. So it is now just a Class
   # method. Accordingly, #mattr has been deprecated.
   #
-  #  CREDIT: David Heinemeier Hansson
-  #  CREDIT: Ara T. Howard (for suggesting)
-
+  # CREDIT: David Heinemeier Hansson
   def cattr( *syms )
     writers, readers = syms.flatten.partition{ |a| a.to_s =~ /=$/ }
     writers = writers.collect{ |e| e.to_s.chomp('=').to_sym }
@@ -31,8 +29,7 @@ class Class
   #   MyClass.a           #=> 10
   #   MyClass.new.a       #=> 10
   #
-  #  CREDIT: David Heinemeier Hansson
-
+  # CREDIT: David Heinemeier Hansson
   def cattr_reader( *syms )
     syms.flatten.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__)
@@ -67,8 +64,7 @@ class Class
   #   MyClass.new.a = 29
   #   MyClass.a            #=> 29
   #
-  #  CREDIT: David Heinemeier Hansson
-
+  # CREDIT: David Heinemeier Hansson
   def cattr_writer(*syms)
     syms.flatten.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__)
@@ -99,17 +95,18 @@ class Class
   #   MyClass.a           #=> 10
   #   mc = MyClass.new
   #   mc.a                #=> 10
-
+  #
+  # CREDIT: David Heinemeier Hansson
   def cattr_accessor(*syms)
     cattr_reader(*syms) + cattr_writer(*syms)
   end
 
 end
 
+# Not properly applicable to modules, so these have been deprecated.
 #class Module
   #alias_method :mattr,          :cattr            # deprecate
   #alias_method :mattr_reader,   :cattr_reader     # deprecate
   #alias_method :mattr_writer,   :cattr_writer     # deprecate
   #alias_method :mattr_accessor, :cattr_accessor   # deprecate
 #end
-

data/lib/core/facets/class/descendents.rb

@@ -9,7 +9,6 @@ class Class
   #
   # NOTE: This is a intesive operation. Do not
   # expect it to be super fast.
-
   def descendents
     subclass = []
     ObjectSpace.each_object( Class ) do |c|
@@ -27,7 +26,6 @@ class Class
     # NOTE: ActiveSupport returns string names rather
     # then actual classes, so this is excluded
     # if ActiveSupport has already been loaded.
-    #
     alias_method :subclasses, :descendents
 
   end

data/lib/core/facets/class/prepend.rb

@@ -22,12 +22,11 @@ class Class
   # Implementation of this method has some limitations,
   # in that it works by overriding #new and #allocate.
   #
-  # CREDIT Trans
+  # CREDIT: Trans
   #
   # TODO: Perhaps rename this to preallocate, b/c of
-  #       the way it works. It is not really a clean
-  #       prepend, like that of Module#prepend.
-
+  # the way it works. It is not really a clean
+  # prepend, like that of Module#prepend.
   def prepend( aspect )
     _new      = method(:new)
     _allocate = method(:allocate)

data/lib/core/facets/class/to_proc.rb

@@ -15,28 +15,8 @@ class Class
   #   %w(john bob jane hans).map(&Person) => [john, bob, jane, hans]
   #
   # CREDIT: Daniel Schierbeck
-
   def to_proc
     proc{|*args| new(*args)}
   end
 
 end
-
-
-
-=begin test
-  reqiure 'test/unit'
-
-  class TestClassConversion < Test::Unit::TestCase
-
-    Person = Struct.new(:name)
-
-    def test_to_proc
-      people = ["joe"].map(&Person)
-      assert_equal("joe", people[0].name)
-    end
-
-  end
-
-=end
-

data/lib/core/facets/comparable/at_least.rb

@@ -0,0 +1 @@
+require 'facets/comparable/cap'

data/lib/core/facets/comparable/at_most.rb

@@ -0,0 +1 @@
+require 'facets/comparable/cap'

data/lib/core/facets/comparable/bound.rb

@@ -1,65 +1 @@
-class String
-  def to_s
-    self
-  end
-end
-
-module Comparable
-
-  # Returns the lower of self or x.
-  #
-  #   4.at_least(5)  #=> 5
-  #   6.at_least(5)  #=> 6
-  #
-  #   CREDIT Florian Gross
-
-  def at_least(x)
-    (self >= x) ? self : x
-  end
-
-  # Returns the greater of self or x.
-  #
-  #   4.at_most(5)  #=> 4
-  #   6.at_most(5)  #=> 5
-  #
-  #   CREDIT Florian Gross
-
-  def at_most(x)
-    (self <= x) ? self : x
-  end
-
-  # Returns the greater of self or x.
-  #
-  #   4.cap(5)  #=> 4
-  #   6.cap(5)  #=> 5
-  #
-  #   CREDIT Trans
-
-  def cap(upper)
-    (self <= upper) ? self : upper
-  end
-
-  # Returns self if above the given lower bound, or
-  # within the given lower and upper bounds,
-  # otherwise returns the the bound of which the
-  # value falls outside.
-  #
-  #   4.clip(3)    #=> 4
-  #   4.clip(5)    #=> 5
-  #   4.clip(2,7)  #=> 4
-  #   9.clip(2,7)  #=> 7
-  #   1.clip(2,7)  #=> 2
-  #
-  #   CREDIT Trans
-
-  def bound(lower, upper=nil)
-    return lower if self < lower
-    return self unless upper
-    return upper if self > upper
-    return self
-  end
-
-  alias_method :clip, :bound
-
-end
-
+require 'facets/comparable/cap'

data/lib/core/facets/comparable/cap.rb

@@ -0,0 +1,34 @@
+module Comparable
+
+  # Returns the lower of self or x.
+  #
+  #   4.at_least(5)  #=> 5
+  #   6.at_least(5)  #=> 6
+  #
+  # CREDIT: Florian Gross
+
+  def at_least(lower)
+    (self >= lower) ? self : lower
+  end
+
+  # Returns the greater of self or x.
+  #
+  #   4.at_most(5)  #=> 4
+  #   6.at_most(5)  #=> 5
+  #
+  # CREDIT: Florian Gross
+
+  def at_most(upper)
+    (self <= upper) ? self : upper
+  end
+
+  # Returns the greater of self or x.
+  #
+  #   4.cap(5)  #=> 4
+  #   6.cap(5)  #=> 5
+  #
+  # CREDIT: Trans
+
+  alias_method :cap, :at_most
+
+end

data/lib/core/facets/comparable/clip.rb

@@ -0,0 +1,38 @@
+module Comparable
+
+  # Returns self if above the given lower bound, or
+  # within the given lower and upper bounds,
+  # otherwise returns the the bound of which the
+  # value falls outside.
+  #
+  #   4.clip(3)    #=> 4
+  #   4.clip(5)    #=> 5
+  #   4.clip(2,7)  #=> 4
+  #   9.clip(2,7)  #=> 7
+  #   1.clip(2,7)  #=> 2
+  #
+  # CREDIT Florian Gross, Trans
+
+  def clip(lower, upper=nil)
+    return lower if self < lower
+    return self unless upper
+    return upper if self > upper
+    return self
+  end
+
+  # Returns self if above the given lower bound, or
+  # within the given lower and upper bounds,
+  # otherwise returns the the bound of which the
+  # value falls outside.
+  #
+  #   4.bound(3)    #=> 4
+  #   4.bound(5)    #=> 5
+  #   4.bound(2,7)  #=> 4
+  #   9.bound(2,7)  #=> 7
+  #   1.bound(2,7)  #=> 2
+  #
+  # CREDIT: Florian Gross
+
+  alias_method :bound, :clip
+
+end

data/lib/core/facets/comparable/cmp.rb

@@ -9,14 +9,14 @@ module Comparable
   # This fundamental compare method is used to keep
   # comparison compatible with <tt>#succ</tt>.
   #
-  #   CREDIT Peter Vanbroekhoven
+  # CREDIT: Peter Vanbroekhoven
 
   def cmp(o)
     self<=>o
   end
 end
 
-class String 
+class String
 
   # Compare method that takes length into account.
   # Unlike #<=>, this is compatible with #succ.
@@ -26,7 +26,7 @@ class String
   #   "abc".cmp("abcd")  #=> -1
   #   "xyz".cmp("abc")   #=>  1
   #
-  #   CREDIT Peter Vanbroekhoven
+  # CREDIT: Peter Vanbroekhoven
 
   def cmp(other)
     return -1 if length < other.length

data/lib/core/facets/comparable/comparable.rb

@@ -24,7 +24,7 @@ class Module
   #     cmp = self.b <=> other.b; return cmp unless cmp == 0
   #     0
   #   end
-
+  #
   def Comparable(*accessors)
     define_method(:comparability){ accessors }
     code = %{

data/lib/core/facets/dir/ascend.rb

@@ -14,8 +14,7 @@ class Dir
   #   /var
   #   /
   #
-  #   CREDIT: Daniel Berger
-  #   CREDIT: Jeffrey Schwab
+  # CREDIT: Daniel Berger, Jeffrey Schwab
 
   def self.ascend(dir, inclusive=true, &blk)
     dir = dir.dup
@@ -43,8 +42,7 @@ class Dir
   #   /var
   #   /var/log
   #
-  #   CREDIT: Daniel Berger
-  #   CREDIT: Jeffrey Schwab
+  # CREDIT: Daniel Berger, Jeffrey Schwab
 
   def self.descend(path) #:yield:
     paths = path.split('/')
@@ -56,4 +54,3 @@ class Dir
   end
 
 end
-

data/lib/core/facets/dir/multiglob.rb

@@ -37,7 +37,6 @@ class Dir
   # This is very useful in collecting files as specificed by a configuration
   # parameter.
   #++
-
   def self.multiglob(*patterns)
     options  = (Hash === patterns.last ? patterns.pop : {})
 
@@ -76,7 +75,6 @@ class Dir
   #
   #   Dir.multiglob( 'folder', 'folder/**/**' )
   #
-
   def self.multiglob_r(*patterns)
     options = (Hash === patterns.last ? patterns.pop : {})
     matches = multiglob(*patterns)

data/lib/core/facets/dir/recurse.rb

@@ -3,8 +3,7 @@ class Dir
   # Recursively scan a directory and pass each file
   # to the given block.
   #
-  #   CREDIT: George Moschovitis
-
+  # CREDIT: George Moschovitis
   def self.recurse(path='.', &block)
     list = []
     stoplist = ['.', '..']

data/lib/core/facets/enumerable/accumulate.rb

@@ -10,6 +10,8 @@ module Enumerable
   #   groups.accumulate.users
   #
   # will return a list of users from all groups.
+  #
+  # CREDIT: George Moshchovitis
 
   def accumulate
     @_accumulate ||= Functor.new do |op, *args|

data/lib/core/facets/enumerable/cluster_by.rb

@@ -11,7 +11,7 @@ module Enumerable
   #
   #    [ ['a'], ['is'], ['this', 'test'] ]
   #
-  #  CREDIT Erik Veenstra
+  # CREDIT: Erik Veenstra
 
   def cluster_by(&b)
     group_by(&b).sort.transpose.pop || []   # group_by(&b).values ?

data/lib/core/facets/enumerable/collect.rb

@@ -5,7 +5,7 @@ module Enumerable
   #   a = [1,2,3].collect_with_index { |e,i| e*i }
   #   a  #=> [0,2,6]
   #
-  #   CREDIT: Gavin Sinclair
+  # CREDIT: Gavin Sinclair
 
   def collect_with_index
     r = []
@@ -32,7 +32,7 @@ module Enumerable
   #
   # NOTE: Perhaps nicer to have as added functionality for #compact.
   #
-  #  CREDIT: Trans
+  # CREDIT: Trans
 
   def compact_map(trash=nil, &block)
     y = []

data/lib/core/facets/enumerable/commonality.rb

@@ -12,7 +12,7 @@ module Enumerable
   #   # Returns all persons that share their last name with another person.
   #   persons.collisions { |person| person.last_name }
   #
-  #   CREDIT: Florian Gross
+  # CREDIT: Florian Gross
 
   def commonality( &block )
     had_no_block = !block

data/lib/core/facets/enumerable/count.rb

@@ -14,7 +14,7 @@ unless (RUBY_VERSION[0,3] == '1.9')
     #   e = { 'a' => 2, 'a' => 2, 'b' => 1 }
     #   e.count('a',2)  #=> 1
     #
-    #   CREDIT: Trans
+    # CREDIT: Trans
 
     def count(*c)
       self.select{ |*i| i == c }.length

data/lib/core/facets/enumerable/divide.rb

@@ -5,7 +5,7 @@ module Enumerable
   #   ['a1','b1','a2','b2'].divide(/^a/)
   #   => [['a1,'b1'],['a2','b2']]
   #
-  #  CREDIT: Trans
+  # CREDIT: Trans
 
   def divide(pattern)
     memo = []

data/lib/core/facets/enumerable/duplicates.rb

@@ -4,7 +4,7 @@ module Enumerable
   #
   #   [1,1,2,2,3,4,5].nonuniq  #=> [1,2]
   #
-  #   CREDIT: Martin DeMello
+  # CREDIT: Martin DeMello
 
   def nonuniq
     h1 = {}
@@ -30,7 +30,7 @@ module Enumerable
 
   # Return list of dulicate elements.
   #
-  #   CREDIT: Thibaut Barrère
+  # CREDIT: Thibaut Barrère
 
   alias_method :duplicates, :nonuniq
 

data/lib/core/facets/enumerable/each_by.rb

@@ -17,7 +17,7 @@ module Enumerable
   # the arity of the block. If each_slice ever suppots this
   # this method can be deprecated.
   #
-  #  CREDIT: Trans
+  # CREDIT: Trans
 
   def each_by(steps=nil, &block)
     if steps