pluggability 0.0.1

data/spec/lib/helpers.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+# coding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
+}
+
+require 'rspec'
+require 'loggability/spechelpers'
+require 'pluggability'
+
+
+
+### Mock with Rspec
+RSpec.configure do |config|
+	ruby_version_vec = RUBY_VERSION.split('.').map {|c| c.to_i }.pack( "N*" )
+
+	config.include( Loggability::SpecHelpers )
+	config.treat_symbols_as_metadata_keys_with_true_values = true
+
+	config.mock_with :rspec
+end
+
+
+# vim: set nosta noet ts=4 sw=4:
+

data/spec/pluggability_spec.rb

@@ -0,0 +1,198 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'rspec'
+require 'logger'
+require 'pluggability'
+
+require 'spec/lib/helpers'
+
+class Plugin
+	extend Pluggability
+	plugin_prefixes 'plugins', 'plugins/private'
+end
+
+class SubPlugin < Plugin; end
+class TestingPlugin < Plugin; end
+class BlackSheep < Plugin; end
+module Test
+	class LoadablePlugin < Plugin; end
+end
+
+
+describe Pluggability do
+
+	before( :each ) do
+		setup_logging( :fatal )
+	end
+
+	after( :each ) do
+		reset_logging()
+	end
+
+
+	it "allows extended objects to declare one or more prefixes to use when requiring derviatives" do
+		Plugin.plugin_prefixes.should == ['plugins', 'plugins/private']
+	end
+
+
+
+	context "-extended class" do
+
+		it "knows about all of its derivatives" do
+			Plugin.derivatives.keys.should include( 'sub' )
+			Plugin.derivatives.keys.should include( 'subplugin' )
+			Plugin.derivatives.keys.should include( 'SubPlugin' )
+			Plugin.derivatives.keys.should include( SubPlugin )
+		end
+
+		it "returns derivatives directly if they're already loaded" do
+			class AlreadyLoadedPlugin < Plugin; end
+			Kernel.should_not_receive( :require )
+			Plugin.create( 'alreadyloaded' ).should be_an_instance_of( AlreadyLoadedPlugin )
+			Plugin.create( 'AlreadyLoaded' ).should be_an_instance_of( AlreadyLoadedPlugin )
+			Plugin.create( 'AlreadyLoadedPlugin' ).should be_an_instance_of( AlreadyLoadedPlugin )
+			Plugin.create( AlreadyLoadedPlugin ).should be_an_instance_of( AlreadyLoadedPlugin )
+		end
+
+		it "filters errors that happen when creating an instance of derivatives so they " +
+			"point to the right place" do
+			class PugilistPlugin < Plugin
+				def initialize
+					raise "Oh noes -- an error!"
+				end
+			end
+
+			exception = nil
+			begin
+				Plugin.create('pugilist')
+			rescue ::RuntimeError => err
+				exception = err
+			else
+				fail "Expected an exception to be raised."
+			end
+
+			exception.backtrace.first.should =~ /#{__FILE__}/
+		end
+
+		it "will refuse to create an object other than one of its derivatives" do
+			class Doppelgaenger; end
+			expect {
+				Plugin.create(Doppelgaenger)
+			}.to raise_error( ArgumentError, /is not a descendent of/ )
+		end
+
+
+		it "will load new plugins from the require path if they're not loaded yet" do
+			loaded_class = nil
+
+			Plugin.should_receive( :require ).with( 'plugins/dazzle_plugin' ).and_return do |*args|
+				loaded_class = Class.new( Plugin )
+				# Simulate a named class, since we're not really requiring
+				Plugin.derivatives['dazzle'] = loaded_class 
+				true
+			end
+
+			Plugin.create( 'dazzle' ).should be_an_instance_of( loaded_class )
+		end
+
+
+		it "will output a sensible description of what it tried to load if requiring a " +
+			"derivative fails" do
+
+			# at least 6 -> 3 variants * 2 paths
+			Plugin.should_receive( :require ).
+				at_least(6).times.
+				and_return {|path| raise LoadError, "path" }
+
+			expect {
+				Plugin.create('scintillating')
+			}.to raise_error( Pluggability::FactoryError, /couldn't find a \S+ named \S+.*tried \[/i )
+		end
+
+
+		it "will output a sensible description when a require succeeds, but it loads something unintended" do
+			# at least 6 -> 3 variants * 2 paths
+			Plugin.should_receive( :require ).and_return( true )
+
+			expect {
+				Plugin.create('corruscating')
+			}.to raise_error( Pluggability::FactoryError, /Require of '\S+' succeeded, but didn't load a Plugin/i )
+		end
+
+
+		it "will re-raise the first exception raised when attempting to load a " +
+			"derivative if none of the paths work" do
+
+			# at least 6 -> 3 variants * 2 paths
+			Plugin.should_receive( :require ).at_least(6).times.and_return {|path|
+				raise ScriptError, "error while parsing #{path}"
+			}
+
+			expect {
+				Plugin.create('portable')
+			}.to raise_error( ScriptError, /error while parsing/ )
+		end
+
+
+		it "can preload all of its derivatives" do
+			Gem.should_receive( :find_files ).with( 'plugins/*.rb' ).
+				and_return([ 'plugins/first.rb' ])
+			Gem.should_receive( :find_files ).with( 'plugins/private/*.rb' ).
+				and_return([ 'plugins/private/second.rb', 'plugins/private/third.rb' ])
+
+			Plugin.should_receive( :require ).with( 'plugins/first.rb' ).
+				and_return( true )
+			Plugin.should_receive( :require ).with( 'plugins/private/second.rb' ).
+				and_return( true )
+			Plugin.should_receive( :require ).with( 'plugins/private/third.rb' ).
+				and_return( true )
+			
+			Plugin.load_all
+		end
+	end
+
+
+	context "derivative of an extended class" do
+
+		it "knows what type of factory loads it" do
+			TestingPlugin.factory_type.should == 'Plugin'
+		end
+
+		it "raises a FactoryError if it can't figure out what type of factory loads it" do
+			TestingPlugin.stub!( :ancestors ).and_return( [] )
+			expect {
+				TestingPlugin.factory_type
+			}.to raise_error( Pluggability::FactoryError, /couldn't find factory base/i )
+		end
+	end
+
+
+	context "derivative of an extended class that isn't named <Something>Plugin" do
+
+		it "is still creatable via its full name" do
+			Plugin.create( 'blacksheep' ).should be_an_instance_of( BlackSheep )
+		end
+
+	end
+
+
+	context "derivative of an extended class in another namespace" do
+
+		it "is still creatable via its derivative name" do
+			Plugin.create( 'loadable' ).should be_an_instance_of( Test::LoadablePlugin )
+		end
+
+	end
+
+end
+

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: pluggability
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Martin Chase
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURMRENDQWhTZ0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREE4TVF3d0NnWURWUVFEREFOblpX
+  UXgKRnpBVkJnb0praWFKay9Jc1pBRVpGZ2RmWVdWeWFXVmZNUk13RVFZS0Na
+  SW1pWlB5TEdRQkdSWURiM0puTUI0WApEVEV3TURreE5qRTBORGcxTVZvWERU
+  RXhNRGt4TmpFME5EZzFNVm93UERFTU1Bb0dBMVVFQXd3RFoyVmtNUmN3CkZR
+  WUtDWkltaVpQeUxHUUJHUllIWDJGbGNtbGxYekVUTUJFR0NnbVNKb21UOGl4
+  a0FSa1dBMjl5WnpDQ0FTSXcKRFFZSktvWklodmNOQVFFQkJRQURnZ0VQQURD
+  Q0FRb0NnZ0VCQUx5Ly9CRnhDMWYvY1BTbnd0SkJXb0ZpRnJpcgpoN1JpY0kr
+  am9xL29jVlhRcUk0VERXUHlGLzh0cWt2dCtyRDk5WDlxczJZZVI4Q1UvWWlJ
+  cExXclFPWVNUNzBKCnZEbjdVdmhiMm11RlZxcTYrdm9iZVRrSUxCRU82cGlv
+  bldERzhqU2JvM3FLbTFSaktKRHdnOXA0d05LaFB1dTgKS0d1ZS9CRmI2N0tm
+  bHF5QXBQbVBlYjNWZGQ5Y2xzcHpxZUZxcDdjVUJNRXBGUzZMV3h5NEdrK3F2
+  RkZKQkpMQgpCVUhFL0xaVkpNVnpmcEM1VXErUW1ZN0IrRkgvUXFObmRuM3RP
+  SGdzUGFkTFROaW11QjFzQ3VMMWE0ejNQZXBkClRlTEJFRm1FYW81RGszSy9R
+  OG84dmxiSUIvakJEVFV4NkRqYmd4dzc3OTA5eDZnSTlkb1U0TEQ1WE1jQ0F3
+  RUEKQWFNNU1EY3dDUVlEVlIwVEJBSXdBREFMQmdOVkhROEVCQU1DQkxBd0hR
+  WURWUjBPQkJZRUZKZW9Ha09yOWw0Qgorc2FNa1cvWlhUNFVlU3ZWTUEwR0NT
+  cUdTSWIzRFFFQkJRVUFBNElCQVFCRzJLT2J2WUkyZUh5eUJVSlNKM2pOCnZF
+  blUzZDYwem5BWGJyU2QycWIzcjFsWTFFUEREM2JjeTBNZ2dDZkdkZzNYdTU0
+  ejIxb3F5SWRrOHVHdFdCUEwKSElhOUVnZkZHU1VFZ3ZjSXZhWXFpTjRqVFV0
+  aWRmRUZ3K0x0anM4QVA5Z1dnU0lZUzZHcjM4VjBXR0ZGTnpJSAphT0Qyd211
+  OW9vL1JmZlc0aFMvOEd1dmZNemN3N0NRMzU1d0ZSNEtCL255emUrRXNaMVk1
+  RGVyQ0FhZ01WdURRClUwQkxtV0RGelBHR1dsUGVRQ3JZSENyK0FjSnorTlJu
+  YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
+  Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
+  cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: hoe-mercurial
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: hoe-highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: hoe-deveiate
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ! 'Pluggability is a mixin module that turns an including class into
+  a factory for
+
+  its derivatives, capable of searching for and loading them by name. This is
+
+  useful when you have an abstract base class which defines an interface and basic
+
+  functionality for a part of a larger system, and a collection of subclasses
+
+  which implement the interface for different underlying functionality.
+
+
+  An example of where this might be useful is in a program which talks to a
+
+  database. To avoid coupling it to a specific database, you use a Driver class
+
+  which encapsulates your program''s interaction with the database behind a useful
+
+  interface. Now you can create a concrete implementation of the Driver class for
+
+  each kind of database you wish to talk to. If you make the base Driver class a
+
+  Pluggability, too, you can add new drivers simply by dropping them in a
+
+  directory and using the Driver''s `create` method to instantiate them:'
+email:
+- stillflame@FaerieMUD.org
+- ged@FaerieMUD.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- ChangeLog
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/pluggability.rb
+- spec/lib/helpers.rb
+- spec/pluggability_spec.rb
+- .gemtest
+homepage: http://deveiate.org/projects/Pluggability
+licenses:
+- BSD
+post_install_message: 
+rdoc_options:
+- -f
+- fivefish
+- -t
+- Pluggability Toolkit
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: pluggability
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Pluggability is a mixin module that turns an including class into a factory
+  for its derivatives, capable of searching for and loading them by name
+test_files: []

metadata.gz.sig

@@ -0,0 +1 @@
+�.�(,�����}����D�����Y�9�1�ڑ�ղ^��T1n˿���v�7�L�`!v~�<p�#�"�)Ir=�J��/����^�L]ʴW��cWO(v�<�<l8O��oո��P�����B��қ����^0C3�i�X
4N��I�E���kS�������qhW���M��S���f��F?���l���,i �0�4����*������wF8Z��dI�K�.�C�Z/�Ï.1O�c�k