pluginfactory 1.0.4 → 1.0.5

data/rake/testing.rb

@@ -1,6 +1,6 @@
 # 
 # Rake tasklib for testing tasks
-# $Id: testing.rb 80 2008-12-20 19:50:19Z deveiant $
+
 # 
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
@@ -16,7 +16,7 @@ end
 SPEC_FILES       = [] unless defined?( SPEC_FILES )
 TEST_FILES       = [] unless defined?( TEST_FILES )
 
-COMMON_SPEC_OPTS = ['-Du', '-b'] unless defined?( COMMON_SPEC_OPTS )
+COMMON_SPEC_OPTS = ['-Du'] unless defined?( COMMON_SPEC_OPTS )
 
 COVERAGE_TARGETDIR = BASEDIR + 'coverage' unless defined?( COVERAGE_TARGETDIR )
 RCOV_EXCLUDES      = 'spec,tests,/Library/Ruby,/var/lib,/usr/local/lib' unless
@@ -29,7 +29,7 @@ task :test do
 		log "Running specs"
 		Rake::Task['spec:quiet'].invoke
 	end
-	
+
 	unless TEST_FILES.empty?
 		log "Running unit tests"
 		Rake::Task[:unittests].invoke 
@@ -45,6 +45,7 @@ begin
 	require 'spec/rake/spectask'
 
 	### Task: spec
+	desc "Run specs"
 	task :spec => 'spec:doc'
 
 	namespace :spec do
@@ -100,7 +101,7 @@ end
 ### Test::Unit tests
 begin
 	require 'rake/testtask'
-	
+
 	Rake::TestTask.new( :unittests ) do |task|
 		task.libs += [LIBDIR]
 		task.test_files = TEST_FILES
@@ -115,7 +116,7 @@ rescue LoadError => err
 	task :unittests => :no_rspec
 end
 
-	
+
 ### RCov (via RSpec) tasks
 begin
 	gem 'rcov'
@@ -135,16 +136,6 @@ begin
 			task.rcov = true
 		end
 	end
-# 	unless TEST_FILES.empty?
-# 		require 'rcov/rcovtask'
-
-# 		Rcov::RcovTask.new do |task|
-# 			task.libs += [LIBDIR]
-# 			task.test_files = TEST_FILES
-# 			task.verbose = true
-# 			task.rcov_opts = RCOV_OPTS
-# 		end
-# 	end
 
 
 	### Task: rcov
@@ -167,12 +158,6 @@ begin
 			task.rcov = true
 		end
 
-		### Task: verify coverage
-		desc "Build coverage statistics"
-		VerifyTask.new( :verify => :rcov ) do |task|
-			task.threshold = COVERAGE_MINIMUM
-		end
-
 		desc "Run RCov in 'spec-only' mode to check coverage from specs"
 		Spec::Rake::SpecTask.new( :speconly ) do |task|
 			task.spec_files = SPEC_FILES

data/rake/win32.rb

@@ -13,13 +13,20 @@
 # * Aaron Patterson
 #   http://tenderlovemaking.com/2008/11/21/cross-compiling-ruby-gems-for-win32/
 
+require 'rubygems'
+require 'rake'
 require 'pathname'
+require 'rubygems/platform'
 require 'rbconfig'
+require 'uri'
+require 'net/ftp'
 
 HOMEDIR        = Pathname( '~' ).expand_path
 RUBYVERSION    = '1.8.6-p287'
-RUBY_DL_BASE   = 'ftp://ftp.ruby-lang.org/pub/ruby/1.8/'
-RUBY_DL_URI    = RUBY_DL_BASE + "ruby-#{RUBYVERSION}.tar.gz"
+RUBYVERSION_MAJORMINOR = RUBYVERSION[/^\d+\.\d+/]
+
+RUBY_DL_BASE   = "ftp://ftp.ruby-lang.org/pub/ruby/#{RUBYVERSION_MAJORMINOR}/"
+RUBY_DL_URI    = URI( RUBY_DL_BASE + "ruby-#{RUBYVERSION}.tar.gz" )
 
 XCOMPILER_DIR  = HOMEDIR + '.ruby_mingw32'
 
@@ -27,11 +34,20 @@ XCOMPILER_DL   = XCOMPILER_DIR + "ruby-#{RUBYVERSION}.tar.gz"
 XCOMPILER_SRC  = XCOMPILER_DIR + "ruby-#{RUBYVERSION}"
 
 XCOMPILER_BIN  = XCOMPILER_DIR + 'bin'
+XCOMPILER_LIB  = XCOMPILER_DIR + 'lib'
 XCOMPILER_RUBY = XCOMPILER_BIN + 'ruby.exe'
 
