facets 2.1.3 → 2.2.0

data/lib/core/facets/proc/bind.rb

@@ -1,22 +1,14 @@
-# TITLE:
-#   Proc Bind
-#
-# LOG:
-#   - 2006-12-27 (trans) Deprecated use of TemporaryMethods module
-
-#
 class Proc
 
-  # Bind a proc to an object. Returns a Method.
+  # Bind a Proc to an object returning a Method.
   #
   # The block's #to_s method (same as #inspect) is
   # used for the temporary method label defined in
   # the Object class.
   #
-  # Note this dynamically loads thread.so if used.
-  #--
-  # But I'm not so sure it is thread critical anymore.
-  #++
+  #   NOTE: This dynamically loads thread.so if used.
+  #   NOTE: Not so sure it is thread critical anymore.
+
   def bind(object=nil)
     require 'thread'
 
@@ -39,11 +31,22 @@ class Proc
       end
       Thread.critical = old
     end
+
     return meth
   end
 
   # Convert Proc to method.
   #
+  #   Class X; end
+  #
+  #   plusproc = lambda { |x| x + 1 }
+  #   plusproc.to_method('foo', X)
+  #   X.new.foo(1)  #=> 2
+  #
+  #   TODO: Should use singleton instead of object.class ?
+  #
+  #   CREDIT: Trans
+
   def to_method(name=nil, object=nil)
     return bind unless name
 
@@ -57,51 +60,5 @@ class Proc
 
     object.method(name)
   end
-end
-
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestProc < Test::Unit::TestCase
-
-    def test_to_method
-      a = 2
-      tproc = proc { |x| x + a }
-      tmethod = tproc.to_method(:tryit)
-      assert_equal( 3, tmethod.call(1) )
-      assert_respond_to( self, :tryit )
-      assert_equal( 3, tryit(1) )
-    end
-
-    def test_memory_leak
-      a = 2
-      tproc = lambda { |x| x + a }
-      100.times {
-        tmethod = tproc.to_method
-        assert_equal( 3, tmethod.call(1) )
-      }
-      meths = (
-        Object.instance_methods +
-        Object.public_instance_methods +
-        Object.private_instance_methods +
-        Object.protected_instance_methods
-      )
-      meths = meths.select{ |s| s.to_s =~ /^_bind_/ }
-      #meths = Symbol.all_symbols.select { |s| s.to_s =~ /^_bind_/ } # why ?
-      assert_equal( 0, meths.size )
-    end
-
-  end
-
-=end
 
+end

data/lib/core/facets/proc/compose.rb

@@ -9,7 +9,7 @@ class Proc
   #   a.compose(b).call(4)  #=> 6
   #   b.compose(a).call(4)  #=> 4
   #
-  # CREDIT Dave
+  #   CREDIT: Dave
 
   def compose(g)
     raise ArgumentError, "arity count mismatch" unless arity == g.arity
@@ -24,12 +24,14 @@ class Proc
   #   (a * b).call(4)  #=> 6
   #   (b * a).call(4)  #=> 4
   #
-  # CREDIT Dave
+  #   CREDIT: Dave
 
   def *(x)
     if Integer===x
       # collect times
-      a = []; x.times{|i| a << call(i)}; a
+      c = []
+      x.times{|i| c << call(i)}
+      c
     else
       # compose procs
       lambda{|*a| self[x[*a]]}
@@ -38,44 +40,8 @@ class Proc
 
   # Use a Proc as an observable.
   #
-  # CREDIT Tim Pease
+  #   CREDIT: Tim Pease
 
   alias_method :update, :call
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestProc < Test::Unit::TestCase
-
-    def test_compose_op
-      a = lambda { |x| x + 4 }
-      b = lambda { |y| y / 2 }
-      assert_equal( 6, (a * b).call(4) )
-      assert_equal( 4, (b * a).call(4) )
-    end
-
-    def test_times_collect_op
-      a = lambda { |x| x + 4 }
-      assert_equal( [4,5,6], a * 3 )
-    end
-
-    def test_compose
-      a = lambda { |x| x + 4 }
-      b = lambda { |y| y / 2 }
-      assert_equal( 6, (a.compose(b)).call(4) )
-      assert_equal( 4, (b.compose(a)).call(4) )
-    end
-
-  end
-
-=end

data/lib/core/facets/proc/fn.rb

@@ -5,6 +5,8 @@ module Kernel
   #   adder = fn { |x,y| x + y }
   #   adder[1,2]  #=> 3
   #
+  #   CREDIT: Trans
+
   alias_method :fn, :lambda
 
 end

data/lib/core/facets/range/combine.rb

@@ -1,24 +1,11 @@
-# = FILE
-#
-#   combine.rb
-#
-# = DESCRIPTION
-#
-#   Range extensions for combination.
-#
-# = AUTHORS
-#
-#   CREDIT Daniel Schierbeck
-#   CREDIT Brandon Keepers
-#
-# = NOTES
-#
-#   TODO Incorporate end sentinal inclusion vs. exclusion in #combine.
-
-#
 class Range
 
   # Combine intervals.
+  #
+  #   Range.combine(1..2, 2..4)   #=> [1..4]
+  #   Range.combine(1..2, 3..4)   #=> [1..2, 3..4]
+  #
+  #   CREDIT: Trans
 
   def self.combine(*intervals)
     intype = intervals.first.class
@@ -28,13 +15,13 @@ class Range
       [i.first, i.last]
     end
 
-    intervals.sort.inject([]) do |result, (from, to)|
+    intervals.sort.each do |(from, to)|  #inject([]) do |result,
       if result.empty? or from > result.last[1]
         result << [from, to]
       elsif to > result.last[1]
         result.last[1] = to
       end
-      result
+      #result
     end
 
     if intype <= Range
@@ -44,40 +31,17 @@ class Range
     end
   end
 
-  # Combine intervals.
+  # Combine ranges.
+  #
+  #   (1..2).combine(2..4)   #=> [1..4]
+  #   (1..2).combine(3..4)   #=> [1..2, 3..4]
+  #
+  #   TODO: Incorporate end-sentinal inclusion vs. exclusion.
+  #
+  #   CREDIT: Trans
 
   def combine(*intervals)
     Range.combine(self, *intervals)
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestRangeCombine < Test::Unit::TestCase
-
-    def test_combine_ranges
-      r = Range.combine(0..4, 2..6, 6..10, 13..17, 12..19)
-      x = [0..10, 12..19]
-      assert_equal(x, r)
-    end
-
-    def test_combine_arrays_as_intervals
-      r = Range.combine([0, 4], [2, 6], [6, 10], [13, 17], [12, 19])
-      x = [[0, 10], [12, 19]]
-      assert_equal(x, r)
-    end
-
-  end
-
-=end

data/lib/core/facets/range/overlap.rb

@@ -1,20 +1,9 @@
-# = FILE
-#
-#   overlap.rb
-#
-# = DESCRIPTION
-#
-#   Range extensions for overlap comparison.
-#
-# = AUTHORS
-#
-#   CREDIT Daniel Schierbeck
-#   CREDIT Brandon Keepers
-
-#
 class Range
 
   # Do two ranges overlap?
+  #
+  #   CREDIT: Daniel Schierbeck
+  #   CREDIT: Brandon Keepers
 
   def overlap?(other)
     include?(other.first) or other.include?(first)
@@ -48,6 +37,9 @@ class Range
   #
   #   (0..3).umbrella(1..2)  #=>  [-1,-1]
   #
+  #   CREDIT: Trans
+  #   CREDIT: Chris Kappler
+
   def umbrella(r)
     s = first <=> r.first
     e = r.last <=> last
@@ -68,6 +60,8 @@ class Range
   #
   #   (1..3).within?(0..4)  #=> true
   #
+  #   CREDIT: Trans
+
   def within?(rng)
     case rng.umbrella(self)
     when [0,0], [-1,0], [0,-1], [-1,-1]
