capybara-inline-screenshot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6faf3f9276b69c6cbe55781c9ac60dbc3205a8bb
+  data.tar.gz: 83ce00c424fdde1ba80629cb17560f7063ab0af6
+SHA512:
+  metadata.gz: cf047e94deee05c01ad29f65b81a88be5434a47323c73fb9574702f2f3a9190d438a352be5d880659fe079cf098ac8a89af87012165b187543bd586879384637
+  data.tar.gz: 6ae2b6f2a60480d39f101e7608d1d1ac61ac700ae148162522320d0bfe4551920327ca675a121d87b16e1d2c8f59aee5fe1711df206e3df4a4c147a107c7dfcb

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2015 Buildkite Pty Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# capybara-inline-screenshot
+
+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)
+
+In [Buildkite](https://buildkite.com/):
+
+![Screenshot of Buildkite](screenshots/buildkite.png)
+
+## Usage
+
+Add it to your Gemfile (after `capybara-screenshot`):
+
+```ruby
+gem 'capybara-inline-screenshot'
+```
+
+And replace your call to:
+
+```ruby
+require 'capybara/screenshot/rspec'
+```
+
+with:
+
+```ruby
+require 'capybara-inline-screenshot/rspec'
+```
+
+## License
+
+See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).

data/lib/capybara-inline-screenshot.rb

@@ -0,0 +1,38 @@
+require 'base64'
+require 'capybara-screenshot'
+
+module CapybaraInlineScreenshot
+  # Sets the default base directory for artifacts (usually the root dir of the
+  # project). Defaults to Rails.root but can be set to another value if you're
+  # not using Rails.
+  def self.base_artifact_dir=(path)
+    @base_artifact_dir = path
+  end
+
+  def self.base_artifact_dir
+    @base_artifact_dir || Rails.root
+  end
+
+  def self.escape_code_for_image(path)
+    if ENV['CI'] || ENV['CAPYBARA_INLINE_SCREENSHOT'] == 'artifact'
+      artifact_escape_code_for_image(path)
+    else
+      base64_escape_code_for_image(path)
+    end
+  end
+
+  def self.artifact_escape_code_for_image(path)
+    relative_path = path.sub(/\A#{base_artifact_dir}\/?/, '')
+    "\e]1338;url=artifact://#{relative_path}\a"
+  end
+
+  def self.base64_escape_code_for_image(path)
+    name = inline_base64(File.basename(path))
+    image = inline_base64(File.read(path))
+    "\e]1337;File=name=#{name};inline=1:#{image}\a"
+  end
+
+  def self.inline_base64(string)
+    Base64.encode64(string).gsub("\n",'')
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'capybara-inline-screenshot'
+require 'capybara-screenshot'
+require 'capybara-screenshot/rspec'
+
+module CapybaraInlineScreenshot::Rspec
+  extend Capybara::Screenshot::RSpec::BaseReporter
+
+  enhance_with_screenshot :example_failed
+
+  def example_failed_with_screenshot(notification)
+    example_failed_without_screenshot(notification)
+
+    if screenshot = notification.example.metadata[:screenshot]
+      output.puts CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://#{screenshot[:html]}") if screenshot[:html]
+      output.puts CapybaraScreenshot::Helpers.yellow("Image screenshot: file://#{screenshot[:image]}") if screenshot[:image]
+      output.puts CapybaraInlineScreenshot.escape_code_for_image(screenshot[:image]) if screenshot[:image]
+    end
+  end
+end
+
+Capybara::Screenshot::RSpec::REPORTERS["RSpec::Core::Formatters::ProgressFormatter"] = CapybaraInlineScreenshot::Rspec
+Capybara::Screenshot::RSpec::REPORTERS["RSpec::Core::Formatters::DocumentationFormatter"] = CapybaraInlineScreenshot::Rspec

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: capybara-inline-screenshot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends capybara-screenshot with inline image output
+email: t@toolmantim.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/capybara-inline-screenshot.rb
+- lib/capybara-inline-screenshot/rspec.rb
+homepage: http://github.com/buildkite/capybara-inline-screenshot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Extends capybara-screenshot with inline image output
+test_files: []