Class: TestCentricity::Elements::UIElement

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

Constant Summary collapse

XPATH_SELECTORS = 
['//', '[@', '[contains(']
CSS_SELECTORS = 
%w[# :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.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 54

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

Instance Attribute Details

#alt_locator ⇒ Object

Returns the value of attribute alt_locator.



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

def alt_locator
  @alt_locator
end

#base_object ⇒ Object

Returns the value of attribute base_object.



48
49
50
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 48

def base_object
  @base_object
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



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

def context
  @context
end

#locator ⇒ Object (readonly)

Returns the value of attribute locator.



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

def locator
  @locator
end

#locator_type ⇒ Object

Returns the value of attribute locator_type.



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

def locator_type
  @locator_type
end

#mru_driver ⇒ Object

Returns the value of attribute mru_driver.



49
50
51
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 49

def mru_driver
  @mru_driver
end

#mru_locator ⇒ Object

Returns the value of attribute mru_locator.



49
50
51
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 49

def mru_locator
  @mru_locator
end

#mru_object ⇒ Object

Returns the value of attribute mru_object.



49
50
51
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 49

def mru_object
  @mru_object
end

#mru_parent ⇒ Object

Returns the value of attribute mru_parent.



49
50
51
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 49

def mru_parent
  @mru_parent
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#original_style ⇒ Object

Returns the value of attribute original_style.



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

def original_style
  @original_style
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



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

def parent
  @parent
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



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

def type
  @type
end

Instance Method Details

#aria_autocomplete ⇒ Boolean

Return state of UI object's aria-autocomplete property

Examples:

email_field.aria_autocomplete

Returns:

  • (Boolean) 


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

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) 


1073
1074
1075
1076
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1073

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) 


1029
1030
1031
1032
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1029

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) 


829
830
831
832
833
834
835
836
837
838
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 829

def aria_colcount
  cols = get_attribute('aria-colcount')
  unless cols.blank?
    if cols.is_int?
      cols.to_i
    else
      cols
    end
  end
end

#aria_controls ⇒ String

Return state of UI object's aria-controls property

Examples:

video_menu.aria_controls

Returns:



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

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:



782
783
784
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 782

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) 


963
964
965
966
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 963

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) 


996
997
998
999
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 996

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) 


1040
1041
1042
1043
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1040

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) 


985
986
987
988
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 985

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) 


1018
1019
1020
1021
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1018

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

#aria_keyshortcuts ⇒ String

Return state of UI object's aria-keyshortcuts property

Examples:

play_button.aria_keyshortcuts

Returns:



923
924
925
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 923

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:



762
763
764
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 762

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:



772
773
774
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 772

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:



792
793
794
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 792

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) 


1084
1085
1086
1087
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1084

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) 


1095
1096
1097
1098
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1095

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) 


1106
1107
1108
1109
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1106

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

#aria_orientation ⇒ String

Return state of UI object's aria-orientation property

Examples:

volume_slider.aria_orientation

Returns:



913
914
915
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 913

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) 


1051
1052
1053
1054
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1051

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) 


1062
1063
1064
1065
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1062

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) 


1007
1008
1009
1010
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1007

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

#aria_roledescription ⇒ String

Return state of UI object's aria-roledescription property

Examples:

editor_button.aria_roledescription

Returns:



933
934
935
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 933

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) 


812
813
814
815
816
817
818
819
820
821
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 812

def aria_rowcount
  rows = get_attribute('aria-rowcount')
  unless rows.blank?
    if rows.is_int?
      rows.to_i
    else
      rows
    end
  end
end

#aria_selected? ⇒ Boolean

Return state of UI object's aria-selected property

Examples:

nutrition_info_tab.aria_selected?

Returns:

  • (Boolean) 


974
975
976
977
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 974

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:



802
803
804
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 802

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) 


846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 846

def aria_valuemax
  max = get_attribute('aria-valuemax')
  unless max.blank?
    if max.is_int?
      max.to_i
    elsif max.is_float?
      max.to_f
    else
      max
    end
  end
end

#aria_valuemin ⇒ Integer

Return state of UI object's aria-valuemin property

Examples:

volume_slider.aria_valuemin

Returns:

  • (Integer) 


865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 865

def aria_valuemin
  min = get_attribute('aria-valuemin')
  unless min.blank?
    if min.is_int?
      min.to_i
    elsif min.is_float?
      min.to_f
    else
      min
    end
  end
end

#aria_valuenow ⇒ Integer

Return state of UI object's aria-valuenow property

Examples:

volume_slider.aria_valuenow

Returns:

  • (Integer) 


884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 884

def aria_valuenow
  result = get_attribute('aria-valuenow')
  unless result.blank?
    if result.is_int?
      result.to_i
    elsif result.is_float?
      result.to_f
    else
      result
    end
  end
end

#aria_valuetext ⇒ String

Return state of UI object's aria-valuetext property

Examples:

volume_slider.aria_valuetext

Returns:



903
904
905
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 903

def aria_valuetext
  get_attribute('aria-valuetext')
end

#clear_alt_locator ⇒ Object 



118
119
120
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 118

def clear_alt_locator
  @alt_locator = nil
end

#click ⇒ Object

Click on an object

Examples:

basket_link.click



127
128
129
130
131
132
133
134
135
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 127

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



166
167
168
169
170
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 166

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) 


1117
1118
1119
1120
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1117

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.


487
488
489
490
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 487

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



1128
1129
1130
1131
1132
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1128

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) 


252
253
254
255
256
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 252

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) 


556
557
558
559
560
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 556

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



142
143
144
145
146
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 142

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 



648
649
650
651
652
653
654
655
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 648

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 



640
641
642
643
644
645
646
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 640

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

#draggable? ⇒ Boolean

Return state of UI object's draggable property

Examples:

puzzle_piece_21.draggable?

Returns:

  • (Boolean) 


568
569
570
571
572
573
574
575
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 568

def draggable?
  state = get_attribute(:draggable)
  if state.is_a?(String)
    state.to_bool
  elsif state.boolean?
    state
  end
end

#enabled? ⇒ Boolean

Is UI object enabled?

Examples:

.enabled?

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 242

def enabled?
  !disabled?
end

#exists?(visible = true) ⇒ Boolean

Does UI object exists?

Examples:

basket_link.exists?

Returns:

  • (Boolean) 


208
209
210
211
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 208

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

#find_element(visible = true) ⇒ Object 



1147
1148
1149
1150
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1147

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) 


289
290
291
292
293
294
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 289

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 



1134
1135
1136
1137
1138
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1134

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

#get_locator ⇒ Object 



106
107
108
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 106

def get_locator
  @locator
end

#get_locator_type ⇒ Object 



88
89
90
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 88

def get_locator_type
  @locator_type
end

#get_max ⇒ Integer

Return max attribute of a number type text field or a progress bar.

Examples:

max_points_value = points_field.get_max

Returns:

  • (Integer) 


711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 711

def get_max
  obj, = find_element
  object_not_found_exception(obj, nil)
  max = obj.native.attribute('max')
  unless max.blank?
    if max.is_int?
      max.to_i
    elsif max.is_float?
      max.to_f
    else
      max
    end
  end
end

#get_name ⇒ Object 



110
111
112
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 110

def get_name
  @name
end

#get_native_attribute(attrib) ⇒ Object 



1140
1141
1142
1143
1144
1145
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 1140

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

#get_object_type ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 92

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 



577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 577

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

#height ⇒ Integer

Return height of object.

Examples:

button_height = my_button.height

Returns:

  • (Integer) 


510
511
512
513
514
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 510

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) 


232
233
234
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 232

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



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 664

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.


615
616
617
618
619
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 615

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.


634
635
636
637
638
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 634

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

#obscured? ⇒ Boolean

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

Examples:

buy_now_button.obscured?

Returns:

  • (Boolean) 


277
278
279
280
281
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 277

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) 


264
265
266
267
268
269
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 264

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

#reset_mru_cache ⇒ Object 



66
67
68
69
70
71
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 66

def reset_mru_cache
  @mru_object = nil
  @mru_locator = nil
  @mru_parent = nil
  @mru_driver = nil
end

#right_click ⇒ Object

Right-click on an object

Examples:

basket_item_image.right_click



153
154
155
156
157
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 153

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:



742
743
744
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 742

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



178
179
180
181
182
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 178

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:



196
197
198
199
200
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 196

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

#set(value) ⇒ Object 



184
185
186
187
188
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 184

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

#set_alt_locator(temp_locator) ⇒ Object 



114
115
116
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 114

def set_alt_locator(temp_locator)
  @alt_locator = temp_locator
end

#set_locator_type(locator = nil) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 73

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:



732
733
734
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 732

def style
  get_attribute('style')
end

#tabindex ⇒ String

Return state of UI object's tabindex property

Examples:

buy_now_button.tabindex

Returns:



752
753
754
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 752

def tabindex
  get_attribute('tabindex')
end

#title ⇒ String

Return UI object's title property

Examples:

buy_now_button.title

Returns:



546
547
548
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 546

def title
  get_attribute(:title)
end

#unhighlight ⇒ Object

Restore a highlighted object's original style

Examples:

store_link.unhighlight



693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 693

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 



595
596
597
598
599
600
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 595

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) 


219
220
221
222
223
224
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 219

def visible?
  obj, = find_element
  exists = obj
  # the object is visible if it exists and it is not invisible
  exists && obj.visible?
end

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

Wait until the object is enabled, 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_enabled(10)

Parameters:

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

    wait time in seconds



391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 391

def wait_until_enabled(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until do
    reset_mru_cache
    enabled?
  end
rescue StandardError
  if post_exception
    raise "UI #{object_ref_message} remained disabled after #{timeout} seconds" unless enabled?
  else
    enabled?
  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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 303

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 do
    reset_mru_cache
    exists?
  end
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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 325

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 do
    reset_mru_cache
    !exists?
  end
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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 369

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 do
    reset_mru_cache
    hidden?
  end
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



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 460

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 do
    reset_mru_cache
    get_value != value
  end
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



438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 438

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 do
    reset_mru_cache
    compare(value, get_value)
  end
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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 347

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 do
    reset_mru_cache
    visible?
  end
rescue StandardError
  if post_exception
    raise "Could not find UI #{object_ref_message} after #{timeout} seconds" unless visible?
  else
    visible?
  end
end

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

Wait until the object is no longer in a busy state, 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:

.wait_while_busy(10)

Parameters:

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

    wait time in seconds



413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 413

def wait_while_busy(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until do
    reset_mru_cache
    aria_busy?
  end
rescue StandardError
  if post_exception
    raise "UI #{object_ref_message} remained in busy state after #{timeout} seconds" if aria_busy?
  else
    aria_busy?
  end
end

#width ⇒ Integer

Return width of object.

Examples:

button_width = my_button.width

Returns:

  • (Integer) 


498
499
500
501
502
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 498

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) 


522
523
524
525
526
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 522

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) 


534
535
536
537
538
 
# File 'lib/testcentricity_web/web_elements/ui_element.rb', line 534

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