looks_good 1.0.0

data/spec/configuration_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+
+describe LooksGood::Configuration do
+
+
+  describe "#reference_image_path" do
+
+    after :each do
+      config_clean_up
+    end
+
+    describe "without Rails" do
+      it "should default to './spec/reference_images' when not in a rails environment" do
+        LooksGood::Configuration.reference_image_path.should eql("spec/reference_images")
+      end
+    end
+
+    describe "with rails" do
+
+      before do
+        begin
+          # Check that rails exists, otherwise fake it for the test
+          Module.const_get("Rails")
+        rescue NameError
+          module Rails
+            def self.root
+              "fake_rails_root"
+            end
+          end
+        end
+      end
+
+      it "should default to <Rails.root>/spec/reference_images in a rails environment" do
+        subject.reference_image_path.should  == "fake_rails_root/spec/reference_images"
+      end
+
+      it "should be overrideable in a rails environment" do
+        subject.reference_image_path = "my custom path"
+        subject.reference_image_path.should == "my custom path"
+      end
+
+      it 'should return the directory for a type of image' do
+        subject.reference_image_path = "a_path"
+        subject.path(:temp).should == 'a_path/temp'
+      end
+
+    end
+
+    describe "creating custom reference folders" do
+
+      before :each do
+        subject.reference_image_path = '/some/ref/path'
+      end
+
+      it "should default to custom folders off" do
+        subject.browser_folders.should == false
+      end
+
+      it "should allow setting custom folders on" do
+        subject.browser_folders = true
+        subject.browser_folders.should == true
+      end
+
+
+      it "should set reference_image_path to default when browser can\'t be found" do
+        subject.browser_folders = true
+        Capybara.page.driver.browser.should_receive(:browser).at_least(:once).and_raise(StandardError.new)
+        subject.reference_image_path.should == '/some/ref/path'
+      end
+
+      it "should create custom folder for each browser according to ENV" do
+        pending
+      end
+
+      it "should set the image reference path for each browser according to selenium driver if no ENV is set" do
+        subject.browser_folders = true
+        subject.stub!(:browser).and_return('chrome')
+        subject.reference_image_path.should == '/some/ref/path/chrome'
+        subject.browser_folders = false
+      end
+
+
+    end
+  end
+
+  describe "#max_no_tries" do
+
+      it "should default to 5" do
+        subject.max_no_tries.should == 5
+      end
+
+      it "should be settable" do
+        LooksGood::Configuration.max_no_tries = 1
+        subject.max_no_tries.should == 1
+      end
+  end
+
+  describe "#sleep_between_tries" do
+
+    it "should default to 0.5" do
+      subject.sleep_between_tries.should == 0.5
+    end
+
+    it "should be settable" do
+      subject.sleep_between_tries = 55
+      subject.sleep_between_tries.should == 55
+    end
+  end
+
+  describe "settings" do
+
+    describe "should accept a block of settings and parse them correctly" do
+
+      it "for reference_image_path" do
+        LooksGood.config do |c|
+          c.reference_image_path = 'custom_path'
+        end
+        subject.reference_image_path.should == 'custom_path'
+      end
+
+      it "for max_no_tries" do
+        LooksGood.config do |c|
+          c.max_no_tries = 3
+        end
+
+        subject.max_no_tries.should == 3
+      end
+
+      it "sleep_between_tries" do
+        LooksGood.config do |c|
+          c.sleep_between_tries = 0.7
+        end
+        subject.sleep_between_tries.should == 0.7
+      end
+
+     it "for browser_folders" do
+        LooksGood.config do |c|
+          c.browser_folders = true
+        end
+
+        subject.browser_folders.should == true
+      end
+
+    end
+  end
+
+  describe "config block" do
+
+    it 'should be able to set a config block' do
+      LooksGood.config do |c|
+        c.reference_image_path = 'some/path'
+        c.max_no_tries = 4
+        c.sleep_between_tries = 5
+        c.browser_folders = false
+      end
+
+      subject.reference_image_path.should == 'some/path'
+      subject.max_no_tries.should == 4
+      subject.sleep_between_tries.should == 5
+      subject.browser_folders.should == false
+    end 
+
+    it 'should raise depreciation alert when calling old block' do
+      expect {
+        LooksGood.config do |c|
+          LooksGood.reference_image_path = 'some/path'
+          LooksGood.max_no_tries = 4
+          LooksGood.sleep_between_tries = 5
+          LooksGood.browser_folders = false
+      end
+      }.to raise_error "Config block has changed. Example: LooksGood.config {|c| c.reference_image_path = 'some/path'}. Please see README"
+    end
+
+   
+  end
+
+
+
+
+end

