facets 2.9.2 → 2.9.3

data/{src/core-uncommon → lib/core}/facets/module/instance_function.rb

@@ -25,8 +25,12 @@ class Module
   # Note: This used to be a module called PromoteSelf and later Instantize,
   # before becoming a method.
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
+  #
+  # @uncommon
+  #   require 'facets/module/instance_function'
+  #
   def instance_function(*meths)
     this = self
     if meths.empty?

data/lib/{core-uncommon → core}/facets/module/let.rb

@@ -10,6 +10,10 @@ class Module
   #   eg.seed == eg.seed
   #
   # CREDIT: Howard Yeh
+  #
+  # @uncommon
+  #   require 'facets/module/let'
+  #
   def let(var,&block)
     name = "@#{var}"
     self.class_eval do

data/{src/core-uncommon/facets/module/cattr.rb → lib/core/facets/module/mattr.rb}

@@ -11,10 +11,14 @@ class Module
   #   CARExample.a           #=> 10
   #   CARExample.new.a       #=> 10
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def cattr(*syms)
     writers, readers = syms.flatten.partition{ |a| a.to_s =~ /=$/ }
     writers = writers.map{ |e| e.to_s.chomp('=').to_sym }
@@ -37,10 +41,14 @@ class Module
   #   CARExample.a           #=> 10
   #   CARExample.new.a       #=> 10
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def cattr_reader(*syms)
     syms.flatten.each do |sym|
       module_eval(<<-EOS, __FILE__, __LINE__)
@@ -75,10 +83,14 @@ class Module
   #   CAWExample.new.a = 29
   #   CAWExample.a            #=> 29
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def cattr_writer(*syms)
     syms.flatten.each do |sym|
       module_eval(<<-EOS, __FILE__, __LINE__)
@@ -110,10 +122,14 @@ class Module
   #   mc = CAAExample.new
   #   mc.a                   #=> 10
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def cattr_accessor(*syms)
     cattr_reader(*syms) + cattr_writer(*syms)
   end
@@ -135,10 +151,14 @@ class Module
   # methods are for classes, becuase class-level methods are not "inherited"
   # across the metaclass for included modules.
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This methiod is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def mattr(*syms)
     writers, readers = syms.flatten.partition{ |a| a.to_s =~ /=$/ }
     writers = writers.collect{ |e| e.to_s.chomp('=').to_sym }
@@ -161,10 +181,14 @@ class Module
   #   c.a           #=> 10
   #   c.new.a       #=> 10
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This methiod is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def mattr_reader( *syms )
     syms.flatten.each do |sym|
       module_eval(<<-EOS, __FILE__, __LINE__)
@@ -200,10 +224,14 @@ class Module
   #   c.new.a = 29
   #   c.a            #=> 29
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This methiod is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def mattr_writer(*syms)
     syms.flatten.each do |sym|
       module_eval(<<-EOS, __FILE__, __LINE__)
@@ -236,10 +264,14 @@ class Module
   #   x = c.new
   #   x.a           #=> 10
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This methiod is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: David Heinemeier Hansson
+  #
+  # @uncommon
+  #   require 'facets/module/cattr'
+  #
   def mattr_accessor(*syms)
     mattr_reader(*syms) + mattr_writer(*syms)
   end

data/{src/core-uncommon → lib/core}/facets/module/memoize.rb

@@ -3,6 +3,10 @@ require 'facets/memoizable'
 class Module
 
   # This is here for backward compatibility.
+  #
+  # @uncommon
+  #   require 'facets/module/memoize'
+  #
   def memoize(*args)
     include Memoizable
     Memoizable.instance_method(:memoize).bind(self).call(*args)

data/lib/{core-uncommon → core}/facets/module/method_clash.rb

@@ -1,5 +1,9 @@
 class Module
 
+  # TODO: Should method_clash just be public methods?
+
+  # TODO: Provide an option to select visiblity.
+
   # Detect method name clash between modules and/or classes, regardless of
   # method visibility:
   #
@@ -20,10 +24,9 @@ class Module
   #
   # CREDIT: Thomas Sawyer, Robert Dober
   #
-  #--
-  # TODO: Should method_clash just be public methods?
-  # TODO: Provide an option to select visiblity.
-  #++
+  # @uncommon
+  #   require 'facets/module/method_clash'
+  #
   def method_clash(other)
     common_ancestor = (ancestors & other.ancestors).first
 
@@ -50,6 +53,10 @@ class Module
 
   # Uses #method_clash to return +true+ or +false+ if there
   # are method name clashes.
+  #
+  # @uncommon
+  #   require 'facets/module/method_clash'
+  #
   def method_clash?(other) 
     c = method_clash(other) 
     !c.empty?

data/lib/{core-uncommon → core}/facets/module/method_space.rb

@@ -21,10 +21,14 @@ class Module
   #     a.x
   #   end
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: Pit Captain
+  #
+  # @uncommon
+  #   require 'facets/module/method_space'
+  #
   def method_space(name, mod=nil, &blk)
 
     ## If block is given then create a module, otherwise
@@ -90,8 +94,12 @@ class Module
   #
   #   X.new.t  #=> "HERE"
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
+  #
+  # @uncommon
+  #   require 'facets/module/method_space'
+  #
   def include_as(h)
     h.each{ |name, mod| method_space(name, mod) }
   end

data/{src/core-uncommon → lib/core}/facets/module/module_load.rb

@@ -7,11 +7,14 @@ class Module
   # and should generally not be used as a substitue for
   # Ruby's standard load system.
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: Trans
-
+  #
+  # @uncommon
+  #   require 'facets/module/module_load'
+  #
   def module_load( path )
     if path =~ /^[\/~.]/
       file = File.expand_path(path)
@@ -39,11 +42,14 @@ class Module
   # and should generally not be used as a substitue for
   # Ruby's standard load system.
   #
-  # NOTE: This is not a common core extension and is not loaded
+  # NOTE: This method is not a common core extension and is not loaded
   # automatically when using <code>require 'facets'</code>.
   #
   # CREDIT: Trans
-
+  #
+  # @uncommon
+  #   require 'facets/module/module_load'
+  #
   def module_require( path )
     if path =~ /^[\/~.]/
       file = File.expand_path(path)
@@ -73,6 +79,5 @@ class Module
 
   alias_method :class_require, :module_require
   alias_method :class_load, :module_load
-
 end
 

data/lib/{core-uncommon → core}/facets/module/preextend.rb

@@ -19,7 +19,10 @@ class Module
   # automatically when using <code>require 'facets'</code>.
   #
   # CREDIT Trans
-
+  #
+  # @uncommon
+  #   require 'facets/module/preextend'
+  #
   def preextend(aspect)
     aspect.__send__(:include, self)
     extend aspect

data/lib/core/facets/nilclass.rb

@@ -1,10 +1,5 @@
-# Require all NilClass core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/nilclass/ergo.rb"
-  require "facets/nilclass/to_f.rb"
-else
-  require_relative "nilclass/ergo.rb"
-  require_relative "nilclass/to_f.rb"
-end
+require_relative 'nilclass/ergo.rb'
+require_relative 'nilclass/to_f.rb'
 

data/lib/core/facets/numeric.rb

@@ -1,20 +1,12 @@
-# Require all Numeric core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/numeric/approx.rb"
-  require "facets/numeric/distance.rb"
-  require "facets/numeric/length.rb"
-  require "facets/numeric/round.rb"
-  require "facets/numeric/round_at.rb"
-  require "facets/numeric/round_to.rb"
-  require "facets/numeric/spacing.rb"
-else
-  require_relative "numeric/approx.rb"
-  require_relative "numeric/distance.rb"
-  require_relative "numeric/length.rb"
-  require_relative "numeric/round.rb"
-  require_relative "numeric/round_at.rb"
-  require_relative "numeric/round_to.rb"
-  require_relative "numeric/spacing.rb"
-end
+require_relative 'numeric/approx.rb'
+require_relative 'numeric/distance.rb'
+require_relative 'numeric/length.rb'
+require_relative 'numeric/negative.rb'
+require_relative 'numeric/positive.rb'
+require_relative 'numeric/round.rb'
+require_relative 'numeric/round_at.rb'
+require_relative 'numeric/round_to.rb'
+require_relative 'numeric/spacing.rb'
 

data/lib/core/facets/numeric/approx.rb

@@ -1,14 +1,37 @@
 class Numeric
 
