capybara-screenshot 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f711d80a74075257002c14a00a6493f212c29aef
-  data.tar.gz: 4ce30deb7d3076398bd0c9ac2f9ec59659355fd8
+  metadata.gz: ea0f0f79b26cc47c17432e0d436e6c5c11fe1d01
+  data.tar.gz: cf7a0fdcf2f73c7dda324ab4f06eeacf0af4b4fd
 SHA512:
-  metadata.gz: eb7f3178a7d365d847fee3a87fc2eb0204a858d284ba3589159745af71a0cf2722167a8935987d61a451c376e1708951334ba3fab9e29564ecad3fae7abaf35b
-  data.tar.gz: 5edea2883f4c986445e7951d13c1d51b988e42d7868e78effc0cf536e26368e6090162f61b20eb7be4d37ad2fcd793401fc10638da291699510530493a8d87a0
+  metadata.gz: 8c9b5f03a37755b78be62e9b5619e23200d6ee7017a7b21d2c33a75dc127632e431707e349572511aba2e900af51597674e47cdf1604312b1b7f6056fda3c600
+  data.tar.gz: d3c4e74a8b4c7c58a6770695ceb8d5d174253f82cafbb19408f127bda0d1bad9077e16d5cb838fe3bd8ca7a7192f2b27c722bc4258dc8a37b3e95a52ef7ba1e0

data/.travis.yml

@@ -3,9 +3,9 @@ script: "rake travis:ci"
 rvm:
   - 1.9.3
   - 2.0.0
-  - ruby-head
+  - 2.1.2
   - jruby-19mode
-  - jruby-head
+  - jruby-1.7.13
 gemfile:
   - gemfiles/cucumber.1.2.gemfile
   - gemfiles/cucumber.1.3.0.gemfile

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+27 September 2014 - 1.0.1 -> 1.0.2
+-----------
+
+* Improved documentation to cover RSpec 3's new approach to using `rails_helper` in place of `spec_helper` for Rails tests
+* Updated documentation to use Ruby formatting in language blocks
+* Removed need to manually `require 'capybara-screenshot'` for RSpec
+
 18 September 2014 - 1.0.0 -> 1.0.1
 -----------
 

data/README.md

@@ -2,8 +2,7 @@ capybara-screenshot gem
 =======================
 
 [![Build Status](https://travis-ci.org/mattheworiordan/capybara-screenshot.png)](https://travis-ci.org/mattheworiordan/capybara-screenshot)
-[![Code Climate](https://d3s6mut3hikguw.cloudfront.net/github/mattheworiordan/capybara-screenshot.png)](https://codeclimate.com/github/mattheworiordan/capybara-
-screenshot)
+[![Code Climate](https://d3s6mut3hikguw.cloudfront.net/github/mattheworiordan/capybara-screenshot.png)](https://codeclimate.com/github/mattheworiordan/capybara-screenshot)
 [![Gem Version](https://badge.fury.io/rb/capybara-screenshot.svg)](http://badge.fury.io/rb/capybara-screenshot)
 
 #### Capture a screen shot for every test failure automatically!
@@ -17,39 +16,63 @@ _Please note that Ruby 1.9+ is required to use this Gem.  For Ruby 1.8 support,
 Installation
 -----
 
-### Step 1
+### Step 1: install the gem
 
 Using Bundler, add the following to your Gemfile
 
-    gem 'capybara-screenshot', :group => :test
+```ruby
+gem 'capybara-screenshot', :group => :test
+```
 
 or install manually using Ruby Gems:
 
-    gem install capybara-screenshot
+```
+gem install capybara-screenshot
+```
 
-### Step 2
+### Step 2: load capybara-screenshot into your tests
 
-For **Cucumber**, in env.rb or a support file, please add:
+#### Cucumber
 
-    require 'capybara-screenshot/cucumber'
+In env.rb or a support file, please add:
 
-For **RSpec**, in spec_helper.rb or a support file, after the require for 'capybara/rspec', please add:
+```ruby
+require 'capybara-screenshot/cucumber'
+```
 
-    # you should require 'capybara/rspec' first
-    require 'capybara-screenshot'
-    require 'capybara-screenshot/rspec'
+#### RSpec
 
-For **Minitest**, typically in 'test/test_helper.rb', please add:
+In rails_helper.rb, spec_helper.rb, or a support file, after the require for 'capybara/rspec', please add:
 
-    require 'capybara-screenshot/minitest'
+```ruby
+# remember: you must require 'capybara/rspec' first
+require 'capybara-screenshot/rspec'
+```
 
-For **Test::Unit**, typically in 'test/test_helper.rb', please add:
+*Note: As of RSpec Rails 3.0, it is recommended that all your Rails environment code is loaded into `rails_helper.rb` instead of `spec_helper.rb`, and as such, the capybara-screenshot require should be located in `rails_helper.rb`.  See the [RSpec Rails 3.0 upgrade notes](https://www.relishapp.com/rspec/rspec-rails/v/3-0/docs/upgrade) for more info.*
 
-    require 'capybara-screenshot/testunit'
+#### Minitest
+
+Typically in 'test/test_helper.rb', please add:
+
+```ruby
+require 'capybara-screenshot/minitest'
+```
+
+#### Test::Unit
+
+Typically in 'test/test_helper.rb', please add:
+
+```ruby
+require 'capybara-screenshot/testunit'
+```
 
 By default, screenshots will be captured for `Test::Unit` tests in the path 'test/integration'.  You can add additional paths as:
 
-    Capybara::Screenshot.testunit_paths << 'test/feature'
+```ruby
+Capybara::Screenshot.testunit_paths << 'test/feature'
+```
+
 
 Manual screenshots
 ----
@@ -58,20 +81,28 @@ If you require more control, you can generate the screenshot on demand rather th
 if the failure occurs at a point where the screen shot is not as useful for debugging a rendering problem. This
 can be more useful if you disable the auto-generate on failure feature with the following config
 
-	Capybara::Screenshot.autosave_on_failure = false
+```ruby
+Capybara::Screenshot.autosave_on_failure = false
+```
 
 Anywhere the Capybara DSL methods (visit, click etc.) are available so too are the screenshot methods.
 
-	screenshot_and_save_page
+```ruby
+screenshot_and_save_page
+```
 
 Or for screenshot only, which will automatically open the image.
 
-	screenshot_and_open_image
+```ruby
+screenshot_and_open_image
+```
 
 These are just calls on the main library methods.
 
-    Capybara::Screenshot.screenshot_and_save_page
-    Capybara::Screenshot.screenshot_and_open_image
+```ruby
+Capybara::Screenshot.screenshot_and_save_page
+Capybara::Screenshot.screenshot_and_open_image
+```
 
 
 Driver configuration
@@ -79,22 +110,28 @@ Driver configuration
 
 The gem supports the default rendering method for Capybara to generate the screenshot, which is:
 
-	page.driver.render(path)
+```ruby
+page.driver.render(path)
+```
 
 There are also some specific driver configurations for Selenium, Webkit, and Poltergeist. See [the definitions here](https://github.com/mattheworiordan/capybara-screenshot/blob/master/lib/capybara-screenshot.rb). The Rack::Test driver, Rails' default, does not allow
 rendering, so it has a driver definition as a noop.
 
 Capybara-webkit defaults to a screenshot size of 1000px by 10px. To specify a custom size, use the following option:
 
-    Capybara::Screenshot.webkit_options = { width: 1024, height: 768 }
+```ruby
+Capybara::Screenshot.webkit_options = { width: 1024, height: 768 }
+```
 
 If a driver is not found the default rendering will be used. If this doesn't work with your driver, then you can
 add another driver configuration like so
 
-	# The driver name should match the Capybara driver config name.
-	Capybara::Screenshot.register_driver(:exotic_browser_driver) do |driver, path|
-	  driver.super_dooper_render(path)
-	end
+```ruby
+# The driver name should match the Capybara driver config name.
+Capybara::Screenshot.register_driver(:exotic_browser_driver) do |driver, path|
+  driver.super_dooper_render(path)
+end
+```
 
 
 Custom screenshot filename
@@ -103,20 +140,26 @@ Custom screenshot filename
 If you want to control the screenshot filename for a specific test library, to inject the test name into it for example,
 you can override how the basename is generated for the file like so
 
-	  Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
-	    "screenshot_#{example.description.gsub(' ', '-').gsub(/^.*\/spec\//,'')}"
-	  end
+```ruby
+Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
+  "screenshot_#{example.description.gsub(' ', '-').gsub(/^.*\/spec\//,'')}"
+end
+```
 
 By default capybara-screenshot will append a timestamp to the basename. If you want to disable this behavior set the following option:
 
-    Capybara::Screenshot.append_timestamp = false
+```ruby
+Capybara::Screenshot.append_timestamp = false
+```
 
 
 Custom screenshot directory
 --------------------------
 By default screenshots are saved to the current working directory. If you want to customize the location, override the file path as:
 
-    Capybara.save_and_open_page_path = "/file/path"
+```ruby
+Capybara.save_and_open_page_path = "/file/path"
+```
 
 
 Information about screenshots in RSpec output
@@ -124,11 +167,15 @@ Information about screenshots in RSpec output
 
 By default, capybara-screenshot extend RSpec’s formatters to include a link to the screenshot and/or saved html page for each failed spec. If you want to disable this feature completely (eg. to avoid problems with CI tools), use:
 
-    Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples = false
+```ruby
+Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples = false
+```
 
 It’s also possible to directly embed the screenshot image in the output if you’re using RSpec’s HtmlFormatter:
 
-    Capybara::Screenshot::RSpec::REPORTERS["RSpec::Core::Formatters::HtmlFormatter"] = Capybara::Screenshot::RSpec::HtmlEmbedReporter
+```ruby
+Capybara::Screenshot::RSpec::REPORTERS["RSpec::Core::Formatters::HtmlFormatter"] = Capybara::Screenshot::RSpec::HtmlEmbedReporter
+```
 
 If you want to further customize the information added to RSpec’s output, just implement your own reporter class and customize `Capybara::Screenshot::RSpec::REPORTERS` accordingly. See [rspec.rb](lib/capybara-screenshot/rspec.rb) for more info.
 
@@ -140,9 +187,11 @@ If you have recently upgraded from v0.2, or you find that screen shots are not a
 
 Also make sure that you're not calling `Capybara.reset_sessions!` before the screenshot hook runs. For RSpec you want to make sure that you're using `append_after` instead of `after`, for instance:
 
-    config.append_after(:each) do
-      Capybara.reset_sessions!
-    end
+```ruby
+config.append_after(:each) do
+  Capybara.reset_sessions!
+end
+```
 
 [Raise an issue on the Capybara-Screenshot issue tracker](https://github.com/mattheworiordan/capybara-screenshot/issues) if you are still having problems.
 

data/lib/capybara-screenshot/capybara.rb

@@ -1,3 +1,5 @@
+require "capybara-screenshot"
+
 module Capybara
   module DSL
     # Adds class methods to Capybara module and gets mixed into

data/lib/capybara-screenshot/cucumber.rb

@@ -1,3 +1,5 @@
+require "capybara-screenshot"
+
 Before do |scenario|
   Capybara::Screenshot.final_session_name = nil
 end

data/lib/capybara-screenshot/minitest.rb

@@ -1,3 +1,5 @@
+require "capybara-screenshot"
+
 module Capybara::Screenshot::MiniTestPlugin
   def before_setup
     super

data/lib/capybara-screenshot/rspec.rb

@@ -1,3 +1,5 @@
+require "capybara-screenshot"
+
 require "capybara-screenshot/rspec/text_reporter"
 require "capybara-screenshot/rspec/html_link_reporter"
 require "capybara-screenshot/rspec/html_embed_reporter"

data/lib/capybara-screenshot/spinach.rb

@@ -1,3 +1,5 @@
+require "capybara-screenshot"
+
 Spinach.hooks.before_scenario do |scenario|
   Capybara::Screenshot.final_session_name = nil
 end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,186 +1,185 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Matthew O'Riordan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '3'
-  type: :runtime
+  name: capybara
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: launchy
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: colored
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: timecop
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: cucumber
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: aruba
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: sinatra
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: test-unit
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: spinach
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: spinach
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: minitest
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: When a Cucumber step fails, it is useful to create a screenshot image
-  and HTML file of the current page
+description: When a Cucumber step fails, it is useful to create a screenshot image and HTML file of the current page
 email:
 - matthew.oriordan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -235,27 +234,26 @@ homepage: http://github.com/mattheworiordan/capybara-screenshot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+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: capybara-screenshot
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
-summary: Automatically create snapshots when Cucumber steps fail with Capybara and
-  Rails
+summary: Automatically create snapshots when Cucumber steps fail with Capybara and Rails
 test_files:
 - spec/cucumber/cucumber_spec.rb
 - spec/cucumber/step_definitions/step_definitions.rb