pretty_face 0.4 → 0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9eeaa80ce445692b64cc177ab61914981f99195e
+  data.tar.gz: 07b5e419aaf7a8915c8001feda76d00f3f2dd279
+SHA512:
+  metadata.gz: 2e6d702f801dd887938086b978c8f96853fd2e66744a55aac81a67cd6bff58242ae75b5820fb1860df320f36c4bc57b64396575940b9f46c000dd41abe5bbf97
+  data.tar.gz: 526f55dc3f05b52d0025c7906c8a0fc4f2acd58e15a63922e5e154a6c22efded7b2d97c05406104ce0ecfae9f5641bd085c171131cf6ba750caad29e4a300894

data/.ruby-gemset

@@ -0,0 +1 @@
+testgen

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p195

data/ChangeLog

@@ -1,3 +1,9 @@
+=== Release 0.5 / 2013-7-19
+* Updated ReadMe
+* Displaying step definition on step failure
+* Added color to scenario headers indicating status
+* Changed styling of scenario reporting
+
 === Release 0.4 / 2013-4-13
 * Make replacement items optional
 * Updated actionpack dependency to the latest version 3.2.13

data/Gemfile

@@ -6,7 +6,8 @@ gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
 gem 'growl'
 gem 'guard-rspec'
 gem 'guard-cucumber'
-
+gem 'page-object'
+gem 'syntax'
 
 # Specify your gem's dependencies in pretty_face.gemspec
 gemspec

data/README.md

@@ -1,11 +1,25 @@
 # pretty_face
 
-HTML report for cucumber and rspec.  You can customize the report by editing an erb file.
+HTML report for cucumber.  You can customize the report by editing an erb file.
 
-The current release is very basic but you can expect a lot more over the next month or so.  If you wish to use this formatter you can simply add the following to your command-line or cucumber.yml profile:
+The current release is very basic but you can expect a lot more over the next month or so.  
+
+## Getting Started
+
+### Download gem
+Add the gem to your Gemfile
+
+   `gem 'pretty_face'`
+
+Then do a  `bundle update` to get the latest version
+
+### Add Formatter
+Update your profile in cucumber.yml file with the following arguments 
 
     --format PrettyFace::Formatter::Html --out index.html
-    
+
+You can also run cucumber from the command line with the same arguments.
+
 ## Customizing the report
 
 Starting with version 0.3 of the gem you can customize some elements on the report.  You will do this by first creating a directory named `pretty_face` in the `features/support` directory.  Customization files should be placed in this directory.

data/features/feature_pages.feature

@@ -69,8 +69,14 @@ Feature: pages that show details for features
 
   Scenario: It should display errors for features
     Then the file "results/basic.html" should contain "RSpec::Expectations::ExpectationNotMetError"
-    Then the file "results/advanced.html" should contain "RSpec::Expectations::ExpectationNotMetError"
-    Then the file "results/failing_background.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+    And the file "results/advanced.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+    And the file "results/failing_background.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+    
+@focus
+  Scenario: It should display error message with a yellow background and red text
+    Then the file "results/basic.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+    And the background of the error message row should be "255, 251, 211"
+    And the text of the of the error message row should be "194, 0, 0"
 
   Scenario: Embedding an image into the page
     Then the file "results/basic.html" should contain "<img id='img_0' style='display: none' src='images/autotrader.png'/>"

data/features/step_definitions/report_steps.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 
+
 When /^I have a logo file in the correct location$/ do
   FileUtils.cp "features/support/logo.png", "features/support/pretty_face/"
 end
@@ -23,3 +24,14 @@ end
 Then /^I should remove the feature header partial file$/ do
   FileUtils.rm "features/support/pretty_face/_feature_header.erb"
 end
+
+Then(/^the background of the error message row should be "(.*?)"$/) do |background|
+  @browser = Watir::Browser.new :firefox
+  visit ErrorDisplay do |page|
+    page.error_background.should include background
+  end
+end
+
+Then(/^the text of the of the error message row should be "(.*?)"$/) do |color|
+  on(ErrorDisplay).error_text_color.should include color
+end

data/features/support/env.rb

@@ -1,9 +1,16 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
 
 require 'aruba/cucumber'
-
+require 'page-object'
 require 'pretty_face'
+require 'watir-webdriver'
+
+World PageObject::PageFactory
 
 Before do
   @dirs = [File.join(File.dirname(__FILE__), '..', '..')]
 end
+
+After do
+  @browser.close if @browser
+end

data/features/support/error_display.rb

@@ -0,0 +1,16 @@
+class ErrorDisplay
+  include PageObject
+
+  page_url "file://#{File.dirname(__FILE__)}/../../results/basic.html"
+
+  element(:error, :tr, :class => 'error')
+
+  def error_background
+    error_element.style('background-color')
+  end
+
+  def error_text_color
+    error_element.style('color')
+  end
+  
+end

data/lib/pretty_face/formatter/html.rb

@@ -249,7 +249,7 @@ module PrettyFace
         end
       end
 
-      def step_error(exception, step)
+      def step_error(exception)
         return nil if exception.nil?
         exception.backtrace[-1] =~ /^#{step.file_colon_line}/ ? exception : nil
       end

data/lib/pretty_face/formatter/report.rb

@@ -191,9 +191,74 @@ module PrettyFace
       def has_table?
         not table.nil?
       end
+
       def has_multiline_arg?
         !multiline_arg.nil? && !has_table?
       end
+
+      def file_with_error(file_colon_line)
+        @snippet_extractor ||= SnippetExtractor.new
+        file, line = @snippet_extractor.file_name_and_line(file_colon_line)
+        file
+      end
+
+      #from cucumber ===================
+      def extra_failure_content(file_colon_line)
+        @snippet_extractor ||= SnippetExtractor.new
+        @snippet_extractor.snippet(file_colon_line)
+      end
+
+      class SnippetExtractor
+        require 'syntax/convertors/html';
+        @@converter = Syntax::Convertors::HTML.for_syntax "ruby"
+
+        def file_name_and_line(error_line)
+          if error_line =~ /(.*):(\d+)/
+            file = $1
+            line = $2.to_i
+            [file, line]
+          end
+        end
+
+        def snippet(error)
+          raw_code, line, file = snippet_for(error[0])
+          highlighted = @@converter.convert(raw_code, false)
+
+          "<pre class=\"ruby\"><strong>#{file + "\n"}</strong><code>#{post_process(highlighted, line)}</code></pre>"
+        end
+
+        def snippet_for(error_line)
+            file, line = file_name_and_line(error_line)
+          if file
+            [lines_around(file, line), line, file]
+          else
+            ["# Couldn't get snippet for #{error_line}", 1]
+          end
+        end
+
+        def lines_around(file, line)
+          if File.file?(file)
+            lines = File.open(file).read.split("\n")
+            min = [0, line-3].max
+            max = [line+1, lines.length-1].min
+            selected_lines = []
+            selected_lines.join("\n")
+            lines[min..max].join("\n")
+          else
+            "# Couldn't get snippet for #{file}"
+          end
+        end
+
+        def post_process(highlighted, offending_line)
+          new_lines = []
+          highlighted.split("\n").each_with_index do |line, i|
+            new_line = "<span class=\"linenum\">#{offending_line+i-2}</span>#{line}"
+            new_line = "<span class=\"offending\">#{new_line}</span>" if i == 2
+            new_lines << new_line
+          end
+          new_lines.join("\n")
+        end
+      end
     end
   end
 end

data/lib/pretty_face/templates/_step.erb

