Class: Capybara::Playwright::Node

Inherits:
Driver::Node
  • Object
show all
Defined in:
lib/capybara/playwright/node.rb

Overview

Selector and checking methods are derived from twapole/apparition Action methods (click, select_option, …) uses playwright.

ref:

selenium:   https://github.com/teamcapybara/capybara/blob/master/lib/capybara/selenium/node.rb
apparition: https://github.com/twalpole/apparition/blob/master/lib/capybara/apparition/node.rb

Direct Known Subclasses

ShadowRootNode

Defined Under Namespace

Modules: UpdateValueJS Classes: Checkbox, ClickOptions, DateInput, DateTimeInput, DragTo, FileUpload, JSValueInput, NotActionableError, RadioButton, SendKeys, Settable, StaleReferenceError, TextInput, TimeInput

Constant Summary collapse

SCROLL_POSITIONS = 
{
  top: '0',
  bottom: 'el.scrollHeight',
  center: '(el.scrollHeight - el.clientHeight)/2'
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(driver, page, element) ⇒ Node

Returns a new instance of Node.



67
68
69
70
71
 
# File 'lib/capybara/playwright/node.rb', line 67

def initialize(driver, page, element)
  super(driver, element)
  @page = page
  @element = element
end

Instance Method Details

#==(other) ⇒ Object 



921
922
923
924
925
 
# File 'lib/capybara/playwright/node.rb', line 921

def ==(other)
  return false unless other.is_a?(Node)

  @element.evaluate('(self, other) => self == other', arg: other.element)
end

#[](name) ⇒ Object 



141
142
143
144
145
 
# File 'lib/capybara/playwright/node.rb', line 141

def [](name)
  assert_element_not_stale {
    property(name) || attribute(name)
  }
end

#all_text ⇒ Object 



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/capybara/playwright/node.rb', line 108

def all_text
  assert_element_not_stale {
    text = @element.text_content
    text.to_s.gsub(/[\u200b\u200e\u200f]/, '')
        .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
        .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
        .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
        .tr("\u00a0", ' ')
  }
end

#checked? ⇒ Boolean

Returns:

  • (Boolean) 


824
825
826
827
828
 
# File 'lib/capybara/playwright/node.rb', line 824

def checked?
  assert_element_not_stale {
    @element.evaluate('el => !!el.checked')
  }
end

#click(keys = [], **options) ⇒ Object 



355
356
357
358
 
# File 'lib/capybara/playwright/node.rb', line 355

def click(keys = [], **options)
  click_options = ClickOptions.new(@element, keys, options, capybara_default_wait_time)
  @element.click(**click_options.as_params)
end

#disabled? ⇒ Boolean

Returns:

  • (Boolean) 


836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/capybara/playwright/node.rb', line 836

def disabled?
  @element.evaluate(<<~JAVASCRIPT)
  function(el) {
    const xpath = 'parent::optgroup[@disabled] | \
                  ancestor::select[@disabled] | \
                  parent::fieldset[@disabled] | \
                  ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]';
    return el.disabled || document.evaluate(xpath, el, null, XPathResult.BOOLEAN_TYPE, null).booleanValue
  }
  JAVASCRIPT
end

#double_click(keys = [], **options) ⇒ Object 



367
368
369
370
 
# File 'lib/capybara/playwright/node.rb', line 367

def double_click(keys = [], **options)
  click_options = ClickOptions.new(@element, keys, options, capybara_default_wait_time)
  @element.dblclick(**click_options.as_params)
end

#drag_to(element, **options) ⇒ Object 



625
626
627
 
# File 'lib/capybara/playwright/node.rb', line 625

def drag_to(element, **options)
  DragTo.new(@page, @element, element.element, options).execute
end

#drop(*args) ⇒ Object

Raises:

  • (NotImplementedError) 


699
700
701
 
# File 'lib/capybara/playwright/node.rb', line 699

def drop(*args)
  raise NotImplementedError
end

#find_css(query, **options) ⇒ Object 



935
936
937
938
939
940
941
 
# File 'lib/capybara/playwright/node.rb', line 935

def find_css(query, **options)
  assert_element_not_stale {
    @element.query_selector_all(query).map do |el|
      Node.new(@driver, @page, el)
    end
  }
end

#find_xpath(query, **options) ⇒ Object 



927
928
929
930
931
932
933
 
# File 'lib/capybara/playwright/node.rb', line 927

def find_xpath(query, **options)
  assert_element_not_stale {
    @element.query_selector_all("xpath=#{query}").map do |el|
      Node.new(@driver, @page, el)
    end
  }
end

#hover ⇒ Object 



621
622
623
 
# File 'lib/capybara/playwright/node.rb', line 621

def hover
  @element.hover(timeout: capybara_default_wait_time)
end

#inspect ⇒ Object 



917
918
919
 
# File 'lib/capybara/playwright/node.rb', line 917

def inspect
  %(#<#{self.class} tag="#{tag_name}" path="#{path}">)
end

#multiple? ⇒ Boolean

Returns:

  • (Boolean) 


852
853
854
 
# File 'lib/capybara/playwright/node.rb', line 852

def multiple?
  @element.evaluate('el => el.multiple')
end

#obscured? ⇒ Boolean

Returns:

  • (Boolean) 


820
821
822
 
# File 'lib/capybara/playwright/node.rb', line 820

def obscured?
  @element.capybara_obscured?
end

#path ⇒ Object 



868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 'lib/capybara/playwright/node.rb', line 868

def path
  assert_element_not_stale {
    @element.evaluate(<<~JAVASCRIPT)
    (el) => {
      var xml = document;
      var xpath = '';
      var pos, tempitem2;
      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {
        return "(: Shadow DOM element - no XPath :)";
      };
      while(el !== xml.documentElement) {
        pos = 0;
        tempitem2 = el;
        while(tempitem2) {
          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name
            pos += 1;
          }
          tempitem2 = tempitem2.previousSibling;
        }
        if (el.namespaceURI != xml.documentElement.namespaceURI) {
          xpath = "*[local-name()='"+el.nodeName+"' and namespace-uri()='"+(el.namespaceURI===null?'':el.namespaceURI)+"']["+pos+']'+'/'+xpath;
        } else {
          xpath = el.nodeName.toUpperCase()+"["+pos+"]/"+xpath;
        }
        el = el.parentNode;
      }
      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;
      xpath = xpath.replace(/\\/$/, '');
      return xpath;
    }
    JAVASCRIPT
  }
end

#readonly? ⇒ Boolean

Returns:

  • (Boolean) 


848
849
850
 
# File 'lib/capybara/playwright/node.rb', line 848

def readonly?
  !@element.editable?
end

#rect ⇒ Object 



856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/capybara/playwright/node.rb', line 856

def rect
  assert_element_not_stale {
    @element.evaluate(<<~JAVASCRIPT)
    function(el){
      const rects = [...el.getClientRects()]
      const rect = rects.find(r => (r.height && r.width)) || el.getBoundingClientRect();
      return rect.toJSON();
    }
    JAVASCRIPT
  }
end

#right_click(keys = [], **options) ⇒ Object 



360
361
362
363
364
365
 
# File 'lib/capybara/playwright/node.rb', line 360

def right_click(keys = [], **options)
  click_options = ClickOptions.new(@element, keys, options, capybara_default_wait_time)
  params = click_options.as_params
  params[:button] = 'right'
  @element.click(**params)
end

#scroll_by(x, y) ⇒ Object 



703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/capybara/playwright/node.rb', line 703

def scroll_by(x, y)
  js = <<~JAVASCRIPT
  (el, [x, y]) => {
    if (el.scrollBy){
      el.scrollBy(x, y);
    } else {
      el.scrollTop = el.scrollTop + y;
      el.scrollLeft = el.scrollLeft + x;
    }
  }
  JAVASCRIPT

  @element.evaluate(js, arg: [x, y])
end

#scroll_to(element, location, position = nil) ⇒ Object 



718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/capybara/playwright/node.rb', line 718

def scroll_to(element, location, position = nil)
  # location, element = element, nil if element.is_a? Symbol
  if element.is_a? Capybara::Playwright::Node
    scroll_element_to_location(element, location)
  elsif location.is_a? Symbol
    scroll_to_location(location)
  else
    scroll_to_coords(*position)
  end

  self
end

#select_option ⇒ Object 



328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/capybara/playwright/node.rb', line 328

def select_option
  return false if disabled?

  select_element = parent_select_element
  if select_element.evaluate('el => el.multiple')
    selected_options = select_element.query_selector_all('option:checked')
    selected_options << @element
    select_element.select_option(element: selected_options, timeout: capybara_default_wait_time)
  else
    select_element.select_option(element: @element, timeout: capybara_default_wait_time)
  end
end

#selected? ⇒ Boolean

Returns:

  • (Boolean) 


830
831
832
833
834
 
# File 'lib/capybara/playwright/node.rb', line 830

def selected?
  assert_element_not_stale {
    @element.evaluate('el => !!el.selected')
  }
end

#send_keys(*args) ⇒ Object 



451
452
453
 
# File 'lib/capybara/playwright/node.rb', line 451

def send_keys(*args)
  SendKeys.new(@element, args).execute
end

#set(value, **options) ⇒ Object

Parameters:

  • value (String, Array) —

    Array is only allowed if node has ‘multiple’ attribute

  • options (Hash) —

    Driver specific options for how to set a value on a node



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/capybara/playwright/node.rb', line 178

def set(value, **options)
  settable_class =
    case tag_name
    when 'input'
      case attribute('type')
      when 'radio'
        RadioButton
      when 'checkbox'
        Checkbox
      when 'file'
        FileUpload
      when 'date'
        DateInput
      when 'time'
        TimeInput
      when 'datetime-local'
        DateTimeInput
      when 'color'
        JSValueInput
      when 'range'
        JSValueInput
      else
        TextInput
      end
    when 'textarea'
      TextInput
    else
      if @element.editable?
        TextInput
      else
        raise NotSupportedByDriverError
      end
    end

  settable_class.new(@element, capybara_default_wait_time).set(value, **options)
rescue ::Playwright::TimeoutError => err
  raise NotActionableError.new(err)
end

#shadow_root ⇒ Object 



906
907
908
909
910
911
912
913
914
915
 
# File 'lib/capybara/playwright/node.rb', line 906

def shadow_root
  # Playwright does not distinguish shadow DOM.
  # https://playwright.dev/docs/selectors#selecting-elements-in-shadow-dom
  # Just do with Host element as shadow root Element.
  #
  #   Node.new(@driver, @page, @element.evaluate_handle('el => el.shadowRoot'))
  #
  # does not work well because of the Playwright Error 'Element is not attached to the DOM'
  ShadowRootNode.new(@driver, @page, @element)
end

#style(styles) ⇒ Object

Raises:

  • (NotImplementedError) 


170
171
172
173
174
 
# File 'lib/capybara/playwright/node.rb', line 170

def style(styles)
  # Capybara provides default implementation.
  # ref: https://github.com/teamcapybara/capybara/blob/f7ab0b5cd5da86185816c2d5c30d58145fe654ed/lib/capybara/node/element.rb#L92
  raise NotImplementedError
end

#tag_name ⇒ Object 



782
783
784
 
# File 'lib/capybara/playwright/node.rb', line 782

def tag_name
  @tag_name ||= @element.evaluate('e => e.tagName.toLowerCase()')
end

#trigger(event) ⇒ Object 



902
903
904
 
# File 'lib/capybara/playwright/node.rb', line 902

def trigger(event)
  @element.dispatch_event(event)
end

#unselect_option ⇒ Object 



341
342
343
344
345
346
347
348
349
 
# File 'lib/capybara/playwright/node.rb', line 341

def unselect_option
  if parent_select_element.evaluate('el => el.multiple')
    return false if disabled?

    @element.evaluate('el => el.selected = false')
  else
    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.'
  end
end

#value ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/capybara/playwright/node.rb', line 156

def value
  assert_element_not_stale {
    # ref: https://github.com/teamcapybara/capybara/blob/f7ab0b5cd5da86185816c2d5c30d58145fe654ed/lib/capybara/selenium/node.rb#L31
    # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/node.rb#L728
    if tag_name == 'select' && @element.evaluate('el => el.multiple')
      @element.query_selector_all('option:checked').map do |option|
        option.evaluate('el => el.value')
      end
    else
      @element.evaluate('el => el.value')
    end
  }
end

#visible? ⇒ Boolean

Returns:

  • (Boolean) 


786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/capybara/playwright/node.rb', line 786

def visible?
  assert_element_not_stale {
    # if an area element, check visibility of relevant image
    @element.evaluate(<<~JAVASCRIPT)
    function(el) {
      if (el.tagName == 'AREA'){
        const map_name = document.evaluate('./ancestor::map/@name', el, null, XPathResult.STRING_TYPE, null).stringValue;
        el = document.querySelector(`img[usemap='#${map_name}']`);
        if (!el){
        return false;
        }
      }
      var forced_visible = false;
      while (el) {
        const style = window.getComputedStyle(el);
        if (style.visibility == 'visible')
          forced_visible = true;
        if ((style.display == 'none') ||
            ((style.visibility == 'hidden') && !forced_visible) ||
            (parseFloat(style.opacity) == 0)) {
          return false;
        }
        var parent = el.parentElement;
        if (parent && (parent.tagName == 'DETAILS') && !parent.open && (el.tagName != 'SUMMARY')) {
          return false;
        }
        el = parent;
      }
      return true;
    }
    JAVASCRIPT
  }
end

#visible_text ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/capybara/playwright/node.rb', line 119

def visible_text
  assert_element_not_stale {
    return '' unless visible?

    text = @element.evaluate(<<~JAVASCRIPT)
      function(el){
        if (el.nodeName == 'TEXTAREA'){
          return el.textContent;
        } else if (el instanceof SVGElement) {
          return el.textContent;
        } else {
          return el.innerText;
        }
      }
    JAVASCRIPT
    text.to_s.gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
        .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
        .gsub(/\n+/, "\n")
        .tr("\u00a0", ' ')
  }
end