@@ -78,53 +72,3 @@ class Range
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestRangeOverlap < Test::Unit::TestCase
-
-    def test_umbrella_aligned
-      assert_equal( [0,0], (3..6).umbrella(3..6) )
-      assert_equal( [0,0], (3...6).umbrella(3...6) )
-    end
-
-    def test_umbrella_partial_aligned
-      assert_equal( [1,0], (3..6).umbrella(2..6) )
-      assert_equal( [0,1], (3..6).umbrella(3..7) )
-      assert_equal( [-1,0], (3..6).umbrella(4..6) )
-      assert_equal( [0,-1], (3..6).umbrella(3..5) )
-    end
-
-    def test_umbrella_offset
-      assert_equal( [1,1], (3..6).umbrella(2..7) )
-      assert_equal( [-1,1], (3..6).umbrella(4..7) )
-      assert_equal( [1,-1], (3..6).umbrella(2..5) )
-      assert_equal( [-1,-1], (3..6).umbrella(4..5) )
-    end
-
-    def test_umbrella_offset_by_exclusion
-$xx = true
-      assert_equal( [0,1], (10...20).umbrella(10..20) )
-$xx = false
-    end
-
-    def test_within?
-      assert( (4..5).within?(3..6) )
-      assert( (3..6).within?(3..6) )
-      assert(! (2..5).within?(3..6) )
-      assert(! (5..7).within?(3..6) )
-    end
-
-  end
-
-=end

data/lib/core/facets/regexp/arity.rb

@@ -1,52 +1,17 @@
-# TITLE:
-#   Regexp Arity
-#
-# DESCRIPTION:
-#   Matchdata methods to produces a hierachical list of a match result.
-#   This also includes Regexp#arity.
-#
-# AUTHORS:
-#   - Thomas Sawyer
-
-#
 class Regexp
+
   # Returns the number of backreferencing subexpressions.
   #
   #   /(a)(b)(c)/.arity  #=> 3
   #   /(a(b(c)))/.arity  #=> 3
   #
-  # Note: This is not perfect, especially with regards to \x
+  # Note that this is not perfect, especially with regards to \x
   # and embedded comments.
+  #
+  #   CREDIT: Trans
 
   def arity
-    self.source.scan( /(?!\\)[(](?!\?[#=:!>-imx])/ ).length
-  end
-end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestRegexpArity < Test::Unit::TestCase
-
-    def test_arity
-      r = /(1)(2)(3)/
-      assert_equal( 3, r.arity )
-      r = /(1)(2)(3)(4)/
-      assert_equal( 4, r.arity )
-      r = /(1)(2)((a)3)/
-      assert_equal( 4, r.arity )
-      r = /(?#nothing)(1)(2)(3)(?=3)/
-      assert_equal( 3, r.arity )
-    end
-
+    source.scan( /(?!\\)[(](?!\?[#=:!>-imx])/ ).length
   end
 
-=end
+end

data/lib/core/facets/stackable.rb

@@ -1,27 +1,58 @@
-# TITLE:
+# = TITLE:
+#
 #   Stackable
 #
-# DESCRIPTION:
-#   Stackable mixin.
+# = DESCRIPTION:
+#
+#   Stackable mixin provides #pop, #push, #pull, etc.
+#   It depends on #slice, #splice and #insert.
+#
+# = COPYRIGHT:
+#
+#   Copyright (c) 2007 Thomas Sawyer
+#
+#   Ruby License
+#
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
+#
+# = AUTHORS:
+#
+#   - Thomas Sawyer
 
 # Stackable mixin provides #pop, #push, #pull, etc.
 # It depends on #slice, #splice and #insert.
 
 module Stackable
 
+  # Pop item off stack.
   #
+  #   a = [1, 2, 3]
+  #   a.pop           #=> 3
+  #   a               #=> [1, 2]
 
   def pop
     splice(-1)
   end
 
+  # Push item onto the stack.
   #
+  #   a = [1, 2]
+  #   a.push(3)       #=> [1, 2, 3]
 
   def push(x)
     insert(-1,x)
   end
 
+  # Pull item off the stack.
   #
+  #   a = [1, 2, 3]
+  #   a.pull          #=> 1
+  #   a               #=> [2, 3]
 
   def pull
     slice(0)
@@ -29,7 +60,12 @@ module Stackable
 
   alias_method :shift, :pull
 
+  # Poke item onto the stack.
   #
+  #   a = [2, 3]
+  #   a.poke(1)       #=> [1, 2, 3]
+  #
+  #   TODO: Better name (besides unshift)?
 
   def poke(x)
     insert(0,x)
@@ -37,11 +73,14 @@ module Stackable
 
   alias_method :unshift, :poke
 
+  # Peek at the top of the stack.
   #
+  #   a = [1, 2, 3]
+  #   a.peek          #=> 3
+  #   a               #=> [1, 2, 3]
 
   def peek
     splice(-1)
   end
 
 end
-