Changeset 385 for lang/ruby/module-pluggable

Timestamp:

10/06/07 08:55:05 (4 years ago)

Author:

cho45

Message:

lang/ruby/module-pluggable/Rakefile,
lang/ruby/module-pluggable/lib/module/pluggable.rb,
lang/ruby/module-pluggable/README,
lang/ruby/module-pluggable/examples/simple.rb,

ドキュメントの更新

lang/ruby/module-pluggable/lib/module/pluggable.rb:

klass2file/file2klass を private に

Location:

lang/ruby/module-pluggable

Files:

• README (modified) (1 diff)
• Rakefile (modified) (2 diffs)
• examples/simple.rb (modified) (1 diff)
• lib/module/pluggable.rb (modified) (10 diffs)

lang/ruby/module-pluggable/README

@@ -1 @@
-README for module-pluggable
-===========================
+= README for module-pluggable
 
-see examples.
+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

lang/ruby/module-pluggable/Rakefile

@@ -45 +45 @@
         s.has_rdoc = true
         s.extra_rdoc_files = ["README", "Changelog"]
-        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(extras)/']
         s.summary = DESCRIPTION
         s.description = DESCRIPTION
@@ -95 +95 @@
         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')

lang/ruby/module-pluggable/examples/simple.rb

@@ -3 +3 @@
 require "module/pluggable"
 
-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
+module Example
 
-        def initialize
+        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)'.
-                plugins.init(self)
+                def initialize
+                        plugins.init(self)
+                end
+
+                def say
+                        plugins.each do |name, instance|
+                                puts instance.say
+                        end
+                end
         end
 
-        def say
-                plugins.each do |name, instance|
-                        puts instance.say
-                end
-        end
 end
 
-SimplePluggable.new.say
+Example::SimplePluggable.new.say

lang/ruby/module-pluggable/lib/module/pluggable.rb

@@ -1 @@
-
-#require "module/pluggable"
+# Author::    cho45 <cho45@lowreal.net>
+# Copyright:: copyright (c) 2007 cho45 www.lowreal.net
+# License::   Ruby's
 
 require "pathname"
@@ -11 +12 @@
         }.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)
@@ -44 +58 @@
                 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)
@@ -74 +95 @@
                 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)
@@ -85 +108 @@
                 end
                 
+                # Reload +klass_name+ or
+                # load unloaded plugins or
+                # reload modified plugins.
+                # returns [loaded, unloaded]
                 def reload(klass_name=nil)
                         if klass_name
@@ -107 +134 @@
                 end
                 
+                # Unload all plugins and reload it.
                 def force_reload
                         call(:on_unload)
@@ -113 +141 @@
                 end
                 
+                # Iterates with plugin name and its instance.
                 def each(&block)
                         @plugins.each do |k,v|
@@ -119 +148 @@
                 end
                 
+                # Call +name+ method of each plugins with +args+
+                # and returns Hash of the result and its plugin name.
                 def call(name, *args)
                         ret = {}
@@ -127 +158 @@
                 end
 
+                # Undefined methods are delegated to each plugins.
+                # This is alias of +call+
                 def method_missing(name, *args)
                         call(name, *args)
                 end
 
-                # foo/foo_bar => Foo::FooBar
+                private
+                # convert foo/foo_bar to Foo::FooBar
                 def file2klass(str)
                         str.split("/").map {|c|
@@ -138 +172 @@
                 end
                 
-                # Foo::FooBar => foo/foo_bar 
+                # convert Foo::FooBar to foo/foo_bar 
                 def klass2file(str)
                         str.split(/::/).map {|c|