retroactive_module_inclusion 1.0.3 → 1.1.0

data/.yardopts

@@ -0,0 +1,3 @@
+--private
+lib/*.rb
+README.rdoc History.rdoc

data/History.rdoc

@@ -1,8 +1,20 @@
+=== 1.1.0 / 2011-01-22
+
+* 2 minor enhancements
+
+  * Refactored retroactively_include method from ::Module to
+    CoreExt::Module::RetroactiveModuleInclusion, after Ola Bini suggested
+    in his post {SAFE(R) MONKEY PATCHING}[http://olabini.com/blog/2011/01/safeer-monkey-patching/]
+
+  * Finally, managed to make yard document the retroactively_include method:
+    * .yardopts had to be created to add the '--private' argument, because
+      yard ignores the rdoc document modifiers :doc: and :nodoc:
+
 === 1.0.3 / 2011-01-20
 
 * 1 minor enhancement
 
-  * more concise Stats implementation, minor gem description and doc improvements
+  * More concise Stats implementation, minor gem description and doc improvements
 
 === 1.0.1 / 2011-01-20
 

data/Manifest.txt

@@ -1,4 +1,5 @@
 .autotest
+.yardopts
 History.rdoc
 Manifest.txt
 README.rdoc

data/README.rdoc

@@ -55,9 +55,9 @@ The second, more concise and elegant, is to use this gem
 
   Enumerable.module_eval { retroactively_include Stats }
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
-* Tested on all major Ruby interpreters (100% coverage, 0% failures):
+* Tested on all major Ruby interpreters (100% coverage, 0% failure):
   * ruby-1.9.2-p136
   * ruby-1.8.7-p330
   * ree-1.8.7-2010.02

data/Rakefile

@@ -8,7 +8,7 @@ require 'hoe'
 Hoe.spec 'retroactive_module_inclusion' do
   developer('Adriano Mitre', 'adriano.mitre@gmail.com')
   
-  self.version = '1.0.3'
+  self.version = '1.1.0'
 
   self.readme_file = 'README.rdoc'
   self.history_file = 'History.rdoc'
@@ -33,3 +33,24 @@ task :tests => [:test] do
   # aliasing :test with :tests for RVM ('rvm tests')
 end
 
+module CoreExt
+  module String
+    module FromHere
+      def from_here
+        unless Dir.pwd != File.dirname(File.expand_path(__FILE__))
+          self
+        else
+          File.expand_path("../#{self}", __FILE__)
+        end
+      end
+    end
+  end
+end
+
+String.class_eval { include CoreExt::String::FromHere }
+
+task :clean_all => [:clean] do
+  %w{ .yardoc }.each do |rel_path|
+    rm_r rel_path.from_here if File.exist?(rel_path.from_here)
+  end
+end

data/lib/retroactive_module_inclusion.rb

@@ -1,54 +1,60 @@
-class Module
+module CoreExt
+  module Module
+    module RetroactiveModuleInclusion
 
-  private
+      private
 
-  # 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
+      # Includes +mod+ retroactively, i.e., extending to all classes and modules which
+      # had included +self+ _beforehand_.
+      #
+      # Example:
+      #
+      #   module Stats
+      #     def mean
+      #       inject(&:+) / count.to_f
+      #     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 # ::Module would in general be equivalent to Object::Module and simply Module would mean CoreExt::Module in this context
 
-    # Although one would expect +A.module_eval("include B")+ to make methods
-    # from module +B+ available to all classes and modules that had previously
-    # included module +A+, this is not the case due to a limitation in Ruby's
-    # object model (see [dynamic module include problem][1]). Thus, one has two
-    # possible solutions:
-    #   * use Module#include_retroactively instead of Module#include
-    #   * reopen +A+ and define the methods directly inside it
-    #
-    # JRuby (at least up to version 1.5.6) has ObjectSpace disabled by default,
-    # thus it must be enabled manually ([reference][2]).
-    #
-    # [1]: http://eigenclass.org/hiki/The+double+inclusion+problem                      "Dynamic Module Include Problem"
-    # [2]: http://ola-bini.blogspot.com/2007/07/objectspace-to-have-or-not-to-have.html "ObjectSpace: to have or not to have"
-    #
-    prev_jruby_objectspace_state = nil # only for scope reasons
-    if defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /jruby/i
-      require 'jruby'
-      prev_jruby_objectspace_state = JRuby.objectspace
-      JRuby.objectspace = true
-    end
-    ObjectSpace.each_object(Module) do |m|
-      if m <= self # equiv. to "if m.include?(self) || m == self"
-        m.module_eval { include mod }
+        # Although one would expect +A.module_eval("include B")+ to make methods
+        # from module +B+ available to all classes and modules that had previously
+        # included module +A+, this is not the case due to a limitation in Ruby's
+        # object model (see [dynamic module include problem][1]). Thus, one has two
+        # possible solutions:
+        #   * use Module#include_retroactively instead of Module#include
+        #   * reopen +A+ and define the methods directly inside it
+        #
+        # JRuby (at least up to version 1.5.6) has ObjectSpace disabled by default,
+        # thus it must be enabled manually ([reference][2]).
+        #
+        # [1]: http://eigenclass.org/hiki/The+double+inclusion+problem                      "Dynamic Module Include Problem"
+        # [2]: http://ola-bini.blogspot.com/2007/07/objectspace-to-have-or-not-to-have.html "ObjectSpace: to have or not to have"
+        #
+        prev_jruby_objectspace_state = nil # only for scope reasons
+        if defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /jruby/i
+          require 'jruby'
+          prev_jruby_objectspace_state = JRuby.objectspace
+          JRuby.objectspace = true
+        end
+        ObjectSpace.each_object(::Module) do |m|
+          if m <= self # equiv. to "if m.include?(self) || m == self"
+            m.module_eval { include mod }
+          end
+        end
+        if defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /jruby/i
+          JRuby.objectspace = prev_jruby_objectspace_state
+        end
       end
-    end
-    if defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /jruby/i
-      JRuby.objectspace = prev_jruby_objectspace_state
+      
+      ::Module.class_eval { include CoreExt::Module::RetroactiveModuleInclusion }
+  
     end
   end
-  
 end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: retroactive_module_inclusion
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 3
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors: 
 - Adriano Mitre
@@ -36,7 +36,7 @@ cert_chain:
   9u8N6mQNneIVRh6Xfdko/Q==
   -----END CERTIFICATE-----
 
-date: 2011-01-21 00:00:00 -02:00
+date: 2011-01-22 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,6 +76,7 @@ extra_rdoc_files:
 - History.rdoc
 files: 
 - .autotest
+- .yardopts
 - History.rdoc
 - Manifest.txt
 - README.rdoc