facets 2.1.3 → 2.2.0

data/lib/core/facets/exception/detail.rb

@@ -8,7 +8,7 @@ class Exception
   # The Exception/StandardError object
   #
   # Output:
-  # the pretty printed string
+  # The pretty printed string
   #
   #   CREDIT: George Moschovitis
 
@@ -17,4 +17,3 @@ class Exception
   end
 
 end
-

data/lib/core/facets/facets.rb

@@ -3,14 +3,15 @@
 module Facets
   extend self
 
+  # REMOVED "facets/basicobject" b/c of coming 1.9.
+  # REMOVED "facets/continuaiton" b/c of coming 1.9.
+
   def require_core
    require "facets/array"
-   require "facets/basicobject"
    require "facets/binding"
    require "facets/boolean"
    require "facets/class"
    require "facets/comparable"
-   require "facets/continuation"
    require "facets/conversion"
    require "facets/curry"
    require "facets/dir"

data/lib/core/facets/file/read.rb

@@ -1,22 +1,8 @@
-# TITLE:
-#
-#   File Class Read Extensions
-#
-# DESCRIPTION:
-#
-#   Class extensions to File for reading
-#   and writing.
-#
-# AUTHORS:
-#
-#   CREDIT Thomas Sawyer
-#   CREDIT George Moschovitis
-#   CREDIT Jeffrey Schwab
-
-#
 class File
 
   # Read in a file as binary data.
+  #
+  #  CREDIT: George Moschovitis
 
   def self.read_binary(fname)
     open(fname, 'rb') {|f|
@@ -27,6 +13,8 @@ class File
   # Reads in a file, removes blank lines and remarks
   # (lines starting with '#') and then returns
   # an array of all the remaining lines.
+  #
+  #   CREDIT: Trans
 
   def self.read_list(filepath, chomp_string='')
     farr = nil
@@ -39,46 +27,3 @@ class File
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-# TODO This isn't right. I'm not to clear on how to do File class-level Mocks.
-
-=begin #test
-
-  require 'test/unit'
-
-  class TestFileRead < Test::Unit::TestCase
-
-    class MockFile < ::File
-      def open( fname, mode, &blk )
-        blk.call(self)
-      end
-      def read( fname=nil )
-        @mock_content.clone
-      end
-      def write( str )
-        @mock_content = str
-      end
-      def <<( str )
-        (@mock_content ||="") << str
-      end
-    end
-
-    File = MockFile.new
-
-    def test_read_list
-      f = File.write("A\nB\nC")
-      s = File.read_list( f )
-      r = ['A','B','C']
-      assert_equal( r, s )
-    end
-
-  end
-
-=end

data/lib/core/facets/file/topath.rb

@@ -1,23 +1,9 @@
-# TITLE:
-#
-#   Path Extensions
-#
-# DESCRIPTION:
-#
-#   Path-related extensions.
-#
-# AUTHORS:
-#
-#   CREDIT Thomas Sawyer
-#   CREDIT Daniel Berger
-
-#
 class File
 
-  # CREDIT Daniel Burger
-
   # Platform dependent null device.
   #
+  #   CREDIT: Daniel Burger
+
   def self.null
     case RUBY_PLATFORM
     when /mswin/i
@@ -38,6 +24,8 @@ class File
   #   File.rootname('/jump.rb')     #=> '/'
   #   File.rootname('jump.rb')      #=> '.'
   #
+  #   CREDIT: Trans
+
   def self.rootname( file_name )
     i = file_name.index('/')
     if i
@@ -54,6 +42,8 @@ class File
   #
   #   File.split_all("a/b/c") =>  ['a', 'b', 'c']
   #
+  #   CREDIT: Trans
+
   def self.split_all(path)
     head, tail = File.split(path)
     return [tail] if head == '.' || tail == '/'
@@ -63,6 +53,8 @@ class File
 
   # Cleans up a filename to ensure it will work on filesystem.
   #
+  #   CREDIT: George Moschovitis
+
   def self.sanitize(filename)
     filename = File.basename(filename.gsub("\\", "/")) # work-around for IE
     filename.gsub!(/[^a-zA-Z0-9\.\-\+_]/,"_")
@@ -71,83 +63,3 @@ class File
   end
 
 end
-
-module FileTest
-  # CREDIT Jeffrey Schwab
-
-  # Is the specified directory the root directory?
-  def self.root?(dir)
-    pth = File.expand_path(dir)
-    return true if pth == '/'
-    return true if pth =~ /^(\w:)?\/$/
-    false
-  end
-end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  # mock file
-
-  class File
-    def self.open( fname, mode, &blk )
-      blk.call(self)
-    end
-    def self.read( fname=nil )
-      @mock_content.clone
-    end
-    def self.write( str )
-      @mock_content = str
-    end
-    def self.<<( str )
-      (@mock_content ||="") << str
-    end
-  end
-
-  # tests
-
-  class TestFile < Test::Unit::TestCase
-
-    # TODO Write file identity tests.
-
-    def test_sanitize_01
-      assert_equal( "This_is_a_test", File.sanitize('This is a test') )
-    end
-
-    def test_sanitize_02
-      assert_equal( "test", File.sanitize('This\is\test') )
-    end
-
-    def test_sanitize_03
-      assert_equal( "test", File.sanitize('This/is/test') )
-    end
-
-    def test_sanitize_04
-      assert_equal( "te_____st", File.sanitize('This/te#$#@!st') )
-    end
-
-    def test_sanitize_05
-      assert_equal( "_.", File.sanitize('.') )
-    end
-
-    def test_sanitize_06
-      assert_equal( "_....", File.sanitize('....') )
-    end
-
-    def test_split_all
-      fp = "this/is/test"
-      assert_equal( ['this', 'is', 'test'], File.split_all(fp) )
-    end
-
-  end
-
-=end

data/lib/core/facets/file/write.rb

@@ -1,30 +1,8 @@
-# TITLE:
-#
-#   File Class Write Extensions
-#
-# DESCRIPTION:
-#
-#   Class extensions to File for reading
-#   and writing.
-#
-# AUTHORS:
-#
-#   CREDIT Thomas Sawyer
-#   CREDIT George Moschovitis
-#   CREDIT Jeffrey Schwab
-#
-# LOG:
-#
-#   - 2007.10.31 Trans
-#     Added 'b' option to all write methods. Is this okay for Windows?
-#
-#   - 2007.10.31 Trans
-#     Added writelines method.
-
-#
 class File
 
   # Append to a file.
+  #
+  #   CREDIT: George Moschovitis
 
   def self.append( file, str )
     File.open( file, 'ab' ) { |f|
@@ -32,8 +10,6 @@ class File
     }
   end
 
-  # CREDIT George Moschovitis
-
   # Creates a new file, or overwrites an existing file,
   # and writes a string into it. Can also take a block
   # just like File#open, which is yielded _after_ the
@@ -41,34 +17,29 @@ class File
   #
   #   str = 'The content for the file'
   #   File.create('myfile.txt', str)
+  #
+  #   CREDIT: George Moschovitis
 
   def self.create(path, str='', &blk)
-    File.open(path, 'wb') { |f|
+    File.open(path, 'wb') do |f|
       f << str
       blk.call(f) if blk
-    }
+    end
   end
 
-  # Write file with string.
+  # Writes the given data to the given path and closes the file.  This is
+  # done in binary mode, complementing <tt>IO.read</tt> in standard Ruby.
+  #
+  # Returns the number of bytes written.
+  #
+  #   CREDIT: Gavin Sinclair
 
   def self.write(path, data)
-    File.open(path, 'wb'){ |f| f.write(data) }
+    File.open(path, "wb") do |file|
+      return file.write(data)
+    end
   end
 
-#   # Writes the given data to the given path and closes the file.  This is
-#   # done in binary mode, complementing <tt>IO.read</tt> in standard Ruby.
-#   #
-#   # Returns the number of bytes written.
-#   #
-#   #   CREDIT Noah Gibbs
-#   #   CREDIT Gavin Sinclair
-#
-#   def self.write(path, data)
-#     File.open(path, "wb") do |file|
-#       return file.write(data)
-#     end
-#   end
-
   # Writes the given array of data to the given path and closes the file.
   # This is done in binary mode, complementing <tt>IO.readlines</tt> in
   # standard Ruby.
@@ -76,12 +47,12 @@ class File
   # Note that +readlines+ (the standard Ruby method) returns an array of lines
   # <em>with newlines intact</em>, whereas +writelines+ uses +puts+, and so
   # appends newlines if necessary.  In this small way, +readlines+ and
-  # +writelines+ are not exact opposites. 
+  # +writelines+ are not exact opposites.
   #
   # Returns +nil+.
   #
-  #   CREDIT Noah Gibbs
-  #   CREDIT Gavin Sinclair
+  #   CREDIT: Noah Gibbs
+  #   CREDIT: Gavin Sinclair
 
   def self.writelines(path, data)
     File.open(path, "wb") do |file|
@@ -103,11 +74,12 @@ class File
   # done) or to append to it.
   #
   #   # Reverse contents of "message"
-  #   File.open_as_string("message") { |str| str.reverse! }
+  #   File.rewrite("message") { |str| str.reverse! }
   #
   #   # Replace "foo" by "bar" in "binary"
-  #   File.open_as_string("binary", "b") { |str| str.gsub!("foo", "bar") }
+  #   File.rewrite("binary", "b") { |str| str.gsub!("foo", "bar") }
   #
+  #   CREDIT: George Moschovitis
   #--
   # TODO Should it be in-place modification like this? Or would it be better
   # if whatever the block returns is written to the file instead?

data/lib/core/facets/filetest/root.rb

@@ -1,12 +1,13 @@
-
 module FileTest
 
   module_function
 
-  # Is this the root directory?
+  # Is the specified directory the root directory?
+  #
+  #   CREDIT: Jeffrey Schwab
 
   def root?(dir=nil)
-    pth = File.expand_path(dir||work)
+    pth = File.expand_path(dir||Dir.pwd)
     return true if pth == '/'
     return true if pth =~ /^(\w:)?\/$/
     false

data/lib/core/facets/functor.rb

@@ -14,16 +14,16 @@
 #   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 #   FOR A PARTICULAR PURPOSE.
 #
-# TODO:
-#   - Consider renaming Functor to Dispatch or Dispatcher, or Func ?
-#
-# CREDIT:
+# AUTHORS:
 #   - Thomas Sawyer
 #
 # LOG:
 #   - 2006-11-04 trans Deprecated #self. Call #self on the #binding instead.
 #   - 2006-11-04 trans Deprecated #functor_function, renamed to #to_proc.
 #   - 2006-11-04 trans All methods are now private except #binding and operators.
+#
+# TODO:
+#   - Consider renaming Functor to Dispatch or Dispatcher ?
 
 # = Functor
 #
@@ -46,7 +46,7 @@
 class Functor
 
   # Privatize all methods except vital methods, #binding and operators.
-  private *instance_methods.select { |m| m !~ /(^__|^\W|^binding$)/ }
+  private(*instance_methods.select { |m| m !~ /(^__|^\W|^binding$)/ })
 
   def initialize(&function)
     @function = function
@@ -62,41 +62,3 @@ class Functor
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-
-=begin testing
-
-  require 'test/unit'
-
-  class TC_Functor < Test::Unit::TestCase
-
-    def test_function
-      f = Functor.new { |op, x| x.send(op, x) }
-      assert_equal( 2, f + 1 ) #=> 2
-      assert_equal( 4, f + 2 ) #=> 4
-      assert_equal( 6, f + 3 ) #=> 6
-      assert_equal( 1, f * 1 ) #=> 1
-      assert_equal( 4, f * 2 ) #=> 4
-      assert_equal( 9, f * 3 ) #=> 9
-    end
-
-    def test_decoration
-      a = 'A'
-      f = Functor.new{ |op, x| x.send(op, a + x) }
-      assert_equal( 'BAB', f + 'B' )
-      assert_equal( 'CAC', f + 'C' )
-      assert_equal( 'DAD', f + 'D' )
-    end
-
-  end
-
-=end
-