Class: Applitools::Selenium::Target

Inherits:
Object
  • Object
show all
Includes:
FluentInterface, MatchLevelSetter
Defined in:
lib/applitools/selenium/target.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Target

Initialize a Applitools::Selenium::Target instance.



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/applitools/selenium/target.rb', line 29

def initialize
  self.frames = []
  self.options = {
    ignore_mismatch: false,
    script_hooks: { beforeCaptureScreenshot: '' },
    visual_grid_options: {}
  }
  self.regions = {}
  self.convert_coordinates_block = nil
  reset_for_fullscreen
end

Instance Attribute Details

#accessibility_regions ⇒ Object

Returns the value of attribute accessibility_regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def accessibility_regions
  @accessibility_regions
end

#content_regions ⇒ Object

Returns the value of attribute content_regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def content_regions
  @content_regions
end

#convert_coordinates_block ⇒ Object

Returns the value of attribute convert_coordinates_block.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def convert_coordinates_block
  @convert_coordinates_block
end

#coordinate_type ⇒ Object

Returns the value of attribute coordinate_type.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def coordinate_type
  @coordinate_type
end

#dynamic_regions ⇒ Object

Returns the value of attribute dynamic_regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def dynamic_regions
  @dynamic_regions
end

#element ⇒ Object

Returns the value of attribute element.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def element
  @element
end

#floating_regions ⇒ Object

Returns the value of attribute floating_regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def floating_regions
  @floating_regions
end

#frames ⇒ Object

Returns the value of attribute frames.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def frames
  @frames
end

#ignored_regions ⇒ Object

Returns the value of attribute ignored_regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def ignored_regions
  @ignored_regions
end

#layout_regions ⇒ Object

Returns the value of attribute layout_regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def layout_regions
  @layout_regions
end

#options ⇒ Object

Returns the value of attribute options.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def options
  @options
end

#region_to_check ⇒ Object

Returns the value of attribute region_to_check.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def region_to_check
  @region_to_check
end

#regions ⇒ Object

Returns the value of attribute regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def regions
  @regions
end

#strict_regions ⇒ Object

Returns the value of attribute strict_regions.



22
23
24
 
# File 'lib/applitools/selenium/target.rb', line 22

def strict_regions
  @strict_regions
end

Class Method Details

.frame(element) ⇒ Object 



9
10
11
 
# File 'lib/applitools/selenium/target.rb', line 9

def frame(element)
  new.frame(element)
end

.region(*args) ⇒ Object 



17
18
19
 
# File 'lib/applitools/selenium/target.rb', line 17

def region(*args)
  new.region(*args)
end

.window ⇒ Object 



13
14
15
 
# File 'lib/applitools/selenium/target.rb', line 13

def window
  new
end

Instance Method Details

#accessibility(*args) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/applitools/selenium/target.rb', line 250

def accessibility(*args)
  options = Applitools::Utils.extract_options! args
  unless options[:type]
    raise Applitools::EyesError,
      'You should call Target.accessibility(region, type: type). The :type option is required'
  end
  unless Applitools::AccessibilityRegionType.enum_values.include?(options[:type])
    raise Applitools::EyesIllegalArgument,
      "The region type should be one of [#{Applitools::AccessibilityRegionType.enum_values.join(', ')}]"
  end
  handle_frames
  padding_proc = proc { |region| Applitools::AccessibilityRegion.new(region, options[:type]) }

  accessibility_regions << case args.first
    when ::Selenium::WebDriver::Element
      proc do |driver, return_element = false|
        element = applitools_element_from_selenium_element(driver, args.first)
        next element, padding_proc if return_element
        padding_proc.call(element)
    end
    when Applitools::Selenium::Element
      proc do |_driver, return_element = false|
        next args.first, padding_proc if return_element
        padding_proc.call(args.first)
      end
    when Applitools::Region
      Applitools::AccessibilityRegion.new(
        args.first, options[:type]
      )
    when String
      proc do |driver, return_element = false|
        element = driver.find_element(name_or_id: args.first)
        next element, padding_proc if return_element
        padding_proc.call(element)
      end
    when :css
      { region: args[1], type: options[:type] }
    else
      proc do |driver, return_element = false|
        elements = driver.find_elements(*args)
        next elements, padding_proc if return_element
        elements.map { |e| padding_proc.call(e) }
      end
    end
  self
