pluginfactory 1.0.7 → 1.0.8

data/lib/pluginfactory.rb

@@ -23,12 +23,12 @@ class FactoryError < RuntimeError; end
 #
 # == Creation Argument Variants
 #
-# The +create+ class method added to your class by PluginFactory searches for your module using 
+# The +create+ class method added to your class by PluginFactory searches for your module using
 #
 # == Synopsis
-# 
+#
 # in driver.rb:
-# 
+#
 #	require "PluginFactory"
 #
 #	class Driver
@@ -37,50 +37,74 @@ class FactoryError < RuntimeError; end
 #		   ["drivers"]
 #		end
 #	end
-# 
+#
 # in drivers/mysql.rb:
-# 
+#
 #	require 'driver'
 #
 #	class MysqlDriver < Driver
 #		...implementation...
 #	end
-# 
+#
 # in /usr/lib/ruby/1.8/PostgresDriver.rb:
-# 
+#
 #	require 'driver'
 #
 #	class PostgresDriver < Driver
 #		...implementation...
 #	end
-# 
+#
 # elsewhere
-# 
+#
 #	require 'driver'
 #
 #	config[:driver_type] #=> "mysql"
 #	driver = Driver.create( config[:driver_type] )
 #	driver.class #=> MysqlDriver
 #	pgdriver = Driver.create( "PostGresDriver" )
-# 
+#
 # == Authors
-# 
+#
 # * Martin Chase <stillflame@FaerieMUD.org>
 # * Michael Granger <ged@FaerieMUD.org>
-# 
-# :include: LICENSE
 #
-#---
+# == License
+#
+# Copyright (c) 2008-2012 Michael Granger and Martin Chase
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#
+#   * Neither the name of the author/s, nor the names of the project's
+#     contributors may be used to endorse or promote products derived from this
+#     software without specific prior written permission.
 #
-# Please see the file LICENSE for licensing details.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 module PluginFactory
 
 	# Library version
-	VERSION = '1.0.7'
+	VERSION = '1.0.8'
 
 
-	### Logging 
+	### Logging
 	@default_logger = Logger.new( $stderr )
 	@default_logger.level = $DEBUG ? Logger::DEBUG : Logger::WARN
 
@@ -161,7 +185,7 @@ module PluginFactory
 		base = nil
 		self.ancestors.each do |klass|
 			if klass.instance_variables.include?( :@derivatives ) ||
-				klass.instance_variables.include?( "@derivatives" ) 
+				klass.instance_variables.include?( "@derivatives" )
 				base = klass
 				break
 			end

data/spec/lib/helpers.rb

@@ -6,67 +6,26 @@ BEGIN {
 	basedir = Pathname.new( __FILE__ ).dirname.parent
 
 	libdir = basedir + "lib"
-	extdir = basedir + "ext"
 
 	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
-	$LOAD_PATH.unshift( extdir.to_s ) unless $LOAD_PATH.include?( extdir.to_s )
 }
 
-require 'erb'
+require 'rspec'
+require 'pluginfactory'
 
-### RSpec helper functions.
-module PluginFactory::SpecHelpers
-
-	unless defined?( LEVEL )
-		LEVEL = {
-			:debug => Logger::DEBUG,
-			:info  => Logger::INFO,
-			:warn  => Logger::WARN,
-			:error => Logger::ERROR,
-			:fatal => Logger::FATAL,
-		  }
-	end
-
-	###############
-	module_function
-	###############
-
-	### Reset the logging subsystem to its default state.
-	def reset_logging
-		PluginFactory.reset_logger
-	end
-	
-	
-	
-	### Alter the output of the default log formatter to be pretty in SpecMate output
-	def setup_logging( level=Logger::FATAL )
-
-		# Turn symbol-style level config into Logger's expected Fixnum level
-		if LEVEL.key?( level )
-			level = LEVEL[ level ]
-		end
-		
-		logger = Logger.new( $stderr )
-		PluginFactory.logger = logger
-		PluginFactory.logger.level = level
-
-		# Only do this when executing from a spec in TextMate
-		if ENV['HTML_LOGGING'] || (ENV['TM_FILENAME'] && ENV['TM_FILENAME'] =~ /_spec\.rb/)
-			PluginFactory.logger.formatter = HtmlLogFormatter.new( logger )
-		end
-	end
-	
-	
-end
 
+### RSpec helper functions.
+module PluginFactory
 
