facets 2.0.2 → 2.0.3

data/AUTHORS

@@ -7,13 +7,13 @@
 == Toplevel Developers
 
 The following developers have contributed significant
-amounts of time to the developemnt of Facets. They are held
+amounts of time to the development of Facets. They are held
 in the highest regard for their efforts.
 
+* Noah Gibbs
+* Florian Gross
 * George Moschovitis
 * Tyler Rick
-* Florian Gross
-* Peter Vanbroekhoven
 
 == Rubyists of Distinction
 

data/README

@@ -36,10 +36,9 @@ IMPORTANT! Note that setup.rb is no longer used b/c of Facets' new layout.
 
 == Compatibility with 1.x series.
 
-Prior to 2.0, Facets was divided between CORE and MORE --standalone extensions vs. classes and modules, respectively. With 2.0, the notion of "CORE" has taken only a slightly differnt meaning. Instead CORE now consists of the libraries that are thought essential and as such are loaded automatically when using ++require "facets"++. While still primarily made up of extension methods a few classes now belong to core as well.
+Prior to 2.0, Facets was divided between CORE and MORE --standalone extensions vs. classes and modules, respectively. With 2.0, the notion of "CORE" has taken only a slightly different meaning. Instead CORE now consists of the libraries that are thought essential and as such are loaded automatically when using ++require "facets"++. While still primarily made up of extension methods a few classes now belong to core as well.
 
-Additionally, the extension methods are no longer stored on a per-method basis. While dividing the extension methods up on a per-method basis had certain advantages, not the least of which was a simple organization, it proved too granular --more "subatomic" than "atomic". With 2.0 we have address this issue. All the extension methods have now been organized into small tightly related groups.
-However, being able to require on the basis of a method is still a useful approach, so a compatibility layer for the 1.x series has been created. It makes it possible to load Facets libraries on a per method basis, just as before, via require redirection. For example:
+Additionally, the extension methods are no longer stored on a per-method basis. While dividing the extension methods up on a per-method basis had certain advantages, not the least of which was a simple organization, it proved too granular --more "subatomic" than "atomic". With 2.0 we have address this issue. All the extension methods have now been organized into small tightly related groups. However, being able to require on the basis of a method is still a useful approach, so a compatibility layer for the 1.x series has been created. It makes it possible to load Facets libraries on a per method basis, just as before, via require redirection. For example:
 
   require 'facets/string/underscore'
 
@@ -89,7 +88,7 @@ For example:
 
   require 'facets/time/stamp'
 
-Most "atoms" contain only a few methods, sometimes only one, but a few exceptions provide quite a few method, such as ++string/indexable.rb++.
+Most "atoms" contain only a few methods, sometimes only one, but a few exceptions provide quite a few methods, such as ++string/indexable.rb++.
 
 You can load per-class or per-module groups of core methods by requiring the class or module by name. For example"
 
@@ -97,7 +96,7 @@ You can load per-class or per-module groups of core methods by requiring the cla
 
 Will require all the Time method extensions.
 
-Note that some methods that were part of CORE in 1.8 and earlier are now part of MORE libraries. A good example is 'random.rb'. There were separated b/c they had more specialized usecases, where as CORE extensions are intended as general purpose.
+Note that some methods that were part of CORE in 1.8 and earlier are now part of MORE libraries. A good example is 'random.rb'. There were separated because they had more specialized use cases, where as CORE extensions are intended as general purpose.
 
 Using a Facets/MORE library of modules, classes or microframeworks is essentially the same. For example:
 
@@ -156,7 +155,7 @@ Facets simply takes the '*' and translates it into a string acceptable to all fi
 
 This project thrives on contribution.
 
-If you have any extension methods, classes, modules or small frameworks that you think have general applicability and would like to see them included in this project, don't hesitiate to submit. There's a very good chance it will be included.  Also, if you have better versions of any thing already included or simply have a patch, they too are more than welcome. We want Ruby Facets to be of the highest quality.
+If you have any extension methods, classes, modules or small frameworks that you think have general applicability and would like to see them included in this project, don't hesitiate to submit. There's a very good chance they will be included.  Also, if you have better versions of any thing already included or simply have a patch, they too are more than welcome. We want Ruby Facets to be of the highest quality.
 
 
 == Authors
@@ -195,7 +194,7 @@ Acknowledgments and Copyrights for particular snippets of borrowed code are give
 
 ----
 
-[1] A lot of mental anguish went into finding this good project name Ruby Facets. Of course, in the end only one name can take the honor. Other good names which were considered: Calibre, Florida and California, Warchest w/ Atomix, Downs & Ace, Trix & Atomx and even Pillbox & Pills (a _why suggestion). Then the names that almost won out and were used for a good while: Nano Methods and Mega Modules --great names but a little to "fad". Finally let's not forget even older "working" titles that were used along the way: Raspberry, ABC, Succ and the very original Tomslib.
+[1] A lot of mental anguish went into finding this good project name Ruby Facets. Of course, in the end only one name can take the honor. Other good names which were considered: Calibre, Florida and California, Warchest w/ Atomix, Downs & Ace, Trix & Atomx and even Pillbox & Pills (a _why suggestion). Then the names that almost won out and were used for a good while: Nano Methods and Mega Modules --great names but a little too "fad". Finally let's not forget even older "working" titles that were used along the way: Raspberry, ABC, Succ and the very original Tomslib.
 
 ----
 

data/lib/core/facets.rb

@@ -1,46 +1 @@
-# Facets Module
-
-module Facets
-  extend self
-
-  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"
-   require "facets/enumerable"
-   require "facets/file"
-   require "facets/filetest"
-   require "facets/float"
-   require "facets/functor"
-   require "facets/hash"
-   require "facets/indexable"
-   require "facets/integer"
-   require "facets/kernel"
-   require "facets/lazy"
-   require "facets/matchdata"
-   require "facets/module"
-   require "facets/nackclass"
-   require "facets/nilclass"
-   require "facets/nullclass"
-   require "facets/numeric"
-   require "facets/pathname"
-   require "facets/proc"
-   require "facets/range"
-   require "facets/regexp"
-   require "facets/stackable"
-   require "facets/string"
-   require "facets/symbol"
-   require "facets/time"
-   require "facets/unboundmethod"
-  end
-end
-
-# Bring it on-line!
-Facets.require_core
+require 'facets/facets.rb'

data/lib/core/facets/array.rb

@@ -4,7 +4,10 @@ require 'facets/array/merge.rb'
 require 'facets/array/select.rb'
 require 'facets/array/splice.rb'
 require 'facets/array/delete.rb'
+require 'facets/array/only.rb'
 require 'facets/array/pad.rb'
 require 'facets/array/unzip.rb'
+
 require 'facets/array/stackable.rb'
 require 'facets/array/indexable.rb'
+

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

@@ -4,7 +4,12 @@ require 'facets/array/splice'
 class Array
   include Indexable
 
-  #alias /      []
+  #--
+  # Maybe not appropriate for indexable.rb, but where?
+  #++
+  alias_method :contains?, :include?
+
+  #alias_method :/, :[]
 
   # Alias for shift, which removes and returns
   # the first element in an array.

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

@@ -0,0 +1,20 @@
+class Array
+  #
+  # Returns the _only_ element in the array.  Raises an IndexError if
+  # the array's size is not 1.
+  #
+  #   [5].only      # -> 5
+  #   [1,2,3].only  # -> IndexError
+  #   [].only       # -> IndexError
+  #
+  #   CREDIT Noah Gibbs
+  #   CREDIT Gavin Sinclair
+
+  def only
+    unless size == 1
+      raise IndexError, "Array#only called on non-single-element array"
+    end
+    first
+  end
+end
+

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

@@ -47,7 +47,7 @@ class Dir
   # This is very useful in collecting files as specificed by a configuration
   # parameter.
 
-  def self.multiglob( *patterns )
+  def self.multiglob(*patterns)
     options  = (Hash === patterns.last ? patterns.pop : {})
 
     bitflags = 0
@@ -58,6 +58,15 @@ class Dir
 
     patterns = [patterns].flatten.compact
 
+    if options[:default]
+      default = [options[:default]].flatten.compact
+      #if patterns.empty?
+      #  patterns = default
+      if patterns.first =~ /^[+-]/ || patterns.empty?
+        patterns = default + patterns
+      end
+    end
+
     patterns_include = patterns.select{ |f| f !~ /^[-]/ }
     patterns_exclude = patterns.select{ |f| f =~ /^[-]/ }
 
@@ -105,6 +114,8 @@ class Dir
   #
   # This is useful when a configuration option needs to supply a file list
   # that may include files, exclude files or append files to a default list.
+  #
+  # TODO Deprecate this and replace with :default option on regular multiglob?
 
   def self.multiglob_with_default(default, *patterns)
     default = [default].flatten.compact

data/lib/core/facets/enumerable.rb

@@ -1,4 +1,3 @@
-require 'facets/enumerable/instance_map.rb'
 require 'facets/enumerable/cartesian.rb'
 require 'facets/enumerable/combination.rb'
 require 'facets/enumerable/collate.rb'

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

@@ -244,3 +244,4 @@ module Enumerable
   #   alias_method :each_with_counter, :each_with_index
 
 end
+

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

@@ -1,21 +1,14 @@
-# TITLE:
-#   Combination
-#
-# DESCRIPTION:
-#   Enumerble combination extensions.
-#
-# AUTHORS:
-#   - Florian Gross
-#   - Thomas Sawyer
+# LOG:
+#   - 2007.11.01 Trans
+#     Deprecated #each_uniq_pair, just use #each_combination instead.
 
 require 'facets/integer/factorial'
 
-#
 module Enumerable
 
   # Produces an array of arrays of all possible combinations
   # of the given arrays in the positions given. (Imagine
-  # it like a slot machine dial. This gives evey combination
+  # it like a slot machine dial. This gives every combination
   # that could come up.)
   #
   #   a = %w|a b|
@@ -34,6 +27,8 @@ module Enumerable
   #   ["b", "x", "x"]
   #   ["b", "x", "y"]
   #
