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 ⇒ MatchWindowData

Returns a new instance of MatchWindowData.



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/applitools/core/match_window_data.rb', line 82

def initialize
  @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
end

Instance Attribute Details

#app_output ⇒ Object

Returns the value of attribute app_output.



80
81
82
 
# File 'lib/applitools/core/match_window_data.rb', line 80

def app_output
  @app_output
end

#ignore_mismatch ⇒ Object

Returns the value of attribute ignore_mismatch.



80
81
82
 
# File 'lib/applitools/core/match_window_data.rb', line 80

def ignore_mismatch
  @ignore_mismatch
end

#options ⇒ Object

Returns the value of attribute options.



80
81
82
 
# File 'lib/applitools/core/match_window_data.rb', line 80

def options
  @options
end

#tag ⇒ Object

Returns the value of attribute tag.



80
81
82
 
# File 'lib/applitools/core/match_window_data.rb', line 80

def tag
  @tag
end

#user_inputs ⇒ Object

Returns the value of attribute user_inputs.



80
81
82
 
# File 'lib/applitools/core/match_window_data.rb', line 80

def user_inputs
  @user_inputs
end

Class Method Details

.convert_coordinates(region, screenshot) ⇒ Object 



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

def convert_coordinates(region, screenshot)
  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 



14
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/applitools/core/match_window_data.rb', line 14

def default_data
  {
    'IgnoreMismatch' => false,
    'MismatchWait' => 0,
    'Options' => {
      'Name' => nil,
      'UserInputs' => [],
      'ImageMatchSettings' => {
        'accessibilityLevel' => 'None',
        'MatchLevel' => 'Strict',
        'SplitTopHeight' => 0,
        'SplitBottomHeight' => 0,
        'IgnoreCaret' => true,
        'IgnoreDisplacements' => false,
        'Accessibility' => [],
        'Ignore' => [],
        'Floating' => [],
        'Layout' => [],
        'Strict' => [],
        'Content' => [],
        'Exact' => {
          'MinDiffIntensity' => 0,
          'MinDiffWidth' => 0,
          'MinDiffHeight' => 0,
          'MatchThreshold' => 0
        },
        'scale' => 0,
        'remainder' => 0,
        'EnablePatterns' => false,
        'UseDom' => false
      },
      'IgnoreExpectedOutputSettings' => false,
      'ForceMatch' => false,
      'ForceMismatch' => false,
      'IgnoreMatch' => false,
      'IgnoreMismatch' => false,
      'Trim' => {
        'Enabled' => false
      }
    },
    'Id' => nil,
    'UserInputs' => [],
    'AppOutput' => {
      'Screenshot64' => nil,
      'ScreenshotUrl' => nil,
      'Title' => nil,
      'IsPrimary' => false,
      'Elapsed' => 0,
      'Location' => {
        'X' => 0,
        'Y' => 0
      }
    },
    'Tag' => nil
  }
end

.valid_input(_i) ⇒ Object 



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

def valid_input(_i)
  true
end

.valid_region(_r) ⇒ Object 



71
72
73
 
# File 'lib/applitools/core/match_window_data.rb', line 71

def valid_region(_r)
  true
end

Instance Method Details

#accessibility_regions=(value) ⇒ Object 



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

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

#accessibility_validation ⇒ Object 



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

def accessibility_validation
  current_data['Options']['ImageMatchSettings']['AccessibilityLevel']
end

#accessibility_validation=(value) ⇒ Object 



347
348
349
 
# File 'lib/applitools/core/match_window_data.rb', line 347

def accessibility_validation=(value)
  current_data['Options']['ImageMatchSettings']['AccessibilityLevel'] = value
end

#content_regions=(value) ⇒ Object 



144
145
146
147
148
149
 
# File 'lib/applitools/core/match_window_data.rb', line 144

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

#convert_accessibility_regions_coordinates ⇒ Object 



378
379
380
381
382
 
# File 'lib/applitools/core/match_window_data.rb', line 378

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 



372
373
374
375
376
 
# File 'lib/applitools/core/match_window_data.rb', line 372

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 



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/applitools/core/match_window_data.rb', line 388

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 



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

def convert_ignored_regions_coordinates
  return unless @need_convert_ignored_regions_coordinates
  self.ignored_regions = convert_regions_coordinates(@ignored_regions)
  # self.ignored_regions = @ignored_regions.map do |r|
  #   self.class.convert_coordinates(r, app_output.screenshot)
  # end unless app_output.screenshot.nil?
  @need_convert_ignored_regions_coordinates = false
end

#convert_layout_regions_coordinates ⇒ Object 



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

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 



384
385
386
 
# File 'lib/applitools/core/match_window_data.rb', line 384

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 



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

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 



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

def enable_patterns
  current_data['Options']['ImageMatchSettings']['EnablePatterns']
end

#enable_patterns=(value) ⇒ Object 



213
214
215
 
# File 'lib/applitools/core/match_window_data.rb', line 213

def enable_patterns=(value)
  current_data['Options']['ImageMatchSettings']['EnablePatterns'] = value
end

#exact ⇒ Object 



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

def exact
  current_data['Options']['ImageMatchSettings']['Exact']
end

#exact=(value) ⇒ Object

Raises:

  • (Applitools::EyesError) 


225
226
227
228
229
230
231
232
233
 
# File 'lib/applitools/core/match_window_data.rb', line 225

def exact=(value)
  raise Applitools::EyesError.new('You should pass a hash as a value!') unless value.nil? || value.is_a?(Hash)
  return current_data['Options']['ImageMatchSettings']['Exact'] = nil if value.nil?
  current_value = exact || {}
  %w(MinDiffIntensity MinDiffWidth MinDiffHeight MatchThreshold).each do |k|
    current_value[k] = value[k]
  end
  current_data['Options']['ImageMatchSettings']['Exact'] = current_value
end

#floating_regions=(value) ⇒ Object 



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

def floating_regions=(value)
  Applitools::ArgumentGuard.is_a? value, 'value', Array
  value.each do |r|
    current_data['Options']['ImageMatchSettings']['Floating'] << r.to_hash
  end
end

#ignore_caret=(value) ⇒ Object 



339
340
341
 
# File 'lib/applitools/core/match_window_data.rb', line 339

def ignore_caret=(value)
  current_data['Options']['ImageMatchSettings']['IgnoreCaret'] = value
end

#ignore_displacements ⇒ Object 



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

def ignore_displacements
  current_data['Options']['ImageMatchSettings']['IgnoreDisplacements']
end

#ignore_displacements=(value) ⇒ Object 



221
222
223
 
# File 'lib/applitools/core/match_window_data.rb', line 221

def ignore_displacements=(value)
  current_data['Options']['ImageMatchSettings']['IgnoreDisplacements'] = value
end

#ignored_regions=(value) ⇒ Object 



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

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)
  end
end

#layout_regions=(value) ⇒ Object 



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

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

#match_level ⇒ Object 



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

def match_level
  current_data['Options']['ImageMatchSettings']['MatchLevel']
end

#match_level=(value) ⇒ Object 



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

def match_level=(value)
  current_data['Options']['ImageMatchSettings']['MatchLevel'] = value
end

#obtain_accessibility_regions_coordinates(regions, driver) ⇒ Object 



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

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 



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/applitools/core/match_window_data.rb', line 307

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 



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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/applitools/core/match_window_data.rb', line 235

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 



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

def remainder
  current_data['Options']['ImageMatchSettings']['remainder']
end

#remainder=(value) ⇒ Object 



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

def remainder=(value)
  current_data['Options']['ImageMatchSettings']['remainder'] = value
end

#scale ⇒ Object 



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

def scale
  current_data['Options']['ImageMatchSettings']['scale']
end

#scale=(value) ⇒ Object 



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

def scale=(value)
  current_data['Options']['ImageMatchSettings']['scale'] = value
end

#screenshot ⇒ Object 



94
95
96
97
 
# File 'lib/applitools/core/match_window_data.rb', line 94

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

#strict_regions=(value) ⇒ Object 



137
138
139
140
141
142
 
# File 'lib/applitools/core/match_window_data.rb', line 137

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

#to_hash ⇒ Object 



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/applitools/core/match_window_data.rb', line 413

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
  current_data.dup
end

#to_s ⇒ Object 



452
453
454
 
# File 'lib/applitools/core/match_window_data.rb', line 452

def to_s
  to_hash
end

#trim=(value) ⇒ Object 



335
336
337
 
# File 'lib/applitools/core/match_window_data.rb', line 335

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

#use_dom ⇒ Object 



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

def use_dom
  current_data['Options']['ImageMatchSettings']['UseDom']
end

#use_dom=(value) ⇒ Object 



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

def use_dom=(value)
  current_data['Options']['ImageMatchSettings']['UseDom'] = value
end