Class: Applitools::MatchWindowData

Inherits:
Object
  • Object
show all
Defined in:
lib/applitools/core/match_window_data.rb

Direct Known Subclasses

MatchSingleCheckData

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default_image_match_settings = nil) ⇒ MatchWindowData

Returns a new instance of MatchWindowData.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/applitools/core/match_window_data.rb', line 61

def initialize(default_image_match_settings = nil)
  @app_output = nil
  @ignored_regions = []
  @floating_regions = []
  @need_convert_ignored_regions_coordinates = false
  @need_convert_floating_regions_coordinates = false
  @need_convert_strict_regions_coordinates = false
  @need_convert_content_regions_coordinates = false
  @need_convert_layout_regions_coordinates = false
  @need_convert_accessibility_regions_coordinates = false
  self.default_image_match_settings = default_image_match_settings.deep_dup || Applitools::ImageMatchSettings.new
end

Instance Attribute Details

#app_output ⇒ Object

Returns the value of attribute app_output.



59
60
61
 
# File 'lib/applitools/core/match_window_data.rb', line 59

def app_output
  @app_output
end

#default_image_match_settings ⇒ Object

Returns the value of attribute default_image_match_settings.



59
60
61
 
# File 'lib/applitools/core/match_window_data.rb', line 59

def default_image_match_settings
  @default_image_match_settings
end

#ignore_mismatch ⇒ Object

Returns the value of attribute ignore_mismatch.



59
60
61
 
# File 'lib/applitools/core/match_window_data.rb', line 59

def ignore_mismatch
  @ignore_mismatch
end

#options ⇒ Object

Returns the value of attribute options.



59
60
61
 
# File 'lib/applitools/core/match_window_data.rb', line 59

def options
  @options
end

#tag ⇒ Object

Returns the value of attribute tag.



59
60
61
 
# File 'lib/applitools/core/match_window_data.rb', line 59

def tag
  @tag
end

#user_inputs ⇒ Object

Returns the value of attribute user_inputs.



59
60
61
 
# File 'lib/applitools/core/match_window_data.rb', line 59

def user_inputs
  @user_inputs
end

Class Method Details

.convert_coordinates(region, screenshot) ⇒ Object 



6
7
8
9
10
11
12
13
 
# File 'lib/applitools/core/match_window_data.rb', line 6

def convert_coordinates(region, screenshot)
  return region.with_padding.to_hash if region.respond_to?(:converted?) && region.converted?
  screenshot.convert_region_location(
    region.with_padding,
    Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
    Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
  ).to_hash
end

.default_data ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/applitools/core/match_window_data.rb', line 15

def default_data
  {
    'IgnoreMismatch' => false,
    'MismatchWait' => 0,
    'Options' => {
      'Name' => nil,
      'UserInputs' => [],
      'IgnoreExpectedOutputSettings' => false,
      'ForceMatch' => false,
      'ForceMismatch' => false,
      'IgnoreMatch' => false,
      'IgnoreMismatch' => false,
      'Trim' => {
        'Enabled' => false
      },
      'RenderId' => ''
    },
    'Id' => nil,
    'UserInputs' => [],
    'AppOutput' => {
      'Screenshot64' => nil,
      'ScreenshotUrl' => nil,
      'Title' => nil,
      'IsPrimary' => false,
      'Elapsed' => 0,
      'Location' => {
        'X' => 0,
        'Y' => 0
      }
    },
    'Tag' => nil,
    'RenderId' => ''
  }
end

.valid_input(_i) ⇒ Object 



54
55
56
 
# File 'lib/applitools/core/match_window_data.rb', line 54

def valid_input(_i)
  true
end

.valid_region(_r) ⇒ Object 



50
51
52
 
# File 'lib/applitools/core/match_window_data.rb', line 50

def valid_region(_r)
  true
end

Instance Method Details

#accessibility_regions=(value) ⇒ Object 



132
133
134
135
136
137
 
# File 'lib/applitools/core/match_window_data.rb', line 132

def accessibility_regions=(value)
  Applitools::ArgumentGuard.is_a? value, 'value', Array
  value.each do |r|
    default_image_match_settings.accessibility << r.to_hash if self.class.valid_region(r)
  end
end

#accessibility_validation ⇒ Object 



328
329
330
 
# File 'lib/applitools/core/match_window_data.rb', line 328

def accessibility_validation
  default_image_match_settings.accessibility_level
end

#accessibility_validation=(value) ⇒ Object 



332
333
334
 
# File 'lib/applitools/core/match_window_data.rb', line 332

def accessibility_validation=(value)
  default_image_match_settings.accessibility_level = value
end

#content_regions=(value) ⇒ Object 



125
126
127
128
129
130
 
# File 'lib/applitools/core/match_window_data.rb', line 125

def content_regions=(value)
  Applitools::ArgumentGuard.is_a? value, 'value', Array
  value.each do |r|
    default_image_match_settings.content << r.to_hash if self.class.valid_region(r)
  end
end

#convert_accessibility_regions_coordinates ⇒ Object 



360
361
362
363
364
 
# File 'lib/applitools/core/match_window_data.rb', line 360

def convert_accessibility_regions_coordinates
  return unless @need_convert_accessibility_regions_coordinates
  self.accessibility_regions = convert_regions_coordinates(@accessibility_regions)
  @need_convert_accessibility_regions_coordinates = false
end

#convert_content_regions_coordinates ⇒ Object 



354
355
356
357
358
 
# File 'lib/applitools/core/match_window_data.rb', line 354

def convert_content_regions_coordinates
  return unless @need_convert_content_regions_coordinates
  self.content_regions = convert_regions_coordinates(@content_regions)
  @need_convert_content_regions_coordinates = false
end

#convert_floating_regions_coordinates ⇒ Object 



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/applitools/core/match_window_data.rb', line 370

def convert_floating_regions_coordinates
  return unless @need_convert_floating_regions_coordinates
  unless app_output.screenshot.nil?
    self.floating_regions = @floating_regions.map do |r|
      updated_region = app_output.screenshot.convert_region_location(
        r,
        Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
        Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
      )
      updated_region.to_hash
      Applitools::FloatingRegion.new(
        updated_region.left,
        updated_region.top,
        r.width,
        r.height,
        r.max_left_offset,
        r.max_top_offset,
        r.max_right_offset,
        r.max_bottom_offset
      ).padding(r.current_padding)
    end
  end
  @need_convert_floating_regions_coordinates = false
end

#convert_ignored_regions_coordinates ⇒ Object 



336
337
338
339
340
 
# File 'lib/applitools/core/match_window_data.rb', line 336

def convert_ignored_regions_coordinates
  return unless @need_convert_ignored_regions_coordinates
  self.ignored_regions = convert_regions_coordinates(@ignored_regions)
  @need_convert_ignored_regions_coordinates = false
end

#convert_layout_regions_coordinates ⇒ Object 



342
343
344
345
346
 
# File 'lib/applitools/core/match_window_data.rb', line 342

def convert_layout_regions_coordinates
  return unless @need_convert_layout_regions_coordinates
  self.layout_regions = convert_regions_coordinates(@layout_regions)
  @need_convert_layout_regions_coordinates = false
end

#convert_regions_coordinates(regions) ⇒ Object 



366
367
368
 
# File 'lib/applitools/core/match_window_data.rb', line 366

def convert_regions_coordinates(regions)
  regions.dup.map { |r| self.class.convert_coordinates(r, app_output.screenshot) } unless app_output.screenshot.nil?
end

#convert_strict_regions_coordinates ⇒ Object 



348
349
350
351
352
 
# File 'lib/applitools/core/match_window_data.rb', line 348

def convert_strict_regions_coordinates
  return unless @need_convert_strict_regions_coordinates
  self.strict_regions = convert_regions_coordinates(@strict_regions)
  @need_convert_strict_regions_coordinates = false
end

#enable_patterns ⇒ Object 



190
191
192
 
# File 'lib/applitools/core/match_window_data.rb', line 190

def enable_patterns
  default_image_match_settings.enable_patterns
end

#enable_patterns=(value) ⇒ Object 



194
195
196
 
# File 'lib/applitools/core/match_window_data.rb', line 194

def enable_patterns=(value)
  default_image_match_settings.enable_patterns = value
end

#exact ⇒ Object 



178
179
180
 
# File 'lib/applitools/core/match_window_data.rb', line 178

def exact
  default_image_match_settings.exact
end

#exact=(value) ⇒ Object 



215
216
217
218
 
# File 'lib/applitools/core/match_window_data.rb', line 215

def exact=(value)
  Applitools::ArgumentGuard.is_a?(value, 'value', Applitools::ImageMatchSettings::Exact)
  default_image_match_settings.exact = value
