capybara-playwright-driver 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17075d587d4657d2c2f70b68256bbaeac10e011d553b092cbbed35cb33de6f05
-  data.tar.gz: c42763d910584f0687985887ab07180f1fde752c9b7543b1613d481757fd3898
+  metadata.gz: cbeebaa83a4010e3b6e99abbc5fe3bcd6fc4e0b61c13f4247f318d5bb9bba039
+  data.tar.gz: b2fbb62062ebda5efddf8ff7a8b2c185b6d725af2480c7638211f7114c1412cc
 SHA512:
-  metadata.gz: 94bf8ef42f8d6a8e59b1f160eeb10f142432015beb9c219bab1c0dac31fbbf7dfcea1c2a63349aaf32dac58e87b33add9a690471eef90d96a5d228a9bc9f456e
-  data.tar.gz: 894cc32d6ef13f2611d81b240a56f75b4ea445667ad7b8215a8955c96e742118dcb08ddf2f15df02fe375674665f45ead8ae892869421e99b01b2ec4bb687082
+  metadata.gz: 91dd078211a3464e311b7bbd8a92e2038cddc1bd4750b5b4259e011caf089cbcdd2c48127c0c55467053e91d08014b36e77c00c153004732aef0301d90c1e4eb
+  data.tar.gz: ef7f8050310b3dffc69add62f810cd4df52ee28f10dc1bc35eabd62e33a042322b5d88ead040a468bb1e0a9838f31cdde02793e62ba6dfab4088a347b67aaeed

data/README.md

@@ -2,12 +2,14 @@
 
 # 🎭 Playwright driver for Capybara
 
-#### [Docs](https://playwright-ruby-client.vercel.app/docs/article/guides/rails_integration)
+Make it easy to introduce Playwright into your Rails application.
 
 ```ruby
 gem 'capybara-playwright-driver'
 ```
 
+**NOTE**: If you want to use Playwright-native features (such as auto-waiting, various type of locators, ...), [consider using playwright-ruby-client directly](https://playwright-ruby-client.vercel.app/docs/article/guides/rails_integration_with_null_driver).
+
 ## Examples
 
 ```ruby
@@ -38,6 +40,8 @@ all('.repo-list-item').each do |li|
 end
 ```
 
+Refer the [documentation](https://playwright-ruby-client.vercel.app/docs/article/guides/rails_integration) for more detailed configuration.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/capybara-playwright.gemspec

@@ -26,13 +26,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
   spec.add_dependency 'capybara'
-  spec.add_dependency 'playwright-ruby-client', '>= 0.6.2'
+  spec.add_dependency 'playwright-ruby-client', '>= 1.16.0'
   spec.add_development_dependency 'allure-rspec'
-  spec.add_development_dependency 'bundler', '~> 2.2.3'
+  spec.add_development_dependency 'bundler', '~> 2.3.10'
   spec.add_development_dependency 'launchy', '>= 2.0.4'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0.3'
-  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  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'

data/lib/capybara/playwright/browser.rb

@@ -165,6 +165,15 @@ module Capybara
         wrap_node(result)
       end
 
+      def active_element
+        el = @playwright_page.capybara_current_frame.evaluate_handle('() => document.activeElement')
+        if el
+          Node.new(@driver, @playwright_page, el)
+        else
+          nil
+        end
+      end
+
       # Not used by Capybara::Session.
       # Intended to be directly called by user.
       def video_path
@@ -328,7 +337,24 @@ module Capybara
         when ::Playwright::ElementHandle
           Node.new(@driver, @playwright_page, arg)
         when ::Playwright::JSHandle
-          arg.json_value
+          obj_type, is_array = arg.evaluate('obj => [typeof obj, Array.isArray(obj)]')
+          if obj_type == 'object'
+            if is_array
+              # Firefox often include 'toJSON' into properties.
+              # https://github.com/microsoft/playwright/issues/7015
+              #
+              # Get rid of non-numeric entries.
+              arg.properties.select { |key, _| key.to_i.to_s == key.to_s }.map  do |_, value|
+                wrap_node(value)
+              end
+            else
+              arg.properties.map do |key, value|
+                [key, wrap_node(value)]
+              end.to_h
+            end
+          else
+            arg.json_value
+          end
         else
           arg
         end

data/lib/capybara/playwright/browser_runner.rb

@@ -0,0 +1,99 @@
+module Capybara
+    module Playwright
+      # playwright-ruby-client provides 3 methods to launch/connect browser.
+      #
+      # Playwright.create do |playwright|
+      #   playwright.chromium.launch do |browser|
+      #
+      # Playwright.connect_to_playwright_server do |playwright| ...
+      #   playwright.chromium.launch do |browser|
+      #
+      # Playwright.connect_to_browser_server do |browser| ...
+      #
+      # This class provides start/stop methods for driver.
+      # This is responsible for
+      # - managing PlaywrightExecution
+      # - launching browser with given option if needed
+      class BrowserRunner
+        class PlaywrightConnectToPlaywrightServer
+          def initialize(endpoint_url, options)
+            @ws_endpoint = endpoint_url
+            @browser_type = options[:browser_type] || :chromium
+            unless %i(chromium firefox webkit).include?(@browser_type)
+              raise ArgumentError.new("Unknown browser_type: #{@browser_type}")
+            end
+            @browser_options = BrowserOptions.new(options)
+          end
+
+          def playwright_execution
+            @playwright_execution ||= ::Playwright.connect_to_playwright_server(@ws_endpoint)
+          end
+
+          def playwright_browser
+            browser_type = playwright_execution.playwright.send(@browser_type)
+            browser_options = @browser_options.value
+            browser_type.launch(**browser_options)
+          end
+        end
+
+        class PlaywrightConnectToBrowserServer
+          def initialize(endpoint_url)
+            @ws_endpoint = endpoint_url
+          end
+
+          def playwright_execution
+            @playwright_execution ||= ::Playwright.connect_to_browser_server(@ws_endpoint)
+          end
+
+          def playwright_browser
+            playwright_execution.browser
+          end
+        end
+
+        class PlaywrightCreate
+          def initialize(options)
+            @playwright_cli_executable_path = options[:playwright_cli_executable_path] || 'npx playwright'
+            @browser_type = options[:browser_type] || :chromium
+            unless %i(chromium firefox webkit).include?(@browser_type)
+              raise ArgumentError.new("Unknown browser_type: #{@browser_type}")
+            end
+            @browser_options = BrowserOptions.new(options)
+          end
+
+          def playwright_execution
+            @playwright_execution ||= ::Playwright.create(
+              playwright_cli_executable_path: @playwright_cli_executable_path,
+            )
+          end
+
+          def playwright_browser
+            browser_type = playwright_execution.playwright.send(@browser_type)
+            browser_options = @browser_options.value
+            browser_type.launch(**browser_options)
+          end
+        end
+
+        def initialize(options)
+          @runner =
+            if options[:playwright_server_endpoint_url]
+              PlaywrightConnectToPlaywrightServer.new(options[:playwright_server_endpoint_url], options)
+            elsif options[:browser_server_endpoint_url]
+              PlaywrightConnectToBrowserServer.new(options[:browser_server_endpoint_url])
+            else
+              PlaywrightCreate.new(options)
+            end
+        end
+
+        # @return [::Playwright::Browser]
+        def start
+          @playwright_execution = @runner.playwright_execution
+          @runner.playwright_browser
+        end
+
+        def stop
+          @playwright_execution&.stop
+          @playwright_execution = nil
+        end
+      end
+    end
+  end

data/lib/capybara/playwright/driver.rb

@@ -7,20 +7,14 @@ module Capybara
       include DriverExtension
 
       def initialize(app, **options)
-        @playwright_cli_executable_path = options[:playwright_cli_executable_path] || 'npx playwright'
-        @browser_type = options[:browser_type] || :chromium
-        unless %i(chromium firefox webkit).include?(@browser_type)
-          raise ArgumentError.new("Unknown browser_type: #{@browser_type}")
-        end
-
-        @browser_options = BrowserOptions.new(options)
+        @browser_runner = BrowserRunner.new(options)
         @page_options = PageOptions.new(options)
       end
 
       def wait?; true; end
       def needs_server?; true; end
 
-      def browser
+      private def browser
         @browser ||= ::Capybara::Playwright::Browser.new(
           driver: self,
           playwright_browser: playwright_browser,
@@ -43,22 +37,13 @@ module Capybara
           exit @exit_status if @exit_status # Force exit with stored status
         end
 
-        browser_type = playwright_execution.playwright.send(@browser_type)
-        browser_options = @browser_options.value
-        browser_type.launch(**browser_options)
-      end
-
-      private def playwright_execution
-        @playwright_execution ||= ::Playwright.create(
-          playwright_cli_executable_path: @playwright_cli_executable_path,
-        )
+        @browser_runner.start
       end
 
       private def quit
         @playwright_browser&.close
         @playwright_browser = nil
-        @playwright_execution&.stop
-        @playwright_execution = nil
+        @browser_runner.stop
       end
 
       def reset!
@@ -112,6 +97,7 @@ module Capybara
       def_delegator(:browser, :save_screenshot)
       def_delegator(:browser, :response_headers)
       def_delegator(:browser, :status_code)
+      def_delegator(:browser, :active_element)
       def_delegator(:browser, :send_keys)
       def_delegator(:browser, :switch_to_frame)
       def_delegator(:browser, :current_window_handle)

data/lib/capybara/playwright/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Playwright
-    VERSION = '0.1.4'
+    VERSION = '0.2.0'
   end
 end

data/lib/capybara/playwright.rb

@@ -4,6 +4,7 @@ require 'capybara'
 require 'playwright'
 
 require 'capybara/playwright/browser'
+require 'capybara/playwright/browser_runner'
 require 'capybara/playwright/browser_options'
 require 'capybara/playwright/dialog_event_handler'
 require 'capybara/playwright/driver'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-playwright-driver
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-19 00:00:00.000000000 Z
+date: 2022-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 1.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: allure-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.3.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.3.10
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +184,7 @@ files:
 - lib/capybara/playwright.rb
 - lib/capybara/playwright/browser.rb
 - lib/capybara/playwright/browser_options.rb
+- lib/capybara/playwright/browser_runner.rb
 - lib/capybara/playwright/dialog_event_handler.rb
 - lib/capybara/playwright/driver.rb
 - lib/capybara/playwright/driver_extension.rb
@@ -211,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Playwright driver for Capybara