facets 2.8.4 → 2.9.0.pre.1

data/lib/core/facets/array/thru.rb

@@ -0,0 +1 @@
+require 'facets/array/from'

data/lib/core/facets/array/traverse.rb

@@ -7,13 +7,12 @@ class Array
   #
   #   g = h.traverse{ |e| e.downcase }
   #
-  #   g = ["a", "b", ["x", "y"]]
+  #   g  #=> ["a", "b", ["x", "y"]]
   #
   # This is the same as <code>recursive.map</code> and will
   # likely be deprecated in the future because of it.
   #
   # CREDIT: Trans
-
   def traverse(&block)
     if block_given?
       map do |e|
@@ -28,9 +27,15 @@ class Array
     end
   end
 
-  # Like #recursive_map, but will change the
-  # array in place.
-
+  # Like #recursive_map, but will change the array in place.
+  #
+  #   h = ["A", "B", ["X", "Y"]]
+  #
+  #   h.traverse!{ |e| e.downcase }
+  #
+  #   h  #=> ["a", "b", ["x", "y"]]
+  #
+  # CREDIT: Trans
   def traverse!(&block)
     replace(traverse(&block))
   end

data/lib/core/facets/array/uniq_by.rb

@@ -1,17 +1,15 @@
-require 'facets/enumerable/uniq_by'
-
 class Array
 
   # Like #uniq, but determines uniqueness based on a given block.
   #
-  #   (-5..5).to_a.uniq_by {|i| i*i }
-  #
-  # produces
-  #
-  #   [-5, -4, -3, -2, -1, 0]
+  #   a = (-5..5).to_a
+  #   a.uniq_by!{ |i| i*i }
+  #   a #=> [-5, -4, -3, -2, -1, 0]
   #
+  # As can be seen in the example, order is significant.
   def uniq_by! #:yield:
-    h = {}; replace(inject([]){|a,x| h[yield(x)] ||= a << x})
+    h = {}
+    replace( inject([]){|a,x| h[yield(x)] ||= a << x} )
   end
 
 end

data/lib/core/facets/binding/__callee__.rb

@@ -0,0 +1 @@
+require 'facets/binding/caller'

data/lib/core/facets/binding/__method__.rb

@@ -0,0 +1 @@
+require 'facets/binding/caller'

data/lib/core/facets/binding/call_stack.rb

@@ -0,0 +1 @@
+require 'facets/kernel/call_stack'

data/lib/core/facets/binding/caller.rb

@@ -1,5 +1,6 @@
 require 'facets/binding/eval'
-require 'facets/binding/callstack'
+require 'facets/binding/call_stack'
+require 'facets/kernel/__method__'
 
 class Binding
 
@@ -29,14 +30,14 @@ class Binding
 
   # Retreive the current running method.
   #
-  def __callee__
-    Kernel.eval("__callee__", self)
+  def __method__
+    Kernel.eval("__method__", self)
   end
 
   # Retreive the current running method.
   #
-  def __method__
-    Kernel.eval("__method__", self)
+  def __callee__
+    Kernel.eval("__callee__", self)
   end
 
 end

data/lib/core/facets/binding/callstack.rb

@@ -1 +1 @@
-require 'facets/kernel/callstack'
+require 'facets/binding/call_stack'

data/lib/core/facets/binding/eval.rb

@@ -4,12 +4,8 @@ class Binding
 
     # Evaluate a Ruby source code string (or block) in the binding context.
 
-    def eval(str) #='', &blk )
-      #if block_given?
-      #  Kernel.eval( self, &blk )
-      #elsif str
-        Kernel.eval(str, self)
-      #end
+    def eval(str)
+      Kernel.eval(str, self)
     end
 
   end

data/lib/core/facets/binding/local_variables.rb

@@ -2,10 +2,12 @@ require 'facets/binding/eval'
 
 class Binding
 
-  # Returns the local variables defined in the binding context
+  # Returns the local variables defined in the binding context:
   #
-  #   a = 2
-  #   binding.local_variables  #=> ["a"]
+  #   a = 1
+  #   b = 2
+  #
+  #   binding.local_variables  #=> [:a, :b]
   #
   def local_variables()
     eval("local_variables")

data/lib/core/facets/boolean.rb

@@ -1,47 +1,28 @@
-# = Boolean
-#
-# Stackable mixin provides #pop, #push, #pull, etc.
-# It depends on #slice, #splice and #insert.
-#
-# == Notes
-#
-# * This was suggested by Ara T. Howard
-#
-# == Authors
-#
-# * Thomas Sawyer
-#
-# == Copying
-#
-# 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.
-
 require 'facets/kernel/true'
 require 'facets/kernel/false'
 
 module Kernel
-
   # Boolean conversion for not being nil or false.
   # Other classes may redefine this to suite the
   # particular need.
   #
-  #   "abc".to_b   #=> true
+  #   "yes".to_b   #=> true
+  #   "abc".to_b   #=> false
+  #
   #   true.to_b    #=> true
   #   false.to_b   #=> false
   #   nil.to_b     #=> false
   #
+  # CREDIT: Ara T. Howard, Trans
   def to_b
     self ? true : false
   end
 
+  # All objects except false and nil are "true".
+  def to_bool
+    true
+  end
+
   # Returns true is an object is class TrueClass
   # or FalseClass, otherwise false.
   #
@@ -52,43 +33,43 @@ module Kernel
   def bool?
     (true == self or false == self)
   end
-
-end
-
-
-class Object
-  def to_bool
-    true
-  end
 end
 
-
 class TrueClass
   def to_bool
     self
   end
 end
 
-
 class FalseClass
   def to_bool
     self
   end
 end
 
