playwright-ruby-client 1.25.0 → 1.27.0

data/lib/playwright_api/frame_locator.rb

@@ -11,14 +11,14 @@ module Playwright
   # **Strictness**
   #
   # Frame locators are strict. This means that all operations on frame locators will throw if more than one element matches
-  # given selector.
+  # a given selector.
   #
   # ```python sync
   # # Throws if there are several frames in DOM:
-  # page.frame_locator('.result-frame').locator('button').click()
+  # page.frame_locator('.result-frame').get_by_role('button').click()
   #
   # # Works because we explicitly tell locator to pick the first frame:
-  # page.frame_locator('.result-frame').first.locator('button').click()
+  # page.frame_locator('.result-frame').first.get_by_role('button').click()
   # ```
   #
   # **Converting Locator to FrameLocator**
@@ -42,12 +42,87 @@ module Playwright
       wrap_impl(@impl.frame_locator(unwrap_impl(selector)))
     end
 
+    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    #
+    # ```html
+    # <img alt='Castle'>
+    # ```
+    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:
+    #
+    # ```html
+    # <label for="password-input">Password:</label>
+    # <input id="password-input">
+    # ```
+    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":
+    #
+    # ```html
+    # <input placeholder="Country">
+    # ```
+    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.
+    #
+    # 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.
+    def get_by_role(
+          role,
+          checked: nil,
+          disabled: nil,
+          expanded: nil,
+          includeHidden: nil,
+          level: nil,
+          name: nil,
+          pressed: nil,
+          selected: nil)
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+    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.
+    def get_by_test_id(testId)
+      wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
+    end
+
+    # Allows locating elements that contain given text.
+    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 "Submit":
+    #
+    # ```html
+    # <button title='Place the order'>Order Now</button>
+    # ```
+    def get_by_title(text, exact: nil)
+      wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
     # Returns locator to the last matching frame.
     def last
       wrap_impl(@impl.last)
     end
 
-    # The method finds an element matching the specified selector in the FrameLocator's subtree.
+    # The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options,
+    # similar to [`method: Locator.filter`] method.
+    #
+    # [Learn more about locators](../locators.md).
     def locator(selector, has: nil, hasText: nil)
       wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end

data/lib/playwright_api/locator.rb

@@ -142,6 +142,21 @@ module Playwright
       wrap_impl(@impl.dispatch_event(unwrap_impl(type), eventInit: unwrap_impl(eventInit), timeout: unwrap_impl(timeout)))
     end
 
+    # This method drags the locator to another target locator or target position. It will first move to the source element,
+    # perform a `mousedown`, then move to the target element or position and perform a `mouseup`.
+    #
+    # ```python sync
+    # source = page.locator("#source")
+    # target = page.locator("#target")
+    #
+    # source.drag_to(target)
+    # # or specify exact positions relative to the top-left corners of the elements:
+    # source.drag_to(
+    #   target,
+    #   source_position={"x": 34, "y": 7},
+    #   target_position={"x": 10, "y": 20}
+    # )
+    # ```
     def drag_to(
           target,
           force: nil,
@@ -232,7 +247,7 @@ module Playwright
     # # ...
     # row_locator
     #     .filter(has_text="text in column 1")
-    #     .filter(has=page.locator("tr", has_text="column 2 button"))
+    #     .filter(has=page.get_by_role("button", name="column 2 button"))
     #     .screenshot()
     # ```
     def filter(has: nil, hasText: nil)
@@ -253,7 +268,7 @@ module Playwright
     # that iframe:
     #
     # ```python sync
-    # locator = page.frame_locator("iframe").locator("text=Submit")
+    # locator = page.frame_locator("iframe").get_by_text("Submit")
     # locator.click()
     # ```
     def frame_locator(selector)
@@ -266,6 +281,78 @@ module Playwright
     end
     alias_method :[], :get_attribute
 
+    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    #
+    # ```html
+    # <img alt='Castle'>
+    # ```
+    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:
+    #
+    # ```html
+    # <label for="password-input">Password:</label>
+    # <input id="password-input">
+    # ```
+    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":
+    #
+    # ```html
+    # <input placeholder="Country">
+    # ```
+    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.
+    #
+    # 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.
+    def get_by_role(
+          role,
+          checked: nil,
+          disabled: nil,
+          expanded: nil,
+          includeHidden: nil,
+          level: nil,
+          name: nil,
+          pressed: nil,
+          selected: nil)
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+    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.
+    def get_by_test_id(testId)
+      wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
+    end
+
+    # Allows locating elements that contain given text.
+    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 "Submit":
+    #
+    # ```html
+    # <button title='Place the order'>Order Now</button>
+    # ```
+    def get_by_title(text, exact: nil)
+      wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
     # Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses
     # [`method: Locator.highlight`].
     def highlight
@@ -344,8 +431,10 @@ module Playwright
       wrap_impl(@impl.last)
     end
 
-    # The method finds an element matching the specified selector in the `Locator`'s subtree. It also accepts filter options,
+    # The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options,
     # similar to [`method: Locator.filter`] method.
+    #
+    # [Learn more about locators](../locators.md).
     def locator(selector, has: nil, hasText: nil)
       wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
@@ -524,8 +613,8 @@ module Playwright
     # An example of typing into a text field and then submitting the form:
     #
     # ```python sync
-    # element = page.locator("input")
-    # element.type("some text")
+    # element = page.get_by_label("Password")
+    # element.type("my password")
     # element.press("Enter")
     # ```
     def type(text, delay: nil, noWaitAfter: nil, timeout: nil)

data/lib/playwright_api/page.rb

@@ -250,6 +250,19 @@ module Playwright
       wrap_impl(@impl.dispatch_event(unwrap_impl(selector), unwrap_impl(type), eventInit: unwrap_impl(eventInit), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # This method drags the source element to the target element. It will first move to the source element, perform a
+    # `mousedown`, then move to the target element and perform a `mouseup`.
+    #
+    # ```python sync
+    # page.drag_and_drop("#source", "#target")
+    # # or specify exact positions relative to the top-left corners of the elements:
+    # page.drag_and_drop(
+    #   "#source",
+    #   "#target",
+    #   source_position={"x": 34, "y": 7},
+    #   target_position={"x": 10, "y": 20}
+    # )
+    # ```
     def drag_and_drop(
           source,
           target,
@@ -553,7 +566,7 @@ module Playwright
     # id="my-frame">`:
     #
     # ```python sync
-    # locator = page.frame_locator("#my-iframe").locator("text=Submit")
+    # locator = page.frame_locator("#my-iframe").get_by_text("Submit")
     # locator.click()
     # ```
     def frame_locator(selector)
@@ -570,6 +583,78 @@ module Playwright
       wrap_impl(@impl.get_attribute(unwrap_impl(selector), unwrap_impl(name), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    #
+    # ```html
+    # <img alt='Castle'>
+    # ```
+    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:
+    #
+    # ```html
+    # <label for="password-input">Password:</label>
+    # <input id="password-input">
+    # ```
+    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":
+    #
+    # ```html
+    # <input placeholder="Country">
+    # ```
+    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.
+    #
+    # 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.
+    def get_by_role(
+          role,
+          checked: nil,
+          disabled: nil,
+          expanded: nil,
+          includeHidden: nil,
+          level: nil,
+          name: nil,
+          pressed: nil,
+          selected: nil)
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+    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.
+    def get_by_test_id(testId)
+      wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
+    end
+
+    # Allows locating elements that contain given text.
+    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 "Submit":
+    #
+    # ```html
+    # <button title='Place the order'>Order Now</button>
+    # ```
+    def get_by_title(text, exact: nil)
+      wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
     # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
     # last redirect. If can not go back, returns `null`.
     #
@@ -688,13 +773,11 @@ module Playwright
       wrap_impl(@impl.visible?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # The method returns an element locator that can be used to perform actions on the page. Locator is resolved to the
-    # element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
-    # different DOM elements. That would happen if the DOM structure between those actions has changed.
+    # The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved to
+    # the element immediately before performing an action, so a series of actions on the same locator can in fact be performed
+    # on different DOM elements. That would happen if the DOM structure between those actions has changed.
     #
     # [Learn more about locators](../locators.md).
-    #
-    # Shortcut for main frame's [`method: Frame.locator`].
     def locator(selector, has: nil, hasText: nil)
       wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
@@ -1177,7 +1260,7 @@ module Playwright
     #
     # ```python sync
     # with page.expect_event("framenavigated") as event_info:
-    #     page.click("button")
+    #     page.get_by_role("button")
     # frame = event_info.value
     # ```
     def expect_event(event, predicate: nil, timeout: nil, &block)
@@ -1228,13 +1311,13 @@ module Playwright
     # when this method is called. If current document has already reached the required state, resolves immediately.
     #
     # ```python sync
-    # page.click("button") # click triggers navigation.
+    # page.get_by_role("button").click() # click triggers navigation.
     # page.wait_for_load_state() # the promise resolves after "load" event.
     # ```
     #
     # ```python sync
     # with page.expect_popup() as page_info:
-    #     page.click("button") # click triggers a popup.
+    #     page.get_by_role("button").click() # click triggers a popup.
     # popup = page_info.value
     #  # Following resolves after "domcontentloaded" event.
     # popup.wait_for_load_state("domcontentloaded")
@@ -1321,7 +1404,7 @@ module Playwright
     # `detached`.
     #
     # > NOTE: Playwright automatically waits for element to be ready before performing an action. Using `Locator` objects and
-    # web-first assertions make the code wait-for-selector-free.
+    # web-first assertions makes the code wait-for-selector-free.
     #
     # Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
     # the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the

data/lib/playwright_api/request.rb

@@ -152,13 +152,13 @@ module Playwright
     end
 
     # @nodoc
-    def apply_fallback_overrides(overrides)
-      wrap_impl(@impl.apply_fallback_overrides(unwrap_impl(overrides)))
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
     end
 
     # @nodoc
-    def header_values(name)
-      wrap_impl(@impl.header_values(unwrap_impl(name)))
+    def apply_fallback_overrides(overrides)
+      wrap_impl(@impl.apply_fallback_overrides(unwrap_impl(overrides)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/response.rb

@@ -101,13 +101,13 @@ module Playwright
     end
 
     # @nodoc
-    def from_service_worker?
-      wrap_impl(@impl.from_service_worker?)
+    def ok?
+      wrap_impl(@impl.ok?)
     end
 
     # @nodoc
-    def ok?
-      wrap_impl(@impl.ok?)
+    def from_service_worker?
+      wrap_impl(@impl.from_service_worker?)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/selectors.rb

@@ -43,6 +43,17 @@ module Playwright
       wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
     end
 
+    # Defines custom attribute name to be used in [`method: Page.getByTestId`]. `data-testid` is used by default.
+    def set_test_id_attribute(attributeName)
+      raise NotImplementedError.new('set_test_id_attribute is not implemented yet.')
+    end
+    alias_method :test_id_attribute=, :set_test_id_attribute
+
+    # @nodoc
+    def text_id_attribute=(attribute_name)
+      wrap_impl(@impl.text_id_attribute=(unwrap_impl(attribute_name)))
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)

data/lib/playwright_api/tracing.rb

@@ -41,7 +41,7 @@ module Playwright
     # page.goto("https://playwright.dev")
     #
     # context.tracing.start_chunk()
-    # page.locator("text=Get Started").click()
+    # page.get_by_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/lib/playwright_api/worker.rb

@@ -44,13 +44,13 @@ module Playwright
     end
 
     # @nodoc
-    def page=(req)
-      wrap_impl(@impl.page=(unwrap_impl(req)))
+    def context=(req)
+      wrap_impl(@impl.context=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def context=(req)
-      wrap_impl(@impl.context=(unwrap_impl(req)))
+    def page=(req)
+      wrap_impl(@impl.page=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.27.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-14 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -327,6 +327,7 @@ files:
 - lib/playwright/javascript/visitor_info.rb
 - lib/playwright/keyboard_impl.rb
 - lib/playwright/locator_impl.rb
+- lib/playwright/locator_utils.rb
 - lib/playwright/mouse_impl.rb
 - lib/playwright/playwright_api.rb
 - lib/playwright/raw_headers.rb
@@ -399,5 +400,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.25.0
+summary: The Ruby binding of playwright driver 1.27.0
 test_files: []