RubyGems - module-import - Versions diffs - 0.1.0 - Mend

module-import 0.1.0

Files changed (11) hide show

data/README ADDED

@@ -0,0 +1,69 @@
+== Summary
+selectively include module methods
+== Author and License
+Copyright (c) 2008 Greg Weber, http://gregweber.info
+Licensed under the MIT license
+== Usage
+  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 # => 'bar'
+  Importer.new.foo # => NoMethodError
+  class Importer
+    import Foo, :not_defined # => #not_defined not found in Foo (ImportError)
+  end
+Giving no methods (or all methods) should behave the same as a normal include
+  class Importer2
+    import Foo, :foo, :bar
+  end
+  Importer.new.bar # => 'bar'
+  Importer.new.foo # => 'foo'
+However, there is one important difference.  New changes in the included module will not effect the class.
+  module Foo
+    undefine_method :foo
+    def bar; fail end
+  end
+  class Importer2
+    import Foo, :foo, :bar
+  end
+  Importer.new.bar # => 'bar'
+  Importer.new.foo # => 'foo'
+== Install
+gem install module-import
+== Source
+=== browser
+http://github.com/gregwebs/module-import/tree/master
+=== repository
+git clone git://github.com/gregwebs/module-import.git
+== Homepage
+http://gregweber.info/projects/module-import.html
+== RDoc documentation
+included with the gem
+== Notes
+=== Testing
+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.
+=== Implementation
+Includes a duplicate of the module that has methods removed

data/doc/created.rid ADDED

	@@ -0,0 +1 @@
1	+ Sun, 09 Mar 2008 12:30:11 -0500

data/doc/fr_class_index.html ADDED

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+    Classes
+  -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Classes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
+  <base target="docwin" />
+</head>
+<body>
+<div id="index">
+  <h1 class="section-bar">Classes</h1>
+  <div id="index-entries">
+    <a href="classes/ImportError.html">ImportError</a><br />
+    <a href="classes/Kernel.html">Kernel</a><br />
+  </div>
+</div>
+</body>
+</html>

data/doc/fr_file_index.html ADDED

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+    Files
+  -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Files</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
+  <base target="docwin" />
+</head>
+<body>
+<div id="index">
+  <h1 class="section-bar">Files</h1>
+  <div id="index-entries">
+    <a href="files/README.html">README</a><br />
+    <a href="files/lib/import_rb.html">lib/import.rb</a><br />
+  </div>
+</div>
+</body>
+</html>

data/doc/fr_method_index.html ADDED

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+    Methods
+  -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Methods</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
+  <base target="docwin" />
+</head>
+<body>
+<div id="index">
+  <h1 class="section-bar">Methods</h1>
+  <div id="index-entries">
+    <a href="classes/Kernel.html#M000001">import (Kernel)</a><br />
+  </div>
+</div>
+</body>
+</html>

data/doc/index.html ADDED

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<!--
+    RDoc Documentation
+  -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>RDoc Documentation</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+</head>
+<frameset rows="20%, 80%">
+    <frameset cols="25%,35%,45%">
+        <frame src="fr_file_index.html"   title="Files" name="Files" />
+        <frame src="fr_class_index.html"  name="Classes" />
+        <frame src="fr_method_index.html" name="Methods" />
+    </frameset>
+    <frame src="files/README.html" name="docwin" />
+</frameset>
+</html>

data/doc/rdoc-style.css ADDED

@@ -0,0 +1,208 @@
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+/* === Structural elements =================================== */
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+div#index a {
+    margin-left: 0.7em;
+}
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+div#fileHeader {
+    background: #057;
+}
+div#classHeader {
+    background: #048;
+}
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+/* === Classes =================================== */
+table.header-table {
+    color: white;
+    font-size: small;
+}
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+/* --- Context section classes ----------------------- */
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+/* --- Source code sections -------------------- */
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+/* --- Ruby keyword styles --------------------- */
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/lib/import.rb ADDED

@@ -0,0 +1,29 @@
+class ImportError < Exception; end
+module Kernel
+  # include a duplicate of the module with all uneeded instance methods removed
+  def import(mod, *meths)
+    include_module_copy = lambda do |block|
+      mod_dup = mod.dup
+      mod_dup.module_eval &block if block
+      include mod_dup
+    end
+    if meths.size == 0
+      include_module_copy.call(nil)
+    else
+      # get list of methods to remove module
+      ims = mod.instance_methods.map {|m| m.to_sym}
+      if (ims & meths).size != meths.size
+        raise ImportError, "##{(meths - ims).join(' and #')} not found in #{mod}"
+      end
+      ims = ims - meths
+      include_module_copy.call( lambda do
+        ims.each { |meth| remove_method meth }
+      end )
+    end
+  end
+end

data/rakefile ADDED

@@ -0,0 +1,60 @@
+rubyforge_project = "'module import'"
+project = 'module-import'
+desc "test"
+task :test do
+  Dir[ 'spec/*' ].each do |file|
+    puts `spec #{file}`
+    exit $?.exitstatus if $?.exitstatus != 0
+  end
+end
+desc "release a new gem to rubyforge"
+task :release => [:rdoc,:package] do
+  Dir.chdir('pkg') do
+    release = Dir['*.gem'].sort_by {|file| File.mtime(file)}.last
+    release =~ /^[^-]+-([.0-9]+).gem$/
+    `rubyforge login && rubyforge add_release #{project} #{project} #$1 #{release}`
+  end
+end
+desc "generate documentation"
+task :rdoc do
+  fail unless system 'rdoc --force-update --quiet README lib/*'
+end
+namespace :readme do
+  desc "create html for website using coderay, use --silent option"
+  task :html => :rdoc do
+    require 'hpricot'
+    doc = open( 'doc/files/README.html' ) { |f| Hpricot(f) }
+    # find example code
+    doc.at('#description').search('pre').
+      select {|elem| elem.inner_html =~ /class |module /}.each do |ex|
+      # add coderay and undo what rdoc has done in the example code
+      ex.swap("<coderay lang='ruby'>#{ex.inner_html.gsub('&quot;', '"').gsub('&gt;','>')}</coderay>")
+    end
+    puts doc.at('#description').to_html
+  end
+end
+require 'rubygems'
+require 'rake/gempackagetask'
+spec = Gem::Specification.new do |s|
+  s.name = project
+  s.rubyforge_project = project
+  s.version = "0.1.0"
+  s.author = "Greg Weber"
+  s.email = "greg@gregweber.info"
+  s.homepage = "http://projects.gregweber.info/#{project}"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "selectively import methods from modules"
+  s.files = Dir['./**'] + Dir['*/**']
+  s.require_path = "lib"
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README"]
+end
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = false
+end

data/spec/import_spec.rb ADDED

@@ -0,0 +1,136 @@
+require File.dirname(__FILE__) + '/../lib/import'
+def module_with_new
+  Module.new do
+    def self.new *args
+      (Class.new.send :include, self, *args).new
+    end
+  end
+end
+def class_with_super(superclass)
+  if superclass.is_a? Class
+    Class.new(superclass)
+  else
+    module_with_new().module_eval do
+      include superclass
+    end
+  end
+end
+def class_and_module(times=nil)
+  if !times or times == 1
+    [Class.new,  module_with_new()]
+  else
+    [(0...times).map{|i| Class.new}, (0...times).map{|i| module_with_new()}]
+  end
+end
+# testing uses this module
+module Foo
+  def extra_method; fail end
+  def foo; 'foo' end
+  def bar; 'bar' end
+  def another_extra_method; fail end
+end
+describe "import" do
+  it 'should import only the required methods' do
+    class_and_module.each do |k|
+      k.send :import, Foo, :bar
+      o = k.new
+      o.bar.should == 'bar'
+      lambda{o.foo}.should raise_error(NoMethodError)
+    end
+  end
+  it 'should raise an error when importing a method that does not exist' do
+    class_and_module.each {|k| lambda{ k.send :import, Foo, :foo, :not_defined, :bar }.
+      should raise_error(ImportError, /#not_defined/) }
+    class_and_module.each {|k| lambda{ k.send :import, Foo,
+      :not_defined, :foo, :_not_defined_, :bar, :__not_defined__ }.
+      should raise_error(ImportError, /#not_defined and #_not_defined_ and #__not_defined__/) }
+  end
+  it 'should import all methods if none are given' do
+    class_and_module.each do |c|
+      c.send :import, Foo
+      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
+    end
+  end
+  it 'should not be effected by changes to the module' do
+    class_and_module(2).each do |imp,inc|
+      Bar = Module.new do
+        def foo; 'foo' end
+      end
+      bar_orig_ims = Bar.instance_methods
+      imp.send :import, Bar
+      inc.send :include, Bar
+      imp.instance_methods.sort.should == inc.instance_methods.sort
+      (bar_orig_ims - imp.instance_methods).should be_empty
+      [imp, inc].each do |klass|
+        k = klass.new
+        k.foo.should == 'foo'
+        lambda{k.bar}.should raise_error(NoMethodError)
+      end
+      Bar.module_eval do
+        def extra_method; fail end
+        def bar; 'bar' end
+        undef_method :foo
+        def another_extra_method; fail end
+      end
+      lambda{inc.new.foo}.should raise_error(NoMethodError)
+      inc.new.bar.should == 'bar'
+      imp.new.foo.should == 'foo'
+      lambda{imp.new.bar}.should raise_error(NoMethodError)
+      (imp.instance_methods - inc.instance_methods).should == ['foo']
+      (inc.instance_methods - imp.instance_methods).sort.should == (Bar.instance_methods - bar_orig_ims).sort
+    end
+  end
+  it 'should not effect calls to super' do
+    class_and_module.each do |a|
+      a.class_eval do
+        def foo; 'super' end
+      end
+      b = class_with_super(a)
+      b.new.foo.should == 'super'
+      b.class_eval { import Foo, :bar }
+      b.new.foo.should == 'super'
+      bo = b.new
+      class << bo
+        import(Foo, :foo)
+      end
+      bo.foo.should == 'foo'
+      b.new.foo.should == 'super'
+      b.class_eval { import Foo, :foo }
+      b.new.foo.should == 'foo'
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+rubygems_version: 0.9.4
+specification_version: 1
+name: module-import
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+date: 2008-03-09 00:00:00 -06:00
+summary: selectively import methods from modules
+require_paths:
+- lib
+email: greg@gregweber.info
+homepage: http://projects.gregweber.info/module-import
+rubyforge_project: module-import
+description:
+autorequire:
+default_executable:
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 0.0.0
+  version:
+platform: ruby
+signing_key:
+cert_chain:
+post_install_message:
+authors:
+- Greg Weber
+files:
+- ./doc
+- ./lib
+- ./pkg
+- ./spec
+- ./README
+- ./rakefile
+- doc/files
+- doc/index.html
+- doc/rdoc-style.css
+- doc/fr_method_index.html
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/created.rid
+- doc/classes
+- lib/import.rb
+- spec/import_spec.rb
+- README
+test_files: []
+rdoc_options: []
+extra_rdoc_files:
+- README
+executables: []
+extensions: []
+requirements: []
+dependencies: []