pretty_face 0.2 → 0.3

data/.rvmrc

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

data/ChangeLog

@@ -1,4 +1,9 @@
-=== Release 0.2
+=== Release 0.3 / 2013-3-9
+* Allow users to provide replacement logo for report
+* Allow users to provide replacement header for top level page
+* Allow users to provide replacement header for feature pages
+
+=== Release 0.2 / 2013-2-23
 * Creating a page for each feature file
 * Displaying Background
 * Displaying Errors on feature pages

data/features/feature_pages.feature

@@ -17,7 +17,6 @@ Feature: pages that show details for features
 
   Scenario: Including an image / logo
     Then the file "results/basic.html" should contain "<img src="
-    And the file "results/basic.html" should contain "images/face.jpg"
 
   Scenario: It should show start time and duration in the header
     Then the file "results/basic.html" should contain "Feature started:"
@@ -47,9 +46,8 @@ Feature: pages that show details for features
     And the file "results/advanced.html" should contain "I am using a scenario outline"
 
   Scenario: It should display the step and data for scenario outline steps
-  I use &#x27;aaa&#x27;\
-    Then the file "results/advanced.html" should contain "I use &#x27;aaa&#x27;"
-    And the file "results/advanced.html" should contain "I use &#x27;bbb&#x27;"
+    Then the file "results/advanced.html" should contain "I use aaa"
+    And the file "results/advanced.html" should contain "I use bbb"
 
   Scenario: It should display descriptions for features
     Then the file "results/basic.html" should contain "As a stakeholder"
@@ -91,4 +89,9 @@ Feature: pages that show details for features
     Then the following files should exist:
     | results/more/more.html |
 
-    
+  Scenario: It should replace the header for the feature pages
+    When I have a feature header partial in the correct location
+    And I run `cucumber fixtures --profile fixture`
+    Then the file "results/basic.html" should contain "The Code Monkeys"
+    And the file "results/basic.html" should contain "Test Results"
+    And I should remove the feature header partial file

data/features/pretty_face_report.feature

@@ -26,7 +26,6 @@ Feature: pretty face report
     
   Scenario: Including an image / logo
     Then the file "results/fixture.html" should contain "<img src="
-    And the file "results/fixture.html" should contain "images/face.jpg"
 
   Scenario: It should copy the style sheet to the stylesheets directory
     Then the following files should exist:
@@ -66,4 +65,16 @@ Feature: pretty face report
     Then the file "results/fixture.html" should contain "| aaa | bbb |"
     And the file "results/fixture.html" should contain "| ccc | ddd |"
   
+  Scenario: It should replace the logo image on the top level page
+    When I have a logo file in the correct location
+    And I run `cucumber fixtures --profile fixture`
+    Then the file "results/fixture.html" should contain "img src='images/logo.png'"
+    And I should remove the logo file
+
+  Scenario: It should replace the header for the main page of the report
+    When I have a suite header partial in the correct location
+    And I run `cucumber fixtures --profile fixture`
+    Then the file "results/fixture.html" should contain "The Code Monkeys"
+    And the file "results/fixture.html" should contain "Test Results"
+    And I should remove the suite header partial file
 

data/features/step_definitions/report_steps.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+
+When /^I have a logo file in the correct location$/ do
+  FileUtils.cp "features/support/logo.png", "features/support/pretty_face/"
+end
+
+Then /^I should remove the logo file$/ do
+  FileUtils.rm "features/support/pretty_face/logo.png"
+end
+
+When /^I have a suite header partial in the correct location$/ do
+  FileUtils.cp "features/support/_suite_header.erb", "features/support/pretty_face"
+end
+
+Then /^I should remove the suite header partial file$/ do
+  FileUtils.rm "features/support/pretty_face/_suite_header.erb"
+end
+
+When /^I have a feature header partial in the correct location$/ do
+  FileUtils.cp "features/support/_feature_header.erb", "features/support/pretty_face"
+end
+
+Then /^I should remove the feature header partial file$/ do
+  FileUtils.rm "features/support/pretty_face/_feature_header.erb"
+end

data/features/support/_feature_header.erb

@@ -0,0 +1,2 @@
+<h1>The Code Monkeys</h1>
+<h2>Test Results</h2>

data/features/support/_suite_header.erb

@@ -0,0 +1,2 @@
+<h1>The Code Monkeys</h1>
+<h2>Test Results</h2>

data/lib/pretty_face/formatter/html.rb

