pluggability 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e540538307554e6530b3aceb32cdcc5943819fb5
-  data.tar.gz: 7c1548aa2c9959d938bcfebfd62896727a9f02f0
+  metadata.gz: a4a48369fcbed3a05f6c1d709edf28215bc7a69f
+  data.tar.gz: 71d8323ae8af471d64796aebdb53814c12b34d79
 SHA512:
-  metadata.gz: b2a7beb87ff1f941522f4467db3caf61bac30f3d520962bce63c2a029f97f3d04ab6d4294e315f6c6349899afa3f766ef7b905d41564514ba08d38c807ff5c0a
-  data.tar.gz: 3a717ceb7a3d075691c36e0a520d8de3ca416bb25e2e13f59d560aa852a904fbe34392bd4e1ed3d685ff8d90e8fe833771fbe4b9d6e72666636cc62fb0906938
+  metadata.gz: 5d7eaa318bd1a7b45a0e704ea1c8e3b10c290551a407c7334ff92b1e065fa5fd89e6a3fdf9036018edd5fc75be5ec5110b5a39542090b6b158da1ec74cc20d01
+  data.tar.gz: 930077f441537a74d322f7ef28ac2be40c2031194bfc31e67d6f6ec723029627a48af8d86bf5cb6a7eacf2f3f2291a643bdecb22ad1f2254daea3db8b47d8b37

data.tar.gz.sig