-NEW_ALT_SEPARATOR = '"\\\\\" ' + ?\
+XCOMPILER_LOAD_PATH = XCOMPILER_LIB + "ruby/#{RUBYVERSION_MAJORMINOR}/i386-mingw32"
+
+TAR_OPTS = { :compression => :gzip }
+
+WIN32_GEMSPEC = GEMSPEC.dup
+WIN32_GEMSPEC.files += FileList[ EXTDIR + '**.{dll,so}' ]
+WIN32_GEMSPEC.platform = Gem::Platform.new( 'i386-mingw32' )
+WIN32_GEMSPEC.extensions = []
+
 
-CONFIGURE_CMD = %w[
+CONFIGURE_CMD = %W[
 	env
 		ac_cv_func_getpgrp_void=no
 		ac_cv_func_setpgrp_void=yes
@@ -41,54 +57,134 @@ CONFIGURE_CMD = %w[
     ./configure
 	    --host=i386-mingw32
 	    --target=i386-mingw32
-	    --build=#{RUBY_PLATFORM}
+	    --build=#{Config::CONFIG['build']}
 	    --prefix=#{XCOMPILER_DIR}
 ]
 
+### Archive::Tar::Reader#extract (as of 0.9.0) is broken w.r.t.
+### permissions, so we have to do this ourselves.
+def untar( tarfile, targetdir )
+	targetdir = Pathname( targetdir )
+	raise "No such directory: #{targetdir}" unless targetdir.directory?
+
+	reader = Archive::Tar::Reader.new( tarfile.to_s, TAR_OPTS )
+
+	mkdir_p( targetdir )
+	reader.each( true ) do |header, body|
+		path = targetdir + header[:path]
+		# trace "Header is: %p" % [ header ]
+
+		case header[:type]
+		when :file
+			trace "  #{path}"
+			path.open( File::WRONLY|File::EXCL|File::CREAT|File::TRUNC, header[:mode] ) do |fio|
+				bytesize = header[:size]
+				fio.write( body[0,bytesize] )
+			end
+
+		when :directory
+			trace "  #{path}"
+			path.mkpath
+
+		when :link
+			linktarget = targetdir + header[:dest]
+			trace "  #{path} => #{linktarget}"
+			path.make_link( linktarget.to_s )
+
+		when :symlink
+			linktarget = targetdir + header[:dest]
+			trace "  #{path} -> #{linktarget}" 
+			path.make_symlink( linktarget )
+		end
+	end
+
+end
+
+
 begin
 	require 'archive/tar'
-	
+
 	namespace :win32 do
-		directory XCOMPILER_DIR
-		
+		directory XCOMPILER_DIR.to_s
+
 		file XCOMPILER_DL => XCOMPILER_DIR do
-			download RUBY_DL_URI, XCOMPILER_DL
+			# openuri can't handle this -- passive ftp required?
+			# run 'wget', '-O', XCOMPILER_DL, RUBY_DL_URI
+			log "Downloading ruby distro from %s" % [ RUBY_DL_URI ]
+			ftp = Net::FTP.new( RUBY_DL_URI.host )
+			ftp.login
+			ftp.getbinaryfile( RUBY_DL_URI.path, XCOMPILER_DL, 4096 )
+			ftp.close
 		end
 
-		directory XCOMPILER_SRC
+		directory XCOMPILER_SRC.to_s
 		task XCOMPILER_SRC => [ XCOMPILER_DIR, XCOMPILER_DL ] do
-			Archive::Tar.extract( XCOMPILER_DL, XCOMPILER_DIR, :compression => :gzip ) or
-				fail "Extraction of %s failed." % [ XCOMPILER_DL ]
+			if XCOMPILER_SRC.exist?
+				trace "Rake fails. #{XCOMPILER_SRC} already exists."
+			else
+				untar( XCOMPILER_DL, XCOMPILER_DIR )
+			end
 		end
 
 		file XCOMPILER_RUBY => XCOMPILER_SRC do
 			Dir.chdir( XCOMPILER_SRC ) do
-				File.open( 'Makefile.in.new', IO::CREAT|IO::WRONLY|IO::EXCL ) do |ofh|
-					File.each_line( 'Makefile.in' ) do |line|
-						line.sub!( /ALT_SEPARATOR = "\\\\"/, NEW_ALT_SEPARATOR )
-						ofh.write( line )
+				unless File.exist?( 'Makefile.in.orig' )
+					File.open( 'Makefile.in.new', IO::CREAT|IO::WRONLY|IO::EXCL ) do |ofh|
+						IO.readlines( 'Makefile.in' ).each do |line|
+							next if line.include?( 0.chr )
+							trace "  copying line: %p" % [ line ]
+							line.sub!( /ALT_SEPARATOR = ".*?"/, "ALT_SEPARATOR = 92.chr" )
+							ofh.write( line )
+						end
 					end
+
+					mv 'Makefile.in', 'Makefile.in.orig'
+					mv 'Makefile.in.new', 'Makefile.in'
 				end
 
-				mv 'Makefile.in.new', 'Makefile.in'
-				
 				run *CONFIGURE_CMD
+				run 'make', 'ruby'
+				run 'make', 'rubyw.exe'
+				run 'make', 'install'
 			end
 		end
 
-		task :build => XCOMPILER_RUBY do
-			log "Building..."
+		file XCOMPILER_LOAD_PATH => XCOMPILER_RUBY
+
+		desc "Cross-compile the library for Win32 systems, installing a cross-" +
+		     "compiled Ruby if necessary"
+		task :build => [ EXTDIR, XCOMPILER_LOAD_PATH.to_s ] do
+			in_subdirectory( EXTDIR ) do
+				ruby "-I#{XCOMPILER_LOAD_PATH}", 'extconf.rb'
+				sh 'make'
+			end
+		end
+
+		desc "Build a binary gem for win32 systems"
+		task :gem => ['win32:build', PKGDIR.to_s] + WIN32_GEMSPEC.files do
+			when_writing( "Creating win32 GEM" ) do
+				pkgname = WIN32_GEMSPEC.file_name
+				builder = Gem::Builder.new( WIN32_GEMSPEC )
+				builder.build
+				mv pkgname, PKGDIR + pkgname, :verbose => $trace
+			end
 		end
 	end
 
 rescue LoadError => err
+	trace "Couldn't load the win32 tasks: %s: %s" % [ err.class.name, err.message ]
+
 	task :no_win32_build do
-		fatal "No win32 build: %s: %s" % [ err.class.name, err.message ]
+		abort "No win32 build: %s: %s" % [ err.class.name, err.message ]
 	end
-	
+
 	namespace :win32 do
+		desc "Build a binary Gem for Win32 systems, installing a cross " +
+		     "compiled Ruby if necessary"
+		task :gem => :no_win32_build
 		task :build => :no_win32_build
 	end
-			
+
 end
 
+

data/spec/pluginfactory_spec.rb

@@ -3,9 +3,9 @@
 BEGIN {
 	require 'pathname'
 	basedir = Pathname.new( __FILE__ ).dirname.parent
-	
+
 	libdir = basedir + "lib"
-	
+
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
@@ -22,176 +22,164 @@ class Plugin
 	end
 end
 
+class SubPlugin < Plugin; end
+class TestingPlugin < Plugin; end
+class BlackSheep < Plugin; end
+module Test
+	class LoadablePlugin < Plugin; end
+end
+
+
 describe PluginFactory do
 	include PluginFactory::SpecHelpers
 
 	before( :each ) do
 		setup_logging( :fatal )
 	end
-	
+
+	after( :each ) do
+		reset_logging()
+	end
+
 
 	it "calls its logging callback with the level and joined message if set" do
 		level = nil; msg = nil
 		PluginFactory.logger_callback = lambda {|l, m| level = l; msg = m }
 		PluginFactory.logger.level = Logger::DEBUG
-		
+
 		PluginFactory.log.debug( 'message' )
 		level.should == :debug
 		msg.should == 'message'
 	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.debug("msg") }.should_not raise_error()
 	end
 
-end
 
+	describe "-extended class" do
 
-class SubPlugin < Plugin; end
+		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
 
-describe "A class extended with PluginFactory" do
-	include PluginFactory::SpecHelpers
+		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
 
-	before( :all ) do
-		setup_logging( :fatal )
-	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
 
-	after( :all ) do
-		reset_logging()
-	end
+			begin
+				Plugin.create('pugilist')
+			rescue ::Exception => err
+				err.backtrace.first.should =~ /#{__FILE__}/
+			else
+				fail "Expected an exception to be raised"
+			end
+		end
 
-	before( :each ) do
-		# Plugin.derivatives.clear
-	end
-	
-	
-	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 "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 "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!"
+
+		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
-		
-		begin
-			Plugin.create('pugilist')
-		rescue ::Exception => err
-			err.backtrace.first.should =~ /#{__FILE__}/
-		else
-			fail "Expected an exception to be raised"
+
+
+		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
-	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 ).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
+		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
-		
-		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" }
-		
-		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/ )
+		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
-end
 
 
-class TestingPlugin < Plugin; end
+	describe "derivative of an extended class" do
 
-describe "A derivative of a class extended with PluginFactory" do
-	
-	it "knows what type of factory loads it" do
-		TestingPlugin.factory_type.should == 'Plugin'
-	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 )
+		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
-end
 
 
-class BlackSheep < Plugin; end
+	describe "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
 
-describe "A derivative of a class extended with PluginFactory 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
 
 
-module Test
-	class LoadablePlugin < Plugin; end
-end
+	describe "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
 
-describe "A derivative of a class extended with PluginFactory 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