rspec-visual 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a003cdbec4d7284cec1419b7f6b4bca7c516bb62
+  data.tar.gz: 75a4ee1e612612454829ec7677aa340c4810112b
+SHA512:
+  metadata.gz: e7756763e7f83749b41ca5e9e2755138785cd6af2990bee75c47c4452afab6f9fae1effe5bb10b7dc0393c31dd9ea6a16f6dd5707faa18de486c3a4deb683aad
+  data.tar.gz: 8141f2ab42372d477dbbf5d8f48f9da262c449ce9639d38bf630faa79e1440a823bd78f62f43de8cd25f90517bc3f4583c5a411afc55db0a1a88ecf85af3b2dc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-visual.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Simon Bagreev
+
+MIT License
+
+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,142 @@
+# Rspec::Visual
+
+RSpec plugin for writing "visual" tests: tests that look for changes in the
+applications's look by comparing screenshots on current branch to the latest
+'stable' screenshots
+
+## Installation and Usage
+
+### Step 1 - Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-visual'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-visual
+
+### Step 2 - Configuration
+
+Configure `rspec-visual` with the folder for _"stable"_ screenshots (they will
+be persisted in version control), folder for temporary screenshots, and run `capybara` setup:
+
+```ruby
+# spec/support/rspec-visual.rb
+Rspec::Visual::Configuration.configure do |config|
+  config.screenshot_folder = Rails.root.join('tmp')
+  config.stable_screenshot_folder = Rails.root.join('docs/visual')
+  config.configure_capybara
+end
+```
+
+### Step 3 - Writing tests
+
+Write some visual tests (**make sure to tag them with `visual: true`**)
+using following steps:
+
+- in your test, visit the page that you want to check
+- take the screenshot using `take_screenshot` helper and passing it page and example
+- use `look_like` matcher for assertion
+
+```ruby
+# spec/features/visual/home_page_spec.rb
+require 'rails_helper'
+
+describe 'home page', type: :feature, visual: true do
+  it 'home_page' do |example|
+    visit '/'
+    take_screenshot(page, example)
+    should look_like example.description
+  end
+end
+```
+
+### Step 4 - Checking the result
+
+#### First run
+
+No failures will occur. Screenshots will be saved in the "stable" folder that you
+defined in "Configure" step.
+
+#### Consequent runs
+
+Screenshots from all "visual" tests will be matched against ones in "stable" folder.
+
+In case there is a difference, like so:
+
+#### "Stable" screenshot
+![Original](/../screenshots-do-not-delete/sample1.jpg?raw=true "Original")
+
+#### Screenshot with changes (banner missing)
+![Actual](/../screenshots-do-not-delete/sample2.jpg?raw=true "Actual")
+
+#### Diff file (diff area is highlighted in red)
+![Diff](/../screenshots-do-not-delete/sample_diff.jpg?raw=true "Diff")
+
+The test will fail and difference file will be generated in
+`Rspec::Visual::Configuration.screenshot_folder`:
+
+Also, failure message will say:
+
+```shell
+Failures:
+
+  1) home page home_page
+     Failure/Error: should look_like example.description
+       expected /path/to/tmp/home_page.png to look like /path/to/docs/visual/home_page.png
+       If you intended home_page to look diffrently, please copy over /path/to/tmp/home_page.png into /path/to/docs/visual
+     # ./spec/features/visual/home_page_visual_spec.rb:10:in `block (2 levels) in <top (required)>'
+```
+_**Please read the failure message carefully, and if you indeed wanted the page to change
+than manually copy now-correct screenshot to the "stable" folder in order for specs to pass**_
+
+## GOTCHAS
+
+1. depends on `rspec, capybara, poltergeist, phantomJS` and _**imagemagick**_
+2. May conflict with `VCR`, to overcome use:
+```ruby
+VCR.configure do |c|
+  c.ignore_localhost = true
+end
+```
+3. If you want to check the app that is NOT _localhost_, use Capybara config like so:
+
+```ruby
+RSpec.configure do |config|
+  default = Capybara.server_port
+  config.before(:example, :visual => :true) do
+    Capybara.run_server = false
+    Capybara.server_port = 80
+    Capybara.app_host = 'http://stage.myapp.com'
+  end
+
+  config.after(:example, :visual => :true) do
+    Capybara.run_server = true
+    Capybara.server_port = default
+  end
+end
+```
+
+## Contributing
+
+### TODO
+
+- add ability to take screenshots in different browsers
+- add ability to take screenshots in different viewports
+- add ability to configure 'similarity' percentage
+- add ability to test certain areas of the page
+- add test coverage
+- expand beyond `poltergeist`, try `selenium-webkit`
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-visual/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rspec/visual/configuration.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module Rspec
+  module Visual
+    class Configuration
+      include Singleton
+
+      class << self
+        attr_accessor :screenshot_folder, :stable_screenshot_folder
+
+        def configure
+          yield self
+        end
+
+        def configure_capybara
+          Capybara.register_driver :poltergeist do |app|
+            Capybara::Poltergeist::Driver.new(app, js_errors: false)
+          end
+
+          RSpec.configure do |config|
+            config.before(:example, :visual => :true) do
+              config.include ScreenshotHelper
+              Capybara.current_driver = :poltergeist
+            end
+
+            config.after(:example, :visual => :true) do
+              Capybara.use_default_driver
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/visual/helpers/screenshot_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec/visual/configuration'
+module ScreenshotHelper
+  def take_screenshot(page, example)
+    file_path = File.join(Rspec::Visual::Configuration.screenshot_folder, "#{example.description}.png")
+    page.save_screenshot(file_path, full: true)
+  end
+end

data/lib/rspec/visual/matchers/look_like_matcher.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+require 'rspec/expectations'
+
+RSpec::Matchers.define :look_like do |expected|
+  expected_image_file_path = File.join(Rspec::Visual::Configuration.stable_screenshot_folder, "#{expected}.png")
+  actual_image_file_path = File.join(Rspec::Visual::Configuration.screenshot_folder, "#{expected}.png")
+
+  match do |actual|
+    unless File.exists?(expected_image_file_path)
+      File.cp(actual_image_file_path, expected_image_file_path) and return true
+    end
+
+    diff_file_path = File.join(Rspec::Visual::Configuration.screenshot_folder, "#{expected}_diff.png")
+    system "compare -metric PAE -subimage-search -dissimilarity-threshold 1 \
+          #{expected_image_file_path} #{actual_image_file_path} #{diff_file_path}"
+  end
+
+  failure_message do |actual|
+    "expected #{actual_image_file_path} to look like #{expected_image_file_path}\n"\
+    "If you intended #{expected} to look diffrently, please copy over "\
+    "#{actual_image_file_path} into #{Rspec::Visual::Configuration.stable_screenshot_folder}"
+  end
+end

data/lib/rspec/visual/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Visual
+    VERSION = "0.0.1"
+  end
+end

data/lib/rspec/visual.rb

@@ -0,0 +1,4 @@
+require 'rspec/visual/version'
+require 'rspec/visual/configuration'
+require 'rspec/visual/helpers/screenshot_helper'
+require 'rspec/visual/matchers/look_like_matcher'

data/rspec-visual.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/visual/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-visual"
+  spec.version       = Rspec::Visual::VERSION
+  spec.authors       = ["Simon Bagreev"]
+  spec.email         = ["sbagreev@gmail.com"]
+  spec.summary       = %Q{ Visual testing with rspec via screenshot comparison. }
+  spec.description   = %Q{ Adds 'visual' specs and matchers that take screenshots
+                          of the app and compare them to find regressions in
+                          frontend. Must have imagemagick installed! Depends on
+                          rspec, capybara, poltergeist }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "capybara", "~> 2.4"
+  spec.add_dependency "poltergeist", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rspec-visual
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Simon Bagreev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: " Adds 'visual' specs and matchers that take screenshots\n                          of
+  the app and compare them to find regressions in\n                          frontend.
+  Must have imagemagick installed! Depends on\n                          rspec, capybara,
+  poltergeist "
+email:
+- sbagreev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/visual.rb
+- lib/rspec/visual/configuration.rb
+- lib/rspec/visual/helpers/screenshot_helper.rb
+- lib/rspec/visual/matchers/look_like_matcher.rb
+- lib/rspec/visual/version.rb
+- rspec-visual.gemspec
+homepage: ''
+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.8
+signing_key: 
+specification_version: 4
+summary: Visual testing with rspec via screenshot comparison.
+test_files: []
+has_rdoc: