facets 0.6.3

data/lib/facet-dev/README

@@ -0,0 +1,11 @@
+*** IMPORTANT!!! ***
+
+This directory contains alpha code and is generally considered
+expiremental. It is provided as a means for conmmon development
+and potential inspiration.
+
+Some of these, or variations there-of, will find eventually become
+part of the main lib.
+
+
+

data/lib/facet-dev/advice.rb

@@ -0,0 +1,70 @@
+#Copyright MJFP
+#batsman dot geo at yahoo dot com 
+  
+  class Module
+     def def_advice(meth, &block)
+         prev = self.instance_method(meth)
+         define_method(meth) do |*a|
+             block.call prev.bind(self), *a
+         end
+     end
+
+     def def_preadvice(meth, &block)
+         prev = self.instance_method(meth)
+         define_method(meth) do |*a|
+             block.call(*a)
+             prev.bind(self).call(*a)
+         end
+     end
+
+     def def_postadvice(meth, &block)
+         prev = self.instance_method(meth)
+         define_method(meth) do |*a|
+             prev.bind(self).call(*a)
+             block.call(*a)
+         end
+     end
+ end
+
+ class A
+     def foo(*a)
+         puts "A#foo #{a.inspect}"
+     end
+ end
+ a = A.new
+ a.foo
+
+ class A
+     def_advice(:foo) do |prev, *a|
+         puts "before"
+         prev[*a]
+         puts "after"
+     end
+ end
+
+ puts "--"
+ a.foo
+
+ class A
+     def_preadvice(:foo) { puts "pre 1" }
+     def_postadvice(:foo) { puts "post 1"}
+     def_preadvice(:foo) { puts "pre 2" }
+ end
+
+ puts "--"
+ a.foo
+ batsman@tux-chan:/tmp$ ruby aop2.rb
+ A#foo []
+ 
+ =begin
+ before
+ A#foo []
+ after
+ pre 2
+ pre 1
+ before
+ A#foo []
+ after
+ post 1
+ =end
+ 

