module-pluggable 0.0.1

data/Changelog

@@ -0,0 +1,8 @@
+2007-10-06  SATOH Hiroh <cho45@lowreal.net>
+
+	* 0.0.1 release
+
+2007-10-04  SATOH Hiroh <cho45@lowreal.net>
+
+	* Initial Coding.
+	  This library is derivation of chokan.

data/README

@@ -0,0 +1,41 @@
+= README for module-pluggable
+
+module-pluggable provides plugin system for classes.
+
+== Installation
+
+=== Archive Installation
+
+	rake install
+
+=== Gem Installation
+
+	gem install module-pluggable
+
+=== Subversion Repository
+
+Hosted by CodeRepos[http://coderepos.org/share/browser/lang/ruby/module-pluggable]
+
+	svn co http://svn.coderepos.org/share/lang/ruby/module-pluggable/
+
+== Examples
+
+	class APluggableClass
+		pluggable :plugins
+
+		def initialize
+			plugins.init(self)
+		end
+
+		def say
+			plugins.say("hello")
+		end
+	end
+
+see examples/simple.rb.
+
+== Copyright
+
+Author::    cho45 <cho45@lowreal.net>
+Copyright:: Copyright (c) 2007 cho45 www.lowreal.net
+License::   Ruby's

data/Rakefile

@@ -0,0 +1,144 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rubyforge'
+require 'fileutils'
+include FileUtils
+
+AUTHOR = "cho45"
+EMAIL = "cho45@lowreal.net"
+DESCRIPTION = ""
+RUBYFORGE_PROJECT = "modulepluggable"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES = %w(  )
+VERS = "0.0.1"
+
+
+NAME = "module-pluggable"
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "#{NAME} documentation",
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README",
+	"--inline-source"]
+
+desc "Packages up #{NAME} gem."
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") { |t|
+	t.libs << "test"
+	t.pattern = "test/**/*_test.rb"
+	t.verbose = true
+}
+
+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 = ["README", "Changelog"]
+	s.rdoc_options += RDOC_OPTS + ['--exclude', '^(extras)/']
+	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 = "safe_eval"
+	s.test_files = Dir["test/test_*.rb"]
+
+	#s.add_dependency('activesupport', '>=1.3.1')
+	#s.required_ruby_version = '>= 1.8.2'
+
+	s.files = %w(README Changelog Rakefile) +
+		Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+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
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "#{ENV["HOME"]}/coderepos/lang/ruby/rdoc/generators/template/html/resh/resh.rb"
+	#rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README', 'Changelog')
+		rdoc.rdoc_files.include('examples/simple.rb')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('ext/**/*.c')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'cho45').upload
+end
+
+desc "Publish to lab"
+task :publab do
+	require 'rake/contrib/sshpublisher'
+
+	path = File.expand_path(File.dirname(__FILE__))
+
+	Rake::SshDirPublisher.new(
+		"cho45@lab.lowreal.net",
+		"/srv/www/lab.lowreal.net/public/site-ruby",
+		path + "/pkg"
+	).upload
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+	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, NAME, VERS, *files
+end

data/examples/plugins/hoge_hoge.rb

@@ -0,0 +1,10 @@
+
+class HogeHoge
+	def init(parent)
+		@parent = parent
+	end
+
+	def say
+		"Hehe, I'm #{self.class} plugin of #{@parent}."
+	end
+end

data/examples/plugins/test.rb

@@ -0,0 +1,10 @@
+
+class Test
+	def init(parent)
+		@parent = parent
+	end
+
+	def say
+		"I'm #{self.class} plugin of #{@parent}."
+	end
+end

data/examples/simple.rb

@@ -0,0 +1,36 @@
+#!ruby -I../lib simple.rb
+
+require "module/pluggable"
+
+module Example
+
+	class SimplePluggable
+		# pluggable [name=:plugins] [opts]
+		# pluggable make the name of instance method
+		# returning instance of Module::Pluggable::Plugin.
+		#
+		# All loaded plugins are in anonymous module,
+		# so you can't access the classes directly,
+		# and you can create some plugin-sets
+		# without confusing class variables etc.
+		pluggable
+
+		#     plugins.init(self)
+		#
+		# `init' method is not defined on Module::Pluggable::Plugin.
+		# undefined methods are delegated to `call' the plugins.
+		# In this case, `plugins.init(self)' is same as `plugins.call(:init, self)'.
+		def initialize
+			plugins.init(self)
+		end
+
+		def say
+			plugins.each do |name, instance|
+				puts instance.say
+			end
+		end
+	end
+
+end
+
+Example::SimplePluggable.new.say

data/lib/module/pluggable.rb

@@ -0,0 +1,182 @@
+# Author::    cho45 <cho45@lowreal.net>
+# Copyright:: copyright (c) 2007 cho45 www.lowreal.net
+# License::   Ruby's
+
+require "pathname"
+
+module Module::Pluggable
+	DEFAULT_OPTS = {
+		:search_path => "plugins",
+		:except      => /_$/,
+		:base_class  => nil,
+	}.freeze
+
+	# pluggable make the name of instance method
+	# returning instance of Module::Pluggable::Plugin.
+	#
+	# All loaded plugins are in anonymous module,
+	# so you can't access the classes directly,
+	# and you can create some plugin-sets
+	# without confusing class variables etc.
+	# 
+	#     opts => {
+	#         :search_path => name,
+	#         :base_class => nil,
+	#         :except => /_$/, # not yet
+	#     }
+	def pluggable(name=:plugins, o={})
+		opts = DEFAULT_OPTS.merge(o)
+		opts[:search_path] = name ? name.to_s : opts[:name].to_s unless opts[:search_path]
+
+		class_eval <<-EOS
+			def #{name}
+				@#{name} ||= Module::Pluggable::Plugins.new(@@pluggable_opts[:#{name}])
+			end
+
+			def self.set_pluggable_opts(name, opts)
+				(@@pluggable_opts ||= {})[name] = opts
+			end
+		EOS
+		self.set_pluggable_opts(name, opts)
+		(class << self; self; end).instance_eval do
+			remove_method(:set_pluggable_opts)
+		end
+	end
+
+	class Plugins
+		include Enumerable
+
+		class PluginsError < StandardError; end
+		class ClassNotFoundError < PluginsError; end
+		class NotInheritAbstractClassError < PluginsError; end
+
+		def initialize(opts)
+			@opts  = opts
+			@dir   = Pathname.new(opts[:search_path])
+			@plugins = {}
+			reload
+		end
+
+		# Load +klass_name+.
+		# The plugin is loaded in anonymous module not order to
+		# destroy the environments.
+		# And remember loaded time for reloading.
+		#
+		# plugin filename must be interconversion with its class name.
+		# In this class, the conversion is do with +file2klass+/+klass2file+ methods.
+		def load(klass_name)
+			return if @plugins.include?(klass_name)
+			
+			filename = klass2file(klass_name)
+			
+			mod = Module.new
+			mod.module_eval(File.open("#{@opts[:search_path]}/#{filename}.rb") {|f| f.read}, filename)
+			
+			c = nil
+			begin
+				c = mod.const_get(klass_name)
+			rescue NameError
+				raise ClassNotFoundError.new("#{@opts[:search_path]}/#{filename} must include #{klass_name} class")
+			end
+			
+			if !@opts[:base_class] || c < @opts[:base_class]
+				@plugins[klass_name] = {
+					:instance => c.new,
+					:loaded   => Time.now,
+				}
+			else
+				raise NotInheritAbstractClassError.new("The class #{klass_name} must inherit #{@opts[:base_class]}")
+			end
+
+			@plugins[klass_name][:instance].on_load rescue NameError
+			@plugins[klass_name][:instance].instance_variable_set(:@plugins, self)
+			
+			klass_name
+		end
+
+		# Get instance of +klass_name+ plugin.
+		def [](klass_name)
+			@plugins[klass_name][:instance] if @plugins.key?(klass_name)
+		end
+		
+		# Unload +klass_name
+		def unload(klass_name)
+			if @plugins.key?(klass_name)
+				@plugins[klass_name][:instance].on_unload rescue NameError
+				@plugins.delete(klass_name)
+			end
+		end
+		
+		# Reload +klass_name+ or
+		# load unloaded plugins or
+		# reload modified plugins.
+		# returns [loaded, unloaded]
+		def reload(klass_name=nil)
+			if klass_name
+				unload(klass_name)
+				load(klass_name)
+				klass_name
+			else
+				loaded   = []
+				unloaded = []
+				Dir.glob("#{@opts[:search_path]}/*.rb") do |f|
+					klass_name = file2klass(File.basename(f, ".rb").sub(/^\d+/, ""))
+					if @plugins.include?(klass_name)
+						if File.mtime(f) > @plugins[klass_name][:loaded]
+							loaded << reload(klass_name)
+						end
+					else
+						loaded << reload(klass_name)
+					end
+				end
+				[loaded, unloaded]
+			end
+		end
+		
+		# Unload all plugins and reload it.
+		def force_reload
+			call(:on_unload)
+			@plugins.clear
+			reload
+		end
+		
+		# Iterates with plugin name and its instance.
+		def each(&block)
+			@plugins.each do |k,v|
+				yield k, v[:instance]
+			end
+		end
+		
+		# Call +name+ method of each plugins with +args+
+		# and returns Hash of the result and its plugin name.
+		def call(name, *args)
+			ret = {}
+			each do |k,v|
+				ret[k] = v.send(name, *args) if v.respond_to?(name)
+			end
+			ret
+		end
+
+		# Undefined methods are delegated to each plugins.
+		# This is alias of +call+
+		def method_missing(name, *args)
+			call(name, *args)
+		end
+
+		private
+		# convert foo/foo_bar to Foo::FooBar
+		def file2klass(str)
+			str.split("/").map {|c|
+				c.split(/_/).collect {|i| i.capitalize }.join("")
+			}.join("::")
+		end
+		
+		# convert Foo::FooBar to foo/foo_bar 
+		def klass2file(str)
+			str.split(/::/).map {|c|
+				c.scan(/[A-Z][a-z0-9]*/).join("_").downcase
+			}.join("/")
+		end
+	end
+end
+Class.instance_eval { include Module::Pluggable }

data/test/module-pluggable_test.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require "pathname"
+require "tmpdir"
+require "fileutils"
+
+class TestModulePluggable < Test::Unit::TestCase
+	def setup
+		@dir = Pathname.new(Dir.tmpdir) + "#{File.basename($0)}.#$$.#{rand(0xffffff)}"
+		@dir.mkpath
+		@test_dir = Pathname.new(File.dirname(__FILE__))
+		FileUtils.cp_r(@test_dir + "plugins", @dir)
+		@plugins_dir = @dir + "plugins"
+	end
+
+	def teardown
+		@dir.rmtree
+	end
+
+	def test_classname_conversion
+		m = Module::Pluggable::Plugins.new({:search_path => @plugins_dir})
+		assert_equal "foo_bar",     m.__send__(:klass2file, "FooBar")
+		assert_equal "FooBar",      m.__send__(:file2klass, "foo_bar")
+		assert_equal "foo/foo_bar", m.__send__(:klass2file, "Foo::FooBar")
+		assert_equal "Foo::FooBar", m.__send__(:file2klass, "foo/foo_bar")
+	end
+
+	def test_success
+		path = @plugins_dir
+		test = Class.new {
+			pluggable :plugins, :search_path => path
+		}.new
+		assert test.plugins["Test"]
+		assert_equal "This is test plugin.", test.plugins.call(:description)["Test"]
+
+		obj = Object.new
+		test.plugins.call(:instance_variable_set, :@test_obj, obj)
+		assert_equal obj, test.plugins["Test"].instance_variable_get(:@test_obj)
+		assert_equal test.plugins, test.plugins["Test"].foobar
+
+		assert_equal "This is test plugin.", test.plugins.description["Test"]
+
+		# inherit test
+		test = Class.new(test.class).new
+		assert test.plugins["Test"]
+		assert_equal "This is test plugin.", test.plugins.call(:description)["Test"]
+
+		test = Class.new {
+			pluggable :plugins, :search_path => "'"
+		}.new
+	end
+
+	def test_multi
+		path = @plugins_dir
+		test = Class.new {
+			pluggable :plugins, :search_path => path
+			pluggable :filters, :search_path => path
+		}.new
+		assert test.plugins["Test"]
+		assert_equal "This is test plugin.", test.plugins.call(:description)["Test"]
+		assert test.filters["Test"]
+		assert_equal "This is test plugin.", test.filters.call(:description)["Test"]
+	end
+
+	def test_inherit
+		path = @plugins_dir
+		assert_raise(Module::Pluggable::Plugins::NotInheritAbstractClassError) do
+			test = Class.new {
+				pluggable :plugins, :search_path => path, :base_class => PluginBase
+			}.new
+			test.plugins
+		end
+
+		testpl = path + "test.rb"
+		n = testpl.read.sub(/class Test/, "class Test < TestModulePluggable::PluginBase")
+		testpl.open("w") {|f| f.puts n }
+
+		assert_nothing_raised do
+			test = Class.new {
+				pluggable :plugins, :search_path => path, :base_class => PluginBase
+			}.new
+			test.plugins
+		end
+	end
+
+	class PluginBase
+		# Nice boat.
+	end
+end

data/test/plugins/test.rb

@@ -0,0 +1,10 @@
+
+class Test
+	def description
+		"This is test plugin."
+	end
+
+	def foobar
+		@plugins
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/module/pluggable'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: module-pluggable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-10-06 00:00:00 +09:00
+summary: ''
+require_paths: 
+  - lib
+email: cho45@lowreal.net
+homepage: http://modulepluggable.rubyforge.org
+rubyforge_project: modulepluggable
+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: 
+  - cho45
+files: 
+  - README
+  - Changelog
+  - Rakefile
+  - test/module-pluggable_test.rb
+  - test/plugins
+  - test/test_helper.rb
+  - test/plugins/test.rb
+  - lib/module
+  - lib/module/pluggable.rb
+  - examples/simple.rb
+  - examples/plugins/hoge_hoge.rb
+  - examples/plugins/test.rb
+test_files: 
+  - test/test_helper.rb
+rdoc_options: 
+  - "--quiet"
+  - "--title"
+  - module-pluggable documentation
+  - "--charset"
+  - utf-8
+  - "--opname"
+  - index.html
+  - "--line-numbers"
+  - "--main"
+  - README
+  - "--inline-source"
+  - "--exclude"
+  - "^(extras)/"
+extra_rdoc_files: 
+  - README
+  - Changelog
+executables: []
+extensions: []
+requirements: []
+dependencies: []