eyes_selenium 3.11.3 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48fa942ab484ac166a79b5c113e8abc724898dc7
-  data.tar.gz: e4706b111471ff17a6b4b9814ea028fde0102a3f
+  metadata.gz: 1eddd248aaa225506bab9d893b31a5d60b672d1e
+  data.tar.gz: 5e1db39922d01f6a2d1240631c7c8c6b8a2777c2
 SHA512:
-  metadata.gz: c5e081ea883a93be0153d8cdb74dbb088d8bab32410884329488f547250b64ea9edd507e10ee8e4b655d4e87ed2ccfc9ee400b3fd46f4d3df10440af9c92ee3d
-  data.tar.gz: 31f787b185858b3a6dad0038187cfc1b1a264b4b4c12ee4c5d09806bc149e21f4f7b15756891dd44a864ca11c8144f7662aca89cce02e7e5e0e3ac1f938da17d
+  metadata.gz: bb020ee6d60bc119e4762dec14ee5c370dc1101f4788c65f379d112a44dff544a04a744047278494a51a723fd964b9526fda0ca3b376df8e07b2a38b575065b4
+  data.tar.gz: 494d2cabeebaedf23f3e87a681da7bae543735abbee395e7417288f27aa80e87eafa1a7dc509e894f67a2b10fb25805f073162a6c71f63d8d18dfd541af314df

data/lib/applitools/selenium/css_translate_position_provider.rb

@@ -54,6 +54,7 @@ module Applitools::Selenium
 
     def force_offset
       Applitools::Location.from_any_attribute last_state_position
+      # Applitools::Location::TOP_LEFT
     end
 
     alias scroll_to position=

data/lib/applitools/selenium/eyes.rb

@@ -103,6 +103,7 @@ module Applitools::Selenium
       self.disable_horizontal_scrolling = false
       self.disable_vertical_scrolling = false
       self.explicit_entire_size = nil
+      self.force_driver_resolution_as_viewport_size = false
     end
 
     # Starts a test
@@ -131,6 +132,8 @@ module Applitools::Selenium
       end
 
       @driver = self.class.eyes_driver(driver, self)
+      perform_driver_specific_settings(driver)
+
       self.device_pixel_ratio = UNKNOWN_DEVICE_PIXEL_RATIO
       self.position_provider = self.class.position_provider(
         stitch_mode, driver, disable_horizontal_scrolling, disable_vertical_scrolling, explicit_entire_size
@@ -142,10 +145,24 @@ module Applitools::Selenium
         )
       end
 
-      open_base options
+      open_base(options) do
+        self.viewport_size = nil if force_driver_resolution_as_viewport_size
+        ensure_running_session
+      end
       @driver
     end
 
+    def perform_driver_specific_settings(driver)
+      modifier = driver.class.to_s.downcase.gsub(/::/, '_')
+      method_name = "perform_driver_settings_for_#{modifier}"
+      send(method_name) if respond_to? method_name
+    end
+
+    def perform_driver_settings_for_appium_driver
+      self.region_visibility_strategy = NopRegionVisibilityStrategy.new
+      self.force_driver_resolution_as_viewport_size = true
+    end
+
     # Sets the stitch mode.
     #
     # @param [Hash] value The desired type of stitching (:SCROLL is default).
@@ -211,16 +228,15 @@ module Applitools::Selenium
       original_overflow = nil
       original_position_provider = position_provider
       original_force_full_page_screenshot = force_full_page_screenshot
-
       eyes_element = nil
       timeout = target.options[:timeout] || USE_DEFAULT_MATCH_TIMEOUT
-
       self.eyes_screenshot_factory = lambda do |image|
         Applitools::Selenium::EyesWebDriverScreenshot.new(
           image, driver: driver, force_offset: position_provider.force_offset
         )
       end
 
+      # rubocop:disable BlockLength
       check_in_frame target_frames: target.frames do
         begin
           match_data = Applitools::MatchWindowData.new