+  # Determines if another number is approximately equal within a given
+  # _n_th degree. Defaults to 100ths if the degree is not specified.
+  #
+  # Currently defaults to 1/10,000,000 if the degree is not specified.
+  # But this may change once a "most commonly useful" factor is determined.
+  #
+  # This is the same a {#close?} but has a different defualt.
+  #
+  # @author Gavin Sinclair
+
+  def approx?(x, n=0.0000001)
+    close?(x, n)
+  end
+
   # Determines if another number is approximately equal
-  # within a given _n_th degree. Defaults to 100ths
-  # if the degree is not specified.
+  # within a given +epsilon+.
+  #
+  # This is the same a {#approx?} but has a different defualt.
   #
-  # CREDIT: Trans
+  # @author Gavin Sinclair
+  def close?(number, epsilon=0.01)
+    return(self == number) if epsilon.zero?
 
-  def approx?(x, n=0.01)
-    return(self == x) if n == 0
-    (self - x).abs <= n
+    a, b = self.to_f, number.to_f
+    if a.zero? or b.zero?
+      ## There's no scale, so we can only go on difference.
+      (a - b).abs < @epsilon
+    else
+      ## We go by ratio. The ratio of two equal numbers is one, so the ratio
+      ## of two practically-equal floats will be very nearly one.
+      (a/b - 1).abs < epsilon
+    end
   end
 
 end

data/lib/core/facets/numeric/close.rb

@@ -0,0 +1 @@
+require 'facets/numeric/approx'

data/lib/core/facets/numeric/negative.rb

@@ -0,0 +1 @@
+require 'facets/numeric/positive'

data/lib/core/facets/numeric/positive.rb

@@ -0,0 +1,15 @@
+class Numeric
+
+  # Is a number greater than zero.
+  #
+  def positive?
+    self > 0
+  end
+
+  # Is a number less than zero.
+  #
+  def negative?
+    self < 0
+  end
+
+end

data/lib/core/facets/object.rb

@@ -1,16 +1,8 @@
-# Require all Object core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/object/clone.rb"
-  require "facets/object/dup.rb"
-  require "facets/object/object_state.rb"
-  require "facets/object/replace.rb"
-  require "facets/object/try_dup.rb"
-else
-  require_relative "object/clone.rb"
-  require_relative "object/dup.rb"
-  require_relative "object/object_state.rb"
-  require_relative "object/replace.rb"
-  require_relative "object/try_dup.rb"
-end
+require_relative 'object/clone.rb'
+require_relative 'object/dup.rb'
+require_relative 'object/object_state.rb'
+require_relative 'object/replace.rb'
+require_relative 'object/try_dup.rb'
 

data/lib/core/facets/objectspace.rb

@@ -1,12 +1,6 @@
-# Require all ObjectSpace core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/objectspace/classes.rb"
-  require "facets/objectspace/op_fetch.rb"
-  require "facets/objectspace/reflect.rb"
-else
-  require_relative "objectspace/classes.rb"
-  require_relative "objectspace/op_fetch.rb"
-  require_relative "objectspace/reflect.rb"
-end
+require_relative 'objectspace/classes.rb'
+require_relative 'objectspace/op_fetch.rb'
+require_relative 'objectspace/reflect.rb'
 

data/lib/core/facets/proc.rb

@@ -1,20 +1,10 @@
-# Require all Proc core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/proc/bind.rb"
-  require "facets/proc/bind_to.rb"
-  require "facets/proc/compose.rb"
-  require "facets/proc/curry.rb"
-  require "facets/proc/partial.rb"
-  require "facets/proc/to_method.rb"
-  require "facets/proc/update.rb"
-else
-  require_relative "proc/bind.rb"
-  require_relative "proc/bind_to.rb"
-  require_relative "proc/compose.rb"
-  require_relative "proc/curry.rb"
-  require_relative "proc/partial.rb"
-  require_relative "proc/to_method.rb"
-  require_relative "proc/update.rb"
-end
+require_relative 'proc/bind.rb'
+require_relative 'proc/bind_to.rb'
+require_relative 'proc/compose.rb'
+require_relative 'proc/curry.rb'
+require_relative 'proc/partial.rb'
+require_relative 'proc/to_method.rb'
+require_relative 'proc/update.rb'