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.



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

def initialize
  @app_output = nil
  @ignored_regions = []
  @floating_regions = []
  @need_convert_ignored_regions_coordinates = false
  @need_convert_floating_regions_coordinates = false
end

Instance Attribute Details

#app_output ⇒ Object

Returns the value of attribute app_output.



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

def app_output
  @app_output
end

#ignore_mismatch ⇒ Object

Returns the value of attribute ignore_mismatch.



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

def ignore_mismatch
  @ignore_mismatch
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#tag ⇒ Object

Returns the value of attribute tag.



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

def tag
  @tag
end

#user_inputs ⇒ Object

Returns the value of attribute user_inputs.



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

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

def default_data
  {
    'IgnoreMismatch' => false,
    'MismatchWait' => 0,
    'Options' => {
      'Name' => nil,
      'UserInputs' => [],
      'ImageMatchSettings' => {
        'MatchLevel' => 'Strict',
        'SplitTopHeight' => 0,
        'SplitBottomHeight' => 0,
        'IgnoreCaret' => true,
        'Ignore' => [],
        'Floating' => [],
        'Exact' => {
          'MinDiffIntensity' => 0,
          'MinDiffWidth' => 0,
          'MinDiffHeight' => 0,
          'MatchThreshold' => 0
        },
        'scale' => 0,
        'remainder' => 0
      },
      '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 



67
68
69
 
# File 'lib/applitools/core/match_window_data.rb', line 67

def valid_input(_i)
  true
end

.valid_region(_r) ⇒ Object 



63
64
65
 
# File 'lib/applitools/core/match_window_data.rb', line 63

def valid_region(_r)
  true
end

Instance Method Details

#convert_floating_regions_coordinates ⇒ Object 



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/applitools/core/match_window_data.rb', line 237

def convert_floating_regions_coordinates
  return unless @need_convert_floating_regions_coordinates
  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
  @need_convert_floating_regions_coordinates = false
end

#convert_ignored_regions_coordinates ⇒ Object 



229
230
231
232
233
234
235
 
# File 'lib/applitools/core/match_window_data.rb', line 229

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

#exact ⇒ Object 



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

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

#exact=(value) ⇒ Object

Raises:

  • (Applitools::EyesError) 


160
161
162
163
164
165
166
167
168
 
# File 'lib/applitools/core/match_window_data.rb', line 160

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 



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

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 



225
226
227
 
# File 'lib/applitools/core/match_window_data.rb', line 225

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

#ignored_regions=(value) ⇒ Object 



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

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

#match_level ⇒ Object 



136
137
138
 
# File 'lib/applitools/core/match_window_data.rb', line 136

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

#match_level=(value) ⇒ Object 



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

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

#read_target(target, driver) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/applitools/core/match_window_data.rb', line 170

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
    target.ignored_regions.each do |r|
      case r
      when Proc
        @ignored_regions << r.call(driver)
        @need_convert_ignored_regions_coordinates = true
      when Applitools::Region
        @ignored_regions << r
        @need_convert_ignored_regions_coordinates = true
      end
    end
  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
end

#remainder ⇒ Object 



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

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

#remainder=(value) ⇒ Object 



148
149
150
 
# File 'lib/applitools/core/match_window_data.rb', line 148

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

#scale ⇒ Object 



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

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

#scale=(value) ⇒ Object 



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

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

#screenshot ⇒ Object 



82
83
84
 
# File 'lib/applitools/core/match_window_data.rb', line 82

def screenshot
  app_output.screenshot.image.to_blob
end

#to_hash ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/applitools/core/match_window_data.rb', line 260

def to_hash
  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 



275
276
277
 
# File 'lib/applitools/core/match_window_data.rb', line 275

def to_s
  to_hash
end

#trim=(value) ⇒ Object 



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

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