data/spec/gatling_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+include Capybara::DSL
+
+describe LooksGood do
+
+  after :all do
+    config_clean_up
+  end
+
+  let(:actual_image)      { mock("LooksGood::Image") }
+  let(:expected_image)    { mock("LooksGood::Image") }
+  let(:comparison)        { mock("LooksGood::Comparison") }
+  let(:element)           { mock("LooksGood::CaptureElement") }
+
+  
+  describe 'comparison' do
+    before :each do
+      LooksGood::ImageFromFile.stub!(:new).and_return(expected_image)
+      LooksGood::ImageFromElement.stub!(:new).and_return(actual_image)
+      LooksGood::Comparison.stub!(:new).and_return(comparison)
+      expected_image.should_receive(:file_name).and_return('expected_image.png')
+    end
+
+    it 'will return true if the images are identical' do
+        comparison.stub!(:matches?).and_return(true)
+        File.stub!(:exists?).and_return(true)
+
+        subject.matches?("expected_image.png", @element).should be_true
+    end
+  end  
+
+
+  describe 'saving images' do
+    before :each do
+      @image_class_mock = mock(LooksGood::Image)
+    end
+
+
+    it "#save_image_as_diff" do
+      @image_class_mock.should_receive(:save).with(:diff).and_return(@ref_path)
+      @image_class_mock.should_receive(:file_name).at_least(:once).and_return("some_name")
+
+      expect {subject.save_image_as_diff(@image_class_mock)}.to raise_error
+    end
+
+    it "#save_image_as_candidate" do
+      @image_class_mock.should_receive(:save).with(:candidate).and_return(@ref_path)
+      @image_class_mock.should_receive(:file_name).at_least(:once).and_return("some_name")
+      @image_class_mock.should_receive(:path).and_return(@path)
+      expect {subject.save_image_as_candidate(@image_class_mock)}.to raise_error
+    end
+
+    describe "#save_image_as_reference" do
+
+      let(:image) {mock('image.png')}
+      let(:reference_image) {LooksGood::ImageFromElement.stub(:new).and_return(image)}
+      let(:comparison) {mock("comparison")}
+
+      before :each do
+        LooksGood.stub!(:compare_until_match).and_return(comparison)
+      end
+
+    end
+  end  
+
+  describe "#compare_until_match" do
+
+    before :each do
+      LooksGood::ImageFromElement.stub!(:new).and_return(actual_image)
+      LooksGood::ImageFromFile.stub!(:new).and_return(expected_image)
+      LooksGood::Comparison.stub!(:new).and_return(comparison)
+
+      expected_image.should_receive(:file_name).at_least(:once).and_return('expected_image.png')
+    end
+
+    it "should try match for a specified amount of times" do
+      comparison.should_receive(:matches?).exactly(3).times.and_return(false)
+      LooksGood.compare_until_match(@element, expected_image, 3, 0.1)
+    end
+
+    it "should pass after a few tries if match is found" do
+      comparison.should_receive(:matches?).exactly(1).times.and_return(true)
+      LooksGood.compare_until_match(@element, expected_image, 3, 0.1)
+    end
+
+  end
+end

data/spec/image_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe LooksGood::Image do
+
+  let(:example_image)           { Magick::Image.new(1,1) }
+  let(:ref_path)                { 'spec/reference_images/image.png' }
+
+  before :each do
+    LooksGood::Configuration.reference_image_path = 'spec/reference_images'
+  end
+
+  after :each do
+    config_clean_up
+  end
+
+  describe 'should initialize from' do
+    it 'ImageFromFile - IO file read' do
+      File.stub(:exists?).and_return(true)
+      Magick::Image.should_receive(:read).with(ref_path).and_return([example_image])
+      
+      subject = LooksGood::ImageFromFile.new("image.png")
+      subject.image.should == example_image
+      subject.file_name.should == 'image.png'
+    end
+
+    
+  end
+
+  describe "save" do
+    it 'will save an image' do
+      example_image.should_receive(:write).with(ref_path).and_return()
+
+      File.should_receive(:exists?).with(ref_path).and_return(true)
+      FileUtils.should_not_receive(:mkdir_p)
+      subject = LooksGood::Image.new(example_image, "image.png")
+
+      subject.save
+      subject.path.should == ref_path
+    end
+  end
+
+  describe "it creates a path from path types" do
+
+    before :each do
+      LooksGood::Configuration.should_receive(:reference_image_path).any_number_of_times.and_return('/some/path')
+      mock_image = mock(Magick::Image)
+      @subject = LooksGood::Image.new(mock_image, 'image.png')
+    end
+
+    it "from reference" do
+      # expected_path = '/some/path/reference'
+      @subject.path.should == '/some/path/image.png'
+    end
+
+    it "from diff" do
+      @subject.path(:diff).should == '/some/path/diff/image.png'
+    end
+
+    it "from candidate" do
+      @subject.path(:candidate).should == '/some/path/candidate/image.png'
+    end
+
+  end
+
+  describe "ImageFromElement" do
+
+    let(:mock_element) { mock(Capybara::Node::Element) }
+    let(:comparison)   { mock('comparison') }
+
+    it 'should initialize from a web element' do
+      LooksGood::CaptureElement.should_receive(:capture).with(mock_element).and_return(example_image)
+
+      subject = LooksGood::ImageFromElement.new(mock_element, "image.png")
+      subject.image.class.should == example_image.class
+      subject.file_name.should == 'image.png'
+    end
+
+    describe '.save_and_verify' do
+
+      it 'should verify the element and then save' do
+        LooksGood::Comparison.should_receive(:new).exactly(2).times.and_return(comparison)
+        comparison.should_receive(:matches?).exactly(2).times.and_return(false,true)
+
+        LooksGood::CaptureElement.should_receive(:capture).exactly(3).times.with(mock_element).and_return(example_image)
+
+        subject = LooksGood::ImageFromElement.new(mock_element, "image.png")
+        subject.should_receive(:save)
+
+        LooksGood::Configuration.max_no_tries = 3
+
+        subject.verify_and_save
+      end
+      
+      it 'should raise an exception if can\'t create a stable image' do
+        LooksGood::Configuration.max_no_tries = 1
+        LooksGood::CaptureElement.stub!(:capture).and_return(mock_element)
+        LooksGood::Comparison.stub!(:matches?).and_return(false)
+
+        subject = LooksGood::ImageFromElement.new(mock_element, "image.png")
+
+        expect {subject.verify_and_save}.to raise_error
+      end 
+    end
+
+
+  end
+
+end

