capybara-inline-screenshot 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6faf3f9276b69c6cbe55781c9ac60dbc3205a8bb
-  data.tar.gz: 83ce00c424fdde1ba80629cb17560f7063ab0af6
+  metadata.gz: 546f109b8ce665f0b1bc0f16c3d0b7006d2c7d9d
+  data.tar.gz: 58be3e7b15e6c72b55b85be661b005c699e55181
 SHA512:
-  metadata.gz: cf047e94deee05c01ad29f65b81a88be5434a47323c73fb9574702f2f3a9190d438a352be5d880659fe079cf098ac8a89af87012165b187543bd586879384637
-  data.tar.gz: 6ae2b6f2a60480d39f101e7608d1d1ac61ac700ae148162522320d0bfe4551920327ca675a121d87b16e1d2c8f59aee5fe1711df206e3df4a4c147a107c7dfcb
+  metadata.gz: 1d88b8db90ba841507147aad74325103ff9b8740f8401a7cdb50b6ad87143f5a8e37f127c7728b50e54dfd3c5582d976b11a68960ee55ba8ce9c3d02a6c52a2c
+  data.tar.gz: 431da3ba652a3d2b6ed95498003916e25b695881bfdf7f838a62ff655e7a67a4f9fb13c06ccfd130e5cbb2ca3ddd2d7f29de5d6a24661650e8cd6e5bbd30e33c

data/README.md

@@ -2,8 +2,6 @@
 
 Extends [capybara-screenshot](https://github.com/mattheworiordan/capybara-screenshot) with inline image output.
 
-If `CI` environment variable is not present it will output screenshots in base64 encoded [iTerm2 image format](http://iterm2.com/images.html), and if `CI` is present it will output in the [Terminal artifact:// format](http://buildkite.github.io/terminal/inline-images/).
-
 In [iTerm2 (nightly)](http://iterm2.com/):
 
 ![Screenshot of iTerm2](screenshots/iterm.png)
@@ -14,16 +12,19 @@ In [Buildkite](https://buildkite.com/):
 
 ## Usage
 
-Add it to your Gemfile (after `capybara-screenshot`):
+In your Gemfile simply replace `capybara-screenshot` with `capybara-inline-screenshot`:
 
 ```ruby
 gem 'capybara-inline-screenshot'
 ```
 
-And replace your call to:
+
+### RSpec
+
+And where you initialize Capybara simply replace your call to:
 
 ```ruby
-require 'capybara/screenshot/rspec'
+require 'capybara-screenshot/rspec'
 ```
 
 with:
@@ -32,6 +33,26 @@ with:
 require 'capybara-inline-screenshot/rspec'
 ```
 
+### Cucumber
+
+For cucumber we use a different file
+
+```ruby
+require 'capybara-inline-screenshot/cucumber'
+```
+
+The final step is to configure your build steps to upload the screenshot artifacts. The default path is your app’s `tmp` directory, so the artifact upload pattern would be `tmp/*.png`
+
+## Fallback
+
+Thanks the wonder of ANSI escape codes if your terminal client doesn't understand the escape codes it'll simply ignore them—it'll just be be like using the standard capybara-screenshot gem.
+
+## CI-mode
+
+If the `CI` environment variable is present screenshots will be output in the [Terminal artifact:// format](http://buildkite.github.io/terminal/inline-images/) with the expectation that the images are uploaded as build artifacts and inlined by your CI system. You can also force this mode by setting the environment variable `CAPYBARA_INLINE_SCREENSHOT=artifact`.
+
+If the `CI` environment variable is not present screenshots will be output in the base64 encoded [iTerm2 image format](http://iterm2.com/images.html) for viewing in a local terminal. You'll need the nightly release of iTerm to see the images.
+
 ## License
 
 See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).

data/lib/capybara-inline-screenshot/cucumber.rb

@@ -0,0 +1,25 @@
+require 'capybara-inline-screenshot'
+require 'capybara-screenshot'
+
+Before do |scenario|
+  Capybara::Screenshot.final_session_name = nil
+end
+
+After do |scenario|
+  if Capybara::Screenshot.autosave_on_failure && scenario.failed?
+    Capybara.using_session(Capybara::Screenshot.final_session_name) do
+      filename_prefix = Capybara::Screenshot.filename_prefix_for(:cucumber, scenario)
+
+      saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+      saver.save
+      saver.output_screenshot_path
+
+      if File.exist?(saver.screenshot_path)
+        encoded_img = CapybaraInlineScreenshot.inline_base64(File.read(saver.screenshot_path))
+        embed(encoded_img, 'image/png;base64', "Screenshot of the error")
+
+        STDOUT.puts CapybaraInlineScreenshot.escape_code_for_image(saver.screenshot_path)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-inline-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tim Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara-screenshot
@@ -33,6 +33,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/capybara-inline-screenshot.rb
+- lib/capybara-inline-screenshot/cucumber.rb
 - lib/capybara-inline-screenshot/rspec.rb
 homepage: http://github.com/buildkite/capybara-inline-screenshot
 licenses:
@@ -54,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Extends capybara-screenshot with inline image output