playwright-ruby-client 1.51.0 → 1.56.0

data/lib/playwright/locator_assertions_impl.rb

@@ -11,20 +11,20 @@ module Playwright
       end
     end
 
-    def initialize(locator, timeout, is_not, message)
+    def initialize(locator, default_expect_timeout, is_not, message)
       @locator = locator
-      @timeout = timeout
+      @default_expect_timeout = default_expect_timeout
       @is_not = is_not
       @custom_message = message
     end
 
-    private def expect_impl(expression, expect_options, expected, message)
-      expect_options[:timeout] ||= 5000
+    private def expect_impl(expression, expect_options, expected, message, title)
+      expect_options[:timeout] ||= @default_expect_timeout
       expect_options[:isNot] = @is_not
       message.gsub!("expected to", "not expected to") if @is_not
       expect_options.delete(:useInnerText) if expect_options.key?(:useInnerText) && expect_options[:useInnerText].nil?
 
-      result = @locator.expect(expression, expect_options)
+      result = @locator.expect(expression, expect_options, title)
 
       if result["matches"] == @is_not
         actual = result["received"]
@@ -49,8 +49,11 @@ module Playwright
             "\n#{message}"
           end
 
-          out = "#{out_message}\nActual value #{actual} #{log}"
-          raise AssertionError.new(out)
+        if result['errorMessage']
+          error_message = "\n#{result['errorMessage']}"
+        end
+        out = "#{out_message}\nActual value #{actual}#{error_message} #{log}"
+        raise AssertionError.new(out)
       else
         true
       end
@@ -59,7 +62,7 @@ module Playwright
     private def _not # "not" is reserved in Ruby
       LocatorAssertionsImpl.new(
         @locator,
-        @timeout,
+        @default_expect_timeout,
         !@is_not,
         @message
       )
@@ -124,7 +127,8 @@ module Playwright
             timeout: timeout,
           },
           expected,
-          "Locator expected to contain text"
+          "Locator expected to contain text",
+          'Expect "to_contain_text"',
         )
       else
         expected_text = to_expected_text_values(
@@ -142,7 +146,8 @@ module Playwright
             timeout: timeout,
           },
           expected,
-          "Locator expected to contain text"
+          "Locator expected to contain text",
+          'Expect "to_contain_text"',
         )
       end
     end
@@ -157,7 +162,8 @@ module Playwright
           timeout: timeout,
         },
         name,
-        "Locator expected to have accessible name"
+        "Locator expected to have accessible name",
+        'Expect "to_have_accessible_name"',
       )
     end
     _define_negation :to_have_accessible_name
@@ -171,7 +177,8 @@ module Playwright
           timeout: timeout,
         },
         name,
-        "Locator expected to have accessible description"
+        "Locator expected to have accessible description",
+        'Expect "to_have_accessible_description"',
       )
     end
     _define_negation :to_have_accessible_description
@@ -185,7 +192,8 @@ module Playwright
           timeout: timeout,
         },
         errorMessage,
-        "Locator expected to have accessible error message"
+        "Locator expected to have accessible error message",
+        'Expect "to_have_accessible_error_message"',
       )
     end
     _define_negation :to_have_accessible_error_message
@@ -200,7 +208,8 @@ module Playwright
           timeout: timeout,
         },
         value,
-        "Locator expected to have attribute"
+        "Locator expected to have attribute",
+        'Expect "to_have_attribute"',
       )
     end
     _define_negation :to_have_attribute
@@ -215,7 +224,8 @@ module Playwright
             timeout: timeout,
           },
           expected,
-          "Locator expected to have class"
+          "Locator expected to have class",
+          'Expect "to_have_class"',
         )
       else
         expected_text = to_expected_text_values([expected])
@@ -226,12 +236,48 @@ module Playwright
             timeout: timeout,
           },
           expected,
-          "Locator expected to have class"
+          "Locator expected to have class",
+          'Expect "to_have_class"',
         )
       end
     end
     _define_negation :to_have_class
 
+    def to_contain_class(expected, timeout: nil)
+      if expected.is_a?(Enumerable)
+        if expected.any? { |e| e.is_a?(Regexp) }
+          raise ArgumentError.new('"expected" argument in toContainClass cannot contain RegExp values')
+        end
+        expected_text = to_expected_text_values(expected)
+        expect_impl(
+          "to.contain.class.array",
+          {
+            expectedText: expected_text,
+            timeout: timeout,
+          },
+          expected,
+          "Locator expected to contain class names",
+          'Expect "to_contain_class"',
+        )
+      else # Single string
+        if expected.is_a?(Regexp)
+          raise ArgumentError.new('"expected" argument in toContainClass cannot be a RegExp value')
+        end
+        expected_text = to_expected_text_values([expected])
+        expect_impl(
+          "to.contain.class",
+          {
+            expectedText: expected_text,
+            timeout: timeout,
+          },
+          expected,
+          "Locator expected to contain class",
+          'Expect "to_contain_class"',
+        )
+      end
+    end
+    _define_negation :to_contain_class
+
     def to_have_count(count, timeout: nil)
       expect_impl(
         "to.have.count",
@@ -240,7 +286,8 @@ module Playwright
           timeout: timeout,
         },
         count,
-        "Locator expected to have count"
+        "Locator expected to have count",
+        'Expect "to_have_count"',
       )
     end
     _define_negation :to_have_count
@@ -255,7 +302,8 @@ module Playwright
           timeout: timeout,
         },
         value,
-        "Locator expected to have CSS"
+        "Locator expected to have CSS",
+        'Expect "to_have_css"',
       )
     end
     _define_negation :to_have_css
@@ -269,7 +317,8 @@ module Playwright
           timeout: timeout,
         },
         id,
-        "Locator expected to have ID"
+        "Locator expected to have ID",
+        'Expect "to_have_id"',
       )
     end
     _define_negation :to_have_id
@@ -283,7 +332,8 @@ module Playwright
           timeout: timeout,
         },
         value,
-        "Locator expected to have JS Property"
+        "Locator expected to have JS Property",
+        'Expect "to_have_js_property"',
       )
     end
     _define_negation :to_have_js_property
@@ -302,6 +352,7 @@ module Playwright
         },
         role,
         "Locator expected to have accessible role",
+        'Expect "to_have_role"',
       )
     end
     _define_negation :to_have_role
@@ -316,7 +367,8 @@ module Playwright
           timeout: timeout,
         },
         value,
-        "Locator expected to have Value"
+        "Locator expected to have Value",
+        'Expect "to_have_value"',
       )
     end
     _define_negation :to_have_value
@@ -331,7 +383,8 @@ module Playwright
           timeout: timeout,
         },
         values,
-        "Locator expected to have Values"
+        "Locator expected to have Values",
+        'Expect "to_have_values"',
       )
     end
     _define_negation :to_have_values
@@ -352,7 +405,8 @@ module Playwright
             timeout: timeout,
           },
           expected,
-          "Locator expected to have text"
+          "Locator expected to have text",
+          'Expect "to_have_text"',
         )
       else
         expected_text = to_expected_text_values(
@@ -369,7 +423,8 @@ module Playwright
             timeout: timeout,
           },
           expected,
-          "Locator expected to have text"
+          "Locator expected to have text",
+          'Expect "to_have_text"',
         )
       end
     end
@@ -384,6 +439,7 @@ module Playwright
         },
         expected,
         'Locator expected to match Aria snapshot',
+        'Expect "to_match_aria_snapshot"',
       )
     end
     _define_negation :to_match_aria_snapshot
@@ -393,7 +449,8 @@ module Playwright
         (attached || attached.nil?) ? "to.be.attached" : "to.be.detached",
         { timeout: timeout },
         nil,
-        "Locator expected to be attached"
+        "Locator expected to be attached",
+        'Expect "to_be_attached"',
       )
     end
     _define_negation :to_be_attached
@@ -416,7 +473,8 @@ module Playwright
         "to.be.checked",
         { timeout: timeout, expectedValue: expected_value },
         nil,
-        "Locator expected to be checked"
+        "Locator expected to be checked",
+        'Expect "to_be_checked"',
       )
     end
     _define_negation :to_be_checked