end

#floating_regions=(value) ⇒ Object 



104
105
106
107
108
109
 
# File 'lib/applitools/core/match_window_data.rb', line 104

def floating_regions=(value)
  Applitools::ArgumentGuard.is_a? value, 'value', Array
  value.each do |r|
    default_image_match_settings.floating << r.to_hash
  end
end

#ignore_caret=(value) ⇒ Object 



324
325
326
 
# File 'lib/applitools/core/match_window_data.rb', line 324

def ignore_caret=(value)
  default_image_match_settings.ignore_caret = value
end

#ignore_displacements ⇒ Object 



198
199
200
 
# File 'lib/applitools/core/match_window_data.rb', line 198

def ignore_displacements
  default_image_match_settings.ignore_displacements
end

#ignore_displacements=(value) ⇒ Object 



202
203
204
 
# File 'lib/applitools/core/match_window_data.rb', line 202

def ignore_displacements=(value)
  default_image_match_settings.ignore_displacements = value
end

#ignored_regions=(value) ⇒ Object 



96
97
98
99
100
101
102
 
# File 'lib/applitools/core/match_window_data.rb', line 96

def ignored_regions=(value)
  Applitools::ArgumentGuard.is_a? value, 'value', Array
  value.each do |r|
    # current_data['Options']['ImageMatchSettings']['Ignore'] << r.to_hash if self.class.valid_region(r)
    default_image_match_settings.ignore << r.to_hash if self.class.valid_region(r)
  end
end

#layout_regions=(value) ⇒ Object 



111
112
113
114
115
116
 
# File 'lib/applitools/core/match_window_data.rb', line 111

def layout_regions=(value)
  Applitools::ArgumentGuard.is_a? value, 'value', Array
  value.each do |r|
    default_image_match_settings.layout << r.to_hash if self.class.valid_region(r)
  end
end

#match_level ⇒ Object 



158
159
160
 
# File 'lib/applitools/core/match_window_data.rb', line 158

def match_level
  default_image_match_settings.match_level
end

#match_level=(value) ⇒ Object 



154
155
156
 
# File 'lib/applitools/core/match_window_data.rb', line 154

def match_level=(value)
  default_image_match_settings.match_level = value
end

#obtain_accessibility_regions_coordinates(regions, driver) ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/applitools/core/match_window_data.rb', line 273

def obtain_accessibility_regions_coordinates(regions, driver)
  result = []
  regions.each do |r|
    case r
    when Proc
      region_or_regions = r.call(driver)
      case region_or_regions
      when Array
        result.concat(region_or_regions)
      when Applitools::AccessibilityRegion
        result << region_or_regions
      end
    else
      raise Applitools::EyesError, 'Error getting accessibility_regions coordinates'
    end
  end
  result
end

#obtain_regions_coordinates(regions, driver) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/applitools/core/match_window_data.rb', line 292

def obtain_regions_coordinates(regions, driver)
  result = []
  regions.each do |r|
    case r
    when Proc
      region = r.call(driver)
      result << Applitools::Region.from_location_size(region.location, region.size)
    when Applitools::Region
      result << r
    end
  end
  result
end

#read_target(target, driver) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/applitools/core/match_window_data.rb', line 220

def read_target(target, driver)
  # options
  target_options_to_read.each do |field|
    a_value = target.options[field.to_sym]
    send("#{field}=", a_value) unless a_value.nil?
  end
  # ignored regions
  if target.respond_to? :ignored_regions
    @ignored_regions = obtain_regions_coordinates(target.ignored_regions, driver)
    @need_convert_ignored_regions_coordinates = true unless @ignored_regions.empty?
  end

  # floating regions
  return unless target.respond_to? :floating_regions
  target.floating_regions.each do |r|
    case r
    when Proc
      region = r.call(driver)
      raise Applitools::EyesError.new "Wrong floating region: #{region.class}" unless
          region.is_a? Applitools::FloatingRegion
      @floating_regions << region
      @need_convert_floating_regions_coordinates = true
    when Applitools::FloatingRegion
      @floating_regions << r
      @need_convert_floating_regions_coordinates = true
    end
  end

  # Layout regions
  if target.respond_to? :layout_regions
    @layout_regions = obtain_regions_coordinates(target.layout_regions, driver)
    @need_convert_layout_regions_coordinates = true unless @layout_regions.empty?
  end

  # Strict regions
  if target.respond_to? :strict_regions
    @strict_regions = obtain_regions_coordinates(target.strict_regions, driver)
    @need_convert_strict_regions_coordinates = true unless @strict_regions.empty?
  end

  # Content regions
  if target.respond_to? :content_regions
    @content_regions = obtain_regions_coordinates(target.content_regions, driver)
    @need_convert_content_regions_coordinates = true unless @content_regions.empty?
  end

  if target.respond_to? :accessibility_regions
    @accessibility_regions = obtain_accessibility_regions_coordinates(target.accessibility_regions, driver)
    @need_convert_accessibility_regions_coordinates = true unless @accessibility_regions.empty?
  end
  target
