facets 2.0.0 → 2.0.1

data/lib/core/facets/enumerable.rb

@@ -5,5 +5,4 @@ require 'facets/enumerable/collate.rb'
 require 'facets/enumerable/collect.rb'
 require 'facets/enumerable/permutation.rb'
 require 'facets/enumerable/count.rb'
-require 'facets/enumerable/partition.rb'
 require 'facets/enumerable/probability.rb'

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

@@ -1,20 +1,43 @@
-# TITLE
+# TITLE:
 #
 #   Collect
 #
-# = DESCRIPTION
+# DESCRIPTION:
 #
-#   Enumerble collection extensions.
+#   Variations of Enumerable collection and partition methods.
 #
-# = AUTHORS
+# AUTHORS:
 #
-#   CREDIT Florian Gross
-#   CREDIT Thomas Sawyer
-#   CREDIT Gavin Sinclair
+#   - Florian Gross
+#   - Thomas Sawyer
+#   - Gavin Sinclair
+#   - Thibaut Barrère
+#   - WhyTheLuckyStiff
+#   - Daniel Sheppard
+#   - Paul Battley
+#
+# NOTES:
+#
+#   - TODO Deprecate #group_by when released for Ruby 1.9.
+#   - TODO Suggest Enumerator's #each_slice use block arity if no parameter is given.
+
+require 'enumerator' # for each_slice
 
 #
 module Enumerable
 
+  # Partition an array into parts of given length.
+  #
+  # CREDIT WhyTheLuckyStiff
+
+  #   def / len
+  #     inject([]) do |ary, x|
+  #       ary << [] if [*ary.last].nitems % len == 0
+  #       ary.last << x
+  #       ary
+  #     end
+  #   end
+
   # Same as #collect but with an iteration counter.
   #
   #   a = [1,2,3].collect_with_index { |e,i| e*i }
@@ -28,22 +51,7 @@ module Enumerable
     r
   end
 
-  alias_method( :map_with_index, :collect_with_index )
-
-  # DEPRECATE?
-
-  # Why the term counter? There may be a change in Ruby 2.0
-  # to use this word instead of index. Index will
-  # still be used for Array, since that is the proper meaning
-  # in that context. In the mean time, aliases are provided.
-
-  alias_method( :collect_with_counter, :collect_with_index )
-  alias_method( :map_with_counter, :collect_with_index )
-
-  # More appropriate naming since an enumerable is not
-  # neccesarily "indexed", as is an Array or Hash.
-
-  alias_method :each_with_counter, :each_with_index
+  alias_method :map_with_index, :collect_with_index
 
   # Collects/Maps and filters items out in one single step.
   # You can use throw(:skip) in the supplied block to indicate that the
@@ -56,7 +64,7 @@ module Enumerable
   #   end
   #
   # Also see Enumerable#collect, Enumerable#find_all.
-  #
+
   def filter_collect #:yield:
     result = []
     self.each do |item|
@@ -78,7 +86,7 @@ module Enumerable
   #   persons.compact_collect { |person| person.telephone_no }
   #
   # Also see Enumerable#collect, Enumerable#map, Array#compact.
-  #
+
   def compact_collect #:yield:
     filter_collect do |item|
       new_item = yield(item)
@@ -91,65 +99,148 @@ module Enumerable
 
   # Say you want to count letters--
   #
-  #    some_text.injecting(Hash.new(0) {|h,l| h[l] += 1}
+  #    some_text.injecting(Hash.new(0)) {|h,l| h[l] += 1}
   #
   # vs
   #
   #    some_text.inject(Hash.new(0)) {|h,l| h[l] +=1; h}
   #
-  #--
   # CREDIT Louis J Scoras
-  #++
+
   def injecting(s)
     inject(s) do |k, i|
       yield(k, i); k
     end
   end
 
-end
-
+  # The #group_by method is best explained by example.
+  #
+  #   (1..5).partition_by { |n| n % 3 }
+  #        #=> { 0 => [3], 1 => [1, 4], 2 => [2,5] }
+  #
+  #   ["I had", 1, "dollar and", 50, "cents"].partition_by { |e| e.class }
+  #        #=> { String => ["I had","dollar and","cents"], Fixnum => [1,50] }
+  #
+  # #group_by is used to group items in a collection by something they
+  # have in common.  The common factor is the key in the resulting hash, the
+  # array of like elements is the value.
+  #
+  # CREDIT Erik Veenstra
 
+  def group_by #:yield:
+    h = k = e = nil
+    r = Hash.new
+    each{ |e| (r[yield(e)] ||= []) << e }
+    r
+  end
 
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
+  # This alias is the original Facets name for the method, but Ruby 1.9 has
+  # adopted #group_by as the name, so eventually #partition_by will be deprecated.
+  alias_method :partition_by, :group_by
 