-
 class NilClass
   def to_bool
     false
   end
 end
 
+class Numeric
+  # Provides a boolean interpretation of self.
+  # If self == 0 then false else true.
+  #
+  #   0.to_b    #=> false
+  #   1.to_b    #=> true
+  #   2.3.to_b  #=> true
+  #
+  def to_b
+    self == 0 ? false : true
+  end
+end
 
 class String
-
   # Interpret common affirmative string meanings as true,
   # otherwise nil or false. Blank space and case are ignored.
-  # The following strings that will return true:
+  # The following strings that will return true ...
   #
   #   true
   #   yes
@@ -98,14 +79,14 @@ class String
   #   y
   #   ==
   #
-  # The following strings will return nil:
+  # The following strings will return nil ...
   #
   #   nil
   #   null
   #
   # All other strings return false.
   #
-  # Examples:
+  # Here are some exmamples.
   #
   #   "true".to_b   #=> true
   #   "yes".to_b    #=> true
@@ -122,32 +103,19 @@ class String
       return false
     end
   end
-
 end
 
-
 class Array
-
   # Boolean conversion for not empty?
   def to_b
     ! self.empty?
   end
-
 end
 
-
-class Numeric
-
-  # Provides a boolean interpretation of self.
-  # If self == 0 then false else true.
-  #
-  #   0.to_b    #=> false
-  #   1.to_b    #=> true
-  #   2.3.to_b  #=> true
-  #
+class Hash
+  # Boolean conversion for not empty?
   def to_b
-    self == 0 ? false : true
+    ! self.empty?
   end
-
 end
 

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

@@ -1,47 +1,34 @@
+require 'facets/class/subclasses'
+
 class Class
 
   # List all descedents of this class.
   #
-  #   class X ; end
-  #   class A < X; end
-  #   class B < X; end
-  #   X.descendents  #=> [A,B]
+  #   class A ; end
+  #   class B < A; end
+  #   class C < A; end
+  #   A.descendants  #=> [B,C]
   #
-  # You may also limit the generational distance
-  # the subclass may be from the parent class.
+  # You may also limit the generational distance the subclass may be from
+  # the parent class.
   #
   #   class X ; end
-  #   class A < X; end
-  #   class B < A; end
-  #   X.descendents    #=> [A, B]
-  #   X.descendents(1) #=> [A]
+  #   class Y < X; end
+  #   class Z < Y; end
+  #   X.descendants    #=> [Y,Z]
+  #   X.descendants(1) #=> [Y]
   #
-  # NOTE: This is a intensive operation. Do not
-  # expect it to be super fast.
-
-  def descendants(generations=nil)
-    subclass = []
-    ObjectSpace.each_object(Class) do |c|
-      ancestors = c.ancestors[0..(generations || -1)]
-      if ancestors.include?(self) and self != c
-        subclass << c
+  # NOTE: This is a intensive operation. Do not expect it to be very fast.
+
+  def descendants(generations=-1)
+    descendants = []
+    subclasses.each do |k|
+      descendants << k
+      if generations != 1
+        descendants.concat(k.descendants(generations - 1))
       end
     end
-    return subclass
-  end
-
-  #
-  alias_method :descendents, :descendants
-
-  unless defined?(::ActiveSupport)
-
-    # Obvious alias for descendants.
-    #
-    # NOTE: ActiveSupport returns string names rather
-    # then actual classes, so this is excluded
-    # if ActiveSupport has already been loaded.
-    alias_method :subclasses, :descendants
-
+    descendants
   end
 
 end

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

@@ -4,7 +4,12 @@ class Class
 
   # Translate a class name to a suitable method name.
   #
-  #   My::CoolClass.methodize => "my__cool_class"
+  #   module ::Example
+  #     class MethodizeExample
+  #     end
+  #   end
+  #
+  #   Example::MethodizeExample.methodize  #=> "example__methodize_example"
   #
   def methodize
     name.methodize

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

@@ -4,7 +4,12 @@ class Class
 
   # Converts a class name to a unix path.
   #
-  #   My::CoolClass.pathize  #=> "my/cool_class"
+  #   module ::Example
+  #     class PathizeExample
+  #     end
+  #   end
+  #
+  #   Example::PathizeExample.pathize  #=> "example/pathize_example"
   #
   def pathize
     name.pathize

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

@@ -1,2 +1,28 @@
-require 'facets/class/descendents'
+class Class
+
+  if defined?(Class.__subclasses__) # Rubinius
+
+    # Returns an array with the direct children of +self+.
+    #
+    #   Integer.subclasses # => [Fixnum, Bignum]
+    #
+    alias_method :subclasses, :__subclasses__
+
+  else
+
+    # Returns an array with the direct children of +self+.
+    #
+    #   Integer.subclasses # => [Fixnum, Bignum]
+    #
+    def subclasses
+      list = []
+      ObjectSpace.each_object(Class) do |c|
+        list.unshift c if c.superclass == self
+      end
+      list.uniq
+    end
+
+  end
+
+end
 

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

@@ -12,7 +12,9 @@ class Class
   #     end
   #   end
   #
-  #   %w(john bob jane hans).map(&Person) => [john, bob, jane, hans]
+  #   persons = %w(john bob jane hans).map(&Person)
+  #
+  #   persons.map{ |p| p.inspect }  #=> ['john', 'bob', 'jane', 'hans']
   #
   # CREDIT: Daniel Schierbeck
   def to_proc
@@ -20,3 +22,4 @@ class Class
   end
 
 end
+

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

@@ -1 +1 @@
-require 'facets/comparable/cap'
+require 'facets/comparable/clip'