end

#remainder ⇒ Object 



174
175
176
 
# File 'lib/applitools/core/match_window_data.rb', line 174

def remainder
  default_image_match_settings.remainder
end

#remainder=(value) ⇒ Object 



170
171
172
 
# File 'lib/applitools/core/match_window_data.rb', line 170

def remainder=(value)
  default_image_match_settings.remainder = value
end

#render_id ⇒ Object 



206
207
208
 
# File 'lib/applitools/core/match_window_data.rb', line 206

def render_id
  current_data['Options']['RenderId']
end

#render_id=(value) ⇒ Object 



210
211
212
213
 
# File 'lib/applitools/core/match_window_data.rb', line 210

def render_id=(value)
  current_data['Options']['RenderId'] = value
  current_data['RenderId'] = value
end

#scale ⇒ Object 



166
167
168
 
# File 'lib/applitools/core/match_window_data.rb', line 166

def scale
  default_image_match_settings.scale
end

#scale=(value) ⇒ Object 



162
163
164
 
# File 'lib/applitools/core/match_window_data.rb', line 162

def scale=(value)
  default_image_match_settings.scale = value
end

#screenshot ⇒ Object 



74
75
76
77
 
# File 'lib/applitools/core/match_window_data.rb', line 74

def screenshot
  return '' unless app_output.screenshot.respond_to?(:image)
  app_output.screenshot.image.to_blob
end

#strict_regions=(value) ⇒ Object 



118
119
120
121
122
123
 
# File 'lib/applitools/core/match_window_data.rb', line 118

def strict_regions=(value)
  Applitools::ArgumentGuard.is_a? value, 'value', Array
  value.each do |r|
    default_image_match_settings.strict << r.to_hash if self.class.valid_region(r)
  end
end

#to_hash ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/applitools/core/match_window_data.rb', line 395

def to_hash
  if @need_convert_accessibility_regions_coordinates
    raise Applitools::EyesError.new(
      'You should convert coordinates for content_regions!'
    )
  end

  if @need_convert_content_regions_coordinates
    raise Applitools::EyesError.new(
      'You should convert coordinates for content_regions!'
    )
  end

  if @need_convert_strict_regions_coordinates
    raise Applitools::EyesError.new(
      'You should convert coordinates for strict_regions!'
    )
  end

  if @need_convert_layout_regions_coordinates
    raise Applitools::EyesError.new(
      'You should convert coordinates for layout_regions!'
    )
  end

  if @need_convert_ignored_regions_coordinates
    raise Applitools::EyesError.new(
      'You should convert coordinates for ignored_regions!'
    )
  end

  if @need_convert_floating_regions_coordinates
    raise Applitools::EyesError.new(
      'You should convert coordinates for floating_regions!'
    )
  end
  result = current_data.dup
  result['Options']['ImageMatchSettings'] = default_image_match_settings.json_data
  result
end

#to_s ⇒ Object 



436
437
438
 
# File 'lib/applitools/core/match_window_data.rb', line 436

def to_s
  to_hash
end

#trim=(value) ⇒ Object 



320
321
322
 
# File 'lib/applitools/core/match_window_data.rb', line 320

def trim=(value)
  current_data['Options']['Trim']['Enabled'] = value ? true : false
end

#use_dom ⇒ Object 



182
183
184
 
# File 'lib/applitools/core/match_window_data.rb', line 182

def use_dom
  default_image_match_settings.use_dom
end

#use_dom=(value) ⇒ Object 



186
187
188
 
# File 'lib/applitools/core/match_window_data.rb', line 186

def use_dom=(value)
  default_image_match_settings.use_dom = value
end