end

#before_render_screenshot_hook(hook) ⇒ Object Also known as: script_hook, hooks 



231
232
233
234
235
236
237
238
 
# File 'lib/applitools/selenium/target.rb', line 231

def before_render_screenshot_hook(hook)
  if hook.is_a?(Hash) && hook[:beforeCaptureScreenshot]
    options[:script_hooks] = hook
  else
    options[:script_hooks][:beforeCaptureScreenshot] = hook
  end
  self
end

#content(*args) ⇒ Object 



103
104
105
106
107
 
# File 'lib/applitools/selenium/target.rb', line 103

def content(*args)
  region = region_from_args(args)
  content_regions << region if region
  self
end

#convert_coordinates(&block) ⇒ Object 



353
354
355
 
# File 'lib/applitools/selenium/target.rb', line 353

def convert_coordinates(&block)
  self.convert_coordinates_block = block
end

#default_full_page_for_vg ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/applitools/selenium/target.rb', line 336

def default_full_page_for_vg
  # if options[:stitch_content].nil?
  #   case region_to_check
  #   when nil
  #     fully(true)
  #   when Proc
  #     begin
  #       r = region_to_check.call
  #       # fully(true) if r == Applitools::Region::EMPTY
  #     rescue StandardError
  #       fully(false)
  #     end
  #   end
  # end
  nil
end

#dynamic(*args) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/applitools/selenium/target.rb', line 297

def dynamic(*args)
  options = Applitools::Utils.extract_options! args
  handle_frames
  padding_proc = proc { |region| Applitools::DynamicRegion.new(region, options[:type]) }

  dynamic_regions << case args.first
    when ::Selenium::WebDriver::Element
      proc do |driver, return_element = false|
        element = applitools_element_from_selenium_element(driver, args.first)
        next element, padding_proc if return_element
        padding_proc.call(element)
      end
    when Applitools::Selenium::Element
      proc do |_driver, return_element = false|
        next args.first, padding_proc if return_element
        padding_proc.call(args.first)
      end
    when Applitools::Region
      Applitools::DynamicRegion.new(
        args.first, options[:type]
      )
    when String
      proc do |driver, return_element = false|
        element = driver.find_element(name_or_id: args.first)
        next element, padding_proc if return_element
        padding_proc.call(element)
      end
    when :css
      { region: args[1], type: options[:type] }
    else
      proc do |driver, return_element = false|
        elements = driver.find_elements(*args)
        next elements, padding_proc if return_element
        elements.map { |e| padding_proc.call(e) }
      end
    end
  self
end

#exact(*args) ⇒ Object 



115
116
117
 
# File 'lib/applitools/selenium/target.rb', line 115

def exact(*args)
  match_level(Applitools::MatchLevel::EXACT, *args)
end

#finalize ⇒ Object 



243
244
245
246
247
248
 
# File 'lib/applitools/selenium/target.rb', line 243

def finalize
  return self unless frame_or_element
  region = frame_or_element
  self.frame_or_element = nil
  dup.region(region)
end

#floating(region_or_element, bounds, left, top, right, bottom, padding) ⇒ Object

Sets the wanted floating region

Examples:

target.floating(:id, 'my_id', 10, 10, 10, 10)
target.floating(:id, 'my_id', Applitools::FloatingBounds.new(10, 10, 10, 10))
target.floating(region, Applitools::FloatingBounds.new(10, 10, 10, 10))
target.floating(floating_region)
target.floating(floating_region, bounds)
target.floating(:id, 'my_id', Applitools::FloatingBounds.new(10, 10, 10, 10), Applitools::PaddingBounds.new(10, 10, 10, 10))

