simulacrum 0.1.1 → 0.3.0

data/lib/simulacrum/matchers.rb

@@ -1,7 +1,9 @@
+# encoding: UTF-8
 require 'rspec'
 require_relative './comparator'
 
 module Simulacrum
+  # Custom RSpec matchers
   module Matchers
     extend RSpec::Matchers::DSL
 
@@ -16,37 +18,25 @@ module Simulacrum
         when false
           fail Simulacrum::Matchers.fail_message(component, comparator)
         when nil
-          pending Simulacrum::Matchers.pending_message(component)
+          skip Simulacrum::Matchers.pending_message(component)
         end
       end
     end
 
     def self.fail_message(component, comparator)
       <<-eos
-The pixel change percentage exceeded the maximum threshold of #{component.acceptable_delta}%.
-
-There was a #{comparator.diff.delta_percent}% pixel difference found between \
-the reference and the candidate.
+The pixel change percentage (#{comparator.diff.delta}%) exceeded the maximum \
+threshold of #{component.delta_threshold}%.
 
 Reference: #{component.reference_path}
 Candidate: #{component.candidate_path}
 Diff:      #{component.diff_path}
-
-Please review the diff and resolve manually.
       eos
     end
 
     def self.pending_message(component)
       <<-eos
-No reference image found! New candidate created:
-
-      #{component.candidate_path}
-
-      Please inspect this candidate image and if it looks OK then;
-
-        - mark it as a reference image by renaming it to 'reference.png'
-        - commit 'reference.png' file to your SCM of choice
-        - rerun this spec making sure it passes using the new reference image
+No reference image found! Candidate created: #{component.candidate_path}
       eos
     end
   end

data/lib/simulacrum/methods.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'ostruct'
 require_relative './component'
 

data/lib/simulacrum/renderer.rb

@@ -1,7 +1,10 @@
+# encoding: UTF-8
 require 'capybara'
 require 'tmpdir'
 
 module Simulacrum
+  # The Renderer Class is responsible for driving Capybara and setting up
+  # the desired page, screenshotting, croping, etc.
   class Renderer
     include Capybara::DSL
 
@@ -23,27 +26,39 @@ module Simulacrum
     end
 
     def get_bounds_for_selector(selector)
-      element = page.find(selector)
-      location = element.native.location
-      size = element.native.size
+      element = page.find(selector.to_s)
+      location = element_location(element)
+      size = element_size(element)
       [location.x, location.y, size.width, size.height]
     end
 
     private
 
+    def element_location(element)
+      element.native.location
+    end
+
+    def element_size(element)
+      element.native.size
+    end
+
     def resize_window!
-      begin
-        page.driver.browser.manage.window.resize_to(1024, 768)
-      rescue Selenium::WebDriver::Error::UnknownError => e
-      end
+      page.driver.browser.manage.window.resize_to(*window_size)
+    rescue Selenium::WebDriver::Error::UnknownError
+      return
     end
 
     def save_screenshot!
       page.driver.save_screenshot(tmp_path)
     end
 
+    def window_size
+      [1024, 768]
+    end
+
     def tmp_path
-      @tmp_path ||= File.join(@tmp_dir, Simulacrum.configuration.candidate_filename)
+      @tmp_path ||= File.join(@tmp_dir,
+                              Simulacrum.configuration.candidate_filename)
     end
   end
 end

data/lib/simulacrum/runner.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+require 'rspec'
+require 'simulacrum/driver'
+require 'simulacrum/methods'
+require 'simulacrum/matchers'
+
+module Simulacrum
+  # Base Runner class for running RSpec in parallel.
+  class Runner
+    attr_reader :exit_code
+
+    def initialize
+      configure_driver
+      configure_rspec
+    end
+
+    def run
+      @exit_code = run_rspec
+    end
+
+    private
+
+    def configure_driver
+      Simulacrum::Driver.use
+    end
+
+    def run_rspec
+      RSpec::Core::Runner.run(test_files)
+    end
+
+    def test_files
+      Simulacrum.runner_options.files
+    end
+
+    def configure_rspec
+      RSpec.configuration.include Simulacrum::Matchers
+      RSpec.configuration.extend Simulacrum::Methods
+      RSpec.configuration.color = Simulacrum.runner_options.color
+      RSpec.configuration.tty = true
+      RSpec.configuration.pattern = '**/*_spec.rb'
+      RSpec.configuration.profile_examples = false
+    end
+  end
+end

data/lib/simulacrum/version.rb

@@ -1,5 +1,6 @@
+# encoding: UTF-8
 # Package information
 module Simulacrum
   PACKAGE = 'simulacrum'
-  VERSION = '0.1.1'
+  VERSION = '0.3.0'
 end

data/rubocop-todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-12 23:22:51 +1000 using RuboCop version 0.20.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+ClassLength:
+  Max: 148
+
+# Offense count: 1
+# Cop supports --auto-correct.
+ColonMethodCall:
+  Enabled: false
+
+# Offense count: 1
+HandleExceptions:
+  Enabled: false
+
+# Offense count: 20
+LineLength:
+  Max: 202
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 22

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/sh -xe
+
+bundle --quiet --binstubs

data/script/quality

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh -xe
+
+function run_command {
+  $1 || exit 1
+}
+
+run_command "rake spec:quality"

data/script/spec

@@ -0,0 +1,10 @@
+#!/bin/sh -xe
+
+$(dirname $0)/bootstrap
+
+rm -rf coverage/
+rm -rf tmp/
+bin/rubocop --display-cop-names
+bin/rspec --require spec_helper
+bin/cucumber --require features/support/env.rb --strict features
+bin/rake quality

data/simulacrum.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'simulacrum/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = Simulacrum::PACKAGE
+  gem.version       = Simulacrum::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.authors       = ['Justin Morris']
+  gem.email         = ['desk@pixelbloom.com']
+  gem.homepage      = 'https://github.com/plasticine/simulacrum'
+  gem.licenses      = ['MIT']
+  gem.summary       =
+    %q{A gem for visually testing and inspecting user interface components.}
+  gem.description   = %q{
+    An opinionated UI component regression testing tool built to be tightly
+    integrated with RSpec, Selenium and tools you already use.
+  }
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = Dir['spec/**/*']
+  gem.require_paths = ['lib']
+  gem.has_rdoc      = false
+  gem.bindir        = 'exe'
+  gem.executables   = ['simulacrum']
+
+  gem.add_dependency 'capybara', ['~> 2.4.1']
+  gem.add_dependency 'rmagick', '~> 2.13.2'
+  gem.add_dependency 'rspec', ['>= 2.14.1']
+  gem.add_dependency 'selenium-webdriver', ['~> 2.42.0']
+
+  gem.add_development_dependency 'appraisal'
+  gem.add_development_dependency 'aruba'
+  gem.add_development_dependency 'cane'
+  gem.add_development_dependency 'codeclimate-test-reporter'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', ['~> 3.0.0']
+  gem.add_development_dependency 'rubocop', ['~> 0.20.1']
+  gem.add_development_dependency 'sauce', ['~> 3.4.8']
+  gem.add_development_dependency 'sauce-connect', ['~> 3.4.1']
+  gem.add_development_dependency 'sauce-cucumber', ['~> 3.4.0']
+  gem.add_development_dependency 'shoulda-matchers'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'sinatra'
+  gem.add_development_dependency 'dotenv'
+end

data/spec/lib/simulacrum/cli/parser_spec.rb

@@ -0,0 +1,113 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'stringio'
+require 'simulacrum/cli/parser'
+
+describe Simulacrum::CLI::Parser do
+  def run(args)
+    output = StringIO.new('')
+    result = Simulacrum::CLI::Parser.new(output).parse(args.split(/\s+/m))
+
+    parser = OpenStruct.new
+    parser.output = output.string
+    parser.result = result
+    parser
+  end
+
+  let(:option) { '' }
+  subject { run(option) }
+
+  describe 'invalid options' do
+    let(:option) { '--velociraptors' }
+
+    it 'handles invalid options by showing help' do
+      expect(subject.output).to include('Usage:')
+      expect(subject.result).to eq(false)
+    end
+  end
+
+  describe '--version' do
+    let(:option) { '--version' }
+
+    it { expect(subject.result).to eq(true) }
+    it { expect(subject.output).to include(Simulacrum::VERSION) }
+  end
+
+  describe '--color' do
+    it { expect(subject.result.color).to eq(false) }
+
+    context 'when the option is set' do
+      let(:option) { '--color' }
+
+      it { expect(subject.result.color).to eq(true) }
+    end
+  end
+
+  describe '--verbose' do
+    it { expect(subject.result.verbose).to eq(false) }
+
+    context 'when the option is set' do
+      let(:option) { '--verbose' }
+
+      it { expect(subject.result.verbose).to eq(true) }
+    end
+  end
+
+  describe '--runner' do
+    it { expect(subject.result.runner).to be_nil }
+
+    context 'when the option is set' do
+      let(:option) { '--runner browserstack' }
+
+      it { expect(subject.result.runner).to eq(:browserstack) }
+    end
+
+    context 'when the option is set to an invalid value' do
+      let(:option) { '--runner dropbear' }
+
+      it 'throws an InvalidArgument exception' do
+        expect { subject.result.runner }.to raise_error(OptionParser::InvalidArgument)
+      end
+    end
+  end
+
+  describe '--username' do
+    it { expect(subject.result.username).to be_nil }
+
+    context 'when the option is set' do
+      let(:option) { '--username justin' }
+
+      it { expect(subject.result.username).to eq('justin') }
+    end
+  end
+
+  describe '--apikey' do
+    it { expect(subject.result.apikey).to be_nil }
+
+    context 'when the option is set' do
+      let(:option) { '--apikey 1234abcd' }
+
+      it { expect(subject.result.apikey).to eq('1234abcd') }
+    end
+  end
+
+  describe '--max-processes' do
+    it { expect(subject.result.max_processes).to be_nil }
+
+    context 'when the option is set' do
+      let(:option) { '--max-processes 5' }
+
+      it { expect(subject.result.max_processes).to eq(5) }
+    end
+  end
+
+  describe '--browser' do
+    it { expect(subject.result.browser).to be_nil }
+
+    context 'when the option is set' do
+      let(:option) { '--browser firefox' }
+
+      it { expect(subject.result.browser).to eq(:firefox) }
+    end
+  end
+end

data/spec/lib/simulacrum/cli_spec.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'simulacrum/cli'
+
+describe Simulacrum::CLI do
+  describe '.execute!' do
+    let(:parser)     { stub_const('Simulacrum::CLI::Parser', double) }
+    let(:simulacrum) { stub_const('Simulacrum', double) }
+    let(:exit_code)  { 0 }
+
+    it 'runs simulacrum with the given args' do
+      expect(parser).to receive(:parse).with('--args').and_return(args: true)
+      expect(simulacrum).to receive(:run).with(args: true).and_return(exit_code)
+
+      expect(-> { described_class.execute!('--args') }).to raise_error SystemExit
+    end
+  end
+end

data/spec/lib/simulacrum/comparator_spec.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'ostruct'
+require 'simulacrum/comparator'
+
+describe Simulacrum::Comparator do
+  let(:reference_path) { '/reference_path' }
+  let(:candidate_path) { '/candidate_path' }
+  let(:diff_path) { '/diff_path' }
+  let(:delta_threshold) { 0 }
+  let(:component) do
+    double(reference_path: reference_path,
+           candidate_path: candidate_path,
+           diff_path: diff_path,
+           delta_threshold: delta_threshold)
+  end
+
+  describe '#initialize' do
+    subject { described_class.new(component) }
+
+    before do
+      expect(component).to receive(:render)
+    end
+  end
+
+  describe '#test' do
+    subject { described_class.new(component).test }
+
+    before do
+      expect(component).to receive(:render)
+      expect(component).to receive(:reference?) { reference }
+    end
+
+    describe 'a reference already exists' do
+      let(:reference) { true }
+
+      before do
+        expect(Simulacrum::RMagicDiff).to receive(:new).with(reference_path, candidate_path) { diff }
+      end
+
+      context 'there is a difference between the candidate and the reference' do
+        let(:diff) { double(delta: 1) }
+
+        before do
+          expect(diff).to receive(:save).with(diff_path)
+        end
+
+        it { is_expected.to eq false }
+      end
+
+      context 'the reference and the candidate are identical' do
+        let(:diff) { double(delta: 0) }
+
+        before do
+          expect(component).to receive(:remove_candidate)
+          expect(component).to receive(:remove_diff)
+        end
+
+        it { is_expected.to eq true }
+      end
+
+      describe 'component delta threshold' do
+        it 'should use the component delta threshold to perform to determine if the test passes' do
+          pending
+        end
+      end
+    end
+
+    describe 'there is no reference' do
+      let(:reference) { false }
+
+      it { is_expected.to be_nil }
+    end
+  end
+end