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.



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

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.



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

def app_output
  @app_output
end

#default_image_match_settings ⇒ Object

Returns the value of attribute default_image_match_settings.



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

def default_image_match_settings
  @default_image_match_settings
end

#ignore_mismatch ⇒ Object

Returns the value of attribute ignore_mismatch.



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

def ignore_mismatch
  @ignore_mismatch
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#tag ⇒ Object

Returns the value of attribute tag.



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

def tag
  @tag
end

#user_inputs ⇒ Object

Returns the value of attribute user_inputs.



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

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
 
# File 'lib/applitools/core/match_window_data.rb', line 14

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 



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

def valid_input(_i)
  true
end

.valid_region(_r) ⇒ Object 



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

def valid_region(_r)
  true
end

Instance Method Details

#accessibility_regions=(value) ⇒ Object 



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

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 



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

def accessibility_validation
  default_image_match_settings.accessibility_level
end

#accessibility_validation=(value) ⇒ Object 



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

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

#content_regions=(value) ⇒ Object 



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

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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

def enable_patterns
  default_image_match_settings.enable_patterns
end

#enable_patterns=(value) ⇒ Object 



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

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

#exact ⇒ Object 



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

def exact
  default_image_match_settings.exact
end

#exact=(value) ⇒ Object 



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

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

#floating_regions=(value) ⇒ Object 



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

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 



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

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

#ignore_displacements ⇒ Object 



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

def ignore_displacements
  default_image_match_settings.ignore_displacements
end

#ignore_displacements=(value) ⇒ Object 



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

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

#ignored_regions=(value) ⇒ Object 



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

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 



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

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 



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

def match_level
  default_image_match_settings.match_level
end

#match_level=(value) ⇒ Object 



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

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

#obtain_accessibility_regions_coordinates(regions, driver) ⇒ Object 



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

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 



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

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 



219
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
 
# File 'lib/applitools/core/match_window_data.rb', line 219

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 



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

def remainder
  default_image_match_settings.remainder
end

#remainder=(value) ⇒ Object 



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

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

#render_id ⇒ Object 



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

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

#render_id=(value) ⇒ Object 



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

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

#scale ⇒ Object 



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

def scale
  default_image_match_settings.scale
end

#scale=(value) ⇒ Object 



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

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

#screenshot ⇒ Object 



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

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

#strict_regions=(value) ⇒ Object 



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

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 



394
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
 
# File 'lib/applitools/core/match_window_data.rb', line 394

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 



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

def to_s
  to_hash
end

#trim=(value) ⇒ Object 



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

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

#use_dom ⇒ Object 



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

def use_dom
  default_image_match_settings.use_dom
end

#use_dom=(value) ⇒ Object 



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

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