compatriot 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03a6a30cd248410ffde17ee0a7b100d6c11dff32
-  data.tar.gz: e2e408ce4c75e59a63ab44d753ac66ab67e896f9
+  metadata.gz: 75b88eb52e8a954c774264cd033b8a9c65b62de0
+  data.tar.gz: 960e215f8c4cdba3a3f83a4e6b5cba92aab7b609
 SHA512:
-  metadata.gz: 3d95580e8525e8149df37e6060fe84444d5f29e90eaf88974c546dede2c81b3896343e63b3c25e78c51cf19a52944e31f37accaf60a11b6b0f1e62764feafaa6
-  data.tar.gz: d5f798d603913260cbe8f235d7b795903598b3e8bca3eb20c14e92ec20c744debc80c5ec4913a5a1a76f096e11abe32ad2c55a0aec8b1dfa5ba3d88c0584e3f4
+  metadata.gz: 8a0fd9c05af9f7501304a813c47bd5e11ec4fcad796e83ee2ccd561bd4cf51ea17e13604baea659f2cf4367d00373dce599b75ee2dae4d53d83f5f3acd385ded
+  data.tar.gz: a33bd9cac462ebbea97adf7a09b8d4eecd6d0d642ea9ba5d73244755916f15d2990ff3b98d41de0bbcc335527a32c9db4e699d6f54c43ee4dfadecb2ff78d2c2

data/lib/compatriot/assertions.rb

@@ -5,10 +5,13 @@ module Compatriot
     def assert_no_ui_changes(title = '')
       class << self
         attr_accessor :compatriot_assertion_titles
+        attr_accessor :compatriot_percentages_changed
       end
       self.compatriot_assertion_titles ||= []
       self.compatriot_assertion_titles << title
+      self.compatriot_percentages_changed ||= []
       diff = Compatriot.percentage_changed(self, title)
+      self.compatriot_percentages_changed << diff
       diff_file = Compatriot.filepath_for_screenshot('diffs', Compatriot.filename_for_test(self, title))
       puts "% diff is #{diff}. #{diff_file}" if Compatriot.show_diffs
       pass = diff <= Compatriot.ui_difference_threshold

data/lib/compatriot/report_template.html.haml

@@ -27,20 +27,18 @@
 
 %h1 Compatriot Test Report
 - $tests.each_with_index do |test,i|
-  - if test.respond_to? :compatriot_assertion_titles
-    - 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))}
+  %label.collapse{ for: "_#{i}", class: test[:status] }= test[:label]
+  %input{id: "_#{i}", type: "checkbox"}
+  %div
+    %table
+      %tbody
+        %tr
+          %td
+            %label.bold Control
+            %img{src: test[:control_image_path]}
+          %td
+            %label.bold Variable
+            %img{src: test[:variable_image_path]}
+          %td
+            %label.bold Diff
+            %img{src: test[:diff_image_path]}

data/lib/compatriot/reporter.rb

@@ -9,11 +9,30 @@ module Compatriot
     end
 
     def run
-      $tests = tests.sort_by {|t| (t.passed? ? 1 : 0) }
+      $tests = format(tests)
       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
+
+    def format(tests)
+      formated_tests = []
+      tests.each do |test|
+        next unless test.respond_to? :compatriot_assertion_titles
+        test.compatriot_assertion_titles.each_with_index do |title,j|
+          formated_test = {
+            label: test.location + ':' + title + ':' + test.compatriot_percentages_changed[j].to_s + "% difference",
+            percentage_changed: test.compatriot_percentages_changed[j],
+            status: test.passed? ? "passed" : "failed",
+            control_image_path: Compatriot.filepath_for_screenshot('control', Compatriot.filename_for_test(test, title)),
+            variable_image_path: Compatriot.filepath_for_screenshot('variable', Compatriot.filename_for_test(test, title)),
+            diff_image_path: Compatriot.filepath_for_screenshot('diffs', Compatriot.filename_for_test(test, title)),
+          }
+          formated_tests << formated_test
+        end
+      end
+      formated_tests.sort_by { |k| k[:percentage_changed] }.reverse
+    end
   end
 end

data/lib/compatriot/version.rb

@@ -1,3 +1,3 @@
 module Compatriot
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/spec_helper.rb

@@ -8,6 +8,8 @@ require 'compatriot'
 
 require_relative "sample_app/sample_app"
 
+SCREENSHOTS_DIR      = './tmp/test/screenshots'
+
 # A custom runner to enable before_suite and after_suite setup/teardown.
 # http://bfts.rubyforge.org/minitest/index.html
 # Only using it to delete the screenshots that result from running the tests
@@ -21,11 +23,6 @@ module TestRunner
   end
 end
 
-class Minitest::Spec
-  include TestRunner
-  include Compatriot::Assertions
-end
-
 module FakeCapybara
   def self.current_session
     Page.new
@@ -43,3 +40,12 @@ class Page
     filepath
   end
 end
+
+class Minitest::Spec
+  include TestRunner
+  include Compatriot::Assertions
+  Compatriot.configure do |config|
+    config.screenshot_directory = SCREENSHOTS_DIR
+    config.framework = FakeCapybara
+  end
+end

data/spec/unit/assertions_spec.rb

@@ -3,7 +3,6 @@ require_relative '../spec_helper'
 describe Compatriot::Assertions do
   let(:page) { Page.new }
 
-  SCREENSHOTS_DIR      = './tmp/test/screenshots'
   CONTROL_IMG_FILENAME = 'important_test_will_do_something_important_and_has_a_description.png'
   CONTROL_IMG          = "#{SCREENSHOTS_DIR}/control/#{CONTROL_IMG_FILENAME}"
   CONTROL_IMG2         = "#{SCREENSHOTS_DIR}/control/important_test_will_do_something_important_another.png"
@@ -16,10 +15,6 @@ describe Compatriot::Assertions do
 
   before do
     FileUtils.remove_dir(SCREENSHOTS_DIR) if File.directory?(SCREENSHOTS_DIR)
-    Compatriot.configure do |config| 
-      config.screenshot_directory = SCREENSHOTS_DIR
-      config.framework = FakeCapybara
-    end
   end
 
   it 'can assert on assert_no_ui_changes' do

data/spec/unit/compatriot_spec.rb

@@ -5,7 +5,6 @@ describe Compatriot do
   let(:stubbed_test) { stub_everything('test', name: 'test_001_will do something important', class: class_stub) }
   let(:page)         { Page.new }
 
-  SCREENSHOTS_DIR      = './tmp/test/screenshots'
   CONTROL_IMG_FILENAME = 'important_test_will_do_something_important_and_has_a_description.png'
   CONTROL_IMG          = "#{SCREENSHOTS_DIR}/control/#{CONTROL_IMG_FILENAME}"
   CONTROL_IMG2         = "#{SCREENSHOTS_DIR}/control/important_test_will_do_something_important_another.png"
@@ -63,12 +62,8 @@ describe Compatriot do
 
   describe 'configuration' do
     before do
-      @screenshot_directory = 'tmp/test_configuration'
-      @control_file = @screenshot_directory + '/control/' + CONTROL_IMG_FILENAME
-      Compatriot.configure do |config|
-        config.screenshot_directory = @screenshot_directory
-      end
-      FileUtils.remove_dir(@screenshot_directory) if File.directory?(SCREENSHOTS_DIR)
+      @control_file = SCREENSHOTS_DIR + '/control/' + CONTROL_IMG_FILENAME
+      FileUtils.remove_dir(SCREENSHOTS_DIR) if File.directory?(SCREENSHOTS_DIR)
     end
 
     it 'can set the screenshot directory' do

data/spec/unit/report_spec.rb

@@ -1,52 +1,103 @@
 require_relative '../spec_helper'
 
 describe Compatriot::Reporter do
-  REPORT_FILENAME = 'compatriot_report.html'
-  before do
-    FileUtils.rm(REPORT_FILENAME) if File.exists?(REPORT_FILENAME)
-  end
+  describe 'tests format' do
 
