playwright-ruby-client 0.0.7 → 0.2.1

data/lib/playwright_api/chromium_browser_context.rb

@@ -11,12 +11,10 @@ module Playwright
   # ```
   # 
   # ```python async
-  # # FIXME
   # background_page = await context.wait_for_event("backgroundpage")
   # ```
   # 
   # ```python sync
-  # # FIXME
   # background_page = context.wait_for_event("backgroundpage")
   # ```
   class ChromiumBrowserContext < BrowserContext
@@ -38,20 +36,24 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/console_message.rb

@@ -23,20 +23,24 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/dialog.rb

@@ -42,7 +42,6 @@ module Playwright
   # ```
   # 
   # ```python sync
-  # # FIXME
   # from playwright.sync_api import sync_playwright
   # 
   # def handle_dialog(dialog):
@@ -60,6 +59,11 @@ module Playwright
   # with sync_playwright() as playwright:
   #     run(playwright)
   # ```
+  # 
+  # > NOTE: Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener. When listener is
+  # present, it **must** either [`method: Dialog.accept`] or [`method: Dialog.dismiss`] the dialog - otherwise the page will
+  # [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog, and
+  # actions like click will never finish.
   class Dialog < PlaywrightApi
 
     # Returns when the dialog has been accepted.

data/lib/playwright_api/download.rb

@@ -37,29 +37,24 @@ module Playwright
   # performed and user has no access to the downloaded files.
   class Download < PlaywrightApi
 
-    # Returns readable stream for current download or `null` if download failed.
-    def create_read_stream
-      raise NotImplementedError.new('create_read_stream is not implemented yet.')
-    end
-
     # Deletes the downloaded file.
     def delete
-      raise NotImplementedError.new('delete is not implemented yet.')
+      wrap_impl(@impl.delete)
     end
 
     # Returns download error if any.
     def failure
-      raise NotImplementedError.new('failure is not implemented yet.')
+      wrap_impl(@impl.failure)
     end
 
     # Returns path to the downloaded file in case of successful download.
     def path
-      raise NotImplementedError.new('path is not implemented yet.')
+      wrap_impl(@impl.path)
     end
 
     # Saves the download to a user-specified path.
     def save_as(path)
-      raise NotImplementedError.new('save_as is not implemented yet.')
+      wrap_impl(@impl.save_as(unwrap_impl(path)))
     end
 
     # Returns suggested filename for this download. It is typically computed by the browser from the
@@ -67,12 +62,34 @@ module Playwright
     # or the `download` attribute. See the spec on [whatwg](https://html.spec.whatwg.org/#downloading-resources). Different
     # browsers can use different logic for computing it.
     def suggested_filename
-      raise NotImplementedError.new('suggested_filename is not implemented yet.')
+      wrap_impl(@impl.suggested_filename)
     end
 
     # Returns downloaded url.
     def url
-      raise NotImplementedError.new('url is not implemented yet.')
+      wrap_impl(@impl.url)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/element_handle.rb

@@ -3,7 +3,8 @@ require_relative './js_handle.rb'
 module Playwright
   # - extends: `JSHandle`
   # 
-  # ElementHandle represents an in-page DOM element. ElementHandles can be created with the [`method: Page.$`] method.
+  # ElementHandle represents an in-page DOM element. ElementHandles can be created with the [`method: Page.querySelector`]
+  # method.
   # 
   #
   # ```js
@@ -57,92 +58,10 @@ module Playwright
   # ElementHandle prevents DOM element from garbage collection unless the handle is disposed with
   # [`method: JSHandle.dispose`]. ElementHandles are auto-disposed when their origin frame gets navigated.
   # 
-  # ElementHandle instances can be used as an argument in [`method: Page.$eval`] and [`method: Page.evaluate`] methods.
+  # ElementHandle instances can be used as an argument in [`method: Page.evalOnSelector`] and [`method: Page.evaluate`]
+  # methods.
   class ElementHandle < JSHandle
 