-  require 'test/unit'
+  # Similar to #group_by but returns an array of the groups.
+  # Returned elements are sorted by block.
+  #
+  #    %w{this is a test}.cluster_by {|x| x[0]}
+  #
+  # _produces_
+  #
+  #    [ ['a'], ['is'], ['this', 'test'] ]
+  #
+  # CREDIT Erik Veenstra
 
-  class TestEnumerableCollect < Test::Unit::TestCase
+  def cluster_by(&b)
+    #group_by(&b).values
+    group_by(&b).sort.transpose.pop
+  end
 
-    def test_filter_collect
-      e = [3,4]
-      a = [1,2,3,4].filter_collect { |n|
-        throw(:skip) if n < 3
-        n
-      }
-      assert_equal( e, a )
+  # Split on matching pattern.
+  #
+  # ['a1','b1','a2','b2'].divide(/^a/)
+  # => [['a1,'b1'],['a2','b2']]
+
+  def divide(pattern)
+    inject([]) do |memo,obj|
+      memo.push [] if pattern === obj
+      memo.last << obj
+      memo
     end
+  end
 
-    def test_compact_collect
-      a = [1,2,nil,4].compact_collect { |e| e }
-      assert_equal( [1,2,4], a )
+  # Iterate through slices. If slicing +step+ is not
+  # given, the the arity if the block is used.
+  #
+  #   x = []
+  #   [1,2,3,4].each_by{ |a,b| x << [a,b] }
+  #   x  #=> [ [1,2], [3,4] ]
+  #
+  #   x = []
+  #   [1,2,3,4,5,6].each_by(3){ |a| x << a }
+  #   x  #=> [ [1,2,3], [4,5,6] ]
+
+  def each_by(step=nil, &yld)
+    if step
+      each_slice(step,&yld)
+    else
+      step = yld.arity.abs
+      each_slice(step,&yld)
     end
+  end
 
-    def test_filter_collect
-      e = [3,4]
-      a = [1,2,3,4].filter_collect { |n|
-        throw(:skip) if n < 3
-        n
-      }
-      assert_equal( e, a )
+  # Iterators over each element pairing.
+  #
+  #   [:a,:b,:c,:d].each_pair { |a,b|  puts "#{a} -> #{b}" }
+  #
+  # _produces_
+  #
+  #   a -> b
+  #   c -> d
+
+  def each_pair #:yield:
+    e1 = nil
+    each_with_index do |e,i|
+      if i % 2 == 0
+        e1 = e
+        next
+      else
+        yield(e1,e)
+      end
     end
+  end
 
-    def test_compact_collect
-      a = [1,2,nil,4].compact_collect { |e| e }
-      assert_equal( [1,2,4], a )
-    end
+  # Collect each n items.
+  #
+  # CREDIT Martin DeMello
+
+  def eachn(&block)
+    n = block.arity.abs
+    each_slice(n) {|i| block.call(*i)}
+  end
+
+  # Conditional collect.
 
+  def collect_if(&b)
+    a = map(&b)
+    # to get the same semantics as select{|e| e}
+    a.delete(false)
+    a.compact!
+    a
   end
 
-=end
+  alias_method :map_if, :collect_if
+
+  # DEPRECATED
+  #
+  #   # Why the term counter? There may be a change in Ruby 2.0
+  #   # to use this word instead of index. Index will
+  #   # still be used for Array, since that is the proper meaning
+  #   # in that context. In the mean time, aliases are provided.
+  #
+  #   alias_method( :collect_with_counter, :collect_with_index )
+  #   alias_method( :map_with_counter, :collect_with_index )
+  #
+  #   # More appropriate naming since an enumerable is not
+  #   # neccesarily "indexed", as is an Array or Hash.
+  #   alias_method :each_with_counter, :each_with_index
+
+end

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

@@ -90,23 +90,21 @@ module Enumerable
     h2.keys
   end
 
-  #
-  def nonuniq!
-    raise unless respond_to?(:replace)
-    h1 = {}
-    h2 = {}
-    each {|i|
-      h2[i] = true if h1[i]
-      h1[i] = true
-    }
-    self.replace(h2.keys)
-  end
+#   #
+#   def nonuniq!
+#     raise unless respond_to?(:replace)
+#     h1 = {}
+#     h2 = {}
+#     each {|i|
+#       h2[i] = true if h1[i]
+#       h1[i] = true
+#     }
+#     self.replace(h2.keys)
+#   end
 
   # Return list of dulicate elements.
 
