motion-juxtapose 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0543dfe3a91b130a2a8faf863307dd63e3ba619d
-  data.tar.gz: b12e0a693f99ef3d63eb0a73674f0ab94a232142
+  metadata.gz: a58dcf720096d73d57d3a904dee1bc216889ce5c
+  data.tar.gz: b54b20541785bfbcb8873f552021578e034ea12e
 SHA512:
-  metadata.gz: f676239c5499c311ed923ab84de8aadd96092459db5a563136352be7d828d986bbf336973313d95192910446d3e5f461268976b48782c3ec775c7a353108fd33
-  data.tar.gz: 013fe557fbbe9ebdcbc0a8dd1d5920a3fd89d312cca5f140936ec35fe97a989e57f96e96d92e3cf157278c2d4b92dea4c7cc855ec8cc9fc31d7a363767a40736
+  metadata.gz: 78e454b932c47f2f76cc27ba28e97c2016fe921f1b3febc6b05164236dd95af2ce5fc542b3a7198af7d3c96be7087e81be1e343b90118c79a83e619d9a6dd2b1
+  data.tar.gz: f2253d30b74513c06b7393734f7155be1c45c482d036328203e5d657d3a3a961596863d8b71a70f2446e703b04a0c5aa15ab5ee1ac2c27b106966daa32fe1347

data/README.md

@@ -1,9 +1,13 @@
 # Juxtapose
 
-Screenshot-driven assertions for testing RubyMotion applications.
+Screenshot-driven assertions for testing Rails and RubyMotion applications.
 
 ## Installation
 
+Motion-juxtapose uses [ImageMagick](http://www.imagemagick.org/) under the hood for image comparison. If you're using [Homebrew](http://brew.sh/), you can install it with:
+
+    brew install imagemagick
+
 Add this line to your application's Gemfile:
 
     gem 'motion-juxtapose'
@@ -22,13 +26,15 @@ Juxtapose's workflow generally goes:
 
 1. Write a test that puts your app in the state you want to capture and take a screenshot (see below for how to do this in Bacon and Frank).
 2. The first time this screenshot is captured, your test will fail with the error "No accepted screen shot".
-3. You must provide Juxtapose an accepted screenshot to match against in future test runs. Run the juxtapose server with `bundle exec juxtapose` and browse to http://localhost:4567 — you should the just-captured screenshot, like below.
+3. You must provide Juxtapose an accepted screenshot to match against in future test runs. Run the juxtapose server with `bundle exec juxtapose` and browse to http://localhost:4567 — you should see the just-captured screenshot, like below.
 4. If the screenshot looks like what you expect, click Accept to save the image. Future runs of this test will be compared against the accepted one. ![Initial view of screenshots.](images/initial-view.png)
 5. Run the tests again, and they should be green.
 6. Later, when you introduce a change (intentionally or not), the tests will fail with the message "Screenshot did not match". Open up the juxtapose server again, and you'll see a comparison of your accepted screenshot with what the test captured. ![Diff view of screenshots.](images/diff-view.png)
 7. If the change was intentional, you can accept the new screenshot - otherwise, you've got some fixin' to do!
 
 
+## Testing RubyMotion Apps
+
 ### MacBacon
 
 Juxtapose provides a single new matcher: `it_should_look_like` takes a single argument, a descriptive string predicate of what the screen should look like.
@@ -70,6 +76,53 @@ Then /^the screen should match "([^\"]*)"$/ do |template|
 end
 ```
 
+## Testing Rails Apps
+
+### Capybara
+
+Any Capybara driver that supports screenshot capture should work, but I've only tested this with [Poltergeist](https://github.com/teampoltergeist/poltergeist) so far.
+
+In your `spec_helper.rb`, add:
+
+```ruby
+require 'juxtapose/capybara'
+
+# if you're using Rspec, you can get the `look_like?` custom matcher with:
+require 'juxtapose/rspec'
+```
+
+Now the Capybara page object will have a `looks_like?(predicate)` method that can call to make screenshot assertions:
+
+```ruby
+feature "viewing locations", js: true do
+  scenario "should only show books at first location" do
+    visit location_path Location.find_by_name("Cambridge")
+    expect(page).to look_like("books at Cambridge")
+  end
+end
+```
+
+### Fuzzy matching
+
+Sometimes screenshots will differ slightly due to things like animation timing. Juxtapose will try to match an existing screenshot multiple times to help counteract this, but it can still be useful to be able to match screenshots using a percent similarity threshold. 
+
+In bacon specs, you can pass a fuzz factor from 0 to 100 to `it_should_look_like`, 0 meaning an exact match and 100 matching anything of the same size. The default is 0.
+
+```ruby
+# matches images that are 15% similar
+it_should_look_like 'a fancy animation', 15
+```
+
+In Frank, pass the fuzz factor in as the third argument to the Screenshotter constructor. A more exacting Frank step could be written as:
+
+```ruby
+Then /^the screen should match "([^\"]*)" within (\d+)% in (\d+) attempts$/ do |template, fuzz_factor, max_attempts|
+  wait_for_nothing_to_be_animating
+  screenshotter = Juxtapose::Screenshotter.new(self, template, fuzz_factor)
+  expect(screenshotter.attempt_verify(max_attempts)).to eq(true)
+end
+```
+
 ### Juxtapose Server
 
 Juxtapose comes with a small webapp that you can use to view your screenshot specs, see diffs between accepted and failing specs and accept any changed images that are expected changes.
@@ -78,6 +131,10 @@ To start it, run `bundle exec juxtapose` in the root of your project and browse
 
 ## Release Notes
 
+#### v.0.2.0
+* Rails/rspec support
+* Fixes to work under newest version of ImageMagick
+
 #### v.0.1.1
 
 * Raise error if screenshot sizes don't match ([@mdenomy](http://github.com/mdenomy))

data/lib/juxtapose/application/js/app.js

@@ -46,7 +46,13 @@ angular.module('juxtapose.controllers').controller('ProjectsCtrl', ['$scope', '$
      });
 
      $scope.iOSVersion = function(spec){
-       return spec.directory.match(/([^\/]*)\/[^\/]+\/[^\/]+$/)[1].match(/[\d\.]+/)[0]
+       version = spec.directory.match(/([^\/]*)\/[^\/]+\/[^\/]+$/)[1] 
+       iosVersion = version.match(/[\d\.]+/)
+       if(iosVersion){
+         return iosVersion[0];
+       } else {
+         return version;
+       }
      }
 
      var versions = _.uniq(_.map($scope.project.specs, $scope.iOSVersion))

data/lib/juxtapose/capybara.rb

@@ -0,0 +1,5 @@
+if defined?(Capybara::Session)
+  class Capybara::Session
+    include Juxtapose
+  end
+end

data/lib/juxtapose/rspec.rb

@@ -0,0 +1,7 @@
+if defined?(RSpec::Matchers)
+  RSpec::Matchers.define :look_like do |predicate|
+    match do |page|
+      page.looks_like?(predicate) == true
+    end
+  end
+end

data/lib/juxtapose/screenshotter.rb

@@ -19,8 +19,12 @@ module Juxtapose
 
   MAX_ATTEMPTS = 20
 
+  def looks_like?(template, fuzz_factor=0)
+    Screenshotter.new(self, template, fuzz_factor).attempt_verify(MAX_ATTEMPTS)
+  end
+
   def it_should_look_like(template, fuzz_factor = 0)
-    Screenshotter.new(self, template, fuzz_factor).attempt_verify(MAX_ATTEMPTS).should.be.true
+    looks_like?(template, fuzz_factor).should.be.true
   end
 
   class Screenshotter
@@ -44,11 +48,17 @@ module Juxtapose
         Juxtapose::MacBaconStrategy.new(context)
       elsif context.respond_to? :frankly_ping
         Juxtapose::FrankStrategy.new(context)
+      elsif defined?(Capybara)
+        Juxtapose::CapybaraStrategy.new(context)
       end
     end
 
     def project_root
-      ENV["RUBYMOTION_PROJECT_DIR"]
+      if defined? Rails
+        Rails.root
+      else
+        ENV["RUBYMOTION_PROJECT_DIR"]
+      end
     end
 
     def test_name
@@ -80,6 +90,8 @@ module Juxtapose
     end
 
     def attempt_verify(max_attempts)
+      ensure_imagemagick_installed
+
       attempts = 0
       while attempts < max_attempts
         return true if verify
@@ -90,6 +102,8 @@ module Juxtapose
     end
 
     def verify
+      ensure_imagemagick_installed
+
       strategy.save_current filename(:current)
       accept_current if ENV['ACCEPT_ALL_SCREENSHOTS']
 
@@ -104,6 +118,16 @@ module Juxtapose
       success
     end
 
+    def ensure_imagemagick_installed
+      unless imagemagick_installed?
+        raise "Executable for 'convert' not installed or not found on $PATH. Please install Imagemagick or add it to your $PATH."
+      end
+    end
+
+    def imagemagick_installed?
+      `command -v convert`.length > 0
+    end
+
     private
 
     def same_size?
@@ -113,20 +137,30 @@ module Juxtapose
       sizes.length == 2 && sizes.uniq.length == 1
     end
 
-    def screenshots_match?
-      match = true
+    def create_diff
+      `compare -fuzz #{fuzz_factor}% -dissimilarity-threshold 1 -subimage-search \"#{filename :current}\" \"#{filename :accepted}\" \"#{filename :diff}\" 2>&1`
+    end
+
+    def cleanup
+      `rm #{filename(:current)}`
+      `rm #{filename(:diff)}`
+    end
+
+    def identical_images?
       compare_command = "compare -fuzz #{fuzz_factor}% -metric AE -dissimilarity-threshold 1 -subimage-search"
       out = `#{compare_command} \"#{filename :current}\" \"#{filename :accepted}\" \"#{filename :diff}\" 2>&1`
       out.chomp!
-      (out == '0').tap do |verified|
-        if verified
-          `rm #{filename(:current)}`
-          `rm #{filename(:diff)}`
-        else
-          match = false
-        end
+      out.start_with?('0')
+    end
+
+    def screenshots_match?
+      if identical_images?
+        cleanup
+        true
+      else
+        create_diff
+        false
       end
-      match
     end
   end
 end

data/lib/juxtapose/strategy/capybara_strategy.rb

@@ -0,0 +1,31 @@
+module Juxtapose
+  class CapybaraStrategy
+
+    attr_accessor :context
+    def initialize(context)
+      self.context = context
+    end
+
+    def version
+      @version ||= "web"
+    end
+
+    def current_spec_description
+      "spec-description"
+      #context.instance_variable_get('@__scenario').name
+    end
+
+    def device_name
+      "capybara"
+    end
+
+    def save_current(filename)
+      Capybara.save_screenshot filename
+    end
+
+    def spec_dir
+      "spec/screens"
+    end
+
+  end
+end

data/lib/juxtapose/version.rb

@@ -1,3 +1,3 @@
 module Juxtapose
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/motion-juxtapose.rb

@@ -1,6 +1,7 @@
 require "juxtapose/version"
 require "juxtapose/screenshotter"
 require "juxtapose/strategy/frank_strategy"
+require "juxtapose/strategy/capybara_strategy"
 
 if defined?(Motion::Project::Config)
   Motion::Project::App.setup do |app|

data/spec/controllers/test_controller_spec.rb

@@ -33,14 +33,14 @@ describe 'screenshot testing under bacon' do
       error.should.not.be.nil
       error.message.should =~ /Screenshot did not match/
 
-      spec_dir = "spec/screens/iphone-retina/ios_7.0.3/screenshot-testing-under-bacon-raises-an-error-and-produces-diffs-on-failure/going-to-differ-screenshot"
+      spec_dir = "spec/screens/iphone-retina/ios_7.1/screenshot-testing-under-bacon-raises-an-error-and-produces-diffs-on-failure/going-to-differ-screenshot"
 
       File.should.exist(File.join( ENV["RUBYMOTION_PROJECT_DIR"], spec_dir, "current.png"))
       File.should.exist(File.join( ENV["RUBYMOTION_PROJECT_DIR"], spec_dir, "diff.png"))
     end
   end
 
-  it "raises an error when screens are different sizes" do 
+  it "raises an error when screens are different sizes" do
     error = nil
     begin
       it_should_look_like "different sized screenshot"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-juxtapose
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe Lind
@@ -10,90 +10,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: haml
   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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   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
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Screenshot-based assertions for RubyMotion projects
@@ -104,7 +104,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -151,16 +151,19 @@ files:
 - lib/juxtapose/application/spec/models/spec_spec.rb
 - lib/juxtapose/application/spec/spec_helper.rb
 - lib/juxtapose/application/views/index.html.haml
+- lib/juxtapose/capybara.rb
+- lib/juxtapose/rspec.rb
 - lib/juxtapose/screenshotter.rb
+- lib/juxtapose/strategy/capybara_strategy.rb
 - lib/juxtapose/strategy/frank_strategy.rb
 - lib/juxtapose/strategy/mac_bacon_strategy.rb
 - lib/juxtapose/version.rb
 - lib/motion-juxtapose.rb
 - motion-juxtapose.gemspec
 - spec/controllers/test_controller_spec.rb
-- spec/screens/iphone-retina/ios_7.0.3/screenshot-testing-under-bacon-passes-when-there-is-an-identical-accepted-screenshot/accepted-screenshot/accepted.png
-- spec/screens/iphone-retina/ios_7.0.3/screenshot-testing-under-bacon-raises-an-error-and-produces-diffs-on-failure/going-to-differ-screenshot/accepted.png
-- spec/screens/iphone-retina/ios_7.0.3/screenshot-testing-under-bacon-raises-an-error-when-screens-are-different-sizes/different-sized-screenshot/accepted.png
+- spec/screens/iphone-retina/ios_7.1/screenshot-testing-under-bacon-passes-when-there-is-an-identical-accepted-screenshot/accepted-screenshot/accepted.png
+- spec/screens/iphone-retina/ios_7.1/screenshot-testing-under-bacon-raises-an-error-and-produces-diffs-on-failure/going-to-differ-screenshot/accepted.png
+- spec/screens/iphone-retina/ios_7.1/screenshot-testing-under-bacon-raises-an-error-when-screens-are-different-sizes/different-sized-screenshot/accepted.png
 homepage: https://github.com/terriblelabs/motion-juxtapose
 licenses:
 - MIT
@@ -171,12 +174,12 @@ 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: []
@@ -187,6 +190,6 @@ specification_version: 4
 summary: Screenshot-based assertions for RubyMotion projects
 test_files:
 - spec/controllers/test_controller_spec.rb
-- spec/screens/iphone-retina/ios_7.0.3/screenshot-testing-under-bacon-passes-when-there-is-an-identical-accepted-screenshot/accepted-screenshot/accepted.png
-- spec/screens/iphone-retina/ios_7.0.3/screenshot-testing-under-bacon-raises-an-error-and-produces-diffs-on-failure/going-to-differ-screenshot/accepted.png
-- spec/screens/iphone-retina/ios_7.0.3/screenshot-testing-under-bacon-raises-an-error-when-screens-are-different-sizes/different-sized-screenshot/accepted.png
+- spec/screens/iphone-retina/ios_7.1/screenshot-testing-under-bacon-passes-when-there-is-an-identical-accepted-screenshot/accepted-screenshot/accepted.png
+- spec/screens/iphone-retina/ios_7.1/screenshot-testing-under-bacon-raises-an-error-and-produces-diffs-on-failure/going-to-differ-screenshot/accepted.png
+- spec/screens/iphone-retina/ios_7.1/screenshot-testing-under-bacon-raises-an-error-when-screens-are-different-sizes/different-sized-screenshot/accepted.png