facets 1.3.3 → 1.4.0

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

@@ -2,6 +2,11 @@
 class MatchData
 
   # Returns [ pre_match, matchtree, post_match ]. (see matchtree)
+  #
+  #   md = /(bb)(cc(dd))(ee)/.match "XXaabbccddeeffXX"
+  #   md.to_a      #=> ["XXaabbccddeeffXX", "bb", "ccdd", "dd", "ee"]
+  #   md.matchset  #=> ["XXaa", [["bb"], ["cc", ["dd"]], "ee"], "ffXX"]
+  #
   def matchset
      [pre_match, matchtree, post_match]
   end
@@ -10,8 +15,8 @@ class MatchData
   # order corresponding with the regular expression.
   #
   #   md = /(bb)(cc(dd))(ee)/.match "XXaabbccddeeffXX"
-  #   md.to_a      #=> ["XXaabbccddeeffXX", "bb", "ccdd", "dd", "ee"]
-  #   md.matches  #=> ["XXaa", [["bb"], ["cc", ["dd"]], "ee"], "ffXX"]
+  #   md.to_a       #=> ["XXaabbccddeeffXX", "bb", "ccdd", "dd", "ee"]
+  #   md.matchtree  #=> [["bb"], ["cc", ["dd"]], "ee"]
   #
   def matchtree(index=0)
     ret=[]
@@ -47,11 +52,16 @@ end
 
   class TC_MatchData < Test::Unit::TestCase
 
-    def test_matchtree
+    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 )

data/lib/facets/core/module/class.rb

@@ -0,0 +1,3 @@
+class Module
+  alias_method :class?, :===
+end

data/lib/facets/core/module/integrate.rb

@@ -1,18 +1,45 @@
 
+#require 'facet/module/revisal'
+
 require 'facet/module/rename'
 require 'facet/module/redef'
 require 'facet/module/remove'
-require 'facet/module/undef'
+require 'facet/module/nodef'
 require 'facet/module/wrap'
 
-#require 'facet/module/revisal'
+# Using integrate is just like using include except the
+# module included is a reconstruction of the one give
+# via commands given in a block.
+#
+# Convenient commands available are: #rename, #redef,
+# #remove, #nodef and #wrap. But any module method
+# can be used.
+#
+#   module W
+#     def q ; "q" ; end
+#     def y ; "y" ; end
+#   end
+#
+#   class X
+#     integrate W do
+#       nodef :y
+#     end
+#   end
+#
+#   x = X.new
+#   x.q  #=> "q"
+#   x.y  #=> missing method error
+#
+# This is like #revisal, but #revisal only
+# returns the reconstructred module. It does not
+# include it.
 
 class Module
 
-  def integrate( mod, &blk )
+  def integrate( mod, &block )
     #include mod.revisal( &blk )
     m = Module.new { include mod }
-    m.class_eval &blk
+    m.class_eval &block
     include m
   end
 

data/lib/facets/core/module/{undef.rb → nodef.rb}

@@ -1,6 +1,11 @@
+
 class Module
+
   private
-  alias_method :undef, :undef_method
+
+  # Alias for undef_method.
+  alias_method :nodef, :undef_method
+
 end
 
 
@@ -18,9 +23,9 @@ end
 
     def the_undefined_method ; 'not here' ; end
 
-    undef :the_undefined_method
+    nodef :the_undefined_method
 
-    def test_undef
+    def test_nodef
       assert( ! respond_to?( :the_undefined_method ) )
     end
 

data/lib/facets/core/module/revisal.rb

@@ -1,9 +1,9 @@
 
-require 'facet/module/rename'
-require 'facet/module/redef'
-require 'facet/module/remove'
-require 'facet/module/undef'
-require 'facet/module/wrap'
+require 'facets/core/module/rename'
+require 'facets/core/module/redef'
+require 'facets/core/module/remove'
+require 'facets/core/module/nodef'
+require 'facets/core/module/wrap'
 
 class Module
 

data/lib/facets/more/annattr.rb

@@ -0,0 +1,147 @@
+# = annattr.rb
+#
+# == Copyright (c) 2005 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 & Contributors
+#
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2005 Thomas Sawyer
+# License::   Ruby License
+
+require 'facets/more/annotation.rb'
+
+# = Annotated Attributes
+#
+# This framework modifies the attr_* methods to allow easy addition of annotations.
+# It the built in attribute methods (attr, attr_reader, attr_writer and attr_accessor),
+# to allow annotations to added to them directly rather than requireing a separate
+# #ann statement.
+#
+#   class X
+#     attr :a, :valid => lambda{ |x| x.is_a?(Integer) }
+#   end
+#
+# See annotation.rb for more information.
+#
+# NOTE This library was designed to be backward compatible with the
+# standard versions of the same methods.
+
+class ::Module
+
+  inheritor :attributes, [], :|
+
+  def attr( *args )
+    args.flatten!
+    case args.last
+    when TrueClass
+      args.pop
+      attr_accessor( *args )
+    when FalseClass
+      args.pop
+      attr_reader( *args )
+    else
+      attr_reader( *args )
+    end
+  end
+
+  code = ''
+  [ :_reader, :_writer, :_accessor].each do |m|
+
+    d = case m
+    when :_reader
+      %{def %1$s; @%1$s; end}
+    when :_writer
+      %{def %1$s=(x); @%1$s = x; end}
+    when :_accessor
+      %{def %1$s; @%1$s; end ; def %1$s=(x); @%1$s = x; end}
+    else
+      %{def %1$s; @%1$s; end}
+    end
+
+    code << %{
+      def attr#{m}(*args)
+        args.flatten!
+
+        harg = {}
+        while args.last.is_a?(Hash) ; harg.update(args.pop) ; end
+
+        harg[:class] = args.pop if args.last.is_a?(Class)
+
+        raise if args.empty? and harg.empty?
+
+        if args.empty?
+          harg.each { |a,h|
+            module_eval( "#{d}" % a)
+            a = a.to_sym
+            define_annotation( a, h )
+          }
+          attributes!.merge!( harg.keys )
+          # return the names of the attributes created
+          return harg.keys
+        else
+          args.each { |a|
+            module_eval( "#{d}" % a)
+            a = a.to_sym
+            define_annotation( a, harg )
+          }
+          attributes!.merge!( args )
+          # return the names of the attributes created
+          return args
+        end
+      end
+    }
+
+  end
+
+  class_eval( code )
+
+  alias_method :attribute, :attr_accessor
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin testing
+
+  require 'test/unit'
+
+  class TC01 < Test::Unit::TestCase
+    class A
+      attr_accessor :x, :cast=>"to_s"
+    end
+
+    def test_09_001
+      a = A.new
+      assert_equal( [:x], A.attributes )
+    end
+  end
+
+  class TC10 < Test::Unit::TestCase
+    class A
+      attr :x, :cast=>"to_s"
+    end
+
+    def test_10_001
+      assert_equal( "to_s", A.ann.x.cast )
+    end
+  end
+
+=end

data/lib/facets/more/annotation.rb

@@ -1,31 +1,44 @@
-#--
-# Annotation
+# = annotation.rb
 #
-# Copyright (c) 2005 Thmas Sawyer
+# == Copyright (c) 2005 Thomas Sawyer
 #
-# Ruby License
+#   Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   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.
+#   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.
 #
-#================================================================================
-# ChangeLog
-#================================================================================
-# 05.10.25  trans  Initial release.
-#================================================================================
-#++
-
-#:title: Annotations
+# == Authors & Contributors
+#
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2005 Thomas Sawyer
+# License::   Ruby License
+
+require 'facets/core/array/merge'
+
+require 'facets/more/openobject'
+require 'facets/more/inheritor'
+require 'facets/more/nullclass'
+
+# = Annotation
 #
 # Annotations allows you to annontate objects, including methods with arbitrary
-# "metadata". These annotations don't do anything in themselves. They are 
-# merely comments. But you can put them to use. For instance an attribute 
+# "metadata". These annotations don't do anything in themselves. They are
+# merely comments. But you can put them to use. For instance an attribute
 # validator might check for an annotation called :valid and test against it.
 #
