playwright-ruby-client 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 623dc9bf11ce77bda6cd9006c727e31060564810bac0ccf5f06aabffc5976c07
-  data.tar.gz: 206995c24a6cbd4dcd6867eaa076e3b3052b7a7056cd63188a7ebb0e54c38056
+  metadata.gz: 77f49d82e8b6b94210f79ee9e031dcfb73072a11da4c366626ad3bcf3e18bfa9
+  data.tar.gz: '098cbff788ed38a7647de0271d6f3c38a757e3c750ebf8aaa3f96dccbb626921'
 SHA512:
-  metadata.gz: a341d042e6e35b5205f56303efda6fe9a34e857c12696622c366f0ebbc113816b3418e05e87b8fe60867ae2252964a36545b8bd782cf61f9c23f42e868cb098a
-  data.tar.gz: 68fc458f0fc750c208f8daa7f900ef33977987aa6684db4edea20c42cf5f3837deb4e5b828385fd9c25d11769ff1b345cdb795aef370158bd009a515dfeeb54d
+  metadata.gz: 46997fb7eff8b747560a6f8658bc2b50cbeb2a489f75ed716ccfb84fc8dfddea171bbd4812dc897840507c7d9267e1c81e9f79ae05679ccece322dff7c8adc8b
+  data.tar.gz: 134a0003575cbe1501af23dad3a2f706cf9a961a8c067a858ecd25e61fe7a20f018d382d8d38be40c5aaa0c603dd0b1d02bd62b674405bfa5b5e130cf8593196

data/documentation/docs/article/guides/rails_integration.md

@@ -48,4 +48,115 @@ Capybara.default_driver = :playwright
 Capybara.javascript_driver = :playwright
 ```
 
-It is not mandatry. Without changing the default driver, you can still use Playwright driver by specifying `Capybara.current_driver = :playwrite` (or `driven_by :playwright` in system spec) explicitly.
+It is not mandatry. Without changing the default driver, you can still use Playwright driver by specifying `Capybara.current_driver = :playwright` (or `driven_by :playwright` in system spec) explicitly.
+
+### (reference) Available driver options
+
+These parameters can be passed into `Capybara::Playwright::Driver.new`
+
+* `playwright_cli_executable_path`
+  * Refer [this article](./download_playwright_driver) to understand what to specify.
+* `browser_type`
+  * `:chromium` (default), `:firefox`, or `:webkit`
+* Parameters for [Playwright::BrowserType#launch](/docs/api/browser_type#launch)
+  * args
+  * channel
+    * `chrome`, `msedge`, `chrome-beta`, `chrome-dev`, `chrome-canary`, `msedge-beta`, `msedge-dev` Browser distribution channel. Read more about using [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge)
+  * devtools
+  * downloadsPath
+  * env
+  * executablePath
+  * firefoxUserPrefs
+  * headless
+  * ignoreDefaultArgs
+  * proxy
+  * slowMo
+  * timeout
+* Parameters for [Playwright::Browser#new_context](/docs/api/browser#new_context)
+  * bypassCSP
+  * colorScheme
+  * deviceScaleFactor
+  * extraHTTPHeaders
+  * geolocation
+  * hasTouch
+  * httpCredentials
+  * ignoreHTTPSErrors
+  * isMobile
+  * javaScriptEnabled
+  * locale
+  * noViewport
+  * offline
+  * permissions
+  * proxy
+  * record_har_omit_content
+  * record_har_path
+  * record_video_dir
+  * record_video_size
+  * screen
+  * storageState
+  * timezoneId
+  * userAgent
+  * viewport
+
+```ruby
+driver_opts = {
+  # `playwright` command path.
+  playwright_cli_executable_path: './node_modules/.bin/playwright',
+
+  # Use firefox for testing.
+  browser_type: :firefox,
+
+  # Headful mode.
+  headless: false,
+
+  # Slower operation
+  slowMo: 50, # integer. (50-100 would be good for most cases)
+}
+
+Capybara::Playwright::Driver.new(app, driver_opts)
+```
+
+
+## Available functions and Limitations
+
+### Capybara DSL
+
+Most of the methods of `Capybara::Session` and `Capybara::Node::Element` are available. However the following method is not yet implemented.
+
+* `Capybara::Node::Element#drop`
+
+### Playwright-native scripting
+
+We can also describe Playwright-native automation script using `with_playwright_page` and `with_playwright_element_handle`.
+
+```ruby
+# With Capybara DSL
+find('a[data-item-type="global_search"]').click
+
+# With Playwright-native Page
+Capybara.current_session.driver.with_playwright_page do |page|
+  # `page` is an instance of Playwright::Page.
+  page.click('a[data-item-type="global_search"]')
+end
+```
+
+```ruby
+all('.list-item').each do |li|
+  # With Capybara::Node::Element method
+  puts li.all('a').first.text
+
+  # With Playwright-native ElementHandle
+  puts li.with_playwright_element_handle do |handle|
+    # `handle` is an instance of Playwright::ElementHandle
+    handle.query_selector('a').text_content
+  end
+end
+```
+
+Generally, Capybara DSL seems simple, but Playwright-native scripting are more precise and efficient. Also `waitForNavigation`, `waitForSelector`, and many other Playwright functions are available with Playwright-native scripting.
+
+### Limitations
+
+* Playwright doesn't allow clicking invisible DOM elements or moving elements. `click` sometimes doesn't work as Selenium does. See the detail in https://playwright.dev/docs/actionability/
+* `current_window.maximize` and `current_window.fullscreen` work only on headful (non-headless) mode, as selenium driver does.
+* `Capybara::Node::Element#drag_to` does not accept `html5` parameter, since [Playwright doesn't implement the feature yet](https://github.com/microsoft/playwright/pull/6207).

data/lib/playwright/channel_owners/browser.rb

@@ -7,7 +7,7 @@ module Playwright
     private def after_initialize
       @connected = true
       @closed_or_closing = false
-      @remote = true
+      @remote = false
 
       @contexts = Set.new
       @channel.on('close', method(:on_close))
@@ -52,14 +52,6 @@ module Playwright
 
     def close
       return if @closed_or_closing
-      if @remote
-        @contexts.each do |context|
-          context.pages.each do |page|
-            page.send(:on_close)
-          end
-          context.send(:on_close)
-        end
-      end
       @closed_or_closing = true
       @channel.send_message_to_server('close')
       nil
@@ -89,14 +81,6 @@ module Playwright
 
     private def on_close(_ = {})
       @connected = false
-      if @remote
-        @contexts.each do |context|
-          context.pages.each do |page|
-            page.send(:on_close)
-          end
-          context.send(:on_close)
-        end
-      end
       emit(Events::Browser::Disconnected, self)
       @closed_or_closing = true
     end

data/lib/playwright/channel_owners/browser_context.rb

@@ -46,6 +46,8 @@ module Playwright
           ChannelOwners::Request.from_nullable(params['page']),
         )
       })
+
+      @closed_promise = Concurrent::Promises.resolvable_future
     end
 
     private def on_page(page)
@@ -223,15 +225,14 @@ module Playwright
     end
 
     private def on_close
-      @closed_or_closing = true
       @browser&.send(:remove_context, self)
       emit(Events::BrowserContext::Close)
+      @closed_promise.fulfill(true)
     end
 
     def close
-      return if @closed_or_closing
-      @closed_or_closing = true
       @channel.send_message_to_server('close')
+      @closed_promise.value!
       nil
     rescue => err
       raise unless safe_close_error?(err)

data/lib/playwright/channel_owners/page.rb

@@ -65,7 +65,8 @@ module Playwright
         emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
       })
       @channel.on('worker', ->(params) {
-        on_worker(ChannelOwners::Worker.from(params['worker']))
+        worker = ChannelOwners::Worker.from(params['worker'])
+        # on_worker(worker)
       })
     end
 

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
   COMPATIBLE_PLAYWRIGHT_VERSION = '1.12.0'
 end

data/lib/playwright_api/page.rb

@@ -1278,8 +1278,8 @@ module Playwright
     end
 
     # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
@@ -1288,8 +1288,8 @@ module Playwright
     end
 
     # @nodoc
-    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
     end
 
     # @nodoc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby