webkit-rspec-formatter 2.0.0

data/data/webkit-rspec-formatter/templates/page.rhtml

@@ -0,0 +1,131 @@
+			<div class="example-group"> 
+				<dl> 
+					<dt id="example-group-1">Treequel::Filter</dt> 
+					<dd class="spec passed"><span class="spec-name">knows that it is promiscuous (will match any entry) if its component is promiscuous</span></dd> 
+					<dd class="spec passed"><span class="spec-name">knows that it isn't promiscuous if its component isn't promiscuous</span></dd> 
+					<dd class="spec passed"><span class="spec-name">defaults to selecting everything</span></dd> 
+					<dd class="spec passed"><span class="spec-name">can be created from a string literal</span></dd> 
+					<dd class="spec passed"><span class="spec-name">wraps string literal instances in parens if it requires them</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a single Symbol argument as a presence filter</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a single-element Array with a Symbol as a presence filter</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a Symbol+value pair as a simple item equal filter</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a Symbol+value pair in an Array as a simple item equal filter</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses an AND expression with only a single clause</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses an AND expression with multiple clauses</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses an OR expression with only a single clause</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses an OR expression with multiple clauses</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses an OR expression with String literal clauses</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses the hash form of OR expression</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a NOT expression with only a single clause</span></dd> 
+					<dd class="spec passed"><span class="spec-name">raises an exception with a NOT expression that contains more than one clause</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a Substring item from a filter that includes an asterisk</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a Present item from a filter that is only an asterisk</span></dd> 
+					<dd class="spec passed"><span class="spec-name">raises an error when an extensible item filter is given</span></dd> 
+					<dd class="spec passed"><span class="spec-name">parses a complex nested expression</span></dd> 
+				</dl> 
+			</div> 
+			<div class="example-group"> 
+				<dl> 
+					<dt id="example-group-2">Treequel::Filter operator methods</dt> 
+					<dd class="spec passed"><span class="spec-name">compares as equal with another filter if their components are equal</span></dd> 
+					<dd class="spec passed"><span class="spec-name">creates a new AND filter out of two filters that are added together</span></dd> 
+					<dd class="spec passed"><span class="spec-name">creates a new AND filter out of two filters that are bitwise-ANDed together</span></dd> 
+					<dd class="spec passed"><span class="spec-name">doesn't include the left operand in an AND filter if it is promiscuous</span></dd> 
+					<dd class="spec passed"><span class="spec-name">doesn't include the right operand in an AND filter if it is promiscuous</span></dd> 
+				</dl> 
+			</div> 
+			<div class="example-group"> 
+				<dl> 
+					<dt id="example-group-3">Treequel::Filter components: Treequel::Filter::FilterList</dt> 
+					<dd class="spec passed"><span class="spec-name">stringifies by joining its stringified members</span></dd> 
+				</dl> 
+			</div> 
+			<div class="example-group"> 
+				<dl> 
+					<dt id="example-group-4">Treequel::Filter components: Treequel::Filter::Component</dt> 
+					<dd class="spec passed"><span class="spec-name">is an abstract class</span></dd> 
+					<dd class="spec passed"><span class="spec-name">is non-promiscuous by default</span></dd> 
+				</dl> 
+			</div> 
+			<div class="example-group"> 
+				<dl> 
+					<dt id="example-group-5">Treequel::Filter components: Treequel::Filter::SimpleItemComponent</dt> 
+					<dd class="spec passed"><span class="spec-name">can parse a component object from a string literal</span></dd> 
+					<dd class="spec passed"><span class="spec-name">raises an ExpressionError if it can't parse a string literal</span></dd> 
+					<dd class="spec passed"><span class="spec-name">uses the 'equal' operator if none is specified</span></dd> 
+					<dd class="spec passed"><span class="spec-name">knows what the appropriate operator is for its filtertype</span></dd> 
+					<dd class="spec passed"><span class="spec-name">knows what the appropriate operator is for its filtertype even if it's set to a string</span></dd> 
+					<dd class="spec passed"><span class="spec-name">stringifies as &lt;attribute&gt;&lt;operator&gt;&lt;value&gt;</span></dd> 
+					<dd class="spec passed"><span class="spec-name">uses the '~=' operator if its filtertype is 'approx'</span></dd> 
+					<dd class="spec passed"><span class="spec-name">uses the '&gt;=' operator if its filtertype is 'greater'</span></dd> 
+					<dd class="spec pending"><span class="spec-name">uses the '&lt;=' operator if its filtertype is 'less' (PENDING: Because I can)</span></dd> 
+					<dd class="spec passed"><span class="spec-name">raises an error if it's created with an unknown filtertype</span></dd> 
+				</dl> 
+			</div> 
+			<div class="example-group"> 
+				<dl> 
+					<dt id="example-group-6">Treequel::Filter components: Treequel::Filter::SubstringItemComponent</dt> 
+					<dd class="spec failed"> 
+						<span class="spec-name">can parse a component object from a string literal</span> 
+						<div class="failure" id="failure-1"> 
+							<div class="message"><code>undefined local variable or method `saadsdf' for #&lt;Spec::Example::ExampleGroup::Subclass_1::Subclass_2::Subclass_4:0x1b343d0&gt;</code></div> 
+							<div class="backtrace">
+								<code><a href="txmt://open?url=file:///Users/ged/source/ruby/Treequel/spec/treequel/filter_spec.rb&amp;line=296">/Users/ged/source/ruby/Treequel/spec/treequel/filter_spec.rb:296</a> -:3</code></div> 
+								<pre class="ruby"><code>
+<span class="linenum">294</span>				<span class="ident">comp</span><span class="punct">.</span><span class="ident">attribute</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">'</span><span class="string">description</span><span class="punct">'</span> 
+<span class="linenum">295</span>				<span class="ident">comp</span><span class="punct">.</span><span class="ident">options</span><span class="punct">.</span><span class="ident">should</span>   <span class="punct">==</span> <span class="punct">'</span><span class="string"></span><span class="punct">'</span> 
+<span class="offending"><span class="linenum">296</span>				<span class="ident">saadsdf</span></span> 
+<span class="linenum">297</span>				<span class="ident">comp</span><span class="punct">.</span><span class="ident">pattern</span><span class="punct">.</span><span class="ident">should</span>   <span class="punct">==</span> <span class="punct">'</span><span class="string">*basecamp*</span><span class="punct">'</span> 
+<span class="linenum">298</span>			<span class="keyword">end</span>
+								</code></pre> 
+							</div> 
+						</dd> 
+						<dd class="spec passed"><span class="spec-name">can parse a component object from a string literal with attribute options</span></dd> 
+						<dd class="spec passed"><span class="spec-name">raises an ExpressionError if it can't parse a string literal</span></dd> 
+					</dl> 
+				</div> 
+				<div class="example-group"> 
+					<dl> 
+						<dt id="example-group-7">Treequel::Filter components: Treequel::Filter::AndComponent</dt> 
+						<dd class="spec passed"><span class="spec-name">stringifies as its filters ANDed together</span></dd> 
+						<dd class="spec passed"><span class="spec-name">allows a single filter</span></dd> 
+					</dl> 
+				</div> 
+				<div class="example-group"> 
+					<dl> 
+						<dt id="example-group-8">Treequel::Filter components: Treequel::Filter::OrComponent</dt> 
+						<dd class="spec passed"><span class="spec-name">stringifies as its filters ORed together</span></dd> 
+						<dd class="spec failed"> 
+							<span class="spec-name">allows a single filter</span> 
+							<div class="failure" id="failure-2"> 
+								<div class="message"><code>undefined local variable or method `sdsdf' for #&lt;Spec::Example::ExampleGroup::Subclass_1::Subclass_2::Subclass_6:0x1af8308&gt;</code></div> 
+								<div class="backtrace"><code><a href="txmt://open?url=file:///Users/ged/source/ruby/Treequel/spec/treequel/filter_spec.rb&amp;line=335">/Users/ged/source/ruby/Treequel/spec/treequel/filter_spec.rb:335</a> -:3</code></div> 
+								<pre class="ruby"><code>
+<span class="linenum">333</span> 
+<span class="linenum">334</span>			<span class="ident">it</span> <span class="punct">&quot;</span><span class="string">allows a single filter</span><span class="punct">&quot;</span> <span class="keyword">do</span> 
+<span class="offending"><span class="linenum">335</span>				<span class="ident">sdsdf</span></span> 
+<span class="linenum">336</span>				<span class="constant">Treequel</span><span class="punct">::</span><span class="constant">Filter</span><span class="punct">::</span><span class="constant">OrComponent</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span> <span class="attribute">@filter1</span> <span class="punct">).</span><span class="ident">to_s</span><span class="punct">.</span> 
+<span class="linenum">337</span>					<span class="ident">should</span> <span class="punct">==</span> <span class="punct">'</span><span class="string">|(filter1)</span><span class="punct">'</span>
+								</code></pre> 
+							</div> 
+						</dd> 
+					</dl> 
+				</div> 
+				<div class="example-group"> 
+					<dl> 
+						<dt id="example-group-9">Treequel::Filter components: Treequel::Filter::NotComponent</dt> 
+						<dd class="spec passed"><span class="spec-name">stringifies as the negation of its filter</span></dd> 
+						<dd class="spec passed"><span class="spec-name">can't be created with multiple filters</span></dd> 
+					</dl> 
+				</div> 
+				<div class="example-group"> 
+					<dl> 
+						<dt id="example-group-10">Treequel::Filter support for Sequel expressions</dt> 
+						<dd class="spec passed"><span class="spec-name">supports the boolean expression syntax</span></dd> 
+					</dl> 
+				</div> 
+			</div> 
+		</div> 
+		
+	</body> 
+	</html>

data/data/webkit-rspec-formatter/templates/passed.rhtml

@@ -0,0 +1,10 @@
+<dd class="spec passed">
+	<span class="spec-name"><%= h(example.description) %></span>
+
+% unless log_messages.nil? || log_messages.empty?
+  <div class="log-messages">
+<%= log_messages.join("\n") %>
+  </div>
+% end
+</dd>
+

data/data/webkit-rspec-formatter/templates/pending-fixed.rhtml

@@ -0,0 +1,25 @@
+
+<dd class="spec pending-fixed">
+	<span class="spec-name"><%= h(example.description) %></span>
+  <div class="failure" id="failure-<%= counter %>">
+
+    <div class="message">Expected pending 
+        <code><%= h(example.metadata[:execution_result][:pending_message]) %></code>
+        to fail. No Error was raised.
+    </div>
+
+		<div class="backtrace"><p><code>
+%     format_backtrace(exception.backtrace, example).each do |backtrace_info|
+	        <span class="backtrace-frame"><%= backtrace_info %></span><br />
+%     end
+		</code></p></div>
+    <%= extra %>
+	</div>
+
+% unless log_messages.nil? || log_messages.empty?
+  <div class="log-messages">
+<%= log_messages.join("\n") %>
+  </div>
+% end
+</dd>
+

data/data/webkit-rspec-formatter/templates/pending.rhtml

@@ -0,0 +1,14 @@
+
+<dd class="spec pending">
+	<span class="spec-name"><%= h(example.description) %></span>
+  <span class="pending-message">
+		(Pending <%= example.execution_result[:pending_message] %>)
+	</span>
+
+% unless log_messages.nil? || log_messages.empty?
+  <div class="log-messages">
+<%= log_messages.join("\n") %>
+  </div>
+% end
+</dd>
+

data/lib/rspec/core/formatters/web_kit.rb

@@ -0,0 +1,4 @@
+# Alow the formatter to be loaded as rspec/core/formatters/web_kit
+
+require 'rspec/core/formatters/webkit'
+

data/lib/rspec/core/formatters/webkit.rb

@@ -0,0 +1,222 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require 'rbconfig'
+require 'erb'
+require 'pathname'
+
+require 'rspec' 
+require 'rspec/core/formatters/base_text_formatter'
+require 'rspec/core/formatters/snippet_extractor'
+
+class RSpec::Core::Formatters::WebKit < RSpec::Core::Formatters::BaseTextFormatter
+	include ERB::Util
+
+	# Version constant
+	VERSION = '2.0.0'
+
+	# Look up the datadir falling back to a relative path (mostly for prerelease testing)
+	DEFAULT_DATADIR = Pathname( Config.datadir('webkit-rspec-formatter') )
+	if DEFAULT_DATADIR.exist?
+		BASE_PATH = DEFAULT_DATADIR
+	else
+		BASE_PATH = Pathname( __FILE__ ).dirname.parent.parent.parent.parent +
+		 	'data/webkit-rspec-formatter'
+	end
+
+	# The base HREF used in the header to map stuff to the datadir
+	BASE_HREF        = "file://#{BASE_PATH}/"
+
+	# The directory to grab ERb templates out of
+	TEMPLATE_DIR     = BASE_PATH + 'templates'
+
+	# The page part templates
+	HEADER_TEMPLATE          = TEMPLATE_DIR + 'header.rhtml'
+	PASSED_EXAMPLE_TEMPLATE  = TEMPLATE_DIR + 'passed.rhtml'
+	FAILED_EXAMPLE_TEMPLATE  = TEMPLATE_DIR + 'failed.rhtml'
+	PENDING_EXAMPLE_TEMPLATE = TEMPLATE_DIR + 'pending.rhtml'
+	PENDFIX_EXAMPLE_TEMPLATE = TEMPLATE_DIR + 'pending-fixed.rhtml'
+	FOOTER_TEMPLATE          = TEMPLATE_DIR + 'footer.rhtml'
+
+
+	### Create a new formatter
+	def initialize( output ) # :notnew:
+		super
+		@previous_nesting_depth = 0
+		@example_number = 0
+		@failcounter = 0
+		@snippet_extractor = RSpec::Core::Formatters::SnippetExtractor.new
+		@example_templates = {
+			:passed        => self.load_template(PASSED_EXAMPLE_TEMPLATE),
+			:failed        => self.load_template(FAILED_EXAMPLE_TEMPLATE),
+			:pending       => self.load_template(PENDING_EXAMPLE_TEMPLATE),
+			:pending_fixed => self.load_template(PENDFIX_EXAMPLE_TEMPLATE),
+		}
+
+		Thread.current['logger-output'] = []
+	end
+
+
+	######
+	public
+	######
+
+	# Attributes made readable for ERb
+	attr_reader :example_group_number, :example_number, :example_count
+
+	# The counter for failed example IDs
+	attr_accessor :failcounter
+
+
+	### Start the page by rendering the header.
+	def start( example_count )
+		@output.puts self.render_header( example_count )
+		@output.flush
+	end
+
+
+	### Callback called by each example group when it's entered --
+	def example_group_started( example_group )
+		super
+		nesting_depth = example_group.ancestors.length
+
+		# Close the previous example groups if this one isn't a 
+		# descendent of the previous one
+		if @previous_nesting_depth.nonzero? && @previous_nesting_depth >= nesting_depth
+			( @previous_nesting_depth - nesting_depth + 1 ).times do
+				@output.puts "  </dl>", "</section>", "  </dd>"
+			end
+		end
+
+		@output.puts "<!-- nesting: %d, previous: %d -->" %
+			[ nesting_depth, @previous_nesting_depth ]
+		@previous_nesting_depth = nesting_depth
+
+		if @previous_nesting_depth == 1
+			@output.puts %{<section class="example-group">}
+		else
+			@output.puts %{<dd class="nested-group"><section class="example-group">}
+		end
+
+		@output.puts %{  <dl>},
+			%{  <dt id="%s">%s</dt>} % [
+			 	example_group.name.gsub(/[\W_]+/, '-').downcase,
+				h(example_group.description)
+			]
+		@output.flush
+	end
+	alias_method :add_example_group, :example_group_started
+
+
+	### Fetch any log messages added to the thread-local Array
+	def log_messages
+		return Thread.current[ 'logger-output' ] || []
+	end
+
+
+	### Callback -- called when the examples are finished.
+	def start_dump
+		@previous_nesting_depth.downto( 1 ) do |i|
+			@output.puts "  </dl>",
+			             "</section>"
+			@output.puts "  </dd>" unless i == 1
+		end
+
+		@output.flush
+	end
+
+
+	### Callback -- called when an example is entered
+	def example_started( example )
+		@example_number += 1
+		Thread.current[ 'logger-output' ] ||= []
+		Thread.current[ 'logger-output' ].clear
+	end
+
+
+	### Callback -- called when an example is exited with no failures.
+	def example_passed( example )
+		status = 'passed'
+		@output.puts( @example_templates[:passed].result(binding()) )
+		@output.flush
+	end
+
+
+	### Callback -- called when an example is exited with a failure.
+	def example_failed( example )
+		super
+
+		counter   = self.failcounter += 1
+		exception = example.metadata[:execution_result][:exception_encountered]
+		extra     = self.extra_failure_content( exception )
+		template  = if exception.is_a?( RSpec::Core::PendingExampleFixedError )
+			then @example_templates[:pending_fixed]
+			else @example_templates[:failed]
+			end
+
+		@output.puts( template.result(binding()) )
+		@output.flush
+	end
+
+
+	### Callback -- called when an example is exited via a 'pending'.
+	def example_pending( example )
+		status = 'pending'
+		@output.puts( @example_templates[:pending].result(binding()) )
+		@output.flush
+	end
+
+
+	### Format backtrace lines to include a textmate link to the file/line in question.
+	def backtrace_line( line )
+		return nil unless line = super
+		return nil if line =~ %r{r?spec/mate|textmate-command}
+		return h( line.strip ).gsub( /([^:]*\.rb):(\d*)/ ) do
+			"<a href=\"txmt://open?url=file://#{File.expand_path($1)}&amp;line=#{$2}\">#{$1}:#{$2}</a> "
+		end
+	end
+
+
+	### Return any stuff that should be appended to the current example
+	### because it's failed. Returns a snippet of the source around the
+	### failure.
+	def extra_failure_content( exception )
+		snippet = @snippet_extractor.snippet( exception )
+		return "    <pre class=\"ruby\"><code>#{snippet}</code></pre>"
+	end
+
+
+	### Returns content to be output when a failure occurs during the run; overridden to
+	### do nothing, as failures are handled by #example_failed.
+	def dump_failures( *unused )
+	end
+
+
+	### Output the content generated at the end of the run.
+	def dump_summary( duration, example_count, failure_count, pending_count )
+		@output.puts self.render_footer( duration, example_count, failure_count, pending_count )
+		@output.flush
+	end
+
+
+	### Render the header template in the context of the receiver.
+	def render_header( example_count )
+		template = self.load_template( HEADER_TEMPLATE )
+		return template.result( binding() )
+	end
+
+
+	### Render the footer template in the context of the receiver.
+	def render_footer( duration, example_count, failure_count, pending_count )
+		template = self.load_template( FOOTER_TEMPLATE )
+		return template.result( binding() )
+	end
+
+
+	### Load the ERB template at +templatepath+ and return it.
+	### @param [Pathname] templatepath  the fully-qualified path to the template file
+	def load_template( templatepath )
+		return ERB.new( templatepath.read, nil, '%<>' ).freeze
+	end
+
+end # class RSpec::Core::Formatter::WebKitFormatter

data/lib/rspec/mate/runner.rb

@@ -0,0 +1,65 @@
+
+rspec_rails_plugin = File.join( ENV['TM_PROJECT_DIRECTORY'], 'vendor', 'plugins', 'rspec', 'lib' )
+
+if File.directory?( rspec_rails_plugin )
+	$LOAD_PATH.unshift( rspec_rails_plugin )
+elsif ENV['TM_RSPEC_HOME']
+	rspec_lib = File.join( ENV['TM_RSPEC_HOME'], 'lib' )
+	raise "TM_RSPEC_HOME points to a bad location: #{ENV['TM_RSPEC_HOME']}" unless
+		File.directory?( rspec_lib )
+	$LOAD_PATH.unshift( rspec_lib )
+end
+
+begin
+	require 'spec'
+	require 'spec/runner/formatter/webkit'
+rescue LoadError => err
+	unless Object.const_defined?( :Gem )
+		require 'rubygems'
+		retry
+	end
+	raise
+end
+
+class SpecMate
+	def run_files(stdout, options={})
+		files = ENV['TM_SELECTED_FILES'].split(" ").map do |path|
+			File.expand_path(path[1..-2])
+		end
+		options.merge!({:files => files})
+		run(stdout, options)
+	end
+
+	def run_file(stdout, options={})
+		options.merge!({:files => [single_file]})
+		run(stdout, options)
+	end
+
+	def run_focussed(stdout, options={})
+		options.merge!({:files => [single_file], :line => ENV['TM_LINE_NUMBER']})
+		run(stdout, options)
+	end
+
+	def run(stdout, options)
+		formatter = ENV['TM_RSPEC_FORMATTER'] || 'RSpec::Core::Formatter::WebKit'
+
+		argv = []
+		argv += ENV['TM_RSPEC_OPTS'].split(" ") if ENV['TM_RSPEC_OPTS']
+		argv += options[:files].dup
+		argv << '--format' << formatter
+		argv << '--line' << options[:line] if options[:line]
+
+		Dir.chdir(ENV['TM_PROJECT_DIRECTORY']) do
+			::RSpec::Core::CommandLine.run(RSpec::Core::OptionParser.parse(argv, STDERR, stdout))
+		end
+	end
+
+	protected
+	def single_file
+		File.expand_path(ENV['TM_FILEPATH'])
+	end
+
+	def project_directory
+		File.expand_path(ENV['TM_PROJECT_DIRECTORY'])
+	end
+end