capybara-playwright-driver 0.5.7 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36e3eb177b25d9c711d190e31beeeebc7fcba4a40b5c1ffa6d2e995ac2b34219
-  data.tar.gz: 961a358b0aeb9cf2ededd3491b0850e8df4ce9ccdf3c3a895cd69fea589923ad
+  metadata.gz: a319465a40c53ac5b47d86ccd4d15136c20dcf7f6dde6fe17b3906d44cb2fd94
+  data.tar.gz: 1e38fb6020a87a07e6eaa8e997084b3abd98a0a8d5cbec4e92819a960c525f62
 SHA512:
-  metadata.gz: d62a3e62ceee42b31676fa7e2728e1d49e24592f32b889a7cf8732ad076bfae839b4009ee56f4031657c6906f2906e412f1df442482ac79b0974a35722fa07a4
-  data.tar.gz: 12d105953dd329eb5eb118d1ab81370f395810004b2e940dc356f5457f36db96ede3fc75938727374124cc9cccb0fb83fe4d71e65b167071bdea7d47a7b8e634
+  metadata.gz: 5d1d8aeccb05f0c667c3b1a617cb1d2f19eb7fa096788a46b81985730f1a75b6ee7196ad952d2152c173b7401980090f738db399503b3ddceac097ced637678c
+  data.tar.gz: 141fd5024a9d322faf9031951e0f74a61426af350ed06d73017b2db90ec5b866e1af9b17edd5017e5c35f79f198cfa5916b220afcf621db9a2538c5fb50f443b

data/AGENTS.md

@@ -0,0 +1,107 @@
+# AGENTS.md
+
+## Ruby Style
+- This repository is Ruby-first. Prefer Ruby naming and control flow over Python- or Java-style ceremony.
+- Use names that describe the role in the domain. Avoid vague plumbing names like `context`, `handler`, `data`, or `control` unless they are the clearest possible name.
+- Boolean-returning methods must end with `?`.
+- Prefer `find`, `any?`, early return, and guard clauses over `value = nil` plus later reassignment.
+- Do not add `attr_reader` for every instance variable in a small internal object. If the state is only used internally, access the instance variable directly.
+- If an object is already scoped to one responsibility, avoid redundant prefixes in every private method name.
+- Do not prefix Ruby private methods with `_`. Use `private` for visibility and a normal method name for intent.
+
+## Naming Examples
+
+Bad:
+
+```ruby
+def _playwright_try_get_by_label(locator)
+  # ...
+end
+```
+
+Good:
+
+```ruby
+def find_by_label(locator)
+  # ...
+end
+```
+
+Bad:
+
+```ruby
+def click_associated_label(control)
+  return true if control.evaluate("el => !!el.checked")
+end
+```
+
+Good:
+
+```ruby
+def click_associated_label?(playwright_locator)
+  return true if playwright_locator.evaluate("el => !!el.checked")
+end
+```
+
+Bad:
+
+```ruby
+def initialize(node_context:, selector:, locator:, checked:)
+  @node_context = node_context
+  @selector = selector
+  @locator = locator
+  @checked = checked
+end
+```
+
+Good:
+
+```ruby
+def initialize(node:, node_type:, locator:, checked:)
+  @node = node
+  @node_type = node_type
+  @locator = locator
+  @checked = checked
+end
+```
+
+Bad:
+
+```ruby
+control = nil
+
+candidates.each do |candidate|
+  next unless matches?(candidate)
+
+  control = candidate
+  break
+end
+
+control
+```
+
+Good:
+
+```ruby
+candidates.find do |element_handle|
+  matches?(element_handle)
+end
+```
+
+Bad:
+
+```ruby
+attr_reader :node, :node_type, :locator, :checked
+```
+
+Good:
+
+```ruby
+def click_associated_label?(playwright_locator)
+  return true if playwright_locator.evaluate("el => !!el.checked") == @checked
+end
+```
+
+## General Guidance
+- Prefer concise Ruby that reads top-to-bottom without carrying unnecessary temporary state.
+- Prefer small private helper objects only when they reduce complexity. Once extracted, give them Ruby-like method names and keep their public surface minimal.

data/README.md

@@ -43,10 +43,27 @@ end
 
 Refer the [documentation](https://playwright-ruby-client.vercel.app/docs/article/guides/rails_integration) for more detailed configuration.
 
+## Development
+
+Prepare to run tests:
+
+```bash
+bundle install
+export PLAYWRIGHT_CLI_VERSION=$(bundle exec ruby -e 'require "playwright"; puts Playwright::COMPATIBLE_PLAYWRIGHT_VERSION.strip')
+npm install playwright@${PLAYWRIGHT_CLI_VERSION}
+./node_modules/.bin/playwright install --with-deps
+```
+
+Now, run tests: note that they are run in a virtual framebuffer (Xvfb).
+
+```bash
+PLAYWRIGHT_CLI_EXECUTABLE_PATH=./node_modules/.bin/playwright xvfb-run bundle exec rspec
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Capybara::Playwright project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/capybara-playwright/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Capybara::Playwright project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/YusukeIwaki/capybara-playwright-driver/blob/main/CODE_OF_CONDUCT.md).

data/capybara-playwright.gemspec

@@ -20,8 +20,6 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/}) || f.include?('.git')
     end
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.4'

data/lib/capybara/playwright/browser.rb

@@ -48,7 +48,7 @@ module Capybara
       private def create_page(browser_context)
         browser_context.new_page.tap do |page|
           page.on('close', -> {
-            if @playwright_page
+            if @playwright_page&.guid == page.guid
               @playwright_page = nil
             end
           })
@@ -84,7 +84,8 @@ module Capybara
             path
           end
 
-          @playwright_page.capybara_current_frame.goto(url)
+          response = @playwright_page.capybara_current_frame.goto(url)
+          @playwright_page.capybara_set_last_response(response)
         }
       end
 
@@ -144,13 +145,15 @@ module Capybara
 
       def go_back
         assert_page_alive {
-          @playwright_page.go_back
+          response = @playwright_page.go_back
+          @playwright_page.capybara_set_last_response(response)
         }
       end
 
       def go_forward
         assert_page_alive {
-          @playwright_page.go_forward
+          response = @playwright_page.go_forward
+          @playwright_page.capybara_set_last_response(response)
         }
       end
 

data/lib/capybara/playwright/driver.rb

@@ -90,8 +90,8 @@ module Capybara
           end
         end
 
-        # video path can be aquired only before closing context.
-        # video is completedly saved only after closing context.
+        # video path can be acquired only before closing context.
+        # video is completely saved only after closing context.
         video_path = @browser&.video_path
 
         # [NOTE] @playwright_browser should keep alive for better performance.

data/lib/capybara/playwright/node.rb

@@ -30,6 +30,145 @@ module Capybara
   end
   Node::Element.prepend(WithElementHandlePatch)
 
+  module NodeActionsAllowLabelClickPatch
+    class SelectableElementHandler
+      def initialize(node:, node_type:, locator:, checked:)
+        @node = node
+        @node_type = node_type
+        @locator = locator
+        @checked = checked
+      end
+
+      def set_checked_state_via_label?
+        playwright_checkable = find_playwright_element_handle_by_non_label_locator
+        playwright_checkable ||= playwright_locator_by_label unless @locator.nil?
+        return false unless playwright_checkable
+
+        click_associated_label?(playwright_checkable)
+      rescue Capybara::ElementNotFound, Capybara::ExpectationNotMet, ::Playwright::Error
+        false
+      end
+
+      private
+
+      def playwright_locator_by_label
+        driver.with_playwright_page do |playwright_page|
+          return playwright_page.get_by_label(@locator.to_s)
+        end
+      end
+
+      def click_associated_label?(playwright_element_handle_or_locator)
+        return true if playwright_element_handle_or_locator.evaluate('el => !!el.checked') == @checked
+
+        label_element_handle = playwright_element_handle_or_locator.evaluate_handle('(el) => (el.labels && el.labels[0]) || el.closest("label") || null')
+        return false unless label_element_handle.is_a?(::Playwright::ElementHandle)
+
+        label_element_handle.click
+
+        playwright_element_handle_or_locator.evaluate('el => !!el.checked') == @checked
+      end
+
+      def find_playwright_element_handle_by_non_label_locator
+        return nil if @locator.nil?
+
+        locator_string = @locator.to_s
+        test_id_attr = session_options.test_id&.to_s
+
+        driver.with_playwright_page do |playwright_page|
+          return non_label_playwright_element_handle_candidates(playwright_page).find do |element_handle|
+            attribute_values = element_handle.evaluate(<<~JAVASCRIPT, arg: test_id_attr)
+            (el, testIdAttr) => ({
+              id: el.id || '',
+              name: el.getAttribute('name') || '',
+              testId: testIdAttr ? (el.getAttribute(testIdAttr) || '') : '',
+            })
+            JAVASCRIPT
+            [attribute_values['id'], attribute_values['name'], attribute_values['testId']].include?(locator_string)
+          end
+        end
+      rescue ::Playwright::Error
+        nil
+      end
+
+      def non_label_playwright_element_handle_candidates(playwright_page)
+        input_type =
+          case @node_type
+          when :checkbox
+            'checkbox'
+          when :radio_button
+            'radio'
+          else
+            return []
+          end
+
+        current_scope = scope_element
+        return current_scope.query_selector_all(%(input[type="#{input_type}"])) if current_scope
+
+        playwright_page.capybara_current_frame.query_selector_all(%(input[type="#{input_type}"]))
+      end
+
+      def scope_element
+        return nil unless @node.is_a?(Capybara::Node::Element)
+        return nil unless @node.send(:base).is_a?(Capybara::Playwright::Node)
+
+        @node.send(:base).send(:element)
+      end
+
+      def driver
+        @node.send(:driver)
+      end
+
+      def session_options
+        @node.send(:session_options)
+      end
+    end
+
+    def choose(locator = nil, **options)
+      check_via_label_click(:radio_button, locator, checked: true, **options) { super }
+    end
+
+    def check(locator = nil, **options)
+      check_via_label_click(:checkbox, locator, checked: true, **options) { super }
+    end
+
+    def uncheck(locator = nil, **options)
+      check_via_label_click(:checkbox, locator, checked: false, **options) { super }
+    end
+
+    private def check_via_label_click(node_type, locator, checked:, allow_label_click: session_options.automatic_label_click, **options)
+      unless should_use_label_click?(allow_label_click, options)
+        return yield
+      end
+
+      handler = SelectableElementHandler.new(
+        node: self,
+        node_type: node_type,
+        locator: locator,
+        checked: checked,
+      )
+      return self if handler.set_checked_state_via_label?
+
+      yield
+    end
+
+    private def should_use_label_click?(allow_label_click, options)
+      return false unless allow_label_click
+      return false unless driver.is_a?(Capybara::Playwright::Driver)
+      return false if Hash.try_convert(allow_label_click)
+      return false unless options.empty?
+
+      true
+    end
+  end
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
+    # Prepend to Node::Base instead of Node::Actions because Ruby < 3.1
+    # does not propagate Module#prepend to classes that have already
+    # included the target module. Node::Base includes Node::Actions at
+    # load time, so prepending to Node::Actions afterwards has no effect
+    # on Node::Document / Node::Element in older Rubies.
+    Node::Base.prepend(NodeActionsAllowLabelClickPatch)
+  end
+
   module CapybaraObscuredPatch
     # ref: https://github.com/teamcapybara/capybara/blob/f7ab0b5cd5da86185816c2d5c30d58145fe654ed/lib/capybara/selenium/node.rb#L523
     OBSCURED_OR_OFFSET_SCRIPT = <<~JAVASCRIPT
@@ -59,6 +198,20 @@ module Capybara
   end
   ::Playwright::ElementHandle.prepend(CapybaraObscuredPatch)
 
+  # ref: https://github.com/teamcapybara/capybara/pull/2424
+  module ElementDropPathCompatPatch
+    def drop(*args)
+      options = args.map { |arg| arg.respond_to?(:to_path) ? arg.to_path : arg }
+      synchronize { base.drop(*options) }
+      self
+    end
+  end
+  if Gem::Version.new(Capybara::VERSION) < Gem::Version.new('3.34.0')
+    # Older Capybara returns early for Pathname arguments in Element#drop,
+    # so the driver implementation never runs.
+    Node::Element.prepend(ElementDropPathCompatPatch)
+  end
+
   module Playwright
     # Selector and checking methods are derived from twapole/apparition
     # Action methods (click, select_option, ...) uses playwright.
@@ -97,6 +250,8 @@ module Capybara
           raise StaleReferenceError.new(err)
         when /error in channel "content::page": exception while running method "adoptNode"/ # for Firefox
           raise StaleReferenceError.new(err)
+        when /(: Shadow DOM element - no XPath :)/
+          raise StaleReferenceError.new(err)
         else
           raise
         end
@@ -244,13 +399,31 @@ module Capybara
 
       class TextInput < Settable
         def set(value, **options)
+          case options[:clear]
+          when :backspace
+            @element.press('End', timeout: @timeout)
+            existing_text = @element.evaluate('el => el.value')
+            existing_text.length.times { @element.press('Backspace', timeout: @timeout) }
+          when :none
+            @element.press('End', timeout: @timeout)
+          when Array
+            @internal_logger.warn "options { clear: #{options[:clear]} } is ignored"
+          end
+
           text = value.to_s
-          if text.end_with?("\n")
-            @element.fill(text[0...-1], timeout: @timeout)
-            @element.press('Enter', timeout: @timeout)
+          if press_enter = text.end_with?("\n")
+            text = text[0...-1]
+          end
+
+          if options[:clear] == :none
+            @element.type(text, timeout: @timeout)
           else
             @element.fill(text, timeout: @timeout)
           end
+
+          if press_enter
+            @element.press('Enter', timeout: @timeout)
+          end
         rescue ::Playwright::TimeoutError
           raise if @element.editable?
 
@@ -711,8 +884,47 @@ module Capybara
         end
       end
 
+      ATTACH_FILE = <<~JAVASCRIPT
+        () => {
+          const input = document.createElement('INPUT');
+          input.type = 'file';
+          input.multiple = true;
+          input.style.display = 'none';
+          document.body.appendChild(input);
+          return input;
+        }
+      JAVASCRIPT
+
+      DROP_FILE = <<~JAVASCRIPT
+        (el, input) => {
+          const dt = new DataTransfer();
+          for (const file of input.files) { dt.items.add(file); }
+          input.remove();
+          el.dispatchEvent(new DragEvent('drop', {
+            cancelable: true, bubbles: true, dataTransfer: dt
+          }));
+        }
+      JAVASCRIPT
+
+      DROP_STRING = <<~JAVASCRIPT
+        (el, items) => {
+          const dt = new DataTransfer();
+          for (const item of items) { dt.items.add(item.data, item.type); }
+          el.dispatchEvent(new DragEvent('drop', {
+            cancelable: true, bubbles: true, dataTransfer: dt
+          }));
+        }
+      JAVASCRIPT
+
       def drop(*args)
-        raise NotImplementedError
+        if args.first.is_a?(String) || args.first.is_a?(Pathname)
+          input = @page.evaluate_handle(ATTACH_FILE)
+          input.as_element.set_input_files(args.map(&:to_s))
+          @element.evaluate(DROP_FILE, arg: input)
+        else
+          items = args.flat_map { |arg| arg.map { |(type, data)| { type: type, data: data } } }
+          @element.evaluate(DROP_STRING, arg: items)
+        end
       end
 
       def scroll_by(x, y)
@@ -905,6 +1117,9 @@ module Capybara
                 xpath = el.nodeName.toUpperCase()+"["+pos+"]/"+xpath;
               }
               el = el.parentNode;
+              if (!el) {
+                throw "(: Shadow DOM element - no XPath :)";
+              }
             }
             xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;
             xpath = xpath.replace(/\\/$/, '');

data/lib/capybara/playwright/page.rb

@@ -17,7 +17,7 @@ module Capybara
       end
 
       private def capybara_initialize
-        @capybara_all_responses = {}
+        @capybara_response_mutex = Mutex.new
         @capybara_last_response = nil
         @capybara_frames = []
 
@@ -31,13 +31,9 @@ module Capybara
           Thread.new(dest) { |_dest| download.save_as(_dest) }
         })
         on('response', -> (response) {
-          @capybara_all_responses[response.url] = response
-        })
-        on('framenavigated', -> (frame) {
-          @capybara_last_response = @capybara_all_responses[frame.url]
-        })
-        on('load', -> (page) {
-          @capybara_all_responses.clear
+          if response.request.navigation_request?
+            capybara_set_last_response(response)
+          end
         })
       end
 
@@ -146,6 +142,12 @@ module Capybara
         end
       end
 
+      def capybara_set_last_response(response)
+        @capybara_response_mutex.synchronize do
+          @capybara_last_response = response
+        end
+      end
+
       class Headers < Hash
         def [](key)
           # Playwright accepts lower-cased keys.
@@ -155,7 +157,7 @@ module Capybara
       end
 
       def capybara_response_headers
-        headers = @capybara_last_response&.headers || {}
+        headers = @capybara_response_mutex.synchronize { @capybara_last_response&.headers || {} }
 
         Headers.new.tap do |h|
           headers.each do |key, value|
@@ -165,7 +167,7 @@ module Capybara
       end
 
       def capybara_status_code
-        @capybara_last_response&.status.to_i
+        @capybara_response_mutex.synchronize { @capybara_last_response&.status.to_i }
       end
 
       def capybara_reset_frames

data/lib/capybara/playwright/shadow_root_node.rb

@@ -5,12 +5,12 @@ module Capybara
     class ShadowRootNode < Node
       def initialize(driver, internal_logger, page, element)
         super
-        @shadow_roow_element = element.evaluate_handle('el => el.shadowRoot')
+        @shadow_root_element = element.evaluate_handle('el => el.shadowRoot')
       end
 
       def all_text
         assert_element_not_stale {
-          text = @shadow_roow_element.text_content
+          text = @shadow_root_element.text_content
           text.to_s.gsub(/[\u200b\u200e\u200f]/, '')
               .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
               .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
@@ -25,7 +25,7 @@ module Capybara
           return '' unless visible?
 
           # https://github.com/teamcapybara/capybara/blob/1c164b608fa6452418ec13795b293655f8a0102a/lib/capybara/rack_test/node.rb#L18
-          displayed_text = @shadow_roow_element.text_content.to_s.
+          displayed_text = @shadow_root_element.text_content.to_s.
                               gsub(/[\u200b\u200e\u200f]/, '').
                               gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
           displayed_text.squeeze(' ')

data/lib/capybara/playwright/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Playwright
-    VERSION = '0.5.7'
+    VERSION = '0.5.9'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capybara-playwright-driver
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.9
 platform: ruby
 authors:
 - YusukeIwaki
-autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2025-08-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -52,7 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.0
-description:
 email:
 - q7w8e9w8q7w8e9@yahoo.co.jp
 executables: []
@@ -60,6 +58,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- AGENTS.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -86,7 +85,6 @@ homepage: https://github.com/YusukeIwaki/capybara-playwright-driver
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,8 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Playwright driver for Capybara
 test_files: []