@@ -426,7 +484,8 @@ module Playwright
         "to.be.disabled",
         { timeout: timeout },
         nil,
-        "Locator expected to be disabled"
+        "Locator expected to be disabled",
+        'Expect "to_be_disabled"',
       )
     end
     _define_negation :to_be_disabled
@@ -436,7 +495,8 @@ module Playwright
         (editable || editable.nil?) ? "to.be.editable" : "to.be.readonly",
         { timeout: timeout },
         nil,
-        "Locator expected to be editable"
+        "Locator expected to be editable",
+        'Expect "to_be_editable"',
       )
     end
     _define_negation :to_be_editable
@@ -446,7 +506,8 @@ module Playwright
         "to.be.empty",
         { timeout: timeout },
         nil,
-        "Locator expected to be empty"
+        "Locator expected to be empty",
+        'Expect "to_be_empty"',
       )
     end
     _define_negation :to_be_empty
@@ -456,7 +517,8 @@ module Playwright
         (enabled || enabled.nil?) ? "to.be.enabled" : "to.be.disabled",
         { timeout: timeout },
         nil,
-        "Locator expected to be enabled"
+        "Locator expected to be enabled",
+        'Expect "to_be_enabled"',
       )
     end
     _define_negation :to_be_enabled
@@ -466,7 +528,8 @@ module Playwright
         "to.be.hidden",
         { timeout: timeout },
         nil,
-        "Locator expected to be hidden"
+        "Locator expected to be hidden",
+        'Expect "to_be_hidden"',
       )
     end
     _define_negation :to_be_hidden
@@ -476,7 +539,8 @@ module Playwright
         (visible || visible.nil?) ? "to.be.visible" : "to.be.hidden",
         { timeout: timeout },
         nil,
-        "Locator expected to be visible"
+        "Locator expected to be visible",
+        'Expect "to_be_visible"',
       )
     end
     _define_negation :to_be_visible
@@ -486,7 +550,8 @@ module Playwright
         "to.be.focused",
         { timeout: timeout },
         nil,
-        "Locator expected to be focused"
+        "Locator expected to be focused",
+        'Expect "to_be_focused"',
       )
     end
     _define_negation :to_be_focused
@@ -496,7 +561,8 @@ module Playwright
         "to.be.in.viewport",
         { timeout: timeout, expectedNumber: ratio }.compact,
         nil,
-        "Locator expected to be in viewport"
+        "Locator expected to be in viewport",
+        'Expect "to_be_in_viewport"',
       )
     end
     _define_negation :to_be_in_viewport

data/lib/playwright/locator_impl.rb

@@ -5,9 +5,8 @@ module Playwright
   define_api_implementation :LocatorImpl do
     include LocatorUtils
 
-    def initialize(frame:, timeout_settings:, selector:, has: nil, hasNot: nil, hasNotText: nil, hasText: nil, visible: nil)
+    def initialize(frame:, selector:, has: nil, hasNot: nil, hasNotText: nil, hasText: nil, visible: nil)
       @frame = frame
-      @timeout_settings = timeout_settings
       selector_scopes = [selector]
 
       if hasText
@@ -40,7 +39,11 @@ module Playwright
     end
 
     def to_s
-      "Locator@#{@selector}"
+      if @description
+        "Locator@#{@selector} (#{@description})"
+      else
+        "Locator@#{@selector}"
+      end
     end
 
     private def to_protocol
@@ -64,8 +67,12 @@ module Playwright
       @selector.to_json
     end
 
+    private def _timeout(timeout)
+      @frame.send(:_timeout, timeout)
+    end
+
     private def with_element(timeout: nil, &block)
-      timeout_or_default = @timeout_settings.timeout(timeout)
+      timeout_or_default = _timeout(timeout)
       start_time = Time.now
 
       handle = @frame.wait_for_selector(@selector, strict: true, state: 'attached', timeout: timeout_or_default)
@@ -213,7 +220,6 @@ module Playwright
       hasText: nil)
       LocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         selector: "#{@selector} >> #{selector}",
         has: has,
         hasNot: hasNot,
