facets 2.1.3 → 2.2.0

data/lib/core/facets/module.rb

@@ -7,5 +7,7 @@ require 'facets/module/traits.rb'
 require 'facets/module/modify.rb'
 require 'facets/module/alias.rb'
 require 'facets/module/attr.rb'
-require 'facets/module/require.rb'
 require 'facets/module/methods.rb'
+
+# remove for 1.9
+require 'facets/module/require.rb'

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

@@ -1,30 +1,17 @@
-# TITLE:
-#
-#   Abstract method.
-#
-# SUMMARY:
-#
-#   Create an abstrct method. If it is not overriden it will raise
-#   an exception when called.
-#
-# AUTHORS:
-#
-#   - Thomas Sawyer
-
-#
 class Module
 
-  # Creates a method that requires to be overridding.
-  # If it not overridden and called upon a TypeError
-  # will be raised.
+  # Create an abstract method. If it is not overridden, it will
+  # raise a TypeError when called.
   #
-  #  class C
-  #    abstract :a
-  #  end
+  #   class C
+  #     abstract :a
+  #   end
   #
-  #  c = C.new
-  #  c.a  #=> Error: undefined abstraction #a
+  #   c = C.new
+  #   c.a  #=> Error: undefined abstraction #a
   #
+  #   CREDIT: Trans
+
   def abstract( *sym )
     sym.each { |s|
       define_method( s ) { raise TypeError, "undefined abstraction ##{s}" }
@@ -32,28 +19,3 @@ class Module
   end
 
 end
-
-
-=begin test
-
-  require 'test/unit'
-
-  class TestAttrTester < Test::Unit::TestCase
-
-    class Aq
-      abstract :q
-    end
-
-    def test_abstract_01
-      ac = Aq.new
-      assert_raises( TypeError ) { ac.q }
-    end
-
-    def test_abstract_02
-      ac = Class.new { abstract :q }.new
-      assert_raises( TypeError ) { ac.q }
-    end
-
-  end
-
-=end

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

@@ -13,12 +13,6 @@
 # AUTHORS:
 #
 #   CREDIT Thomas Saywer
-#
-# LOG:
-#
-#   - 2007.10.31  trans
-#     Made #alias_method_chain compatible with current ActiveSupport version.
-
 class Module
 
   private
@@ -42,6 +36,7 @@ class Module
   end
 
   # As with alias_accessor, but just for the reader.
+  # This is basically the same as alias_method.
 
   def alias_reader(*args)
     orig = args.last
@@ -61,17 +56,18 @@ class Module
     end
   end
 
-  # Like module_funtion but makes the instance method
-  # public rather than private. This can not work
-  # as a sectional modifier however.
+  # Like module_function but makes the instance method
+  # public rather than private.
+  #
+  #   NOTE: This does not work as a sectional modifier.
 
-  def module_method *meth
-    module_function *meth
-    public *meth
+  def module_method(*meth)
+    module_function(*meth)
+    public(*meth)
   end
 
   # Alias a module function so that the alias is also
-  # a module function. The typical #alias_method 
+  # a module function. The typical #alias_method
   # does not do this.
   #
   #   module Demo
@@ -116,8 +112,8 @@ class Module
   #
   # so you can safely chain foo, foo?, and foo! with the same feature.
   #
-  #   CREDIT Bitsweat and Rails Team.
-  #++
+  #   CREDIT: Bitsweat
+  #   CREDIT: Rails Team
 
   def alias_method_chain(target, feature)
     # Strip out punctuation on predicates or bang methods since
@@ -141,56 +137,3 @@ class Module
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TCModule < Test::Unit::TestCase
-
-    module MockModule
-      # for alias_module_method
-      def x ; 33 ; end
-      module_function :x
-      alias_module_function :y, :x
-    end
-
-    def test_alias_module_function
-      assert_equal( 33, MockModule.y )
-      #assert_equal( 33, @m.send(:y) ) # use send b/c private
-    end
-
-    module X
-      def self.included(base)
-        base.module_eval {
-          alias_method_chain :foo, :feature
-        }
-      end
-      def foo_with_feature
-        foo_without_feature + '!'
-      end
-    end
-
-    class Y
-      def foo
-        "FOO"
-      end
-      include X
-      #alias_method_chain :foo, :feature
-    end
-
-    def test_001
-      y = Y.new
-      assert_equal( "FOO!", y.foo )
-    end
-
-  end
-
-=end

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

@@ -1,20 +1,9 @@
-# TITLE:
-#
-#   Extra Attributes Methods
-#
-# SUMMARY:
-#
-#   Module attribute extensions.
-#
-# AUTHORS:
-#
-#   - Thomas Sawyer
-
-#
 class Module
 
   # Like attr_writer, but the writer method validates the
   # setting against the given block.
+  #
+  #   CREDIT: ?
 
   def attr_validator(*symbols, &validator)
     made = []
@@ -30,11 +19,13 @@ class Module
     made
   end
 
+  # Create aliases for validators.
+
   def alias_validator(*args)
     orig = args.last
     args = args - [orig]
     args.each do |name|
-      alias_method(name, orig)
+      #alias_method(name, orig)
       alias_method("#{name}=", "#{orig}=")
     end
   end
@@ -57,6 +48,8 @@ class Module
   #     end
   #   end
   #
+  #  CREDIT: Trans
+
   def attr_setter(*args)
     code, made = '', []
     args.each do |a|
@@ -71,6 +64,20 @@ class Module
     made
   end
 
+  # Alias an accessor. This create an alias for
+  # both a reader and a writer.
+  #
+  #   class X
+  #     attr_accessor :a
+  #     alias_accessor :b, :a
+  #   end
+  #
+  #   x = X.new
+  #   x.b = 1
+  #   x.a        #=> 1
+  #
+  #  CREDIT: Trans
+
   def alias_setter(*args)
     args = args - [orig]
     args.each do |name|
@@ -94,6 +101,8 @@ class Module
   #     @a = value
   #     self
   #   end
+  #
+  #  CREDIT: Trans
 
   def attr_accessor!(*args)
     attr_reader!(*args) + attr_writer!(*args)
@@ -101,6 +110,10 @@ class Module
   alias_method :attr_switcher, :attr_accessor!
   alias_method :attr_toggler,  :attr_accessor!
 
+  # Create aliases for flag accessors.
+  #
+  #  CREDIT: Trans
+
   def alias_accessor!(*args)
     orig = args.last
     args = args - [orig]
@@ -112,7 +125,7 @@ class Module
   alias_method :alias_switcher, :alias_accessor!
   alias_method :alias_toggler,  :alias_accessor!
 
-  # Create an tester attribute. This creates a single methods
+  # Create an tester attribute. This creates a single method
   # used to test the attribute for truth.
   #
   #   attr_reader! :a
@@ -139,6 +152,10 @@ class Module
   alias_method :attr_reader?, :attr_reader!
   alias_method :attr_tester, :attr_reader!
 
+  # Create aliases for flag reader.
+  #
+  #  CREDIT: Trans
+
   def alias_reader!(*args)
     orig = args.last
     args = args - [orig]
@@ -176,6 +193,10 @@ class Module
     made
   end
 
+  # Create aliases for flag writer.
+  #
+  #  CREDIT: Trans
+
   def alias_writer!(*args)
     orig = args.last
     args = args - [orig]

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

@@ -1,20 +1,3 @@
-# TITLE:
-#
-#   Class Attributes
-#
-# FILE:
-#
-#   cattr.rb
-#
-# DESCRIPTION:
-#
-#   Class attributes with instance level access.
-#
-# AUTHORS:
-#
-#   CREDIT David Heinemeier Hansson
-
-#
 class Class
 
   # Creates a class-variable attribute that can
@@ -25,6 +8,8 @@ class Class
   # method is not carried along. So the are now just class
   # methods. Accordingly, #mattr will eventually be deprecated
   # so use #cattr instead.
+  #
+  #   CREDIT: David Heinemeier Hansson
 
   def cattr( *syms )
     accessors, readers = syms.flatten.partition { |a| a.to_s =~ /=$/ }
@@ -48,6 +33,8 @@ class Class
   #   MyClass.a           #=> 10
   #   MyClass.new.a       #=> 10
   #
+  #   CREDIT: David Heinemeier Hansson
+
   def cattr_reader( *syms )
     syms.flatten.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__)
@@ -79,6 +66,8 @@ class Class
   #   MyClass.new.a = 29
   #   MyClass.a            #=> 29
   #
+  #   CREDIT: David Heinemeier Hansson
+
   def cattr_writer(*syms)
     syms.flatten.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__)
@@ -107,6 +96,8 @@ class Class
   #   mc = MyClass.new
   #   mc.a                #=> 10
   #
+  #   CREDIT: David Heinemeier Hansson
+
   def cattr_accessor(*syms)
     m = []
     m.concat( cattr_reader(*syms) )
@@ -117,62 +108,3 @@ class Class
   alias_method :mattr_accessor, :cattr_accessor  # deprecate
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TCModule < Test::Unit::TestCase
-
-    class MockObject
-      def initialize
-        @@a = 10
-      end
-      def b ; @@b ; end
-    end
-
-    def test_cattr
-      assert_nothing_raised {
-        MockObject.class_eval { cattr :a }
-      }
-      t = MockObject.new
-      assert_equal( 10, t.a )
-    end
-
-    def test_cattr_reader
-      assert_nothing_raised {
-        MockObject.class_eval { cattr_reader :a }
-      }
-      t = MockObject.new
-      assert_equal( 10, t.a )
-    end
-
-    def test_cattr_writer
-      assert_nothing_raised {
-        MockObject.class_eval { cattr_writer :b }
-      }
-      t = MockObject.new
-      t.b = 5
-      assert_equal( 5, t.b )
-    end
-
-    def test_cattr_accessor
-      assert_nothing_raised {
-        MockObject.class_eval { cattr_accessor :c }
-      }
-      t = MockObject.new
-      t.c = 50
-      assert_equal( 50, t.c )
-    end
-
-  end
-
-=end

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

@@ -1,22 +1,12 @@
-# TITLE:
-#
-#   Module Clone and Augment
-#
-# SUMMARY:
-#
-#   Module extensions for cloning and augmenting a module.
-#   These will *probably* be fully usurped by Traits in
-#   the long run.
-#
-# CREDITS:
-#
-#   - Thomas Sawyer
-
-#
 class Module
 
   # Returns an anonymous module with the specified methods
   # of the receiving module renamed.
+  #
+  #   NOTE: These is likely to be usurped by traits.rb.
+  #
+  #   CREDIT: Trans
+
   def clone_renaming( pairs )
     mod = self.dup
     pairs.each_pair{ |to_sym, from_sym|
@@ -30,6 +20,11 @@ class Module
 
   # Returns an anonymous module with the specified methods
   # of the receiving module removed.
+  #
+  #   NOTE: These is likely to be usurped by traits.rb.
+  #
+  #   CREDIT: Trans
+
   def clone_removing( *meths )
     mod = self.dup
     methods_to_remove = meths
@@ -39,6 +34,11 @@ class Module
 
   # Returns an anonymous module with only the specified methods
   # of the receiving module intact.
+  #
+  #   NOTE: These is likely to be usurped by traits.rb.
+  #
+  #   CREDIT: Trans
+
   def clone_using( *methods )
     methods.collect!{ |m| m.to_s }
     methods_to_remove = instance_methods - methods
@@ -48,54 +48,3 @@ class Module
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestModuleClone < Test::Unit::TestCase
-
-    module M
-      def f; 1; end
-      def g; 2; end
-    end
-
-    class Remove
-      include M.clone_removing( :g )
-    end
-
-    class Rename
-      include M.clone_renaming( :q => :g )
-    end
-
-    class Use
-      include M.clone_using( :f )
-    end
-
-    def test_removing
-      assert( Remove.method_defined?(:f) )
-      assert( ! Remove.method_defined?(:g) )
-    end
-
-    def test_renaming
-      assert( ! Rename.method_defined?(:g) )
-      assert( Rename.method_defined?(:f) )
-      assert( Rename.method_defined?(:q) )
-    end
-
-    def test_using_2
-      assert( ! Use.method_defined?(:g) )
-      assert( Use.method_defined?(:f) )
-    end
-
-  end
-
-=end