-    # The method finds an element matching the specified selector in the `ElementHandle`'s subtree. See
-    # [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements match the selector,
-    # returns `null`.
-    def query_selector(selector)
-      wrap_impl(@impl.query_selector(unwrap_impl(selector)))
-    end
-
-    # The method finds all elements matching the specified selector in the `ElementHandle`s subtree. See
-    # [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements match the selector,
-    # returns empty array.
-    def query_selector_all(selector)
-      wrap_impl(@impl.query_selector_all(unwrap_impl(selector)))
-    end
-
-    # Returns the return value of `pageFunction`
-    # 
-    # The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a first
-    # argument to `pageFunction`. See [Working with selectors](./selectors.md#working-with-selectors) for more details. If no
-    # elements match the selector, the method throws an error.
-    # 
-    # If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value.
-    # 
-    # Examples:
-    # 
-    #
-    # ```js
-    # const tweetHandle = await page.$('.tweet');
-    # expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
-    # expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');
-    # ```
-    # 
-    # ```python async
-    # tweet_handle = await page.query_selector(".tweet")
-    # assert await tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
-    # assert await tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "10"
-    # ```
-    # 
-    # ```python sync
-    # tweet_handle = page.query_selector(".tweet")
-    # assert tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
-    # assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "10"
-    # ```
-    def eval_on_selector(selector, pageFunction, arg: nil)
-      wrap_impl(@impl.eval_on_selector(unwrap_impl(selector), unwrap_impl(pageFunction), arg: unwrap_impl(arg)))
-    end
-
-    # Returns the return value of `pageFunction`
-    # 
-    # The method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array of
-    # matched elements as a first argument to `pageFunction`. See
-    # [Working with selectors](./selectors.md#working-with-selectors) for more details.
-    # 
-    # If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value.
-    # 
-    # Examples:
-    # 
-    # ```html
-    # <div class="feed">
-    #   <div class="tweet">Hello!</div>
-    #   <div class="tweet">Hi!</div>
-    # </div>
-    # ```
-    # 
-    #
-    # ```js
-    # const feedHandle = await page.$('.feed');
-    # expect(await feedHandle.$$eval('.tweet', nodes => nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!']);
-    # ```
-    # 
-    # ```python async
-    # # FIXME
-    # feed_handle = await page.query_selector(".feed")
-    # assert await feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]
-    # ```
-    # 
-    # ```python sync
-    # feed_handle = page.query_selector(".feed")
-    # assert feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]
-    # ```
-    def eval_on_selector_all(selector, pageFunction, arg: nil)
-      wrap_impl(@impl.eval_on_selector_all(unwrap_impl(selector), unwrap_impl(pageFunction), arg: unwrap_impl(arg)))
-    end
-
     # 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.
     # 
@@ -296,9 +215,80 @@ module Playwright
       wrap_impl(@impl.dispatch_event(unwrap_impl(type), eventInit: unwrap_impl(eventInit)))
     end
 
+    # Returns the return value of `expression`.
+    # 
+    # The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a first
+    # argument to `expression`. See [Working with selectors](./selectors.md) for more details. If no elements match the
+    # selector, the method throws an error.
+    # 
+    # If `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelector`] would wait for the promise to resolve
+    # and return its value.
+    # 
+    # Examples:
+    # 
+    #
+    # ```js
+    # const tweetHandle = await page.$('.tweet');
+    # expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
+    # expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');
+    # ```
+    # 
+    # ```python async
+    # tweet_handle = await page.query_selector(".tweet")
+    # assert await tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
+    # assert await tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "10"
+    # ```
+    # 
+    # ```python sync
+    # tweet_handle = page.query_selector(".tweet")
+    # assert tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
+    # assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "10"
+    # ```
+    def eval_on_selector(selector, expression, arg: nil)
+      wrap_impl(@impl.eval_on_selector(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
+    end
+
+    # Returns the return value of `expression`.
+    # 
+    # The method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array of
+    # matched elements as a first argument to `expression`. See [Working with selectors](./selectors.md) for more details.
+    # 
+    # If `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelectorAll`] would wait for the promise to
+    # resolve and return its value.
+    # 
+    # Examples:
+    # 
+    # ```html
+    # <div class="feed">
+    #   <div class="tweet">Hello!</div>
+    #   <div class="tweet">Hi!</div>
+    # </div>
+    # ```
+    # 
+    #
+    # ```js
+    # const feedHandle = await page.$('.feed');
+    # expect(await feedHandle.$$eval('.tweet', nodes => nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!']);
+    # ```
+    # 
+    # ```python async
+    # feed_handle = await page.query_selector(".feed")
+    # assert await feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]
+    # ```
+    # 
+    # ```python sync
+    # feed_handle = page.query_selector(".feed")
+    # assert feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]
+    # ```
+    def eval_on_selector_all(selector, expression, arg: nil)
+      wrap_impl(@impl.eval_on_selector_all(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
+    end
+
     # This method waits for [actionability](./actionability.md) checks, focuses the element, fills it and triggers an `input`
-    # event after filling. If the element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws
-    # an error. Note that you can pass an empty string to clear the input field.
+    # event after filling. If the element is inside the `<label>` element that has associated
+    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), that control will be filled
+    # instead. If the element to be filled is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method
+    # throws an error. Note that you can pass an empty string to clear the input field.
     def fill(value, noWaitAfter: nil, timeout: nil)
       wrap_impl(@impl.fill(unwrap_impl(value), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
     end
@@ -395,6 +385,18 @@ module Playwright
       wrap_impl(@impl.press(unwrap_impl(key), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
     end
 
+    # The method finds an element matching the specified selector in the `ElementHandle`'s subtree. See
+    # [Working with selectors](./selectors.md) for more details. If no elements match the selector, returns `null`.
+    def query_selector(selector)
+      wrap_impl(@impl.query_selector(unwrap_impl(selector)))
+    end
+
+    # The method finds all elements matching the specified selector in the `ElementHandle`s subtree. See
+    # [Working with selectors](./selectors.md) for more details. If no elements match the selector, returns empty array.
+    def query_selector_all(selector)
+      wrap_impl(@impl.query_selector_all(unwrap_impl(selector)))
+    end
+
     # Returns the buffer with the captured screenshot.
     # 
     # This method waits for the [actionability](./actionability.md) checks, then scrolls element into view before taking a
@@ -456,7 +458,6 @@ module Playwright
     # ```
     # 
     # ```python sync
-    # # FIXME
     # # single selection matching the value
     # handle.select_option("blue")
     # # single selection matching both the value and the label
@@ -466,8 +467,14 @@ module Playwright
     # # multiple selection for blue, red and second option
     # handle.select_option(value="blue", { index: 2 }, "red")
     # ```
-    def select_option(values, noWaitAfter: nil, timeout: nil)
-      wrap_impl(@impl.select_option(unwrap_impl(values), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
+    def select_option(
+          element: nil,
+          index: nil,
+          value: nil,
+          label: nil,
+          noWaitAfter: nil,
+          timeout: nil)
+      wrap_impl(@impl.select_option(element: unwrap_impl(element), index: unwrap_impl(index), value: unwrap_impl(value), label: unwrap_impl(label), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
     end
 
     # This method waits for [actionability](./actionability.md) checks, then focuses the element and selects all its text
@@ -628,20 +635,24 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/file_chooser.rb

@@ -3,39 +3,47 @@ module Playwright
   # 
   #
   # ```js
-  # page.on('filechooser', async (fileChooser) => {
-  #   await fileChooser.setFiles('/tmp/myfile.pdf');
-  # });
+  # const [fileChooser] = await Promise.all([
+  #   page.waitForEvent('filechooser'),
+  #   page.click('upload')
+  # ]);
+  # await fileChooser.setFiles('myfile.pdf');
   # ```
   # 
   # ```python async
-  # page.on("filechooser", lambda file_chooser: file_chooser.set_files("/tmp/myfile.pdf"))
+  # async with page.expect_file_chooser() as fc_info:
+  #     await page.click("upload")
+  # file_chooser = await fc_info.value
+  # await file_chooser.set_files("myfile.pdf")
   # ```
   # 
   # ```python sync
-  # page.on("filechooser", lambda file_chooser: file_chooser.set_files("/tmp/myfile.pdf"))
+  # with page.expect_file_chooser() as fc_info:
+  #     page.click("upload")
+  # file_chooser = fc_info.value
+  # file_chooser.set_files("myfile.pdf")
   # ```
   class FileChooser < PlaywrightApi
 
     # Returns input element associated with this file chooser.
     def element
-      raise NotImplementedError.new('element is not implemented yet.')
+      wrap_impl(@impl.element)
     end
 
     # Returns whether this file chooser accepts multiple files.
     def multiple?
-      raise NotImplementedError.new('multiple? is not implemented yet.')
+      wrap_impl(@impl.multiple?)
     end
 
     # Returns page this file chooser belongs to.
     def page
-      raise NotImplementedError.new('page is not implemented yet.')
+      wrap_impl(@impl.page)
     end
 
     # Sets the value of the file input this chooser is associated with. If some of the `filePaths` are relative paths, then
     # they are resolved relative to the the current working directory. For empty array, clears the selected files.
     def set_files(files, noWaitAfter: nil, timeout: nil)
-      raise NotImplementedError.new('set_files is not implemented yet.')
+      wrap_impl(@impl.set_files(unwrap_impl(files), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
     end
     alias_method :files=, :set_files
   end