percy-selenium 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48523c91451a5f498c95bec1c937d275052d7f9ff4c6810bfae131fb0c6c23f
-  data.tar.gz: f53f34f7cb9c9d100fcb9399cff0fe072b42eb27decd8cd87732b7331ccc3ebd
+  metadata.gz: 1182f98302b6e6a50148711618e377ca36e62ad06d8bfc8a6f3da3b7c34a8256
+  data.tar.gz: b8125cece8b3929bd8416bc15fcaac70fbf9b9f8832207ed47d95f88a167c013
 SHA512:
-  metadata.gz: a0c7281c379dbecca1437da9ad73eb86ba1da0114fa5f8f5effbe72703a4d5702e4eb74d6d210ab0be5d11a48c274f6169c8452099aa77c09090f354a3f043bf
-  data.tar.gz: 3f13093da87d137b2d47a86b25f46ae64d2d6681a5f2cab6531d6df1e6ee8b3878f8e29c160084efa95cde0f2a2f30efc49f95c22c87a054aac347def64521fd
+  metadata.gz: 3a5ffdebefdc4844c60e599bfda70a2375602970de16dbbf9dc5ca5be2d2b52a9cb5f9569215430431130345a43815a934037dd93efa934f4a12f67f9db76627
+  data.tar.gz: 4937624feab8efc33c64d4825204dc4a886dafca14b697be5343826260fb14f49eaad34dd74467a427fc38b7ebb40219b23805c3c43020af9ce844b3c85422d6

data/.github/workflows/lint.yml

@@ -14,7 +14,7 @@ jobs:
         with:
           ruby-version: 2.6
           bundler-cache: true
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: "./vendor/bundle"
           key: v1/${{ runner.os }}/ruby-2.6/${{ hashFiles('**/Gemfile.lock') }}

data/.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
         with:
           ruby-version: 2.6
           bundler-cache: true
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: "./vendor/bundle"
           key: v1/${{ runner.os }}/ruby-2.6/${{ hashFiles('**/Gemfile.lock') }}

data/.github/workflows/test.yml

@@ -31,7 +31,7 @@ jobs:
         with:
           ruby-version: ${{matrix.ruby}}
           bundler-cache: true
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: "./vendor/bundle"
           key: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/${{ hashFiles('**/Gemfile.lock') }}

data/lib/percy.rb

@@ -13,6 +13,42 @@ module Percy
   LABEL = "[\u001b[35m" + (PERCY_DEBUG ? 'percy:ruby' : 'percy') + "\u001b[39m]"
   RESONSIVE_CAPTURE_SLEEP_TIME = ENV['RESONSIVE_CAPTURE_SLEEP_TIME']
 
+  def self.create_region(
+    bounding_box: nil, element_xpath: nil, element_css: nil, padding: nil,
+    algorithm: 'ignore', diff_sensitivity: nil, image_ignore_threshold: nil,
+    carousels_enabled: nil, banners_enabled: nil, ads_enabled: nil, diff_ignore_threshold: nil
+  )
+    element_selector = {}
+    element_selector[:boundingBox] = bounding_box if bounding_box
+    element_selector[:elementXpath] = element_xpath if element_xpath
+    element_selector[:elementCSS] = element_css if element_css
+
+    region = {
+      algorithm: algorithm,
+      elementSelector: element_selector,
+    }
+
+    region[:padding] = padding if padding
+
+    if %w[standard intelliignore].include?(algorithm)
+      configuration = {
+        diffSensitivity: diff_sensitivity,
+        imageIgnoreThreshold: image_ignore_threshold,
+        carouselsEnabled: carousels_enabled,
+        bannersEnabled: banners_enabled,
+        adsEnabled: ads_enabled,
+      }.compact
+
+      region[:configuration] = configuration unless configuration.empty?
+    end
+
+    assertion = {}
+    assertion[:diffIgnoreThreshold] = diff_ignore_threshold unless diff_ignore_threshold.nil?
+    region[:assertion] = assertion unless assertion.empty?
+
+    region
+  end
+
   # Take a DOM snapshot and post it to the snapshot endpoint
   def self.snapshot(driver, name, options = {})
     return unless percy_enabled?

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Percy
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/package.json

@@ -4,6 +4,6 @@
     "test": "percy exec --testing -- bundle exec rspec"
   },
   "devDependencies": {
-    "@percy/cli": "^1.29.5-beta.0"
+    "@percy/cli": "1.30.9"
   }
 }

data/spec/lib/percy/percy_spec.rb

@@ -254,6 +254,64 @@ RSpec.describe Percy, type: :feature do
   end
 end
 
+RSpec.describe Percy do
+  describe '.create_region' do
+    it 'creates a region with default values' do
+      region = Percy.create_region
+
+      expect(region[:algorithm]).to eq('ignore')
+      expect(region[:elementSelector]).to eq({})
+      expect(region).to_not have_key(:configuration)
+      expect(region).to_not have_key(:assertion)
+    end
+
+    it 'creates a region with bounding_box, xpath, and css selectors' do
+      region = Percy.create_region(
+        bounding_box: {x: 10, y: 20, width: 100, height: 200},
+        element_xpath: '//div[@id="test"]',
+        element_css: '.test-class',
+      )
+
+      expect(region[:elementSelector][:boundingBox]).to eq({x: 10, y: 20, width: 100, height: 200})
+      expect(region[:elementSelector][:elementXpath]).to eq('//div[@id="test"]')
+      expect(region[:elementSelector][:elementCSS]).to eq('.test-class')
+    end
+
+    it 'creates a region with padding' do
+      region = Percy.create_region(padding: 10)
+      expect(region[:padding]).to eq(10)
+    end
+
+    it 'creates a region with configuration settings when algorithm is standard' do
+      region = Percy.create_region(
+        algorithm: 'standard',
+        diff_sensitivity: 0.5,
+        image_ignore_threshold: 0.3,
+        carousels_enabled: true,
+        banners_enabled: false,
+        ads_enabled: true,
+      )
+
+      expect(region[:configuration][:diffSensitivity]).to eq(0.5)
+      expect(region[:configuration][:imageIgnoreThreshold]).to eq(0.3)
+      expect(region[:configuration][:carouselsEnabled]).to eq(true)
+      expect(region[:configuration][:bannersEnabled]).to eq(false)
+      expect(region[:configuration][:adsEnabled]).to eq(true)
+    end
+
+    it 'creates a region with assertion settings' do
+      region = Percy.create_region(diff_ignore_threshold: 0.2)
+      expect(region[:assertion][:diffIgnoreThreshold]).to eq(0.2)
+    end
+
+    it 'does not add empty configuration or assertion keys' do
+      region = Percy.create_region(algorithm: 'ignore')
+      expect(region).to_not have_key(:configuration)
+      expect(region).to_not have_key(:assertion)
+    end
+  end
+end
+
 RSpec.describe Percy, type: :feature do
   before(:each) do
     WebMock.reset!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-selenium
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Percy visual testing for Ruby Selenium