capybara-screenshot-diff 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2aaf70ea2e2737e435920bc94a4504a2d2d3fe9d92874a4f1a9ac2f66527ed1
-  data.tar.gz: '087a7e5e2636a56318884f7d272126e62faea68c49401e96fa40a4a0d43bfb8b'
+  metadata.gz: e982564438ee16c8ae6900407e80ab1921888bd83b14fc6efc1c9a20fb6b79d5
+  data.tar.gz: 4893ded8cd25dbf93d9147b21e3a1bf09d80c544a390648eae58ef46dca85c78
 SHA512:
-  metadata.gz: 7c636d231583f4b3df1404aff861ef94000752e8b07edc829e2c16d56e34e2ba7418849c7e875a9e625832a6b8259f854c3ff3e0883c20d5942350d34181bc7d
-  data.tar.gz: f706ccc8937cd86a53b0a0dd04cb2429e77d4ef1ac643b898ce7bc08c4b623c976ce3f402136fccf0851c99509ec346102a48ef724a4711f70e73e438cf2a973
+  metadata.gz: 146c1928e4fd32ac25d7ad6813f81adb6e6a82004ab2bd589281e8fbc130001f4cddea57e706d7023dcb760a0d907d9a766375ef25a851e44962db6bbdd3e80a
+  data.tar.gz: 474fca1d1a8e27508593efe4517f6fe2d58608693acba531943e3220d6ae169445963517da6b40b5f7c095f6ef27f038cf57c397f7e17e0f3cae728307f085cd

data/Rakefile

@@ -16,3 +16,32 @@ Rake::TestTask.new("test:integration") do |t|
   t.libs << "lib"
   t.test_files = FileList["test/integration/**/*_test.rb"]
 end
+
+Rake::TestTask.new("test:signatures") do |t|
+  ENV["RBS_TEST_DOUBLE_SUITE"] ||= "minitest"
+  ENV["RBS_TEST_TARGET"] ||= "Capybara::Screenshot::Diff::*"
+  ENV["RBS_TEST_OPT"] ||= "-rset -rpathname -Isig"
+
+  t.libs << "test"
+  t.ruby_opts << "-r rbs/test/setup"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task "clobber" do
+  puts "Cleanup tmp/*.png"
+  FileUtils.rm_rf(Dir["./tmp/*"])
+end
+
+task "test:benchmark" do
+  require_relative "./scripts/benchmark/find_region_benchmark"
+  benchmark = Capybara::Screenshot::Diff::Drivers::FindRegionBenchmark.new
+
+  puts "For Medium Screen Size: 800x600"
+  benchmark.for_medium_size_screens
+
+  puts ""
+  puts "*" * 100
+
+  puts "For Small Screen Size: 80x60"
+  benchmark.for_small_images
+end

data/capybara-screenshot-diff.gemspec

@@ -12,15 +12,18 @@ Gem::Specification.new do |spec|
   spec.summary = "Track your GUI changes with diff assertions"
   spec.description = "Save screen shots and track changes with graphical diff"
   spec.homepage = "https://github.com/donv/capybara-screenshot-diff"
-  spec.required_ruby_version = defined?(JRUBY_VERSION) ? ">= 2.6.0" : ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.0.0"
   spec.license = "MIT"
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{(^(\.|tmp|bin|test|spec|features|gemfiles|scripts)/)|(^(\.|Dockerfile|CONTRIBUTING|README))})
+  end
+
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "actionpack", ">= 6.0", "< 8"
+  spec.add_runtime_dependency "actionpack", ">= 6.1", "< 8"
   spec.add_runtime_dependency "capybara", ">= 2", "< 4"
-  spec.add_runtime_dependency "chunky_png", "~> 1.3"
+  spec.add_runtime_dependency "chunky_png", ">= 1.3", "< 2"
 end

data/gems.rb

@@ -8,7 +8,7 @@ gemspec path: __dir__
 gem "rake"
 
 # Image processing libraries
-gem "oily_png", platform: :ruby
+gem "oily_png", platform: :ruby, git: "https://github.com/donv/oily_png", branch: "patch-2"
 gem "ruby-vips", require: false
 
 # Test
@@ -18,12 +18,18 @@ gem "simplecov", require: false
 
 # Capybara Server
 gem "puma", require: false
+gem "rackup", require: false
 
 # Capybara Drivers
 gem "cuprite", require: false
 gem "selenium-webdriver", require: false
-gem "webdrivers", require: false
+gem "webdrivers", "~> 5.0", require: false
+
+# Test Frameworks
+# gem "cucumber", require: false
+# gem "cucumber-rails", require: false
 
 group :tools do
   gem "standard", require: false
+  gem "rbs", require: false, platform: :ruby
 end

data/lib/capybara/screenshot/diff/browser_helpers.rb

@@ -5,25 +5,24 @@ require_relative "region"
 module Capybara
   module Screenshot
     module BrowserHelpers
-      def current_capybara_driver_class
-        Capybara.current_session.driver.class
+      def self.resize_to(window_size)
+        if session.driver.respond_to?(:resize)
+          session.driver.resize(*window_size)
+        elsif BrowserHelpers.selenium?
+          session.driver.browser.manage.window.resize_to(*window_size)
+        end
       end
 
-      def selenium?
+      def self.selenium?
         current_capybara_driver_class <= Capybara::Selenium::Driver
       end
 
-      def window_size_is_wrong?
-        selenium? &&
-          Screenshot.window_size &&
-          page.driver.browser.manage.window.size != ::Selenium::WebDriver::Dimension.new(*Screenshot.window_size)
-      end
-
-      def rect_for(css_selector)
-        all_visible_regions_for(css_selector).first
+      def self.window_size_is_wrong?(expected_window_size = nil)
+        selenium? && expected_window_size &&
+          session.driver.browser.manage.window.size != ::Selenium::WebDriver::Dimension.new(*expected_window_size)
       end
 
-      def bounds_for_css(*css_selectors)
+      def self.bounds_for_css(*css_selectors)
         css_selectors.reduce([]) do |regions, selector|
           regions.concat(all_visible_regions_for(selector))
         end
@@ -38,13 +37,9 @@ module Capybara
             }
           }
           return false;
-        }()
+        }(window)
       JS
 
-      def pending_image_to_load
-        evaluate_script IMAGE_WAIT_SCRIPT
-      end
-
       HIDE_CARET_SCRIPT = <<~JS
         if (!document.getElementById('csdHideCaretStyle')) {
           let style = document.createElement('style');
@@ -55,8 +50,8 @@ module Capybara
         }
       JS
 
-      def hide_caret
-        execute_script(HIDE_CARET_SCRIPT)
+      def self.hide_caret
+        session.execute_script(HIDE_CARET_SCRIPT)
       end
 
       FIND_ACTIVE_ELEMENT_SCRIPT = <<~JS
@@ -67,11 +62,11 @@ module Capybara
             return ae;
           }
           return null;
-        }();
+        }(window);
       JS
 
-      def blur_from_focused_element
-        page.evaluate_script(FIND_ACTIVE_ELEMENT_SCRIPT)
+      def self.blur_from_focused_element
+        session.evaluate_script(FIND_ACTIVE_ELEMENT_SCRIPT)
       end
 
       GET_BOUNDING_CLIENT_RECT_SCRIPT = <<~JS
@@ -83,18 +78,24 @@ module Capybara
         ]
       JS
 
-      def all_visible_regions_for(selector)
-        all(selector, visible: true).map(&method(:region_for))
+      def self.all_visible_regions_for(selector)
+        BrowserHelpers.session.all(selector, visible: true).map(&method(:region_for))
       end
 
-      def region_for(element)
+      def self.region_for(element)
         element.evaluate_script(GET_BOUNDING_CLIENT_RECT_SCRIPT).map { |point| point.negative? ? 0 : point.to_i }
       end
 
-      private
+      def self.session
+        Capybara.current_session
+      end
+
+      def self.pending_image_to_load
+        BrowserHelpers.session.evaluate_script(IMAGE_WAIT_SCRIPT)
+      end
 
-      def create_output_directory_for(file_name)
-        FileUtils.mkdir_p File.dirname(file_name)
+      def self.current_capybara_driver_class
+        session.driver.class
       end
     end
   end

data/lib/capybara/screenshot/diff/cucumber.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "capybara/screenshot/diff"
+require "capybara/screenshot/diff/test_methods"
+
+World(Capybara::Screenshot::Diff::TestMethods)
+
+Before do
+  Capybara::Screenshot::Diff.delayed = false
+  Capybara::Screenshot::BrowserHelpers.resize_to(Capybara::Screenshot.window_size) if Capybara::Screenshot.window_size
+end

data/lib/capybara/screenshot/diff/difference.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Capybara
+  module Screenshot
+    module Diff
+      class Difference < Struct.new(:region, :meta, :comparison)
+        def different?
+          !(blank? || tolerable?)
+        end
+
+        def base_image
+          comparison.base_image
+        end
+
+        def options
+          comparison.options
+        end
+
+        def tolerance
+          options[:tolerance]
+        end
+
+        def skip_area
+          options[:skip_area]
+        end
+
+        def area_size_limit
+          options[:area_size_limit]
+        end
+
+        def blank?
+          region.nil? || region_area_size.zero?
+        end
+
+        def region_area_size
+          region&.size || 0
+        end
+
+        def ratio
+          meta[:difference_level]
+        end
+
+        def to_h
+          {area_size: region_area_size, region: coordinates}.merge!(meta)
+        end
+
+        def coordinates
+          region&.to_edge_coordinates
+        end
+
+        def inspect
+          to_h.to_json
+        end
+
+        def tolerable?
+          !!((area_size_limit && area_size_limit >= region_area_size) || (tolerance && tolerance >= ratio))
+        end
+      end
+    end
+  end
+end

data/lib/capybara/screenshot/diff/drivers/base_driver.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "chunky_png"
+require "capybara/screenshot/diff/difference"
+
+module Capybara
+  module Screenshot
+    module Diff
+      # Compare two images and determine if they are equal, different, or within some comparison
+      # range considering color values and difference area size.
+      module Drivers
+        class BaseDriver
+          PNG_EXTENSION = ".png"
+
+          def same_dimension?(comparison)
+            dimension(comparison.base_image) == dimension(comparison.new_image)
+          end
+
+          def height_for(image)
+            image.height
+          end
+
+          def width_for(image)
+            image.width
+          end
+
+          def image_area_size(image)
+            width_for(image) * height_for(image)
+          end
+
+          def dimension(image)
+            [width_for(image), height_for(image)]
+          end
+
+          def inscribed?(dimensions, i)
+            width_for(i) < dimensions[0] || height_for(i) < dimensions[1]
+          end
+        end
+      end
+    end
+  end
+end