RubyGems - module-import - Versions diffs - 0.3.0 → 0.4.0 - Mend

module-import 0.3.0 → 0.4.0

Files changed (12) hide show

data/README +6 -1
data/Rakefile +2 -2
data/coverage/-var-lib-gems-1_8-gems-rcov-0_8_0_2-lib-rcov_rb.html +1 -1
data/coverage/index.html +11 -11
data/coverage/lib-module-import_rb.html +35 -23
data/doc/created.rid +1 -1
data/lib/module-import.rb +17 -5
data/spec/import_spec.rb +52 -7
metadata +2 -5
data/delete.html +0 -92
data/example.rb +0 -48
data/module-import.rb +0 -0

data/README CHANGED

@@ -1,5 +1,5 @@
 == Summary
-selectively include module methods
+selectively include module methods with Kernel#import
 == Author and License
 Copyright (c) 2008 Greg Weber, http://gregweber.info
@@ -42,6 +42,11 @@ However, there is one important difference.  New changes in the included module
   Importer2.new.bar # => 'bar'
   Importer2.new.foo # => 'foo'
+== WARNING!
+There is no way for Kernel#import to track dependencies between methods!  To help with this, by default, all private methods from the module will be imported unless the option :import_private is set to false
+To write a module that works with this system well, your public methods should depend only on private methods.
+To use this on someone else's module, you should either import the full module or write tests or inspect the source code of the module you are importing.
 == Install
 gem install module-import

data/Rakefile CHANGED

@@ -82,7 +82,7 @@ namespace :rcov do
 end
 desc "release a new gem to rubyforge"
-task :release => [:test,:rdoc,:website,:package] do
+task :release => [:test,:record,:rdoc,:website,:package] do
   Dir.chdir('pkg') do
     release = Dir['*.gem'].sort_by {|file| File.mtime(file)}.last
     release =~ /^[^-]+-([.0-9]+).gem$/
@@ -137,7 +137,7 @@ require 'rake/gempackagetask'
 spec = Gem::Specification.new do |s|
   s.name = project
   s.rubyforge_project = project
-  s.version = "0.3.0"
+  s.version = "0.4.0"
   s.author = "Greg Weber"
   s.email = "greg@gregweber.info"
   s.homepage = "http://projects.gregweber.info/#{project}"

data/coverage/-var-lib-gems-1_8-gems-rcov-0_8_0_2-lib-rcov_rb.html CHANGED

@@ -556,7 +556,7 @@ span.run100 {
       </head>
       <body>
         <h3>C0 code coverage information</h3>
-        <p>Generated on Wed Mar 12 17:24:18 -0500 2008 with <a href='http://eigenclass.org/hiki.rb?rcov'>rcov 0.8.0</a>
+        <p>Generated on Fri Mar 14 20:30:48 -0500 2008 with <a href='http://eigenclass.org/hiki.rb?rcov'>rcov 0.8.0</a>
         </p>
         <hr /><pre><span class='marked0'>Code reported as executed by Ruby looks like this...
 </span><span class='marked1'>and this: this line is also marked as covered.

data/coverage/index.html CHANGED

@@ -151,7 +151,7 @@ table.report tr.dark {
       </head>
       <body>
         <h3>C0 code coverage information</h3>
-        <p>Generated on Wed Mar 12 17:24:18 -0500 2008 with <a href='http://eigenclass.org/hiki.rb?rcov'>rcov 0.8.0</a>
+        <p>Generated on Fri Mar 14 20:30:48 -0500 2008 with <a href='http://eigenclass.org/hiki.rb?rcov'>rcov 0.8.0</a>
         </p>
         <hr />    <table class='report'>
       <thead>
@@ -167,21 +167,21 @@ table.report tr.dark {
         <tr class='light'>
           <td>TOTAL</td>
           <td class='lines_total'>
-            <tt>1003</tt>
+            <tt>1015</tt>
           </td>
           <td class='lines_code'>
-            <tt>612</tt>
+            <tt>624</tt>
           </td>
           <td>
             <table cellspacing='0' cellpadding='0' align='right'>
               <tr>
                 <td>
-                  <tt class='coverage_total'>6.0%</tt>&nbsp;</td>
+                  <tt class='coverage_total'>7.1%</tt>&nbsp;</td>
                 <td>
                   <table cellspacing='0' class='percent_graph' cellpadding='0' width='100'>
                     <tr>
-                      <td class='covered' width='6' />
-                      <td class='uncovered' width='94' />
+                      <td class='covered' width='7' />
+                      <td class='uncovered' width='93' />
                     </tr>
                   </table>
                 </td>
@@ -192,12 +192,12 @@ table.report tr.dark {
             <table cellspacing='0' cellpadding='0' align='right'>
               <tr>
                 <td>
-                  <tt class='coverage_code'>5.6%</tt>&nbsp;</td>
+                  <tt class='coverage_code'>7.4%</tt>&nbsp;</td>
                 <td>
                   <table cellspacing='0' class='percent_graph' cellpadding='0' width='100'>
                     <tr>
-                      <td class='covered' width='6' />
-                      <td class='uncovered' width='94' />
+                      <td class='covered' width='7' />
+                      <td class='uncovered' width='93' />
                     </tr>
                   </table>
                 </td>
@@ -253,10 +253,10 @@ table.report tr.dark {
             <a href='lib-module-import_rb.html'>lib/module-import.rb</a>
           </td>
           <td class='lines_total'>
-            <tt>27</tt>
+            <tt>39</tt>
           </td>
           <td class='lines_code'>
-            <tt>17</tt>
+            <tt>29</tt>
           </td>
           <td>
             <table cellspacing='0' cellpadding='0' align='right'>

data/coverage/lib-module-import_rb.html CHANGED

@@ -556,7 +556,7 @@ span.run100 {
       </head>
       <body>
         <h3>C0 code coverage information</h3>
-        <p>Generated on Wed Mar 12 17:24:18 -0500 2008 with <a href='http://eigenclass.org/hiki.rb?rcov'>rcov 0.8.0</a>
+        <p>Generated on Fri Mar 14 20:30:48 -0500 2008 with <a href='http://eigenclass.org/hiki.rb?rcov'>rcov 0.8.0</a>
         </p>
         <hr /><pre><span class='marked0'>Code reported as executed by Ruby looks like this...
 </span><span class='marked1'>and this: this line is also marked as covered.
@@ -580,10 +580,10 @@ span.run100 {
             <a href='lib-module-import_rb.html'>lib/module-import.rb</a>
           </td>
           <td class='lines_total'>
-            <tt>27</tt>
+            <tt>39</tt>
           </td>
           <td class='lines_code'>
-            <tt>17</tt>
+            <tt>29</tt>
           </td>
           <td>
             <table cellspacing='0' cellpadding='0' align='right'>
@@ -624,28 +624,40 @@ span.run100 {
 </span><span class="marked1"><a name="line3" /> 3 module Kernel
 </span><span class="inferred0"><a name="line4" /> 4
 </span><span class="inferred1"><a name="line5" /> 5   # abstraction:: only include the methods given by _meths_
-</span><span class="inferred0"><a name="line6" /> 6   # implementation:: includes a duplicate of _mod_ with all uneeded instance methods removed
-</span><span class="marked1"><a name="line7" /> 7   def import(mod, *meths)
+</span><span class="inferred0"><a name="line6" /> 6   # implementation:: includes a duplicate of _mod_ with only the specified instance methods included.  By default, all private methods will be included unless the option :import_private is set to false.  If no methods are given,
+</span><span class="marked1"><a name="line7" /> 7   def import(mod, *methods_or_options)
 </span><span class="marked0"><a name="line8" /> 8     mod_dup = mod.dup
 </span><span class="inferred1"><a name="line9" /> 9
-</span><span class="marked0"><a name="line10" />10     unless meths.empty?
-</span><span class="inferred1"><a name="line11" />11
-</span><span class="inferred0"><a name="line12" />12       # get list of methods to remove module
-</span><span class="marked1"><a name="line13" />13       ims = mod.instance_methods.map {|m| m.to_sym}
-</span><span class="marked0"><a name="line14" />14       removes = ims - meths
-</span><span class="inferred1"><a name="line15" />15
-</span><span class="marked0"><a name="line16" />16       if removes.size != (ims.size - meths.size)
-</span><span class="marked1"><a name="line17" />17         raise ImportError, &quot;##{(meths - ims).join(' and #')} not found in #{mod}&quot;
-</span><span class="inferred0"><a name="line18" />18       end
-</span><span class="inferred1"><a name="line19" />19
-</span><span class="marked0"><a name="line20" />20       mod_dup.module_eval do
-</span><span class="marked1"><a name="line21" />21         removes.each { |meth| remove_method meth }
-</span><span class="inferred0"><a name="line22" />22       end
-</span><span class="inferred1"><a name="line23" />23     end
-</span><span class="inferred0"><a name="line24" />24
-</span><span class="marked1"><a name="line25" />25     include mod_dup
-</span><span class="inferred0"><a name="line26" />26   end
-</span><span class="inferred1"><a name="line27" />27 end
+</span><span class="marked0"><a name="line10" />10     unless methods_or_options.empty?
+</span><span class="marked1"><a name="line11" />11       options, meths = methods_or_options.partition {|m| m.is_a?(Hash)}
+</span><span class="inferred0"><a name="line12" />12
+</span><span class="inferred1"><a name="line13" />13       # get list of methods to remove module
+</span><span class="marked0"><a name="line14" />14       ims = mod.instance_methods
+</span><span class="marked1"><a name="line15" />15       if options.first
+</span><span class="marked0"><a name="line16" />16         if meths.empty?
+</span><span class="marked1"><a name="line17" />17           fail ArgumentError,
+</span><span class="inferred0"><a name="line18" />18             &quot;methods arguments required with options flags&quot;
+</span><span class="inferred1"><a name="line19" />19         end
+</span><span class="marked0"><a name="line20" />20         if options.first[:import_private] == false
+</span><span class="marked1"><a name="line21" />21           ims += mod.private_instance_methods
+</span><span class="inferred0"><a name="line22" />22         end
+</span><span class="inferred1"><a name="line23" />23       end
+</span><span class="marked0"><a name="line24" />24       ims.map! {|m| m.to_sym}
+</span><span class="marked1"><a name="line25" />25       removes = ims - meths
+</span><span class="inferred0"><a name="line26" />26
+</span><span class="marked1"><a name="line27" />27       if removes.size != (ims.size - meths.size)
+</span><span class="marked0"><a name="line28" />28         raise ImportError,
+</span><span class="marked1"><a name="line29" />29           &quot;##{(meths - ims).join(' and #')} not found in #{mod}&quot;
+</span><span class="inferred0"><a name="line30" />30       end
+</span><span class="inferred1"><a name="line31" />31
+</span><span class="marked0"><a name="line32" />32       mod_dup.module_eval do
+</span><span class="marked1"><a name="line33" />33         removes.each { |meth| remove_method meth }
+</span><span class="inferred0"><a name="line34" />34       end
+</span><span class="inferred1"><a name="line35" />35     end
+</span><span class="inferred0"><a name="line36" />36
+</span><span class="marked1"><a name="line37" />37     include mod_dup
+</span><span class="inferred0"><a name="line38" />38   end
+</span><span class="inferred1"><a name="line39" />39 end
 </span></pre><hr />    <p>Generated using the <a href='http://eigenclass.org/hiki.rb?rcov'>rcov code coverage analysis tool for Ruby</a> version 0.8.0.</p><p>
           <a href='http://validator.w3.org/check/referer'>
             <img src='http://www.w3.org/Icons/valid-xhtml10' height='31' alt='Valid XHTML 1.0!' width='88' />

data/doc/created.rid CHANGED

	@@ -1 +1 @@
1	- ~~Wed~~, 12 Mar 2008 17:24:20 -0500
1	+ Fri, 14 Mar 2008 20:30:52 -0500

data/lib/module-import.rb CHANGED

@@ -3,18 +3,30 @@ class ImportError < Exception; end
 module Kernel
   # abstraction:: only include the methods given by _meths_
-  # implementation:: includes a duplicate of _mod_ with all uneeded instance methods removed
-  def import(mod, *meths)
+  # implementation:: includes a duplicate of _mod_ with only the specified instance methods included.  By default, all private methods will be included unless the option :import_private is set to false.  If no methods are given,
+  def import(mod, *methods_or_options)
     mod_dup = mod.dup
-    unless meths.empty?
+    unless methods_or_options.empty?
+      options, meths = methods_or_options.partition {|m| m.is_a?(Hash)}
       # get list of methods to remove module
-      ims = mod.instance_methods.map {|m| m.to_sym}
+      ims = mod.instance_methods
+      if options.first
+        if meths.empty?
+          fail ArgumentError,
+            "methods arguments required with options flags"
+        end
+        if options.first[:import_private] == false
+          ims += mod.private_instance_methods
+        end
+      end
+      ims.map! {|m| m.to_sym}
       removes = ims - meths
       if removes.size != (ims.size - meths.size)
-        raise ImportError, "##{(meths - ims).join(' and #')} not found in #{mod}"
+        raise ImportError,
+          "##{(meths - ims).join(' and #')} not found in #{mod}"
       end
       mod_dup.module_eval do

data/spec/import_spec.rb CHANGED

@@ -1,5 +1,4 @@
 require File.dirname(__FILE__) + '/../lib/module-import'
 # testing helpers
 def module_with_new
   Module.new do
@@ -27,14 +26,40 @@ def class_and_module(times=nil)
   end
 end
+module ModuleDependencies
+  def self.included(mod)
+    mod.module_eval do
+      @@instance_method_dependencies = Hash.new
+    end
+    def mod.import_dependencies set=nil
+      if set
+        @@instance_method_dependencies = set
+      else
+        @@instance_method_dependencies
+      end
+    end
+  end
+end
 # testing uses this module
 module Foo
   def extra_method; fail end
-  def foo; 'foo' end
-  def bar; 'bar' end
+  def foo; foo_dependency() end
+  def bar; bar_dependency end
+protected
+  def protected_method
+  end
+private
+  def foo_dependency; 'foo' end
+  def bar_dependency; 'bar' end
+  def private_extra_method; fail end
+public
   def another_extra_method; fail end
 end
@@ -63,10 +88,6 @@ describe "import" do
       c.new.foo.should == 'foo'
       c.new.bar.should == 'bar'
-      b = c.class.new
-      b.send :import, Foo, *(Foo.private_instance_methods)
-      c.instance_methods.sort.should == b.instance_methods.sort
       a = c.class.new
       a.send :include, Foo
       a.instance_methods.sort.should == c.instance_methods.sort
@@ -134,4 +155,28 @@ describe "import" do
       b.new.foo.should == 'foo'
     end
   end
+  it "should remove private methods when :import_private is false" do
+    class_and_module.each do |a|
+      b = Class.new do
+        import Foo, :foo, :import_private => false
+      end
+      lambda{b.new.foo}.should raise_error(NoMethodError, /foo_dependency/)
+      c = Class.new do
+        import Foo, :foo, :foo_dependency, :import_private => false
+      end
+      lambda{c.new.foo}.should_not raise_error
+    end
+  end
+  it "should fail when no methods given with :import_private flag" do
+    class_and_module.each do |a|
+      [true,false].each do |tf|
+        lambda{ Class.new do
+          import Foo, :import_private => tf
+        end }.should raise_error(ArgumentError)
+      end
+    end
+  end
 end

metadata CHANGED

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: module-import
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-date: 2008-03-12 00:00:00 -05:00
+  version: 0.4.0
+date: 2008-03-14 00:00:00 -05:00
 summary: selectively import methods from modules
 require_paths:
 - lib
@@ -34,10 +34,7 @@ files:
 - ./spec
 - ./Rakefile
 - ./README
-- ./example.rb
 - ./coverage
-- ./delete.html
-- ./module-import.rb
 - doc/files
 - doc/index.html
 - doc/rdoc-style.css

data/delete.html DELETED

@@ -1,92 +0,0 @@
-<html>
-  <body>
-&lt;div id=<span class="s"><span class="dl">&quot;</span><span class="k">description</span><span class="dl">&quot;</span></span>&gt;
-      &lt;h2&gt;<span class="co">Summary</span>&lt;<span class="rx"><span class="dl">/</span><span class="k">h2&gt;
-&lt;p&gt;
-selectively include module methods
-&lt;</span><span class="dl">/</span></span>p&gt;
-&lt;h2&gt;<span class="co">Author</span> <span class="r">and</span> <span class="co">License</span>&lt;<span class="rx"><span class="dl">/</span><span class="k">h2&gt;
-&lt;p&gt;
-Copyright (c) 2008 Greg Weber, &lt;a href=&quot;http:</span><span class="dl">/</span></span>/gregweber.info<span class="s"><span class="dl">&quot;</span><span class="k">&gt;gregweber.info&lt;/a&gt; Licensed under the MIT
-license
-&lt;/p&gt;
-&lt;h2&gt;Usage&lt;/h2&gt;
-&lt;coderay lang=</span><span class="dl">&quot;</span></span>ruby<span class="s"><span class="dl">&quot;</span><span class="k">&gt;
-  require 'rubygems'
-  require 'module-import'
-  module Foo
-    def foo; 'foo' end
-    def bar; 'bar' end
-  end
-  class Importer
-    import Foo, :bar
-  end
-  Importer.new.bar # =&gt; 'bar'
-  Importer.new.foo # =&gt; # NoMethodError
-  class Importer
-    import Foo, :not_defined # =&gt; #not_defined not found in Foo (ImportError)
-  end
-&lt;/coderay&gt;
-&lt;p&gt;
-Giving no methods (or all methods) should behave the same as a normal
-include
-&lt;/p&gt;
-&lt;coderay lang=</span><span class="dl">&quot;</span></span>ruby<span class="s"><span class="dl">&quot;</span><span class="k">&gt;
-  class Importer2
-    import Foo # same as import Foo, :foo, :bar
-  end
-  Importer2.new.bar # =&gt; 'bar'
-  Importer2.new.foo # =&gt; 'foo'
-&lt;/coderay&gt;
-&lt;p&gt;
-However, there is one important difference. New changes in the included
-module will not effect the class.
-&lt;/p&gt;
-&lt;coderay lang=</span><span class="dl">&quot;</span></span>ruby<span class="s"><span class="dl">&quot;</span><span class="k">&gt;
-  module Foo
-    undef_method :foo
-    def bar; fail end
-  end
-  Importer2.new.bar # =&gt; 'bar'
-  Importer2.new.foo # =&gt; 'foo'
-&lt;/coderay&gt;
-&lt;h2&gt;Install&lt;/h2&gt;
-&lt;p&gt;
-gem install module-import
-&lt;/p&gt;
-&lt;h2&gt;Source&lt;/h2&gt;
-&lt;h3&gt;browser&lt;/h3&gt;
-&lt;p&gt;
-&lt;a href=</span><span class="dl">&quot;</span></span>http<span class="sy">:/</span>/github.com/gregwebs/<span class="r">module</span>-import/tree/master<span class="s"><span class="dl">&quot;</span><span class="k">&gt;github.com/gregwebs/module-import/tree/master&lt;/a&gt;
-&lt;/p&gt;
-&lt;h3&gt;repository&lt;/h3&gt;
-&lt;p&gt;
-git clone git://github.com/gregwebs/module-import.git
-&lt;/p&gt;
-&lt;h2&gt;Homepage&lt;/h2&gt;
-&lt;p&gt;
-&lt;a href=</span><span class="dl">&quot;</span></span>http<span class="sy">:/</span>/gregweber.info/projects/<span class="r">module</span>-import.html<span class="s"><span class="dl">&quot;</span><span class="k">&gt;gregweber.info/projects/module-import.html&lt;/a&gt;
-&lt;/p&gt;
-&lt;h2&gt;RDoc documentation&lt;/h2&gt;
-&lt;p&gt;
-included with the gem
-&lt;/p&gt;
-&lt;h2&gt;Notes&lt;/h2&gt;
-&lt;h3&gt;Testing&lt;/h3&gt;
-&lt;p&gt;
-4:1 test:code ratio, I think I have all the corner cases covered. In
-particular, this does not break inheritance and everything works the same
-for importing into a module instead of a class.
-&lt;/p&gt;
-&lt;h3&gt;Implementation&lt;/h3&gt;
-&lt;p&gt;
-Includes a duplicate of the module that has methods removed
-&lt;/p&gt;
-    &lt;/div&gt;
-</span></span>
-  </body>
-</html>

data/example.rb DELETED

@@ -1,48 +0,0 @@
-class ImportError < Exception; end
-module Kernel
-  # abstraction:: only include the methods given by _meths_
-  # implementation:: includes a duplicate of _mod_ with all uneeded instance methods removed
-  def import(mod, *meths)
-    mod_dup = mod.dup
-    unless meths.empty?
-      # get list of methods to remove module
-      ims = mod.instance_methods.map {|m| m.to_sym}
-      removes = ims - meths
-      if removes.size != (ims.size - meths.size)
-        raise ImportError, "##{(meths - ims).join(' and #')} not found in #{mod}"
-      end
-      mod_dup.module_eval do
-        removes.each { |meth| remove_method meth }
-      end
-    end
-    include mod_dup
-  end
-end
-  module Foo
-    def foo; 'foo' end
-    def bar; 'bar' end
-  end
-  class Importer
-    import Foo, :bar
-  end
-  Importer.new.bar # => 'bar'
-  class Importer
-  end
-  class Importer2
-    import Foo # same as import Foo, :foo, :bar
-  end
-  Importer2.new.bar # => 'bar'
-  Importer2.new.foo # => 'foo'
-  module Foo
-    undef_method :foo
-    def bar; fail end
-  end
-  Importer2.new.bar # => 'bar'
-  Importer2.new.foo # => 'foo'

data/module-import.rb DELETED

File without changes