compatriot 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d450836b0c2e68d09d5ca4e810c0e1e1d020bc4b
-  data.tar.gz: 8379ba8e3caa26f2d74d000a7086e112869abe86
+  metadata.gz: 52335a1370e7cf3da50555a02c667e6dc8389b33
+  data.tar.gz: da7bef0b5be93ebb60ddf4a4f7f22236190c2561
 SHA512:
-  metadata.gz: 7d637ff6d079e9bf66de3738fe7bf40ef9516c3cbd2504c272eed8400a656962c389e051e5fa073facf421e399bf18a301027eaf2e3fc0e89b396486b7f7dbba
-  data.tar.gz: e43b8be36412ac6d6de2e733bb0f6d6753ce1f0e21326060d986829911047f31e894c745a7f535fbfe3fe2846248d975f96ed1ce159e662273919b625f31c2e7
+  metadata.gz: b11a74741daac8e3e2589ea78a54a72c7e7045cb9cb47bae5f9050d029ffaf3d263f09e180572b7eacc4bf8303fdc6744de42931cc312b2e852fe43d51486445
+  data.tar.gz: 8476a55fda6ed11afc4be69a994254f67b37c5ca685389d06971159819fc01ff235157f7939fc91acf29736ac121149934065fa49448d8990ee44a9a6855921b

data/.gitignore

@@ -19,3 +19,4 @@ tmp
 spec/sample_app/chromedriver.log
 TAGS
 screenshots
+compatriot_report.html

data/README.md

@@ -47,6 +47,8 @@ How To Use
 
     class IntegrationTest
     include Compatriot::Assertions
+    
+    Minitest::Reporters.use! Compatriot::MinitestReportDriver.new # Optional: if you want html output. See MinitestReporters for more info
 
       Compatriot.configure do |config|
         screenshot_directory = 

data/compatriot.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.licenses      = "MIT"
 
   gem.add_development_dependency 'minitest', '~> 5.8', '>= 5.8.2'
+  gem.add_development_dependency 'minitest-reporters', '~> 1.1', '>= 1.1.8'
   gem.add_development_dependency 'sinatra', '~> 1.4', '>= 1.4.6'
   gem.add_development_dependency 'mocha', '~> 1.1', '>= 1.1.0'
   gem.add_development_dependency 'pry'
@@ -29,4 +30,5 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rake', '~> 10.4', '>= 10.4.2'
   gem.add_runtime_dependency 'chunky_png', '~> 1.3', '>= 1.3.5'
   gem.add_runtime_dependency 'oily_png', '~> 1.2.0'
+  gem.add_runtime_dependency 'haml', '~> 4.0.7'
 end

data/lib/compatriot.rb

@@ -4,6 +4,7 @@ require "compatriot/runner"
 require "compatriot/browser"
 require "compatriot/results_presenter"
 require "compatriot/image_differ/image_differ"
+require "compatriot/minitest_report_driver"
 
 module Compatriot
   class << self
@@ -34,7 +35,7 @@ module Compatriot
     def percentage_changed(test, description = '')
       variable_img_path = take_screenshot(test, description)
       control_img_path = filepath_for_screenshot('control', filename_for_test(test, description))
-      diff = Compatriot::ColorDiffer.diff(variable_img_path, control_img_path, self.screenshot_directory + '/')
+      diff = Compatriot::ColorDiffer.diff(variable_img_path, control_img_path)
       variable_image = ChunkyPNG::Image.from_file(variable_img_path)
       Compatriot::ColorDiffer.color_difference_percentage(variable_image, diff)
     end

data/lib/compatriot/assertions.rb

@@ -3,6 +3,11 @@ require 'compatriot'
 module Compatriot
   module Assertions
     def assert_no_ui_changes(title = '')
+      class << self
+        attr_accessor :compatriot_assertion_titles
+      end
+      self.compatriot_assertion_titles ||= []
+      self.compatriot_assertion_titles << title
       diff = Compatriot.percentage_changed(self, title)
       diff_file = Compatriot.filepath_for_screenshot('diffs', Compatriot.filename_for_test(self, title))
       puts "% diff is #{diff}. #{diff_file}" if Compatriot.show_diffs

data/lib/compatriot/image_differ/color_differ.rb

@@ -23,10 +23,9 @@ module Compatriot
       output.save(output_filename)
     end
 
-    def self.diff(filename1, filename2, results_directory)
+    def self.diff(filename1, filename2)
       image1 = ChunkyPNG::Image.from_file(filename1)
       image2 = ChunkyPNG::Image.from_file(filename2)
-      @results_directory = results_directory
 
       output = ChunkyPNG::Image.new(image1.width, image1.height, WHITE)
       diff = []
@@ -40,21 +39,15 @@ module Compatriot
         end
       end
 
-      save_diff_image(output, filename1, filename2)
+      save_diff_image(output, File.basename(filename1), File.basename(filename2))
 
       diff
     end
 
     def self.save_diff_image(output, filename1, filename2)
-      filename = diff_name(filename1, filename2)
-      path = File.join(
-        @results_directory,
-        "diffs",
-        filename
-      )
+      path = Compatriot.filepath_for_screenshot('diffs', filename1)
       create_directory_if_necessary(path)
       output.save(path)
-      File.join("diffs", filename)
     end
 
     def self.create_directory_if_necessary(file)
@@ -62,13 +55,6 @@ module Compatriot
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
     end
 
-    def self.diff_name(image1, image2)
-      browser1 = File.basename(File.dirname(image1))
-      browser2 = File.basename(File.dirname(image2))
-
-      "color_#{browser1}_vs_#{browser2}_#{File.basename(image1)}"
-    end
-
     def self.color_difference_of_pixels(pixel1, pixel2)
       score = Math.sqrt(
         (r(pixel2) - r(pixel1)) ** 2 +

data/lib/compatriot/image_differ/image_differ.rb

@@ -25,7 +25,7 @@ module Compatriot
     end
 
     def diff(results)
-      @strategy.diff(results.first, results.last, @results_directory)
+      @strategy.diff(results.first, results.last)
     end
 
     def diffs_path
@@ -38,4 +38,4 @@ module Compatriot
       FileUtils.mkdir_p(diffs_path)
     end
   end
-end
+end

data/lib/compatriot/minitest_report_driver.rb

@@ -0,0 +1,36 @@
+require 'minitest'
+require 'compatriot/reporter'
+
+module Compatriot
+  class MinitestReportDriver < Minitest::StatisticsReporter
+    attr_accessor :tests
+
+    def initialize(options={})
+      super($stdout, options)
+      self.tests = []
+    end
+
+    def before_test(test)
+    end
+
+    def after_test(test)
+    end
+
+    def before_suite(suite)
+    end
+
+    def after_suite(suite)
+    end
+
+    def record(test)
+      super
+      tests << test
+    end
+
+    def report
+      super
+      Compatriot::Reporter.new(tests).run
+    end
+
+  end
+end

data/lib/compatriot/report_template.html.haml

@@ -0,0 +1,45 @@
+%style
+  :plain
+    img {
+        width: 100%;
+        height: auto;
+    }
+    label.bold{
+        font-weight: bold;
+    }
+    label.collapse{
+      cursor: pointer;
+      display: block;
+      background: green;
+    }
+    label.collapse.failed{
+      background: red;
+    }
+    label.collapse + input{
+      display: none; /* hide the checkboxes */
+    }
+    label.collapse + input + div{
+      display:none;
+    }
+    label.collapse + input:checked + div{
+      display:block;
+    }
+
+%h1 Compatriot Test Report
+- $tests.each_with_index do |test,i|
+  - test.compatriot_assertion_titles.each_with_index do |title,j|
+    %label.collapse{ for: "_#{i}.#{j}", class: ("failed" unless test.passed?) }= test.location + ":" + title
+    %input{id: "_#{i}.#{j}", type: "checkbox"}
+    %div
+      %table
+        %tbody
+          %tr
+            %td
+              %label.bold Control
+              %img{src: Compatriot.filepath_for_screenshot('control', Compatriot.filename_for_test(test, title))}
+            %td
+              %label.bold Variable
+              %img{src: Compatriot.filepath_for_screenshot('variable', Compatriot.filename_for_test(test, title))}
+            %td
+              %label.bold Diff
+              %img{src: Compatriot.filepath_for_screenshot('diffs', Compatriot.filename_for_test(test, title))}

data/lib/compatriot/reporter.rb

@@ -0,0 +1,19 @@
+require 'haml'
+
+module Compatriot
+  class Reporter
+    attr_accessor :tests
+
+    def initialize(tests)
+      @tests = tests
+    end
+
+    def run
+      $tests = tests.sort_by {|t| (t.passed? ? 1 : 0) }
+      file_path = File.expand_path('../report_template.html.haml', __FILE__)
+      template = File.read(file_path)
+      engine = Haml::Engine.new(template)
+      File.write 'compatriot_report.html',engine.render
+    end
+  end
+end

data/lib/compatriot/version.rb

@@ -1,3 +1,3 @@
 module Compatriot
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
 
 require "minitest/autorun"
+require "minitest/reporters"
 require "mocha/mini_test"
 
 require 'compatriot'

data/spec/unit/compatriot_spec.rb

@@ -10,7 +10,7 @@ describe Compatriot do
   CONTROL_IMG          = "#{SCREENSHOTS_DIR}/control/#{CONTROL_IMG_FILENAME}"
   CONTROL_IMG2         = "#{SCREENSHOTS_DIR}/control/important_test_will_do_something_important_another.png"
   VARIABLE_IMG         = "#{SCREENSHOTS_DIR}/variable/important_test_will_do_something_important_and_has_a_description.png"
-  DIFF_IMG             = "#{SCREENSHOTS_DIR}/diffs/color_variable_vs_control_important_test_will_do_something_important_and_has_a_description.png"
+  DIFF_IMG             = "#{SCREENSHOTS_DIR}/diffs/important_test_will_do_something_important_and_has_a_description.png"
 
   def setup_control_image
     Page.new.save_screenshot CONTROL_IMG

data/spec/unit/image_differ/color_differ_spec.rb

@@ -9,7 +9,7 @@ describe Compatriot::ColorDiffer do
     ChunkyPNG::Image.expects(:from_file).with("file_two").returns(image2)
     Compatriot::ColorDiffer.stubs(:save_diff_image)
 
-    Compatriot::ColorDiffer.diff("file_one", "file_two", "some/dir")
+    Compatriot::ColorDiffer.diff("file_one", "file_two")
   end
 
   it "starts a new white image with the same dimensions" do
@@ -26,14 +26,6 @@ describe Compatriot::ColorDiffer do
     ChunkyPNG::Image.stubs(:from_file).returns(image1, image2)
     Compatriot::ColorDiffer.stubs(:save_diff_image)
 
-    differ = Compatriot::ColorDiffer.diff(image1, image2, "some/dir")
+    Compatriot::ColorDiffer.diff("/some/file/path.png", "/some/file/path.png")
   end
-
-  it "names the image based on the strategy and the browsers" do
-    name = Compatriot::ColorDiffer.diff_name(
-      "/something/firefox/1.png",
-      "/something/chrome/1.png"
-    )
-    name.must_equal("color_firefox_vs_chrome_1.png")
-  end
-end
+end

data/spec/unit/image_differ/image_differ_spec.rb

@@ -53,7 +53,6 @@ describe Compatriot::ImageDiffer do
       strategy.expects(:diff).with(
         file_one,
         file_two,
-        "something"
       ).returns("diff_filename.png")
 
       c = Compatriot::ImageDiffer.new(
@@ -64,4 +63,4 @@ describe Compatriot::ImageDiffer do
       c.diff([file_one, file_two]).must_equal("diff_filename.png")
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compatriot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Carol (Nichols || Goulding)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -31,6 +31,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.8.2
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.8
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +199,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.7
 description: Compare screenshots in your tests!
 email:
 - carol.nichols@gmail.com
@@ -204,6 +238,9 @@ files:
 - lib/compatriot/browser.rb
 - lib/compatriot/image_differ/color_differ.rb
 - lib/compatriot/image_differ/image_differ.rb
+- lib/compatriot/minitest_report_driver.rb
+- lib/compatriot/report_template.html.haml
+- lib/compatriot/reporter.rb
 - lib/compatriot/results_presenter.rb
 - lib/compatriot/runner.rb
 - lib/compatriot/version.rb