facets 2.1.3 → 2.2.0

data/lib/core/facets/module/name.rb

@@ -1,22 +1,3 @@
-# TITLE:
-#
-#   Name
-#
-# DESCRIPTION:
-#
-#   Extensions related to module names and namespace.
-#
-# COPYRIGHT:
-#
-#   Copyright (c) 2007 Gavin Sinclair, Thomas Sawyer
-#   Distributed under the terms of the Ruby License
-#
-# AUTHORS:
-#
-#   - Gavin Sinclair
-#   - Thomas Sawyer
-
-#
 class Module
 
   # <em>Note: the following documentation uses "class" because it's more common, but it
@@ -47,15 +28,14 @@ class Module
   #   Class.by_name("Enumerable")         # -> Enumerable
   #   Module.by_name("Enumerable")        # -> Enumerable
   #
-  #--
-  # Credit for this goes to Gavin Sinclair.
-  #++
+  #   CREDIT: Gavin Sinclair
+
   def by_name(name)
     #result = Object.constant(name)
-    # ??? Does self need to be Object in the following lines?
+    # TODO: Does self need to be Object in the following lines?
     const  = name.to_s.dup
     base   = const.sub!(/^::/, '') ? Object : ( self.kind_of?(Module) ? self : self.class )
-    result = const.split(/::/).inject(base){ |mod, name| mod.const_get(name) }
+    result = const.split(/::/).inject(base){ |mod, subconst| mod.const_get(subconst) }
 
     return result if result.kind_of?( Module )
     raise ArgumentError, "#{name} is not a module or class"
@@ -78,6 +58,8 @@ class Module
   #   m.inspect       #=> "#<Module:0xb7bb0434>"
   #   m.basename      #=> "Module_0xb7bb0434"
   #
+  #   CREDIT: Trans
+
   def basename
     if name and not name.empty?
       name.gsub(/^.*::/, '')
@@ -98,6 +80,8 @@ class Module
   #
   # See also Module#basename.
   #
+  #   CREDIT: Trans
+
   def dirname
     name[0...(name.rindex('::') || 0)]
     #name.gsub(/::[^:]*$/, '')
@@ -114,73 +98,25 @@ class Module
   #
   # See also Module#basename.
   #
+  #   CREDIT: Trans
+
   def modspace
     space = name[ 0...(name.rindex( '::' ) || 0)]
     space.empty? ? Object : eval(space)
   end
 
-  #--
-  # Special thanks to Mauricio Fernandez
-  #   parent = Object.const_get(mod.to_s.sub(/::[^:]+\z/, ""))
-  #++
+  # Show a modules nesting in module namespaces.
+  #
+  #   A::B::C.nesting  #=> [ A, A::B ]
+  #
+  #   CREDIT: Trans
+
   def nesting
     n = []
-    name.split(/::/).inject(self){ |mod, name| c = mod.const_get(name) ; n << c ; c }
+    name.split(/::/).inject(self) do |mod, name|
+      c = mod.const_get(name) ; n << c ; c
+    end
     return n
   end
 
 end
-
-
-
-=begin test
-
-  require 'test/unit'
-
-  class TestModuleName < Test::Unit::TestCase
-
-    def test_ancestor
-      assert( self.class.ancestor?(::Test::Unit::TestCase) )
-    end
-
-    def test_by_name
-      c = ::Test::Unit::TestCase.name
-      assert_equal( ::Test::Unit::TestCase, Module.by_name(c) )
-      c = "Test::Unit::TestCase"
-      assert_equal( ::Test::Unit::TestCase, Class.by_name(c) )
-    end
-
-    def test_basename
-      assert_equal( "TestCase", ::Test::Unit::TestCase.basename )
-    end
-
-    def test_dirname
-      assert_equal( 'Test::Unit', Test::Unit::TestCase.dirname )
-      assert_equal( 'Test::Unit', ::Test::Unit::TestCase.dirname )
-      assert_equal( '', Test.dirname )
-      assert_equal( '', ::Test.dirname )
-    end
-
-    def test_modspace
-      assert_equal( Test::Unit, Test::Unit::TestCase.modspace )
-      assert_equal( ::Test::Unit, ::Test::Unit::TestCase.modspace )
-      assert_equal( Object, ::Test.modspace )
-    end
-
-    module M
-      module N
-        class C
-          def n
-            self.class.nesting
-          end
-        end
-      end
-    end
-
-    def test_nesting
-      assert_equal( [TestModuleName, M, M::N, M::N::C], M::N::C.new.n )
-    end
-
-  end
-
-=end

data/lib/core/facets/module/require.rb

@@ -1,62 +1,57 @@
-# TITLE:
-#
-#   Require / Load Module Extensions
-#
-# SUMMARY:
-#
-#   In module require and load.
-#
-# AUTHORS:
-#
-#   - Thomas Sawyer
-
-class Module
-
-  # Load file into module/class namespace.
-
-  def module_load( path )
-    if path =~ /^[\/~.]/
-      file = File.expand_path(path)
-    else
-      $LOAD_PATH.each do |lp|
-        file = File.join(lp,path)
-        break if File.exist?(file)
-        file = nil
+unless (RUBY_VERSION[0,3] == '1.9')
+
+  class Module
+
+    # Load file into module/class namespace.
+    #
+    #   CREDIT: Trans
+
+    def module_load( path )
+      if path =~ /^[\/~.]/
+        file = File.expand_path(path)
+      else
+        $LOAD_PATH.each do |lp|
+          file = File.join(lp,path)
+          break if File.exist?(file)
+          file = nil
+        end
       end
-    end
 
-    module_eval(File.read(file))
-  end
+      module_eval(File.read(file))
+    end
 
-  # Require file into module/class namespace.
-
-  def module_require( path )
-    if path =~ /^[\/~.]/
-      file = File.expand_path(path)
-    else
-      $LOAD_PATH.each do |lp|
-        file = File.join(lp,path)
-        break if File.exist?(file)
-        file += '.rb'
-        break if File.exist?(file)
-        file = nil
+    # Require file into module/class namespace.
+    #
+    #   CREDIT: Trans
+
+    def module_require( path )
+      if path =~ /^[\/~.]/
+        file = File.expand_path(path)
+      else
+        $LOAD_PATH.each do |lp|
+          file = File.join(lp,path)
+          break if File.exist?(file)
+          file += '.rb'
+          break if File.exist?(file)
+          file = nil
+        end
+      end
+      @loaded ||= {}
+      if @loaded.key?(file)
+        false
+      else
+        @loaded[file] = true
+        script = File.read(file)
+        module_eval(script)
+        true
       end
-    end
-    @loaded ||= {}
-    if @loaded.key?(file)
-      false
-    else
-      @loaded[file] = true
-      script = File.read(file)
-      module_eval(script)
-      true
     end
   end
-end
 
 
-class Class
-  alias_method :class_load, :module_load
-  alias_method :class_require, :module_require
-end
+  class Class
+    alias_method :class_load, :module_load
+    alias_method :class_require, :module_require
+  end
 
+end

data/lib/core/facets/module/traits.rb

@@ -1,33 +1,37 @@
-# TITLE:
-#
-#   Module Traits
-#
-# SUMMARY:
-#
-#   Module extensions for modifying a module a al traits.
-#
-# CREDITS:
-#
-#   - Thomas Sawyer
-#   - Robert Dober
-#
-# NOTES:
-#   - In the old version of traits.rb we cloned modules and
-#     altered their copies. Eg.
-#       def +(other)
-#         mod1 = other.clone
-#         mod2 = clone
-#         mod1.module_eval{ include mod2 }
-#       end
-#     Later it was realized that this thwarted the main
-#     benefit that Ruby's concept of modules has over
-#     traditional traits, inheritance.
-#
-
-#
 class Module
 
   # Combine modules.
+  #
+  #   module A
+  #     def a; "a"; end
+  #   end
+  #
+  #   module B
+  #     def b; "b"; end
+  #   end
+  #
+  #   C = A + B
+  #
+  #   class X; include C; end
+  #
+  #   X.new.a    #=> "a"
+  #   X.new.b    #=> "b"
+  #
+  # Note that in the old version of traits.rb we cloned
+  # modules and altered their copies. Eg.
+  #
+  #     def +(other)
+  #       mod1 = other.clone
+  #       mod2 = clone
+  #       mod1.module_eval{ include mod2 }
+  #     end
+  #
+  # Later it was realized that this thwarted the main
+  # benefit that Ruby's concept of modules has over
+  # traditional traits, inheritance.
+  #
+  #   CREDIT: Thomas Sawyer
+  #   CREDIT: Robert Dober
 
   def +(other)
     base = self
@@ -38,9 +42,12 @@ class Module
   end
 
   # Subtract modules.
-  #--
-  # TODO Should this use all instance_methods, not just public?
-  #++
+  #
+  #   TODO: Should this use all instance_methods, not just public?
+  #
+  #   CREDIT: Thomas Sawyer
+  #   CREDIT: Robert Dober
+
   def -(other)
     case other
     when Array
@@ -58,6 +65,20 @@ class Module
   end
 
   # Rename methods.
+  #
+  #   module A
+  #     def a; "a"; end
+  #   end
+  #
+  #   B = A * { :a => :b }
+  #
+  #   class X; include B; end
+  #
+  #   X.new.b    #=> "a"
+  #
+  #
+  #   CREDIT: Thomas Sawyer
+  #   CREDIT: Robert Dober
 
   def *(rename_map)
     base = self
@@ -71,9 +92,23 @@ class Module
   end
 
   # Detect conflicts.
-  #--
-  # TODO All instance methods, or just public?
-  #++
+  #
+  #   module A
+  #     def c; end
+  #   end
+  #
+  #   module B
+  #     def c; end
+  #   end
+  #
+  #   A.conflict?(B)  #=> ["c"]
+  #
+  #
+  #   TODO: All instance methods, or just public?
+  #
+  #   CREDIT: Thomas Sawyer
+  #   CREDIT: Robert Dober
+
   def conflict?(other)
     c = []
     c += (public_instance_methods(true) & other.public_instance_methods(true))
@@ -87,16 +122,22 @@ class Module
   #  c.empty ? false : c
   #end
 
+  # Like #conflict?, but checks only public methods.
+
   def public_conflict?(other)
     c = public_instance_methods(true) & other.public_instance_methods(true)
     c.empty ? false : c
   end
 
+  # Like #conflict?, but checks only private methods.
+
   def private_conflict?(other)
     c = private_instance_methods(true) & other.private_instance_methods(true)
     c.empty ? false : c
   end
 
+  # Like #conflict?, but checks only protected methods.
+
   def protected_conflict?(other)
     c = protected_instance_methods(true) & other.protected_instance_methods(true)
     c.empty ? false : c

data/lib/core/facets/nilclass/status.rb

@@ -1,10 +1,21 @@
-
 class NilClass
 
   # Nil#status makes it possible to pass messages
   # through a "failure" chain.
+  #
+  #   def foo
+  #     return nil.status("failed foo!")
+  #   end
+  #
+  #   result = foo
+  #   if result.nil?
+  #     result.status?  #=> true
+  #     result.status   #=> "failed foo!"
+  #   end
+  #
+  #   CREDIT: Trans
 
-  def status( status=nil )
+  def status(status=nil)
     if status
       @status = status
       self
@@ -14,6 +25,18 @@ class NilClass
   end
 
   # Check status.
+  #
+  #   def foo
+  #     return nil.status("failed foo!")
+  #   end
+  #
+  #   result = foo
+  #   if result.nil?
+  #     result.status?  #=> true
+  #     result.status   #=> "failed foo!"
+  #   end
+  #
+  #   CREDIT: Trans
 
   def status?
     return unless @status

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

@@ -1,22 +1,13 @@
-# = Round
-#
-# To properly support Float's rounding methods,
-# Numeric and Integer must also be augmented.
-#
-# == AUTHORS
-#
-#   CREDIT Thomas Sawyer
-
-#
 class Numeric