@@ -16,7 +16,7 @@ module PrettyFace
       include Cucumber::Formatter::Duration
       include ViewHelper
 
-      attr_reader :report
+      attr_reader :report, :logo
 
       def initialize(step_mother, path_or_io, options)
         @path = path_or_io
@@ -26,6 +26,7 @@ module PrettyFace
         @options = options
         @report = Report.new
         @img_id = 0
+        @logo = 'face.jpg'
       end
 
       def embed(src, mime_type, label)
@@ -109,35 +110,51 @@ module PrettyFace
       def after_features(features)
         @features = features
         @duration = format_duration(Time.now - @tests_started)
+        copy_images
+        copy_stylesheets
         generate_report
-        copy_images_directory
-        copy_stylesheets_directory
       end
 
       def features
         @report.features
       end
 
+      def custom_suite_header?
+        Dir.foreach(customization_directory) do |file|
+          return true if file == '_suite_header.erb'
+        end
+        false
+      end
+
+      def custom_feature_header?
+        Dir.foreach(customization_directory) do |file|
+          return true if file == '_feature_header.erb'
+        end
+        false
+      end
+
       private
 
       def generate_report
-        renderer = ActionView::Base.new(@path_to_erb)
+        paths = [@path_to_erb, customization_directory.to_s]
+        renderer = ActionView::Base.new(paths)
         filename = File.join(@path_to_erb, 'main')
-        @io.puts renderer.render(:file => filename, :locals => {:report => self})
+        @io.puts renderer.render(:file => filename, :locals => {:report => self, :logo => @logo})
         features.each do |feature|
           write_feature_file(feature)
         end
       end
 
       def write_feature_file(feature)
-        renderer = ActionView::Base.new(@path_to_erb)
+        paths = [@path_to_erb, customization_directory.to_s]
+        renderer = ActionView::Base.new(paths)
         filename = File.join(@path_to_erb, 'feature')
         output_file = "#{File.dirname(@path)}/#{feature.file}"
         to_cut = output_file.split('/').last
         directory = output_file.sub("/#{to_cut}", '')
         FileUtils.mkdir directory unless File.directory? directory
         file = File.new(output_file, Cucumber.file_mode('w'))
-        file.puts renderer.render(:file => filename, :locals => {:feature => feature})
+        file.puts renderer.render(:file => filename, :locals => {:feature => feature, :logo => @logo, :customize => custom_feature_header?})
         file.flush
         file.close
       end
@@ -155,19 +172,40 @@ module PrettyFace
       def copy_directory(dir, file_names, file_extension)
         path = "#{File.dirname(@path)}/#{dir}"
         file_names.each do |file|
-          FileUtils.cp File.join(File.dirname(__FILE__), '..', 'templates', "#{file}.#{file_extension}"), path
+          copy_file File.join(File.dirname(__FILE__), '..', 'templates', "#{file}.#{file_extension}"), path
         end
       end
 
-      def copy_images_directory
-        copy_directory 'images', ['face'], 'jpg'
+      def copy_file(source, destination)
+        FileUtils.cp source, destination
+      end
+
+      def copy_images
         copy_directory 'images', %w(failed passed pending undefined skipped), "png"
+        logo = logo_file
+        copy_file logo, "#{File.join(File.dirname(@path), 'images')}" if logo
+        copy_directory 'images', ['face'], 'jpg' unless logo
       end
 
-      def copy_stylesheets_directory
+      def copy_stylesheets
         copy_directory 'stylesheets', ['style'], 'css'
       end
 
+      def logo_file
+        dir = customization_directory
+        Dir.foreach(dir) do |file|
+          if file =~ /^logo\.(png|gif|jpg|jpeg)$/
+            @logo = file
+            return File.join(dir, file)
+          end
+        end if dir
+      end
+
+      def customization_directory
+        dir = File.join(File.expand_path('features'), 'support', 'pretty_face')
+        return dir if File.exists? dir
+      end
+
       def process_scenario(scenario)
         @report.current_scenario.populate(scenario)
       end

data/lib/pretty_face/templates/_main_header.erb

@@ -0,0 +1 @@
+<h2 class="results">Test Results</h2>

data/lib/pretty_face/templates/_page_header.erb

@@ -0,0 +1,2 @@
+<h2 class="results">Feature Results:  <%= feature.title %></h2>
+<br />

data/lib/pretty_face/templates/feature.erb

@@ -9,12 +9,15 @@
   <body>
 
     <div style="float: left;">
