mixin 0.4.0 → 0.4.1

data/README

@@ -1,6 +1,6 @@
 Mixin by Hersch Stevenson (xain)
 
-http://persapient.com/mixin (comming soon)
+http://rdoc.persapient.com/mixin
 
 
 This must be an early beta version.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Default: Generate documentation.'
+task :default => :rdoc
+
+desc 'Generate documentation for Mixin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mixin'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README', 'LICENSE', 'lib/**/*.rb')
+end

data/lib/metable.rb

@@ -1,6 +1,64 @@
 require 'mixin'
 
 
+# == Metable - The Bonus Mixin
+#
+# Metable is a mixin that provides a bundle of handy methods for the aspiring
+# ruby metaprogrammer.
+#
+# Have you ever wanted an easy way to alias a class method? Check out
+# +alias_class_method+. Have you ever desired a clean way to dynamically define
+# a class method in the same manner you would an instance method using
+# +define_method+ ? Well feast your eyes on +define_class_method+. In fact, you can
+# dynamically define a singleton method on any object the same way with
+# +define_singleton_method+.
+#
+# Metable provides those and many more (see the full list bellow).
+#
+# === Public Instance Methods
+# * eigen_eval
+# * eigenclass
+# * metaclass
+# * private_singleton_method
+# * protected_singleton_method
+# * public_singleton_method
+#
+# === Private Instance Methods
+# * alias_singleton_method
+# * define_singleton_method
+# * define_private_singleton_method
+# * define_protected_singleton_method
+# * define_public_singleton_method
+#
+# === Public Module Mixin & Class Mixin Methods
+# * class_method_defined?
+# * eigen_eval
+# * eigenclass
+# * metaclass
+# * private_class_method_defined?
+# * private_singleton_method
+# * protected_class_method
+# * protected_class_method_defined?
+# * protected_singleton_method
+# * public_class_method_defined?
+# * public_singleton_method
+#
+# === Private Module Mixin & Class Mixin Methods
+# * alias_class_method
+# * alias_singleton_method
+# * define_class_method
+# * define_singleton_method
+# * define_private_class_method
+# * define_private_singleton_method
+# * define_protected_class_method
+# * define_protected_singleton_method
+# * define_public_class_method
+# * define_public_singleton_method
+# * enclosed_attr
+# * private_enclosure
+# * protected_enclosure
+# * public_enclosure
+#
 module Metable
   include Metable::InstanceMethods
   extend_class_mixin Metable::ClassMethods

data/lib/metable/class_methods.rb

@@ -51,6 +51,20 @@ module Metable
     # invoked on that instance. The _access_ argument can be a symbol or string
     # representing the access level for the enclosure method (public, private,
     # or protected). The default access level is +private+.
+    #
+    #   class Foo
+    #     include Metable
+    #     enclosed_attr(:time_of_enclosure, :public) { Time.now }
+    #   end
+    #
+    #   foo = Foo.new
+    #   sleep 7
+    #   Time.now               -> Fri Sep 05 16:20:00 -0700 2008
+    #   foo.time_of_enclosure  -> Fri Sep 05 16:20:00 -0700 2008
+    #   sleep 86407
+    #   foo.time_of_enclosure  -> Fri Sep 05 16:20:00 -0700 2008
+    #   foo.instance_variables -> []
+    #
     def enclosed_attr(name, access = :private, &block) # :doc:
       define_method name do
         ea = instance_eval &block
@@ -61,14 +75,20 @@ module Metable
     end
 
 
+    # Equivalent to calling "<tt>enclosed_attr _name_, :public, <em>&block</em></tt>"
+    # on each _name_ in turn.
     def public_enclosure(*names, &block) # :doc:
       names.each { |name| enclosed_attr name, :public, &block }
     end
 
+    # Equivalent to calling "<tt>enclosed_attr _name_, :private, <em>&block</em></tt>"
+    # on each _name_ in turn.
     def private_enclosure(*names, &block) # :doc:
       names.each { |name| enclosed_attr name, :private, &block }
     end
 
+    # Equivalent to calling "<tt>enclosed_attr _name_, :protected, <em>&block</em></tt>"
+    # on each _name_ in turn.
     def protected_enclosure(*names, &block) # :doc:
       names.each { |name| enclosed_attr name, :protected, &block }
     end

data/lib/mixin.rb

@@ -8,7 +8,8 @@ module Mixin
   include Metable::InstanceMethods
   extend Metable::ClassMethods
 
-  class ModuleMixin < Module # :nodoc:
+
+  class ModuleMixin < SingletonMixin = Class.new(Module) # :nodoc:
     include Metable::InstanceMethods
 
     def initialize(mixin)
@@ -25,7 +26,7 @@ module Mixin
   end
 
 
-  enclosed_attr(:__class_mixin__) { Module.new }
+  enclosed_attr(:__class_mixin__) { SingletonMixin.new }
   enclosed_attr(:__module_mixin__) { ModuleMixin.new(self) }
 
 
@@ -94,7 +95,7 @@ module Mixin
 
 
   # Works the same as +class_mixin+ except that the invoking module's
-  # +module_mixin+ is instead extended to the invoking module its self rather
+  # +module_mixin+ is instead extended to the invoking module itself rather
   # than its including classes.
   #
   #   module Active
@@ -128,7 +129,7 @@ module Mixin
 
 
   def included(submodule)
-    if submodule.kind_of? Class
+    if submodule.kind_of?(Class) || submodule.kind_of?(SingletonMixin)
       submodule.extend __class_mixin__
     else
       submodule.extend_module_mixin __module_mixin__

data/test/mixin_case.rb

@@ -217,4 +217,14 @@ class MixinTest < Test::Unit::TestCase
     assert Meeper.rico? && Meeper.suave?
   end
 
+
+  def test_tips_and_tricks
+    load 'clevers.rb'
+
+    assert Clever.trick?
+    assert Adroit.trick?
+    assert Deft.technique?
+    assert Adroit.technique?
+  end
+
 end

data/test/test_subjects/clevers.rb

@@ -0,0 +1,24 @@
+module Clever
+  extend_module_mixin class_mixin
+
+  class_mixin do
+    def trick?
+      true
+    end
+  end
+end
+
+
+module Deft
+  extend_module_mixin self
+  extend_class_mixin self
+
+  def technique?
+    true
+  end
+end
+
+
+class Adroit
+  include Clever, Deft
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mixin
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Hersch Stevenson (xian)
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-04 00:00:00 -07:00
+date: 2008-09-08 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -35,9 +35,11 @@ files:
 - test/test_subjects/nudgers.rb
 - test/test_subjects/includers.rb
 - test/test_subjects/soopers.rb
+- test/test_subjects/clevers.rb
 - test/mixin_case.rb
 - README
 - LICENSE
+- Rakefile
 has_rdoc: true
 homepage: http://www.persapient.com/mixin
 post_install_message: