Class: TestCentricity::UIElement

Inherits:
Object
  • Object
show all
Includes:
Capybara::DSL, Test::Unit::Assertions
Defined in:
lib/testcentricity_web/web_elements/ui_elements_helper.rb

Constant Summary collapse

XPATH_SELECTORS = 
['//', '[@', '[contains(']
CSS_SELECTORS = 
['#', ':nth-child(', ':first-child', ':last-child', ':nth-of-type(', ':first-of-type', ':last-of-type', '^=', '$=', '*=', ':contains(']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, parent, locator, context) ⇒ UIElement

Returns a new instance of UIElement.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 52

def initialize(name, parent, locator, context)
  @name           = name
  @parent         = parent
  @locator        = locator
  @context        = context
  @type           = nil
  @alt_locator    = nil
  @original_style = nil
  set_locator_type
end

Instance Attribute Details

#alt_locator ⇒ Object

Returns the value of attribute alt_locator.



46
47
48
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 46

def alt_locator
  @alt_locator
end

#base_object ⇒ Object

Returns the value of attribute base_object.



47
48
49
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 47

def base_object
  @base_object
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def context
  @context
end

#locator ⇒ Object (readonly)

Returns the value of attribute locator.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def locator
  @locator
end

#locator_type ⇒ Object

Returns the value of attribute locator_type.



46
47
48
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 46

def locator_type
  @locator_type
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def name
  @name
end

#original_style ⇒ Object

Returns the value of attribute original_style.



46
47
48
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 46

def original_style
  @original_style
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def parent
  @parent
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def type
  @type
end

Instance Method Details

#aria_autocomplete ⇒ Integer

Return state of UI object's aria-autocomplete property

Examples:

email_field.aria_autocomplete

Returns:

  • (Integer) 


823
824
825
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 823

def aria_autocomplete
  get_attribute('aria-autocomplete')
end

#aria_busy? ⇒ Boolean

Return state of UI object's aria-busy property

Examples:

home_phone_field.aria_busy?

Returns:

  • (Boolean) 


953
954
955
956
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 953

def aria_busy?
  state = get_attribute('aria-busy')
  state.boolean? ? state : state == 'true'
end

#aria_checked? ⇒ Boolean

Return state of UI object's aria-checked property

Examples:

allow_new_users_checkbox.aria_checked?

Returns:

  • (Boolean) 


909
910
911
912
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 909

def aria_checked?
  state = get_attribute('aria-checked')
  state.boolean? ? state : state == 'true'
end

#aria_colcount ⇒ Integer

Return state of UI object's aria-colcount property

Examples:

user_grid.aria_colcount

Returns:

  • (Integer) 


743
744
745
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 743

def aria_colcount
  get_attribute('aria-colcount')
end

#aria_controls ⇒ Integer

Return state of UI object's aria-controls property

Examples:

video_menu.aria_controls

Returns:

  • (Integer) 


833
834
835
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 833

def aria_controls
  get_attribute('aria-controls')
end

#aria_describedby ⇒ String

Return state of UI object's aria-describedby property

Examples:

buy_now_button.aria_describedby

Returns:



703
704
705
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 703

def aria_describedby
  get_attribute('aria-describedby')
end

#aria_disabled? ⇒ Boolean

Return state of UI object's aria-disabled property

Examples:

buy_now_button.aria_disabled?

Returns:

  • (Boolean) 


843
844
845
846
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 843

def aria_disabled?
  state = get_attribute('aria-disabled')
  state.boolean? ? state : state == 'true'
end

#aria_expanded? ⇒ Boolean

Return state of UI object's aria-expanded property

Examples:

catalog_tree.aria_expanded?

Returns:

  • (Boolean) 


876
877
878
879
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 876

def aria_expanded?
  state = get_attribute('aria-expanded')
  state.boolean? ? state : state == 'true'
end

#aria_haspopup? ⇒ Boolean

Return state of UI object's aria-haspopup property

Examples:

user_avatar.aria_haspopup?

Returns:

  • (Boolean) 


920
921
922
923
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 920

def aria_haspopup?
  state = get_attribute('aria-haspopup')
  state.boolean? ? state : state == 'true'
end

#aria_hidden? ⇒ Boolean

Return state of UI object's aria-hidden property

Examples:

nutrition_info_tab.aria_hidden?

Returns:

  • (Boolean) 


865
866
867
868
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 865

def aria_hidden?
  state = get_attribute('aria-hidden')
  state.boolean? ? state : state == 'true'
end

#aria_invalid? ⇒ Boolean

Return state of UI object's aria-invalid property

Examples:

home_phone_field.aria_invalid?

Returns:

  • (Boolean) 


898
899
900
901
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 898

def aria_invalid?
  state = get_attribute('aria-invalid')
  state.boolean? ? state : state == 'true'
end

#aria_keyshortcuts ⇒ Integer

Return state of UI object's aria-keyshortcuts property

Examples:

play_button.aria_keyshortcuts

Returns:

  • (Integer) 


803
804
805
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 803

def aria_keyshortcuts
  get_attribute('aria-keyshortcuts')
end

#aria_label ⇒ String

Return state of UI object's aria-label property

Examples:

buy_now_button.aria_label

Returns:



683
684
685
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 683

def aria_label
  get_attribute('aria-label')
end

#aria_labelledby ⇒ String

Return state of UI object's aria-labelledby property

Examples:

buy_now_button.aria_labelledby

Returns:



693
694
695
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 693

def aria_labelledby
  get_attribute('aria-labelledby')
end

#aria_live ⇒ String

Return state of UI object's aria-live property

Examples:

properties_list.aria_live

Returns:



713
714
715
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 713

def aria_live
  get_attribute('aria-live')
end

#aria_modal? ⇒ Boolean

Return state of UI object's aria-modal property

Examples:

add_user_modal.aria_modal?

Returns:

  • (Boolean) 


964
965
966
967
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 964

def aria_modal?
  state = get_attribute('aria-modal')
  state.boolean? ? state : state == 'true'
end

#aria_multiline? ⇒ Boolean

Return state of UI object's aria-multiline property

Examples:

description_field.aria_multiline?

Returns:

  • (Boolean) 


975
976
977
978
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 975

def aria_multiline?
  state = get_attribute('aria-multiline')
  state.boolean? ? state : state == 'true'
end

#aria_multiselectable? ⇒ Boolean

Return state of UI object's aria-multiselectable property

Examples:

channels_select.aria_multiselectable?

Returns:

  • (Boolean) 


986
987
988
989
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 986

def aria_multiselectable?
  state = get_attribute('aria-multiselectable')
  state.boolean? ? state : state == 'true'
end

#aria_orientation ⇒ Integer

Return state of UI object's aria-orientation property

Examples:

volume_slider.aria_orientation

Returns:

  • (Integer) 


793
794
795
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 793

def aria_orientation
  get_attribute('aria-orientation')
end

#aria_pressed? ⇒ Boolean

Return state of UI object's aria-pressed property

Examples:

option1_button.aria_pressed?

Returns:

  • (Boolean) 


931
932
933
934
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 931

def aria_pressed?
  state = get_attribute('aria-pressed')
  state.boolean? ? state : state == 'true'
end

#aria_readonly? ⇒ Boolean

Return state of UI object's aria-readonly property

Examples:

home_phone_field.aria_readonly?

Returns:

  • (Boolean) 


942
943
944
945
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 942

def aria_readonly?
  state = get_attribute('aria-readonly')
  state.boolean? ? state : state == 'true'
end

#aria_required? ⇒ Boolean

Return state of UI object's aria-required property

Examples:

home_phone_field.aria_required?

Returns:

  • (Boolean) 


887
888
889
890
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 887

def aria_required?
  state = get_attribute('aria-required')
  state.boolean? ? state : state == 'true'
end

#aria_roledescription ⇒ Integer

Return state of UI object's aria-roledescription property

Examples:

editor_button.aria_roledescription

Returns:

  • (Integer) 


813
814
815
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 813

def aria_roledescription
  get_attribute('aria-roledescription')
end

#aria_rowcount ⇒ Integer

Return state of UI object's aria-rowcount property

Examples:

user_grid.aria_rowcount

Returns:

  • (Integer) 


733
734
735
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 733

def aria_rowcount
  get_attribute('aria-rowcount')
end

#aria_selected? ⇒ Boolean

Return state of UI object's aria-selected property

Examples:

nutrition_info_tab.aria_selected?

Returns:

  • (Boolean) 


854
855
856
857
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 854

def aria_selected?
  state = get_attribute('aria-selected')
  state.boolean? ? state : state == 'true'
end

#aria_sort ⇒ String

Return state of UI object's aria-sort property

Examples:

name_column.aria_sort

Returns:



723
724
725
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 723

def aria_sort
  get_attribute('aria-sort')
end

#aria_valuemax ⇒ Integer

Return state of UI object's aria-valuemax property

Examples:

volume_slider.aria_valuemax

Returns:

  • (Integer) 


753
754
755
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 753

def aria_valuemax
  get_attribute('aria-valuemax')
end

#aria_valuemin ⇒ Integer

Return state of UI object's aria-valuemin property

Examples:

volume_slider.aria_valuemin

Returns:

  • (Integer) 


763
764
765
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 763

def aria_valuemin
  get_attribute('aria-valuemin')
end

#aria_valuenow ⇒ Integer

Return state of UI object's aria-valuenow property

Examples:

volume_slider.aria_valuenow

Returns:

  • (Integer) 


773
774
775
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 773

def aria_valuenow
  get_attribute('aria-valuenow')
end

#aria_valuetext ⇒ Integer

Return state of UI object's aria-valuetext property

Examples:

volume_slider.aria_valuetext

Returns:

  • (Integer) 


783
784
785
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 783

def aria_valuetext
  get_attribute('aria-valuetext')
end

#clear_alt_locator ⇒ Object 



108
109
110
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 108

def clear_alt_locator
  @alt_locator = nil
end

#click ⇒ Object

Click on an object

Examples:

basket_link.click


117
118
119
120
121
122
123
124
125
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 117

def click
  obj, type = find_element
  object_not_found_exception(obj, type)
  begin
    obj.click
  rescue StandardError
    obj.click_at(10, 10)
  end
end

#click_at(x, y) ⇒ Object

Click at a specific location within an object

Examples:

basket_item_image.click_at(10, 10)

Parameters:

  • x (Integer) —

    X offset

  • y (Integer) —

    Y offset



156
157
158
159
160
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 156

def click_at(x, y)
  obj, = find_element
  raise "UI #{object_ref_message} not found" unless obj
  obj.click_at(x, y)
end

#content_editable? ⇒ Boolean

Return state of UI object's contenteditable property

Examples:

description_field.content_editable?

Returns:

  • (Boolean) 


997
998
999
1000
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 997

def content_editable?
  state = get_attribute('contenteditable')
  state.boolean? ? state : state == 'true'
end

#count(visible = true) ⇒ Object

Return the number of occurrences of an object with an ambiguous locator that evaluates to multiple UI elements.

Examples:

num_uploads = upload_progress_bars.count(:all)

Parameters:

  • visible (Boolean, Symbol) (defaults to: true) —

    Only find elements with the specified visibility:

    • true - only finds visible elements.
    • false - finds invisible and visible elements.
    • :all - same as false; finds visible and invisible elements.
    • :hidden - only finds invisible elements.
    • :visible - same as true; only finds visible elements.


446
447
448
449
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 446

def count(visible = true)
  obj_locator = @alt_locator.nil? ? @locator : @alt_locator
  page.all(@locator_type, obj_locator, wait: 0.01, visible: visible, minimum: 0).count
end

#crossorigin ⇒ Object

Return crossorigin property

Examples:

with_creds = media_player.crossorigin == 'use-credentials'

Returns:

  • crossorigin value



1008
1009
1010
1011
1012
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 1008

def crossorigin
  obj, = find_element
  object_not_found_exception(obj, @type)
  obj.native.attribute('crossorigin')
end

#disabled? ⇒ Boolean

Is UI object disabled (not enabled)?

Examples:

.disabled?

Returns:

  • (Boolean) 


261
262
263
264
265
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 261

def disabled?
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.disabled?
end

#displayed? ⇒ Boolean

Is UI object displayed in browser window?

Examples:

basket_link.displayed??

Returns:

  • (Boolean) 


515
516
517
518
519
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 515

def displayed?
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj.displayed?
end

#double_click ⇒ Object

Double-click on an object

Examples:

file_image.double_click


132
133
134
135
136
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 132

def double_click
  obj, type = find_element
  object_not_found_exception(obj, type)
  page.driver.browser.action.double_click(obj.native).perform
end

#drag_and_drop(target, right_offset = nil, down_offset = nil) ⇒ Object 



590
591
592
593
594
595
596
597
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 590

def drag_and_drop(target, right_offset = nil, down_offset = nil)
  source, type = find_element
  object_not_found_exception(source, type)
  page.driver.browser.action.click_and_hold(source.native).perform
  sleep(1)
  target_drop, = target.find_element
  page.driver.browser.action.move_to(target_drop.native, right_offset.to_i, down_offset.to_i).release.perform
end

#drag_by(right_offset, down_offset) ⇒ Object 



582
583
584
585
586
587
588
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 582

def drag_by(right_offset, down_offset)
  obj, type = find_element
  object_not_found_exception(obj, type)
  page.driver.browser.action.click_and_hold(obj.native).perform
  sleep(1)
  obj.drag_by(right_offset, down_offset)
end

#enabled? ⇒ Boolean

Is UI object enabled?

Examples:

.enabled?

Returns:

  • (Boolean) 


251
252
253
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 251

def enabled?
  !disabled?
end

#exists?(visible = true) ⇒ Boolean

Does UI object exists?

Examples:

basket_link.exists?

Returns:

  • (Boolean) 


198
199
200
201
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 198

def exists?(visible = true)
  obj, = find_object(visible)
  !obj.nil?
end

#find_element(visible = true) ⇒ Object 



1026
1027
1028
1029
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 1026

def find_element(visible = true)
  wait = Selenium::WebDriver::Wait.new(timeout: Capybara.default_max_wait_time)
  wait.until { find_object(visible) }
end

#focused? ⇒ Boolean

Does UI object have the current focus?

Examples:

first_name_field.focused?

Returns:

  • (Boolean) 


298
299
300
301
302
303
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 298

def focused?
  obj, type = find_element(visible = :all)
  object_not_found_exception(obj, type)
  focused_obj = page.driver.browser.switch_to.active_element
  focused_obj == obj.native
end

#get_attribute(attrib) ⇒ Object 



1014
1015
1016
1017
1018
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 1014

def get_attribute(attrib)
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj[attrib]
end

#get_locator ⇒ Object 



96
97
98
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 96

def get_locator
  @locator
end

#get_locator_type ⇒ Object 



78
79
80
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 78

def get_locator_type
  @locator_type
end

#get_name ⇒ Object 



100
101
102
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 100

def get_name
  @name
end

#get_native_attribute(attrib) ⇒ Object 



1020
1021
1022
1023
1024
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 1020

def get_native_attribute(attrib)
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj.native.attribute(attrib)
end

#get_object_type ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 82

def get_object_type
  if @type
    @type
  else
    obj, type = find_element
    object_not_found_exception(obj, type)
    if obj.tag_name
      obj.tag_name
    elsif obj.native.attribute('type')
      obj.native.attribute('type')
    end
  end
end

#get_value(visible = true) ⇒ Object Also known as: get_caption, caption, value 



521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 521

def get_value(visible = true)
  obj, type = find_element(visible)
  object_not_found_exception(obj, type)
  text = case obj.tag_name.downcase
         when 'input', 'select', 'textarea'
           obj.value
         else
           obj.text
         end
  text.gsub(/[[:space:]]+/, ' ').strip unless text.nil?
end

#height ⇒ Integer

Return height of object.

Examples:

button_height = my_button.height

Returns:

  • (Integer) 


469
470
471
472
473
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 469

def height
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj.get_height
end

#hidden? ⇒ Boolean

Is UI object hidden (not visible)?

Examples:

remember_me_checkbox.hidden?

Returns:

  • (Boolean) 


241
242
243
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 241

def hidden?
  !visible?
end

#highlight(duration = 1) ⇒ Object

Highlight an object with a 3 pixel wide, red dashed border for the specified wait time. If wait time is zero, then the highlight will remain until the page is refreshed

Examples:

error_message.highlight(3)

Parameters:

  • duration (Integer or Float) (defaults to: 1) —

    wait time in seconds



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 606

def highlight(duration = 1)
  obj, type = find_element
  object_not_found_exception(obj, type)
  # store original style so it can be reset later
  @original_style = obj.native.attribute('style')
  # style element with red border
  page.execute_script(
    'arguments[0].setAttribute(arguments[1], arguments[2])',
    obj,
    'style',
    'border: 3px solid red; border-style: dashed;'
  )
  # keep element highlighted for duration and then revert to original style
  if duration.positive?
    sleep duration
    page.execute_script(
      'arguments[0].setAttribute(arguments[1], arguments[2])',
      obj,
      'style',
      @original_style
    )
  end
end

#hover(visible = true) ⇒ Object

Hover the cursor over an object

Examples:

basket_link.hover

Parameters:

  • visible (Boolean, Symbol) (defaults to: true) —

    Only find elements with the specified visibility:

    • true - only finds visible elements.
    • false - finds invisible and visible elements.
    • :all - same as false; finds visible and invisible elements.
    • :hidden - only finds invisible elements.
    • :visible - same as true; only finds visible elements.


557
558
559
560
561
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 557

