pluggability 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4a48369fcbed3a05f6c1d709edf28215bc7a69f
-  data.tar.gz: 71d8323ae8af471d64796aebdb53814c12b34d79
+  metadata.gz: 6657aec37785ba2a1d1b7be5f114acf4924000bc
+  data.tar.gz: b86d76b06fa680fee6fb5288de1058340d67910d
 SHA512:
-  metadata.gz: 5d7eaa318bd1a7b45a0e704ea1c8e3b10c290551a407c7334ff92b1e065fa5fd89e6a3fdf9036018edd5fc75be5ec5110b5a39542090b6b158da1ec74cc20d01
-  data.tar.gz: 930077f441537a74d322f7ef28ac2be40c2031194bfc31e67d6f6ec723029627a48af8d86bf5cb6a7eacf2f3f2291a643bdecb22ad1f2254daea3db8b47d8b37
+  metadata.gz: 91f428c726410e0e67fb3a5c9e83f2782e97aba1adfdbadffc38729a0bafe9c867ec18b9f75540675e8a325776a0d073ca25214e612d90015f113afdf4432aab
+  data.tar.gz: 6b332d73c7d3abd9fb3ae481eed77931eca4760a8bb37371cb9925b5556ecc78ae4a4ec0d1fa8388da4b168ce69a3c0f0940f01725f813780d741d7b941a3b1e

data/ChangeLog

@@ -23,7 +23,7 @@
 	[f66a50774525]
 
 	* lib/pluggability.rb, spec/pluggability_spec.rb:
-	Fix specs for FactoryError changes; add backward-compatibility
+	Fix specs for PluginError changes; add backward-compatibility
 	constant.
 	[379015772893] [v0.0.1]
 
@@ -329,7 +329,7 @@
 	[7ef14552ab3d]
 
 	* lib/pluginfactory.rb:
-	- Made load failures raise FactoryErrors as intended instead of
+	- Made load failures raise PluginErrors as intended instead of
 	RuntimeErrors.
 	[e95a4103ceff]
 
@@ -416,7 +416,7 @@
 	[bdfc3046476d]
 
 	* lib/pluginfactory.rb:
-	FactoryError now inherits from RuntimeError
+	PluginError now inherits from RuntimeError
 	[fff45f7bd617]
 
 	* test.rb:
@@ -578,7 +578,7 @@
 	[b83ace0e5210]
 
 	* lib/pluginfactory.rb:
-	- Made load failures raise FactoryErrors as intended instead of
+	- Made load failures raise PluginErrors as intended instead of
 	RuntimeErrors.
 	[ee1c6ed5d684]
 
@@ -665,7 +665,7 @@
 	[48a6ad672ee6]
 
 	* lib/pluginfactory.rb:
-	FactoryError now inherits from RuntimeError
+	PluginError now inherits from RuntimeError
 	[3bbead1f4ca4]
 
 	* test.rb:

data/History.rdoc

@@ -1,3 +1,10 @@
+== v0.2.0 [2013-03-28] Michael Granger <ged@FaerieMUD.org>
+
+- Fix loading of grandchildren of plugins
+- Rename Pluggability::FactoryError to 
+  Pluggability::PluginError (with backward-compatibility aliases)
+
+
 == v0.1.0 [2013-03-27] Michael Granger <ged@FaerieMUD.org>
 
 - Add loading via underbarred name variants (CommaDelimitedThing ->

data/README.rdoc

@@ -141,7 +141,7 @@ will change the search to include:
     'datadriver/apache'
     'datadriver/Apache'
 
-If the plugin is not found, a Pluggability::FactoryError is raised, and
+If the plugin is not found, a Pluggability::PluginError is raised, and
 the message will list all the permutations that were tried.
 
 
@@ -215,7 +215,7 @@ and generate the API documentation.
 
 == License
 
-Copyright (c) 2008-2012, Michael Granger and Martin Chase
+Copyright (c) 2008-2013, Michael Granger and Martin Chase
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -12,14 +12,15 @@ hoespec = Hoe.spec 'pluggability' do
 	self.readme_file = 'README.rdoc'
 	self.history_file = 'History.rdoc'
 	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
-	self.spec_extras[:rdoc_options] = ['-f', 'fivefish', '-t', 'Pluggability Toolkit']
+	self.spec_extras[:rdoc_options] = ['-t', 'Pluggability Toolkit']
+	self.spec_extras[:rdoc_options] += [ '-f', 'fivefish' ] if File.directory?( '.hg' )
 
 	self.developer 'Martin Chase', 'stillflame@FaerieMUD.org'
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	self.dependency 'loggability', '~> 0.5'
+	self.dependency 'loggability', '~> 0.6'
 
-	self.dependency 'hoe-deveiate', '~> 0.1', :development
+	self.dependency 'hoe-deveiate', '~> 0.2', :development
 
 	self.spec_extras[:licenses] = ["BSD"]
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )

data/lib/pluggability.rb

@@ -12,25 +12,48 @@ module Pluggability
 
 
 	# Library version
-	VERSION = '0.1.0'
+	VERSION = '0.2.0'
 
 
-	### An exception class for Pluggability specific errors.
-	class FactoryError < RuntimeError; end
+	# An exception class for Pluggability specific errors.
+	class PluginError < RuntimeError; end
+	FactoryError = PluginError
 
 
 	### Add the @derivatives instance variable to including classes.
 	def self::extend_object( obj )
 		obj.instance_variable_set( :@plugin_prefixes, [] )
 		obj.instance_variable_set( :@derivatives, {} )
+
+		Pluggability.pluggable_classes << obj
+
 		super
 	end
 
 
+	##
+	# The Array of all classes that have added Pluggability
+	@pluggable_classes = []
+	class << self; attr_reader :pluggable_classes; end
+
+
+	### Return the ancestor of +subclass+ that has Pluggability.
+	def self::plugin_base_class( subclass )
+		return subclass.ancestors.find do |klass|
+			Pluggability.pluggable_classes.include?( klass )
+		end
+	end
+
+
 	#############################################################
 	###	M I X I N   M E T H O D S
 	#############################################################
 
+	### Return the Hash of derivative classes, keyed by various versions of
+	### the class name.
+	attr_reader :derivatives
+
+
 	### Get/set the prefixes that will be used when searching for particular plugins
 	### for the calling Class.
 	def plugin_prefixes( *args )
@@ -46,27 +69,10 @@ module Pluggability
 	end
 
 
-	### Return the Hash of derivative classes, keyed by various versions of
-	### the class name.
-	def derivatives
-		return super unless defined?( @derivatives )
-		return @derivatives
-	end
-
-
 	### Returns the type name used when searching for a derivative.
 	def plugin_type
-		base = nil
-		self.ancestors.each do |klass|
-			if klass.instance_variables.include?( :@derivatives ) ||
-				klass.instance_variables.include?( "@derivatives" )
-				base = klass
-				break
-			end
-		end
-
-		raise FactoryError, "Couldn't find plugin base for #{self.name}" if
-			base.nil?
+		base = Pluggability.plugin_base_class( self ) or
+			raise PluginError, "Couldn't find plugin base for #{self.name}"
 
 		if base.name =~ /^.*::(.*)/
 			return $1
@@ -80,20 +86,22 @@ module Pluggability
 	### Inheritance callback -- Register subclasses in the derivatives hash
 	### so that ::create knows about them.
 	def inherited( subclass )
-		Pluggability.logger.debug "%p inherited by %p" % [ self, subclass ]
+		plugin_class = Pluggability.plugin_base_class( subclass )
+
+		Pluggability.logger.debug "%p inherited by %p" % [ plugin_class, subclass ]
 		keys = [ subclass ]
 
 		# If it's not an anonymous class, make some keys out of variants of its name
 		if subclass.name
-			keys += self.make_derivative_names( subclass )
+			keys += plugin_class.make_derivative_names( subclass )
 		else
 			Pluggability.log.debug "  no name-based variants for anonymous subclass %p" % [ subclass ]
 		end
 
 		keys.compact.uniq.each do |key|
 			Pluggability.log.info "Registering %s derivative of %s as %p" %
