capybara-playwright-driver 0.5.2 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2e156c0f77ca328e9f95266e2b3ec6bf5a8250dbdbdb4d8c5e58b6590c042b
-  data.tar.gz: 252a5c70de1364cde5fd3996466d166deb3d17639476731c63e24c362a3f46bd
+  metadata.gz: 518d6724c448e420fa844cbd57d30859ad8cc8bdc20348c9d9dc5ffdf819866f
+  data.tar.gz: 61ca17f8d89db0c48b4fe5a95b57462b389f2307e9185108779d5bcb5cb075b2
 SHA512:
-  metadata.gz: fcfa998db2aa8701ba465be17b67df0164e9fdb4cb9c7c087342256143dde984573f7627d20297f6dc1b9680d9b6bfa5b3e2227f4bbc91eea3bfd878c76ad01a
-  data.tar.gz: f792c1dd299fc9d257c6a38311a270979da849f4617d5827bbcfe7b186ccbca80cb92f27b1f4b6e6684a9443f8751af18501d4857f22031754ded783b6519219
+  metadata.gz: a873fe231de97cdcc86a541c3eb462b438cafe4d8582f2e3050b3e75e60d7dc8b79420dd81dbcf746ce637f5f834636c35f43b0534b3638d78ca67f4bdc91656
+  data.tar.gz: f4455bf145a28e9e102ff21b0f75fbfe026d1d0f888d55b874bdc6d38bec287a4fd1e6402d3623154c10f18377a3fa2bfdf383e1c8bc0bb888eb5712f9123211

data/Gemfile

@@ -6,3 +6,14 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in capybara-playwright.gemspec
 gemspec
+
+gem 'allure-rspec'
+gem 'bundler'
+gem 'launchy', '>= 2.0.4'
+gem 'pry-byebug'
+gem 'rack-test_server'
+gem 'rake', '~> 13.0.3'
+gem 'rspec', '~> 3.11.0'
+gem 'rubocop-rspec'
+gem 'sinatra', '>= 1.4.0'
+gem 'webrick'

data/capybara-playwright.gemspec

@@ -28,14 +28,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'addressable'
   spec.add_dependency 'capybara'
   spec.add_dependency 'playwright-ruby-client', '>= 1.16.0'
-  spec.add_development_dependency 'allure-rspec'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'launchy', '>= 2.0.4'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rack-test_server'
-  spec.add_development_dependency 'rake', '~> 13.0.3'
-  spec.add_development_dependency 'rspec', '~> 3.11.0'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'sinatra', '>= 1.4.0'
-  spec.add_development_dependency 'webrick'
 end

data/lib/capybara/playwright/browser.rb

@@ -15,8 +15,9 @@ module Capybara
 
       class NoSuchWindowError < StandardError ; end
 
-      def initialize(driver:, playwright_browser:, page_options:, record_video: false, callback_on_save_trace: nil, default_timeout: nil, default_navigation_timeout: nil)
+      def initialize(driver:, internal_logger:, playwright_browser:, page_options:, record_video: false, callback_on_save_trace: nil, default_timeout: nil, default_navigation_timeout: nil)
         @driver = driver
+        @internal_logger = internal_logger
         @playwright_browser = playwright_browser
         @page_options = page_options
         if record_video
@@ -36,6 +37,7 @@ module Capybara
             unless @playwright_page
               @playwright_page = page
             end
+            page.send(:_update_internal_logger, @internal_logger)
           })
           if @callback_on_save_trace
             browser_context.tracing.start(screenshots: true, snapshots: true)
@@ -95,7 +97,7 @@ module Capybara
       def find_xpath(query, **options)
         assert_page_alive {
           @playwright_page.capybara_current_frame.query_selector_all("xpath=#{query}").map do |el|
-            Node.new(@driver, @playwright_page, el)
+            Node.new(@driver, @internal_logger, @playwright_page, el)
           end
         }
       end
@@ -103,7 +105,7 @@ module Capybara
       def find_css(query, **options)
         assert_page_alive {
           @playwright_page.capybara_current_frame.query_selector_all(query).map do |el|
-            Node.new(@driver, @playwright_page, el)
+            Node.new(@driver, @internal_logger, @playwright_page, el)
           end
         }
       end
@@ -185,7 +187,7 @@ module Capybara
       def active_element
         el = @playwright_page.capybara_current_frame.evaluate_handle('() => document.activeElement')
         if el
-          Node.new(@driver, @playwright_page, el)
+          Node.new(@driver, @internal_logger, @playwright_page, el)
         else
           nil
         end
@@ -252,7 +254,7 @@ module Capybara
             /Cannot find context with specified id/,
             /Unable to adopt element handle from a different document/
             # ignore error for retry
-            puts "[WARNING] #{err.message}"
+            @internal_logger.warn(err.message)
           else
             raise
           end
@@ -324,7 +326,7 @@ module Capybara
       end
 
       def maximize_window(handle)