-  it 'generates an html file' do
-    test1 = stub_everything('test',
-                            name: 'test_1_viewing_a_specific_report',
-                            location: 'Some description',
-                            compatriot_assertion_titles: [ 'did stuff' ],
-                            passed?: true)
-    test2 = stub_everything('test',
-                            name: 'test_2_viewing_a_specific_report_with_a_filter',
-                            location: 'Another description',
-                            compatriot_assertion_titles: [ 'did other stuff' ],
-                            passed?: false)
-    tests = [
-      test1, test2
-    ]
-    Compatriot::Reporter.new(tests).run
-
-    assert File.exist?(REPORT_FILENAME), "#{REPORT_FILENAME} not found"
-    File.readlines(REPORT_FILENAME).grep(/label class='collapse/).count.must_equal 2
-  end
+    it 'sorts the tests by percentage changed' do
+      test1 = stub_everything('test',
+                              name: 'test_1_viewing_a_specific_report',
+                              location: 'Some description',
+                              compatriot_assertion_titles: [ 'did stuff','moar' ],
+                              compatriot_percentages_changed: [ 0.02 , 0.04 ],
+                              passed?: true)
+      test2 = stub_everything('test',
+                              name: 'test_2_viewing_a_specific_report_with_a_filter',
+                              location: 'Another description',
+                              compatriot_assertion_titles: [ 'did other stuff', 'moar other stuff' ],
+                              compatriot_percentages_changed: [ 0.03, 0.8 ],
+                              passed?: false)
+      tests = [test1, test2]
+      formated_tests = Compatriot::Reporter.new(tests).format(tests)
+      formated_tests.map { |t| t[:percentage_changed] }.must_equal [ 0.8, 0.04, 0.03, 0.02 ]
+    end
 
-  it 'generates a report even if there were not any assertions made' do
-    tests = [stub_everything('test',
-                            name: 'test_1_viewing_a_specific_report',
-                            location: 'Some description',
-                            compatriot_assertion_titles: [ ],
-                            passed?: true)
-            ]
-    Compatriot::Reporter.new(tests).run
-    assert File.exist?(REPORT_FILENAME), "#{REPORT_FILENAME} not found"
-    File.readlines(REPORT_FILENAME).grep(/label class='collapse/).count.must_equal 0
+    it 'labels the tests names' do
+      tests = [stub_everything('test',
+                               name: 'test_1_viewing_a_specific_report',
+                               location: 'Some description',
+                               compatriot_assertion_titles: [ 'did stuff','moar' ],
+                               compatriot_percentages_changed: [ 0.02 , 0.04 ],
+                               passed?: true)]
+      formated_tests = Compatriot::Reporter.new(tests).format(tests)
+      labels = formated_tests.map { |t| t[:label] }
+      labels.must_equal ["Some description:moar:0.04% difference","Some description:did stuff:0.02% difference"]
+    end
+
+    it 'image paths are relative' do
+      tests = [stub_everything('test',
+                               name: 'test_1_viewing_a_specific_report',
+                               location: 'Some description',
+                               compatriot_assertion_titles: [ 'did stuff' ],
+                               compatriot_percentages_changed: [ 0.02 ],
+                               passed?: true)]
+      formated_test = Compatriot::Reporter.new(tests).format(tests)[0]
+      formated_test[:control_image_path].must_equal "./tmp/test/screenshots/control/mocha::mock_viewing_a_specific_report_did_stuff.png"
+      formated_test[:variable_image_path].must_equal "./tmp/test/screenshots/variable/mocha::mock_viewing_a_specific_report_did_stuff.png"
+      formated_test[:diff_image_path].must_equal "./tmp/test/screenshots/diffs/mocha::mock_viewing_a_specific_report_did_stuff.png"
+    end
   end
 
-  it 'handles multiple assertions in one test' do
-    tests = [stub_everything('test',
-                             name: 'test_1_viewing_a_specific_report',
-                             location: 'Some description',
-                             compatriot_assertion_titles: [ 'first assertion', 'second assertion' ],
-                             passed?: true)
-            ]
-    Compatriot::Reporter.new(tests).run
-    assert File.exist?(REPORT_FILENAME), "#{REPORT_FILENAME} not found"
-    File.readlines(REPORT_FILENAME).grep(/label class='collapse/).count.must_equal 2
+  describe 'html file' do
+    REPORT_FILENAME = 'compatriot_report.html'
+    before do
+      FileUtils.rm(REPORT_FILENAME) if File.exists?(REPORT_FILENAME)
+    end
+
+    it 'generates an html file' do
+      test1 = stub_everything('test',
+                              name: 'test_1_viewing_a_specific_report',
+                              location: 'Some description',
+                              compatriot_assertion_titles: [ 'did stuff' ],
+                              compatriot_percentages_changed: [ 0.02 ],
+                              passed?: true)
+      test2 = stub_everything('test',
+                              name: 'test_2_viewing_a_specific_report_with_a_filter',
+                              location: 'Another description',
+                              compatriot_assertion_titles: [ 'did other stuff' ],
+                              compatriot_percentages_changed: [ 0.8 ],
+                              passed?: false)
+      tests = [test1, test2]
+      Compatriot::Reporter.new(tests).run
+
+      assert File.exist?(REPORT_FILENAME), "#{REPORT_FILENAME} not found"
+      File.readlines(REPORT_FILENAME).grep(/label class='collapse/).count.must_equal 2
+    end
+
+    it 'generates a report even if there were not any assertions made' do
+      tests = [stub_everything('test',
+                               name: 'test_1_viewing_a_specific_report',
+                               location: 'Some description',
+                               compatriot_assertion_titles: [ ],
+                               compatriot_percentages_changed: [ 0.02 ],
+                               passed?: true)
+              ]
+      Compatriot::Reporter.new(tests).run
+      assert File.exist?(REPORT_FILENAME), "#{REPORT_FILENAME} not found"
+      File.readlines(REPORT_FILENAME).grep(/label class='collapse/).count.must_equal 0
+    end
+
+    it 'handles multiple assertions in one test' do
+      tests = [stub_everything('test',
+                               name: 'test_1_viewing_a_specific_report',
+                               location: 'Some description',
+                               compatriot_assertion_titles: [ 'first assertion', 'second assertion' ],
+                               compatriot_percentages_changed: [ 0.02 , 0.01 ],
+                               passed?: true)
+              ]
+      Compatriot::Reporter.new(tests).run
+      assert File.exist?(REPORT_FILENAME), "#{REPORT_FILENAME} not found"
+      File.readlines(REPORT_FILENAME).grep(/label class='collapse/).count.must_equal 2
+    end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compatriot
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Carol (Nichols || Goulding)