playwright-ruby-client 0.2.0 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eecde37d8ee0ad9fdb1f0df5a64a5a646f2706915a24a2a2d83a8f176bcc8519
-  data.tar.gz: cb97a5926b3a25c8c3b2fe8c88946747ec89d3d579f71d36350c7cf2839c83e0
+  metadata.gz: 548d69d7e9ada4dcbd8b760c5c993ad48809bc952d889aa96b440e8d2f2e4cc3
+  data.tar.gz: d1c634791be5a553240895824b5cd99d17d41d52c0cdfc81993992a8175b4897
 SHA512:
-  metadata.gz: 2e1bb8eee779773afd9e3b165a03f3c91bb25ae076ae00d6d1603e34afe8eaf3876f847559841c68403588a79b766f3e4afe680f7056286c64ba16ce5be149bc
-  data.tar.gz: e55e7895a26b5a579cae82101cd9ae0bf3cebd4f9ecc0c18692b4a18fa5a7e649b4121d9ac5c6029101131cdd56c59af64ba8b65d6c325cfbe7ffe56c8ee632c
+  metadata.gz: d61d45ba95f21049bf4e14001c874d659e3a825f1f531ecd91c4ab107dae3d6eee90ee02f1f7dcce4a7fc8d1041da5bf0b09f4cf562baeb5dd0d2d676ee6eec7
+  data.tar.gz: 134a10c14a14b716d8be3eff79fffb44fc3f254078a63ac3f00070e5e937ef7523f4b4272b2e838a36357b88862cc643a2d3a5ca9b72295535bdfd1c71cce8f1

data/README.md

@@ -9,22 +9,34 @@ Note: Currently, this Gem is just a PoC (Proof of Concept). If you want to devel
 At this point, playwright-ruby-client doesn't include the downloader of playwright driver, so **we have to install [playwright](https://github.com/microsoft/playwright) in advance**.
 
 ```sh
+npx playwright install
+```
+
+and then, set `playwright_cli_executable_path: "npx playwright"` at `Playwright.create`.
+
+**Prefer npm install instead of npx?**
+
+Actually `npx playwright` is a bit slow. We can also use `npm install` to setup.
+
+Instead of `npx playwright install`:
+
+```
 npm install playwright
 ./node_modules/.bin/playwright install
 ```
 
-and then, set `playwright_cli_executable_path: ./node_modules/.bin/playwright` at `Playwright.create`.
+And set `playwright_cli_executable_path: './node_modules/.bin/playwright'`
 
 **Prefer playwrighting without Node.js?**
 
-Instead of npm install, you can also directly download playwright driver from playwright.azureedge.net/builds/. The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/79f6ce0a6a69c480573372706df84af5ef99c4a4/setup.py#L56-L61)
+Instead of npm, you can also directly download playwright driver from playwright.azureedge.net/builds/. The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/79f6ce0a6a69c480573372706df84af5ef99c4a4/setup.py#L56-L61)
 
 ### Capture a site
 
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: '/path/to/playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
   playwright.chromium.launch(headless: false) do |browser|
     page = browser.new_page
     page.goto('https://github.com/YusukeIwaki')
@@ -40,7 +52,7 @@ end
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
   playwright.chromium.launch(headless: false) do |browser|
     page = browser.new_page
     page.goto('https://github.com/')
@@ -82,7 +94,7 @@ $ bundle exec ruby main.rb
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
   devices = playwright.android.devices
   unless devices.empty?
     device = devices.last

data/docs/api_coverage.md

@@ -19,24 +19,24 @@
 
 ## Response
 
-* ~~body~~
-* ~~finished~~
-* ~~frame~~
-* ~~headers~~
-* ~~json~~
-* ~~ok~~
-* ~~request~~
-* ~~status~~
-* ~~status_text~~
-* ~~text~~
-* ~~url~~
+* body
+* finished
+* frame
+* headers
+* json
+* ok
+* request
+* status
+* status_text
+* text
+* url
 
-## ~~Route~~
+## Route
 
-* ~~abort~~
-* ~~continue_~~
-* ~~fulfill~~
-* ~~request~~
+* abort
+* continue
+* fulfill
+* request
 
 ## ~~WebSocket~~
 
@@ -55,11 +55,11 @@
 
 ## Mouse
 
-* ~~click~~
-* ~~dblclick~~
-* ~~down~~
-* ~~move~~
-* ~~up~~
+* click
+* dblclick
+* down
+* move
+* up
 
 ## Touchscreen
 
@@ -173,6 +173,7 @@
 * expect_navigation
 * wait_for_selector
 * ~~wait_for_timeout~~
+* wait_for_url
 
 ## ~~Worker~~
 
@@ -182,7 +183,7 @@
 
 ## Selectors
 
-* ~~register~~
+* register
 
 ## ConsoleMessage
 
@@ -191,26 +192,13 @@
 * text
 * type
 
-## ~~Dialog~~
-
-* ~~accept~~
-* ~~default_value~~
-* ~~dismiss~~
-* ~~message~~
-* ~~type~~
-
-## Download
-
-* delete
-* failure
-* path
-* save_as
-* suggested_filename
-* url
-
-## ~~Video~~
+## Dialog
 
-* ~~path~~
+* accept
+* default_value
+* dismiss
+* message
+* type
 
 ## Page
 
@@ -258,7 +246,7 @@
 * query_selector
 * query_selector_all
 * reload
-* ~~route~~
+* route
 * screenshot
 * select_option
 * set_content
@@ -272,24 +260,25 @@
 * title
 * type
 * uncheck
-* ~~unroute~~
+* unroute
 * url
-* ~~video~~
+* video
 * viewport_size
+* expect_console_message
+* expect_download
 * expect_event
+* expect_file_chooser
 * wait_for_function
 * wait_for_load_state
 * expect_navigation
+* expect_popup
 * expect_request
 * expect_response
 * wait_for_selector
 * ~~wait_for_timeout~~
-* ~~workers~~
-* ~~expect_download~~
-* ~~expect_popup~~
+* wait_for_url
 * ~~expect_worker~~
-* ~~expect_console_message~~
-* ~~expect_file_chooser~~
+* ~~workers~~
 * ~~wait_for_event~~
 * accessibility
 * keyboard
@@ -298,28 +287,31 @@
 
 ## BrowserContext
 
-* ~~add_cookies~~
-* ~~add_init_script~~
-* ~~browser~~
-* ~~clear_cookies~~
-* ~~clear_permissions~~
+* add_cookies
+* add_init_script
+* ~~background_pages~~
+* browser
+* clear_cookies
+* clear_permissions
 * close
-* ~~cookies~~
-* ~~expose_binding~~
-* ~~expose_function~~
-* ~~grant_permissions~~
+* cookies
+* expose_binding
+* expose_function
+* grant_permissions
+* ~~new_cdp_session~~
 * new_page
 * pages
-* ~~route~~
-* ~~set_default_navigation_timeout~~
-* ~~set_default_timeout~~
-* ~~set_extra_http_headers~~
-* ~~set_geolocation~~
-* ~~set_offline~~
+* route
+* ~~service_workers~~
+* set_default_navigation_timeout
+* set_default_timeout
+* set_extra_http_headers
+* set_geolocation
+* set_offline
 * ~~storage_state~~
-* ~~unroute~~
-* ~~expect_event~~
-* ~~expect_page~~
+* unroute
+* expect_event
+* expect_page
 * ~~wait_for_event~~
 
 ## ~~CDPSession~~
@@ -327,19 +319,16 @@
 * ~~detach~~
 * ~~send_message~~
 
-## ChromiumBrowserContext
-
-* ~~background_pages~~
-* ~~new_cdp_session~~
-* ~~service_workers~~
-
 ## Browser
 
 * close
 * contexts
 * connected?
+* ~~new_browser_cdp_session~~
 * new_context
 * new_page
+* start_tracing
+* stop_tracing
 * version
 
 ## BrowserType
@@ -355,5 +344,58 @@
 * chromium
 * devices
 * firefox
-* ~~selectors~~
+* selectors
 * webkit
+
+## Android
+
+* devices
+* ~~set_default_timeout~~
+
+## AndroidDevice
+
+* close
+* ~~drag~~
+* ~~fill~~
+* ~~fling~~
+* info
+* ~~install_apk~~
+* launch_browser
+* ~~long_tap~~
+* model
+* ~~open~~
+* ~~pinch_close~~
+* ~~pinch_open~~
+* ~~press~~
+* ~~push~~
+* screenshot
+* ~~scroll~~
+* serial
+* ~~set_default_timeout~~
+* shell
+* ~~swipe~~
+* ~~tap_point~~
+* ~~wait~~
+* ~~wait_for_event~~
+* ~~web_view~~
+* ~~web_views~~
+* input
+
+## AndroidInput
+
+* drag
+* press
+* ~~swipe~~
+* tap_point
+* type
+
+## ~~AndroidSocket~~
+
+* ~~close~~
+* ~~write~~
+
+## ~~AndroidWebView~~
+
+* ~~page~~
+* ~~pid~~
+* ~~pkg~~

data/lib/playwright.rb

@@ -17,14 +17,17 @@ require 'playwright/utils'
 require 'playwright/api_implementation'
 require 'playwright/channel'
 require 'playwright/channel_owner'
+require 'playwright/download'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
+require 'playwright/route_handler_entry'
 require 'playwright/select_option_values'
 require 'playwright/timeout_settings'
 require 'playwright/transport'
 require 'playwright/url_matcher'
 require 'playwright/version'
+require 'playwright/video'
 require 'playwright/wait_helper'
 
 require 'playwright/playwright_api'
@@ -32,18 +35,54 @@ require 'playwright/playwright_api'
 Dir[File.join(__dir__, 'playwright_api', '*.rb')].each { |f| require f }
 
 module Playwright
-  module_function def create(playwright_cli_executable_path:, &block)
-    raise ArgumentError.new("block must be provided") unless block
+  class Execution
+    def initialize(connection, playwright)
+      @connection = connection
+      @playwright = playwright
+    end
+
+    def stop
+      @connection.stop
+    end
+
+    attr_reader :playwright
+  end
 
+  # Recommended to call this method with block.
+  #
+  # Playwright.create(...) do |playwright|
+  #   browser = playwright.chromium.launch
+  #   ...
+  # end
+  #
+  # When we use this method without block, an instance of Puppeteer::Execution is returned
+  # and we *must* call execution.stop on the end.
+  # The instance of playwright is available by calling execution.playwright
+  module_function def create(playwright_cli_executable_path:, &block)
     connection = Connection.new(playwright_cli_executable_path: playwright_cli_executable_path)
+    connection.async_run
+
+    execution =
+      begin
+        playwright = connection.wait_for_object_with_known_name('Playwright')
+        Execution.new(connection, PlaywrightApi.wrap(playwright))
+      rescue
+        connection.stop
+        raise
+      end
 
-    playwright_promise = connection.async_wait_for_object_with_known_name('Playwright')
-    Thread.new { connection.run }
-    playwright = PlaywrightApi.wrap(playwright_promise.value!)
-    begin
-      block.call(playwright)
-    ensure
-      connection.stop
+    if block
+      begin
+        block.call(execution.playwright)
+      ensure
+        execution.stop
+      end
+    else
+      execution
     end
   end
+
+  module_function def instance
+    @playwright_instance
+  end
 end

data/lib/playwright/channel.rb

@@ -15,8 +15,9 @@ module Playwright
 
     # @param method [String]
     # @param params [Hash]
+    # @return [Playwright::ChannelOwner|nil]
     def send_message_to_server(method, params = {})
-      result = @connection.send_message_to_server(@guid, method, params)
+      result = send_message_to_server_result(method, params)
       if result.is_a?(Hash)
         _type, channel_owner = result.first
         channel_owner
@@ -27,8 +28,17 @@ module Playwright
 
     # @param method [String]
     # @param params [Hash]
-    def send_no_reply(method, params)
+    # @return [Hash]
+    def send_message_to_server_result(method, params)
+      @connection.send_message_to_server(@guid, method, params)
+    end
+
+    # @param method [String]
+    # @param params [Hash]
+    # @returns nil
+    def async_send_message_to_server(method, params = {})
       @connection.async_send_message_to_server(@guid, method, params)
+
       nil
     end
   end