wizardwerdna-pluggable 0.2.0 → 0.3.0

data/README.rdoc

@@ -56,6 +56,7 @@ Finally, it may be useful to establish an API for plugins in the form of a tradi
 	require 'rubygems'
 	require 'pluggable'
 	module PluginAPI
+	  def initialize(one, two, three); end
 	  def first; "first"; end
 	  def second; private_second; end
 	  module ClassMethods
@@ -70,7 +71,7 @@ Finally, it may be useful to establish an API for plugins in the form of a tradi
 
 	class Test
 		include Pluggable
-		def initialize; install_plugins; end
+		def initialize; install_plugins(:one, :two, :three); end # arity must match initialize methods for all plugins
 		def process; plugins.map {|plugin| plugin.process}; end
 		private
 		def method_missing symbol, *args

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "pluggable"
-    gem.summary = %Q{TODO: one-line summary of your gem}
-    gem.description = %Q{TODO: longer description of your gem}
+    gem.summary = %Q{Pluggable is a mixin for classes requiring plugins.}
+    gem.description = %Q{Pluggable classes are automatically registered from classes that subclass from <classname>::Plugin, and can use tools for managing, installing and delegating methods therefrom.}
     gem.email = "wizardwerdna@gmail.com"
     gem.homepage = "http://github.com/wizardwerdna/pluggable"
     gem.authors = ["Andrew C. Greenberg"]
@@ -45,4 +45,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "pluggable #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/pluggable.rb

@@ -19,24 +19,27 @@ module Pluggable
   
   class PluginFactory < Array
     include Singleton
-    def build_plugins
+    def build_plugins(*args)
       array_of_instance_and_name_pairs = map do |each| 
-        instance = each.new
+        instance = each.new(*args)
         {:name => variable_name_for_plugin_instance(instance), :instance => instance}
       end
       Plugins.from_array_of_instance_and_name_pairs(array_of_instance_and_name_pairs)
     end
     def delegate_plugin_public_methods_to_plugins_class_except *excluded_methods
       excluded_methods = excluded_methods.map{|each| each.to_s}
-      build_plugins.each do |instance|
-        delegated_methods = instance.public_methods-Plugin.public_instance_methods-excluded_methods
-        variable_name = variable_name_for_plugin_instance instance
+      each do |klass|
+        delegated_methods = klass.public_instance_methods-Plugin.public_instance_methods-excluded_methods
+        variable_name = variable_name_for_plugin_class klass
         Plugins.def_delegators variable_name, *delegated_methods
       end
     end
     private
     def variable_name_for_plugin_instance instance
-      "@ivar_for_#{instance.class.to_s}".gsub(/::/) {'_colons_'}.to_sym
+      variable_name_for_plugin_class instance.class
+    end
+    def variable_name_for_plugin_class klass
+      "@ivar_for_#{klass.to_s}".gsub(/::/) {'_colons_'}.to_sym
     end
   end
   
@@ -46,8 +49,8 @@ module Pluggable
   	end
   end
   
-  def install_plugins
-    instance_variable_set :@pluggable_module_plugins, PluginFactory.instance.build_plugins
+  def install_plugins(*args)
+    instance_variable_set :@pluggable_module_plugins, PluginFactory.instance.build_plugins(*args)
   end
 
   def plugins

data/pluggable.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pluggable}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew C. Greenberg"]
-  s.date = %q{2009-08-20}
-  s.description = %q{TODO: longer description of your gem}
+  s.date = %q{2009-08-21}
+  s.description = %q{Pluggable classes are automatically registered from classes that subclass from <classname>::Plugin, and can use tools for managing, installing and delegating methods therefrom.}
   s.email = %q{wizardwerdna@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{TODO: one-line summary of your gem}
+  s.summary = %q{Pluggable is a mixin for classes requiring plugins.}
   s.test_files = [
     "spec/pluggable_spec.rb",
      "spec/spec_helper.rb"

data/spec/pluggable_spec.rb

@@ -2,6 +2,7 @@ require 'forwardable'
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
 module PluginAPI
+  def initialize(one, two, three); end
   def first; "first"; end
   def second; private_second; end
   module ClassMethods
@@ -48,7 +49,7 @@ class Plugin3 < Test::Plugin
 end
 
 if Test.respond_to? :delegate_plugin_public_methods_except
-  Test.delegate_plugin_public_methods_except :exception_public
+  Test.delegate_plugin_public_methods_except :exception_public, :one, :two, :three, :initialize
 end
 
 
@@ -80,12 +81,17 @@ describe Pluggable, "when included in a class" do
   it "should add a method #install_plugins" do
     Test.new.should respond_to(:install_plugins)
   end
+  
+  it "should properly instantiate plugins upon a call to #install_plugins" do
+    [Plugin1, Plugin2, Plugin3].each{|each| each.should_receive(:new).with(:one, :two, :three)}
+    Test.new.install_plugins(:one, :two, :three)
+  end
 end
 
 describe Pluggable, "after installing plugins" do
   before(:each) do
     @test_instance = Test.new
-    @test_instance.install_plugins
+    @test_instance.install_plugins(:one, :two, :three)
   end
   
   it "should have #plugins answer an object containing a collection of new plugin instances after #install_plugins" do
@@ -108,7 +114,7 @@ end
 describe Pluggable, "after Test has delegated all but excepted plugin public methods" do
   before(:each) do
     @test_instance = Test.new
-    @test_instance.install_plugins
+    @test_instance.install_plugins(:one, :two, :three)
   end
 
   it "should delegate public methods of plugins" do
@@ -152,7 +158,7 @@ describe Test::PluginFactory, "instances" do
   end
   
   it "should build a Plugins object with fresh instances of each plugin" do
-    @installed_plugins = @instance.build_plugins
+    @installed_plugins = @instance.build_plugins(:one, :two, :three)
     @installed_plugins.should be_a_kind_of(Test::Plugins)
     @installed_plugins.should have(3).items
     @installed_plugins.map{|each| each.class}.should include(Plugin1, Plugin2, Plugin3)
@@ -162,7 +168,7 @@ end
 describe Test, "when using message_missing to simulate delegation from the parent" do
   before(:each) do
     @test_instance = Test.new
-    @test_instance.install_plugins
+    @test_instance.install_plugins(:one, :two, :three)
   end
 
   it "should properly process using all the plugins" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wizardwerdna-pluggable
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Andrew C. Greenberg
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-20 00:00:00 -07:00
+date: 2009-08-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: "TODO: longer description of your gem"
+description: Pluggable classes are automatically registered from classes that subclass from <classname>::Plugin, and can use tools for managing, installing and delegating methods therefrom.
 email: wizardwerdna@gmail.com
 executables: []
 
@@ -68,7 +68,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: "TODO: one-line summary of your gem"
+summary: Pluggable is a mixin for classes requiring plugins.
 test_files: 
 - spec/pluggable_spec.rb
 - spec/spec_helper.rb