facets 2.1.3 → 2.2.0

data/lib/core/facets/kernel/super.rb

@@ -1,30 +1,25 @@
-# TITLE:
-#
+# = TITLE:
 #   Super/As Extensions
 #
-# DESCRIPTION:
-#
+# = DESCRIPTION:
 #   Extensions for calling ancestor methods.
 #
-# AUTHORS:
-#
+# = AUTHORS:
 #   CREDIT Thomas Sawyer
 #
-# CHANGES:
-#
-#   - LOG  2006-11-04  trans@gmail.com  Use own delegator instead of Functor.
-#   - LOG  2006-11-04  trans@gmail.com  Now #as can take a block.
+# = LOG:
+#   - 2006-11-04  trans@gmail.com  Use own delegator instead of Functor.
+#   - 2006-11-04  trans@gmail.com  Now #as can take a block.
 #
-# TODOs:
+# = TODO:
 #
-#   - TODO Probably get rid of __self__ or get a new name.
+#   - Probably get rid of __self__ or get a new name.
 #     It is similar to #meta + #as, but just for Object/Kernel.
 #
-#   - TODO Deprecatee either #super_method or #supermethod.
+#   - Deprecatee either #super_method or #supermethod.
 
 require 'facets/functor'
 
-#
 module Kernel
 
   # Returns a Functor that allows one to call any
@@ -42,6 +37,7 @@ module Kernel
   #
   # NOTE: This has been through a couple of renamings,
   # including #__object__, #__self__, and #self.
+
   def __real__
     @__real__ ||= Functor.new do |meth, *args|  # &blk|
       Object.instance_method(meth).bind(self).call(*args) # ,&blk)
@@ -76,6 +72,7 @@ module Kernel
   end
 
   # Call parent class/module methods once bound to self.
+
   def send_as(ancestor, sym, *args, &blk)
     ancestor.instance_method(sym).bind(self).call(*args,&blk)
   end
@@ -148,7 +145,7 @@ end
 
 class As #:nodoc:
   # Privatize all methods except #binding an operators.
-  private *instance_methods.select { |m| m !~ /(^__|^\W|^binding$)/ }
+  private(*instance_methods.select { |m| m !~ /(^__|^\W|^binding$)/ })
 
   def initialize(subject, ancestor)
     @subject = subject
@@ -159,64 +156,3 @@ class As #:nodoc:
     @ancestor.instance_method(sym).bind(@subject).call(*args,&blk)
   end
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestKernelSuper < Test::Unit::TestCase
-
-    class X ; def x ; 1 ; end ; end
-    class Y < X ; def x ; 2 ; end ; end
-    class Z < Y ; def x ; superior(X) ; end ; end
-
-    def test_superior
-      z = Z.new
-      assert_equal( 1, z.x )
-    end
-
-    class X2 ; def x ; 1 ; end ; end
-    class Y2 < X2 ; def x ; 2 ; end ; end
-    class Z2 < Y2 ; def x ; 3 ; end ; end
-
-    def test_super_method
-      x = X2.new
-      z = Z2.new
-      s0 = x.method( :x )
-      s1 = z.super_method( X2, :x )
-      assert_equal( s0.call, s1.call )
-    end
-
-    class A
-      def x; "A.x"; end
-      def y; "A.y"; end
-    end
-    class B < A
-      def x; "B.x" end
-      def y; "B.y" end
-    end
-    class C < B
-      def x; "C.x"; end
-      def y; as(B).x ; end
-    end
-
-    def test_as
-      c = C.new
-      assert_equal("B.x", c.y)
-      assert_equal("C.x", c.x)
-    end
-
-    def test_send_as
-      assert_equal( String, "A".send_as(Object, :class) )
-    end
-
-  end
-
-=end

data/lib/core/facets/kernel/tap.rb

@@ -1,116 +1,34 @@
-# TITLE:
-#
-#   K-Combinators, Tap and Returning
-#
-# SUMMARY:
-#
-#   Veriations on K-Combinator, namely #tap and
-#   #returning, and returning's alias #with.
-#
-# AUTHORS:
-#
-#   - Mikael Brockman
-#    -Thomas Sawyer
+# DEPRECATE for 1.9.
+unless (RUBY_VERSION[0,3] == '1.9')
 
-#
-module Kernel
+  module Kernel
 
-  # Yield self -and- return self.
+    # The tap K-Combinator. This yields self -and- returns self.
+    #
+    #   CREDIT: ?
 
-  def tap(&b)
-    if block_given?
-      b.arity == 1 ? yield(self) : instance_eval(&b)
-    end
-    self
-  end
-
-#   require 'facets/functor'
-#
-#   # Yield self -and- return self.
-#
-#   def tap(&b)
-#     if block_given?
-#       b.arity == 1 ? yield(self) : instance_eval(&b)
-#       self
-#     else
-#       Functor.new{ |op, *args| self.send(op, *args); self }
-#     end
-#   end
-
-  # A Ruby-ized realization of the K combinator.
-  #
-  #   returning Book.new do |book|
-  #     book.title = "Imperium"
-  #     book.author = "Ulick Varange"
-  #   end
-  #
-  # Also aliased as #with.
-  #
-  #   def foo
-  #     with values = [] do
-  #       values << 'bar'
-  #       values << 'baz'
-  #     end
-  #   end
-  #
-  #   foo # => ['bar', 'baz']
-  #
-  # Technically, #returning probably should force the return of
-  # the stated object irregardless of any return statements that
-  # might appear within it's block. This might differentiate
-  # #returning from #with, however it also would require
-  # implementation in Ruby itself.
-
-  def returning(obj=self)
-    yield obj
-    obj
-  end
-
-  alias :with :returning
-
-  # Repeat loop until it yeilds false or nil.
-
-  def complete
-    loop { break unless yield }
-  end
-
-end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TCKernel < Test::Unit::TestCase
-
-    def test_returning
-      foo = returning( values = [] ) do
-        values << 'bar'
-        values << 'baz'
+    def tap(&b)
+      if block_given?
+        b.arity == 1 ? yield(self) : instance_eval(&b)
       end
-      assert_equal( ['bar', 'baz'], foo )
+      self
     end
 
-    def test_tap
-      x = "foo"
-      r = ("foobar".tap{ gsub! /bar/, '' })
-      assert_equal(x, r)
-    end
-
-    def test_tap_array
-      x = [1,2,3]
-      x.tap{ |a|
-        assert_equal(x, a)
-      }
-    end
+    # This is just an odd consideration for #tap using Functor:
+    #
+    #   require 'facets/functor'
+    #
+    #   # Yield self -and- return self.
+    #
+    #   def tap(&b)
+    #     if block_given?
+    #       b.arity == 1 ? yield(self) : instance_eval(&b)
+    #       self
+    #     else
+    #       Functor.new{ |op, *args| self.send(op, *args); self }
+    #     end
+    #   end
 
   end
 
-=end
+end

data/lib/core/facets/kernel/val.rb

@@ -4,6 +4,11 @@ module Kernel
   # is considered to have value if it is not nil?
   # and if it responds to #empty?, is not empty.
   #
+  #   nil.val?     #=> false
+  #   [].val?      #=> false
+  #   10.val?      #=> true
+  #   [nil].val?   #=> true
+
   def val?
     return false if nil?
     return false if empty? if respond_to?(:empty?)
@@ -15,14 +20,13 @@ module Kernel
   #   "hello".not_nil?     # -> true
   #   nil.not_nil?         # -> false
   #
-  #   CREDIT Gavin Sinclair
+  #   CREDIT: Gavin Sinclair
 
   def not_nil?
     not nil?
   end
 
-  # TODO Do not need two of these.
-  #alias_method :non_nil?, :not_nil?
+  alias_method :non_nil?, :not_nil?
 
   # Is self included in other?
   #
@@ -34,46 +38,3 @@ module Kernel
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestKernelVal < Test::Unit::TestCase
-
-    def test_val_1
-      f = nil
-      t = 1
-      assert( ! f.val? )
-      assert( t.val? )
-    end
-
-    def test_val_2
-      f = []
-      t = [1]
-      assert( ! f.val? )
-      assert( t.val? )
-    end
-
-    def test_val_3
-      f = ''
-      t = '1'
-      assert( ! f.val? )
-      assert( t.val? )
-    end
-
-    def test_in?
-      assert( 5.in?(0..10) )
-      assert( 5.in?([1,2,3,4,5]) )
-    end
-
-  end
-
-=end

data/lib/core/facets/kernel/withattr.rb

@@ -1,21 +1,3 @@
-# FILE:
-#
-#   kernel/with.rb
-#
-# DESCRIPTION:
-#
-#   With-accessors create singleton attributes.
-#
-# AUTHORS:
-#
-#   CREDIT THomas Sawyer
-#
-# NOTES:
-#
-#   TODO Consider the use cases of these, and at the very
-#        least find new names.
-
-#
 class Object
 
   # Takes a hash and creates (singleton) attr_readers for each key.
@@ -26,6 +8,8 @@ class Object
   #   self.x   #=> 1
   #   self.y   #=> 2
   #
+  #   CREDIT: Trans
+
   def with_reader(h)
     (class << self ; self ; end).send( :attr_reader, *h.keys )
     h.each { |k,v| instance_variable_set("@#{k}", v) }
@@ -41,6 +25,8 @@ class Object
   #   @x           #=> 3
   #   @y           #=> 4
   #
+  #   CREDIT: Trans
+
   def with_writer(h)
     (class << self ; self ; end).send( :attr_writer, *h.keys )
     h.each { |k,v| instance_variable_set("@#{k}", v) }
@@ -57,55 +43,11 @@ class Object
   #   self.x      #=> 3
   #   self.y      #=> 4
   #
+  #   CREDIT: Trans
+
   def with_accessor(h)
     (class << self ; self ; end).send( :attr_accessor, *h.keys )
     h.each { |k,v| instance_variable_set("@#{k}", v) }
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TCKernel < Test::Unit::TestCase
-    # fixture for #with_reader, #with_writer and #with_accessor
-    class TestWith
-      def initialize
-        with_reader :foo => "FOO"
-        with_writer :bar => "BAR"
-        with_accessor :baz => "BAZ"
-      end
-      def get_bar
-        @bar
-      end
-    end
-
-    def test_with_reader
-      assert_nothing_raised { @t = TestWith.new }
-      assert_equal("FOO", @t.foo)
-    end
-
-    def test_with_writer
-      assert_nothing_raised { @t = TestWith.new }
-      assert_equal("BAR", @t.get_bar)
-      @t.bar = "BAR2"
-      assert_equal("BAR2", @t.get_bar)
-    end
-
-    def test_with_accessor
-      assert_nothing_raised { @t = TestWith.new }
-      assert_equal("BAZ", @t.baz)
-      @t.baz = "BAZ2"
-      assert_equal("BAZ2", @t.baz)
-    end
-  end
-
-=end

data/lib/core/facets/matchdata/matchset.rb

@@ -1,23 +1,14 @@
-# TITLE:
-#   Matchset
-#
-# DESCRIPTION:
-#   Matchdata methods to produces a hierachical list of a match result.
-#   This also includes Regexp#arity.
-#
-# AUTHORS:
-#   - Thomas Sawyer
-
-#
 class MatchData
 
-  # TODO Is MatchData#match really worth having? It's kind of confusing w/ Regexp#match.
-
   # Return the primary match string. This is equivalent to +md[0]+.
   #
   #   md = /123/.match "123456"
   #   md.match  #=> "123"
   #
+  #   TODO: Is MatchData#match really worth having? It's kind of confusing w/ Regexp#match.
+  #
+  #   CREDIT: Trans
+
   def match
     self[0]
   end
@@ -28,6 +19,8 @@ class MatchData
   #   md.to_a      #=> ["XXaabbccddeeffXX", "bb", "ccdd", "dd", "ee"]
   #   md.matchset  #=> ["XXaa", [["bb"], ["cc", ["dd"]], "ee"], "ffXX"]
   #
+  #   CREDIT: Trans
+
   def matchset
      [pre_match, matchtree, post_match]
   end
@@ -39,6 +32,8 @@ class MatchData
   #   md.to_a       #=> ["XXaabbccddeeffXX", "bb", "ccdd", "dd", "ee"]
   #   md.matchtree  #=> [["bb"], ["cc", ["dd"]], "ee"]
   #
+  #  CREDIT: Trans
+
   def matchtree(index=0)
     ret=[]
     b, e=self.begin(index), self.end(index)
@@ -59,40 +54,3 @@ class MatchData
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestMatchData < Test::Unit::TestCase
-
-    def test_match
-      md = /X(a)(b)(c)X/.match("YXabcXY")
-      assert_equal( "XabcX", md.match )
-    end
-
-    def test_matchtree_01
-      md = /(bb)(cc(dd))(ee)/.match "XXaabbccddeeffXX"
-      assert_equal( [["bb"], ["cc", ["dd"]], ["ee"]] , md.matchtree )
-    end
-
-    def test_matchtree_02
-      md = /(bb)c(c(dd))(ee)/.match "XXaabbccddeeffXX"
-      assert_equal( [["bb"], "c", ["c", ["dd"]], ["ee"]] , md.matchtree )
-    end
-
-    def test_matchset
-      md = /(bb)(cc(dd))(ee)/.match "XXaabbccddeeffXX"
-      assert_equal( ["XXaa", [["bb"], ["cc", ["dd"]], ["ee"]], "ffXX"] , md.matchset )
-    end
-
-  end
-
-=end