pluginfactory 1.0.3 → 1.0.4

data/ChangeLog

@@ -1,3 +1,29 @@
+-- Wed, 25 Feb 2009 17:50:55 -0000 by deveiant (r57) -----
+   Changed: lib/pluginfactory.rb
+
+   Incrementing library version.
+
+
+-- Wed, 25 Feb 2009 16:52:20 -0000 by deveiant (r56) -----
+   Added:   spec/lib (new)
+            spec/lib/helpers.rb (new)
+   Changed: lib/pluginfactory.rb
+            spec/pluginfactory_spec.rb
+
+    * Fixes for Ruby 1.9.1.
+    * Replace home-grown logger stuff with Logger library
+
+
+-- Mon, 23 Feb 2009 06:34:03 -0000 by deveiant (r55) -----
+   Changed: README
+            Rakefile
+            utils.rb
+            project.yml
+            spec/pluginfactory_spec.rb
+
+   Start of fixes for 1.9.1.
+
+
 -- Wed, 13 Aug 2008 21:58:41 -0000 by deveiant (r52) -----
    Changed: lib/pluginfactory.rb
             Rakefile

data/README

@@ -189,7 +189,7 @@ this might generate a log that looks like:
 
 == Subversion ID
 
-$Id: README 50 2008-08-13 21:57:18Z deveiant $
+$Id: README 55 2009-02-23 06:34:03Z deveiant $
 
 == Authors
 

data/Rakefile

@@ -4,7 +4,7 @@
 #
 # Based on various other Rakefiles, especially one by Ben Bleything
 #
-# Copyright (c) 2008 The FaerieMUD Consortium
+# Copyright (c) 2007-2009 The FaerieMUD Consortium
 #
 # Authors:
 #  * Michael Granger <ged@FaerieMUD.org>
@@ -21,39 +21,55 @@ BEGIN {
 	$LOAD_PATH.unshift( extdir.to_s ) unless $LOAD_PATH.include?( extdir.to_s )
 }
 
-
 require 'rbconfig'
-require 'rubygems'
 require 'rake'
 require 'rake/rdoctask'
 require 'rake/testtask'
 require 'rake/packagetask'
 require 'rake/clean'
+require 'rake/191_compat.rb'
 
 $dryrun = false
 
 ### Config constants
 BASEDIR       = Pathname.new( __FILE__ ).dirname.relative_path_from( Pathname.getwd )
+BINDIR        = BASEDIR + 'bin'
 LIBDIR        = BASEDIR + 'lib'
 EXTDIR        = BASEDIR + 'ext'
 DOCSDIR       = BASEDIR + 'docs'
 PKGDIR        = BASEDIR + 'pkg'
+DATADIR       = BASEDIR + 'data'
 
-PKG_NAME      = 'pluginfactory'
+PROJECT_NAME  = 'PluginFactory'
+PKG_NAME      = PROJECT_NAME.downcase
 PKG_SUMMARY   = 'A mixin for making plugin classes'
+
 VERSION_FILE  = LIBDIR + 'pluginfactory.rb'
-PKG_VERSION   = VERSION_FILE.read[ /VERSION = '(\d+\.\d+\.\d+)'/, 1 ]
+if VERSION_FILE.exist? && buildrev = ENV['CC_BUILD_LABEL']
+	PKG_VERSION = VERSION_FILE.read[ /VERSION\s*=\s*['"](\d+\.\d+\.\d+)['"]/, 1 ] + '.' + buildrev
+elsif VERSION_FILE.exist?
+	PKG_VERSION = VERSION_FILE.read[ /VERSION\s*=\s*['"](\d+\.\d+\.\d+)['"]/, 1 ]
+else
+	PKG_VERSION = '0.0.0'
+end
+
 PKG_FILE_NAME = "#{PKG_NAME.downcase}-#{PKG_VERSION}"
 GEM_FILE_NAME = "#{PKG_FILE_NAME}.gem"
 
+EXTCONF       = EXTDIR + 'extconf.rb'
+
 ARTIFACTS_DIR = Pathname.new( ENV['CC_BUILD_ARTIFACTS'] || 'artifacts' )
 
 TEXT_FILES    = %w( Rakefile ChangeLog README LICENSE ).collect {|filename| BASEDIR + filename }
+BIN_FILES     = Pathname.glob( BINDIR + '*' ).delete_if {|item| item =~ /\.svn/ }
 LIB_FILES     = Pathname.glob( LIBDIR + '**/*.rb' ).delete_if {|item| item =~ /\.svn/ }
 EXT_FILES     = Pathname.glob( EXTDIR + '**/*.{c,h,rb}' ).delete_if {|item| item =~ /\.svn/ }
+DATA_FILES    = Pathname.glob( DATADIR + '**/*' ).delete_if {|item| item =~ /\.svn/ }
 
 SPECDIR       = BASEDIR + 'spec'
-SPEC_FILES    = Pathname.glob( SPECDIR + '**/*_spec.rb' ).delete_if {|item| item =~ /\.svn/ }
+SPECLIBDIR    = SPECDIR + 'lib'
+SPEC_FILES    = Pathname.glob( SPECDIR + '**/*_spec.rb' ).delete_if {|item| item =~ /\.svn/ } +
+                Pathname.glob( SPECLIBDIR + '**/*.rb' ).delete_if {|item| item =~ /\.svn/ }
 
 TESTDIR       = BASEDIR + 'tests'
 TEST_FILES    = Pathname.glob( TESTDIR + '**/*.tests.rb' ).delete_if {|item| item =~ /\.svn/ }
@@ -68,8 +84,10 @@ EXTRA_PKGFILES = []
 RELEASE_FILES = TEXT_FILES + 
 	SPEC_FILES + 
 	TEST_FILES + 
+	BIN_FILES +
 	LIB_FILES + 
 	EXT_FILES + 
+	DATA_FILES + 
 	RAKE_TASKLIBS +
 	EXTRA_PKGFILES
 
@@ -107,12 +125,14 @@ SNAPSHOT_PKG_NAME = "#{PKG_FILE_NAME}.#{PKG_BUILD}"
 SNAPSHOT_GEM_NAME = "#{SNAPSHOT_PKG_NAME}.gem"
 
 # Documentation constants
+RDOCDIR = DOCSDIR + 'api'
 RDOC_OPTIONS = [
 	'-w', '4',
 	'-SHN',
 	'-i', '.',
 	'-m', 'README',
-	'-W', 'http://deveiate.org/projects/PluginFactory//browser/trunk/'
+	'-t', PKG_NAME,
+	'-W', 'http://deveiate.org/projects/PluginFactory/browser/trunk/'
   ]
 
 # Release constants
@@ -120,10 +140,11 @@ SMTP_HOST = 'mail.faeriemud.org'
 SMTP_PORT = 465 # SMTP + SSL
 
 # Project constants
-PROJECT_HOST = 'deveiate.org'
-PROJECT_PUBDIR = "/usr/local/www/public/code"
+PROJECT_HOST = 'deveiate'
+PROJECT_PUBDIR = '/usr/local/www/public/code'
 PROJECT_DOCDIR = "#{PROJECT_PUBDIR}/#{PKG_NAME}"
-PROJECT_SCPURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
+PROJECT_SCPPUBURL = "#{PROJECT_HOST}:#{PROJECT_PUBDIR}"
+PROJECT_SCPDOCURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
 
 # Rubyforge stuff
 RUBYFORGE_GROUP = 'deveiate'
@@ -133,6 +154,22 @@ RUBYFORGE_PROJECT = 'pluginfactory'
 DEPENDENCIES = {
 }
 
+# Developer Gem dependencies: gemname => version
+DEVELOPMENT_DEPENDENCIES = {
+	'amatch'      => '>= 0.2.3',
+	'rake'        => '>= 0.8.1',
+	'rcodetools'  => '>= 0.7.0.0',
+	'rcov'        => '>= 0',
+	'RedCloth'    => '>= 4.0.3',
+	'rspec'       => '>= 0',
+	'rubyforge'   => '>= 0',
+	'termios'     => '>= 0',
+	'text-format' => '>= 1.0.0',
+	'tmail'       => '>= 1.2.3.1',
+	'ultraviolet' => '>= 0.10.2',
+	'libxml-ruby' => '>= 0.8.3',
+}
+
 # Non-gem requirements: packagename => version
 REQUIREMENTS = {
 }
@@ -143,13 +180,13 @@ GEMSPEC   = Gem::Specification.new do |gem|
 	gem.version           = PKG_VERSION
 
 	gem.summary           = PKG_SUMMARY
-	gem.description       = <<-EOD
-	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.
-	EOD
+	gem.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.",
+  	  ].join( "\n" )
 
 	gem.authors           = 'Michael Granger'
 	gem.email             = 'ged@FaerieMUD.org'
@@ -158,6 +195,15 @@ GEMSPEC   = Gem::Specification.new do |gem|
 
 	gem.has_rdoc          = true
 	gem.rdoc_options      = RDOC_OPTIONS
+	gem.extra_rdoc_files  = %w[ChangeLog README LICENSE]
+
+	gem.bindir            = BINDIR.relative_path_from(BASEDIR).to_s
+	gem.executables       = BIN_FILES.select {|pn| pn.executable? }.
+		collect {|pn| pn.relative_path_from(BINDIR).to_s }
+
+	if EXTCONF.exist?
+		gem.extensions << EXTCONF.relative_path_from( BASEDIR ).to_s
+	end
 
 	gem.files             = RELEASE_FILES.
 		collect {|f| f.relative_path_from(BASEDIR).to_s }
@@ -166,7 +212,15 @@ GEMSPEC   = Gem::Specification.new do |gem|
 		
 	DEPENDENCIES.each do |name, version|
 		version = '>= 0' if version.length.zero?
-		gem.add_dependency( name, version )
+		gem.add_runtime_dependency( name, version )
+	end
+	
+	# Developmental dependencies don't work as of RubyGems 1.2.0
+	unless Gem::Version.new( Gem::RubyGemsVersion ) <= Gem::Version.new( "1.2.0" )
+		DEVELOPMENT_DEPENDENCIES.each do |name, version|
+			version = '>= 0' if version.length.zero?
+			gem.add_development_dependency( name, version )
+		end
 	end
 	
 	REQUIREMENTS.each do |name, version|
@@ -174,6 +228,9 @@ GEMSPEC   = Gem::Specification.new do |gem|
 	end
 end
 
+# Manual-generation config
+MANUALDIR = DOCSDIR + 'manual'
+
 $trace = Rake.application.options.trace ? true : false
 $dryrun = Rake.application.options.dryrun ? true : false
 
@@ -229,13 +286,16 @@ end
 
 ### Task: cruise (Cruisecontrol task)
 desc "Cruisecontrol build"
-task :cruise => [:clean, :spec, :package] do |task|
+task :cruise => [:clean, 'spec:quiet', :package] do |task|
 	raise "Artifacts dir not set." if ARTIFACTS_DIR.to_s.empty?
-	artifact_dir = ARTIFACTS_DIR.cleanpath
+	artifact_dir = ARTIFACTS_DIR.cleanpath + ENV['CC_BUILD_LABEL']
 	artifact_dir.mkpath
 	
-	$stderr.puts "Copying coverage stats..."
-	FileUtils.cp_r( 'coverage', artifact_dir )
+	coverage = BASEDIR + 'coverage'
+	if coverage.exist? && coverage.directory?
+		$stderr.puts "Copying coverage stats..."
+		FileUtils.cp_r( 'coverage', artifact_dir )
+	end
 	
 	$stderr.puts "Copying packages..."
 	FileUtils.cp_r( FileList['pkg/*'].to_a, artifact_dir )

data/lib/pluginfactory.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby -w
 
+require 'logger'
+
 ### An exception class for PluginFactory specific errors.
 class FactoryError < RuntimeError; end
 
@@ -21,9 +23,7 @@ class FactoryError < RuntimeError; end
 #
 # == Creation Argument Variants
 #
-# The +create+ class method added to your class by PluginFactory searches for 
-# your module using the $LOAD_PATH that require uses. See the README for a 
-# detailed explanation.
+# The +create+ class method added to your class by PluginFactory searches for your module using 
 #
 # == Synopsis
 # 
@@ -65,7 +65,7 @@ class FactoryError < RuntimeError; end
 # 
 # == Subversion ID
 # 
-# $Id: pluginfactory.rb 52 2008-08-13 21:58:41Z deveiant $
+# $Id: pluginfactory.rb 57 2009-02-25 17:50:55Z deveiant $
 # 
 # == Authors
 # 
@@ -80,23 +80,52 @@ class FactoryError < RuntimeError; end
 #
 module PluginFactory
 
-	VERSION = '1.0.3'
+	VERSION = '1.0.4'
 	
 
-	### A callback for logging the various debug and information this module
-	### has to log.  Should take two arguments, the log level, possibly as a
-	### symbol, and the log message itself.
-	@logger_callback = nil
+	### Logging 
+	@default_logger = Logger.new( $stderr )
+	@default_logger.level = $DEBUG ? Logger::DEBUG : Logger::WARN
+
+	@logger = @default_logger
+
+
 	class << self
-		attr_accessor :logger_callback
+		# The logger that will be used when the logging subsystem is reset
+		attr_accessor :default_logger
+		
+		# The logger that's currently in effect
+		attr_accessor :logger
+		alias_method :log, :logger
+		alias_method :log=, :logger=
 	end
 
-	### If the logger callback is set, use it to pass on a log entry.  First
-	### argument is a 'level' which is passed to the logging callback. Any
-	### remaining arguments will be joined and passed as a single second
-	### argument to the callback.
-	def self::log( level, *msg )
-		@logger_callback.call( level, msg.join ) if @logger_callback
+
+	### Deprecated: use the Logger object at #log to manipulate logging instead of this
+	### method.
+	def self::logger_callback=( callback )
+		if callback.nil?
+			self.logger.formatter = nil
+		else
+			self.logger.formatter = lambda {|lvl, _, _, msg|
+				callback.call(lvl.downcase.to_sym, msg)
+				''
+			}
+		end
+	end
+	
+
+	### Reset the global logger object to the default
+	def self::reset_logger
+		self.logger = self.default_logger
+		self.logger.level = Logger::WARN
+	end
+	
+
+	### Returns +true+ if the global logger has not been set to something other than
+	### the default one.
+	def self::using_default_logger?
+		return self.logger == self.default_logger
 	end
 
 
@@ -122,7 +151,8 @@ module PluginFactory
 	### the class name.
 	def derivatives
 		ancestors.each do |klass|
-			if klass.instance_variables.include?( "@derivatives" )
+			if klass.instance_variables.include?( :@derivatives ) ||
+			   klass.instance_variables.include?( "@derivatives" )
 				return klass.instance_variable_get( :@derivatives )
 			end
 		end
@@ -133,7 +163,8 @@ module PluginFactory
 	def factory_type
 		base = nil
 		self.ancestors.each do |klass|
-			if klass.instance_variables.include?( "@derivatives" )
+			if klass.instance_variables.include?( :@derivatives ) ||
+				klass.instance_variables.include?( "@derivatives" ) 
 				base = klass
 				break
 			end
@@ -154,17 +185,26 @@ module PluginFactory
 	### Inheritance callback -- Register subclasses in the derivatives hash
 	### so that ::create knows about them.
 	def inherited( subclass )
-		keys = [ subclass.name, subclass.name.downcase, subclass ]
-
-		# Handle class names like 'FooBar' for 'Bar' factories.
-		if subclass.name.match( /(?:.*::)?(\w+)(?:#{self.factory_type})/i )
-			keys << Regexp.last_match[1].downcase
+		keys = [ subclass ]
+
+		# 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.
+			PluginFactory.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
 		else
-			keys << subclass.name.sub( /.*::/, '' ).downcase
+			PluginFactory.log.debug "  no name-based variants for anonymous subclass %p" % [ subclass ]
 		end
 
-		keys.uniq.each do |key|
-			PluginFactory.log :info, "Registering %s derivative of %s as %p" %
+		keys.compact.uniq.each do |key|
+			PluginFactory.log.info "Registering %s derivative of %s as %p" %
 				[ subclass.name, self.name, key ]
 			self.derivatives[ key ] = subclass
 		end
@@ -245,7 +285,7 @@ module PluginFactory
 	### require line is tried with both <tt>'foo/'</tt> and <tt>'bar/'</tt>
 	### prepended to it.
 	def load_derivative( class_name )
-		PluginFactory.log :debug, "Loading derivative #{class_name}"
+		PluginFactory.log.debug "Loading derivative #{class_name}"
 
 		# Get the unique part of the derived class name and try to
 		# load it from one of the derivative subdirs, if there are
@@ -261,7 +301,7 @@ module PluginFactory
 				self.factory_type,
 				class_name.downcase,
 			]
-			PluginFactory.log :error, errmsg
+			PluginFactory.log.error( errmsg )
 			raise FactoryError, errmsg, caller(3)
 		end
 	end
@@ -303,7 +343,7 @@ module PluginFactory
 		end
 
 		subdirs = [ subdirs ] unless subdirs.is_a?( Array )
-		PluginFactory.log :debug, "Subdirs are: %p" % [subdirs]
+		PluginFactory.log.debug "Subdirs are: %p" % [subdirs]
 		fatals = []
 		tries  = []
 
@@ -311,7 +351,7 @@ module PluginFactory
 		# module.
 		subdirs.collect {|dir| dir.strip}.each do |subdir|
 			self.make_require_path( mod_name, subdir ).each do |path|
-				PluginFactory.log :debug, "Trying #{path}..."
+				PluginFactory.log.debug "Trying #{path}..."
 				tries << path
 
 				# Try to require the module, saving errors and jumping
@@ -319,22 +359,20 @@ module PluginFactory
 				begin
 					require( path.untaint )
 				rescue LoadError => err
-					PluginFactory.log :debug,
-						"No module at '%s', trying the next alternative: '%s'" %
+					PluginFactory.log.debug "No module at '%s', trying the next alternative: '%s'" %
 						[ path, err.message ]
 				rescue Exception => err
 					fatals << err
-					PluginFactory.log :error,
-						"Found '#{path}', but encountered an error: %s\n\t%s" %
+					PluginFactory.log.error "Found '#{path}', but encountered an error: %s\n\t%s" %
 						[ err.message, err.backtrace.join("\n\t") ]
 				else
-					PluginFactory.log :info, "Loaded '#{path}' without error."
+					PluginFactory.log.info "Loaded '#{path}' without error."
 					return path
 				end
 			end
 		end
 
-		PluginFactory.log :debug, "fatals = %p" % [ fatals ]
+		PluginFactory.log.debug "fatals = %p" % [ fatals ]
 
 		# Re-raise is there was a file found, but it didn't load for
 		# some reason.
@@ -344,10 +382,10 @@ module PluginFactory
 				mod_name,
 				tries
 			  ]
-			PluginFactory.log :error, errmsg
+			PluginFactory.log.error( errmsg )
 			raise FactoryError, errmsg
 		else
-			PluginFactory.log :debug, "Re-raising first fatal error"
+			PluginFactory.log.debug "Re-raising first fatal error"
 			Kernel.raise( fatals.first )
 		end
 	end
@@ -379,7 +417,7 @@ module PluginFactory
 			path.collect! {|m| File.join(subdir, m)}
 		end
 
-		PluginFactory.log :debug, "Path is: #{path.uniq.reverse.inspect}..."
+		PluginFactory.log.debug "Path is: #{path.uniq.reverse.inspect}..."
 		return path.uniq.reverse
 	end
 	alias_method :makeRequirePath, :make_require_path