RubyGems - pretty_face - Versions diffs - 0.1 - Mend

pretty_face 0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

data/.gitignore +8 -0
data/.rspec +2 -0
data/.travis.yml +5 -0
data/ChangeLog +2 -0
data/Gemfile +12 -0
data/Guardfile +17 -0
data/README.md +21 -0
data/Rakefile +18 -0
data/cucumber.yml +3 -0
data/features/pretty_face_report.feature +63 -0
data/features/support/env.rb +9 -0
data/features/support/hooks.rb +6 -0
data/fixtures/advanced.feature +14 -0
data/fixtures/basic.feature +17 -0
data/fixtures/step_definitions/advanced_steps.rb +12 -0
data/fixtures/step_definitions/basic_steps.rb +19 -0
data/fixtures/support/env.rb +3 -0
data/lib/pretty_face.rb +6 -0
data/lib/pretty_face/formatter/html.rb +140 -0
data/lib/pretty_face/formatter/report.rb +68 -0
data/lib/pretty_face/formatter/view_helper.rb +60 -0
data/lib/pretty_face/templates/face.jpg +0 -0
data/lib/pretty_face/templates/failed.jpg +0 -0
data/lib/pretty_face/templates/main.erb +194 -0
data/lib/pretty_face/templates/passed.jpg +0 -0
data/lib/pretty_face/templates/pending.jpg +0 -0
data/lib/pretty_face/templates/skipped.jpg +0 -0
data/lib/pretty_face/templates/undefined.jpg +0 -0
data/lib/pretty_face/version.rb +3 -0
data/pretty_face.gemspec +26 -0
data/sample_report/LisaCrispin1.png +0 -0
data/sample_report/LisaCrispin2.png +0 -0
data/sample_report/blue_s.jpeg +0 -0
data/sample_report/green_bar.jpeg +0 -0
data/sample_report/green_check.jpg +0 -0
data/sample_report/red_bar.gif +0 -0
data/sample_report/red_x.jpg +0 -0
data/sample_report/sample_report.html +167 -0
data/sample_report/some_code/gherkin_formatter_adapter.rb +87 -0
data/sample_report/some_code/html.rb +655 -0
data/sample_report/some_code/ordered_xml_markup.rb +24 -0
data/sample_report/some_code/summary.rb +35 -0
data/sample_report/yellow_o.jpg +0 -0
data/spec/lib/html_formatter_spec.rb +111 -0
data/spec/spec_helper.rb +5 -0
metadata +168 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+*.swp
+fixture.html
+images

data/.rspec ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ --color
2	+ --format doc

data/.travis.yml ADDED Viewed

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7

data/ChangeLog ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ === Release 0.1 / 2012-11-17
2	+ Initial release with single page basic report

data/Gemfile ADDED Viewed

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+gem 'rake'
+gem 'fuubar'
+gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+gem 'growl'
+gem 'guard-rspec'
+gem 'guard-cucumber'
+# Specify your gem's dependencies in pretty_face.gemspec
+gemspec

data/Guardfile ADDED Viewed

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard 'rspec', :cli => '--color --format Fuubar' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+guard 'cucumber', :notification => true, :all_after_pass => false, :cli => '--profile focus' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^lib/.+\.rb$})                   { "features" }
+  watch(%r{^lib/.+\.erb$})                  { "features" }
+end

data/README.md ADDED Viewed

@@ -0,0 +1,21 @@
+# pretty_face
+HTML report for cucumber and rspec.  You can customzie the report by editing an erb file.
+## Known Issues
+See [http://github.com/cheezy/pretty_face/issues](http://github.com/cheezy/pretty_face/issues)
+## Contribute
+* Fork the project.
+* Test drive your feature addition or bug fix. Adding specs is important and I will not accept a pull request that does not have tests.
+* Make sure you describe your new feature with a cucumber scenario.
+* Make sure you provide RDoc comments for any new public method you add. Remember, others will be using this gem.
+* Commit, do not mess with Rakefile, version, or ChangeLog.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+## Copyright
+Copyright (c) 2012 Jeffrey S. Morgan. See LICENSE for details.

data/Rakefile ADDED Viewed

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+Cucumber::Rake::Task.new(:features, "Run all features") do |t|
+  t.profile = 'default'
+end
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :spec
+desc 'Run all specs and features'
+task :test => %w[spec features]
+task :default => :test

data/cucumber.yml ADDED Viewed

@@ -0,0 +1,3 @@
+default: --color --no-source --format pretty
+fixture: --color --no-source --require fixtures/step_definitions --format PrettyFace::Formatter::Html --out fixture.html
+focus: --color --no-source --format pretty --tags @focus

data/features/pretty_face_report.feature ADDED Viewed

@@ -0,0 +1,63 @@
+Feature: pretty face report
+  Background:
+    When I run `cucumber fixtures --profile fixture`
+  Scenario: Cucumber crefates an html report
+    Then the following files should exist:
+    | fixture.html |
+  Scenario: Generating the basic html page from the erb
+    Then the file "fixture.html" should contain "DOCTYPE html PUBLIC"
+    And the file "fixture.html" should contain "<html xmlns='http://www.w3.org/1999/xhtml'>"
+    And the file "fixture.html" should contain "<head>"
+    And the file "fixture.html" should contain "<body"
+    And the file "fixture.html" should contain "<title>Test Results</title>"
+  Scenario: Generating some basic stats from the erb
+    Then the file "fixture.html" should contain "<th>Executed<"
+    And the file "fixture.html" should contain "<th>Average<br/>Duration"
+    And the file "fixture.html" should contain "Scenarios"
+    And the file "fixture.html" should contain "Steps"
+  Scenario: Including the styles for the main page
+    Then the file "fixture.html" should contain "<style type='text/css'>"
+    And the file "fixture.html" should contain "</style>"
+  Scenario: Including an image / logo
+    Then the file "fixture.html" should contain "<img src="
+    And the file "fixture.html" should contain "images/face.jpg"
+  Scenario: It should copy the logo image to the images directory
+    Then the following files should exist:
+    | images/face.jpg |
+  Scenario: It should show start time and duration in the header
+    Then the file "fixture.html" should contain "Tests started:"
+    And the file "fixture.html" should contain "Duration:"
+  Scenario: It should capture scenario and step statuses
+    Then the file "fixture.html" should contain "Passed"
+    And the file "fixture.html" should contain "Failed"
+    And the file "fixture.html" should contain "Pending"
+    And the file "fixture.html" should contain "Undefined"
+    And the file "fixture.html" should contain "Skipped"
+  Scenario: It should display all of the tests with failures
+    Then the file "fixture.html" should contain "Tests With Failures:"
+  Scenario: It should display a list of all features / scenarios
+    Then the file "fixture.html" should contain "Scenario Overview:"
+  Scenario: It should display useful information about each scenario
+    Then the file "fixture.html" should contain "Result"
+    And the file "fixture.html" should contain "Name"
+    And the file "fixture.html" should contain "# Steps"
+    And the file "fixture.html" should contain "Duration"
+  Scenario: It should display the data from scenario outlines
+    Then the file "fixture.html" should contain "| aaa | bbb |"
+    And the file "fixture.html" should contain "| ccc | ddd |"
+  Scenario: It should display the scenario name for scenario outlines
+    Then the file "fixture.html" should contain "A scenario outline"

data/features/support/env.rb ADDED Viewed

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
+require 'aruba/cucumber'
+require 'pretty_face'
+Before do
+  @dirs = [File.join(File.dirname(__FILE__), '..', '..')]
+end

data/features/support/hooks.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require 'fileutils'
+After do
+  file = File.join(File.dirname(__FILE__), '..', '..', 'fixture.html')
+ # FileUtils.rm file
+end

data/fixtures/advanced.feature ADDED Viewed

@@ -0,0 +1,14 @@
+Feature: Advanced scenarios
+  Scenario Outline: A scenario outline
+    Given I am using a scenario outline
+    When I use <first>
+    And I use <second>
+    Then the examples should work
+  Examples:
+  | first | second |
+  | aaa   | bbb    |
+  | ccc   | ddd    |
+  | eee   | fff    |

data/fixtures/basic.feature ADDED Viewed

@@ -0,0 +1,17 @@
+Feature: Basic scenarios
+  Scenario: A passing scenario
+    When Cucumber puts "hello"
+    Then it should say hello
+  Scenario: A failing scenario
+    When the first step fails
+    Then the second step should not execute
+  Scenario: A pending scenario
+    When the first step is pending
+    Then the second step is undefined
+  Scenario: A undefined scenario
+    When all steps are undefined
+    Then the scenario is undefined

data/fixtures/step_definitions/advanced_steps.rb ADDED Viewed

@@ -0,0 +1,12 @@
+Given /^I am using a scenario outline$/ do
+end
+When /^I use (.*?)$/ do |value|
+end
+Then /^the examples should work$/ do
+end

data/fixtures/step_definitions/basic_steps.rb ADDED Viewed

@@ -0,0 +1,19 @@
+When /^Cucumber puts "(.*?)"$/ do |some_string|
+  puts some_string
+end
+Then /^it should say hello$/ do
+  puts "It said hello"
+end
+When /^the first step fails$/ do
+ true.should == false
+end
+Then /^the second step should not execute$/ do
+  puts "Should not execute"
+end
+When /^the first step is pending$/ do
+  pending
+end

data/fixtures/support/env.rb ADDED Viewed

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
+require 'pretty_face'

data/lib/pretty_face.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require "pretty_face/version"
+require "pretty_face/formatter/html"
+module PrettyFace
+  # Your code goes here...
+end

data/lib/pretty_face/formatter/html.rb ADDED Viewed

@@ -0,0 +1,140 @@
+require 'erb'
+require 'fileutils'
+require 'cucumber/formatter/io'
+require 'cucumber/formatter/duration'
+require 'cucumber/ast/scenario'
+require 'cucumber/ast/table'
+require 'cucumber/ast/outline_table'
+require File.join(File.dirname(__FILE__), 'view_helper')
+require File.join(File.dirname(__FILE__), 'report')
+module PrettyFace
+  module Formatter
+    class Html
+      include Cucumber::Formatter::Io
+      include Cucumber::Formatter::Duration
+      include ViewHelper
+      def initialize(step_mother, path_or_io, options)
+        @path = path_or_io
+        @io = ensure_io(path_or_io, 'html')
+        @step_mother = step_mother
+        @options = options
+        @report = Report.new
+        @step_times = []
+        @scenario_times = []
+        @outline_steps = []
+      end
+      def before_features(features)
+        @tests_started = Time.now
+      end
+      def before_feature(feature)
+        @report.add_feature ReportFeature.new(feature)
+      end
+      def after_feature(feature)
+        @report.current_feature.title = feature.title
+      end
+      def before_feature_element(feature_element)
+        @scenario_timer = Time.now
+        unless scenario_outline? feature_element
+          @report.add_scenario  ReportScenario.new(feature_element)
+        end
+      end
+      def after_feature_element(feature_element)
+        unless scenario_outline?(feature_element)
+          process_scenario(feature_element)
+        end
+      end
+      def after_outline_table(outline_table)
+        process_scenario_outline(outline_table)
+      end
+      def after_table_row(example_row)
+        @scenario_times.push Time.now - @scenario_timer
+      end
+      def before_step(step)
+        @step_timer = Time.now
+      end
+      def after_step(step)
+        process_step(step)
+      end
+      def after_features(features)
+        @features = features
+        @duration = format_duration(Time.now - @tests_started)
+        generate_report
+        copy_images_directory
+      end
+      def features
+        @report.features
+      end
+      private
+      def generate_report
+        filename = File.join(File.dirname(__FILE__), '..', 'templates', 'main.erb')
+        text = File.new(filename).read
+        @io.puts ERB.new(text, nil, "%").result(binding)
+      end
+      def copy_images_directory
+        path = "#{File.dirname(@path)}/images"
+        FileUtils.mkdir path unless File.directory? path
+        %w(face failed passed pending undefined skipped).each do |file|
+          FileUtils.cp File.join(File.dirname(__FILE__), '..', 'templates', "#{file}.jpg"), path
+        end
+      end
+      def process_scenario(scenario)
+        @scenario_times.push Time.now - @scenario_timer
+        @report.current_scenario.populate(scenario)
+      end
+      def process_example_row(example_row)
+        @report.add_scenario build_scenario_outline_with example_row
+      end
+      def process_scenario_outline(scenario_outline)
+        scenario_outline.example_rows.each do |example_row|
+          process_example_row(example_row)
+        end
+        @outline_steps = []
+      end
+      def process_step(step)
+        @step_times.push Time.now - @step_timer
+        if step_belongs_to_outline? step
+          @outline_steps << ReportStep.new(step)
+        else
+          @report.add_step ReportStep.new(step)
+        end
+      end
+      def scenario_outline?(feature_element)
+        feature_element.is_a? Cucumber::Ast::ScenarioOutline
+      end
+      def step_belongs_to_outline?(step)
+        scenario = step.instance_variable_get "@feature_element"
+        not scenario.nil?
+      end
+      def build_scenario_outline_with(example_row)
+        scenario = ReportScenario.new(example_row)
+        scenario.steps = @outline_steps
+        scenario.populate example_row
+        scenario
+      end
+    end
+  end
+end

data/lib/pretty_face/formatter/report.rb ADDED Viewed

@@ -0,0 +1,68 @@
+module PrettyFace
+  module Formatter
+    class Report
+      attr_reader :features
+      def initialize
+        @features = []
+      end
+      def current_feature
+        @features.last
+      end
+      def current_scenario
+        current_feature.scenarios.last
+      end
+      def add_feature(feature)
+        @features << feature
+      end
+      def add_scenario(scenario)
+        current_feature.scenarios << scenario
+      end
+      def add_step(step)
+        current_scenario.steps << step
+      end
+    end
+    class ReportFeature
+      attr_accessor :title, :scenarios
+      def initialize(feature)
+        self.scenarios = []
+      end
+    end
+    class ReportScenario
+      attr_accessor :name, :file_colon_line, :status, :steps
+      def initialize(scenario)
+        self.steps = []
+      end
+      def populate(scenario)
+        if scenario.instance_of? Cucumber::Ast::Scenario
+          self.name = scenario.name
+          self.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
+        end
+        self.status = scenario.status
+      end
+    end
+    class ReportStep
+      attr_accessor :name, :file_colon_line, :status
+      def initialize(step)
+          self.name = step.name
+          self.file_colon_line = step.file_colon_line
+          self.status = step.status
+      end
+    end
+  end
+end