@@ -224,7 +230,6 @@ module Playwright
     def frame_locator(selector)
       FrameLocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         frame_selector: "#{@selector} >> #{selector}",
       )
     end
@@ -240,15 +245,20 @@ module Playwright
     def content_frame
       FrameLocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         frame_selector: @selector,
       )
     end
 
+    def describe(description)
+      LocatorImpl.new(
+        frame: @frame,
+        selector: "#{@selector} >> internal:describe=#{description.to_json}",
+      )
+    end
+
     def filter(has: nil, hasNot: nil, hasNotText: nil, hasText: nil, visible: nil)
       LocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         selector: @selector,
         has: has,
         hasNot: hasNot,
@@ -261,7 +271,6 @@ module Playwright
     def first
       LocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         selector: "#{@selector} >> nth=0",
       )
     end
@@ -269,7 +278,6 @@ module Playwright
     def last
       LocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         selector: "#{@selector} >> nth=-1",
       )
     end
@@ -277,7 +285,6 @@ module Playwright
     def nth(index)
       LocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         selector: "#{@selector} >> nth=#{index}",
       )
     end
@@ -288,7 +295,6 @@ module Playwright
       end
       LocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         selector: "#{@selector} >> internal:and=#{locator.send(:selector_json)}",
       )
     end
@@ -299,7 +305,6 @@ module Playwright
       end
       LocatorImpl.new(
         frame: @frame,
-        timeout_settings: @timeout_settings,
         selector: "#{@selector} >> internal:or=#{locator.send(:selector_json)}",
       )
     end
@@ -312,7 +317,7 @@ module Playwright
       params = {
         selector: @selector,
         strict: true,
-        timeout: timeout,
+        timeout: _timeout(timeout),
       }.compact
       @frame.channel.send_message_to_server('blur', params)
     end
@@ -329,6 +334,10 @@ module Playwright
       @frame.get_attribute(@selector, name, strict: true, timeout: timeout)
     end
 
+    def resolve_selector
+      @frame.channel.send_message_to_server('resolveSelector', { selector: @selector })
+    end
+
     def hover(
           force: nil,
           modifiers: nil,
@@ -400,7 +409,7 @@ module Playwright
     def aria_snapshot(timeout: nil)
       @frame.channel.send_message_to_server('ariaSnapshot', {
         selector: @selector,
-        timeout: timeout,
+        timeout: _timeout(timeout),
       }.compact)
     end
 
@@ -508,27 +517,8 @@ module Playwright
       @frame.highlight(@selector)
     end
 
-    def expect(expression, options)
-      if options.key?(:expectedValue)
-        options[:expectedValue] = JavaScript::ValueSerializer
-          .new(options[:expectedValue])
-          .serialize
-      end
-
-      result = @frame.channel.send_message_to_server_result(
-        "expect",
-        {
-          selector: @selector,
-          expression: expression,
-          **options,
-        }
-      )
-
-      if result.key?('received')
-        result['received'] = JavaScript::ValueParser.new(result['received']).parse
-      end
-
-      result
+    def expect(expression, options, title)
+      @frame.expect(@selector, expression, options, title)
     end
   end
 end

data/lib/playwright/page_assertions_impl.rb

@@ -11,21 +11,21 @@ module Playwright
       end
     end
 
-    def initialize(page, timeout, is_not, message)
+    def initialize(page, default_expect_timeout, is_not, message)
       @page = PlaywrightApi.unwrap(page)
-      @locator = @page.locator(":root")
-      @timeout = timeout
+      @frame = @page.main_frame
+      @default_expect_timeout = default_expect_timeout
       @is_not = is_not
       @custom_message = message
     end
 
-    private def expect_impl(expression, expect_options, expected, message)
-      expect_options[:timeout] ||= 5000
+    private def expect_impl(expression, expect_options, expected, message, title)
+      expect_options[:timeout] ||= @default_expect_timeout
       expect_options[:isNot] = @is_not
       message.gsub!("expected to", "not expected to") if @is_not
       expect_options.delete(:useInnerText) if expect_options.key?(:useInnerText) && expect_options[:useInnerText].nil?
 
-      result = @locator.expect(expression, expect_options)
+      result = @frame.expect(nil, expression, expect_options, title)
 
       if result["matches"] == @is_not
         actual = result["received"]
@@ -50,8 +50,11 @@ module Playwright
             "\n#{message}"
           end
 
-          out = "#{out_message}\nActual value #{actual} #{log}"
-          raise AssertionError.new(out)
+        if result['errorMessage']
+          error_message = "\n#{result['errorMessage']}"
+        end
+        out = "#{out_message}\nActual value #{actual}#{error_message} #{log}"
+        raise AssertionError.new(out)
       else
         true
       end
@@ -60,7 +63,7 @@ module Playwright
     private def _not # "not" is reserved in Ruby
       PageAssertionsImpl.new(
         @page,
-        @timeout,
+        @default_expect_timeout,
         !@is_not,
         @message
       )
@@ -117,7 +120,8 @@ module Playwright
           timeout: timeout,
         },
         title_or_regex,
-        "Page title expected to be"
+        "Page title expected to be",
+        'Expect "to_have_title"',
       )
     end
     _define_negation :to_have_title
@@ -141,7 +145,8 @@ module Playwright
           timeout: timeout,
         },
         expected,
-        "Page URL expected to be"
+        "Page URL expected to be",
+        'Expect "to_have_url"',
       )
     end
     _define_negation :to_have_url

data/lib/playwright/selectors_impl.rb

@@ -0,0 +1,45 @@
+module Playwright
+  # https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_selectors.py
+  define_api_implementation :SelectorsImpl do
+    def initialize
+      @selector_engines = []
+      @contexts_for_selectors = Set.new
+    end
+
+    def register(name, contentScript: nil, path: nil, script: nil)
+      source =
+        if path
+          File.read(path)
+        elsif script
+          script
+        else
+          raise ArgumentError.new('Either path or script parameter must be specified')
+        end
+      selector_engine = { name: name, source: source }
+      if contentScript
+        selector_engine[:contentScript] = true
+      end
+      @contexts_for_selectors.each do |context|
+        context.send(:register_selector_engine, selector_engine)
+      end
+      @selector_engines << selector_engine
+
+      nil
+    end
+
+    def set_test_id_attribute(attribute_name)
+      @test_id_attribute_name = attribute_name
+      ::Playwright::LocatorUtils.instance_variable_set(:@test_id_attribute_name, attribute_name)
+    end
+
+    private def update_with_selector_options(options)
+      options[:selectorEngines] = @selector_engines unless @selector_engines.empty?
+      options[:testIdAttributeName] = @test_id_attribute_name if @test_id_attribute_name
+      options
+    end
+
+    private def contexts_for_selectors
+      @contexts_for_selectors
+    end
+  end
+end

data/lib/playwright/test.rb

@@ -2,10 +2,28 @@ module Playwright
   # this module is responsible for running playwright assertions and integrating
   # with test frameworks.
   module Test
+    @@expect_timeout = nil
+
+    def self.expect_timeout
+      @@expect_timeout || 5000 # default timeout is 5000ms
+    end
+
+    def self.expect_timeout=(timeout)
+      @@expect_timeout = timeout
+    end
+
+    def self.with_timeout(expect_timeout, &block)
+      old_timeout = @@expect_timeout
+      @@expect_timeout = expect_timeout
+      block.call
+    ensure
+      @@expect_timeout = old_timeout
+    end
+
     # ref: https://github.com/microsoft/playwright-python/blob/main/playwright/sync_api/__init__.py#L90
     class Expect
       def initialize
-        @timeout_settings = TimeoutSettings.new
+        @default_expect_timeout = ::Playwright::Test.expect_timeout
       end
 
       def call(actual, is_not)
@@ -14,7 +32,7 @@ module Playwright
           PageAssertions.new(
             PageAssertionsImpl.new(
               actual,
-              @timeout_settings.timeout,
+              @default_expect_timeout,
               is_not,
               nil,
             )
@@ -23,7 +41,7 @@ module Playwright
           LocatorAssertions.new(
             LocatorAssertionsImpl.new(
               actual,
-              @timeout_settings.timeout,
+              @default_expect_timeout,
               is_not,
               nil,
             )