-### Make Logger output stuff in a form that looks nice(er) in SpecMate output.
-class HtmlLogFormatter < Logger::Formatter
-	include ERB::Util  # for html_escape()
+	# An alternate formatter for Logger instances that outputs +div+ HTML
+	# fragments.
+	# @private
+	class HtmlLogFormatter < Logger::Formatter
+		include ERB::Util  # for html_escape()
 
-	unless defined?( HTML_LOG_FORMAT )
+		# The default HTML fragment that'll be used as the template for each log message.
 		HTML_LOG_FORMAT = %q{
-		<dd class="log-message %5$s">
+		<div class="log-message %5$s">
 			<span class="log-time">%1$s.%2$06d</span>
 			[
 				<span class="log-pid">%3$d</span>
@@ -77,171 +36,122 @@ class HtmlLogFormatter < Logger::Formatter
 			:
 			<span class="log-name">%6$s</span>
 			<span class="log-message-text">%7$s</span>
-		</dd>
+		</div>
 		}
-	end
-
-	### Override the logging formats with ones that generate HTML fragments
-	def initialize( logger, format=HTML_LOG_FORMAT ) # :notnew:
-		@logger = logger
-		@format = format
-		super()
-	end
-
-
-	######
-	public
-	######
-
-	# The HTML fragment that will be used as a format() string for the log
-	attr_accessor :format
-	
-
-	### Return a log message composed out of the arguments formatted using the
-	### formatter's format string
-	def call( severity, time, progname, msg )
-		args = [
-			time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
-			time.usec,                                                    # %2$d
-			Process.pid,                                                  # %3$d
-			Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
-			severity,                                                     # %5$s
-			progname,                                                     # %6$s
-			html_escape( msg ).gsub(/\n/, '<br />')                       # %7$s
-		]
-
-		return self.format % args
-	end
-	
-end
 
+		### Override the logging formats with ones that generate HTML fragments
+		def initialize( logger, format=HTML_LOG_FORMAT ) # :notnew:
+			@logger = logger
+			@format = format
+			super()
+		end
+
+
+		######
+		public
+		######
 
-# Override the badly-structured output of the RSpec HTML formatter
-require 'spec/runner/formatter/html_formatter'
+		# The HTML fragment that will be used as a format() string for the log
+		attr_accessor :format
 
-class Spec::Runner::Formatter::HtmlFormatter
-	def example_failed( example, counter, failure )
-		failure_style = failure.pending_fixed? ? 'pending_fixed' : 'failed'
-		
-		unless @header_red
-			@output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>"
-			@header_red = true
+
+		### Return a log message composed out of the arguments formatted using the
+		### formatter's format string
+		def call( severity, time, progname, msg )
+			args = [
+				time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
+				time.usec,                                                    # %2$d
+				Process.pid,                                                  # %3$d
+				Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
+				severity.downcase,                                                     # %5$s
+				progname,                                                     # %6$s
+				html_escape( msg ).gsub(/\n/, '<br />')                       # %7$s
+			]
+
+			return self.format % args
 		end
-		
-		unless @example_group_red
-			css_class = 'example_group_%d' % [current_example_group_number || 0]
-			@output.puts "    <script type=\"text/javascript\">makeRed('#{css_class}');</script>"
-			@example_group_red = true
+
+	end # class HtmlLogFormatter
+
+
+	### Spec helper functions
+	module SpecHelpers
+
+		class ArrayLogger
+			### Create a new ArrayLogger that will append content to +array+.
+			def initialize( array )
+				@array = array
+			end
+
+			### Write the specified +message+ to the array.
+			def write( message )
+				@array << message
+			end
+
+			### No-op -- this is here just so Logger doesn't complain
+			def close; end
+
+		end # class ArrayLogger
+
+
+		unless defined?( LEVEL )
+			LEVEL = {
+				:debug => Logger::DEBUG,
+				:info  => Logger::INFO,
+				:warn  => Logger::WARN,
+				:error => Logger::ERROR,
+				:fatal => Logger::FATAL,
+			  }
 		end
-		
-		move_progress()
-		
-		@output.puts "    <dd class=\"spec #{failure_style}\">",
-		             "      <span class=\"failed_spec_name\">#{h(example.description)}</span>",
-		             "      <div class=\"failure\" id=\"failure_#{counter}\">"
-		if failure.exception
-			backtrace = format_backtrace( failure.exception.backtrace )
-			message = failure.exception.message
-			
-			@output.puts "        <div class=\"message\"><code>#{h message}</code></div>",
-			             "        <div class=\"backtrace\"><pre>#{backtrace}</pre></div>"
+
+		###############
+		module_function
+		###############
+
+		### Make an easily-comparable version vector out of +ver+ and return it.
+		def vvec( ver )
+			return ver.split('.').collect {|char| char.to_i }.pack('N*')
 		end
 
-		if extra = extra_failure_content( failure )
-			@output.puts( extra )
+
+		### Reset the logging subsystem to its default state.
+		def reset_logging
+			PluginFactory.reset_logger
 		end
-		
-		@output.puts "      </div>",
-		             "    </dd>"
-		@output.flush
-	end
-
-
-	if instance_methods.include?('global_styles') || instance_methods.include?(:global_styles)
-		alias_method :default_global_styles, :global_styles
-	else
-		def default_global_styles
-			"/* No default global_styles (methods: %p)?!? */" % [ instance_methods ]
+
+
+		### Alter the output of the default log formatter to be pretty in SpecMate output
+		def setup_logging( level=Logger::FATAL )
+
+			# Turn symbol-style level config into Logger's expected Fixnum level
+			if LEVEL.key?( level )
+				level = LEVEL[ level ]
+			end
+
+			logger = Logger.new( $stderr )
+			PluginFactory.logger = logger
+			PluginFactory.logger.level = level
+
+			# Only do this when executing from a spec in TextMate
+			if ENV['HTML_LOGGING'] || (ENV['TM_FILENAME'] && ENV['TM_FILENAME'] =~ /_spec\.rb/)
+				Thread.current['logger-output'] = []
+				logdevice = ArrayLogger.new( Thread.current['logger-output'] )
+				PluginFactory.logger = Logger.new( logdevice )
+				# PluginFactory.logger.level = level
+				PluginFactory.logger.formatter = PluginFactory::HtmlLogFormatter.new( logger )
+			end
 		end
-	end
-	
-	def global_styles
-		css = default_global_styles()
-		css << %Q{
-			/* Stuff added by #{__FILE__} */
-
-			/* Overrides */
-			#rspec-header {
-				-webkit-box-shadow: #333 0 2px 5px;
-				margin-bottom: 1em;
-			}
-
-			.example_group dt {
-				-webkit-box-shadow: #333 0 2px 3px;
-			}
-
-			/* Style for log output */
-			dd.log-message {
-				background: #eee;
-				padding: 0 2em;
-				margin: 0.2em 1em;
-				border-bottom: 1px dotted #999;
-				border-top: 1px dotted #999;
-				text-indent: -1em;
-			}
-
-			/* Parts of the message */
-			dd.log-message .log-time {
-				font-weight: bold;
-			}
-			dd.log-message .log-time:after {
-				content: ": ";
-			}
-			dd.log-message .log-level {
-				font-variant: small-caps;
-				border: 1px solid #ccc;
-				padding: 1px 2px;
-			}
-			dd.log-message .log-name {
-				font-size: 1.2em;
-				color: #1e51b2;
-			}
-			dd.log-message .log-name:before { content: "«"; }
-			dd.log-message .log-name:after { content:  "»"; }
-
-			dd.log-message .log-message-text {
-				padding-left: 4px;
-				font-family: Monaco, "Andale Mono", "Vera Sans Mono", mono;
-			}
-
-
-			/* Distinguish levels */
-			dd.log-message.debug { color: #666; }
-			dd.log-message.info {}
-
-			dd.log-message.warn,
-			dd.log-message.error {
-				background: #ff9;
-			}
-			dd.log-message.error .log-level,
-			dd.log-message.error .log-message-text {
-				color: #900;
-			}
-			dd.log-message.fatal {
-				background: #900;
-				color: white;
-				font-weight: bold;
-				border: 0;
-			}
-			dd.log-message.fatal .log-name {
-				color:  white;
-			}
-		}
-		
-		return css
-	end
-end # module PluginFactory::SpecHelpers
 
+	end # module SpecHelpers
+
+end # module PluginFactory
+
+
+### Mock with Rspec
+RSpec.configure do |c|
+	c.mock_with :rspec
+	c.include( PluginFactory::SpecHelpers )
+end
 
 # vim: set nosta noet ts=4 sw=4: