kracker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a82f88dd9e535f033f95cb5d3e55f7f750c5d8ce
-  data.tar.gz: bb78e59d2d84010fca771793ea381fa25fdc36ce
+  metadata.gz: 61346c706348ae78ccf2739f62c62d132ff27d3f
+  data.tar.gz: 129c1fdf63cb2c97f609d91be74e05100d751f7f
 SHA512:
-  metadata.gz: 59d7782c28372a1cc22822a252d0bfd920d45f8794cbe5772b5aff1ec360008543a48087f9e80d2368f38c46f2d648cd41d72010f04cc97b20eea60c69ef50d9
-  data.tar.gz: e1c2b002db5448fee7f079af793938891647eb997fca1d2a14feffb6693af225d2634d151d7e0bf6915e4bf32c6bae4c74e54eaf6efdc7cfda63bbe7486e11f7
+  metadata.gz: 2c77b6a589b65375de31df8862ea41223bf0236622f8cc5cb4c7f515a55e5b6b3f9ffcf37977c63768e8705bec30fa1f9876d8c91608903dd21849ae6223e733
+  data.tar.gz: b489c575a18a781d12916b84341f16931f5bcdd3508225cc13838eef94e3053c5b494e6dc1fdca90384a0100756793ee4b2b78751225af2bfdf908b76794c46b

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.0.0-p353

data/Gemfile

@@ -10,7 +10,7 @@ gem 'minitest-reporters'
 gem 'awesome_print'
 gem 'mocha'
 
-gem 'selenium-webdriver', '2.37.0'
+gem 'selenium-webdriver', '2.42.0'
 gem 'capybara', '2.2.1'
 gem 'ae_page_objects', '1.0.0'
 

data/kracker.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency(%q<kramdown>, ["~> 1.1.0"])
   spec.add_dependency 'capybara'
+  spec.add_dependency 'chunky_png'
 
 end

data/lib/kracker/analysis.rb

@@ -48,7 +48,7 @@ module Kracker
     output_hash
   end
 
-  def make_svg(set_master_not_current, set_current_not_master)
+  def make_svg(set_master_not_current, set_current_not_master, set_changed_master)
     js_id = 0
     set_master_not_current.each do |item|
       item[:js_id] = js_id
@@ -58,9 +58,14 @@ module Kracker
       item[:js_id] = js_id
       js_id += 1
     end
+    set_changed_master.each do |item|
+      item[:js_id] = js_id
+      js_id += 1
+    end
 
     rectangles = set_current_not_master.map  { |item| item.merge(format__not_in_master) }
     rectangles << set_master_not_current.map { |item| item.merge(format__not_in_current) }
+    rectangles << set_changed_master.map     { |item| item.merge(format__same_but_different) }
     rectangles.flatten!
 
     generate_svg(rectangles)
@@ -68,7 +73,7 @@ module Kracker
 
   def create_diff_file(set_current_not_master, set_master_not_current, set_changed_master, test_root)
     filename = Kracker.diff_filename(test_root)
-    svg = make_svg(set_current_not_master, set_master_not_current)
+    svg = make_svg(set_current_not_master, set_master_not_current, set_changed_master)
     File.open(filename, 'w') { |file| file.write(svg) }
     save_set_info(test_root, 'current_not_master', set_current_not_master)
     save_set_info(test_root, 'master_not_current', set_master_not_current)
@@ -133,4 +138,4 @@ module Kracker
     "cp #{Kracker.current_filename(test_root)} #{Kracker.master_filename(test_root)}"
   end
 
-end
+end

data/lib/kracker/kracker.rb

@@ -2,6 +2,7 @@ module Kracker
   require 'yaml'
 
   def page_map_same?(test_root)
+    purge_old_files_before_test(test_root)
 
     result, msg = map_current_file(test_root)
     return [result, msg]  unless result
@@ -20,6 +21,8 @@ module Kracker
     msg = make_analysis_failure_report(analysis_data)
     result = analysis_data[:same]
 
+    File.delete Kracker.current_filename(test_root) if result
+
     [result, msg]
   end
 
@@ -109,4 +112,10 @@ module Kracker
     msg.join("\n")
   end
 
+  def purge_old_files_before_test(test_root)
+    File.delete Kracker.current_filename(test_root) if File.exist?(Kracker.current_filename(test_root))
+
+    filename_pattern = File.join(Kracker.diff_file_location, "#{test_root}__*__diff.yaml")
+    Dir[filename_pattern].each { |file| file.delete(file) if File.exist?(file) }
+  end
 end

data/lib/kracker/version.rb

@@ -1,3 +1,3 @@
 module Kracker
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/kracker/zooka/analyzer.rb

@@ -0,0 +1,157 @@
+module Kracker
+  module Zooka
+    class Analyzer
+      attr_accessor :tolerance, :ignore_antialiasing, :ignore_colors
+      attr_accessor :image_1, :image_2
+      attr_reader :result
+      attr_reader :noncompliant_pixels
+
+      def initialize(options = {})
+        @tolerance = Tolerance.new
+        @ignore_antialiasing = false
+        @ignore_colors = false
+        @noncompliant_pixels = []
+
+        if options.has_key?(:image_1)
+          @image_1 = options[:image_1]
+        elsif options.has_key?(:filename_1)
+          @image_1 = ChunkyPNG::Image.from_file(options[:filename_1])
+        else
+          @image_1 = nil
+        end
+
+        if options.has_key?(:image_2)
+          @image_2 = options[:image_2]
+        elsif options.has_key?(:filename_2)
+          @image_2 = ChunkyPNG::Image.from_file(options[:filename_2])
+        else
+          @image_2 = nil
+        end
+      end
+
+      def analyze
+        @noncompliant_pixels = []
+        @result = ChunkyPNG::Image.new(@image_1.width, @image_1.height, ChunkyPNG::Color::TRANSPARENT)
+
+        @image_1.width.times do |x|
+          @image_1.height.times do |y|
+            pix_1 = Pixel.new(@image_1[x, y])
+            pix_2 = Pixel.new(@image_2[x, y])
+
+             if @ignore_colors
+              if brightness_similar?(pix_1, pix_2)
+                @result[x, y] = ChunkyPNG::Color::rgba(pix_1.red, pix_1.green, pix_1.blue, pix_1.alpha / 10)
+              else
+                @result[x, y] = ChunkyPNG::Color::rgba(255, 0, 0, 100)
+                @noncompliant_pixels << { x: x, y: y }
+              end
+            else
+              if rgb_similar?(pix_1, pix_2)
+                @result[x, y] = ChunkyPNG::Color::rgba(pix_1.red, pix_1.green, pix_1.blue, pix_1.alpha / 10)
+              elsif @ignore_antialiasing && (antialiased?(@image_1, x, y)  || antialiased?(@image_2, x, y))
+                if brightness_similar?(pix_1, pix_2)
+                  @result[x, y] = ChunkyPNG::Color::rgba(pix_1.red, pix_1.green, pix_1.blue, pix_1.alpha / 10)
+                else
+                  @result[x, y] = ChunkyPNG::Color::rgba(255, 0, 0, 100)
+                  @noncompliant_pixels << { x: x, y: y }
+                end
+              else
+                @result[x, y] = ChunkyPNG::Color::rgba(255, 0, 0, 100)
+                @noncompliant_pixels << { x: x, y: y }
+              end
+            end
+          end
+        end
+      end
+
+      def same?
+        @noncompliant_pixels.count == 0
+      end
+
+      private
+
+      def antialiased?(data, src_x, src_y)
+        high_contrast_siblings = 0
+        different_hue_siblings = 0
+        equivalent_siblings    = 0
+
+        pixel = Pixel.new(data[src_x, src_y])
+
+        result = false
+
+        other_pixels = []
+
+        (-1..1).each do |x|
+          (-1..1).each do |y|
+            unless x == 0 && y == 0
+              other_x = src_x + x
+              other_y = src_y + y
+
+              next if other_x >= data.width
+              next if other_x < 0
+              next if other_y >= data.height
+              next if other_y < 0
+
+              other_pixels << Pixel.new(data[other_x, other_y])
+            end
+          end
+        end
+
+        if other_pixels.length == 8
+          other_pixels.each do |other_pixel|
+            high_contrast_siblings = high_contrast_siblings + 1 if     contrasting?(pixel, other_pixel)
+            equivalent_siblings    = equivalent_siblings    + 1 if     rgb_same?(pixel, other_pixel)
+            different_hue_siblings = different_hue_siblings + 1 unless hue_same?(pixel, other_pixel)
+
+            if different_hue_siblings > 1 || high_contrast_siblings > 1
+              return true
+            end
+          end
+
+          result = equivalent_siblings < 2
+        else
+          result = false
+        end
+
+        result
+      end
+
+      def contrasting?(pix1, pix2)
+        (pix1.brightness - pix2.brightness).abs > @tolerance.max_brightness
+      end
+
+      def rgb_same?(pix1, pix2)
+        red_same   = pix1.red   == pix2.red
+        green_same = pix1.green == pix2.green
+        blue_same  = pix1.blue  == pix2.blue
+
+        red_same && green_same && blue_same
+      end
+
+      def hue_same?(pix1, pix2)
+        (pix1.hue - pix2.hue).abs <= @tolerance.hue
+      end
+
+      def rgb_similar?(pix1, pix2)
+        red_similar   = color_similar?(pix1.red, pix2.red, 'red')
+        green_similar = color_similar?(pix1.green, pix2.green, 'green')
+        blue_similar  = color_similar?(pix1.blue, pix2.blue, 'blue')
+        alpha_similar = color_similar?(pix1.alpha, pix2.alpha, 'alpha')
+
+        red_similar && green_similar && blue_similar && alpha_similar
+      end
+
+      def color_similar?(a, b, color)
+        return true if a == b
+        (a - b).abs < @tolerance.color(color)
+      end
+
+      def brightness_similar?(pix1, pix2)
+        alpha      = color_similar?(pix1.alpha, pix2.alpha, 'alpha')
+        brightness = color_similar?(pix1.brightness, pix2.brightness, 'min_brightness')
+        brightness && alpha
+      end
+
+    end
+  end
+end

data/lib/kracker/zooka/error_pixel_transform.rb

@@ -0,0 +1,32 @@
+module Kracker
+  module Zooka
+    class ErrorPixelTransform
+      attr_accessor :red, :green, :blue, :alpha
+
+      def initialize
+        @red   = 255
+        @green = 0
+        @blue  = 255
+        @alpha = 255
+      end
+
+      def flat(d1, d2)
+        {
+          r: @red,
+          g: @green,
+          b: @blue,
+          a: @alpha
+        }
+      end
+
+      def movement(d1, d2)
+        {
+          r: ((d2.red   * (@red/255))   + @red)   / 2,
+          g: ((d2.green * (@green/255)) + @green) / 2,
+          b: ((d2.blue  * (@blue/255))  + @blue)  / 2,
+          a: d2.alpha
+        }
+      end
+    end
+  end
+end

data/lib/kracker/zooka/image.rb

@@ -0,0 +1,70 @@
+module Kracker
+  module Zooka
+    class Image
+      attr_accessor :data, :pixels
+      attr_accessor :red, :green, :blue, :alpha, :brightness
+      attr_accessor :red_total, :green_total, :blue_total, :brightness_total
+
+      def initialize(data)
+        @data = data
+        compute_image_summary
+      end
+
+      def display_image_info
+        puts '-'*22
+        puts "  Width:  #{@data.width}"
+        puts "  Height: #{@data.height}"
+        puts "  Avg. Red:    #{@red}"
+        puts "  Avg. Green:  #{@green}"
+        puts "  Avg. Blue:   #{@blue}"
+        puts "  Total Red:   #{@red_total}"
+        puts "  Total Green: #{@green_total}"
+        puts "  Total Blue:  #{@blue_total}"
+        puts '-'*22
+      end
+
+      private
+
+      def on_all_pixels(image, &block)
+        image.width.times do |x|
+          image.height.times do |y|
+            block.call(image[x, y])
+          end
+        end
+      end
+
+      def compute_image_summary
+        @red    = 0
+        @green  = 0
+        @blue   = 0
+        @pixels = 0
+
+        @red_total        = 0
+        @green_total      = 0
+        @blue_total       = 0
+        @brightness_total = 0
+
+        on_all_pixels(@data) do |pixel_value|
+          p = Pixel.new(pixel_value)
+          @pixels = @pixels + 1
+          @red   = @red   + p.red
+          @green = @green + p.green
+          @blue  = @blue  + p.blue
+
+          @red_total        = @red_total   + p.red   / 255 * 100
+          @green_total      = @green_total + p.green / 255 * 100
+          @blue_total       = @blue_total  = p.blue  / 255 * 100
+          # @brightness_total = @brightness_total
+        end
+
+        @red   = @red   / @pixels
+        @green = @green / @pixels
+        @blue  = @blue  / @pixels
+
+        @red_total   = @red_total   / @pixels
+        @green_total = @green_total / @pixels
+        @blue_total  = @blue_total  / @pixels
+      end
+    end
+  end
+end

data/lib/kracker/zooka/pixel.rb

@@ -0,0 +1,50 @@
+module Kracker
+  module Zooka
+    class Pixel
+      attr_accessor :red, :green, :blue, :alpha
+
+      def initialize(color_value)
+        @alpha = ChunkyPNG::Color.a(color_value)
+        @red   = ChunkyPNG::Color.r(color_value)
+        @green = ChunkyPNG::Color.g(color_value)
+        @blue  = ChunkyPNG::Color.b(color_value)
+      end
+
+      def brightness
+        0.3 * @red + 0.59 * @green + 0.11 * @blue
+      end
+
+      def hue
+        red   = @red   / 255.0
+        green = @green / 255.0
+        blue  = @blue  / 255.0
+
+        min = [red, green , blue].sort.first
+        max = [red, green , blue].sort.last
+
+        h = 0
+        d = 0
+
+        if max == min
+          h = 0
+        else
+          d = max - min
+          h = case max
+          when red
+            (green  - blue) / d + (green  < blue ? 6 : 0)
+          when green
+            (blue - red) / d + 2
+          when blue
+            (red - green ) / d + 4
+          else
+            0
+          end
+
+          h = h / 6.0
+        end
+        h
+      end
+
+    end
+  end
+end

data/lib/kracker/zooka/tolerance.rb

@@ -0,0 +1,36 @@
+module Kracker
+  module Zooka
+    class Tolerance
+      attr_accessor :red, :green, :blue, :alpha, :min_brightness, :max_brightness, :hue
+
+      def initialize
+        @red = 16
+        @green = 16
+        @blue = 16
+        @alpha = 16
+        @min_brightness = 16
+        @max_brightness = 240
+        @hue = 0.3
+      end
+
+      def color(c)
+        case c.downcase.to_sym
+        when :alpha
+          @alpha
+        when :red
+          @red
+        when :blue
+          @blue
+        when :green
+          @green
+        when :min_brightness
+          @min_brightness
+        when :hue
+          @hue
+        else
+          0
+        end
+      end
+    end
+  end
+end

data/lib/kracker.rb

@@ -5,3 +5,9 @@ require 'kracker/element'
 require 'kracker/analysis'
 require 'kracker/locations'
 require 'kracker/svg'
+
+require 'kracker/zooka/analyzer'
+require 'kracker/zooka/error_pixel_transform'
+require 'kracker/zooka/image'
+require 'kracker/zooka/pixel'
+require 'kracker/zooka/tolerance'

data/test/selenium/mapping_test.rb

@@ -10,6 +10,7 @@ class MappingTest < Kracker::SeleniumTestCase
     same, msg = page_map_same?('kracker_index')
 
     assert same, msg
+    assert_artifacts_on_same('kracker_index')
   end
 
   def test_mapping__no_master
@@ -19,7 +20,7 @@ class MappingTest < Kracker::SeleniumTestCase
     assert_match 'Master file does not exist', msg, 'the missing master error message'
   end
 
-  def test_full_mapping__one_added__bless
+  def test_full_mapping__one_added__clear
     visit_index
 
     map_current_page_and_save_as_master('kracker_index')
@@ -75,10 +76,9 @@ class MappingTest < Kracker::SeleniumTestCase
 
     index_page = show_page.bless!
     assert_equal 0, index_page.files.count, 'number of difference files'
-
   end
 
-  def test_non_kracker_page
+  def test_non_kracker_page__pass
     local_page = PageObjects::Kracker::LocalIndexPage.visit
 
     map_current_page_and_save_as_master('test_page')
@@ -86,6 +86,26 @@ class MappingTest < Kracker::SeleniumTestCase
     same, msg = page_map_same?('test_page')
 
     assert same, msg
+
+    assert_artifacts_on_same 'test_page'
+  end
+
+  def test_non_kracker_page__fail__size_change
+    local_page = PageObjects::Kracker::LocalIndexPage.visit
+
+    map_current_page_and_save_as_master('test_page')
+
+    starting_dimensions = get_current_browser_dimensions
+    w = starting_dimensions.width + 100
+    h = starting_dimensions.height
+
+    resize_browser(w, h)
+
+    same, msg = page_map_same?('test_page')
+
+    refute same, msg
+
+    assert_artifacts_on_difference 'test_page'
   end
 
   private

data/test/selenium/zooka_test.rb

@@ -0,0 +1,64 @@
+require 'selenium_test_helper'
+
+class ZookaTest < Kracker::SeleniumTestCase
+
+  def setup
+    @filename_1 = Kracker::current_filename('zooka_1').gsub('yaml', 'png')
+    @filename_2 = Kracker::current_filename('zooka_2').gsub('yaml', 'png')
+
+    FileUtils.rm_rf @filename_1
+    FileUtils.rm_rf @filename_2
+    super
+  end
+
+  def teardown
+    FileUtils.rm_rf @filename_1
+    FileUtils.rm_rf @filename_2
+    super
+  end
+
+  def test_zooka__pass
+    index_page = visit_index
+
+    index_page.navigation.config!
+
+    page.driver.save_screenshot(@filename_1)
+    page.driver.save_screenshot(@filename_2)
+
+    image_1 = ChunkyPNG::Image.from_file(@filename_1)
+    image_2 = ChunkyPNG::Image.from_file(@filename_2)
+
+    analyzer = Kracker::Zooka::Analyzer.new({:image_1 => image_1, :image_2 => image_2})
+    analyzer.analyze
+    not_compliant = analyzer.noncompliant_pixels
+
+    expected = 0
+
+    assert analyzer.same?, 'images should be found to be the same'
+    assert_equal expected, not_compliant.count
+  end
+
+  def test_zooka__fail
+    index_page = visit_index
+
+    index_page.navigation.config!
+
+    page.driver.save_screenshot(@filename_1)
+
+    add_centered_element('the zooka will rock you!')
+    page.driver.save_screenshot(@filename_2)
+
+    image_1 = ChunkyPNG::Image.from_file(@filename_1)
+    image_2 = ChunkyPNG::Image.from_file(@filename_2)
+
+    analyzer = Kracker::Zooka::Analyzer.new({:image_1 => image_1, :image_2 => image_2})
+    analyzer.analyze
+    not_compliant = analyzer.noncompliant_pixels
+
+    expected = ENV['TRAVIS'] ? 27200 : 26400
+
+    refute analyzer.same?, 'images should be found to be different'
+    assert_equal expected, not_compliant.count
+  end
+
+end

data/test/selenium_test_helper.rb

@@ -30,6 +30,8 @@ require 'selenium-webdriver'
 
 require 'page_objects'
 
+require 'chunky_png'
+
 test_objects_location = File.expand_path('../test_objects/*', __FILE__)
 Dir[test_objects_location].each { |f| require f }
 
@@ -48,12 +50,23 @@ module Kracker
 
     def setup
       delete_contents_from_kracker_locations
+      initialize_browser_size_for_test
     end
 
     def teardown
       delete_contents_from_kracker_locations
     end
 
+    def initialize_browser_size_for_test
+      @browser_dimensions = ENV['BROWSER_SIZE'] || '960x1000'
+      if @browser_dimensions
+        @starting_dimensions = get_current_browser_dimensions
+        w = @browser_dimensions.split('x')[0]
+        h = @browser_dimensions.split('x')[1]
+        resize_browser(w, h)
+      end
+    end
+
     def visit_index
       PageObjects::Kracker::IndexPage.visit
     end
@@ -84,6 +97,14 @@ module Kracker
       page.driver.browser.execute_script(js)
     end
 
+    def resize_browser(width, height)
+      page.driver.browser.manage.window.resize_to(width.to_i, height.to_i)
+    end
+
+    def get_current_browser_dimensions
+      page.driver.browser.manage.window.size
+    end
+
     def assert_artifacts_on_difference(test_root)
       filename = Kracker.diff_filename(test_root)
       assert File.exists?(filename), "Diff file should exist: #{filename}"
@@ -96,7 +117,33 @@ module Kracker
 
       filename = File.join(Kracker.diff_file_location, "#{test_root}__master_not_current__diff.yaml")
       assert File.exists?(filename), "Master, not current, file should exist: #{filename}"
+
+      filename = Kracker.master_filename(test_root)
+      assert File.exists?(filename), "Master file should exist: #{filename}"
+
+      filename = Kracker.current_filename(test_root)
+      assert File.exists?(filename), "Current file should exist: #{filename}"
+    end
+
+    def assert_artifacts_on_same(test_root)
+      filename = Kracker.diff_filename(test_root)
+      refute File.exists?(filename), "No diff file should exist: #{filename}"
+
+      filename = File.join(Kracker.diff_file_location, "#{test_root}__changed_master__diff.yaml")
+      refute File.exists?(filename), "No changed master file should exist: #{filename}"
+
+      filename = File.join(Kracker.diff_file_location, "#{test_root}__current_not_master__diff.yaml")
+      refute File.exists?(filename), "No current, not master, file should exist: #{filename}"
+
+      filename = File.join(Kracker.diff_file_location, "#{test_root}__master_not_current__diff.yaml")
+      refute File.exists?(filename), "No master, not current, file should exist: #{filename}"
+
+      filename = Kracker.master_filename(test_root)
+      assert File.exists?(filename), "Master file should exist: #{filename}"
+
+      filename = Kracker.current_filename(test_root)
+      refute File.exists?(filename), "No current file should exist: #{filename}"
     end
 
   end
-end
+end

data/test/test_helper.rb

@@ -31,11 +31,13 @@ Dir[test_objects_location].each { |f| require f }
 test_helper_location = File.expand_path('../test_helpers/**/*.rb', __FILE__)
 Dir[test_helper_location].each { |f| require f }
 
+
 module Kracker
   class KrackerTestCase < Minitest::Test
+
     include Kracker
     include Kracker::TestObjects
     include Kracker::TestHelpers::Location
 
   end
-end
+end