facets 2.1.3 → 2.2.0

data/AUTHORS

@@ -1,25 +1,23 @@
-= Facets Contributing Authors
+= Facets Authors
 
 == Project Manager & Primary Developer
 
 * Trans (Thomas Sawyer)
 
-== Toplevel Developers
+== Recent Contributors
 
-The following developers have contributed significant
-amounts of time to the development of Facets. They are held
-in the highest regard for their efforts.
+The following developers have recently contributed
+to the development of Facets. They are held in the
+highest regard for their efforts.
 
-* Florian Gross
-* George Moschovitis
-* Tyler Rick
-* Noah Gibbs
+* Matthew Harris 	Incorporated very useful Duration class.
+* Noah Gibbs     	Completed port from Extensions project.
 
 == Rubyists of Distinction
 
-All of the following persons have contributed to 
-Facets is some form or fashion. All of their hard
-work is greatly appreciated.
+All of the following persons have contributed to
+Facets is some form or fashion over the years.
+All of their hard work is greatly appreciated.
 
 * Thibaut Barrère
 * Daniel J. Berger
@@ -32,9 +30,11 @@ work is greatly appreciated.
 * Mauricio Fernandez
 * Florian Frank
 * Hal Fulton
+* Noah Gibbs
 * Michael Granger
 * Florian Gross
 * Sean O'Halpin
+* Matthew Harris
 * David Heinemeier Hansson
 * Thomas-Ivo Heinen
 * Dave Hoover
@@ -50,8 +50,10 @@ work is greatly appreciated.
 * Jonas Pfenniger
 * Ryan Platte
 * Oliver Renaud
+* Tyler Rick
 * Christoph Rippel
 * Daniel Schierbeck
+* Louis J Scoras
 * Gavin Sinclair
 * Tilo Sloboda
 * Phil Tomson

data/CHANGES

@@ -1,5 +1,48 @@
-facets 2.1.2 / 2007-11-22
+= Facets Change History
+
+== 2.2.0 / 2007-12-13
+
+* A lot of rdoc updates to core extensions --as promised ;)
+* Just about every method now has at least a brief explinaiton and an example.
+* integer/bitmask.rb has changed a bit --pun intended ;) Deprecated some methods and now use "~" instead of "-" to clear bits.
+* The name Array#unzip didn't makes sense, it was renamed to #modulate (though #collate seems better?)
+* Renamed Enumerable#collate to #mash (Map hASH); #collate and #graph remain aliases for the time being.
+* Deprecated Module#include_and_extend. Just use both silly.
+* More lib pp_s.rb has been removed. Use #pretty_inspect instead.
+* Split binding extensions up a bit more finely --eval.rb sprouted here.rb, self.rb and defined.rb.
+* Move Time#stamp out of conversion.rb and into time/ dir, and remove to_s alias.
+* Preliminary addition of Matthew Harris' excellent duration.rb lib (will integrate with times.rb better in future).
+* Added if clauses to handle upcoming Ruby 1.9 gracefully. Facets should now be just about ready for use with 1.9.
+
+== 2.1.3 / 2007-11-28
+
+* Fixed minor oddity in Enumerable/collate.
+* Fixed major issue with 2.1.2 where it would not core facets correctly.
+
+== 2.1.2 / 2007-11-22
 
 * Dir::multiglob no longer handels -/+ modifiers. Use FileList instead.
 * Fixed task/install script.
-* Improved task/changes.
+* Improved task/changes.
+
+== 2.1.1 / 2007-11-16
+
+* Fixed bug in command.rb that clobbered options.
+* Added kernel/ergo.rb.
+
+== 2.1.0 / 2007-11-10
+
+* command.rb has been completely rewritten. The API has changed completely!
+* There is no longer a Commmand::Optoins class. Use Console::Arguments instead.
+* Added BiCrypt class to crypt.rb for simple two-way encyrption.
+* module/attr.rb now has attr_reader!, attr_writer! and attr_accessor!
+* All attr_xxx methods have coresponding alias_xxx methods.
+* Fixed bug in Enumerable#cluster_by which returned nil instead of [].
+
+== 2.0.5 / 2007-11-07
+
+* Added final methods Gavin Sinclair's Extensions project (contributed by Noah Gibbs).
+* Fixes bug with Dictionary#initialize
+* Fixes bug with Hash#-
+* Also improves changelog production.
+* Made #alias_method_chain compatible with current ActiveSupport version.

data/NOTES

@@ -1,14 +1,16 @@
-Facets 2.1.2 has been released!
+Facets 2.2.0 has been released!
 
-This release fixes then manual install script (task/install).
+This release provides improved rdocs and prepares facets for
+use with RUby 1.9. It also adds Matthew Harris' duration.rb
+library. Bug thanks to Matthew!
 
 As of 2.1.0: 
 
-Major changes include a new and much-improved
-command.rb, a new BiCrypt class for simple two-way
-crypotgraphy, as well as attr_reader!, attr_writer!
-and attr_accessor! for flag attributes, plus
-alias_xxx methods for all attr_xxx methods.
+Major changes include a new and much-improved command.rb,
+a new BiCrypt class for simple two-way crypotgraphy,
+as well as attr_reader!, attr_writer! and attr_accessor!
+for flag attributes, plus alias_xxx methods for all
+attr_xxx methods.
 
 Enjoy!
 

data/lib/core/facets/1stclassmethod.rb

@@ -1,17 +1,15 @@
-# TITLE:
+# = TITLE:
 #
 #   First Class Methods
 #
-# SUMMARY:
+# = SUMMARY:
 #
 #   Gives Ruby 1st class methods.
 #
-# COPYRIGHT:
+# = COPYRIGHT:
 #
 #   Copyright (c) 2005 Thomas Sawyer
 #
-# LICENSE:
-#
 #   Ruby License
 #
 #   This module is free software. You may use, modify, and/or redistribute this
@@ -21,11 +19,11 @@
 #   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 #   FOR A PARTICULAR PURPOSE.
 #
-# AUTHORS:
+# = AUTHORS:
 #
 #   - Thomas Sawyer
 #
-# NOTES:
+# = NOTES:
 #
 #   First Class Methods
 #
@@ -52,7 +50,6 @@
 #
 #   Which do you prefer?
 
-
 #
 module Kernel
 
@@ -61,8 +58,16 @@ module Kernel
   #   def hello
   #     puts "Hello World!"
   #   end
-  #   p method!(:hello)   #=> <Method: #hello>
   #
+  #   m1 = method!(:hello)   #=> <Method: #hello>
+  #
+  #   def m1.annotate
+  #     "simple example"
+  #   end
+  #
+  #   m2 = method!(:hello)
+  #   m2.annotate  #=> "simple example"
+
   def method!(s)
     ( @__methods__ ||= {} )[s] ||= method(s)
   end
@@ -101,8 +106,7 @@ class Module
   #   end
   #   p K.instance_method!(:hello)   #=> <UnboundMethod: #hello>
   #
-  # CAUTION! This will not work exactly right until class variable
-  # lookup is fixed. Presently it is limited to the scope of the
+  # CAUTION! This it is currently limited to the scope of the
   # current module/class.
 
   def instance_method!(s)

data/lib/core/facets/array.rb

@@ -6,7 +6,6 @@ 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/conjoin.rb

@@ -1,15 +1,47 @@
-# = Conjoin
-
-#
 class Array
 
-  def conjoin( separator=", ", last_separator="and" )
+  # This is more advnaced form of #join. It allows for a different
+  # terminating separator, and even a different starting terminator.
+  #
+  # The default separator is ", " and default terminating separator
+  # is " and ".
+  #
+  #   [1,2,3].conjoin
+  #   => "1, 2 and 3
+  #
+  #   [1,2,3].conjoin(:last => ' or ')
+  #   => "1, 2 or 3
+  #
+  #   [1,2,3].conjoin('.', :last => '-')
+  #   => "1.2-3
+  #
+  #   [2,4,2,3].conjoin(' == ', :first => " x ", :last => " ** ")
+  #   => "2 x 4 == 2 ** 3"
+  #
+  #   CREDIT: Trans
+
+  def conjoin(*args)
+    options   = (Hash===args.last) ? args.pop : {}
+    separator = args.unshift || ", "
+
+    first = options[:first] || separator
+    last  = options[:last]  || " and "
+
     case length
-    when 0: ""
-    when 1: self[0]
-    else [self[0..-2].join("#{separator}"), self[-1]].join(" #{last_separator} ")
+    when 0
+      ""
+    when 1
+      self[0]
+    else
+      [self[0], first, self[1..-2].join("#{separator}"), last, self[-1]].join
+      #[self[0..-2].join("#{separator}"), self[-1]].join("#{last}")
     end
   end
-  alias join_sentence conjoin
 
+  # Alias for #conjoin.
+  #
+  #   NOTE: This will be deprecated.
+
+  alias_method :join_sentence, :conjoin
 end
+

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

@@ -1,8 +1,11 @@
 class Array
 
-  # CREDIT Daniel Schierbeck
-
   # Inverse of #delete_if.
+  #
+  #   [1,2,3].delete_unless{ |x| x < 2 }
+  #   => [1,2]
+  #
+  #   CREDIT: Daniel Schierbeck
 
   def delete_unless(&block)
     delete_if { |element| not block.call(element) }
@@ -14,6 +17,8 @@ class Array
   #   a.delete_values(1,2)   #=> [1,2]
   #   a                      #=> [3,4]
   #
+  #   CREDIT: Trans
+
   def delete_values(*values)
     d = []
     values.each{ |v| d << delete(v) }
@@ -30,6 +35,7 @@ class Array
   #   a.delete_values_at(0..2)  #=> [1,2,3]
   #   a                         #=> [4]
   #
+  #   CREDIT: Trans
 
   def delete_values_at(*selectors)
     idx = []

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

@@ -4,9 +4,12 @@ require 'facets/array/splice'
 class Array
   include Indexable
 
-  #--
-  # Maybe not appropriate for indexable.rb, but where?
-  #++
+  # Alias for #include?.
+  #
+  #   TODO: Maybe not appropriate for indexable.rb, but where?
+  #
+  #   CREDIT: Trans
+
   alias_method :contains?, :include?
 
   #alias_method :/, :[]
@@ -18,6 +21,8 @@ class Array
   #  a.first!      #=> "a"
   #  p a           #=> ["y","z"]
   #
+  #   CREDIT: Trans
+
   alias_method :first!, :shift
 
   # Alias for pop, which removes and returns
@@ -27,6 +32,8 @@ class Array
   #  a.last! 3
   #  p a           #=> [1,2,3]
   #
+  #   CREDIT: Trans
+
   alias_method :last!, :pop
 
   # Iteration object.
@@ -51,6 +58,26 @@ class Array
   end
 
   # Iterate over each element of array using an iteration object.
+  #
+  #   [1,2,3].each_iteration do |it|
+  #     p it.index
+  #     p it.value
+  #     p it.first?
+  #     p it.last?
+  #     p it.prior
+  #     p it.after
+  #   end
+  #
+  # on each successive iteration produces:
+  #
+  #   0          1          2
+  #   1          2          3
+  #   true       false      false
+  #   false      false      true
+  #   []         [1]        [1,2]
+  #   [2,3]      [3]        []
+  #
+  #  CREDIT: Trans
 
   def each_iteration
     if block_given?

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

@@ -1,10 +1,21 @@
 class Array
 
   # Alias for <tt>|</tt>.
+  #
+  #   [1,2].merge [2,3]  #=> [1,2,3]
+  #
+  #   CREDIT: Trans
+
   alias_method :merge, :|
 
   # In place #merge.
   #
+  #   a = [1,2]
+  #   a.merge! [2,3]
+  #   a => [1,2,3]
+  #
+  #   CREDIT: Trans
+
   def merge!( other )
     self.replace( self | other )
   end

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

@@ -1,5 +1,5 @@
 class Array
-  #
+
   # Returns the _only_ element in the array.  Raises an IndexError if
   # the array's size is not 1.
   #
@@ -7,8 +7,8 @@ class Array
   #   [1,2,3].only  # -> IndexError
   #   [].only       # -> IndexError
   #
-  #   CREDIT Noah Gibbs
-  #   CREDIT Gavin Sinclair
+  #   CREDIT: Gavin Sinclair
+  #   CREDIT: Noah Gibbs
 
   def only
     unless size == 1

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

@@ -5,8 +5,6 @@
 #
 class Array
 
-  # CREDIT Richard Laugesen
-
   # Pad an array with a given <tt>value</tt> upto a given <tt>length</tt>.
   #
   #   [0,1,2].pad(6,"a")  #=> [0,1,2,"a","a","a"]
@@ -15,6 +13,8 @@ class Array
   # to the beginning of the array.
   #
   #   [0,1,2].pad(-6,"a")  #=> ["a","a","a",0,1,2]
+  #
+  #   CREDIT: Richard Laugesen
 
   def pad(len, val=nil)
     return dup if self.size >= len.abs
@@ -30,6 +30,8 @@ class Array
   #    a = [0,1,2]
   #    a.pad!(6,"x")
   #    a  #=> [0,1,2,"x","x","x"]
+  #
+  #   CREDIT: Richard Laugesen
 
   def pad!(len, val=nil)
     return self if self.size >= len.abs
@@ -41,47 +43,3 @@ class Array
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestArray < Test::Unit::TestCase
-
-    def test_pad
-      r = [0,1,2,3].pad(7,"x")
-      x = [0,1,2,3,"x","x","x"]
-      assert_equal(x,r)
-    end
-
-    def test_pad!
-      a = [0,1,2,3]
-      r = a.pad!(6,"y")
-      x = [0,1,2,3,"y","y"]
-      assert_equal(x,a)
-    end
-
-    def test_pad_negative
-      r = [0,1,2,3].pad(-7,"n")
-      x = ["n","n","n",0,1,2,3]
-      assert_equal(x,r)
-    end
-
-    def test_pad_negative!
-      a = [0,1,2,3]
-      r = a.pad!(-6,"q")
-      x = ["q","q",0,1,2,3]
-      assert_equal(x,a)
-    end
-
-  end
-
-=end