webkit-rspec-formatter 2.0.0

data/ChangeLog

@@ -0,0 +1,81 @@
+26[github/master,master,tip]   5ff0e8d21818   2010-10-21 16:35 -0700   ged
+  Fix the project page URL
+
+25   dcac16539488   2010-10-21 16:33 -0700   ged
+  On second thought, make the links actually links. Duh
+
+24   7d0875336f79   2010-10-21 16:30 -0700   ged
+  Actually add the link to the Github mirror
+
+23   118d08bb8ab1   2010-10-21 16:29 -0700   ged
+  Rename README -> README.md since I changed it to Markdown
+
+22   406646ae0941   2010-10-21 16:25 -0700   ged
+  CSS changes, split out templates, nested example groups
+
+21   06221c136d6b   2010-10-20 17:23 -0700   ged
+  More RSpec 2.0 fixes
+
+20   3dd8bff179fd   2010-10-20 13:58 -0700   ged
+  Add a shim to allow the formatter for the --format option
+
+19   3df4a3eaa994   2010-10-19 15:30 -0700   ged
+  Updated build system, project metadata.
+
+18   e6628d07ab9f   2010-10-19 15:27 -0700   ged
+  Added tag 1.0.0 for changeset 45d2888c3afa
+
+17   14ec4d0f642e   2010-10-19 15:26 -0700   ged
+  Version bump to 2.0.0
+
+16   9fac9e11e14e   2010-10-19 15:25 -0700   ged
+  Upgrade to RSpec 2.0
+
+15   057eca6f4b84   2010-10-19 15:24 -0700   ged
+  Move resource files into the datadir
+
+14[1.0.0]   45d2888c3afa   2010-08-23 13:53 -0700   ged
+  Updated to work under my fork of rspec/rspec-tmbundle using only an environment variable.
+
+13   195d2dba198a   2010-08-23 10:51 -0700   ged
+  Updated build system for JRuby and MRI 1.9.2.
+
+12   91754df5cb4b   2010-04-19 08:48 -0700   ged
+  Updated build system.
+
+11   96b80268f5e5   2010-03-23 08:13 -0700   ged
+  More cleanup and documentation
+
+10   811c00ded302   2010-03-19 10:28 -0700   ged
+  Updated to work with recent version of 'Ruby RSpec' bundle, updated jQuery.
+
+9   bfa9742a4ee5   2009-06-14 00:27 +0000   deveiant
+  * Updated build system.
+
+8   c9c79767104a   2009-05-29 02:46 +0000   deveiant
+  Fixed the log-toggle click handler.
+
+7   6306a3c2e23f   2009-05-28 23:40 +0000   deveiant
+  * Qualify the data directory of the formatter as its gem path if its loaded as a gem.
+
+6   70e99153196a   2009-05-10 21:00 +0000   deveiant
+  * Updated for RSpec 1.2.4
+
+5   d8cf7477aa41   2009-04-29 13:23 +0000   deveiant
+  Updated build.
+
+4   f479fadaffd8   2009-04-28 00:50 +0000   deveiant
+  * Upgraded to RSpec 1.2.4.
+
+3   0ee8ca9d463a   2009-04-27 16:57 +0000   deveiant
+  Added alternative TextMate RSpec runner.
+
+2   db46f308449c   2009-04-27 16:50 +0000   deveiant
+  * Updated with an in-progress timer that shows the graph as a progress bar
+
+1   2afa45a6e2c6   2009-04-27 13:26 +0000   deveiant
+  Added the build system.
+
+0   de236604bbaf   2009-04-27 13:20 +0000   deveiant
+  Initial import
+

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2009-2010, Michael Granger
+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.
+
+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.

data/README.md

@@ -0,0 +1,26 @@
+# A WebKit RSpec Formatter
+
+This is a formatter for RSpec 2 that takes advantage of features in [WebKit](http://webkit.org/) to make the output from RSpec in Textmate more fun.
+
+Test output looks like this:
+
+![Example Output](http://deveiate.org/images/tmrspec-example.png)
+
+## Installation
+
+To get started, install the `webkit-rspec-formatter` gem:
+
+    $ gem install webkit-rspec-formatter
+
+If you're running specs in Textmate via [the RSpec bundle](http://github.com/rspec/rspec-tmbundle), you can use the webkit formatter by opening Textmate's 'Advanced' Preferences and adding a `TM_RSPEC_OPTS` Shell Variable with the value `--format RSpec::Core::Formatters::WebKit`:
+
+![Setting TM_RSPEC_OPTS](http://deveiate.org/images/tmrspecopts-shellvar.png)
+
+That's it!
+
+## Miscellaneous
+
+It's also usable anywhere else the standard HTML formatter is, of course. Also, while it's specifically intended to be used under the Textmate HTML viewer that the RSpec bundle uses, the output should work fine under recent Gecko/Firefox-based viewers, as well. 
+
+Patches/suggestions welcomed.
+

data/Rakefile

@@ -0,0 +1,370 @@
+#!rake -*- ruby -*-
+#
+# WebKit-RSpec-Formatter rakefile
+#
+# Based on various other Rakefiles, especially one by Ben Bleything
+#
+# Copyright (c) 2007-2010 The FaerieMUD Consortium
+#
+# Authors:
+#  * Michael Granger <ged@FaerieMUD.org>
+#
+
+BEGIN {
+	require 'rbconfig'
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname
+
+	libdir = basedir + "lib"
+	extdir = libdir + Config::CONFIG['sitearch']
+
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+	$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 )
+}
+
+begin
+	require 'readline'
+	include Readline
+rescue LoadError
+	# Fall back to a plain prompt
+	def readline( text )
+		$stderr.print( text.chomp )
+		return $stdin.gets
+	end
+end
+
+begin
+	require 'rubygems'
+rescue LoadError
+	module Gem
+		class Specification; end
+	end
+end
+
+require 'rbconfig'
+require 'rake'
+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'
+
+MANUALDIR     = DOCSDIR + 'manual'
+
+PROJECT_NAME  = 'WebKit-RSpec-Formatter'
+PKG_NAME      = PROJECT_NAME.downcase
+PKG_SUMMARY   = 'A webkit-aware pretty formatter for RSpec'
+
+# Cruisecontrol stuff
+CC_BUILD_LABEL     = ENV['CC_BUILD_LABEL']
+CC_BUILD_ARTIFACTS = ENV['CC_BUILD_ARTIFACTS'] || 'artifacts'
+
+VERSION_FILE  = LIBDIR + 'rspec/core/formatters/webkit.rb'
+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 ]
+end
+
+PKG_VERSION = '0.0.0' unless defined?( PKG_VERSION ) && !PKG_VERSION.nil?
+
+PKG_FILE_NAME = "#{PKG_NAME.downcase}-#{PKG_VERSION}"
+GEM_FILE_NAME = "#{PKG_FILE_NAME}.gem"
+
+# Universal VCS constants
+DEFAULT_EDITOR  = 'vi'
+COMMIT_MSG_FILE = 'commit-msg.txt'
+FILE_INDENT     = " " * 12
+LOG_INDENT      = " " * 3
+
+EXTCONF       = EXTDIR + 'extconf.rb'
+
+ARTIFACTS_DIR = Pathname.new( CC_BUILD_ARTIFACTS )
+
+TEXT_FILES    = Rake::FileList.new( %w[Rakefile ChangeLog README* LICENSE] )
+BIN_FILES     = Rake::FileList.new( "#{BINDIR}/*" )
+LIB_FILES     = Rake::FileList.new( "#{LIBDIR}/**/*.rb" )
+EXT_FILES     = Rake::FileList.new( "#{EXTDIR}/**/*.{c,h,rb}" )
+DATA_FILES    = Rake::FileList.new( "#{DATADIR}/**/*" )
+
+SPECDIR       = BASEDIR + 'spec'
+SPECLIBDIR    = SPECDIR + 'lib'
+SPEC_FILES    = Rake::FileList.new( "#{SPECDIR}/**/*_spec.rb", "#{SPECLIBDIR}/**/*.rb" )
+
+TESTDIR       = BASEDIR + 'tests'
+TEST_FILES    = Rake::FileList.new( "#{TESTDIR}/**/*.tests.rb" )
+
+RAKE_TASKDIR  = BASEDIR + 'rake'
+RAKE_TASKLIBS = Rake::FileList.new( "#{RAKE_TASKDIR}/*.rb" )
+PKG_TASKLIBS  = Rake::FileList.new( "#{RAKE_TASKDIR}/{191_compat,helpers,packaging,rdoc,testing}.rb" )
+PKG_TASKLIBS.include( "#{RAKE_TASKDIR}/manual.rb" ) if MANUALDIR.exist?
+
+RAKE_TASKLIBS_URL = 'http://repo.deveiate.org/rake-tasklibs'
+
+LOCAL_RAKEFILE = BASEDIR + 'Rakefile.local'
+
+EXTRA_PKGFILES = Rake::FileList.new
+EXTRA_PKGFILES.include( "#{BASEDIR}/data/**/*" )
+
+RELEASE_FILES = TEXT_FILES + 
+	SPEC_FILES + 
+	TEST_FILES + 
+	BIN_FILES +
+	LIB_FILES + 
+	EXT_FILES + 
+	DATA_FILES + 
+	RAKE_TASKLIBS +
+	EXTRA_PKGFILES
+
+
+RELEASE_FILES << LOCAL_RAKEFILE.to_s if LOCAL_RAKEFILE.exist?
+
+RELEASE_ANNOUNCE_ADDRESSES = [
+	"Ruby-Talk List <ruby-talk@ruby-lang.org>",
+]
+
+COVERAGE_MINIMUM = ENV['COVERAGE_MINIMUM'] ? Float( ENV['COVERAGE_MINIMUM'] ) : 85.0
+RCOV_EXCLUDES = 'spec,tests,/Library/Ruby,/var/lib,/usr/local/lib'
+RCOV_OPTS = [
+	'--exclude', RCOV_EXCLUDES,
+	'--xrefs',
+	'--save',
+	'--callsites',
+	#'--aggregate', 'coverage.data' # <- doesn't work as of 0.8.1.2.0
+  ]
+
+
+### Load some task libraries that need to be loaded early
+if !RAKE_TASKDIR.exist?
+	$stderr.puts "It seems you don't have the build task directory. Shall I fetch it "
+	ans = readline( "for you? [y]" )
+	ans = 'y' if !ans.nil? && ans.empty?
+
+	if ans =~ /^y/i
+		$stderr.puts "Okay, fetching #{RAKE_TASKLIBS_URL} into #{RAKE_TASKDIR}..."
+		system 'hg', 'clone', RAKE_TASKLIBS_URL, "./#{RAKE_TASKDIR}"
+		if ! $?.success?
+			fail "Damn. That didn't work. Giving up; maybe try manually fetching?"
+		end
+	else
+		$stderr.puts "Then I'm afraid I can't continue. Best of luck."
+		fail "Rake tasklibs not present."
+	end
+
+	RAKE_TASKLIBS.include( "#{RAKE_TASKDIR}/*.rb" )
+end
+
+require RAKE_TASKDIR + 'helpers.rb'
+include RakefileHelpers
+
+# Set the build ID if the mercurial executable is available
+if hg = which( 'hg' )
+	id = `#{hg} id -n`.chomp
+	PKG_BUILD = (id.chomp[ /^[[:xdigit:]]+/ ] || '1')
+else
+	PKG_BUILD = '0'
+end
+SNAPSHOT_PKG_NAME = "#{PKG_FILE_NAME}.#{PKG_BUILD}"
+SNAPSHOT_GEM_NAME = "#{SNAPSHOT_PKG_NAME}.gem"
+
+# Documentation constants
+API_DOCSDIR = DOCSDIR + 'api'
+README_FILE = TEXT_FILES.find {|path| path =~ /^README/ } || 'README'
+RDOC_OPTIONS = [
+	'--tab-width=4',
+	'--show-hash',
+	'--include', BASEDIR.to_s,
+	"--main=#{README_FILE}",
+	"--title=#{PKG_NAME}",
+  ]
+YARD_OPTIONS = [
+	'--use-cache',
+	'--no-private',
+	'--protected',
+	'-r', README_FILE,
+	'--exclude', 'extconf\\.rb',
+	'--files', 'ChangeLog,LICENSE',
+	'--output-dir', API_DOCSDIR.to_s,
+	'--title', "#{PKG_NAME} #{PKG_VERSION}",
+  ]
+
+# Release constants
+SMTP_HOST = "mail.faeriemud.org"
+SMTP_PORT = 465 # SMTP + SSL
+
+# Project constants
+PROJECT_HOST = 'deveiate'
+PROJECT_PUBDIR = '/usr/local/www/public/code/'
+PROJECT_DOCDIR = "#{PROJECT_PUBDIR}/#{PKG_NAME}"
+PROJECT_SCPPUBURL = "#{PROJECT_HOST}:#{PROJECT_PUBDIR}"
+PROJECT_SCPDOCURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
+
+GEM_PUBHOST = 'rubygems.org'
+
+# Gem dependencies: gemname => version
+DEPENDENCIES = {
+	'rspec-core' => '>=2.0.1',
+}
+
+# Developer Gem dependencies: gemname => version
+DEVELOPMENT_DEPENDENCIES = {
+	'rake'         => '>= 0.8.7',
+	'rcodetools'   => '>= 0.7.0.0',
+	'rcov'         => '>= 0.8.1.2.0',
+	'rdoc'         => '>= 2.4.3',
+	'RedCloth'     => '>= 4.0.3',
+	'rspec'        => '>= 1.2.6',
+	'ruby-termios' => '>= 0.9.6',
+	'text-format'  => '>= 1.0.0',
+	'tmail'        => '>= 1.2.3.1',
+	'diff-lcs'     => '>= 1.1.2',
+}
+
+# Non-gem requirements: packagename => version
+REQUIREMENTS = {
+	'Rspec-Bundle' => '>=0',
+	'Textmate' => '>=0',
+}
+
+# RubyGem specification
+GEMSPEC   = Gem::Specification.new do |gem|
+	gem.name              = PKG_NAME.downcase
+	gem.version           = PKG_VERSION
+
+	gem.summary           = PKG_SUMMARY
+	gem.description       = [
+		"This is a formatter for RSpec that takes advantage of some of the advanced features of the webkit",
+		"HTML engine, like the one TextMate uses for its output.",
+  	  ].join( "\n" )
+	gem.post_install_message = [
+		"",
+		"You can use this formatter from TextMate (if you're using RSpec 2.0.0 ",
+		"or later) bysetting the TM_RSPEC_OPTS shell variable (in the ",
+		"'Advanced' preference pane) to:",
+		"",
+		"    --format RSpec::Core::Formatters::WebKit",
+		"",
+		"Have fun!",
+	  ].join( "\n" )
+
+	gem.authors           = "Michael Granger"
+	gem.email             = ["ged@FaerieMUD.org"]
+	gem.homepage          = 'http://deveiate.org/projects/WebKit-RSpec-Formatter'
+
+	gem.has_rdoc          = true
+	gem.rdoc_options      = RDOC_OPTIONS
+	gem.extra_rdoc_files  = TEXT_FILES - [ 'Rakefile' ]
+
+	gem.bindir            = BINDIR.relative_path_from(BASEDIR).to_s
+	gem.executables       = BIN_FILES.select {|pn| File.executable?(pn) }.
+	                            collect {|pn| File.basename(pn) }
+	gem.require_paths << EXTDIR.relative_path_from( BASEDIR ).to_s if EXTDIR.exist?
+
+	if EXTCONF.exist?
+		gem.extensions << EXTCONF.relative_path_from( BASEDIR ).to_s
+	end
+
+	gem.files             = RELEASE_FILES
+	gem.test_files        = SPEC_FILES
+
+	# signing key and certificate chain
+	gem.signing_key       = '/Volumes/Keys/ged-private_gem_key.pem'
+	gem.cert_chain        = [File.expand_path('~/.gem/ged-public_gem_cert.pem')]
+
+	DEPENDENCIES.each do |name, version|
+		version = '>= 0' if version.length.zero?
+		gem.add_runtime_dependency( name, version )
+	end
+
+	REQUIREMENTS.each do |name, version|
+		gem.requirements << [ name, version ].compact.join(' ')
+	end
+end
+
+$trace = Rake.application.options.trace ? true : false
+$dryrun = Rake.application.options.dryrun ? true : false
+$include_dev_dependencies = false
+
+# Load any remaining task libraries
+RAKE_TASKLIBS.each do |tasklib|
+	next if tasklib.to_s =~ %r{/helpers\.rb$}
+	begin
+		trace "  loading tasklib %s" % [ tasklib ]
+		import tasklib
+	rescue ScriptError => err
+		fail "Task library '%s' failed to load: %s: %s" %
+			[ tasklib, err.class.name, err.message ]
+		trace "Backtrace: \n  " + err.backtrace.join( "\n  " )
+	rescue => err
+		log "Task library '%s' failed to load: %s: %s. Some tasks may not be available." %
+			[ tasklib, err.class.name, err.message ]
+		trace "Backtrace: \n  " + err.backtrace.join( "\n  " )
+	end
+end
+
+# Load any project-specific rules defined in 'Rakefile.local' if it exists
+import LOCAL_RAKEFILE if LOCAL_RAKEFILE.exist?
+
+
+#####################################################################
+###	T A S K S 	
+#####################################################################
+
+### Default task
+task :default  => [:clean, :local, :spec, :apidocs, :package]
+
+### Task the local Rakefile can append to -- no-op by default
+task :local
+
+### Task: clean
+CLEAN.include 'coverage', '**/*.orig', '**/*.rej'
+CLOBBER.include 'artifacts', 'coverage.info', 'ChangeLog', PKGDIR
+
+### Task: changelog
+file 'ChangeLog' do |task|
+	log "Updating #{task.name}"
+
+	changelog = make_changelog()
+	File.open( task.name, 'w' ) do |fh|
+		fh.print( changelog )
+	end
+end
+
+
+### Task: cruise (Cruisecontrol task)
+desc "Cruisecontrol build"
+task :cruise => [:clean, 'spec:quiet', :package] do |task|
+	raise "Artifacts dir not set." if ARTIFACTS_DIR.to_s.empty?
+	artifact_dir = ARTIFACTS_DIR.cleanpath + (CC_BUILD_LABEL || Time.now.strftime('%Y%m%d-%T'))
+	artifact_dir.mkpath
+
+	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 )
+end
+
+
+desc "Update the build system to the latest version"
+task :update_build do
+	log "Updating the build system"
+	run 'hg', '-R', RAKE_TASKDIR, 'pull', '-u'
+	log "Updating the Rakefile"
+	sh 'rake', '-f', RAKE_TASKDIR + 'Metarakefile'
+end
+