@@ -228,8 +244,11 @@ module Applitools::Selenium
           update_default_settings(match_data)
           match_data.read_target(target, driver)
           eyes_element = target.region_to_check.call(driver)
-          region_visibility_strategy.move_to_region original_position_provider,
-            Applitools::Location.new(eyes_element.location.x.to_i, eyes_element.location.y.to_i)
+
+          unless force_full_page_screenshot
+            region_visibility_strategy.move_to_region original_position_provider,
+              Applitools::Location.new(eyes_element.location.x.to_i, eyes_element.location.y.to_i)
+          end
 
           check_window = false
           if !target.frames.empty? && eyes_element.is_a?(Applitools::Region)
@@ -241,8 +260,17 @@ module Applitools::Selenium
             # check_element
             logger.info 'check_region(' \
               "#{Applitools::Region.from_location_size(eyes_element.location, eyes_element.size)})"
+
+            use_coordinates =
+              if position_provider.is_a?(Applitools::Selenium::CssTranslatePositionProvider) &&
+                  driver.frame_chain.empty?
+                Applitools::EyesScreenshot::COORDINATE_TYPES[:context_as_is]
+              else
+                target.coordinate_type
+              end
+
             region_provider = Applitools::RegionProvider.new(
-              region_for_element(eyes_element), target.coordinate_type
+              region_for_element(eyes_element), use_coordinates
             )
           else
             # check_window
@@ -263,6 +291,8 @@ module Applitools::Selenium
               eyes_element.overflow = 'hidden'
             end
 
+            region_provider = Applitools::RegionProvider.new(region_provider.region, target.coordinate_type)
+
             self.region_to_check = region_provider
 
             region_provider = Applitools::RegionProvider.new(
@@ -282,6 +312,7 @@ module Applitools::Selenium
           self.region_to_check = nil
           region_visibility_strategy.return_to_original_position position_provider
         end
+        # rubocop:enable BlockLength
       end
     end
 
@@ -475,7 +506,7 @@ module Applitools::Selenium
 
     attr_accessor :check_frame_or_element, :region_to_check, :dont_get_title,
       :device_pixel_ratio, :position_provider, :scale_provider, :tag_for_debug,
-      :region_visibility_strategy, :eyes_screenshot_factory
+      :region_visibility_strategy, :eyes_screenshot_factory, :force_driver_resolution_as_viewport_size
 
     def capture_screenshot
       image_provider = Applitools::Selenium::TakesScreenshotImageProvider.new driver,
@@ -547,7 +578,7 @@ module Applitools::Selenium
             logger.info 'Done switching!'
           end
           logger.info 'Creating EyesWebDriver screenshot instance..'
-          ewd_screenshot = Applitools::Selenium::EyesWebDriverScreenshot.new full_page_image, driver: driver
+          ewd_screenshot = Applitools::Selenium::EyesFullPageScreenshot.new(full_page_image)
           logger.info 'Done creating EyesWebDriver screenshot instance!'
           ewd_screenshot
         else
@@ -567,16 +598,16 @@ module Applitools::Selenium
       end
     end
 
-    def vp_size=(value)
-      raise Applitools::EyesNotOpenException.new 'set_viewport_size: Eyes not open!' unless open?
+    def vp_size=(value, skip_check_if_open = false)
+      raise Applitools::EyesNotOpenException.new 'set_viewport_size: Eyes not open!' unless skip_check_if_open || open?
       original_frame = driver.frame_chain
       driver.switch_to.default_content
       begin
         Applitools::Utils::EyesSeleniumUtils.set_viewport_size driver, value
       rescue => e
-        logger.error e.class
+        logger.error e.class.to_s
         logger.error e.message
-        raise Applitools::TestFailedError.new 'Failed to set viewport size!'
+        raise Applitools::TestFailedError.new "#{e.class} - #{e.message}"
       ensure
         driver.switch_to.frames(frame_chain: original_frame)
       end

data/lib/applitools/selenium/eyes_full_page_screenshot.rb

@@ -0,0 +1,47 @@
+module Applitools::Selenium
+  class EyesFullPageScreenshot < Applitools::EyesScreenshot
+    def initialize(*args)
+      super
+    end
+
+    def sub_screenshot(region, coordinate_type, throw_if_clipped = false, force_nil_if_clipped = false)
+      logger.info "get_subscreenshot(#{region}, #{coordinate_type}, #{throw_if_clipped})"
+      Applitools::ArgumentGuard.not_nil region, 'region'
+      Applitools::ArgumentGuard.not_nil coordinate_type, 'coordinate_type'
+
+      as_is_subscreenshot_region = intersected_region(
+        region, coordinate_type,
+        Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
+      )
+
+      if as_is_subscreenshot_region.empty? || (throw_if_clipped && as_is_subscreenshot_region.size != region.size)
+        return nil if force_nil_if_clipped
+        raise Applitools::OutOfBoundsException.new "Region #{region} (#{coordinate_type}) is out" \
+          " of screenshot bounds [#{frame_window}]"
+      end
+
+      sub_screenshot_image = Applitools::Screenshot.from_image(
+        image.crop(
+          as_is_subscreenshot_region.left,
+          as_is_subscreenshot_region.top, as_is_subscreenshot_region.width,
+          as_is_subscreenshot_region.height
+        )
+      )
+      result = self.class.new sub_screenshot_image
+      logger.info 'Done!'
+      result
+    end
+
+    def intersected_region(region, _original_coordinate_types, _result_coordinate_types)
+      region.intersect Applitools::Region.new(0, 0, image.width, image.height)
+    end
+
+    def convert_location(location, _from, _to)
+      location
+    end
+
+    def location_in_screenshot(location, _coordinate_type)
+      location
+    end
+  end
+end

data/lib/applitools/selenium/eyes_web_driver_screenshot.rb

@@ -219,6 +219,13 @@ module Applitools::Selenium
         else
           raise Applitools::EyesCoordinateTypeConversionException.new "Can't convert coordinates from #{from} to #{to}"
         end
+      when Applitools::EyesScreenshot::COORDINATE_TYPES[:context_as_is]
+        case to
+        when Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
+          result.offset_negative(frame_location_in_screenshot).offset(force_offset)
+        else
+          raise Applitools::EyesCoordinateTypeConversionException.new "Can't convert coordinates from #{from} to #{to}"
+        end
       else
         raise Applitools::EyesCoordinateTypeConversionException.new "Can't convert coordinates from #{from} to #{to}"
       end
@@ -244,12 +251,11 @@ module Applitools::Selenium
         region, original_coordinate_types, Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
       )
       case original_coordinate_types
-      when Applitools::EyesScreenshot::COORDINATE_TYPES[:context_as_is]
-        nil
-      when Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
+      when Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
+        Applitools::EyesScreenshot::COORDINATE_TYPES[:context_as_is]
         intersected_region.intersect frame_window
       when Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
-        intersected_region.intersect Applitools::Region.new(0, 0, image.width, image.height)
+        intersected_region.intersect(Applitools::Region.new(0, 0, image.width, image.height))
       else
         raise Applitools::EyesCoordinateTypeConversionException.new(
           "Unknown coordinates type: #{original_coordinate_types}"

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '3.11.3'.freeze
+  VERSION = '3.12.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.11.3
+  version: 3.12.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-13 00:00:00.000000000 Z
+date: 2017-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.11.3
+        version: 3.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.11.3
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - lib/applitools/selenium/element.rb
 - lib/applitools/selenium/element_position_provider.rb
 - lib/applitools/selenium/eyes.rb
+- lib/applitools/selenium/eyes_full_page_screenshot.rb
 - lib/applitools/selenium/eyes_target_locator.rb
 - lib/applitools/selenium/eyes_web_driver_screenshot.rb
 - lib/applitools/selenium/frame.rb