pluginfactory 1.0.2 → 1.0.3

data/spec/pluginfactory_spec.rb

@@ -0,0 +1,223 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent
+	
+	libdir = basedir + "lib"
+	
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+begin
+	require 'spec/runner'
+	require 'pluginfactory'
+rescue LoadError
+	unless Object.const_defined?( :Gem )
+		require 'rubygems'
+		retry
+	end
+	raise
+end
+
+
+
+class Plugin
+	extend PluginFactory
+	def self::derivative_dirs 
+		[ 'plugins', 'plugins/private' ]
+	end
+end
+
+
+
+describe PluginFactory do
+
+	it "calls its logging callback with the level and joined message if set" do
+		level = nil; msg = nil
+		PluginFactory.logger_callback = lambda {|level, msg|}
+		
+		PluginFactory.log( :level, 'message1', 'message2' )
+		level.should == :level
+		msg.should == 'message1message2'
+	end
+	
+	it "doesn't error when its log method is called if no logging callback is set" do
+		PluginFactory.logger_callback = nil
+		lambda { PluginFactory.log(:level, "msg") }.should_not raise_error()
+	end
+
+end
+
+describe "A class extended with PluginFactory" do
+	
+	before( :each ) do
+		# This is kind of cheating, but it makes testing possible without knowing 
+		# the order the examples are run in
+		Plugin.derivatives.clear
+	end
+	
+	
+	it "knows about all of its derivatives" do
+		Plugin.derivatives.should be_empty()
+		Plugin.derivatives.should be_an_instance_of( Hash )
+		
+		class SubPlugin < Plugin; end
+		
+		Plugin.derivatives.should have(4).members
+		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 "can return an Array of all of its derivative classes" do
+		Plugin.derivative_classes.should be_empty()
+		
+		class OtherPlugin < Plugin; end
+		
+		Plugin.derivative_classes.should == [OtherPlugin]
+	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
+		
+		begin
+			Plugin.create('pugilist')
+		rescue ::Exception => err
+			err.backtrace.first.should =~ /#{__FILE__}/
+		else
+			fail "Expected an exception to be raised"
+		end
+	end
+	
+	it "will refuse to create an object other than one of its derivatives" do
+		class Doppelgaenger; end
+		lambda { Plugin.create(Doppelgaenger) }.
+			should 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 ).and_return {|*args|
+			loaded_class = Class.new( Plugin ) do
+				def self::name; "DazzlePlugin"; end
+			end
+			true
+		}
+		
+		Plugin.create( 'dazzle' ).should be_an_instance_of( loaded_class )
+	end
+	
+
+	it "will #require derivatives that aren't yet loaded" do
+		loaded_class = nil
+
+		Plugin.should_receive( :require ).and_return {|*args|
+			loaded_class = Class.new( Plugin ) do
+				def self::name; "SnazzlePlugin"; end
+			end
+			true
+		}
+		
+		Plugin.create( 'snazzle' ).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" }
+		
+		lambda { Plugin.create('scintillating') }.
+			should raise_error( 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 )
+		
+		lambda { Plugin.create('corruscating') }.
+			should raise_error( 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}"
+		}
+		
+		lambda { Plugin.create('portable') }.
+			should raise_error( ScriptError, /error while parsing/ )
+	end
+end
+
+
+describe "A derivative of a class extended with PluginFactory" do
+	
+	before( :all ) do
+		class TestingPlugin < Plugin; end
+	end
+	
+	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( [] )
+		lambda { TestingPlugin.factory_type }.
+			should raise_error( FactoryError, /couldn't find factory base/i )
+	end
+end
+
+
+describe "A derivative of a class extended with PluginFactory that isn't named <Something>Plugin" do
+	
+	before( :all ) do
+		class BlackSheep < Plugin; end
+	end
+	
+	it "is still creatable via its full name" do
+		Plugin.create( 'blacksheep' ).should be_an_instance_of( BlackSheep )
+	end
+	
+end
+
+
+describe "A derivative of a class extended with PluginFactory in another namespace" do
+	
+	before( :all ) do
+		module Test
+			class LoadablePlugin < Plugin; end
+		end
+	end
+	
+	it "is still creatable via its derivative name" do
+		Plugin.create( 'loadable' ).should be_an_instance_of( Test::LoadablePlugin )
+	end
+	
+end
+

metadata

@@ -1,57 +1,76 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: pluginfactory
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2007-07-17 00:00:00 -07:00
-summary: Mixin module that adds plugin behavior to any class
-require_paths: 
-- lib
-email: ged@FaerieMUD.org
-homepage: http://devEiate.org/projects/PluginFactory
-rubyforge_project: 
-description: PluginFactory is a module that provides plugin behavior for any class. Including PluginFactory in your class provides a ::create class method, which can be passed the name of any derivatives. Derivative classes are loaded dynamically and instantiated by the factory class.
-autorequire: pluginfactory
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.5
-  version: 
+  version: 1.0.3
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Michael Granger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: PluginFactory 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.
+email: ged@FaerieMUD.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
-- COPYRIGHT
+- Rakefile
 - ChangeLog
 - README
-- install.rb
+- LICENSE
+- spec/pluginfactory_spec.rb
 - lib/pluginfactory.rb
-- test.rb
-- tests/mybase.rb
-- tests/othersub.rb
-- tests/subofmybase.rb
-- tests/dir/deepsubofmybase.rb
-- utils.rb
-test_files: 
-- test.rb
+- rake/dependencies.rb
+- rake/helpers.rb
+- rake/manual.rb
+- rake/packaging.rb
+- rake/publishing.rb
+- rake/rdoc.rb
+- rake/style.rb
+- rake/svn.rb
+- rake/testing.rb
+- rake/verifytask.rb
+has_rdoc: true
+homepage: http://deveiate.org/projects/PluginFactory/
+post_install_message: 
 rdoc_options: 
-- --main
+- -w
+- "4"
+- -SHN
+- -i
+- .
+- -m
 - README
-extra_rdoc_files: 
-- README
-executables: []
-
-extensions: []
-
+- -W
+- http://deveiate.org/projects/PluginFactory//browser/trunk/
+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: []
 
-dependencies: []
-
+rubyforge_project: pluginfactory
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A mixin for making plugin classes
+test_files: 
+- spec/pluginfactory_spec.rb

data/COPYRIGHT

@@ -1,131 +0,0 @@
-
-
-
-
-			 The "Artistic License"
-
-				Preamble
-
-The intent of this document is to state the conditions under which a
-Package may be copied, such that the Copyright Holder maintains some
-semblance of artistic control over the development of the package,
-while giving the users of the package the right to use and distribute
-the Package in a more-or-less customary fashion, plus the right to make
-reasonable modifications.
-
-Definitions:
-
-	"Package" refers to the collection of files distributed by the
-	Copyright Holder, and derivatives of that collection of files
-	created through textual modification.
-
-	"Standard Version" refers to such a Package if it has not been
-	modified, or has been modified in accordance with the wishes
-	of the Copyright Holder as specified below.
-
-	"Copyright Holder" is whoever is named in the copyright or
-	copyrights for the package.
-
-	"You" is you, if you're thinking about copying or distributing
-	this Package.
-
-	"Reasonable copying fee" is whatever you can justify on the
-	basis of media cost, duplication charges, time of people involved,
-	and so on.  (You will not be required to justify it to the
-	Copyright Holder, but only to the computing community at large
-	as a market that must bear the fee.)
-
-	"Freely Available" means that no fee is charged for the item
-	itself, though there may be fees involved in handling the item.
-	It also means that recipients of the item may redistribute it
-	under the same conditions they received it.
-
-1. You may make and give away verbatim copies of the source form of the
-Standard Version of this Package without restriction, provided that you
-duplicate all of the original copyright notices and associated disclaimers.
-
-2. You may apply bug fixes, portability fixes and other modifications
-derived from the Public Domain or from the Copyright Holder.  A Package
-modified in such a way shall still be considered the Standard Version.
-
-3. You may otherwise modify your copy of this Package in any way, provided
-that you insert a prominent notice in each changed file stating how and
-when you changed that file, and provided that you do at least ONE of the
-following:
-
-    a) place your modifications in the Public Domain or otherwise make them
-    Freely Available, such as by posting said modifications to Usenet or
-    an equivalent medium, or placing the modifications on a major archive
-    site such as uunet.uu.net, or by allowing the Copyright Holder to include
-    your modifications in the Standard Version of the Package.
-
-    b) use the modified Package only within your corporation or organization.
-
-    c) rename any non-standard executables so the names do not conflict
-    with standard executables, which must also be provided, and provide
-    a separate manual page for each non-standard executable that clearly
-    documents how it differs from the Standard Version.
-
-    d) make other distribution arrangements with the Copyright Holder.
-
-4. You may distribute the programs of this Package in object code or
-executable form, provided that you do at least ONE of the following:
-
-    a) distribute a Standard Version of the executables and library files,
-    together with instructions (in the manual page or equivalent) on where
-    to get the Standard Version.
-
-    b) accompany the distribution with the machine-readable source of
-    the Package with your modifications.
-
-    c) give non-standard executables non-standard names, and clearly
-    document the differences in manual pages (or equivalent), together
-    with instructions on where to get the Standard Version.
-
-    d) make other distribution arrangements with the Copyright Holder.
-
-5. You may charge a reasonable copying fee for any distribution of this
-Package.  You may charge any fee you choose for support of this
-Package.  You may not charge a fee for this Package itself.  However,
-you may distribute this Package in aggregate with other (possibly
-commercial) programs as part of a larger (possibly commercial) software
-distribution provided that you do not advertise this Package as a
-product of your own.  You may embed this Package's interpreter within
-an executable of yours (by linking); this shall be construed as a mere
-form of aggregation, provided that the complete Standard Version of the
-interpreter is so embedded.
-
-6. The scripts and library files supplied as input to or produced as
-output from the programs of this Package do not automatically fall
-under the copyright of this Package, but belong to whoever generated
-them, and may be sold commercially, and may be aggregated with this
-Package.  If such scripts or library files are aggregated with this
-Package via the so-called "undump" or "unexec" methods of producing a
-binary executable image, then distribution of such an image shall
-neither be construed as a distribution of this Package nor shall it
-fall under the restrictions of Paragraphs 3 and 4, provided that you do
-not represent such an executable image as a Standard Version of this
-Package.
-
-7. C subroutines (or comparably compiled subroutines in other
-languages) supplied by you and linked into this Package in order to
-emulate subroutines and variables of the language defined by this
-Package shall not be considered part of this Package, but are the
-equivalent of input as in Paragraph 6, provided these subroutines do
-not change the language in any way that would cause it to fail the
-regression tests for the language.
-
-8. Aggregation of this Package with a commercial distribution is always
-permitted provided that the use of this Package is embedded; that is,
-when no overt attempt is made to make this Package's interfaces visible
-to the end user of the commercial distribution.  Such use shall not be
-construed as a distribution of this Package.
-
-9. The name of the Copyright Holder may not be used to endorse or promote
-products derived from this software without specific prior written permission.
-
-10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-				The End

data/install.rb

@@ -1,172 +0,0 @@
-#!/usr/bin/ruby
-#
-#	Module Install Script
-#	$Id: install.rb 31 2004-11-21 17:14:13Z ged $
-#
-#	Thanks to Masatoshi SEKI for ideas found in his install.rb.
-#
-#	Copyright (c) 2001-2004 The FaerieMUD Consortium.
-#
-#	This is free software. You may use, modify, and/or redistribute this
-#	software under the terms of the Perl Artistic License. (See
-#	http://language.perl.com/misc/Artistic.html)
-#
-
-require './utils.rb'
-include UtilityFunctions
-
-require 'rbconfig'
-include Config
-
-require 'find'
-require 'ftools'
-require 'optparse'
-
-$version	= %q$Revision: 31 $
-$rcsId		= %q$Id: install.rb 31 2004-11-21 17:14:13Z ged $
-
-# Define required libraries
-RequiredLibraries = [
-	# libraryname, nice name, RAA URL, Download URL, e.g.,
-	#[ 'strscan', "Strscan", 
-	#	'http://www.ruby-lang.org/en/raa-list.rhtml?name=strscan',
-	#	'http://i.loveruby.net/archive/strscan/strscan-0.6.7.tar.gz',
-	#],
-]
-
-class Installer
-
-	@@PrunePatterns = [
-		/CVS/,
-		/~$/,
-		%r:(^|/)\.:,
-		/\.tpl$/,
-	]
-
-	def initialize( testing=false )
-		@ftools = (testing) ? self : File
-	end
-
-	### Make the specified dirs (which can be a String or an Array of Strings)
-	### with the specified mode.
-	def makedirs( dirs, mode=0755, verbose=false )
-		dirs = [ dirs ] unless dirs.is_a? Array
-
-		oldumask = File::umask
-		File::umask( 0777 - mode )
-
-		for dir in dirs
-			if @ftools == File
-				File::mkpath( dir, $verbose )
-			else
-				$stderr.puts "Make path %s with mode %o" % [ dir, mode ]
-			end
-		end
-
-		File::umask( oldumask )
-	end
-
-	def install( srcfile, dstfile, mode=nil, verbose=false )
-		dstfile = File.catname(srcfile, dstfile)
-		unless FileTest.exist? dstfile and File.cmp srcfile, dstfile
-			$stderr.puts "   install #{srcfile} -> #{dstfile}"
-		else
-			$stderr.puts "   skipping #{dstfile}: unchanged"
-		end
-	end
-
-	public
-
-	def installFiles( src, dstDir, mode=0444, verbose=false )
-		directories = []
-		files = []
-		
-		if File.directory?( src )
-			Find.find( src ) {|f|
-				Find.prune if @@PrunePatterns.find {|pat| f =~ pat}
-				next if f == src
-
-				if FileTest.directory?( f )
-					directories << f.gsub( /^#{src}#{File::Separator}/, '' )
-					next 
-
-				elsif FileTest.file?( f )
-					files << f.gsub( /^#{src}#{File::Separator}/, '' )
-
-				else
-					Find.prune
-				end
-			}
-		else
-			files << File.basename( src )
-			src = File.dirname( src )
-		end
-		
-		dirs = [ dstDir ]
-		dirs |= directories.collect {|d| File.join(dstDir,d)}
-		makedirs( dirs, 0755, verbose )
-		files.each {|f|
-			srcfile = File.join(src,f)
-			dstfile = File.dirname(File.join( dstDir,f ))
-
-			if verbose
-				if mode
-					$stderr.puts "Install #{srcfile} -> #{dstfile} (mode %o)" % mode
-				else
-					$stderr.puts "Install #{srcfile} -> #{dstfile}"
-				end
-			end
-
-			@ftools.install( srcfile, dstfile, mode, verbose )
-		}
-	end
-
-end
-
-
-if $0 == __FILE__
-	for lib in RequiredLibraries
-		testForRequiredLibrary( *lib )
-	end
-
-	dryrun = false
-
-	# Parse command-line switches
-	ARGV.options {|oparser|
-		oparser.banner = "Usage: #$0 [options]\n"
-
-		oparser.on( "--verbose", "-v", TrueClass, "Make progress verbose" ) {
-			$VERBOSE = true
-			debugMsg "Turned verbose on."
-		}
-
-		oparser.on( "--dry-run", "-n", TrueClass, "Don't really install anything" ) {
-			debugMsg "Turned dry-run on."
-			dryrun = true
-		}
-
-		# Handle the 'help' option
-		oparser.on( "--help", "-h", "Display this text." ) {
-			$stderr.puts oparser
-			exit!(0)
-		}
-
-		oparser.parse!
-	}
-
-	debugMsg "Sitelibdir = '#{CONFIG['sitelibdir']}'"
-	sitelibdir = CONFIG['sitelibdir']
-	debugMsg "Sitearchdir = '#{CONFIG['sitearchdir']}'"
-	sitearchdir = CONFIG['sitearchdir']
-
-	message "Installing..."
-	i = Installer.new( dryrun )
-	#i.installFiles( "redist", sitelibdir, 0444, verbose )
-	i.installFiles( "lib", sitelibdir, 0444, $VERBOSE )
-
-	message "done.\n"
-end
-	
-
-
-