@@ -1,2 +1,2 @@
-M��uT&Zb@���X���O�h����)��/��%�s���oC��Y��RZ�����̻~�K��|f�x�����#
-A�J��eS9!&��?.���IQ ��%(�X_E��t�c�kkJ�
��ž\����(^��3h��|
+qK�GI��M�yR����t���^S��Dr�1J�x�'+�~�7@
+

data/History.rdoc

@@ -1,3 +1,9 @@
+== v0.1.0 [2013-03-27] Michael Granger <ged@FaerieMUD.org>
+
+- Add loading via underbarred name variants (CommaDelimitedThing ->
+  comma_delimited)
+- Rename some stuff for consistency.
+
 == v0.0.2 [2012-08-13] Michael Granger <ged@FaerieMUD.org>
 
 Simplify Pluggability#derivatives.

data/lib/pluggability.rb

@@ -12,7 +12,7 @@ module Pluggability
 
 
 	# Library version
-	VERSION = '0.0.2'
+	VERSION = '0.1.0'
 
 
 	### An exception class for Pluggability specific errors.
@@ -55,7 +55,7 @@ module Pluggability
 
 
 	### Returns the type name used when searching for a derivative.
-	def factory_type
+	def plugin_type
 		base = nil
 		self.ancestors.each do |klass|
 			if klass.instance_variables.include?( :@derivatives ) ||
@@ -65,7 +65,7 @@ module Pluggability
 			end
 		end
 
-		raise FactoryError, "Couldn't find factory base for #{self.name}" if
+		raise FactoryError, "Couldn't find plugin base for #{self.name}" if
 			base.nil?
 
 		if base.name =~ /^.*::(.*)/
@@ -74,6 +74,7 @@ module Pluggability
 			return base.name
 		end
 	end
+	alias factory_type plugin_type
 
 
 	### Inheritance callback -- Register subclasses in the derivatives hash
@@ -84,16 +85,7 @@ module Pluggability
 
 		# If it's not an anonymous class, make some keys out of variants of its name
 		if subclass.name
-			simple_name = subclass.name.sub( /#<Class:0x[[:xdigit:]]+>::/i, '' )
-			keys << simple_name << simple_name.downcase
-
-			# Handle class names like 'FooBar' for 'Bar' factories.
-			Pluggability.log.debug "Inherited %p for %p-type plugins" % [ subclass, self.factory_type ]
-			if subclass.name.match( /(?:.*::)?(\w+)(?:#{self.factory_type})/i )
-				keys << Regexp.last_match[1].downcase
-			else
-				keys << subclass.name.sub( /.*::/, '' ).downcase
-			end
+			keys += self.make_derivative_names( subclass )
 		else
 			Pluggability.log.debug "  no name-based variants for anonymous subclass %p" % [ subclass ]
 		end
@@ -108,6 +100,27 @@ module Pluggability
 	end
 
 
+	### Return all variants of the name of the given +subclass+ that can be
+	### used to load it.
+	def make_derivative_names( subclass )
+		keys = []
+
+		simple_name = subclass.name.sub( /^.*::/i, '' ).sub( /\W+$/, '' )
+		keys << simple_name << simple_name.downcase
+		keys << simple_name.gsub( /([a-z])([A-Z])/, "\\1_\\2" ).downcase
+
+		# Handle class names like 'FooBar' for 'Bar' factories.
+		Pluggability.log.debug "Inherited %p for %p-type plugins" % [ subclass, self.plugin_type ]
+		if subclass.name.match( /(?:.*::)?(\w+)(?:#{self.plugin_type})/i )
+			keys << Regexp.last_match[1].downcase
+		else
+			keys << subclass.name.sub( /.*::/, '' ).downcase
+		end
+
+		return keys
+	end
+
+
 	### Returns an Array of registered derivatives
 	def derivative_classes
 		self.derivatives.values.uniq
@@ -169,7 +182,7 @@ module Pluggability
 
 
 	### Find and load all derivatives of this class, using plugin_prefixes if any
-	### are defined, or a pattern derived from the #factory_type if not. Returns
+	### are defined, or a pattern derived from the #plugin_type if not. Returns
 	### an array of all derivative classes. Load failures are logged but otherwise
 	### ignored.
 	def load_all
@@ -183,8 +196,8 @@ module Pluggability
 			end
 		else
 			# Use all but the last pattern, which will just be '*.rb'
-			Pluggability.log.debug "Using factory type (%p) to build load patterns." %
-				[ self.factory_type ]
+			Pluggability.log.debug "Using plugin type (%p) to build load patterns." %
+				[ self.plugin_type ]
 			patterns += self.make_require_path( '*', '' )[0..-2].
 				map {|f| f + '.rb' }
 		end
@@ -225,7 +238,7 @@ module Pluggability
 		unless self.derivatives[ class_name.downcase ]
 			errmsg = "Require of '%s' succeeded, but didn't load a %s named '%s' for some reason." % [
 				result,
-				self.factory_type,
+				self.plugin_type,
 				class_name.downcase,
 			]
 			Pluggability.log.error( errmsg )
@@ -236,11 +249,11 @@ module Pluggability
 
 	### Build and return the unique part of the given <tt>class_name</tt>
 	### either by stripping leading namespaces if the name already has the
-	### name of the factory type in it (eg., 'My::FooService' for Service,
-	### or by appending the factory type if it doesn't.
+	### name of the plugin type in it (eg., 'My::FooService' for Service,
+	### or by appending the plugin type if it doesn't.
 	def get_module_name( class_name )
-		if class_name =~ /\w+#{self.factory_type}/
-			mod_name = class_name.sub( /(?:.*::)?(\w+)(?:#{self.factory_type})/, "\\1" )
+		if class_name =~ /\w+#{self.plugin_type}/
+			mod_name = class_name.sub( /(?:.*::)?(\w+)(?:#{self.plugin_type})/, "\\1" )
 		else
 			mod_name = class_name
 		end
@@ -290,7 +303,7 @@ module Pluggability
 		# some reason.
 		if fatals.empty?
 			errmsg = "Couldn't find a %s named '%s': tried %p" % [
-				self.factory_type,
+				self.plugin_type,
 				mod_name,
 				tries
 			  ]
@@ -310,7 +323,7 @@ module Pluggability
 	###    "drivers/SocketDataDriver", "drivers/socket", "drivers/Socket"]
 	def make_require_path( modname, subdir )
 		path = []
-		myname = self.factory_type
+		myname = self.plugin_type
 
 		# Make permutations of the two parts
 		path << modname

data/spec/pluggability_spec.rb

@@ -104,7 +104,7 @@ describe Pluggability do
 			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 
+				Plugin.derivatives['dazzle'] = loaded_class
 				true
 			end
 
@@ -162,7 +162,7 @@ describe Pluggability do
 				and_return( true )
 			Plugin.should_receive( :require ).with( 'plugins/private/third.rb' ).
 				and_return( true )
-			
+
 			Plugin.load_all
 		end
 	end
@@ -170,15 +170,15 @@ describe Pluggability do
 
 	context "derivative of an extended class" do
 
-		it "knows what type of factory loads it" do
-			TestingPlugin.factory_type.should == 'Plugin'
+		it "knows what type of plugin loads it" do
+			TestingPlugin.plugin_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 )
+				TestingPlugin.plugin_type
+			}.to raise_error( Pluggability::FactoryError, /couldn't find plugin base/i )
 		end
 	end
 
@@ -189,6 +189,10 @@ describe Pluggability do
 			Plugin.create( 'blacksheep' ).should be_an_instance_of( BlackSheep )
 		end
 
+		it "is loadable via its underbarred name" do
+			Plugin.create( 'black_sheep' ).should be_an_instance_of( BlackSheep )
+		end
+
 	end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pluggability
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Martin Chase
@@ -31,7 +31,7 @@ cert_chain:
   6mKCwjpegytE0oifXfF8k75A9105cBnNiMZOe1tXiqYc/exCgWvbggurzDOcRkZu
   /YSusaiDXHKU2O3Akc3htA==
   -----END CERTIFICATE-----
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: pluggability
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Pluggability is a mixin module that turns an including class into a factory