rspec-formatter-webkit 2.1.0

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,223 @@
+#!/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.1.0'
+
+	# Look up the datadir falling back to a relative path (mostly for prerelease testing)
+	DEFAULT_DATADIR = Pathname( Config.datadir('rspec-formatter-webkit') )
+	if DEFAULT_DATADIR.exist?
+		BASE_PATH = DEFAULT_DATADIR
+	else
+		BASE_PATH = Pathname( __FILE__ ).dirname.parent.parent.parent.parent +
+		 	'data/rspec-formatter-webkit'
+	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]
+		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 )
+		return '' unless 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

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-formatter-webkit
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 0
+  version: 2.1.0
+platform: ruby
+authors: 
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDLDCCAhSgAwIBAgIBADANBgkqhkiG9w0BAQUFADA8MQwwCgYDVQQDDANnZWQx
+  FzAVBgoJkiaJk/IsZAEZFgdfYWVyaWVfMRMwEQYKCZImiZPyLGQBGRYDb3JnMB4X
+  DTEwMDkxNjE0NDg1MVoXDTExMDkxNjE0NDg1MVowPDEMMAoGA1UEAwwDZ2VkMRcw
+  FQYKCZImiZPyLGQBGRYHX2FlcmllXzETMBEGCgmSJomT8ixkARkWA29yZzCCASIw
+  DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALy//BFxC1f/cPSnwtJBWoFiFrir
+  h7RicI+joq/ocVXQqI4TDWPyF/8tqkvt+rD99X9qs2YeR8CU/YiIpLWrQOYST70J
+  vDn7Uvhb2muFVqq6+vobeTkILBEO6pionWDG8jSbo3qKm1RjKJDwg9p4wNKhPuu8
+  KGue/BFb67KflqyApPmPeb3Vdd9clspzqeFqp7cUBMEpFS6LWxy4Gk+qvFFJBJLB
+  BUHE/LZVJMVzfpC5Uq+QmY7B+FH/QqNndn3tOHgsPadLTNimuB1sCuL1a4z3Pepd
+  TeLBEFmEao5Dk3K/Q8o8vlbIB/jBDTUx6Djbgxw77909x6gI9doU4LD5XMcCAwEA
+  AaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJeoGkOr9l4B
+  +saMkW/ZXT4UeSvVMA0GCSqGSIb3DQEBBQUAA4IBAQBG2KObvYI2eHyyBUJSJ3jN
+  vEnU3d60znAXbrSd2qb3r1lY1EPDD3bcy0MggCfGdg3Xu54z21oqyIdk8uGtWBPL
+  HIa9EgfFGSUEgvcIvaYqiN4jTUtidfEFw+Ltjs8AP9gWgSIYS6Gr38V0WGFFNzIH
+  aOD2wmu9oo/RffW4hS/8GuvfMzcw7CQ355wFR4KB/nyze+EsZ1Y5DerCAagMVuDQ
+  U0BLmWDFzPGGWlPeQCrYHCr+AcJz+NRnaHCKLZdSKj/RHuTOt+gblRex8FAh8NeA
+  cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
+  -----END CERTIFICATE-----
+
+date: 2010-12-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe-yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  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)
+email: 
+- ged@FaerieMUD.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- data/rspec-formatter-webkit/css/textmate-rspec.css
+- data/rspec-formatter-webkit/images/clock.png
+- data/rspec-formatter-webkit/images/cross_circle.png
+- data/rspec-formatter-webkit/images/cross_circle_frame.png
+- data/rspec-formatter-webkit/images/cross_octagon.png
+- data/rspec-formatter-webkit/images/cross_octagon_frame.png
+- data/rspec-formatter-webkit/images/cross_shield.png
+- data/rspec-formatter-webkit/images/exclamation.png
+- data/rspec-formatter-webkit/images/exclamation_frame.png
+- data/rspec-formatter-webkit/images/exclamation_shield.png
+- data/rspec-formatter-webkit/images/exclamation_small.png
+- data/rspec-formatter-webkit/images/plus_circle.png
+- data/rspec-formatter-webkit/images/plus_circle_frame.png
+- data/rspec-formatter-webkit/images/question.png
+- data/rspec-formatter-webkit/images/question_frame.png
+- data/rspec-formatter-webkit/images/question_shield.png
+- data/rspec-formatter-webkit/images/question_small.png
+- data/rspec-formatter-webkit/images/tick.png
+- data/rspec-formatter-webkit/images/tick_circle.png
+- data/rspec-formatter-webkit/images/tick_circle_frame.png
+- data/rspec-formatter-webkit/images/tick_shield.png
+- data/rspec-formatter-webkit/images/tick_small.png
+- data/rspec-formatter-webkit/images/tick_small_circle.png
+- data/rspec-formatter-webkit/images/ticket.png
+- data/rspec-formatter-webkit/images/ticket_arrow.png
+- data/rspec-formatter-webkit/images/ticket_exclamation.png
+- data/rspec-formatter-webkit/images/ticket_minus.png
+- data/rspec-formatter-webkit/images/ticket_pencil.png
+- data/rspec-formatter-webkit/images/ticket_plus.png
+- data/rspec-formatter-webkit/images/ticket_small.png
+- data/rspec-formatter-webkit/js/jquery-1.4.2.min.js
+- data/rspec-formatter-webkit/js/textmate-rspec.js
+- data/rspec-formatter-webkit/templates/failed.rhtml
+- data/rspec-formatter-webkit/templates/footer.rhtml
+- data/rspec-formatter-webkit/templates/header.rhtml
+- data/rspec-formatter-webkit/templates/page.rhtml
+- data/rspec-formatter-webkit/templates/passed.rhtml
+- data/rspec-formatter-webkit/templates/pending-fixed.rhtml
+- data/rspec-formatter-webkit/templates/pending.rhtml
+- docs/tmrspec-example.png
+- docs/tmrspecopts-shellvar.png
+- lib/rspec/core/formatters/web_kit.rb
+- lib/rspec/core/formatters/webkit.rb
+- History.md
+has_rdoc: yard
+homepage: http://deveiate.org/webkit-rspec-formatter.html
+licenses: 
+- BSD
+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!
+  
+rdoc_options: 
+- --use-cache
+- --protected
+- --verbose
+- --title
+- RspecFormatterWebkit Documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rspec-formatter-webkit
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: 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_files: []
+