-				[ subclass.name, self.name, key ]
-			self.derivatives[ key ] = subclass
+				[ subclass.name, plugin_class.name, key ]
+			plugin_class.derivatives[ key ] = subclass
 		end
 
 		super
@@ -170,7 +178,7 @@ module Pluggability
 
 			subclass = self.derivatives[ class_name.downcase ]
 			unless subclass.is_a?( Class )
-				raise FactoryError,
+				raise PluginError,
 					"load_derivative(%s) added something other than a class "\
 					"to the registry for %s: %p" %
 					[ class_name, self.name, subclass ]
@@ -242,7 +250,7 @@ module Pluggability
 				class_name.downcase,
 			]
 			Pluggability.log.error( errmsg )
-			raise FactoryError, errmsg, caller(3)
+			raise PluginError, errmsg, caller(3)
 		end
 	end
 
@@ -308,7 +316,7 @@ module Pluggability
 				tries
 			  ]
 			Pluggability.log.error( errmsg )
-			raise FactoryError, errmsg
+			raise PluginError, errmsg
 		else
 			Pluggability.log.debug "Re-raising first fatal error"
 			Kernel.raise( fatals.first )
@@ -349,5 +357,5 @@ end # module Pluggability
 
 
 # Backward-compatibility alias
-FactoryError = Pluggability::FactoryError unless defined?( FactoryError )
+FactoryError = Pluggability::PluginError unless defined?( FactoryError )
 

data/spec/pluggability_spec.rb

@@ -31,6 +31,8 @@ module Test
 	class LoadablePlugin < Plugin; end
 end
 
+class SubSubPlugin < SubPlugin; end
+
 
 #
 # Examples
@@ -122,7 +124,7 @@ describe Pluggability do
 
 			expect {
 				Plugin.create('scintillating')
-			}.to raise_error( Pluggability::FactoryError, /couldn't find a \S+ named \S+.*tried \[/i )
+			}.to raise_error( Pluggability::PluginError, /couldn't find a \S+ named \S+.*tried \[/i )
 		end
 
 
@@ -132,7 +134,7 @@ describe Pluggability do
 
 			expect {
 				Plugin.create('corruscating')
-			}.to raise_error( Pluggability::FactoryError, /Require of '\S+' succeeded, but didn't load a Plugin/i )
+			}.to raise_error( Pluggability::PluginError, /Require of '\S+' succeeded, but didn't load a Plugin/i )
 		end
 
 
@@ -174,11 +176,11 @@ describe Pluggability do
 			TestingPlugin.plugin_type.should == 'Plugin'
 		end
 
-		it "raises a FactoryError if it can't figure out what type of factory loads it" do
+		it "raises a PluginError if it can't figure out what type of factory loads it" do
 			TestingPlugin.stub!( :ancestors ).and_return( [] )
 			expect {
 				TestingPlugin.plugin_type
-			}.to raise_error( Pluggability::FactoryError, /couldn't find plugin base/i )
+			}.to raise_error( Pluggability::PluginError, /couldn't find plugin base/i )
 		end
 	end
 
@@ -204,5 +206,14 @@ describe Pluggability do
 
 	end
 
+
+	context "subclass of a derivative" do
+
+		it "is still registered with the base class" do
+			Plugin.derivatives[ 'subsub' ].should == SubSubPlugin
+		end
+
+	end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pluggability
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Chase
@@ -31,7 +31,7 @@ cert_chain:
   6mKCwjpegytE0oifXfF8k75A9105cBnNiMZOe1tXiqYc/exCgWvbggurzDOcRkZu
   /YSusaiDXHKU2O3Akc3htA==
   -----END CERTIFICATE-----
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -39,14 +39,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
   requirement: !ruby/object:Gem::Requirement
@@ -95,14 +95,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -163,10 +163,10 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- -f
-- fivefish
 - -t
 - Pluggability Toolkit
+- -f
+- fivefish
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement