Class: TestCentricity::SelectList

Inherits:
UIElement show all
Defined in:
lib/testcentricity_web/web_elements/select_list.rb

Constant Summary

Constants inherited from UIElement

UIElement::CSS_SELECTORS, UIElement::XPATH_SELECTORS

Instance Attribute Summary collapse

Attributes inherited from UIElement

#alt_locator, #context, #locator, #locator_type, #name, #original_style, #parent, #type

Instance Method Summary collapse

Methods inherited from UIElement

#aria_checked?, #aria_colcount, #aria_describedby, #aria_disabled?, #aria_expanded?, #aria_haspopup?, #aria_hidden?, #aria_invalid?, #aria_label, #aria_labelledby, #aria_live, #aria_pressed?, #aria_readonly?, #aria_required?, #aria_rowcount, #aria_selected?, #aria_sort, #clear_alt_locator, #click, #click_at, #count, #disabled?, #displayed?, #double_click, #drag_and_drop, #drag_by, #enabled?, #exists?, #get_attribute, #get_locator, #get_locator_type, #get_name, #get_native_attribute, #get_object_type, #get_siebel_object_type, #get_value, #height, #hidden?, #highlight, #hover, #hover_at, #invoke_siebel_dialog, #right_click, #role, #send_keys, #set_alt_locator, #set_locator_type, #style, #tabindex, #title, #unhighlight, #verify_value, #visible?, #wait_until_exists, #wait_until_gone, #wait_until_hidden, #wait_until_value_changes, #wait_until_value_is, #wait_until_visible, #width, #x, #y

Constructor Details

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

Returns a new instance of SelectList.



9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 9

def initialize(name, parent, locator, context)
  super
  @type = :selectlist
  list_spec = {
    selected_item: "li[class*='result-selected']",
    list_item:     "li[class*='active-result']",
    list_trigger:  nil,
    text_field:    nil,
    options_list:  nil
  }
  define_list_elements(list_spec)
end

Instance Attribute Details

#list_item ⇒ Object

Returns the value of attribute list_item.



3
4
5
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 3

def list_item
  @list_item
end

#list_trigger ⇒ Object

Returns the value of attribute list_trigger.



5
6
7
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 5

def list_trigger
  @list_trigger
end

#options_list ⇒ Object

Returns the value of attribute options_list.



7
8
9
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 7

def options_list
  @options_list
end

#selected_item ⇒ Object

Returns the value of attribute selected_item.



4
5
6
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 4

def selected_item
  @selected_item
end

#text_field ⇒ Object

Returns the value of attribute text_field.



6
7
8
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 6

def text_field
  @text_field
end

Instance Method Details

#choose_option(option) ⇒ Object

Select the specified option in a select box object. Accepts a String or Hash. Supports standard HTML select objects and Chosen select objects.

Examples:

province_select.choose_option('Alberta')
province_select.choose_option(value: 'AB')
state_select.choose_option(index: 24)
state_select.choose_option(text: 'Maryland')

Parameters:

  • option (String) —

    text of option to select OR

  • option (Hash) —

    :value, :index, or :text of option to select



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 54

def choose_option(option)
  obj, = find_element
  object_not_found_exception(obj, nil)

  unless @list_trigger.nil? && @options_list.nil?
    obj.find(:css, @list_trigger).click
    menu = obj.find(:css, @options_list, minimum: 0, wait: 2)
    object_not_found_exception(menu, nil)
    raise "Could not find option #{option} to choose" unless first(:css, @list_item, minimum: 0, wait: 2)

    if option.is_a?(Array)
      option.each do |item|
        page.find(:css, @list_item, text: item.strip).click
      end
    else
      if option.is_a?(Hash)
        page.find(:css, "#{@list_item}:nth-of-type(#{option[:index]})").click if option.key?(:index)
        page.find(:css, "#{@list_item}:nth-of-type(#{option[:value]})").click if option.key?(:value)
        page.find(:css, "#{@list_item}:nth-of-type(#{option[:text]})").click if option.key?(:text)
      else
        options = obj.all(@list_item).collect(&:text)
        sleep(2) unless options.include?(option)
        first(:css, @list_item, text: option).click
      end
    end
    return
  end

  if @list_trigger.nil?
    obj.click
  else
    page.find(:css, @list_trigger).click
    sleep(1)
  end

  if first(:css, @list_item, minimum: 0, wait: 2)
    if option.is_a?(Array)
      option.each do |item|
        page.find(:css, @list_item, text: item.strip).click
      end
    else
      if option.is_a?(Hash)
        page.find(:css, "#{@list_item}:nth-of-type(#{option[:index]})").click if option.key?(:index)
        page.find(:css, "#{@list_item}:nth-of-type(#{option[:value]})").click if option.key?(:value)
        page.find(:css, "#{@list_item}:nth-of-type(#{option[:text]})").click if option.key?(:text)
      else
        options = obj.all(@list_item).collect(&:text)
        sleep(2) unless options.include?(option)
        first(:css, @list_item, text: option).click
      end
    end
  else
    if option.is_a?(Array)
      option.each do |item|
        select_item(obj, item)
      end
    else
      select_item(obj, option)
    end
  end
end

#choose_siebel_option(option) ⇒ Object

Select the specified option in a Siebel OUI select box object.

Examples:

country_select.choose_siebel_option('Cayman Islands')

Parameters:

  • option (String) —

    text of option to select



222
223
224
225
226
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 222

def choose_siebel_option(option)
  Capybara.wait_on_first_by_default = true
  invoke_siebel_popup
  first(:xpath, "//li[@class='ui-menu-item']", exact: true, match: :prefer_exact, text: option).click
end

#define_list_elements(element_spec) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 22

def define_list_elements(element_spec)
  element_spec.each do |element, value|
    case element
    when :list_item
      @list_item = value
    when :selected_item
      @selected_item = value
    when :list_trigger
      @list_trigger = value
    when :text_field
      @text_field = value
    when :options_list
      @options_list = value
    else
      raise "#{element} is not a recognized selectlist element"
    end
  end
end

#get_option_count ⇒ Integer Also known as: get_item_count

Return the number of options in a select box object. Supports standard HTML select objects and Chosen select objects.

Examples:

num_colors = color_select.get_option_count

Returns:

  • (Integer) 


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 165

def get_option_count
  obj, = find_element
  object_not_found_exception(obj, nil)
  if @list_trigger.nil? && @options_list.nil?
    if obj.first(:css, @list_item, minimum: 0, wait: 2)
      obj.all(@list_item).count
    else
      obj.all('option', visible: :all).count
    end
  else
    obj.find(:css, @list_trigger).click
    menu = obj.find(:css, @options_list, minimum: 0, wait: 2)
    object_not_found_exception(menu, nil)
    num_items = menu.all(@list_item, visible: true, minimum: 0, wait: 2).count
    obj.find(:css, @list_trigger).click
    num_items
  end
end

#get_options ⇒ Array Also known as: get_list_items

Return array of strings of all options in a select box object. Supports standard HTML select objects and Chosen select objects.

Examples:

all_colors = color_select.get_options

Returns:

  • (Array) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 137

def get_options
  obj, = find_element
  object_not_found_exception(obj, nil)
  if @list_trigger.nil? && @options_list.nil?
    if obj.first(:css, @list_item, minimum: 0, wait: 2)
      obj.all(@list_item).collect(&:text)
    else
      obj.all('option', visible: :all).collect(&:text)
    end
  else
    obj.find(:css, @list_trigger).click
    menu = obj.find(:css, @options_list, minimum: 0, wait: 2)
    object_not_found_exception(menu, nil)
    options = menu.all(@list_item, visible: true, minimum: 0, wait: 2).collect(&:text)
    obj.find(:css, @list_trigger).click
    options
  end
end

#get_selected_option ⇒ String Also known as: selected?

Return text of first selected option in a select box object. Supports standard HTML select objects and Chosen select objects.

Examples:

current_color = color_select.get_selected_option

Returns:



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 202

def get_selected_option
  obj, = find_element
  object_not_found_exception(obj, nil)
  if obj.first(:css, @list_item, minimum: 0)
    obj.first(:css, @selected_item).text
  elsif obj.first(:css, @selected_item, minimum: 0)
    obj.first(:css, @selected_item).text
  else
    obj.first('option[selected]', visible: :all).text
  end
end

#get_siebel_options ⇒ Array

Return array of strings of all options in a Siebel OUI select box object.

Examples:

all_countries = country_select.get_siebel_options

Returns:

  • (Array) 


234
235
236
237
238
239
240
241
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 234

def get_siebel_options
  invoke_siebel_popup
  sleep(0.5)
  options = page.all(:xpath, "//li[@class='ui-menu-item']").collect(&:text)
  obj, = find_element
  obj.native.send_keys(:escape)
  options
end

#read_only? ⇒ Boolean

Is Siebel JComboBox set to read-only?

Examples:

country_select.read_only?

Returns:

  • (Boolean) 


262
263
264
265
266
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 262

def read_only?
  obj, = find_element
  object_not_found_exception(obj, nil)
  !obj.native.attribute('readonly')
end

#set(text) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 116

def set(text)
  if @text_field.nil?
    raise "A 'text_field' list element must be defined before calling the 'set' method on a selectlist object"
  end
  obj, = find_element
  object_not_found_exception(obj, nil)
  if @list_trigger.nil?
    obj.click
  else
    page.find(:css, @list_trigger).click
  end
  page.find(:css, @text_field, wait: 2).set(text)
end

#verify_options(expected, enqueue = false) ⇒ Object 



186
187
188
189
190
191
192
193
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 186

def verify_options(expected, enqueue = false)
  actual = get_options
  if enqueue
    ExceptionQueue.enqueue_assert_equal(expected, actual, "Expected list of options in list #{object_ref_message}")
  else
    assert_equal(expected, actual, "Expected list of options in list #{object_ref_message} to be #{expected} but found #{actual}")
  end
end

#verify_siebel_options(expected, enqueue = false) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/testcentricity_web/web_elements/select_list.rb', line 243

def verify_siebel_options(expected, enqueue = false)
  invoke_siebel_popup
  sleep(0.5)
  actual = page.all(:xpath, "//li[@class='ui-menu-item']").collect(&:text)
  if enqueue
    ExceptionQueue.enqueue_assert_equal(expected, actual, "Expected list of options in list #{object_ref_message}")
  else
    assert_equal(expected, actual, "Expected list of options in list #{object_ref_message} to be #{expected} but found #{actual}")
  end
  obj, = find_element
  obj.native.send_keys(:escape)
end