percy-capybara 5.0.0.pre.5 → 5.0.1.pre.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf51cb54687bfae9bea4339cf40dc1abc68c1c9f92978b5ed18e2d89ac794dde
-  data.tar.gz: ae1131aefeb90634c386029a452686de6128ec29e48002faf11a7d7da1414e76
+  metadata.gz: ccaeb7accc5e9ccb209ad80416672ada2508a4614b43a0963b6e7b6c7a80d347
+  data.tar.gz: ab7f534fd22d02a567a60d1905b737ed1a0f2276d531de1a2186ae79b96b5176
 SHA512:
-  metadata.gz: f0c80b0a26341d17e18c1ed2b58b1abaa2e1cb975788c7a5bd363a8ea4c55dbe210f55fb92479321612e88db4afb14c0952d36999d0a23aced76b5f2c627257b
-  data.tar.gz: bda59318073be4794cb9ddb782ffdfc4b341e6134504a735cc60a41a54c73b25fcae2609f1702b97e15a2c534e8fdd1ff8ad0160ce9f0ebb2ba1c659fa2f2eb3
+  metadata.gz: c1c5cb3a5024547f38d493a7571a73bdc43ae3a722865abce42fa6dc068c058a4326e4363c761f9f46cf8154ffeda1156b87eafee4e427118ff527ceeb6f6e97
+  data.tar.gz: f70fdedb5935a55025c068ace0dc6fcacfd4556c27be45584a97777107f405c85bcfc9aeec1465ba9631bb886344e0653663aa0074ae0a17f1f4bf5c93f5f2fc

data/README.md

@@ -66,10 +66,27 @@ $ percy exec -- [test command]
 `page.snapshot(name[, options])`
 
 - `name` (**required**) - The snapshot name; must be unique to each snapshot
-- `options` - [See per-snapshot configuration options](https://docs.percy.io/docs/cli-configuration#per-snapshot-configuration)
+- `options` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)
 
 ## Upgrading
 
+### Automatically with `@percy/migrate`
+
+We built a tool to help automate migrating to the new CLI toolchain! Migrating
+can be done by running the following commands and following the prompts:
+
+``` shell
+$ npx @percy/migrate
+? Are you currently using percy-capybara? Yes
+? Install @percy/cli (required to run percy)? Yes
+? Migrate Percy config file? Yes
+? Upgrade SDK to percy-capybara@^5.0.0? Yes
+? The Capybara API has breaking changes, automatically convert to the new API? Yes
+```
+
+This will automatically run the changes described below for you, with the
+exception of changing the `require`.
+
 ### Manually
 
 #### Require change

data/lib/percy/capybara.rb

@@ -22,9 +22,20 @@ module PercyCapybara
 
     begin
       page.evaluate_script(fetch_percy_dom)
+
+      # Readiness gate -- runs before serialize when CLI supports it.
+      # Uses evaluate_async_script with a callback signal so the SDK can block
+      # on PercyDOM.waitForReady. In-browser typeof guard makes this a no-op on
+      # older CLIs that lack waitForReady.
+      readiness_diagnostics = wait_for_ready(page, options)
+
       dom_snapshot = page
         .evaluate_script("(function() { return PercyDOM.serialize(#{options.to_json}) })()")
 
+      if readiness_diagnostics && dom_snapshot.is_a?(Hash)
+        dom_snapshot['readiness_diagnostics'] = readiness_diagnostics
+      end
+
       response = fetch('percy/snapshot',
         name: name,
         url: page.current_url,
@@ -55,7 +66,7 @@ module PercyCapybara
         log('You may be using @percy/agent ' \
             'which is no longer supported by this SDK. ' \
             'Please uninstall @percy/agent and install @percy/cli instead. ' \
-            'https://docs.percy.io/docs/migrating-to-percy-cli')
+            'https://www.browserstack.com/docs/percy/migration/migrate-to-cli')
         @percy_enabled = false
         return false
       end
@@ -85,6 +96,39 @@ module PercyCapybara
     @percy_dom = response.body
   end
 
+  # Readiness gate: runs PercyDOM.waitForReady before serialize.
+  #
+  # Returns diagnostics to attach to the domSnapshot, or nil.
+  # Config precedence: options[:readiness] / options['readiness'] > {} (the
+  # CLI applies its balanced preset default when passed {}). preset='disabled'
+  # skips the script entirely. Opt-in: only runs when the caller explicitly
+  # passes a `readiness` option -- keeps non-opting tests insulated from
+  # Capybara drivers that don't implement evaluate_async_script.
+  # Any StandardError is caught at debug level.
+  private def wait_for_ready(page, options)
+    return nil unless options.key?(:readiness) || options.key?('readiness')
+
+    readiness_config = options[:readiness] || options['readiness'] || {}
+    return nil if readiness_config.is_a?(Hash) && (
+      readiness_config[:preset] == 'disabled' || readiness_config['preset'] == 'disabled'
+    )
+
+    begin
+      page.evaluate_async_script(<<~JS)
+        var cfg = #{readiness_config.to_json};
+        var done = arguments[arguments.length - 1];
+        try {
+          if (typeof PercyDOM !== 'undefined' && typeof PercyDOM.waitForReady === 'function') {
+            PercyDOM.waitForReady(cfg).then(function(r){ done(r); }).catch(function(){ done(); });
+          } else { done(); }
+        } catch (e) { done(); }
+      JS
+    rescue StandardError => e
+      if PERCY_DEBUG then log("waitForReady failed, proceeding to serialize: #{e}") end
+      nil
+    end
+  end
+
   private def log(msg)
     puts "#{PERCY_LABEL} #{msg}"
   end

data/lib/percy/version.rb

@@ -1,3 +1,3 @@
 module PercyCapybara
-  VERSION = '5.0.0.pre.5'.freeze
+  VERSION = '5.0.1.pre.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 5.0.0.pre.5
+  version: 5.0.1.pre.0
 platform: ruby
 authors:
 - Perceptual Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2026-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta1
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta1
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: geckodriver-bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +98,16 @@ dependencies:
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.31'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.31'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: percy-style
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +139,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/percy/percy-capybara/issues
   source_code_uri: https://github.com/percy/percy-capybara
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Percy visual testing for Capybara
 test_files: []