-      <img src="<%= feature.directory_prefix_for(feature.file) %>images/face.jpg" width="200" />
+      <img src="<%= feature.directory_prefix_for(feature.file) %>images/<%= logo %>" width="200" />
     </div>
     <div style="float: left;">
       <a href="<%= feature.parent_filename %>">Back</a>
-      <h2 class="results">Feature Results:  <%= feature.title %></h2>
-      <br />
+      <% if customize %>
+        <%= render "feature_header" %>
+      <% else %>
+        <%= render "page_header", :feature => feature %>
+      <% end %>
       <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>

data/lib/pretty_face/templates/main.erb

@@ -8,10 +8,14 @@
 
   <body>
     <div style="float: left;">
-      <img src="images/face.jpg" width="200" />
+      <img src='images/<%= logo %>' width="200" />
     </div>
     <div style="float: left;">
-      <h2 class="results">Test Results</h2>
+      <% if report.custom_suite_header? %>
+        <%= render "suite_header" %>
+      <% else %>
+        <%= render "main_header" %>
+      <% end %>
       <span>Tests started: <%= report.start_time %></span>
       <br />
       <span>Duration: <%= report.total_duration %></span>

data/lib/pretty_face/version.rb

@@ -1,3 +1,3 @@
 module PrettyFace
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/pretty_face.gemspec

@@ -5,7 +5,7 @@ require "pretty_face/version"
 Gem::Specification.new do |s|
   s.name        = "pretty_face"
   s.version     = PrettyFace::VERSION
-  s.authors     = ["Jeffrey S. Morgan", "Joel Byler"]
+  s.authors     = ["Jeffrey S. Morgan", "Joel Byler", "Steve Jackson"]
   s.email       = ["jeff.morgan@leandog.com", "joelbyler@gmail.com", "steve.jackson@leandogsoftware.com"]
   s.homepage    = "http://github.com/cheezy/pretty_face"
   s.summary     = %q{HTML Report/Formatter  for Cucumber and RSpec}
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "actionpack", ">= 3.2.11"
+  s.add_dependency "actionpack"
 
   s.add_development_dependency "cucumber"
   s.add_development_dependency "rspec"

data/spec/lib/html_formatter_spec.rb

@@ -16,8 +16,8 @@ describe PrettyFace::Formatter::Html do
 
     it "should know how long it takes" do
       formatter.should_receive(:generate_report)
-      formatter.should_receive(:copy_images_directory)
-      formatter.should_receive(:copy_stylesheets_directory)
+      formatter.should_receive(:copy_images)
+      formatter.should_receive(:copy_stylesheets)
       formatter.stub(:make_output_directories)
       formatter.before_features(nil)
 

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: pretty_face
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
 - Jeffrey S. Morgan
 - Joel Byler
+- Steve Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2013-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -19,7 +20,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,7 +28,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +105,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rvmrc
 - .travis.yml
 - ChangeLog
 - Gemfile
@@ -114,8 +116,13 @@ files:
 - cucumber.yml
 - features/feature_pages.feature
 - features/pretty_face_report.feature
+- features/step_definitions/report_steps.rb
+- features/support/_feature_header.erb
+- features/support/_suite_header.erb
 - features/support/env.rb
 - features/support/hooks.rb
+- features/support/logo.png
+- features/support/pretty_face/blah.txt
 - fixtures/advanced.feature
 - fixtures/background.feature
 - fixtures/basic.feature
@@ -128,6 +135,8 @@ files:
 - lib/pretty_face/formatter/html.rb
 - lib/pretty_face/formatter/report.rb
 - lib/pretty_face/formatter/view_helper.rb
+- lib/pretty_face/templates/_main_header.erb
+- lib/pretty_face/templates/_page_header.erb
 - lib/pretty_face/templates/_step.erb
 - lib/pretty_face/templates/face.jpg
 - lib/pretty_face/templates/failed.jpg
@@ -174,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4205723903375013439
+      hash: -2360201377690045592
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -183,17 +192,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4205723903375013439
+      hash: -2360201377690045592
 requirements: []
 rubyforge_project: pretty_face
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: HTML Report/Formatter  for Cucumber and RSpec
 test_files:
 - features/feature_pages.feature
 - features/pretty_face_report.feature
+- features/step_definitions/report_steps.rb
+- features/support/_feature_header.erb
+- features/support/_suite_header.erb
 - features/support/env.rb
 - features/support/hooks.rb
+- features/support/logo.png
+- features/support/pretty_face/blah.txt
 - spec/lib/html_formatter_spec.rb
 - spec/spec_helper.rb