function_importer 0.0.1

data/ChangeLog

@@ -0,0 +1,11 @@
+commit 1e41d415433a45ecac051021ac62fd88345c428c
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Sat Mar 28 20:00:10 2009 +0900
+
+    added ChangeLog file.
+
+commit f365f447c2c9342400da03db57e012811a229900
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Sat Mar 28 19:44:15 2009 +0900
+
+    initial import.

data/README

@@ -0,0 +1,62 @@
+= function_importer
+writing explicitly need function for a module. and support rename.
+
+== Example
+  require 'rubygems'
+  require 'function_importer'
+  module Utils
+    extend FunctionExporter
+    
+    def escape str
+      "escaped_#{str}"
+    end
+  end
+
+  module Foo
+    Utils.export self, :escape
+
+    def run
+      p(escape('str')) #=> "escaped_str"
+    end
+  end
+
+  # you can rename methods when argument is Hash.
+  module Bar
+    Utils.export self, :escape => :my_escape
+
+    def run
+      p(my_escape('str')) #=> "escaped_str"
+    end
+  end
+
+  # or syntax suger.
+  module Baz
+    extend FunctionImporter
+    import_function Utils, :escape
+
+    def run
+      p(escape('str')) #=> "escaped_str"
+    end
+  end
+
+  # apply to class method.
+  module Baz
+    extend FunctionImporter
+    import_module_function Utils, :escape
+
+    def self.run
+      p(escape('str')) #=> "escaped_str"
+    end
+  end
+
+== Descripotin
+restrict importing methods and rename methods when include module.
+
+== SEE ALSO
++module-import+: I'm not like this module interface. (For example, pollute Kernel#import ).
+
+== Copyright
+
+Author:: Keiji, Yoshimi <walf443 at gmail.com>
+License:: you can redistribute it and/or modify it under the same terms as Ruby itself.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+include FileUtils
+
+load File.join(File.dirname(__FILE__), 'tasks', 'basic_config.rake')
+
+NAME              = "function_importer"
+DESCRIPTION       = <<-"END_DESCRIPTION"
+restrict importing methods and rename methods when include module.
+END_DESCRIPTION
+BIN_FILES         = %w(  )
+VERS              = "0.0.1"
+
+EXTRA_RDOC_FILES = []
+HECKLE_ROOT_MODULES = ["Classx"]
+
+SPEC = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = DEFAULT_EXTRA_RDOC_FILES + EXTRA_RDOC_FILES
+	s.rdoc_options     += RDOC_OPTS + ['--title', "#{NAME} documentation", ]
+	s.summary           = DESCRIPTION
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir            = "bin"
+	s.require_path      = "lib"
+	s.autorequire       = ""
+	s.test_files        = Dir["spec/*_spec.rb"]
+
+  if Gem::RubyGemsVersion >= "1.2"
+	  s.add_development_dependency('rspec', '>=1.1.4')
+  end
+	#s.required_ruby_version = '>= 1.8.2'
+
+	s.files = PKG_FILES + EXTRA_RDOC_FILES
+	s.extensions = EXTENSIONS
+end
+
+import File.join(File.dirname(__FILE__), 'tasks', 'basic_tasks.rake')

data/lib/function_importer.rb

@@ -0,0 +1,86 @@
+# add module a method to export function.
+module FunctionExporter
+  # Example:
+  #   module Utils
+  #     extend FunctionExporter
+  #     
+  #     def escape str
+  #       "escaped_#{str}"
+  #     end
+  #   end
+  #
+  #   module Foo
+  #     Utils.export self, :escape
+  #
+  #     def run
+  #       p(escape('str')) #=> "escaped_str"
+  #     end
+  #   end
+  #
+  #   # you can rename method when argument is Hash.
+  #   module Bar
+  #     Utils.export self, :escape => :my_escape
+  #
+  #     def run
+  #       p(my_escape('str')) #=> "escaped_str"
+  #     end
+  #   end
+  #
+  def export context, *args
+    parent_mod = create_export_module(*args)
+    context.module_eval do
+      include parent_mod
+    end
+  end
+
+  def create_export_module *args
+    parent_mod = self.dup
+
+    method_of = {};
+    case args.first
+    when Hash
+      args.first.each do |key, val|
+        method_of[key.to_s] = val
+      end
+    else
+      args.each do |i| 
+        method_of[i.to_s] = true
+      end
+    end
+
+    no_need_methods = []
+    parent_mod.instance_methods.each do |meth|
+      unless method_of[meth.to_s]
+        no_need_methods.push meth
+      end
+    end
+
+    parent_mod.module_eval do
+      # renate method.
+      method_of.each do |key, val|
+        next if val.kind_of? TrueClass
+        alias_method val, key
+        undef_method key
+      end
+      no_need_methods.each do |meth|
+        undef_method meth
+      end
+    end
+
+    parent_mod
+  end
+end
+
+# syntax suger for import function.
+module FunctionImporter
+
+  def import_function mod, *funcs
+    include(mod.create_export_module(*funcs))
+  end
+
+  def import_module_function mod, *funcs
+    extend(mod.create_export_module(*funcs))
+  end
+
+  private :import_function, :import_module_function
+end

data/spec/function_exporter_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe FunctionExporter do
+  before :all do
+    @module = Module.new
+    @module.module_eval do
+      extend FunctionExporter
+
+      define_method :escape do |str|
+        "escaped_#{str}"
+      end
+
+    end
+  end
+
+  describe 'export a function' do
+    before do
+      @export_mod = @module.create_export_module :escape
+    end
+
+    it 'should return Module' do
+      @export_mod.should be_kind_of(Module)
+    end
+
+    it 'should have #escape as public' do
+      @export_mod.public_instance_methods.any? {|i| i.to_s == 'escape' }.should be_true
+    end
+  end
+
+  describe 'export a function with rename' do
+    before do
+      @export_mod = @module.create_export_module :escape => :my_escape
+    end
+
+    it 'should not have #escape' do
+      @export_mod.instance_methods.all? {|i| i.to_s != 'escape' }.should be_true
+    end
+
+    it 'should have #my_escape as public' do
+      @export_mod.instance_methods.any? {|i| i.to_s == 'my_escape' }.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib')))
+require 'function_importer'
+
+require 'rubygems'
+require 'spec'

data/tasks/basic_config.rake

@@ -0,0 +1,27 @@
+AUTHOR            = "Keiji, Yoshimi"
+EMAIL             = "walf443 at gmail.com"
+RUBYFORGE_PROJECT = "akasakarb"
+RUBYFORGE_PROJECT_ID = 4314
+HOMEPATH          = "http://walf443.github.com/function_importer/"
+RDOC_OPTS = [
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README",
+	"--inline-source",
+  "--accessor", "has=rw",
+  '--exclude', '^(example|extras)/'
+]
+DEFAULT_EXTRA_RDOC_FILES = ['README', 'ChangeLog']
+PKG_FILES = [ 'Rakefile' ] + 
+  DEFAULT_EXTRA_RDOC_FILES +
+  Dir.glob('{bin,lib,test,spec,doc,bench,example,tasks,script,generator,templates,extras,website}/**/*') + 
+  Dir.glob('ext/**/*.{h,c,rb}') +
+  Dir.glob('examples/**/*.rb') +
+  Dir.glob('tools/*.rb')
+
+[ %r{^doc/.+\.pdf}, %r{^doc/.+\.key} ].each do |ignore|
+  PKG_FILES.delete_if {|file| file =~ ignore }
+end
+
+EXTENSIONS = FileList['ext/**/extconf.rb'].to_a

data/tasks/basic_tasks.rake

@@ -0,0 +1,144 @@
+
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+
+Rake::GemPackageTask.new(SPEC) do |p|
+	p.need_tar = true
+	p.gem_spec = SPEC
+end
+
+task :default => [:spec]
+task :test    => [:spec]
+task :package => [:clean]
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.warning = true
+  # t.rcov = true
+  t.rcov_dir = 'doc/output/coverage'
+  t.rcov_opts = ['--exclude', 'spec,\.autotest,/Library/']
+end
+
+desc "Heckle each module and class in turn"
+task :heckle => :spec do
+  root_modules = HECKLE_ROOT_MODULES
+  spec_files = FileList['spec/**/*_spec.rb']
+  
+  current_module, current_method = nil, nil
+  heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
+  unhandled_mutations = 0
+  
+  root_modules.each do |root_module|
+    IO.popen("heckle #{root_module} -t #{spec_files}") do |pipe|
+      while line = pipe.gets
+        line = line.chomp
+        
+        if line =~ /^\*\*\*  ((?:\w+(?:::)?)+)#(\w+)/
+          current_module, current_method = $1, $2
+        elsif line == "The following mutations didn't cause test failures:"
+          heckle_caught_modules[current_module] << current_method
+        elsif line == "+++ mutation"
+          unhandled_mutations += 1 
+        end
+              
+        puts line
+      end
+    end
+  end
+  
+  if unhandled_mutations > 0
+    error_message_lines = ["*************\n"]
+    
+    error_message_lines << 
+      "Heckle found #{unhandled_mutations} " + 
+      "mutation#{"s" unless unhandled_mutations == 1} " +
+      "that didn't cause spec violations\n"
+
+    heckle_caught_modules.each do |mod, methods|
+      error_message_lines <<
+        "#{mod} contains the following poorly-specified methods:"
+      methods.each do |m| 
+        error_message_lines << " - #{m}"
+      end
+      error_message_lines << ""
+    end
+    
+    error_message_lines <<
+      "Get your act together and come back " +
+      "when your specs are doing their job!"
+    
+    puts "*************"
+    raise error_message_lines.join("\n")
+  else
+    puts "Well done! Your code withstood a heckling."
+  end
+end
+
+require 'spec/rake/verify_rcov'
+RCov::VerifyTask.new(:rcov => :spec) do |t|
+  t.index_html = "doc/output/coverage/index.html"
+  t.threshold = 100
+end
+
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+begin
+  allison_path = `allison --path`.chomp
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'html'
+    rdoc.options += RDOC_OPTS
+    rdoc.template = allison_path
+    if ENV['DOC_FILES']
+      rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+    else
+      rdoc.rdoc_files.include('README', 'ChangeLog')
+      rdoc.rdoc_files.include('lib/**/*.rb')
+      rdoc.rdoc_files.include('ext/**/*.c')
+    end
+  end
+rescue Exception => e
+  warn e
+  warn "skipping rdoc task"
+ensure
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	require 'rubyforge'
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'yoshimi').upload
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+	require 'rubyforge'
+	v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+	abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
+	pkg = "pkg/#{NAME}-#{VERS}"
+
+	rf = RubyForge.new
+	puts "Logging in"
+	rf.login
+
+	c = rf.userconfig
+#	c["release_notes"] = description if description
+#	c["release_changes"] = changes if changes
+	c["preformatted"] = true
+
+	files = [
+		"#{pkg}.tgz",
+		"#{pkg}.gem"
+	].compact
+
+	puts "Releasing #{NAME} v. #{VERS}"
+	rf.add_release RUBYFORGE_PROJECT_ID, RUBYFORGE_PACKAGE_ID, VERS, *files
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: function_importer
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Keiji, Yoshimi
+autorequire: ""
+bindir: bin
+cert_chain: []
+
+date: 2009-03-28 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+description: restrict importing methods and rename methods when include module.
+email: walf443 at gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- ChangeLog
+files: 
+- Rakefile
+- README
+- ChangeLog
+- lib/function_importer.rb
+- spec/function_exporter_spec.rb
+- spec/spec_helper.rb
+- tasks/basic_config.rake
+- tasks/basic_tasks.rake
+has_rdoc: true
+homepage: http://walf443.github.com/function_importer/
+post_install_message: 
+rdoc_options: 
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --accessor
+- has=rw
+- --exclude
+- ^(example|extras)/
+- --title
+- function_importer documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: akasakarb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: restrict importing methods and rename methods when include module.
+test_files: 
+- spec/function_exporter_spec.rb