retroactive_module_inclusion 1.0.0 → 1.0.1

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 1.0.1 / 2011-01-20
+
+* 1 minor enhancement
+
+  * Forced documentation of private method retroactively_include
+
 === 1.0.0 / 2011-01-19
 
 * 1 major enhancement

data/Rakefile

@@ -20,7 +20,7 @@ Hoe.spec 'retroactive_module_inclusion' do
 
   developer('Adriano Mitre', 'adriano.mitre@gmail.com')
   
-  self.version = '1.0.0'
+  self.version = '1.0.1'
 
   self.readme_file = 'README.rdoc'
   self.history_file = 'History.rdoc'

data/lib/retroactive_module_inclusion.rb

@@ -2,7 +2,23 @@ class Module
 
   private
 
-  def retroactively_include(mod)
+  # Includes +mod+ retroactively, i.e., extending to all classes and modules which
+  # included +self+ _beforehand_.
+  #
+  # Example:
+  #
+  #   module Stats
+  #     def mean
+  #       n = 1
+  #       inject {|s,k| n += 1 ; s + k }.to_f / count
+  #     end
+  #   end
+  #
+  #   Enumerable.module_eval { retroactively_include Stats }
+  #
+  #   (1..2).mean  #=>  1.5
+  #
+  def retroactively_include(mod) # :doc:
     raise TypeError, 'wrong argument type #{mod.class} (expected Module)' unless mod.is_a? Module
 
     # Although one would expect +A.module_eval("include B")+ to make methods

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Adriano Mitre