rspec_yah_formatter 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a7bad1267c438124ef01fd2825113cea0a8deaa
-  data.tar.gz: 8dd20d5b5dd1eb7642fc9b04ab146c48bf44bb5a
+  metadata.gz: 78aa4ce207ac8c86257815cb0c464d5f3e0a5cd4
+  data.tar.gz: d00e505e3a4f237a1dfed353a2f26de528b51d94
 SHA512:
-  metadata.gz: 021cd492d0e39a275e2b53232d143b58ba79cf391a6bdf8d9faf2eea10fbdff6592c97bcdb348c7e3527eb46d6b3882eeb72b2c6cecfc5ca6093a422a6d527c0
-  data.tar.gz: a67c55a7478b6bd70aad82c57d2739f7324c929e2b17bd883835a15506deb1313bd0764eb58e9154cf010f04f979d330d84a05ce495fe0e172d1c5a04aa16b66
+  metadata.gz: dce7ebe550470f383d37fd55ecbfe7ba60ac1c41fc8df76f1912da57cc5833cf8667068638389f57ed820c670e0b2dccaf07c6313577a9f81e9d57860dc5009b
+  data.tar.gz: 6be13527a162f06244ae1975ded4481623ae173ee9ed95eca2c2704eb784f32a5dc3f52705c7c2cfa0233acd584c32adae968910bcef7fa071614886c953d719

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/example.rb

@@ -1,23 +1,21 @@
 
 require 'oopsy'
+require 'pathname'
 
 class Example
 
   attr_reader :description, :full_description, :run_time, :duration, :status,
-              :exception, :file_path, :metadata, :spec, :screenshot
+              :exception, :file_path, :metadata, :spec
 
-  def initialize(example)
+  def initialize(example, report_folder)
     @description = example.description
     @full_description = example.full_description
     @execution_result = example.execution_result
-    @run_time = (@execution_result.run_time).round(5)
-    @duration = @execution_result.run_time.to_s(:rounded, precision: 5)
-    @status = @execution_result.status.to_s
     @metadata = example.metadata
     @file_path = @metadata[:file_path]
     @exception = Oopsy.new(example.exception, @file_path)
-    @screenshot = screenshot_path
     @spec = nil
+    @report_folder = report_folder
   end
 
   def has_exception?
@@ -34,15 +32,28 @@ class Example
 
   def klass(prefix = 'label-')
     class_map = { passed: "#{prefix}success", failed: "#{prefix}danger", pending: "#{prefix}warning" }
-    class_map[@status.to_sym]
+    class_map[status.to_sym]
   end
 
-  private
+  def screenshot
+    return nil unless @metadata[:screenshot]
 
-  def screenshot_path
-    filename = File.basename(@metadata[:file_path])
-    line_number = @metadata[:line_number]
-    default_path = "#{filename}-#{line_number}.png"
-    File.exist?(default_path) ? default_path : @metadata[:screenshot]
+    unless File.exist?(@metadata[:screenshot])
+      puts "The screenshot '#{@metadata[:screenshot]}' does not exist"
+    end
+
+    path = Pathname.new(File.dirname(@report_folder))
+    Pathname.new(@metadata[:screenshot]).relative_path_from(path).to_s
+  end
+
+  def run_time
+    (@execution_result.run_time).round(5)
+  end
+
+  def duration
+    @execution_result.run_time.to_s(:rounded, precision: 5)
+  end
+  def status
+    @execution_result.status.to_s
   end
 end

data/lib/rspec_yah_formatter.rb

@@ -10,43 +10,45 @@ require 'example'
 
 I18n.enforce_available_locales = false
 
+# Formatter that builds a pretty html report, and includes a screenshot if it
+# is included in the example metadata.
 class RspecYahFormatter < RSpec::Core::Formatters::BaseFormatter
   RSpec::Core::Formatters.register self, :example_passed, :example_failed,
                                    :example_pending
 
-  def initialize(io_standard_output)
+  def initialize(out_file)
     @examples = []
     @passed = 0
     @failed = 0
     @pending = 0
-    unless io_standard_output.is_a?(File)
-      raise 'You should specify a file with the --out option, STDOUT cannot be used with this formatter'
+    if !out_file.is_a?(File)
+      raise 'You should specify a html file with the --out option, STDOUT cannot be used with this formatter'
     end
-    @io_standard_output = io_standard_output
-    copy_resources
+    @out_file = out_file
   end
 
   def example_passed(notification)
     @passed += 1
-    @examples << Example.new(notification.example)
+    @examples << Example.new(notification.example, @out_file)
   end
 
   def example_failed(notification)
     @failed += 1
-    @examples << Example.new(notification.example)
+    @examples << Example.new(notification.example, @out_file)
   end
 
   def example_pending(notification)
     @pending += 1
-    @examples << Example.new(notification.example)
+    @examples << Example.new(notification.example, @out_file)
   end
 
-  def close(notification)
+  def close(_notification)
     calculate_durations
-    File.open(@io_standard_output, 'w') do |f|
+    File.open(@out_file, 'w') do |file|
       template_file = File.read(File.dirname(__FILE__) + '/../templates/report.erb')
-      f.puts ERB.new(template_file).result(binding)
+      file.puts ERB.new(template_file).result(binding)
     end
+    copy_resources
   end
 
   private
@@ -58,10 +60,11 @@ class RspecYahFormatter < RSpec::Core::Formatters::BaseFormatter
     duration_values << duration_values.first if duration_values.size == 1
 
     @durations = duration_values.each_with_index.map { |e, i| [i, e] }
-    @summary_duration = duration_values.inject(:+).to_s(:rounded, precision: 5)
+    @summary_duration = duration_values.inject(:+).to_f.to_s(:rounded, precision: 5)
   end
 
+  # Copies resources to the same folder where the report will be saved
   def copy_resources
-    FileUtils.cp_r(File.dirname(__FILE__) + '/../resources', File.dirname(@io_standard_output))
+    FileUtils.cp_r(File.dirname(__FILE__) + '/../resources', File.dirname(@out_file))
   end
 end

data/rspec_yah_formatter.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rspec_yah_formatter 0.0.5 ruby lib
+# stub: rspec_yah_formatter 0.0.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rspec_yah_formatter"
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kingsley Hendrickse", "David Garcia"]
-  s.date = "2016-02-15"
+  s.date = "2016-02-29"
   s.description = "Rspec html formatter to generate pretty results with images"
   s.email = "david.garcia.mora@gmail.com"
   s.extra_rdoc_files = [
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
     "rspec_yah_formatter.gemspec",
     "spec/penders_spec.rb",
     "spec/rspec_html_formatter_spec.rb",
+    "spec/something.png",
     "spec/test2_spec.rb",
     "templates/report.erb"
   ]

data/spec/test2_spec.rb

@@ -1,8 +1,24 @@
 require 'rspec'
-# require_relative '../lib/rspec_html_formatter'
 
-describe 'The second Test' do
+def fake_screenshot(metadata)
+  filename = File.basename(metadata[:file_path])
+  line_number = metadata[:line_number]
+  FileUtils.mkdir 'screenshots' unless File.exist? 'screenshots'
+  screenshot_name = "screenshots/#{filename}-#{line_number}.png"
+  FileUtils.cp(File.join(__dir__, 'something.png'), screenshot_name)
+  screenshot_name
+end
+
+RSpec.configure do |config|
+  config.after(:each) do |example|
+    if example.exception
+      screenshot_name = fake_screenshot(example.metadata)
+      example.metadata[:screenshot] = screenshot_name
+    end
+  end
+end
 
+describe 'The second Test' do
   it 'should do cool test stuff' do
     pending('coming soon')
     fail
@@ -13,26 +29,17 @@ describe 'The second Test' do
   end
 
   it 'should do superb test stuff' do
-    #-> Given there are some ships
-    #-> When I sail one
-    #-> Then it should go fast
     expect('ships').to eq 'ships'
   end
 
   it 'should do example stuff' do
     expect('apple').to eq 'apple'
     expect('pear').to eq 1
-    #-> Given I have some stuff to do
-    #-> And I like to do is wait here for a while
-    #-> Then I do it real good!!
   end
 
   it 'should do very cool test stuff' do
-    #-> Given I have some cars
     expect('cars').to eq 'cars'
-    #-> And I drive one of them
     expect('diesel').to eq 'diesels'
-    #-> Then I should go fast
     expect('apple').to eq 'apple'
   end
 
@@ -45,14 +52,11 @@ describe 'The second Test' do
   end
 
   it 'should do very rawesome test stuff' do
-        #-> Given I have some cars
     pending('give me a woop')
     fail
   end
 
   it 'should do insane and cool test stuff' do
     expect('ships').to eq 'ships'
-   end
-
-
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_yah_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kingsley Hendrickse
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -141,6 +141,7 @@ files:
 - rspec_yah_formatter.gemspec
 - spec/penders_spec.rb
 - spec/rspec_html_formatter_spec.rb
+- spec/something.png
 - spec/test2_spec.rb
 - templates/report.erb
 homepage: http://github.com/dgmora/rspec_yah_formatter