pretty_face 0.1 → 0.2

data/lib/pretty_face/formatter/report.rb

@@ -1,6 +1,33 @@
 module PrettyFace
   module Formatter
 
+    module Formatting
+      def summary_percent(number, total)
+        percent = (number.to_f / total) * 100
+        "#{number} (#{'%.1f' % percent}%)"
+      end
+
+      def formatted_duration(duration)
+        m, s = duration.divmod(60)
+        "#{m}m#{'%.3f' % s}s"
+      end
+
+      def image_tag_for(status, source=nil)
+        dir = "#{directory_prefix_for(source)}images"
+        "<img src=\"#{dir}/#{status}.png\" alt=\"#{status}\" title=\"#{status}\" width=\"30\">"
+      end
+
+      def directory_prefix_for(source=nil)
+        dir = ''
+        back_dir = source.count('/') if source
+        back_dir.times do
+          dir += '../'
+        end
+        dir
+      end
+    end
+
+
     class Report
       attr_reader :features
 
@@ -24,44 +51,148 @@ module PrettyFace
         current_feature.scenarios << scenario
       end
 
+      def begin_background
+        @processing_background = true
+      end
+
+      def end_background
+        @processing_background = false
+      end
+
+      def processing_background_steps?
+        @processing_background
+      end
+
       def add_step(step)
         current_scenario.steps << step
       end
     end
 
     class ReportFeature
-      attr_accessor :title, :scenarios
+      include Formatting
+      attr_accessor :scenarios, :background, :description
+      attr_reader :title, :file, :start_time, :duration, :parent_filename
+
+      def initialize(feature, parent_filename)
+        @scenarios = []
+        @background = []
+        @start_time = Time.now
+        @description = feature.description
+        @parent_filename = parent_filename
+      end
+
+      def close(feature)
+        @title = feature.title
+        @duration = Time.now - start_time
+        a_file = feature.file.sub(/\.feature/, '.html')
+        to_cut = a_file.split('/').first
+        @file = a_file.sub("#{to_cut}/", '')
+      end
+
+      def steps
+        steps = []
+        scenarios.each { |scenario| steps += scenario.steps }
+        steps
+      end
+
+      def background_title
+        title = @background.find { |step| step.keyword.nil? }
+      end
 
-      def initialize(feature)
-        self.scenarios = []
+      def background_steps
+        @background.find_all { |step| step.keyword }
+      end
+
+      def scenarios_for(status)
+        scenarios.find_all { |scenario| scenario.status == status }
+      end
+
+      def scenario_summary_for(status)
+        scenarios_with_status = scenarios_for(status)
+        summary_percent(scenarios_with_status.length, scenarios.length)
+      end
+
+      def step_summary_for(status)
+        steps_with_status = steps.find_all { |step| step.status == status }
+        summary_percent(steps_with_status.length, steps.length)
+      end
+
+      def scenario_average_duration
+        durations = scenarios.collect { |scenario| scenario.duration }
+        formatted_duration(durations.reduce(:+).to_f / durations.size)
+      end
+
+      def step_average_duration
+        steps = scenarios.collect { |scenario| scenario.steps }
+        durations = steps.flatten.collect { |step| step.duration }
+        formatted_duration(durations.reduce(:+).to_f / durations.size)
+      end
+
+      def get_binding
+        binding
+      end
+
+      def description?
+        !description.nil?  && !description.empty?
+      end
+
+      def has_background?
+        background.length > 0
       end
     end
 
     class ReportScenario
-      attr_accessor :name, :file_colon_line, :status, :steps
+      attr_accessor :name, :file_colon_line, :status, :steps, :duration, :image, :image_label, :image_id
 
       def initialize(scenario)
-        self.steps = []
+        @steps = []
+        @start = Time.now
       end
 
       def populate(scenario)
+        @duration = Time.now - @start
         if scenario.instance_of? Cucumber::Ast::Scenario
-          self.name = scenario.name
-          self.file_colon_line = scenario.file_colon_line
+          @name = scenario.name
+          @file_colon_line = scenario.file_colon_line
         elsif scenario.instance_of? Cucumber::Ast::OutlineTable::ExampleRow
-          self.name = scenario.scenario_outline.name
-          self.file_colon_line = scenario.backtrace_line
+          @name = scenario.scenario_outline.name
+          @file_colon_line = scenario.backtrace_line
         end
-        self.status = scenario.status
+        @status = scenario.status
+      end
+
+      def has_image?
+        not image.nil?
       end
     end
 
     class ReportStep