-        puts "[WARNING] maximize_window is not supported in Playwright driver"
+        @internal_logger.warn("maximize_window is not supported in Playwright driver")
         # incomplete in Playwright
         # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L346
         on_window(handle) do |page|
@@ -334,7 +336,7 @@ module Capybara
       end
 
       def fullscreen_window(handle)
-        puts "[WARNING] fullscreen_window is not supported in Playwright driver"
+        @internal_logger.warn("fullscreen_window is not supported in Playwright driver")
         # incomplete in Playwright
         # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L341
         on_window(handle) do |page|
@@ -375,7 +377,7 @@ module Capybara
             [key, wrap_node(value)]
           end.to_h
         when ::Playwright::ElementHandle
-          Node.new(@driver, @playwright_page, arg)
+          Node.new(@driver, @internal_logger, @playwright_page, arg)
         when ::Playwright::JSHandle
           obj_type, is_array = arg.evaluate('obj => [typeof obj, Array.isArray(obj)]')
           if obj_type == 'object'

data/lib/capybara/playwright/browser_options.rb

@@ -20,6 +20,7 @@ module Capybara
         headless: nil,
         ignoreDefaultArgs: nil,
         proxy: nil,
+        reducedMotion: nil,
         slowMo: nil,
         # timeout: nil,
         tracesDir: nil,

data/lib/capybara/playwright/driver.rb

@@ -18,6 +18,7 @@ module Capybara
         if options[:default_navigation_timeout].is_a?(Numeric)
           @default_navigation_timeout = options[:default_navigation_timeout] * 1000
         end
+        @internal_logger = options[:logger] || default_logger
       end
 
       def wait?; true; end
@@ -26,6 +27,7 @@ module Capybara
       private def browser
         @browser ||= ::Capybara::Playwright::Browser.new(
           driver: self,
+          internal_logger: @internal_logger,
           playwright_browser: playwright_browser,
           page_options: @page_options.value,
           record_video: callback_on_save_screenrecord?,
@@ -52,6 +54,27 @@ module Capybara
         @browser_runner.start
       end
 
+      private def default_logger
+        if defined?(Rails)
+          Rails.logger
+        else
+          PutsLogger.new
+        end
+      end
+
+      # Since existing user already monkey-patched Kernel#puts,
+      # (https://gist.github.com/searls/9caa12f66c45a72e379e7bfe4c48405b)
+      # Logger.new(STDOUT) should be avoided to use.
+      class PutsLogger
+        def info(message)
+          puts "[INFO] #{message}"
+        end
+
+        def warn(message)
+          puts "[WARNING] #{message}"
+        end
+      end
+
       private def quit
         @playwright_browser&.close
         @playwright_browser = nil

data/lib/capybara/playwright/driver_extension.rb

@@ -46,7 +46,7 @@ module Capybara
       def with_playwright_page(&block)
         raise ArgumentError.new('block must be given') unless block
 
-        @browser&.with_playwright_page(&block)
+        browser.with_playwright_page(&block)
       end
 
       # Start Playwright tracing (doc: https://playwright.dev/docs/api/class-tracing#tracing-start)

data/lib/capybara/playwright/node.rb

@@ -8,7 +8,10 @@ module Capybara
 
       # Playwright has own auto-waiting feature.
       # So disable Capybara's retry logic.
-      options[:wait] = 0
+      if driver.is_a?(Capybara::Playwright::Driver)
+        options[:wait] = 0
+      end
+
       super
     end
   end
@@ -21,7 +24,7 @@ module Capybara
       if native.is_a?(::Playwright::ElementHandle)
         block.call(native)
       else
-        raise "#{native.inspect} is not a Playwirght::ElementHandle"
+        raise "#{native.inspect} is not a Playwright::ElementHandle"
       end
     end
   end
@@ -64,8 +67,9 @@ module Capybara
     #   selenium:   https://github.com/teamcapybara/capybara/blob/master/lib/capybara/selenium/node.rb
     #   apparition: https://github.com/twalpole/apparition/blob/master/lib/capybara/apparition/node.rb
     class Node < ::Capybara::Driver::Node
-      def initialize(driver, page, element)
+      def initialize(driver, internal_logger, page, element)
         super(driver, element)
+        @internal_logger = internal_logger
         @page = page
         @element = element
       end
@@ -131,7 +135,7 @@ module Capybara
               }
             }
           JAVASCRIPT
-          text.to_s.gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
+          text.to_s.scrub.gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
               .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
               .gsub(/\n+/, "\n")
               .tr("\u00a0", ' ')
@@ -209,15 +213,16 @@ module Capybara
             end
           end
 
-        settable_class.new(@element, capybara_default_wait_time).set(value, **options)
+        settable_class.new(@element, capybara_default_wait_time, @internal_logger).set(value, **options)
       rescue ::Playwright::TimeoutError => err
         raise NotActionableError.new(err)
       end
 
       class Settable
-        def initialize(element, timeout)
+        def initialize(element, timeout, internal_logger)
           @element = element
           @timeout = timeout
+          @internal_logger = internal_logger
         end
       end
 
@@ -249,7 +254,7 @@ module Capybara
         rescue ::Playwright::TimeoutError
           raise if @element.editable?
 
-          puts "[INFO] Node#set: element is not editable. #{@element}"
+          @internal_logger.info("Node#set: element is not editable. #{@element}")
         end
       end
 
@@ -548,7 +553,7 @@ module Capybara
                   _key = key.last
                   code =
                     if _key.is_a?(String) && _key.length == 1
-                      _key.upcase
+                      _key
                     elsif _key.is_a?(Symbol)
                       key_for(_key)
                     else
@@ -567,7 +572,7 @@ module Capybara
                 when String
                   key.each_char do |char|
                     executables << PressKey.new(
-                      key: char.upcase,
+                      key: char,
                       modifiers: modifiers,
                     )
                   end
@@ -600,6 +605,10 @@ module Capybara
 
         class PressKey
           def initialize(key:, modifiers:)
+            # Shift requires an explicitly uppercase a-z key to produce the correct output
+            # See https://playwright.dev/docs/input#keys-and-shortcuts
+            key = key.upcase if modifiers == [MODIFIERS[:shift]] && key.match?(/^[a-z]$/)
+
             # puts "PressKey: key=#{key} modifiers: #{modifiers}"
             if modifiers.empty?
               @key = key
@@ -917,7 +926,7 @@ module Capybara
         #   Node.new(@driver, @page, @element.evaluate_handle('el => el.shadowRoot'))
         #
         # does not work well because of the Playwright Error 'Element is not attached to the DOM'
-        ShadowRootNode.new(@driver, @page, @element)
+        ShadowRootNode.new(@driver, @internal_logger, @page, @element)
       end
 
       def inspect
@@ -933,7 +942,7 @@ module Capybara
       def find_xpath(query, **options)
         assert_element_not_stale {
           @element.query_selector_all("xpath=#{query}").map do |el|
-            Node.new(@driver, @page, el)
+            Node.new(@driver, @internal_logger, @page, el)
           end
         }
       end
@@ -941,7 +950,7 @@ module Capybara
       def find_css(query, **options)
         assert_element_not_stale {
           @element.query_selector_all(query).map do |el|
-            Node.new(@driver, @page, el)
+            Node.new(@driver, @internal_logger, @page, el)
           end
         }
       end

data/lib/capybara/playwright/page.rb

@@ -12,6 +12,10 @@ module Capybara
         capybara_initialize
       end
 
+      private def _update_internal_logger(internal_logger)
+        @internal_logger = internal_logger
+      end
+
       private def capybara_initialize
         @capybara_all_responses = {}
         @capybara_last_response = nil
@@ -44,7 +48,7 @@ module Capybara
       end
 
       private def capybara_on_unexpected_modal(dialog)
-        puts "[WARNING] Unexpected modal - \"#{dialog.message}\""
+        @internal_logger.warn "Unexpected modal - \"#{dialog.message}\""
         if dialog.type == 'beforeunload'
           dialog.accept_async
         else
@@ -99,7 +103,7 @@ module Capybara
             message_promise.fulfill(message)
             acceptor.handle(dialog)
           else
-            message_promise.reject(Capybara::ModalNotFound.new("Dialog message=\"#{message}\" dowsn't match"))
+            message_promise.reject(Capybara::ModalNotFound.new("Dialog message=\"#{message}\" doesn't match"))
             dialog.dismiss
           end
         }
@@ -125,7 +129,7 @@ module Capybara
           if matcher.matches?(message)
             message_promise.fulfill(message)
           else
-            message_promise.reject(Capybara::ModalNotFound.new("Dialog message=\"#{message}\" dowsn't match"))
+            message_promise.reject(Capybara::ModalNotFound.new("Dialog message=\"#{message}\" doesn't match"))
           end
           dialog.dismiss
         }

data/lib/capybara/playwright/shadow_root_node.rb

@@ -3,7 +3,7 @@ require_relative './node'
 module Capybara
   module Playwright
     class ShadowRootNode < Node
-      def initialize(driver, page, element)
+      def initialize(driver, internal_logger, page, element)
         super
         @shadow_roow_element = element.evaluate_handle('el => el.shadowRoot')
       end

data/lib/capybara/playwright/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Playwright
-    VERSION = '0.5.2'
+    VERSION = '0.5.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-playwright-driver
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.5
 platform: ruby
 authors:
 - YusukeIwaki
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -52,147 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.0
-- !ruby/object:Gem::Dependency
-  name: allure-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: launchy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.4
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test_server
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.0.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email:
 - q7w8e9w8q7w8e9@yahoo.co.jp
 executables: []
@@ -226,7 +86,7 @@ homepage: https://github.com/YusukeIwaki/capybara-playwright-driver
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -241,8 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Playwright driver for Capybara
 test_files: []