-  def duplicates
-    inject(Hash.new(0)){|h,v| h[v]+=1; h}.reject{|k,v| v==1}.keys
-  end
+  alias_method :duplicates, :nonuniq
 
   # Like #uniq, but determines uniqueness based on a given block.
   #

data/lib/core/facets/integer/of.rb

@@ -7,11 +7,16 @@ class Integer
   #   a = 3.of { |i| "#{i+1}" }
   #   a => [ "1", "2", "3" ]
   #
-  def of(&yld)
-    a = []; self.times{ |i| a << yld.call(i) }
-    a
+  def of(&block)
+    Array.new(self, &block)
   end
 
+  #def of(&yld)
+  #  a = []; self.times{ |i| a << yld.call(i) }
+  #  a
+  #end
+
+  # Time warn aliases for #of.
   alias_method :times_collect, :of
   alias_method :times_map, :of
 

data/lib/methods/facets/enumerable/cluster_by.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/collect_if.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/divide.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/each_by.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/each_pair.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/eachn.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/group_by.rb

@@ -0,0 +1 @@
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/map_if.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/lib/methods/facets/enumerable/partition_by.rb

@@ -1 +1 @@
-require 'facets/enumerable/partition.rb'
+require 'facets/enumerable/collect.rb'

data/meta/manifest.txt

@@ -4,7 +4,11 @@ LICENSE
 README
 demo
 demo/bench
-demo/bench/bench_factorial.rb
+demo/bench/enumerable
+demo/bench/enumerable/bench_collect.rb
+demo/bench/enumerable/bench_count.rb
+demo/bench/integer
+demo/bench/integer/bench_factorial.rb
 demo/sample
 demo/sample/annotations
 demo/sample/annotations/annotations1.rb
@@ -56,7 +60,6 @@ lib/core/facets/enumerable/collect.rb
 lib/core/facets/enumerable/combination.rb
 lib/core/facets/enumerable/count.rb
 lib/core/facets/enumerable/instance_map.rb
-lib/core/facets/enumerable/partition.rb
 lib/core/facets/enumerable/permutation.rb
 lib/core/facets/enumerable/probability.rb
 lib/core/facets/enumerable.rb
@@ -287,6 +290,7 @@ lib/methods/facets/enumerable/filter_collect.rb
 lib/methods/facets/enumerable/filter_map.rb
 lib/methods/facets/enumerable/frequency.rb
 lib/methods/facets/enumerable/graph.rb
+lib/methods/facets/enumerable/group_by.rb
 lib/methods/facets/enumerable/ideal_entropy.rb
 lib/methods/facets/enumerable/injecting.rb
 lib/methods/facets/enumerable/map_if.rb
@@ -815,7 +819,6 @@ test/unit/enumerable/test_collate.rb
 test/unit/enumerable/test_collect.rb
 test/unit/enumerable/test_combination.rb
 test/unit/enumerable/test_count.rb
-test/unit/enumerable/test_partition.rb
 test/unit/enumerable/test_permutation.rb
 test/unit/enumerable/test_probability.rb
 test/unit/file

data/meta/version.txt

@@ -1 +1 @@
-2.0.0 stable (2007-10-03)
+2.0.1 stable (2007-10-03)

data/task/clean

@@ -1,8 +1,8 @@
 #!/usr/bin/env ratch
 
-CLOBBER = %w{ pkg doc/rdoc }
+# Remove pkg/ and doc/rdoc products
 
-# Remove generated files
+CLOBBER = %w{ pkg doc/rdoc }
 
 main :clean do
   CLOBBER.each do |f|

data/task/groups

@@ -4,6 +4,7 @@
 
 main :groups do
   dir = 'lib/core/facets'
+
   Dir.chdir(dir) do
     dirs = Dir.glob('*').select{ |f| File.directory?(f) }
     dirs.each do |d|

data/task/methods

@@ -5,8 +5,12 @@
 # This tool generates libraries files for each
 # method in the every facets library.
 
-require 'lib/core/facets/kernel/op_esc'
-require 'lib/core/facets/module/require'
+$LOAD_PATH.unshift(File.expand_path('lib/methods'))
+$LOAD_PATH.unshift(File.expand_path('lib/core'))
+$LOAD_PATH.unshift(File.expand_path('lib/more'))
+
+require 'facets/kernel/op_esc'
+require 'facets/module/require'
 
 # Read configuration
 
@@ -56,7 +60,7 @@ task :generate_redirects => [ :neuter_module ] do
   redirect_libs.each do |file|
     next if dir?(file) #File.directory?(file)
 
-    # puts "#{file}..."
+    puts "#{file}..."
 
     mod = Module.new
     mod.module_eval do