-      attr_accessor :name, :file_colon_line, :status
+      attr_accessor :name, :keyword, :file_colon_line, :status, :duration, :table, :multiline_arg, :error
+
       def initialize(step)
-          self.name = step.name
-          self.file_colon_line = step.file_colon_line
-          self.status = step.status
+        @name = step.name
+        @file_colon_line = step.file_colon_line
+        unless step.instance_of? Cucumber::Ast::Background
+          if step.respond_to? :actual_keyword
+            @keyword = step.actual_keyword
+          else
+            @keyword = step.keyword
+          end
+          @status = step.status
+          @multiline_arg = step.multiline_arg
+          @error = step.exception
+        end
+      end
+
+      def failed_with_error?
+        status == :failed && !error.nil?
+      end
+
+      def has_table?
+        not table.nil?
+      end
+      def has_multiline_arg?
+        !multiline_arg.nil? && !has_table?
       end
     end
   end

data/lib/pretty_face/formatter/view_helper.rb

@@ -20,12 +20,17 @@ module PrettyFace
         @duration
       end
 
-      def step_average_duration
-        format_duration get_average_from_float_array @step_times
+      def step_average_duration(features)
+        scenarios = features.collect { |feature| feature.scenarios }
+        steps = scenarios.flatten.collect { |scenario| scenario.steps }
+        durations = steps.flatten.collect { |step| step.duration }
+        format_duration get_average_from_float_array durations
       end
 
-      def scenario_average_duration
-        format_duration get_average_from_float_array @scenario_times
+      def scenario_average_duration(features)
+        scenarios = features.collect { |feature| feature.scenarios }
+        durations = scenarios.flatten.collect { |scenario| scenario.duration }
+        format_duration get_average_from_float_array durations
       end
 
       def scenarios_summary_for(status)
@@ -40,14 +45,10 @@ module PrettyFace
         scenario.status == :failed
       end
 
-      def image_tag_for(scenario)
-        status = scenario.status.to_s
-        "<img src=\"images/#{status}.jpg\" alt=\"#{status}\" title=\"#{status}\" width=\"30\""
-      end
 
       private
 
-      def get_average_from_float_array (arr)
+      def get_average_from_float_array(arr)
         arr.reduce(:+).to_f / arr.size
       end
 

data/lib/pretty_face/templates/_step.erb

@@ -0,0 +1,41 @@
+            <%= "#{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 %>

data/lib/pretty_face/templates/feature.erb

@@ -0,0 +1,147 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <link href='<%= feature.directory_prefix_for(feature.file) %>stylesheets/style.css' type='text/css' rel='stylesheet' />
+
+    <title>Feature Results</title>
+  </head>
+
+  <body>
+
+    <div style="float: left;">
+      <img src="<%= feature.directory_prefix_for(feature.file) %>images/face.jpg" width="200" />
+    </div>
+    <div style="float: left;">
+      <a href="<%= feature.parent_filename %>">Back</a>
+      <h2 class="results">Feature Results:  <%= feature.title %></h2>
+      <br />
+      <span>Feature started: <%= feature.start_time.strftime("%a %B %-d, %Y at %H:%M:%S") %></span>
+      <br />
+      <span>Duration: <%= feature.formatted_duration(feature.duration) %></span>
+      <% if feature.description? %>
+        <pre class="description"><%= feature.description %></pre>
+      <% end %>
+    </div>
+
+	  <div class="summary_body">
+      <h2 class="summary">Summary</h2>
+
+      <table cellspacing="0" cellpadding="7" class="summary">
+        <tr>
+          <th></th>
+          <th>Executed</th>
+          <th>Passed</th>
+          <th>Failed</th>
+          <th>Skipped</th>
+          <th>Undefined</th>
+          <th>Pending</th>
+          <th>Average<br/>Duration</th>
+        </tr>
+        <tr>
+          <td class="summary_row_header">Scenarios</td>
+          <td><%= feature.scenarios.length %></td>
+          <td><%= 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>
+          <td><%= feature.scenario_summary_for :pending %></td>
+          <td><%= feature.scenario_average_duration %></td>
+        </tr>
+        <tr>
+          <td class="summary_row_header">Steps</td>
+          <td><%= feature.steps.length %></td>
+          <td><%= feature.step_summary_for :passed %></td>
+          <td><%= feature.step_summary_for :failed %></td>
+          <td><%= feature.step_summary_for :skipped %></td>
+          <td><%= feature.step_summary_for :undefined %></td>
+          <td><%= feature.step_summary_for :pending %></td>
+          <td><%= feature.step_average_duration %></td>
+        </tr>
+      </table>
+    </div>
+
+    <div style="width: 100%; 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">
+      <% feature.background_steps.each do |step| %>
+        <tr>
+          <td><%= raw(feature.image_tag_for(step.status, feature.file)) %></td>
+          <td>
+            <%= render "step", :step => step %>
+          </td>
+        </tr>
+      <% end %>
+      </table>
+      <br />
+      <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>
+        </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 %>
+          </td>
+        </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 />
+        <img id='<%= scenario.image_id %>' style='display: none' src='<%= feature.directory_prefix_for(feature.file) %>images/<%= scenario.image %>'/>
+      <% end %>
+      <br /><br />
+
+      <% end %>
+    </div>
+    <div class="footer">
+      Generated by PrettyFace
+    </div>
+
+  </body>
+</html>

data/lib/pretty_face/templates/main.erb

@@ -1,88 +1,8 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns='http://www.w3.org/1999/xhtml'>
   <head>
-    <style type='text/css'>
-        /* TODO: lets move this to an external .css file */
-        body {
-          font-family: GeosansLightRegular,Arial,Helvetica,sans-serif; 
-          font-size: 1em;
-        }
-        a, a:visited {
-            color: #4B7CAB;
-        }
-        div {
-            padding: 5px;
-        }
+    <link href='stylesheets/style.css' type='text/css' rel='stylesheet' />
 
-        h2 {
-            margin: 0;
-        }
-
-        .summary_body {
-          width: 99%; 
-          margin-top: 15px; 
-          float: left; 
-          -moz-border-radius: 15px; 
-          border-radius: 15px; 
-          background-color: #E0E0E0;
-        }
-        .summary_row_header {
-          text-align: left; 
-          font-size: 1em; 
-          font-weight: bold;
-        }
-        .summary td {
-            font-size: .8em;
-            text-align: center;
-            width: 150px;
-        }
-        .summary td:first-child {
-            font-size: inherit;
-            text-align: inherit;
-            width: inherit;
-        }        
-
-        .failed td {
-            font-size: .8em;
-        }
-
-        .footer {
-          width: 100%; 
-          background-color: #4B7CAB; 
-          float: left; 
-          margin-left: -7px; 
-          margin-top: 25px; 
-          font-family: Verdana; 
-          font-size: 0.8em; 
-          color: white
-        }
-        h2.failures {
-          color: #A00000; 
-          margin-top: 15px; 
-          margin-left: 5px;
-        }
-        h2.scenarios {
-          color: #4B7CAB; 
-          margin-top: 15px; 
-          margin-left: 5px;
-        }
-        h2.results {
-          color: #282828; 
-          margin-top: 12px; 
-          margin-bottom: 15px;
-        }
-        h2.summary {
-          color: white; 
-          margin-left: 5px; 
-          margin-top: 5px;
-        }
-
-        .feature_title {
-          background-color: #F0F0F0; 
-          font-size: 0.9em;
-        }
-    </style>
-    
     <title>Test Results</title>
   </head>
 
@@ -92,11 +12,11 @@
     </div>
     <div style="float: left;">
       <h2 class="results">Test Results</h2>
-      <span>Tests started: <%= start_time %></span>
+      <span>Tests started: <%= report.start_time %></span>
       <br />
-      <span>Duration: <%= total_duration %></span>
+      <span>Duration: <%= report.total_duration %></span>
     </div>
-    
+
 	  <div class="summary_body">
       <h2 class="summary">Summary</h2>
 
@@ -113,43 +33,43 @@
         </tr>
         <tr>
           <td class="summary_row_header">Scenarios</td>
-          <td><%= scenario_count %></td>
-          <td><%= scenarios_summary_for :passed %></td>
-          <td><%= scenarios_summary_for :failed %></td>
-          <td><%= scenarios_summary_for :skipped %></td>
-          <td><%= scenarios_summary_for :undefined %></td>
-          <td><%= scenarios_summary_for :pending %></td>
-          <td><%= scenario_average_duration %></td>
+          <td><%= report.scenario_count %></td>
+          <td><%= report.scenarios_summary_for :passed %></td>
+          <td><%= report.scenarios_summary_for :failed %></td>
+          <td><%= report.scenarios_summary_for :skipped %></td>
+          <td><%= report.scenarios_summary_for :undefined %></td>
+          <td><%= report.scenarios_summary_for :pending %></td>
+          <td><%= report.scenario_average_duration(report.features) %></td>
         </tr>
         <tr>
           <td class="summary_row_header">Steps</td>
-          <td><%= step_count %></td>
-          <td><%= steps_summary_for :passed %></td>
-          <td><%= steps_summary_for :failed %></td>
-          <td><%= steps_summary_for :skipped %></td>
-          <td><%= steps_summary_for :undefined %></td>
-          <td><%= steps_summary_for :pending %></td>
-          <td><%= step_average_duration %></td>
+          <td><%= report.step_count %></td>
+          <td><%= report.steps_summary_for :passed %></td>
+          <td><%= report.steps_summary_for :failed %></td>
+          <td><%= report.steps_summary_for :skipped %></td>
+          <td><%= report.steps_summary_for :undefined %></td>
+          <td><%= report.steps_summary_for :pending %></td>
+          <td><%= report.step_average_duration(report.features) %></td>
         </tr>
       </table>
     </div>
 
-    <div style="width: 100%; float: left;">
+    <div class="failures">
       <br />
-      <h2 class="failures">Tests With Failures:</h2>
+      <h2>Tests With Failures:</h2>
       <br />
-      <table cellspacing="0" cellpadding="7" border="0" class="failed">
+      <table cellspacing="0" cellpadding="7" border="0">
         <tr style="background-color: #E0E0E0;">
           <th></th>
           <th style="text-align: left;">Feature</th>
           <th style="text-align: left;">Scenario</th>
           <th style="text-align: left;">File</th>
         </tr>
-        <% features.each do |feature| %>
+        <% report.features.each do |feature| %>
           <% feature.scenarios.each do |scenario| %>
-            <% if failed_scenario? scenario %>
+            <% if report.failed_scenario? scenario %>
         <tr>
-          <td><img src="images/failed.jpg" width="30"/></td>
+          <td><img src="images/failed.png" width="30"/></td>
           <td><%= feature.title %> </td>
           <td><%= scenario.name %></td>
           <td style="color: gray;"><%= scenario.file_colon_line %></td>
@@ -158,37 +78,58 @@
           <% end %>
         <% end %>
       </table>
-        
-      <br />
-      <h2 class="scenarios">Scenario Overview:</h2>
-      <br />
 
-      <table cellspacing="0" cellpadding="7" border="0" class="failed">
-        <tr style="background-color: #E0E0E0;">
-          <th style="text-align: left;">Result</th>
-          <th style="text-align: left;">Name</th>
-          <th style="text-align: left;">File</th>
-          <th style="text-align: left;"># Steps</th>
-        </tr>
-        <% features.each do |feature| %>
-        <tr>
-          <td class="feature_title" colspan="4">Feature: <%= feature.title %></td>
-        </tr>
-          <% feature.scenarios.each do |scenario| %>
-        <tr>
-          <td><%= image_tag_for scenario %></td>
-          <td><%= scenario.name %></td>
-          <td style="color: gray;"><%= scenario.file_colon_line %></td>
-          <td><%= scenario.steps.length %></td>
-        </tr>
+      <section class="feature-overview">
+        <br />
+        <h2 class="scenarios">Feature Overview:</h2>
+        <br />
+
+        <table cellspacing="0" cellpadding="7" border="0">
+          <tr>
+            <th>Feature</th>
+            <th>File</th>
+            <th>Passed</th>
+            <th>Failed</th>
+            <th>Pending</th>
+            <th>Undefined</th>
+            <th>Skipped</th>
+            <th>Duration</th>
+          </tr>
+          <% report.features.each do |feature| %>
+          <tr>
+            <td class="feature_title">
+              <a href="<%= feature.file %>"><%= feature.title %></a>
+            </td>
+            <td>
+              <%= feature.file %>
+            </td>
+            <td>
+              <%= feature.scenarios_for(:passed).length %>
+            </td>
+            <td>
+              <%= feature.scenarios_for(:failed).length %>
+            </td>
+            <td>
+              <%= feature.scenarios_for(:pending).length %>
+            </td>
+            <td>
+              <%= feature.scenarios_for(:undefined).length %>
+            </td>
+            <td>
+              <%= feature.scenarios_for(:skipped).length %>
+            </td>
+            <td>
+              <%= feature.formatted_duration(feature.duration) %>
+            </td>
+          </tr>
           <% end %>
-        <% end %>
-      </table>
+        </table>
+      </section>
     </div>
-    
+
     <div class="footer">
       Generated by PrettyFace
     </div>
-    
+
   </body>
 </html>