@@ -1,41 +1,46 @@
-            <%= "#{step.keyword} #{step.name}" %>
-            <% if step.has_table? %>
-              <br />
-              <table border="1">
-                <tr>
-                  <% step.table.first.each do |column| %>
-                    <th><%= column %></th>
-                  <% end %>
-                </tr>
-                <% step.table.delete_at 0 %>
-                <% step.table.each do |row| %>
-                  <tr>
-                    <% row.each do |column| %>
-                      <td><%= column %></td>
-                    <% end %>
-                  </tr>
-                <% end %>
-              </table>
-            <% end %>
-            <% if step.has_multiline_arg? %>
-              <br />
-              <table border="1">
-                <tr>
-                  <td><pre><%= step.multiline_arg %></pre></td>
-                </tr>
-              </table>
-            <% end %>
-            <% if step.failed_with_error? %>
-              <table>
-                <tr class="error">
-                  <td>
-                    <strong><%= "#{step.error.message} (#{step.error.class})" %></strong>
-                  </td>
-                </tr>
-                <tr class="error">
-                  <td>
-                    <pre><%= step.error.backtrace.join("\n") %></pre>
-                  </td>
-                </tr>
-              </table>
-            <% end %>
+<%= "#{step.keyword} #{step.name}" %>
+<% if step.has_table? %>
+	<br />
+	<table border="1" class="param_table">
+		<tr>
+			<% step.table.first.each do |column| %>
+				<th><%= column %></th>
+			<% end %>
+		</tr>
+		<% step.table.delete_at 0 %>
+		<% step.table.each do |row| %>
+			<tr>
+				<% row.each do |column| %>
+					<td><%= column %></td>
+				<% end %>
+			</tr>
+		<% end %>
+	</table>
+<% end %>
+<% if step.has_multiline_arg? %>
+	<br />
+	<table border="1" class="multiline_arg">
+		<tr>
+		 <td><pre><%= step.multiline_arg %></pre></td>
+		</tr>
+	</table>
+<% end %>
+<% if step.failed_with_error? %>
+	<table>
+		<tr class="error">
+			<td class="message">
+				<strong><pre><%= "#{step.error.message} (#{step.error.class})" %></pre></strong>
+			</td>
+		</tr>
+		<tr>
+			<td>
+				<%= raw(step.extra_failure_content(step.error.backtrace)) %>
+			</td>
+		</tr>
+		<tr >
+			<td class="detail">
+					<pre><%= step.error.backtrace.join("\n") %></pre>
+			</td>
+		</tr>
+	</table>
+<% end %>

data/lib/pretty_face/templates/feature.erb

@@ -33,7 +33,7 @@
         <tr>
           <th></th>
           <th>Executed</th>
-          <th>Passed</th>
+	  <th >Passed</th>
           <th>Failed</th>
           <th>Skipped</th>
           <th>Undefined</th>
@@ -43,7 +43,7 @@
         <tr>
           <td class="summary_row_header">Scenarios</td>
           <td><%= feature.scenarios.length %></td>
-          <td><%= feature.scenario_summary_for :passed %></td>
+          <td class="summary"><%= feature.scenario_summary_for :passed %></td>
           <td><%= feature.scenario_summary_for :failed %></td>
           <td><%= feature.scenario_summary_for :skipped %></td>
           <td><%= feature.scenario_summary_for :undefined %></td>
@@ -63,17 +63,17 @@
       </table>
     </div>
 
-    <div style="width: 100%; float: left;">
+    <div style="width: 60%; float: left;">
       <% if feature.has_background? %>
       <br />
       <h2 class="failures">Background: <%= feature.background_title.name %></h2>
       <% end %>
-      <table cellspacing="0" cellpadding="7" border="0" class="failed">
+      <table cellspacing="0" cellpadding="7" border="0" width="100%">
       <% feature.background_steps.each do |step| %>
         <tr>
           <td><%= raw(feature.image_tag_for(step.status, feature.file)) %></td>
           <td>
-            <%= render "step", :step => step %>
+            <%= render "step", step: step %>
           </td>
         </tr>
       <% end %>
@@ -82,57 +82,18 @@
       <h2 class="failures">Scenarios:</h2>
       <br />
       <% feature.scenarios.each do |scenario| %>
-      <table cellspacing="0" cellpadding="7" border="0" class="scenario <%= scenario.status %>">
-        <tr style="background-color: #E0E0E0;">
-          <th></th>
-          <th><%= scenario.name %></th>
+      <table cellspacing="0" cellpadding="7" class="scenario" width="100%">
+      <tr >
+          <th colspan="2" class="<%= scenario.status.to_s %>"><%= scenario.name %></th>
         </tr>
         <% scenario.steps.each do |step| %>
-        <tr>
-          <td> <%= raw(feature.image_tag_for(step.status, feature.file)) %></td>
-          <td>
-            <%= "#{step.keyword} #{step.name}" %>
-            <% if step.has_table? %>
-              <br />
-              <table class="param_table">
-                <tr>
-                  <% step.table.first.each do |column| %>
-                    <th><%= column %></th>
-                  <% end %>
-                </tr>
-                <% step.table.delete_at 0 %>
-                <% step.table.each do |row| %>
-                  <tr>
-                    <% row.each do |column| %>
-                      <td><%= column %></td>
-                    <% end %>
-                  </tr>
-                <% end %>
-              </table>
-            <% end %>
-            <% if step.has_multiline_arg? %>
-              <br />
-              <div class="multiline_arg">
-                <pre><code><%= step.multiline_arg %></code></pre>
-              </div>
-            <% end %>
-            <% if step.failed_with_error? %>
-              <table>
-                <tr class="error message">
-                  <td>
-                    <%= "#{step.error.message} (#{step.error.class})" %>
-                  </td>
-                </tr>
-                <tr class="error detail">
-                  <td>
-                    <pre><%= step.error.backtrace.join("\n") %></pre>
-                  </td>
-                </tr>
-              </table>
-            <% end %>
+	  <tr class="borderSeparator">
+          <td class="image_tag"> <%= raw(feature.image_tag_for(step.status, feature.file)) %></td>
+		  <td>
+	  <%= render "step", step: step %>
           </td>
-        </tr>
-      <% end %>
+	  </tr>
+        <% end %>
       </table>
       <% if scenario.has_image? %>
         <a href='' onclick="img=document.getElementById('<%= scenario.image_id %>'); img.style.display = (img.style.display == 'none' ? 'block' : 'none');return false"><%= "#{scenario.image_label}" %></a><br />

data/lib/pretty_face/templates/style.css

@@ -44,8 +44,23 @@ h2 {
   text-align: inherit;
   width: inherit;
 }
-.failed td {
-  font-size: 1em;
+
+.failed {
+  background-color: #C20000;
+  color: white;
+  border-color: #333333;
+}
+.passed {
+  background-color: #3d7700;
+  color: white;
+}
+.pending {
+  background-color: #faf834;
+
+}
+.undefined {
+  background-color: #e0ffff;
+
 }
 .footer {
   width: 100%;
@@ -85,7 +100,21 @@ h2 {
   background-color: #F0F0F0;
   font-size: 1em;
 }
+table.scenario {
+  border-width: 2px;
+  border-color: #cccccc;
+  border-style: solid;
+  border-collapse: collapse;
+}
 
+.borderSeparator {
+  border-top: 1px solid #ccc;
+}
+
+td.image_tag {
+  text-align: center;
+  vertical-align: text-top;
+}
 .description {
   border: 1px dotted #CCCCCC;
   border-radius: 8px 8px 8px 8px;
@@ -130,20 +159,91 @@ h2 {
 }
 
 .error {
-  color: #b94a48;
-  background-color: #f2dede;
+  color: #C20000;
+  background-color: #FFFBD3;
   border-color: #eed3d7;
 }
 
 .message td {
-  padding: 10px;
+  padding: 5px;
   font-weight: bold;
-  border-radius: 18px 18px 0px 0px;
 }
 
 .detail td {
   margin-left: 10px;
-  padding: 10px;
-  border-radius: 0px 0px 18px 18px;
+  padding: 7px;
+  font-weight: normal;
 }
 
+
+
+.ruby {
+  font-size: 12px;
+  font-family: monospace;
+  color: white;
+  background: black;
+  padding: 0.1em 0 0.2em 0;
+}
+.ruby .keyword {
+  color: #ff6600;
+}
+.ruby .constant {
+  color: #339999;
+}
+.ruby .attribute {
+  color: white;
+}
+.ruby .global {
+  color: white;
+}
+.ruby .module {
+  color: white;
+}
+.ruby .class {
+  color: white;
+}
+.ruby .string {
+  color: #66ff00;
+}
+.ruby .ident {
+  color: white;
+}
+.ruby .method {
+  color: #ffcc00;
+}
+.ruby .number {
+  color: white;
+}
+.ruby .char {
+  color: white;
+}
+.ruby .comment {
+  color: #9933cc;
+}
+.ruby .symbol {
+  color: white;
+}
+.ruby .regex {
+  color: #44b4cc;
+}
+.ruby .punct {
+  color: white;
+}
+.ruby .escape {
+  color: white;
+}
+.ruby .interp {
+  color: white;
+}
+.ruby .expr {
+  color: white;
+}
+.ruby .offending {
+  background: #333333;
+}
+.ruby .linenum {
+  width: 75px;
+  padding: 0.1em 1em 0.2em 0;
+  color: black;
+  background: #fffbd3;
+}

data/lib/pretty_face/version.rb

@@ -1,3 +1,3 @@
 module PrettyFace
-  VERSION = "0.4"
+  VERSION = "0.5"
 end

data/pretty_face.gemspec

@@ -5,8 +5,9 @@ require "pretty_face/version"
 Gem::Specification.new do |s|
   s.name        = "pretty_face"
   s.version     = PrettyFace::VERSION
-  s.authors     = ["Jeffrey S. Morgan", "Joel Byler", "Steve Jackson"]
-  s.email       = ["jeff.morgan@leandog.com", "joelbyler@gmail.com", "steve.jackson@leandogsoftware.com"]
+  s.license     = 'MIT'
+  s.authors     = ["Jeffrey S. Morgan", "Joel Byler", "Steve Jackson", "Sahithya Wintrich", "Carl Shotwell"]
+  s.email       = ["jeff.morgan@leandog.com", "joelbyler@gmail.com", "steve.jackson@leandogsoftware.com", "sahithya.wintrich@gmail.com", "carl.shotwell@leandog.com"]
   s.homepage    = "http://github.com/cheezy/pretty_face"
   s.summary     = %q{HTML Report/Formatter  for Cucumber and RSpec}
   s.description = %q{HTML Report/Formatter for cucumber that allows user to modify erb in order to customize.}
@@ -19,6 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "actionpack", ">= 3.2.13"
+  s.add_dependency "syntax"
 
   s.add_development_dependency "cucumber"
   s.add_development_dependency "rspec"

metadata

@@ -1,96 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: pretty_face
 version: !ruby/object:Gem::Version
-  version: '0.4'
-  prerelease: 
+  version: '0.5'
 platform: ruby
 authors:
 - Jeffrey S. Morgan
 - Joel Byler
 - Steve Jackson
+- Sahithya Wintrich
+- Carl Shotwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-13 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: HTML Report/Formatter for cucumber that allows user to modify erb in
@@ -99,13 +104,16 @@ email:
 - jeff.morgan@leandog.com
 - joelbyler@gmail.com
 - steve.jackson@leandogsoftware.com
+- sahithya.wintrich@gmail.com
+- carl.shotwell@leandog.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - ChangeLog
 - Gemfile
@@ -120,6 +128,7 @@ files:
 - features/support/_feature_header.erb
 - features/support/_suite_header.erb
 - features/support/env.rb
+- features/support/error_display.rb
 - features/support/hooks.rb
 - features/support/logo.png
 - features/support/pretty_face/blah.txt
@@ -171,28 +180,28 @@ files:
 - spec/lib/html_formatter_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/cheezy/pretty_face
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: pretty_face
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: HTML Report/Formatter  for Cucumber and RSpec
 test_files:
 - features/feature_pages.feature
@@ -201,6 +210,7 @@ test_files:
 - features/support/_feature_header.erb
 - features/support/_suite_header.erb
 - features/support/env.rb
+- features/support/error_display.rb
 - features/support/hooks.rb
 - features/support/logo.png
 - features/support/pretty_face/blah.txt

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.9.3-p392@testgen --create