rspec_yah_formatter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5991db17503bca41a3362fac0f61251f74a54b28
-  data.tar.gz: 86a6427828f37541f17b084b4367b834394c6fe8
+  metadata.gz: fadff7e240dc6674f7d356501e47e53aee9d91d2
+  data.tar.gz: 2a76d915da277a119c1262d6c56df1b767aa20e9
 SHA512:
-  metadata.gz: 302fafb381ee493bdecb3d31880cf46b7c00ceea78ff117cf48c8f2008c582e64c15cc925a5ade94a27023786de6dc0f9aefe82c82b36b1593813e5c15341329
-  data.tar.gz: e2f8343a74dcaa27b4a57d9d8faa258f85dd396d4ce9e5d0c08b62948a248ebff46e2f832e754855f666f672ccc7e5bc711e96b440b58c7274494e0a492a971e
+  metadata.gz: 876f4f04bd416fc7eb1b93fdeef5b53fdce0094862d8db5bfbcdf3f31d4bbaf8dcac6c6fcb1402b3dadf84150902ae94b7f6f65492edb066bda906f06c7e47c3
+  data.tar.gz: d258630cb6f0f65c8e9b62c9b7f2ea02798e65571073a167a457365d4bd9d4d87324471766b1ce05e884eae28d40a402d96c72c10e76d0c5803de998a68ab9a1

data/README.md

@@ -1,22 +1,48 @@
 # PLEASE NOTE - This is a fork from [rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter)
 
-# Publish pretty [rspec](http://rspec.info/) reports
+# Publish pretty [rspec](http://rspec.info/) reports with images
 
-This is a ruby Rspec custom formatter which generates pretty html reports showing the results of rspec tests. This gem was build to use Rspec 3.x.x
+This is a RSpec formatter which generates pretty html reports showing the results of rspec tests, where you can also easily attach images and screenshots.
+
+## Why another formatter?
+
+On CI servers, xUnit xml test reports are quite "standard", but the attachments cannot be linked to a concrete test. I mean, just [look at this](https://wiki.jenkins-ci.org/download/attachments/42467572/junit-attachments.png).
+
+The RSpec HTML formatter is a prettier alternative, but it still doesn't allow to attach images.
+
+With `rspec_yah_formatter` you can attach images, which is very useful for `capybara`, `selenium` and so on.
+
+Plus, the interface kingsleyh created with [rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter) looks much nicer.
+
+## Features
+
+This report is inspired in [rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter), with some differences:
+
+- All examples are shown in the same page. This makes it simpler, and also 
+avoids [this](https://github.com/kingsleyh/rspec_reports_formatter/issues/3)
+- As mentioned, you can add images
+- To avoid that the page is filled with stacktraces and images, errors are by default hidden, and you can show them by clicking on them.
+- This report only makes sense in html, so you must specify a file in `--out`when running rspec
+- Removed the "magic" Gherkin processing of the comments on the specs
+
+Here is also the [Changelog](../../wiki/Changelog) and a [TODO list](../../wiki/TODO-list)
 
 ## Install
 
+This gem was build to use Rspec 3.x.x
+
 ```
-  gem install rspec_yah_formatter -v 0.0.1
+  gem install rspec_yah_formatter -v 0.0.4
 ```
 
 ideally just add it to your bundler Gemfile as follows:
 
 ```ruby
- gem 'rspec_yah_formatter','~> 0.0.1'
+ gem 'rspec_yah_formatter','~> 0.0.4'
 ```
 
 ## Use
+
 When running your rspec tests with rspec 3.0.0 just use the custom formatter:
 
 This should work:
@@ -31,13 +57,16 @@ If not you can explicitly add in a require as follows:
  rspec --require rspec_yah_formatter.rb --format RspecYahFormatter spec
 ```
 
+To add images:
 
-![example report]
-This report is inspired in [rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter), with some differences:
+```
+RSpec.configure do |config|
+  config.after(:each) do |example| 
+    if example.exception
+        # Save screenshot to 'path/to/foo.png'
+        example.metadata[:screenshot] = 'path/to/foo.png'
+    end
+  end
+end
+```
 
-- All examples are shown in the same page. This makes it simpler, and also 
-avoids [this](https://github.com/kingsleyh/rspec_reports_formatter/issues/3)
-- **You can add images**. To do that, you have to create a png in the same folder where --out is, and name it `<spec-filename>-<line-with-error>.png`. The formatter will pick up the images automatically. It's quite restrictive, but this will be worked out later.
-- To avoid that the page is filled with stacktraces and images, errors are by default hidden, and you can show them by clicking on them.
-- This report only makes sense in html, so you must specify a file in `--out`when running rspec
-- Removed the "magic" Gherkin processing of the comments on the specs

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/example.rb

@@ -18,7 +18,7 @@ class Example
     @exception = Oopsy.new(example.exception, @file_path)
     filename = File.basename(@metadata[:file_path])
     line_number = @metadata[:line_number]
-    @screenshot = "#{filename}-#{line_number}.png"
+    @screenshot = @metadata[:screenshot] || "#{filename}-#{line_number}.png"
     @spec = nil
   end
 

data/rspec_yah_formatter.gemspec

@@ -2,11 +2,11 @@
 # 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.3 ruby lib
+# stub: rspec_yah_formatter 0.0.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rspec_yah_formatter"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_yah_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kingsley Hendrickse