playwright-ruby-client 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8cc3ad6fb1bd9c8a42f249085e91f92dbed26ebcbbd310559810299b60ea31
-  data.tar.gz: 6fb3450345d6f7bcbcbb19e3206244739f8aecf0813a94216e58df03674fb8e1
+  metadata.gz: 4e87b002bd3cd1dfaf592f6be37902b0a0604553d419b8b7516e0e887584125a
+  data.tar.gz: 5b956c57000f12dc8399df4382dd301a7ef1d47551782afff0fae0871892c630
 SHA512:
-  metadata.gz: b4e12e990b3a9df4532154ad62d6064c343664b75d8f29d088e6c28c00b5f22608d3de49c3568af2e2ac8689e9d9769e478e36571e7921d928c21eb3a18d9a56
-  data.tar.gz: 49f939af824f3affd9bbb011eb389238d5484a3f320fed6ad170bfb8c011ac351f6dba239f4e685d6b9058f4b72461fd5d1b5aee98835e34948eeef90b535dbc
+  metadata.gz: e3a418d6d40392a157016b164455e8cdc83bffb696c182d68d2ce10cb1e7315be151fb4be78e5b985871ba75ef1882be262d05c93a0b3a65a3c3b8b9c7373fb2
+  data.tar.gz: db086e5ff1cdbc8cee9d1aea80601e2f9664c4806478aa556fd91e6b647bc71d23b9f0862ed60711365e06e67d513717c5e01b3d7b60c1a5b9438535ef8394e5

data/documentation/docs/api/browser.md

@@ -41,6 +41,10 @@ were opened).
 In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the
 browser server.
 
+> NOTE: This is similar to force quitting the browser. Therefore, you should call [BrowserContext#close](./browser_context#close) on
+any [BrowserContext](./browser_context)'s you explicitly created earlier with [Browser#new_context](./browser#new_context) **before** calling
+[Browser#close](./browser#close).
+
 The [Browser](./browser) object itself is considered to be disposed and cannot be used anymore.
 
 ## contexts
@@ -121,14 +125,19 @@ def new_context(
 
 Creates a new browser context. It won't share cookies/cache with other browser contexts.
 
+> NOTE: If directly using this method to create [BrowserContext](./browser_context)s, it is best practice to explicilty close the returned
+context via [BrowserContext#close](./browser_context#close) when your code is done with the [BrowserContext](./browser_context), and before calling
+[Browser#close](./browser#close). This will ensure the `context` is closed gracefully and any artifacts—like HARs and
+videos—are fully flushed and saved.
+
 ```ruby
 playwright.firefox.launch do |browser| # or "chromium.launch" or "webkit.launch".
   # create a new incognito browser context.
-  context = browser.new_context
-
-  # create a new page in a pristine context.
-  page = context.new_page()
-  page.goto("https://example.com")
+  browser.new_context do |context|
+    # create a new page in a pristine context.
+    page = context.new_page
+    page.goto("https://example.com")
+  end
 end
 ```
 

data/documentation/docs/api/browser_context.md

@@ -23,7 +23,7 @@ page = context.new_page
 page.goto("https://example.com")
 
 # dispose context once it is no longer needed.
-context.close()
+context.close
 ```
 
 
@@ -161,7 +161,7 @@ page.content = <<~HTML
 <div></div>
 HTML
 
-page.click("button")
+page.locator("button").click
 ```
 
 An example of passing an element handle:
@@ -184,7 +184,7 @@ page.content = <<~HTML
 <div>Or click me</div>
 HTML
 
-page.click('div')
+page.locator('div').first.click
 ```
 
 
@@ -222,7 +222,7 @@ page.content = <<~HTML
 <button onclick="onClick()">Click me</button>
 <div></div>
 HTML
-page.click("button")
+page.locator("button").click
 ```
 
 
@@ -434,7 +434,7 @@ value. Will throw an error if the context closes before the event is fired. Retu
 
 ```ruby
 new_page = browser_context.expect_event('page') do
-  page.click('button')
+  page.locator('button').click
 end
 ```
 

data/documentation/docs/api/download.md

@@ -12,7 +12,7 @@ Download event is emitted once the download starts. Download path becomes availa
 
 ```ruby
 download = page.expect_download do
-  page.click('a')
+  page.locator('a').click
 end
 
 # wait for download to complete

data/documentation/docs/api/element_handle.md

@@ -55,7 +55,7 @@ def bounding_box
 This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
 calculated relative to the main frame viewport - which is usually the same as the browser window.
 
-Scrolling affects the returned bonding box, similarly to
+Scrolling affects the returned bounding box, similarly to
 [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect). That
 means `x` and/or `y` may be negative.
 

data/documentation/docs/api/file_chooser.md

@@ -8,7 +8,7 @@ sidebar_position: 10
 
 ```ruby
 file_chooser = page.expect_file_chooser do
-  page.click("upload") # action to trigger file uploading
+  page.locator("upload").click # action to trigger file uploading
 end
 file_chooser.set_files("myfile.pdf")
 ```

data/documentation/docs/api/locator.md

@@ -34,7 +34,7 @@ def bounding_box(timeout: nil)
 This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
 calculated relative to the main frame viewport - which is usually the same as the browser window.
 
-Scrolling affects the returned bonding box, similarly to
+Scrolling affects the returned bounding box, similarly to
 [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect). That
 means `x` and/or `y` may be negative.
 
@@ -342,6 +342,7 @@ locator.click
 ```
 def get_attribute(name, timeout: nil)
 ```
+alias: `[]`
 
 Returns element attribute value.
 

data/documentation/docs/api/page.md

@@ -462,7 +462,7 @@ page.content = <<~HTML
 <button onclick="onClick()">Click me</button>
 <div></div>
 HTML
-page.click("button")
+page.locator("button").click
 ```
 
 An example of passing an element handle:
@@ -483,7 +483,7 @@ page.content = <<~HTML
 <div>Or click me</div>
 HTML
 
-page.click('div')
+page.locator('div').first.click
 ```
 
 
@@ -522,7 +522,7 @@ page.content = <<~HTML
 <button onclick="onClick()">Click me</button>
 <div></div>
 HTML
-page.click("button")
+page.locator("button").click
 ```
 
 

data/documentation/docs/api/route.md

@@ -47,7 +47,7 @@ def fallback(headers: nil, method: nil, postData: nil, url: nil)
 ```
 
 When several routes match the given pattern, they run in the order opposite to their registration. That way the last
-registered route can always override all the previos ones. In the example below, request will be handled by the
+registered route can always override all the previous ones. In the example below, request will be handled by the
 bottom-most handler first, then it'll fall back to the previous one and in the end will be aborted by the first
 registered route.
 

data/documentation/docs/api/selectors.md

@@ -36,9 +36,9 @@ playwright.chromium.launch do |browser|
   page.content = '<div><button>Click me</button></div>'
 
   # Use the selector prefixed with its name.
-  button = page.query_selector('tag=button')
+  button = page.locator('tag=button')
   # Combine it with other selector engines.
-  page.click('tag=div >> text="Click me"')
+  page.locator('tag=div >> text="Click me"').click
 
   # Can use it in any methods supporting selectors.
   button_count = page.locator('tag=button').count

data/documentation/docs/api/tracing.md

@@ -58,7 +58,7 @@ page = context.new_page
 page.goto("https://playwright.dev")
 
 context.tracing.start_chunk
-page.click("text=Get Started")
+page.locator("text=Get Started").click
 # Everything between start_chunk and stop_chunk will be recorded in the trace.
 context.tracing.stop_chunk(path: "trace1.zip")
 

data/documentation/package.json

@@ -14,11 +14,11 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.18",
-    "@docusaurus/preset-classic": "^2.0.0-beta.18",
+    "@docusaurus/core": "^2.0.1",
+    "@docusaurus/preset-classic": "^2.0.1",
     "@mdx-js/react": "^1.6.22",
-    "@svgr/webpack": "^6.2.1",
-    "clsx": "^1.1.1",
+    "@svgr/webpack": "^6.3.1",
+    "clsx": "^1.2.1",
     "file-loader": "^6.2.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",