+  #   CREDIT Florian Gross
+
   def self.combinations(head, *rest)
     crest = rest.empty? ? [[]] : combinations(*rest)
     head.inject([]) { |combs, item|
@@ -55,6 +50,8 @@ module Enumerable
   #   ["a", "c", "d"]
   #   ["b", "c", "d"]
   #
+  #   CREDIT Florian Gross
+
   def each_combination(k=2)
     s = to_a
     n = s.size
@@ -70,85 +67,42 @@ module Enumerable
     end
   end
 
-  # TODO Change name of each_unique_pair.
-
-  # Processes each unique pair (of indices, not value)
-  # in the array by yielding them to the supplied block.
-  #
-  #   a = [1,2,3,4]
-  #   a.each_unique_pair{ |a,b| puts a+','+b }
-  #
-  # produces
-  #
-  #   1,2
-  #   1,3
-  #   1,4
-  #   2,3
-  #   2,4
-  #   3,4
-  #
-  # This does not guarantee the uniqueness of values.
-  # For example:
-  #
-  #   a = [1,2,1]
-  #   a.each_unique_pair{ |a,b| puts a+','+b }
-  #
-  # prduces
-  #
-  #   1,2
-  #   1,1
-  #   2,1
-  #
-  # This is equivalent to <tt>each_combination(2){ ... }</tt>.
-  def each_unique_pair(&yld)
-    self.each_combination(2,&yld)
-    #s = self.to_a
-    #self.each_with_index{ |a,i|
-    #  self[(i+1)..-1].each{ |b| yield a,b }
-    #}
-  end
-
-end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
+#   # Processes each unique pair (of indices, not value)
+#   # in the array by yielding them to the supplied block.
+#   #
+#   #   a = [1,2,3,4]
+#   #   a.each_unique_pair{ |a,b| puts a+','+b }
+#   #
+#   # produces
+#   #
+#   #   1,2
+#   #   1,3
+#   #   1,4
+#   #   2,3
+#   #   2,4
+#   #   3,4
+#   #
+#   # This does not guarantee the uniqueness of values.
+#   # For example:
+#   #
+#   #   a = [1,2,1]
+#   #   a.each_unique_pair{ |a,b| puts a+','+b }
+#   #
+#   # prduces
+#   #
+#   #   1,2
+#   #   1,1
+#   #   2,1
+#   #
+#   # This is equivalent to <tt>each_combination(2){ ... }</tt>.
 #
-=begin test
-
-  require 'test/unit'
-  require 'set'
+#   def each_unique_pair(&yld)
+#     self.each_combination(2,&yld)
+#     #s = self.to_a
+#     #self.each_with_index{ |a,i|
+#     #  self[(i+1)..-1].each{ |b| yield a,b }
+#     #}
+#   end
 
-  class TestEnumerableCombination < Test::Unit::TestCase
-
-    def test_combinations_01
-      a = [1,2]
-      b = [3,4]
-      z = Enumerable.combinations(a,b)
-      r = [[1,3],[1,4],[2,3],[2,4]]
-      assert_equal( r, z )
-    end
-
-    def test_combinations_02
-      a = %w|a b|
-      b = %w|a x|
-      c = %w|x y|
-      z = Enumerable.combinations(a, b, c)
-      r = [ ["a", "a", "x"],
-            ["a", "a", "y"],
-            ["a", "x", "x"],
-            ["a", "x", "y"],
-            ["b", "a", "x"],
-            ["b", "a", "y"],
-            ["b", "x", "x"],
-            ["b", "x", "y"] ]
-      assert_equal( r, z )
-    end
-
-  end
+end
 
-=end

data/lib/core/facets/facets.rb

@@ -0,0 +1,46 @@
+# Facets Module
+
+module Facets
+  extend self
+
+  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"
+   require "facets/enumerable"
+   require "facets/file"
+   require "facets/filetest"
+   require "facets/float"
+   require "facets/functor"
+   require "facets/hash"
+   require "facets/indexable"
+   require "facets/integer"
+   require "facets/kernel"
+   require "facets/lazy"
+   require "facets/matchdata"
+   require "facets/module"
+   require "facets/nackclass"
+   require "facets/nilclass"
+   require "facets/nullclass"
+   require "facets/numeric"
+   require "facets/pathname"
+   require "facets/proc"
+   require "facets/range"
+   require "facets/regexp"
+   require "facets/stackable"
+   require "facets/string"
+   require "facets/symbol"
+   require "facets/time"
+   require "facets/unboundmethod"
+  end
+end
+
+# Bring it on-line!
+Facets.require_core

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

@@ -12,6 +12,14 @@
 #   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
@@ -19,7 +27,7 @@ class File
   # Append to a file.
 
   def self.append( file, str )
-    File.open( file, 'a' ) { |f|
+    File.open( file, 'ab' ) { |f|
       f << str
     }
   end
@@ -35,7 +43,7 @@ class File
   #   File.create('myfile.txt', str)
 
   def self.create(path, str='', &blk)
-    File.open(path, 'w') { |f|
+    File.open(path, 'wb') { |f|
       f << str
       blk.call(f) if blk
     }
@@ -43,8 +51,42 @@ class File
 
   # Write file with string.
 
-  def self.write(file, str)
-    File.open(file, 'w'){ |f| f << str }
+  def self.write(path, data)
+    File.open(path, 'wb'){ |f| f.write(data) }
+  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.
+  #
+  # 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. 
+  #
+  # Returns +nil+.
+  #
+  #   CREDIT Noah Gibbs
+  #   CREDIT Gavin Sinclair
+
+  def self.writelines(path, data)
+    File.open(path, "wb") do |file|
+      file.puts(data)
+    end
   end
 
   # Opens a file as a string and writes back the string to the file at
@@ -97,57 +139,3 @@ class File
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-# TODO This isn't right, and I'm concerned about acidentally writing a real file.
-
-=begin #test
-
-  require 'test/unit'
-
-  class TestFileWrite < Test::Unit::TestCase
-
-    class MockFile < ::File
-      def open( fname, mode, &blk )
-        blk.call(self)
-      end
-      def ead( fname=nil )
-        @mrock_content.clone
-      end
-      def write( str )
-        @mock_content = str
-      end
-      def <<( str )
-        (@mock_content ||="") << str
-      end
-    end
-
-    File = MockFile.new
-
-    def test_create
-      f = "not a real file"
-      t = 'This is a test'
-      File.create( f, t )
-      s = File.read( f )
-      assert_equal( t, s )
-    end
-
-    def test_rewrite
-      f = "not a real file"
-      t = 'This is a test'
-      File.write( t )
-      File.rewrite(f) { |s| s.reverse! }
-      s = File.read(f)
-      assert_equal( t.reverse, s )
-    end
-
-  end
-
-=end