def hover(visible = true)
  obj, type = find_element(visible)
  object_not_found_exception(obj, type)
  obj.hover
end

#hover_at(x, y, visible = true) ⇒ Object

Hover at a specific location within an object

Examples:

timeline_bar.hover_at(100, 5)

Parameters:

  • x (Integer) —

    X offset

  • y (Integer) —

    Y offset

  • visible (Boolean, Symbol) (defaults to: true) —

    Only find elements with the specified visibility:

    • true - only finds visible elements.
    • false - finds invisible and visible elements.
    • :all - same as false; finds visible and invisible elements.
    • :hidden - only finds invisible elements.
    • :visible - same as true; only finds visible elements.


576
577
578
579
580
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 576

def hover_at(x, y, visible = true)
  obj, = find_element(visible)
  raise "UI #{object_ref_message} not found" unless obj
  obj.hover_at(x, y)
end

#inspect ⇒ String

Return a human readable representation of the UI element

Examples:

buy_now_button.inspect

Returns:



311
312
313
314
315
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 311

def inspect
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.inspect
end

#obscured? ⇒ Boolean

Is UI object obscured (not currently in viewport and not clickable)?

Examples:

buy_now_button.obscured?

Returns:

  • (Boolean) 


286
287
288
289
290
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 286

def obscured?
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.obscured?
end

#required? ⇒ Boolean

Is UI object's required attribute set?

Examples:

first_name_field.required?

Returns:

  • (Boolean) 


273
274
275
276
277
278
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 273

def required?
  obj, type = find_element
  object_not_found_exception(obj, type)
  state = get_attribute(:required)
  state.boolean? ? state : state == 'true'
end

#right_click ⇒ Object

Right-click on an object

Examples:

basket_item_image.right_click


143
144
145
146
147
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 143

def right_click
  obj, type = find_element
  object_not_found_exception(obj, type)
  page.driver.browser.action.context_click(obj.native).perform
end

#role ⇒ String

Return state of UI object's role property

Examples:

buy_now_button.role

Returns:



663
664
665
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 663

def role
  get_attribute('role')
end

#scroll_to(position) ⇒ Object

Scroll the object to its top, middle, or bottom

Examples:

cue_list.scroll_to(:bottom)

Parameters:

  • position (Symbol) —

    :top, :bottom, :center



168
169
170
171
172
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 168

def scroll_to(position)
  obj, type = find_element
  object_not_found_exception(obj, type)
  page.scroll_to(obj, align: position)
end

#send_keys(*keys) ⇒ Object

Send keystrokes to this object.

Examples:

comment_field.send_keys(:enter)

Parameters:



186
187
188
189
190
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 186

def send_keys(*keys)
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.send_keys(*keys)
end

#set(value) ⇒ Object 



174
175
176
177
178
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 174

def set(value)
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.set(value)
end

#set_alt_locator(temp_locator) ⇒ Object 



104
105
106
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 104

def set_alt_locator(temp_locator)
  @alt_locator = temp_locator
end

#set_locator_type(locator = nil) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 63

def set_locator_type(locator = nil)
  locator = @locator if locator.nil?
  is_xpath = XPATH_SELECTORS.any? { |selector| locator.include?(selector) }
  is_css = CSS_SELECTORS.any? { |selector| locator.include?(selector) }
  @locator_type = if is_xpath && !is_css
                    :xpath
                  elsif is_css && !is_xpath
                    :css
                  elsif !is_css && !is_xpath
                    :css
                  else
                    :css
                  end
end

#style ⇒ String

Return UI object's style property

Examples:

buy_now_button.style

Returns:



653
654
655
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 653

def style
  get_attribute('style')
end

#tabindex ⇒ String

Return state of UI object's tabindex property

Examples:

buy_now_button.tabindex

Returns:



673
674
675
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 673

def tabindex
  get_attribute('tabindex')
end

#title ⇒ String

Return UI object's title property

Examples:

buy_now_button.title

Returns:



505
506
507
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 505

def title
  get_attribute(:title)
end

#unhighlight ⇒ Object

Restore a highlighted object's original style

Examples:

store_link.unhighlight


635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 635

def unhighlight
  obj, type = find_element
  object_not_found_exception(obj, type)
  return if @original_style.nil?
  page.execute_script(
    'arguments[0].setAttribute(arguments[1], arguments[2])',
    obj,
    'style',
    @original_style
  )
end

#verify_value(expected, enqueue = false) ⇒ Object Also known as: verify_caption 



537
538
539
540
541
542
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 537

def verify_value(expected, enqueue = false)
  actual = get_value
  enqueue ?
      ExceptionQueue.enqueue_assert_equal(expected.strip, actual.strip, "Expected UI #{object_ref_message}") :
      assert_equal(expected.strip, actual.strip, "Expected UI #{object_ref_message} to display '#{expected}' but found '#{actual}'")
end

#visible? ⇒ Boolean

Is UI object visible?

Examples:

remember_me_checkbox.visible?

Returns:

  • (Boolean) 


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 209

def visible?
  obj, type = find_element
  exists = obj
  invisible = false
  if type == :css
    Capybara.using_wait_time 0.1 do
      # is object itself hidden with .ui-helper-hidden class?
      self_hidden = page.has_css?("#{@locator}.ui-helper-hidden")
      # is parent of object hidden, thus hiding the object?
      parent_hidden = page.has_css?(".ui-helper-hidden > #{@locator}")
      # is grandparent of object, or any other ancestor, hidden?
      other_ancestor_hidden = page.has_css?(".ui-helper-hidden * #{@locator}")
      # if any of the above conditions are true, then object is invisible
      invisible = self_hidden || parent_hidden || other_ancestor_hidden
    end
  else
    invisible = !obj.visible? if exists
  end
  # the object is visible if it exists and it is not invisible
  if exists && !invisible
    true
  else
    false
  end
end

#wait_until_exists(seconds = nil, post_exception = true) ⇒ Object

Wait until the object exists, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

run_button.wait_until_exists(0.5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 324

def wait_until_exists(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { exists? }
rescue StandardError
  if post_exception
    raise "Could not find UI #{object_ref_message} after #{timeout} seconds" unless exists?
  else
    exists?
  end
end

#wait_until_gone(seconds = nil, post_exception = true) ⇒ Object

Wait until the object no longer exists, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

logout_button.wait_until_gone(5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 343

def wait_until_gone(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { !exists? }
rescue StandardError
  if post_exception
    raise "UI #{object_ref_message} remained visible after #{timeout} seconds" if exists?
  else
    exists?
  end
end

#wait_until_hidden(seconds = nil, post_exception = true) ⇒ Object

Wait until the object is hidden, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

run_button.wait_until_hidden(10)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 381

def wait_until_hidden(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { hidden? }
rescue StandardError
  if post_exception
    raise "UI #{object_ref_message} remained visible after #{timeout} seconds" if visible?
  else
    visible?
  end
end

#wait_until_value_changes(seconds = nil, post_exception = true) ⇒ Object

Wait until the object's value changes to a different value, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

basket_grand_total_label.wait_until_value_changes(5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 422

def wait_until_value_changes(seconds = nil, post_exception = true)
  value = get_value
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { get_value != value }
rescue StandardError
  if post_exception
    raise "Value of UI #{object_ref_message} failed to change from '#{value}' after #{timeout} seconds" if get_value == value
  else
    get_value == value
  end
end

#wait_until_value_is(value, seconds = nil, post_exception = true) ⇒ Object

Wait until the object's value equals the specified value, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

card_authorized_label.wait_until_value_is('Card authorized', 5)
  or
total_weight_field.wait_until_value_is({ greater_than: '250' }, 5)

Parameters:

  • value (String or Hash) —

    value expected or comparison hash

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 403

def wait_until_value_is(value, seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { compare(value, get_value) }
rescue StandardError
  if post_exception
    raise "Value of UI #{object_ref_message} failed to equal '#{value}' after #{timeout} seconds" unless get_value == value
  else
    get_value == value
  end
end

#wait_until_visible(seconds = nil, post_exception = true) ⇒ Object

Wait until the object is visible, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

run_button.wait_until_visible(0.5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 362

def wait_until_visible(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { visible? }
rescue StandardError
  if post_exception
    raise "Could not find UI #{object_ref_message} after #{timeout} seconds" unless visible?
  else
    visible?
  end
end

#width ⇒ Integer

Return width of object.

Examples:

button_width = my_button.width

Returns:

  • (Integer) 


457
458
459
460
461
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 457

def width
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj.get_width
end

#x ⇒ Integer

Return x coordinate of object's location.

Examples:

button_x = my_button.x

Returns:

  • (Integer) 


481
482
483
484
485
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 481

def x
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj.get_x
end

#y ⇒ Integer

Return y coordinate of object's location.

Examples:

button_y = my_button.y

Returns:

  • (Integer) 


493
494
495
496
497
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 493

def y
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj.get_y
end