pluginfactory 1.0.3 → 1.0.4

data/rake/testing.rb

@@ -1,16 +1,22 @@
 # 
 # Rake tasklib for testing tasks
-# $Id: testing.rb 14 2008-07-23 23:16:30Z deveiant $
+# $Id: testing.rb 80 2008-12-20 19:50:19Z deveiant $
 # 
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
 # 
 
-COVERAGE_MINIMUM = 85.0 unless defined?( COVERAGE_MINIMUM )
+unless defined?( COVERAGE_MINIMUM )
+	if ENV['COVVERAGE_MINIMUM']
+		COVERAGE_MINIMUM = Float( ENV['COVERAGE_MINIMUM'] )
+	else
+		COVERAGE_MINIMUM = 85.0 
+	end
+end
 SPEC_FILES       = [] unless defined?( SPEC_FILES )
 TEST_FILES       = [] unless defined?( TEST_FILES )
 
-COMMON_SPEC_OPTS = ['-c', '-f', 's'] unless defined?( COMMON_SPEC_OPTS )
+COMMON_SPEC_OPTS = ['-Du', '-b'] 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
@@ -34,15 +40,12 @@ end
 ### RSpec specifications
 begin
 	gem 'rspec', '>= 1.1.3'
+
+	require 'spec'
 	require 'spec/rake/spectask'
 
 	### Task: spec
-	Spec::Rake::SpecTask.new( :spec ) do |task|
-		task.spec_files = SPEC_FILES
-		task.libs += [LIBDIR]
-		task.spec_opts = COMMON_SPEC_OPTS
-	end
-
+	task :spec => 'spec:doc'
 
 	namespace :spec do
 		desc "Run rspec every time there's a change to one of the files"
@@ -50,28 +53,33 @@ begin
 			require 'autotest/rspec'
 
 			autotester = Autotest::Rspec.new
-			autotester.exceptions = %r{\.svn|\.skel}
 			autotester.run
 		end
 
+		desc "Generate regular color 'doc' spec output"
+		Spec::Rake::SpecTask.new( :doc ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 's', '-c']
+		end
 
-		desc "Generate quiet output"
-		Spec::Rake::SpecTask.new( :quiet ) do |task|
+		desc "Generate spec output with profiling"
+		Spec::Rake::SpecTask.new( :profile ) do |task|
 			task.spec_files = SPEC_FILES
-			task.spec_opts = ['-f', 'p', '-D']
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'o']
 		end
 
-		desc "Generate HTML output for a spec run"
-		Spec::Rake::SpecTask.new( :html ) do |task|
+		desc "Generate quiet non-colored plain-text output"
+		Spec::Rake::SpecTask.new( :quiet ) do |task|
 			task.spec_files = SPEC_FILES
-			task.spec_opts = ['-f','h', '-D']
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'p']
 		end
 
-		desc "Generate plain-text output for a CruiseControl.rb build"
-		Spec::Rake::SpecTask.new( :text ) do |task|
+		desc "Generate HTML output"
+		Spec::Rake::SpecTask.new( :html ) do |task|
 			task.spec_files = SPEC_FILES
-			task.spec_opts = ['-f','p']
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'h']
 		end
+
 	end
 rescue LoadError => err
 	task :no_rspec do
@@ -81,9 +89,10 @@ rescue LoadError => err
 	task :spec => :no_rspec
 	namespace :spec do
 		task :autotest => :no_rspec
+		task :doc => :no_rspec
+		task :profile => :no_rspec
 		task :quiet => :no_rspec
 		task :html => :no_rspec
-		task :text => :no_rspec
 	end
 end
 
@@ -112,8 +121,10 @@ begin
 	gem 'rcov'
 	gem 'rspec', '>= 1.1.3'
 
+	require 'spec'
+	require 'rcov'
+
 	### Task: coverage (via RCov)
-	### Task: rcov
 	desc "Build test coverage reports"
 	unless SPEC_FILES.empty?
 		Spec::Rake::SpecTask.new( :coverage ) do |task|
@@ -124,19 +135,20 @@ begin
 			task.rcov = true
 		end
 	end
-	unless TEST_FILES.empty?
-		require 'rcov/rcovtask'
+# 	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
+# 		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 => [:coverage] do; end
+	### Task: rcov
+	task :rcov => :coverage
 
 	### Other coverage tasks
 	namespace :coverage do
@@ -150,7 +162,8 @@ begin
 		desc "Show differences in coverage from last run"
 		Spec::Rake::SpecTask.new( :diff ) do |task|
 			task.spec_files = SPEC_FILES
-			task.rcov_opts = ['--text-coverage-diff']
+			task.spec_opts = ['-f', 'p', '-b']
+			task.rcov_opts = RCOV_OPTS - ['--save'] + ['--text-coverage-diff']
 			task.rcov = true
 		end
 
@@ -168,9 +181,7 @@ begin
 		end
 	end
 
-	task :clobber_coverage do
-		rmtree( COVERAGE_TARGETDIR )
-	end
+	CLOBBER.include( COVERAGE_TARGETDIR )
 
 rescue LoadError => err
 	task :no_rcov do

data/rake/win32.rb

@@ -0,0 +1,94 @@
+# 
+# Win32-specific tasks (cross-compiling, etc.)
+# 
+# Thanks to some people that understand this stuff better than me for
+# posting helpful blog posts. This stuff is an amalgam of stuff they did:
+# 
+# * Mauricio Fernandez
+#   http://eigenclass.org/hiki/cross+compiling+rcovrt
+# 
+# * Jeremy Hinegardner
+#   http://www.copiousfreetime.org/articles/2008/10/12/building-gems-for-windows.html
+# 
+# * Aaron Patterson
+#   http://tenderlovemaking.com/2008/11/21/cross-compiling-ruby-gems-for-win32/
+
+require 'pathname'
+require 'rbconfig'
+
+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"
+
+XCOMPILER_DIR  = HOMEDIR + '.ruby_mingw32'
+
+XCOMPILER_DL   = XCOMPILER_DIR + "ruby-#{RUBYVERSION}.tar.gz"
+XCOMPILER_SRC  = XCOMPILER_DIR + "ruby-#{RUBYVERSION}"
+
+XCOMPILER_BIN  = XCOMPILER_DIR + 'bin'
+XCOMPILER_RUBY = XCOMPILER_BIN + 'ruby.exe'
+
+NEW_ALT_SEPARATOR = '"\\\\\" ' + ?\
+
+CONFIGURE_CMD = %w[
+	env
+		ac_cv_func_getpgrp_void=no
+		ac_cv_func_setpgrp_void=yes
+		rb_cv_negative_time_t=no
+		ac_cv_func_memcmp_working=yes
+		rb_cv_binary_elf=no
+    ./configure
+	    --host=i386-mingw32
+	    --target=i386-mingw32
+	    --build=#{RUBY_PLATFORM}
+	    --prefix=#{XCOMPILER_DIR}
+]
+
+begin
+	require 'archive/tar'
+	
+	namespace :win32 do
+		directory XCOMPILER_DIR
+		
+		file XCOMPILER_DL => XCOMPILER_DIR do
+			download RUBY_DL_URI, XCOMPILER_DL
+		end
+
+		directory XCOMPILER_SRC
+		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 ]
+		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 )
+					end
+				end
+
+				mv 'Makefile.in.new', 'Makefile.in'
+				
+				run *CONFIGURE_CMD
+			end
+		end
+
+		task :build => XCOMPILER_RUBY do
+			log "Building..."
+		end
+	end
+
+rescue LoadError => err
+	task :no_win32_build do
+		fatal "No win32 build: %s: %s" % [ err.class.name, err.message ]
+	end
+	
+	namespace :win32 do
+		task :build => :no_win32_build
+	end
+			
+end
+

data/spec/lib/helpers.rb

@@ -0,0 +1,247 @@
+#!/usr/bin/ruby
+# coding: utf-8
+
+BEGIN {
+	require 'pathname'
+	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'
+
+### 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
+
+
+### Make Logger output stuff in a form that looks nice(er) in SpecMate output.
+class HtmlLogFormatter < Logger::Formatter
+	include ERB::Util  # for html_escape()
+
+	unless defined?( HTML_LOG_FORMAT )
+		HTML_LOG_FORMAT = %q{
+		<dd class="log-message %5$s">
+			<span class="log-time">%1$s.%2$06d</span>
+			[
+				<span class="log-pid">%3$d</span>
+				/
+				<span class="log-tid">%4$s</span>
+			]
+			<span class="log-level">%5$s</span>
+			:
+			<span class="log-name">%6$s</span>
+			<span class="log-message-text">%7$s</span>
+		</dd>
+		}
+	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 badly-structured output of the RSpec HTML formatter
+require 'spec/runner/formatter/html_formatter'
+
+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
+		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
+		
+		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>"
+		end
+
+		if extra = extra_failure_content( failure )
+			@output.puts( extra )
+		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 ]
+		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
+
+
+# vim: set nosta noet ts=4 sw=4:
+