+# Annotation is an OpenObject, and is used across the board for keeping annotations.
+#
+# Annotation class serves for both simple and inherited cases depending on whether
+# a base class is given.
+#
+# == Synopsis
+#
 #   class X
 #     attr :a
 #     ann :@a, :valid => lambda{ |x| x.is_a?(Integer) }
@@ -43,24 +56,7 @@
 #
 #   end
 #
-# == Author(s)
-#
-# * Thomas Sawyer
-#
-
-require 'facets/core/array/merge'
-
-require 'facets/more/openobject'
-require 'facets/more/inheritor'
-require 'facets/more/nullclass'
 
-# Annotation is an OpenObject, and is used across the
-# board for keeping annotations.
-#
-# Annotation class serves for both simple and
-# and inherited cases depending on whether
-# a base class is given.
-#
 class Annotation < OpenObject
 
   def initialize( set={} )
@@ -122,7 +118,6 @@ class Annotation < OpenObject
 
 end
 
-
 # This is a simple decorator for accessing a module's
 # method annotations (and it's own annotations).
 
@@ -150,7 +145,6 @@ class Annotator < BasicObject  #:nodoc:
   end
 end
 
-
 # Any object can be annotated.
 
 module ::Kernel
@@ -173,7 +167,6 @@ module ::Kernel
   #++
 end
 
-
 # Modules and Classes have more sifisticated annotation.
 # They differ from normal object annotation in that
 # the are inheritables.
@@ -290,82 +283,6 @@ class ::Module
 end #class ::Module
 
 
-# attr on steroids! Override the default implementations
-# to support annotations.
-
-class ::Module
-
-  inheritor :attributes, [], :|
-
-  def attr( *args )
-    args.flatten!
-    case args.last
-    when TrueClass
-      args.pop
-      attr_accessor( *args )
-    when FalseClass
-      args.pop
-      attr_reader( *args )
-    else
-      attr_reader( *args )
-    end
-  end
-
-  code = ''
-  [ :_reader, :_writer, :_accessor].each do |m|
-
-    d = case m
-    when :_reader
-      %{def %1$s; @%1$s; end}
-    when :_writer
-      %{def %1$s=(x); @%1$s = x; end}
-    when :_accessor
-      %{def %1$s; @%1$s; end ; def %1$s=(x); @%1$s = x; end}
-    else
-      %{def %1$s; @%1$s; end}
-    end
-
-    code << %{
-      def attr#{m}(*args)
-        args.flatten!
-
-        harg = {}
-        while args.last.is_a?(Hash) ; harg.update(args.pop) ; end
-
-        harg[:class] = args.pop if args.last.is_a?(Class)
-
-        raise if args.empty? and harg.empty?
-
-        if args.empty?
-          harg.each { |a,h|
-            module_eval( "#{d}" % a)
-            a = a.to_sym
-            define_annotation( a, h )
-          }
-          attributes!.merge!( harg.keys )
-          # return the names of the attributes created
-          return harg.keys
-        else
-          args.each { |a|
-            module_eval( "#{d}" % a)
-            a = a.to_sym
-            define_annotation( a, harg )
-          }
-          attributes!.merge!( args )
-          # return the names of the attributes created
-          return args
-        end
-      end
-    }
-
-  end
-
-  class_eval( code )
-
-  alias_method :attribute, :attr_accessor
-
-end
-
 
 #  _____         _
 # |_   _|__  ___| |_
@@ -556,25 +473,4 @@ end
     end
   end
 
-  class TC09 < Test::Unit::TestCase
-    class A
-      attr_accessor :x, :cast=>"to_s"
-    end
-
-    def test_09_001
-      a = A.new
-      assert_equal( [:x], A.attributes )
-    end
-  end
-
-  class TC10 < Test::Unit::TestCase
-    class A
-      attr :x, :cast=>"to_s"
-    end
-
-    def test_10_001
-      assert_equal( "to_s", A.ann.x.cast )
-    end
-  end
-
 =end