Class: Applitools::Selenium::Target
- Inherits:
-
Object
- Object
- Applitools::Selenium::Target
- Includes:
- FluentInterface, MatchLevelSetter
- Defined in:
- lib/applitools/selenium/target.rb
Instance Attribute Summary collapse
-
#content_regions ⇒ Object
Returns the value of attribute content_regions.
-
#coordinate_type ⇒ Object
Returns the value of attribute coordinate_type.
-
#element ⇒ Object
Returns the value of attribute element.
-
#floating_regions ⇒ Object
Returns the value of attribute floating_regions.
-
#frames ⇒ Object
Returns the value of attribute frames.
-
#ignored_regions ⇒ Object
Returns the value of attribute ignored_regions.
-
#layout_regions ⇒ Object
Returns the value of attribute layout_regions.
-
#match_level(*args) ⇒ Object
Returns the value of attribute match_level.
-
#options ⇒ Object
Returns the value of attribute options.
-
#region_to_check ⇒ Object
Returns the value of attribute region_to_check.
-
#regions ⇒ Object
Returns the value of attribute regions.
-
#strict_regions ⇒ Object
Returns the value of attribute strict_regions.
Class Method Summary collapse
Instance Method Summary collapse
- #content(*args) ⇒ Object
- #exact(*args) ⇒ Object
- #finalize ⇒ Object
-
#floating(region_or_element, bounds, left, top, right, bottom, padding) ⇒ Object
Sets the wanted floating region.
- #frame(element) ⇒ Object
- #fully(value = true) ⇒ Object
-
#ignore(region_or_element, how, what, padding = Applitools::PaddingBounds::PIXEL_PADDING) ⇒ Object
Add the wanted ignored regions.
-
#initialize ⇒ Target
constructor
Initialize a Applitools::Selenium::Target instance.
- #layout(*args) ⇒ Object
- #process_region(*args) ⇒ Object
-
#region(element, how, what) ⇒ Applitools::Selenium::Target
Add the desired region.
- #replace_element(original, new, array) ⇒ Object
- #replace_region(original_region, new_region, key) ⇒ Object
- #script_hook(hook) ⇒ Object
- #send_dom(value = true) ⇒ Object
- #strict(*args) ⇒ Object
- #use_dom(value = true) ⇒ Object
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. = { ignore_caret: true, ignore_mismatch: false, send_dom: nil, script_hooks: { beforeCaptureScreenshot: '' } } self.regions = {} reset_for_fullscreen end |
Instance Attribute Details
#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 |
#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 |
#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 |
#match_level(*args) ⇒ Object
Returns the value of attribute match_level.
22 23 24 |
# File 'lib/applitools/selenium/target.rb', line 22 def match_level @match_level end |
#options ⇒ Object
Returns the value of attribute options.
22 23 24 |
# File 'lib/applitools/selenium/target.rb', line 22 def @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
#content(*args) ⇒ Object
177 178 179 180 181 182 |
# File 'lib/applitools/selenium/target.rb', line 177 def content(*args) return match_level(Applitools::MatchLevel::CONTENT) if args.empty? region = process_region(*args) content_regions << region self end |
#exact(*args) ⇒ Object
191 192 193 |
# File 'lib/applitools/selenium/target.rb', line 191 def exact(*args) match_level(Applitools::MatchLevel::EXACT, *args) end |
#finalize ⇒ Object
302 303 304 305 306 307 |
# File 'lib/applitools/selenium/target.rb', line 302 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
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/applitools/selenium/target.rb', line 122 def floating(*args) requested_padding = if args.last.is_a? Applitools::PaddingBounds args.pop else Applitools::PaddingBounds::PIXEL_PADDING end value = case args.first when Applitools::FloatingRegion args.first.padding(requested_padding) when ::Applitools::Region Applitools::FloatingRegion.any(args.shift, *args).padding(requested_padding) when ::Selenium::WebDriver::Element proc do |driver, return_element = false| args_dup = args.dup region = applitools_element_from_selenium_element(driver, args_dup.shift) padding_proc = proc do |region| Applitools::FloatingRegion.any(region, *args_dup).padding(requested_padding) end next region, padding_proc if return_element padding_proc.call(region) end when ::Applitools::Selenium::Element proc do |_driver, return_element = false| args_dup = args.dup region = args_dup.shift padding_proc = proc do |region| Applitools::FloatingRegion.any(region, *args_dup).padding(requested_padding) end next region, padding_proc if return_element padding_proc.call(region) end else proc do |driver, return_element = false| args_dup = args.dup region = driver.find_element(args_dup.shift, args_dup.shift) padding_proc = proc do |region| Applitools::FloatingRegion.any( region, *args_dup ).padding(requested_padding) end next region, padding_proc if return_element padding_proc.call(region) end end floating_regions << value self end |
#frame(element) ⇒ Object
244 245 246 247 248 249 |
# File 'lib/applitools/selenium/target.rb', line 244 def frame(element) frames << frame_or_element if frame_or_element self.frame_or_element = element reset_for_fullscreen self end |
#fully(value = true) ⇒ Object
238 239 240 241 242 |
# File 'lib/applitools/selenium/target.rb', line 238 def fully(value = true) [: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.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/applitools/selenium/target.rb', line 48 def ignore(*args) if args.empty? reset_ignore else requested_padding = if args.last.is_a? Applitools::PaddingBounds args.pop else Applitools::PaddingBounds::PIXEL_PADDING end ignored_regions << case args.first when Applitools::Region proc { args.first.padding(requested_padding) } when ::Selenium::WebDriver::Element proc do |driver, return_element = false| region = applitools_element_from_selenium_element(driver, args.first) padding_proc = proc do |region| Applitools::Region.from_location_size( region.location, region.size ).padding(requested_padding) end next region, padding_proc if return_element padding_proc.call(region) end when Applitools::Selenium::Element proc do |_driver, return_element = false| region = args.first padding_proc = proc do |region| Applitools::Region.from_location_size( region.location, region.size ).padding(requested_padding) end next region, padding_proc if return_element padding_proc.call(region) end else proc do |driver, return_element = false| region = driver.find_element(*args) padding_proc = proc do |region| Applitools::Region.from_location_size( region.location, region.size ).padding(requested_padding) end next region, padding_proc if return_element padding_proc.call(region) end end end self end |
#layout(*args) ⇒ Object
170 171 172 173 174 175 |
# File 'lib/applitools/selenium/target.rb', line 170 def layout(*args) return match_level(Applitools::MatchLevel::LAYOUT) if args.empty? region = process_region(*args) layout_regions << region self end |
#process_region(*args) ⇒ Object
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/applitools/selenium/target.rb', line 195 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.
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/applitools/selenium/target.rb', line 262 def region(*args) handle_frames self.region_to_check = case args.first when ::Selenium::WebDriver::Element proc do |driver| applitools_element_from_selenium_element(driver, args.first) end when Applitools::Selenium::Element, Applitools::Region proc { args.first } when String proc do |driver| driver.find_element(name_or_id: args.first) end else proc do |driver| driver.find_element(*args) end end self.coordinate_type = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative] [:timeout] = nil reset_ignore reset_floating self end |
#replace_element(original, new, array) ⇒ Object
227 228 229 |
# File 'lib/applitools/selenium/target.rb', line 227 def replace_element(original, new, array) array[array.index(original)] = new end |
#replace_region(original_region, new_region, key) ⇒ Object
212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/applitools/selenium/target.rb', line 212 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) end end |
#script_hook(hook) ⇒ Object
297 298 299 300 |
# File 'lib/applitools/selenium/target.rb', line 297 def script_hook(hook) [:script_hooks][:beforeCaptureScreenshot] = hook self end |
#send_dom(value = true) ⇒ Object
287 288 289 290 |
# File 'lib/applitools/selenium/target.rb', line 287 def send_dom(value = true) [:send_dom] = value ? true : false self end |
#strict(*args) ⇒ Object
184 185 186 187 188 189 |
# File 'lib/applitools/selenium/target.rb', line 184 def strict(*args) return match_level(Applitools::MatchLevel::STRICT) if args.empty? region = process_region(*args) strict_regions << region self end |
#use_dom(value = true) ⇒ Object
292 293 294 295 |
# File 'lib/applitools/selenium/target.rb', line 292 def use_dom(value = true) [:use_dom] = value ? true : false self end |