-  # To properly support Float's rounding methods,
-  # Numeric must also be augmented.
+
+  # See Float#round_at.
+
   def round_at(*args)
     to_f.round_at(*args)
   end
 
-  # To properly support Float's rounding methods,
-  # Numeric must also be augmented.
+  # See Float#round_to.
+
   def round_to(*args)
     to_f.round_to(*args)
   end
@@ -24,31 +15,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.
-  def approx?( x, n=0.01 )
+  #
+  #   CREDIT: Trans
+
+  def approx?(x, n=0.01)
     return(self == x) if n == 0
     (self - x).abs <= n
   end
 
 end
 
-#
+
 class Integer
-  #
+
+  # See Float#round_at.
+
   def round_at(*args)
     to_f.round_at(*args)
   end
 
-  # To properly support Float's rounding methods,
-  # Integer must also be augmented.
+  # See Float#round_to.
+
   def round_to(*args)
     to_f.round_to(*args)
   end
+
 end
 
-#
+
 class Float
-  # Float#round_off is simple an alias for Float#round.
-  #
+
+  # Float#round_off is simply an alias for Float#round.
   alias_method :round_off, :round
 
   # Rounds to the given decimal position.
@@ -58,6 +55,8 @@ class Float
   #   4.555.round_at(2)  #=> 4.56
   #   4.555.round_at(3)  #=> 4.555
   #
+  #   CREDIT: Trans
+
   def round_at( d ) #d=0
     (self * (10.0 ** d)).round_off.to_f / (10.0 ** d)
   end
@@ -69,75 +68,11 @@ class Float
   #   4.555.round_to(0.01)  #=> 4.56
   #   4.555.round_to(0)     #=> 4.555
   #
+  #   CREDIT: Trans
+
   def round_to( n ) #n=1
     return self if n == 0
     (self * (1.0 / n)).round_off.to_f / (1.0 / n)
   end
-end
 
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestRound < Test::Unit::TestCase
-
-    def setup
-      @f0 = [ 0, 10, 15, 105 ]
-      @f1 = [ 10.1, 10.01, 10.9, 10.09, 10.5, 10.05, 10.49 ]
-    end
-
-    def test_round_at_arg1
-      fr = @f0.collect{ |f| f.round_at(1) }
-      assert_equal( [0,10,15,105], fr )
-      fr = @f1.collect { |f| f.round_at(1) }
-      assert_equal( [10.1,10.0,10.9,10.1,10.5,10.1,10.5], fr )
-    end
-
-    def test_round_at_arg2
-      fr = @f0.collect { |f| f.round_at(2) }
-      assert_equal( [0,10,15,105], fr )
-      fr = @f1.collect { |f| f.round_at(2) }
-      assert_equal( [10.1,10.01,10.9,10.09,10.5,10.05,10.49], fr )
-    end
-
-    def test_round_off
-      assert_equal( 1.0, 1.2.round_off )
-      assert_equal( 2.0, 1.8.round_off )
-    end
-
-    def test_round_to_arg1
-      fr = @f0.collect { |f| f.round_to(0.1) }
-      assert_equal( [0,10,15,105], fr )
-      fr = @f1.collect { |f| f.round_to(0.1) }
-      assert_equal( [10.1,10.0,10.9,10.1,10.5,10.1,10.5], fr )
-    end
-
-    def test_round_to_arg10
-      fr = @f0.collect { |f| f.round_to(10) }
-      assert_equal( [0,10,20,110], fr )
-      fr = @f1.collect { |f| f.round_to(10) }
-      assert_equal( [10,10,10,10,10,10,10], fr )
-    end
-
-    def test_round_off
-      assert_equal( 1.0, 1.2.round_off )
-      assert_equal( 2.0, 1.8.round_off )
-    end
-
-    def test_approx?
-      f = 10.006
-      assert( f.approx?(10.01) )
-      assert( f.approx?(10, 0.1) )
-      assert( 100.4.approx?(100.6, 1) )
-    end
-
-  end
-
-=end
+end