pluggable 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andrew C. Greenberg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,102 @@
+= pluggable
+
+Pluggable is a mixin for classes requiring plugins.  Including *Pluggable* adds several methods:
+
+[*install_plugins*] Should generally be called when initializing an instance of the Pluggable class.
+[*plugins*] After initialization, returns a list of plugin instances
+
+For example:
+
+	require 'rubygems'
+	require 'pluggable'
+	class Test
+		include Pluggable
+		def initialize; install_plugins; end
+		def process; plugins.map {|plugin| plugin.process}; end
+	end
+
+	class Plugin1 < Test::Plugin
+		def process; "foo"; end
+	end
+
+	class Plugin2 < Test::Plugin
+		def process; "bar"; end
+	end
+	
+	Test.new.process # => ["foo", "bar"]	
+
+It may be convenient to have public methods of plugins delegated to from the +plugins+ object, which may in turn be delgated to by the +Pluggable+ class in various ways.  This is accomplished with the class method *delegate_plugin_public_methods_except*, which should be called after loading all of the plugins. For example:
+
+	require 'rubygems'
+	require 'pluggable'
+	class Test
+		include Pluggable
+		def initialize; install_plugins; end
+		def process; plugins.map {|plugin| plugin.process}; end
+	end
+
+	class Plugin1 < Test::Plugin
+		def foo; "foo"; end
+		def process; foo; end
+	end
+
+	class Plugin2 < Test::Plugin
+		def bar; "bar"; end
+		def process; bar; end
+	end
+
+	Test.delegate_plugin_public_methods_except :process
+	
+	Test.new.process # => ["foo", "bar"]
+	Test.new.plugins.foo # => "foo"
+	Test.new.plugins.bar # => "bar"
+	
+Finally, it may be useful to establish an API for plugins in the form of a traditional Ruby module.  The module may be included into the plugins using the class method *plugin_install_methods, which may be called in the Pluggable class definition.  For example:
+
+	require 'rubygems'
+	require 'pluggable'
+	module PluginAPI
+	  def initialize(one, two, three); end
+	  def first; "first"; end
+	  def second; private_second; end
+	  module ClassMethods
+	    def class_first; "class_first"; end
+	  end
+	  private
+	  def private_second; "second"; end
+	  def self.included(klass)
+	    klass.extend ClassMethods
+	  end
+	end
+
+	class Test
+		include Pluggable
+		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
+		  plugins.send(symbol, *args)
+		end
+	end
+	
+	require 'plugin_definitions'
+
+	Test.new.plugins.first.first # => "first"
+	Test.new.plugins.first.second # => "second"
+	Test.new.plugins.first.class.class_first # => "class_first"
+	
+And of course, the plugins may override the API definitions.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Andrew C. Greenberg. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pluggable"
+    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"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pluggable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/pluggable.rb

@@ -0,0 +1,75 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'singleton'
+require 'forwardable'
+module Pluggable
+  
+  class Plugins < Array
+    extend Forwardable
+    def self.from_array_of_instance_and_name_pairs array
+      result = new
+      array.each do |each_pair| 
+        result << each_pair[:instance]
+        result.instance_variable_set each_pair[:name], each_pair[:instance]
+      end
+      result
+    end
+  end
+  
+  class PluginFactory < Array
+    include Singleton
+    def build_plugins(*args)
+      array_of_instance_and_name_pairs = map do |each| 
+        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}
+      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
+      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
+  
+  class Plugin
+    def self.inherited(klass)
+      PluginFactory.instance << klass
+  	end
+  end
+  
+  def install_plugins(*args)
+    instance_variable_set :@pluggable_module_plugins, PluginFactory.instance.build_plugins(*args)
+  end
+
+  def plugins
+    instance_variable_get :@pluggable_module_plugins
+  end
+
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def plugin_factory
+      PluginFactory.instance
+    end
+    def delegate_plugin_public_methods_except *excluded_methods
+      PluginFactory.instance.delegate_plugin_public_methods_to_plugins_class_except *excluded_methods
+    end
+    def plugin_include_module mod
+      Plugin.class_eval "include #{mod.to_s}"
+    end
+  end
+end