Parameters:

  • region_or_element (Applitools::FloatingRegion, Selenium::WebDriver::Element, Applitools::Selenium::Element, Applitools::Region)
  • bounds (Applitools::FloatingBounds)
  • left (Integer)
  • top (Integer)
  • right (Integer)
  • bottom (Integer)
  • padding (Applitools::PaddingBounds) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/applitools/selenium/target.rb', line 81

def floating(*args)
  options = Applitools::Utils.extract_options!(args)
  padding = options && options[:padding]
  requested_padding = get_requested_padding(padding, args)
  bounds = get_bounds(args)
  value = convert_to_universal(args)
  value = { type: args[0], selector: args[1] } if value.nil?
  value = value[:selector] if value.is_a?(Hash) && (value[:type].to_s === 'id')
  region = { region: value }
  region.merge!(bounds) if bounds != {}
  region.merge!(padding: requested_padding) if requested_padding != {}
  region.merge!(regionId: options[:region_id]) if options[:region_id]
  floating_regions << region
  self
end

#frame(*args) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/applitools/selenium/target.rb', line 184

def frame(*args)
  element = case args.first
            when ::Selenium::WebDriver::Element, Applitools::Selenium::Element, String
              args.first
            else
              proc { |d| d.find_element(*args) }
            end
  frames << element
  # frames << frame_or_element if frame_or_element
  # self.frame_or_element = element
  reset_for_fullscreen
  self
end

#fully(value = true) ⇒ Object 



172
173
174
175
176
 
# File 'lib/applitools/selenium/target.rb', line 172

def fully(value = true)
  options[:stitch_content] = value ? true : false
  handle_frames
  self
end

#ignore(region_or_element, how, what, padding = Applitools::PaddingBounds::PIXEL_PADDING) ⇒ Object

Add the wanted ignored regions.

Parameters:

  • region_or_element (Applitools::Selenium::Element, Applitools::Region, ::Selenium::WebDriver::Element) —

    the region to ignore or an element representing the region to ignore

  • how (Symbol, String) —

    A finder to be used (see Selenium::WebDriver documentation for complete list of available finders)

  • what (Symbol, String) —

    An id or selector to find



48
49
50
51
52
53
54
55
56
 
# File 'lib/applitools/selenium/target.rb', line 48

def ignore(*args)
  if args.empty?
    reset_ignore
  else
    region = region_from_args(args)
    ignored_regions << region if region
  end
  self
end

#layout(*args) ⇒ Object 



97
98
99
100
101
 
# File 'lib/applitools/selenium/target.rb', line 97

def layout(*args)
  region = region_from_args(args)
  layout_regions << region if region
  self
end

#layout_breakpoints(value = true) ⇒ Object 



370
371
372
373
374
375
376
377
 
# File 'lib/applitools/selenium/target.rb', line 370

def layout_breakpoints(value = true)
  if value.is_a?(Hash) && (value.has_key?(:breakpoints) || value.has_key?('breakpoints'))
    options[:layout_breakpoints] = value
  else
    options[:layout_breakpoints] = { breakpoints: value }
  end
  self
end

#lazy_load(*args) ⇒ Object

scroll_length, waiting_time, max_amount_to_scroll



391
392
393
394
 
# File 'lib/applitools/selenium/target.rb', line 391

def lazy_load(*args) # scroll_length, waiting_time, max_amount_to_scroll
  options[:lazy_load] = args.is_a?(Hash) ? args : true
  self
end

#page_id(value) ⇒ Object 



385
386
387
388
389
 
# File 'lib/applitools/selenium/target.rb', line 385

def page_id(value)
  Applitools::ArgumentGuard.not_nil(value, 'page_id')
  options[:page_id] = value
  self
end

#process_region(*args) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/applitools/selenium/target.rb', line 125

def process_region(*args)
  r = args.first
  case r
  when ::Selenium::WebDriver::Element
    proc do |driver|
      applitools_element_from_selenium_element(driver, args.dup.first)
    end
  when Applitools::Region, Applitools::Selenium::Element
    proc { r }
  else
    proc do |driver|
      args_dup = args.dup
      driver.find_element(args_dup.shift, args_dup.shift)
    end
  end
end

#region(element, how, what) ⇒ Applitools::Selenium::Target

Add the desired region.

Examples:

Add region by element

target.region(an_element)

Add target region by finder

target.region(:id, 'target_region')

Parameters:

  • element (Applitools::Selenium::Element, Applitools::Region, ::Selenium::WebDriver::Element) —

    the target region or an element representing the target region

  • how (Symbol, String) —

    The finder to be used (:css, :id, etc. see Selenium::WebDriver documentation for complete list of available finders)

  • what (Symbol, String) —

    Selector or id of an element

Returns:



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/applitools/selenium/target.rb', line 209

def region(*args)
  value = convert_to_universal(args)
  value = { type: args[0], selector: args[1] } if value.nil?
  value = value[:selector] if value.is_a?(Hash) && (value[:type].to_s === 'id')
  self.region_to_check = value
  self.coordinate_type = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
  options[:timeout] = nil
  reset_ignore
  reset_floating
  self
end

#replace_element(original, new, array) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/applitools/selenium/target.rb', line 161

def replace_element(original, new, array)
  case new
  when Array
    index = array.index(original)
    array.delete_at(index)
    array.insert(index, *new)
  when Applitools::Selenium::VGRegion
    array[array.index(original)] = new
  end
end

#replace_region(original_region, new_region, key) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/applitools/selenium/target.rb', line 142

def replace_region(original_region, new_region, key)
  case key
  when :content_regions
    replace_element(original_region, new_region, content_regions)
  when :strict_regions
    replace_element(original_region, new_region, strict_regions)
  when :layout_regions
    replace_element(original_region, new_region, layout_regions)
  when :floating
    replace_element(original_region, new_region, floating_regions)
  when :ignore
    replace_element(original_region, new_region, ignored_regions)
  when :accessibility_regions
    replace_element(original_region, new_region, accessibility_regions)
  when :dynamic_regions
    replace_element(original_region, new_region, dynamic_regions)
  end
end

#scroll_root_element(by, what = nil) ⇒ Object 



357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/applitools/selenium/target.rb', line 357

def scroll_root_element(by, what = nil)
  options[:scroll_root_element] = if is_element?(by)
    ref = by.ref
    ref = by.ref[1] if ref.is_a?(Array) && ref[0] === :element
    { elementId: ref }
  elsif what
    { type: by.to_s, selector: what }
  else
    by
  end
  self
end

#send_dom(value = true) ⇒ Object 



221
222
223
224
 
# File 'lib/applitools/selenium/target.rb', line 221

def send_dom(value = true)
  options[:send_dom] = value ? true : false
  self
end

#strict(*args) ⇒ Object 



109
110
111
112
113
 
# File 'lib/applitools/selenium/target.rb', line 109

def strict(*args)
  region = region_from_args(args)
  strict_regions << region if region
  self
end

#use_dom(value = true) ⇒ Object 



226
227
228
229
 
# File 'lib/applitools/selenium/target.rb', line 226

def use_dom(value = true)
  options[:use_dom] = value ? true : false
  self
end

#variation_group_id(value) ⇒ Object 



178
179
180
181
182
 
# File 'lib/applitools/selenium/target.rb', line 178

def variation_group_id(value)
  Applitools::ArgumentGuard.not_nil(value, 'variation_group_id')
  options[:variation_group_id] = value
  self
end

#visual_grid_options(value) ⇒ Object 



119
120
121
122
123
 
# File 'lib/applitools/selenium/target.rb', line 119

def visual_grid_options(value)
  Applitools::ArgumentGuard.hash(value, 'value')
  options[:visual_grid_options] = value
  self
end

#wait_before_capture(value) ⇒ Object 



379
380
381
382
383
 
# File 'lib/applitools/selenium/target.rb', line 379

def wait_before_capture(value)
  Applitools::ArgumentGuard.not_nil(value, 'wait_before_capture')
  options[:wait_before_capture] = value
  self
end