data/spec/integration/gatling_integration_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+include Capybara::DSL
+
+describe 'LooksGood' do
+
+  before(:all) do
+    @spec_support_root = spec_support_root
+    @black_box = 'black.png'
+    @red_box = 'red.png'
+  end
+
+  before(:each) do
+    @ref_path = LooksGood::Configuration.reference_image_path = File.join(spec_support_root, 'ref_path')
+  end
+
+  after(:each) do
+    remove_refs(@ref_path)
+  end
+
+  describe 'LooksGood, when no reference image exists' do
+
+    it "will notify that no reference image exists and create a candidate image" do
+      pending
+      mock_element = mock
+      mock_element.stub(:native).and_return(mock_element)
+
+      expected_error = "The design reference #{@black_box} does not exist, #{@ref_path}/candidate/#{@black_box} " +
+                       "is now available to be used as a reference. " +
+                       "Copy candidate to root reference_image_path to use as reference"
+
+      expect {LooksGood.matches?(@black_box, mock_element)}.to raise_error(RuntimeError, expected_error)
+
+      File.exists?(File.join(@ref_path, 'candidate', @black_box)).should be_true
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--require rubygems
+--require rspec/instafail

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'capybara'
+require 'capybara/dsl'
+require 'capybara/rspec'
+require 'looks_good'
+require 'looks_good/matchers/look_like_matcher'
+require 'fileutils'
+require 'pry'
+
+#todo: spec folders clean up method
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+Capybara.app_host = "file://#{File.expand_path(File.dirname(__FILE__))}/support/assets"
+Capybara.default_driver = :selenium
+Capybara.run_server = false
+
+def config_clean_up
+  LooksGood::Configuration.reference_image_path = nil
+  LooksGood::Configuration.browser_folders = false
+  LooksGood::Configuration.max_no_tries = nil
+end
+
+def remove_refs(dir)
+  Dir.glob("#{dir}/**/*.png").each {|image| FileUtils.rm image}
+end
+
+def element_for_spec(css = '#black')
+  visit('/fruit_app.html')
+  @element = page.find(:css, css)
+end
+
+def spec_support_root
+  File.join(File.dirname(__FILE__), 'support')
+end
+
+def create_images_for_web_page
+  asset_reference_path = File.join(spec_support_root, 'assets')
+  create_square_image(asset_reference_path, 'black')
+  create_square_image(asset_reference_path, 'red')
+end
+
+def create_square_image(path, color)
+  # We make the images, rather then check them in because otherwise the comparison tests
+  # become very flakey depending on the graphics set up on the computer running them
+  FileUtils::mkdir_p(path)
+
+  reference_file = Magick::Image.new(100,100) { self.background_color = 'white' }
+  square = Magick::Draw.new
+  square.fill_opacity(100)
+  square.fill_color(color)
+  square.rectangle(10,10, 90,90)
+  square.draw(reference_file)
+
+  reference_file.write(File.join(path, "#{color}.png"))
+  reference_file
+end

data/spec/support/assets/fruit_app.html

@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+        "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+	<style type="text/css">
+	div.ex
+	{
+	width:220px;
+	padding:10px;
+	border:5px solid gray;
+	margin:0px;
+	}
+	</style>
+    <title>The Smiley Site</title>
+</head>
+<body>
+	<div class='ex' id="box">
+    <img src='./black.png' id="black"/>
+    <img src='./red.png' id="red"/>
+	</div>
+    <img src='./black.png' id="different-size" width="15px" height="180px"/>
+</body>
+</html>

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: looks_good
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Russell Jennings
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.53.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.53.0
+description: Rspec visual testing with percent matching tolerance
+email:
+- violentpurr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/looks_good.rb
+- lib/looks_good/capture_element.rb
+- lib/looks_good/comparison.rb
+- lib/looks_good/configuration.rb
+- lib/looks_good/image.rb
+- lib/looks_good/matchers/look_like_matcher.rb
+- lib/looks_good/rspec_config.rb
+- lib/looks_good/version.rb
+- looks_good.gemspec
+- reports/rspec_unit_test_output.html
+- spec/acceptance/gatling_acceptance_spec.rb
+- spec/acceptance/rspec_matcher_spec.rb
+- spec/capture_spec.rb
+- spec/comparison_spec.rb
+- spec/configuration_spec.rb
+- spec/gatling_spec.rb
+- spec/image_spec.rb
+- spec/integration/gatling_integration_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/assets/fruit_app.html
+- temp-1032.rdb
+homepage: http://github.com/meesterdude/looks_good
+licenses: []
+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: []
+rubygems_version: 3.3.19
+signing_key: 
+specification_version: 4
+summary: Rspec visual testing
+test_files:
+- spec/acceptance/gatling_acceptance_spec.rb
+- spec/acceptance/rspec_matcher_spec.rb
+- spec/capture_spec.rb
+- spec/comparison_spec.rb
+- spec/configuration_spec.rb
+- spec/gatling_spec.rb
+- spec/image_spec.rb
+- spec/integration/gatling_integration_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/assets/fruit_app.html