data/pluggable.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pluggable}
+  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-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",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/pluggable.rb",
+     "pluggable.gemspec",
+     "spec/pluggable_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/wizardwerdna/pluggable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Pluggable is a mixin for classes requiring plugins.}
+  s.test_files = [
+    "spec/pluggable_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/spec/pluggable_spec.rb

@@ -0,0 +1,189 @@
+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
+    def class_first; "class_first"; end
+  end
+  private
+  def private_second; "second"; end
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+end
+
+class Test
+  include Pluggable
+  plugin_include_module PluginAPI
+  def process
+    plugins.map{|each| each.process}
+  end
+  private
+  def method_missing symbol, *args
+    plugins.send(symbol, *args)
+  end
+end
+
+class Plugin1 < Test::Plugin
+  def foo; "foo"; end
+  def process; foo; end
+  private 
+  def exception_private; end
+end
+
+class Plugin2 < Test::Plugin
+  def bar; "bar"; end
+  def process; bar; end
+  private
+  def exception_private; end
+end
+
+class Plugin3 < Test::Plugin
+  def baz; "baz"; end
+  def process; baz; end
+  private
+  def exception_private; end
+end
+
+if Test.respond_to? :delegate_plugin_public_methods_except
+  Test.delegate_plugin_public_methods_except :exception_public, :one, :two, :three, :initialize
+end
+
+
+describe Pluggable, "when included in a class" do
+  
+  before(:each) do
+    @test_instance = Test.new
+  end
+  
+  it "should install a class method #plugin_factory, an array of all the plugin classes" do
+    Test.should respond_to(:plugin_factory)
+    Test.plugin_factory.should have(3).items
+    Test.plugin_factory.should include(Plugin1, Plugin2, Plugin3)
+  end
+    
+  it "should install a class method #delegate_plugin_public_methods_except" do
+    Test.should respond_to(:delegate_plugin_public_methods_except)
+  end
+  
+  it "should install a class method #plugin_include_module" do
+    Test.should respond_to(:plugin_include_module)
+  end
+
+  it "should add a method #plugins that should be nil upon creation" do
+    @test_instance.should respond_to(:plugins)
+    @test_instance.plugins.should be_nil
+  end
+  
+  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(:one, :two, :three)
+  end
+  
+  it "should have #plugins answer an object containing a collection of new plugin instances after #install_plugins" do
+    @test_instance.should_not be_nil
+    @test_instance.plugins.should_not be_nil
+    @test_instance.plugins.should be_an_instance_of(Test::Plugins)
+    @test_instance.plugins.should have(3).items
+    @test_instance.plugins.map{|each| each.class}.should include(Plugin1, Plugin2, Plugin3)
+  end
+  
+  it "should have #plugins answer an object containing a collection of new plugin instances after #install_plugins a second time" do
+    @test_instance.should_not be_nil
+    @test_instance.plugins.should_not be_nil
+    @test_instance.plugins.should be_an_instance_of(Test::Plugins)
+    @test_instance.plugins.should have(3).items
+    @test_instance.plugins.map{|each| each.class}.should include(Plugin1, Plugin2, Plugin3)
+  end
+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(:one, :two, :three)
+  end
+
+  it "should delegate public methods of plugins" do
+    @test_instance.plugins.should respond_to(:foo)
+    @test_instance.plugins.should respond_to(:bar)
+    @test_instance.plugins.should respond_to(:baz)
+    @test_instance.plugins.foo.should == "foo"
+    @test_instance.plugins.bar.should == "bar"
+    @test_instance.plugins.baz.should == "baz"
+  end
+  
+  it "should not delegate excepted public methods of plugins" do
+    @test_instance.plugins.should_not respond_to(:exception_public)
+    @test_instance.should_not respond_to(:exception_public)
+  end
+  
+  it "should not delegate private methods of plugins" do
+    @test_instance.plugins.should_not respond_to(:exception_private)
+    @test_instance.should_not respond_to(:exception_private)
+  end
+end
+
+describe Test::Plugin, "after Test has included a module" do
+  it "should have the instance methods of the module" do
+    Test::Plugin.instance_methods.should include(*PluginAPI.instance_methods)
+  end
+  
+  it "should have the class methods of the module" do
+    Test::Plugin.methods.should include(*PluginAPI::ClassMethods.instance_methods)
+  end
+end
+
+describe Test::PluginFactory, "instances" do
+  before(:each) do
+    @instance = Test::PluginFactory.instance
+  end
+  
+  it "should be an array of all the plugins" do
+    @instance.should have(3).items
+    @instance.should include(Plugin1, Plugin2, Plugin3)
+  end
+  
+  it "should build a Plugins object with fresh instances of each plugin" do
+    @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)
+  end
+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(:one, :two, :three)
+  end
+
+  it "should properly process using all the plugins" do
+    @test_instance.process.should == ["foo", "bar", "baz"]
+  end
+
+  it "should delegate public methods of plugins" do
+    @test_instance.foo.should == "foo"
+    @test_instance.bar.should == "bar"
+    @test_instance.baz.should == "baz"
+  end
+  
+  it "should work with included module procedures" do
+    @test_instance.plugins.first.first.should == "first"
+    @test_instance.plugins.first.second.should == "second"
+    @test_instance.plugins.first.class.class_first.should == "class_first"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'pluggable'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: pluggable
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Andrew C. Greenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-21 00:00:00 -07: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: "0"
+    version: 
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pluggable.rb
+- pluggable.gemspec
+- spec/pluggable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/wizardwerdna/pluggable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pluggable is a mixin for classes requiring plugins.
+test_files: 
+- spec/pluggable_spec.rb
+- spec/spec_helper.rb