data/lib/facet-dev/array/**.rb

@@ -0,0 +1,17 @@
+class Array
+  # Basic Array cross-product.
+  #--
+  # Note this code is wrong. The idea here is to
+  # offer a more effiecnt veriosn of Enumerable#cross
+  # for Array's. When done, require Array#**
+  # in Enumerable#** too.
+  #++
+  def **(other_enum)
+    res = Array.new
+    self.each do |i|
+      other_enum.each { |j|  res << [i,j] }
+    end
+    return res
+  end
+end
+

data/lib/facet-dev/array/at_rand.rb

@@ -0,0 +1,95 @@
+class Array
+
+  # Return an array element at random.
+  #
+  #   require 'facet/array/at_rand'
+  #
+  #   [1,2,3,4].at_rand     #=> 1
+  #   [1,2,3,4].at_rand     #=> 4
+  #   [1,2,3,4].at_rand(1)  #=> [4]
+  #   [1,2,3,4].at_rand(3)  #=> [2,2,1]
+  #   [1,2,3,4].at_rand(3)  #=> [3,2,4]
+  #
+#   def at_rand(n=nil, exclusive=false)
+#     if n
+#       n = n.to_i
+#       if exclusive
+#         return dup if n >= length
+#         return sort_by{Kernel.rand}[0..n]
+#       else
+#         idx = []
+#         n.times do
+#           idx << Kernel.rand(self.size)
+#         end
+#         return values_at(*idx)
+#       end
+#     else
+#       return at( Kernel.rand(self.size) )
+#     end
+#   end
+
+  def at_rand(n=nil, exclusive=false)
+    if n
+      return values_at(*rand_index(n, :exclusive))
+    else
+      return at(Kernel.rand(length))
+    end
+  end
+  alias_method(:at_random, :at_rand)
+
+
+  def pick(n)
+  
+  end
+
+
+  # Return random index or indexes of an array. If a number
+  # of indexes _n_ is given, an array of indexes is returned.
+  # This in non-exlusive and may pick the same index more than
+  # once.
+  #
+  #   ["a", "b", "c"].rand_index          #=> "a" (or "b", or "c")
+  #   ["a", "b", "c"].rand_index(2)       #=> ["a","b"]  
+  #   ["a", "b", "c"].rand_index(3)       #=> ["a","b","b"]
+  #
+  def rand_index(n=nil)
+    if n
+      n = n.to_i 
+      if exclusive
+        idx = (0...size).to_a
+        return idx if n >= length
+        return idx.sort_by{Kernel.rand}.slice(0,n)
+      else
+        idx = []
+        n.times{ idx << Kernel.rand(self.length) }
+        return idx
+      end
+    else
+      return Kernel.rand(size)
+    end
+  end
+
+  # Pick and return a random index or indexes of array.
+  # If a number of indexes _n_ is given, an array of indexes
+  # is returned. Unlike #rand_index, #pick_index is exclusive
+  # and will not pick the same index twice. If _n_ exceeds
+  # the size of the array, all elements are returned.
+  #
+  #   ["a", "b", "c"].pick_index          #=> "a" (or "b", or "c")
+  #   ["a", "b", "c"].pick_index(2)       #=> ["a","b"]  
+  #   ["a", "b", "c"].pick_index(3)       #=> ["a","b","c"]
+  #
+  #
+  def pick_index(n=nil)
+    if n
+      n = n.to_i
+      idx = (0...size).to_a
+      return idx if n >= length
+      return idx.sort_by{Kernel.rand}.slice(0,n)
+    else
+      return Kernel.rand(size)
+    end
+  end
+
+end
+

data/lib/facet-dev/array/each_slice.rb

@@ -0,0 +1,23 @@
+# DEPRECATE. THIS IS INCLUDED IN ENUMERABLE NOW.
+class Array
+  # Iterates over +n+ elements at a time. If +n+ is
+  # not given then the arity of the block determines the 
+  # slicing quantity.
+  #
+  #   require 'facet/array/each_slice'
+  #
+  #   [1, 2, 3, 4].each_slice(2){ |a,b| ... }
+  #
+  # Enumerable#each_slice offers the same functionality 
+  # but this is a more efficient implementation specifically
+  # for the Array.
+  def each_slice(n=nil, &yld)
+    n = yld.arity.abs unless n
+    i=0
+    while i < self.length
+      yld.call(*self.slice(i,n))
+      i+=n
+    end
+  end
+  alias_method( :each_by, :each_slice )
+end

data/lib/facet-dev/array/pick_values.rb

@@ -0,0 +1,32 @@
+
+class Array
+
+  # Pick out _n_ random elements from the array.
+  # If _n_ is not given then picks out a single 
+  # element.
+  #
+  #   require 'facet/array/pick'
+  #
+  #   a = ["a", "b", "c", "d", "e"]
+  #   a.pick             #=> "b"
+  #   a                  #=> ["a", "c", "d", "e"]
+  #   a.pick(2)          #=> ["a", "e"]
+  #   a                  #=> ["c", "d"]
+  #
+  def pick(n=nil)
+    if n
+      n = n.to_i
+      all = (0..size).to_a
+      idx = pick_indexes(n)
+      vals = values_at(*idx)
+      replace( values_at( *(all - idx) )
+      return vals
+    else
+      i = Kernel.rand(size)
+      v = at(i)
+      delete_at(i)
+      return v
+    end
+  end
+
+end 

data/lib/facet-dev/array/remove.rb

@@ -0,0 +1,21 @@
+class Array
+  # Like +compact+ but takes an _object_ to be
+  # removed rather then just nil. Empty string
+  # ("") is the default if no parameter is given.
+  #
+  #   require 'facet/array/remove'
+  #
+  #   [1,'a',nil,""].remove         #=> [1,'a',nil]
+  #   [1,'a',nil,""].remove(nil)    #=> [1,'a',""]
+  #   [1,'a',nil,""].remove('a')    #=> [1,nil,""]
+  #
+  # This could probably use a little error catching code (todo).
+  def remove(object="")
+    if object
+      delete(object)
+    else
+      compact
+    end
+    self
+  end
+end

data/lib/facet-dev/binding/class.rb

@@ -0,0 +1,11 @@
+class Binding
+  # Returns the class in the binding context
+  # this is just a shortcut for self.class
+  # You can still get to the old class (of the binding)
+  # via #__class__. (NOTE: Is this really a good idea?)
+  alias_method( :__class__, :class ) unless respond_to?( :__class__ )
+  def class()
+    @class ||= eval( "self.class" )
+    @class
+  end
+end 

data/lib/facet-dev/binding/delegate.rb

@@ -0,0 +1,15 @@
+require 'facet/binding/binding' # This comes with the whole nine yards.
+class Binding
+  # All missing methods delegate to binding's self.
+  #--
+  # (is this a good idea, or not?)
+  #++
+  alias_method( :method_missing_without_delegate, :method_missing )
+  def method_missing(sym, *args, &blk)
+    if send(:self).respond_to?(sym)
+      send(:self).send(sym, *args, &blk)
+    else
+      method_missing_without_delegate
+    end
+  end
+end

data/lib/facet-dev/binding/proc.rb

@@ -0,0 +1,6 @@
+class Binding
+  # Returns the Proc that was active, if any, when the binding was created
+  #def proc() ... ??? ...  
+end
+
+ 

data/lib/facet-dev/class_include.rb

@@ -0,0 +1,13 @@
+class Module
+  private
+  def when_included_provide_class_methods(&bl)
+    unless @__class_methods_module
+      @__class_methods_module = Module.new
+      def self.append_features(base)
+        super
+        base.extend(@__class_methods_module)
+      end
+    end
+    @__class_methods_module.class_eval(&bl)
+  end
+end 

data/lib/facet-dev/enumerable/[].rb

@@ -0,0 +1,30 @@
+
+module Enumerable
+  def [](*args)
+    arr = self.to_a
+    r = []    
+    args.each{ |arg|
+      case arg
+      when Proc
+        r.concat arr.find_all &arg
+      when Range
+        r.concat arr[arg]
+      when Numeric
+        r << arr[arg]
+      else
+        raise ArgumentError, "Invalid enumeration"
+        #super if defined? super
+      end
+    }
+    r
+  end
+end
+
+
+# --- test ---
+
+if $0 == __FILE__
+
+  p ("a".."z")[2,5,3..4]
+  
+end

data/lib/facet-dev/enumerable/rand.rb

@@ -0,0 +1,412 @@
+#
+# = rand.rb -- library for picking random elements and shuffling
+#
+# Copyright (C) 2004  Ilmari Heikkinen <mailto:kig@misfiring.net>
+#
+# Documentation:: Christian Neukirchen <mailto:chneukirchen@gmail.com>
+# 
+
+
+module Enumerable
+  # Choose and return a random element of the Enumerable.
+  #   [1, 2, 3, 4].pick  #=> 2 (or 1, 3, 4)
+  def pick
+    entries.pick
+  end
+
+  # Return an array of the elements in random order.
+  #   [1, 2, 3, 4].shuffle  #=> [3, 4, 1, 2]
+  def shuffle
+    entries.shuffle
+  end
+
+  # Calls _block_ once for each element in _self_ in random order,
+  # passing that element as a parameter.
+  def each_random(&block)
+    shuffle.each(&block)
+  end
+
+  # Invokes _block_ once for each element of _self_ in random order.
+  # Creates a new array containing the values returned by the block.
+  def map_random(&block)
+    shuffle.map(&block)
+  end
+end
+
+
+class Array
+  # Choose and return a random element of _self_.
+  #   [1, 2, 3, 4].pick  #=> 2 (or 1, 3, 4)
+  def pick
+    self[pick_index]
+  end
+
+  # Deletes a random element of _self_, returning that element.
+  #   a = [1, 2, 3, 4]
+  #   a.pick  #=> 2
+  #   a       #=> [1, 3, 4]
+  def pick!
+    i = pick_index
+    rv = self[i]
+    delete_at(i)
+    rv
+  end
+
+  # Return the index of an random element of _self_.
+  #   ["foo", "bar", "baz"].pick_index  #=> 1 (or 0, or 2)
+  def pick_index
+    rand(size)
+  end
+
+  # Destructive pick_index.  Delete a random element of _self_ and
+  # return its index.
+  #   a = [11, 22, 33, 44]
+  #   a.pick_index!  #=> 2
+  #   a              #=> [11, 22, 44]
+  def pick_index!
+    i = pick_index
+    delete_at i
+    i
+  end
+
+  # Return an array of the elements in random order.
+  #   [11, 22, 33, 44].shuffle  #=> [33, 11, 44, 22]
+  def shuffle
+    sort_by{rand}
+  end
+
+  # Destructive shuffle.  Arrange the elements of _self_ in new order.
+  #   a = [11, 22, 33, 44]
+  #   a.shuffle!
+  #   a                      #=> [33, 11, 44, 22]
+  def shuffle!
+    sort!{rand <=> 0.5}
+  end
+end
+
+
+class Hash
+  # Choose and return a random key-value pair of _self_.
+  #   {:one => 1, :two => 2, :three => 3}.pick  #=> [:one, 1]
+  def pick
+    k = keys.pick
+    [k, self[k]]
+  end
+
+  # Deletes a random key-value pair of _self_, returning that pair.
+  #   a = {:one => 1, :two => 2, :three => 3}
+  #   a.pick  #=> [:two, 2]
+  #   a       #=> {:one => 1, :three => 3}
+  def pick!
+    rv = pick
+    delete rv.first
+    rv
+  end
+
+  # Return a random key of _self_.
+  #   {:one => 1, :two => 2, :three => 3}.pick_key  #=> :three
+  def pick_key
+    keys.pick
+  end
+
+  # Return a random value of _self_.
+  #   {:one => 1, :two => 2, :three => 3}.pick_value  #=> 3
+  def pick_value
+    values.pick
+  end
+
+  # Delete a random key-value pair of _self_ and return the key.
+  #   a = {:one => 1, :two => 2, :three => 3}
+  #   a.pick_key!  #=> :two
+  #   a       #=> {:one => 1, :three => 3}
+  def pick_key!
+    pick!.first
+  end
+
+  # Delete a random key-value pair of _self_ and return the value.
+  #   a = {:one => 1, :two => 2, :three => 3}
+  #   a.pick_value!  #=> 2
+  #   a       #=> {:one => 1, :three => 3}
+  def pick_value!
+    pick!.last
+  end
+
+  # Return the key-value pairs of _self_ with _keys_ and _values_
+  # shuffled independedly.
+  #   {:one => 1, :two => 2, :three => 3}.shuffle_hash_pairs
+  #      #=> [[:one, 3], [:two, 1], [:three, 2]]
+  def shuffle_hash_pairs
+    keys.shuffle.zip(values.shuffle)
+  end
+
+  # Return a copy of _self_ with _values_ arranged in random order.
+  #   {:one => 1, :two => 2, :three => 3}.shuffle_hash
+  #      #=> {:two=>2, :three=>1, :one=>3}
+  def shuffle_hash
+    shuffled = {}
+    shuffle_hash_pairs.each{|k, v|
+      shuffled[k] = v
+    }
+    shuffled
+  end
+
+  # Destructive shuffle_hash.  Arrange the values of _self_ in
+  # new, random order.
+  #   h = {:one => 1, :two => 2, :three => 3}
+  #   h.shuffle_hash!
+  #   h  #=> {:two=>2, :three=>1, :one=>3}
+  def shuffle_hash!
+    shuffle_hash_pairs.each{|k, v|
+      self[k] = v
+    }
+    self
+  end
+end
+
+
+class String
+  # Return the string with characters arranged in random order.
+  #   "Ruby rules".shuffle_chars  #=> "e lybRsuur"
+  def shuffle_chars
+    split(//).shuffle.join('')
+  end
+
+  # Destructive shuffle_chars.  Arrange the characters of the string
+  # in new, random order.
+  #   s = "Ruby rules".shuffle_chars
+  #   s.shuffle_chars!
+  #   s    #=> "e lybRsuur"
+  def shuffle_chars!
+    self[0,size] = shuffle_chars
+  end
+
+  # Return a random byte of _self_.
+  #   "Ruby rules".pick_byte  #=> 121
+  def pick_byte
+    self[pick_index]
+  end
+
+  # Return a single-character string of a random character in _self_.
+  #   "Ruby rules".pick_char  #=> "y"
+  def pick_char
+    pick_byte.chr
+  end
+
+  # Destructive pick_char.  Delete a random character of the string
+  # and return it as a single-character string.
+  #   s = "Ruby rules"
+  #   s.pick_char!  #=> "y"
+  #   s             #=> "Rub rules"
+  def pick_char!
+    i = pick_index
+    rv = self[i,1]
+    self[i,1] = ""
+    rv
+  end
+
+  # Destructive pick_byte.  Delete a random byte of _self_ and return it.
+  #   s = "Ruby rules"
+  #   s.pick_byte!  #=> 121
+  #   s             #=> "Rub rules"
+  def pick_byte!
+    pick_char![0]
+  end
+
+  # Return a random byte index of _self_.
+  #   "Ruby rules".pick_index  #=> 3
+  def pick_index
+    rand(size)
+  end
+
+  # Destructive pick_index.  Delete a random byte of _self_ and
+  # return it's index.
+  #   s = "Ruby rules"
+  #   s.pick_index  #=> 3
+  #   s             #=> "Rub rules"
+  def pick_index!
+    i = pick_index
+    self[i,1] = ""
+    i
+  end
+end
+
+
+if __FILE__ == $0
+
+require 'test/unit'
+
+module RandTestHelpers          # :nodoc:
+  def picker(enum, enum_check, method, n=50)
+    (1..n).all?{ enum_check.include? enum.send(method) }
+  end
+
+  def try_shuffling(enum, enum_c, method)
+    rv = nil
+    10.times{
+     rv = enum.send method
+     break if rv != enum_c
+    }
+    rv
+  end
+end
+
+
+class RandArrayTest < Test::Unit::TestCase  # :nodoc:
+  include RandTestHelpers
+
+  def ar
+    (0..99).to_a
+  end
+
+  def test_pick
+    a = ar
+    results = (0...a.size).map{ a.pick }
+    assert true, results.all? {|r| a.include? r }
+  end
+
+  def test_pick!
+    a = ar
+    results = (0...a.size).map{ a.pick! }
+    assert true, results.sort == (0..99).to_a and a.empty?
+  end
+
+  def test_pick_index
+    a = ar
+    results = (0...a.size).map{ a.pick_index }
+    assert true, results.all? {|r| r.between?(0, a.size-1) }
+  end
+
+  def test_pick_index!
+    a = ar
+    # side-effect-relying block; a.size = a.size-1 after pick_index!,
+    # so the picked index max value is the new a.size
+    assert true, (0...a.size).all?{ a.pick_index!.between?(0, a.size) } and a.empty?
+  end
+
+  def test_shuffle
+    a = ar
+    shuffled = try_shuffling(a, a, :shuffle)
+    assert true, shuffled.sort == a and shuffled != a
+  end
+
+  def test_shuffle!
+    a = ar
+    try_shuffling(a, ar, :shuffle!)
+    assert true, a != ar and a.sort == ar
+  end
+end
+
+
+class RandHashTest < Test::Unit::TestCase  # :nodoc:
+  include RandTestHelpers
+
+  def ha
+    Hash[*(1..100).to_a]
+  end
+
+  def test_pick
+    assert true, picker(ha, ha.entries, :pick)
+  end
+
+  def test_pick!
+    h = ha
+    assert true, picker(h, ha.entries, :pick!) and h.empty? 
+  end
+
+  def test_pick_key
+    assert true, picker(ha, ha.keys, :pick_key)
+  end
+
+  def test_pick_key!
+    h = ha
+    assert true, picker(h, ha.keys, :pick_key!) and h.empty?
+  end
+
+  def test_pick_value
+    assert true, picker(ha, ha.values, :pick_value)
+  end
+
+  def test_pick_value!
+    h = ha
+    assert true, picker(h, ha.values, :pick_value!) and h.empty?
+  end
+
+  def test_shuffle_hash
+    h = ha
+    hs = try_shuffling(ha, h, :shuffle_hash)
+    assert true, hs != h and (hs.keys + hs.values).sort == (h.keys + h.values).sort
+  end
+
+  def test_shuffle_hash!
+    h = ha
+    hs = ha
+    try_shuffling(hs, h, :shuffle_hash!)
+    assert true, hs != h and (hs.keys + hs.values).sort == (h.keys + h.values).sort
+  end
+
+  def test_shuffle
+    h = ha
+    hs = try_shuffling(ha, h, :shuffle)
+    assert true, hs != h and hs.entries.sort == h.entries.sort
+  end
+end
+
+
+class RandStringTest < Test::Unit::TestCase  # :nodoc:
+  include RandTestHelpers
+
+  def self.pick_tests(endings)
+    endings.each{|ending, compare_str_f|
+      define_method("test_pick#{ending}"){
+        s = str
+        assert true, picker(s, instance_eval(&compare_str_f), "pick#{ending}", s.size)
+      }
+    }
+  end
+
+  def self.pick_tests!(endings)
+    endings.each{|ending, compare_str_f|
+      define_method("test_pick#{ending}!"){
+        s = str
+        assert true, picker(s, instance_eval(&compare_str_f), "pick#{ending}!", s.size) and s.empty?
+      }
+    }
+  end
+
+  def str
+    (("a".."z").to_s + "\n") * 10
+  end
+
+  def test_shuffle
+    s = str
+    ss = try_shuffling(s, s.to_a, :shuffle)
+    assert true, ss != s.to_a and ss.sort == s.to_a.sort
+  end
+
+  def test_shuffle_chars
+    s = str
+    ss = try_shuffling(s, s.split(//), :shuffle_chars)
+    assert true, ss != s and ss.split(//).sort == s.split(//).sort
+  end
+
+  def test_shuffle_chars!
+    s = str
+    ss = str
+    try_shuffling(ss, s.split(//), :shuffle_chars!)
+    assert true, ss != s and ss.split(//).sort == s.split(//).sort
+  end
+
+  pick_tests({ ""      => lambda{str.to_a}, 
+               :_char  => lambda{str.split(//)}, 
+               :_byte  => lambda{str.split(//).map{|c| c[0]}}, 
+               :_index => lambda{(0...str.size).to_a}
+             })
+
+  pick_tests!({ :_char  => lambda{str.split(//)}, 
+                :_byte  => lambda{str.split(//).map{|c| c[0]}}, 
+                :_index => lambda{(0...str.size).to_a}
+              })
+end
+
+
+end #if