playwright-ruby-client 1.29.1 → 1.30.beta1

data/lib/playwright_api/page.rb

@@ -596,40 +596,93 @@ module Playwright
     end
 
     #
-    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    # Allows locating elements by their alt text.
+    #
+    # **Usage**
+    #
+    # For example, this method will find the image by alt text "Playwright logo":
     #
     # ```html
-    # <img alt='Castle'>
+    # <img alt='Playwright logo'>
+    # ```
+    #
+    # ```python sync
+    # page.get_by_alt_text("Playwright logo").click()
     # ```
     def get_by_alt_text(text, exact: nil)
       wrap_impl(@impl.get_by_alt_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
     #
-    # Allows locating input elements by the text of the associated label. For example, this method will find the input by label text "Password" in the following DOM:
+    # Allows locating input elements by the text of the associated label.
+    #
+    # **Usage**
+    #
+    # For example, this method will find the input by label text "Password" in the following DOM:
     #
     # ```html
     # <label for="password-input">Password:</label>
     # <input id="password-input">
     # ```
+    #
+    # ```python sync
+    # page.get_by_label("Password").fill("secret")
+    # ```
     def get_by_label(text, exact: nil)
       wrap_impl(@impl.get_by_label(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
     #
-    # Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder "Country":
+    # Allows locating input elements by the placeholder text.
+    #
+    # **Usage**
+    #
+    # For example, consider the following DOM structure.
     #
     # ```html
-    # <input placeholder="Country">
+    # <input type="email" placeholder="name@example.com" />
+    # ```
+    #
+    # You can fill the input after locating it by the placeholder text:
+    #
+    # ```python sync
+    # page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
     # ```
     def get_by_placeholder(text, exact: nil)
       wrap_impl(@impl.get_by_placeholder(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
     #
-    # Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles), [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). Note that role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
+    # Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles), [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
+    #
+    # **Usage**
+    #
+    # Consider the following DOM structure.
+    #
+    # ```html
+    # <h3>Sign up</h3>
+    # <label>
+    #   <input type="checkbox" /> Subscribe
+    # </label>
+    # <br/>
+    # <button>Submit</button>
+    # ```
+    #
+    # You can locate each element by it's implicit role:
+    #
+    # ```python sync
+    # expect(page.get_by_role("heading", name="Sign up")).to_be_visible()
+    #
+    # page.get_by_role("checkbox", name="Subscribe").check()
     #
-    # Note that many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings) that is recognized by the role selector. You can find all the [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend** duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
+    # page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()
+    # ```
+    #
+    # **Details**
+    #
+    # Role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
+    #
+    # Many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings) that is recognized by the role selector. You can find all the [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend** duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
     def get_by_role(
           role,
           checked: nil,
@@ -645,13 +698,37 @@ module Playwright
     end
 
     #
-    # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
+    # Locate element by the test id.
+    #
+    # **Usage**
+    #
+    # Consider the following DOM structure.
+    #
+    # ```html
+    # <button data-testid="directions">Itinéraire</button>
+    # ```
+    #
+    # You can locate the element by it's test id:
+    #
+    # ```python sync
+    # page.get_by_test_id("directions").click()
+    # ```
+    #
+    # **Details**
+    #
+    # By default, the `data-testid` attribute is used as a test id. Use [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
 
     #
-    # Allows locating elements that contain given text. Consider the following DOM structure:
+    # Allows locating elements that contain given text.
+    #
+    # See also [`method: Locator.filter`] that allows to match by another criteria, like an accessible role, and then filter by the text content.
+    #
+    # **Usage**
+    #
+    # Consider the following DOM structure:
     #
     # ```html
     # <div>Hello <span>world</span></div>
@@ -677,20 +754,30 @@ module Playwright
     # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
     # ```
     #
-    # See also [`method: Locator.filter`] that allows to match by another criteria, like an accessible role, and then filter by the text content.
+    # **Details**
     #
-    # **NOTE**: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.
+    # Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.
     #
-    # **NOTE**: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
+    # Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
     def get_by_text(text, exact: nil)
       wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
     #
-    # Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
+    # Allows locating elements by their title attribute.
+    #
+    # **Usage**
+    #
+    # Consider the following DOM structure.
     #
     # ```html
-    # <button title='Place the order'>Order Now</button>
+    # <span title='Issues count'>25 issues</span>
+    # ```
+    #
+    # You can check the issues count after locating it by the title text:
+    #
+    # ```python sync
+    # expect(page.get_by_title("Issues count")).to_have_text("25 issues")
     # ```
     def get_by_title(text, exact: nil)
       wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))

data/lib/playwright_api/route.rb

@@ -99,7 +99,7 @@ module Playwright
     #
     # ```python sync
     # def handle(route):
-    #     response = route.fulfill()
+    #     response = route.fetch()
     #     json = response.json()
     #     json["message"]["big_red_dog"] = []
     #     route.fulfill(response=response, json=json)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.29.1
+  version: 1.30.beta1
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -394,12 +394,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.29.2
+summary: The Ruby binding of playwright driver 1.30.0
 test_files: []