eyes_selenium 3.11.2 → 3.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae6592033273af368726fae293e5792d76f0d0a4
-  data.tar.gz: 15f47a14d8c29633f9b51ad735ac974c442521b4
+  metadata.gz: 48fa942ab484ac166a79b5c113e8abc724898dc7
+  data.tar.gz: e4706b111471ff17a6b4b9814ea028fde0102a3f
 SHA512:
-  metadata.gz: e60dbd1e7622611dadec8b9d810f318209c4eff8aee4d305dd91af9bf72af65c902626515920113e4e2f48e09bd40545067d94b923a77f6aec5f855d343976a9
-  data.tar.gz: 3e49663198b2fe8655240bd8d36e5c93a1a36a5952cd055e4f3aaac6e32919e589286cbe40283ebd4a4a4aed846ad83f819d7818414422adfcb6af4f2ad2b7ee
+  metadata.gz: c5e081ea883a93be0153d8cdb74dbb088d8bab32410884329488f547250b64ea9edd507e10ee8e4b655d4e87ed2ccfc9ee400b3fd46f4d3df10440af9c92ee3d
+  data.tar.gz: 31f787b185858b3a6dad0038187cfc1b1a264b4b4c12ee4c5d09806bc149e21f4f7b15756891dd44a864ca11c8144f7662aca89cce02e7e5e0e3ac1f938da17d

data/lib/applitools/selenium/eyes.rb

@@ -75,7 +75,7 @@ module Applitools::Selenium
 
     attr_accessor :base_agent_id, :screenshot, :force_full_page_screenshot, :hide_scrollbars,
       :wait_before_screenshots, :debug_screenshot, :stitch_mode, :disable_horizontal_scrolling,
-      :disable_vertical_scrolling, :explicit_entire_size
+      :disable_vertical_scrolling, :explicit_entire_size, :debug_screenshot_provider
     attr_reader :driver
 
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
@@ -97,6 +97,9 @@ module Applitools::Selenium
       self.wait_before_screenshots = DEFAULT_WAIT_BEFORE_SCREENSHOTS
       self.region_visibility_strategy = MoveToRegionVisibilityStrategy.new
       self.debug_screenshot = false
+      self.debug_screenshot_provider = Applitools::DebugScreenshotProvider.new
+                                                                          .tag_access { tag_for_debug }
+                                                                          .debug_flag_access { debug_screenshot }
       self.disable_horizontal_scrolling = false
       self.disable_vertical_scrolling = false
       self.explicit_entire_size = nil
@@ -388,7 +391,6 @@ module Applitools::Selenium
       options = { timeout: USE_DEFAULT_MATCH_TIMEOUT, tag: nil }.merge! Applitools::Utils.extract_options!(args)
       target = Applitools::Selenium::Target.new.region(*args).timeout(options[:match_timeout])
       target.fully if options[:stitch_content]
-      self.screenshot_name_enumerator = nil
       check(options[:tag], target)
     end
 
@@ -477,7 +479,7 @@ module Applitools::Selenium
 
     def capture_screenshot
       image_provider = Applitools::Selenium::TakesScreenshotImageProvider.new driver,
-        debug_screenshot: debug_screenshot, name_enumerator: screenshot_name_enumerator
+        debug_screenshot_provider: debug_screenshot_provider
       logger.info 'Getting screenshot (capture_screenshot() has been invoked)'
 
       update_scaling_params
@@ -493,7 +495,9 @@ module Applitools::Selenium
       begin
         if check_frame_or_element
           logger.info 'Check frame/element requested'
-          algo = Applitools::Selenium::FullPageCaptureAlgorithm.new
+          algo = Applitools::Selenium::FullPageCaptureAlgorithm.new(
+            debug_screenshot_provider: debug_screenshot_provider
+          )
 
           entire_frame_or_element = algo.get_stitched_region(
             image_provider: image_provider,
@@ -515,7 +519,9 @@ module Applitools::Selenium
           logger.info 'Full page screenshot requested'
           original_frame = driver.frame_chain
           driver.switch_to.default_content
-          algo = Applitools::Selenium::FullPageCaptureAlgorithm.new
+          algo = Applitools::Selenium::FullPageCaptureAlgorithm.new(
+            debug_screenshot_provider: debug_screenshot_provider
+          )
           region_provider = Object.new
           region_provider.instance_eval do
             def region
@@ -696,6 +702,8 @@ module Applitools::Selenium
       add_mouse_trigger_base(mouse_action, control, cursor)
     end
 
+    public :add_text_trigger, :add_mouse_trigger, :add_mouse_trigger_by_region_and_location
+
     protected
 
     def check_current_frame(match_timeout, tag)
@@ -957,23 +965,6 @@ module Applitools::Selenium
       end
     end
 
-    def screenshot_name_enumerator
-      @name_enumerator ||= Enumerator.new do |y|
-        counter = 1
-        loop do
-          y << "#{tag_for_debug.gsub(/\s+/, '_')}__#{Time.now.strftime('%Y_%m_%d_%H_%M')}__#{counter}.png"
-          counter += 1
-        end
-      end
-    end
-
-    # Resets screenshot_names sequence to initial state.
-    #
-    # @param [Boolean] value should be false or nil to reset the sequence. Takes no effect if +true+ passed
-    def screenshot_name_enumerator=(value)
-      @name_enumerator = nil unless value
-    end
-
     def inferred_environment
       return @inferred_environment unless @inferred_environment.nil?
 

data/lib/applitools/selenium/full_page_capture_algorithm.rb

@@ -4,9 +4,16 @@ module Applitools::Selenium
     extend Forwardable
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
 
+    attr_reader :debug_screenshot_provider
+
     MAX_SCROLL_BAR_SIZE = 50
     MIN_SCREENSHOT_PART_HEIGHT = 10
 
+    def initialize(options = {})
+      @debug_screenshot_provider = options[:debug_screenshot_provider] ||
+        Applitools::DebugScreenshotProvider.new.tag_access { '' }.debug_flag_access { false }
+    end
+
     # Returns the stitched image.
     #
     # @param [Hash] options The options.
@@ -60,18 +67,26 @@ module Applitools::Selenium
 
       logger.info 'Getting top/left image...'
       image = image_provider.take_screenshot
+      debug_screenshot_provider.save(image, 'left_top_original')
       image = scale_provider.scale_image(image) if scale_provider
+      debug_screenshot_provider.save(image, 'left_top_original_scaled')
       image = cut_provider.cut(image) if cut_provider
+      debug_screenshot_provider.save(image, 'left_top_original_cutted')
       logger.info 'Done! Creating screenshot object...'
       screenshot = eyes_screenshot_factory.call(image)
 
       if region_provider.coordinate_type
         left_top_image = screenshot.sub_screenshot(region_provider.region, region_provider.coordinate_type)
+        debug_screenshot_provider.save_subscreenshot(left_top_image, region_provider.region)
       else
         left_top_image = screenshot.sub_screenshot(
           Applitools::Region.from_location_size(Applitools::Location.new(0, 0), entire_size),
           Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
         )
+        debug_screenshot_provider.save_subscreenshot(
+          left_top_image,
+          Applitools::Region.from_location_size(Applitools::Location.new(0, 0), entire_size)
+        )
       end
 
       image = left_top_image.image
@@ -122,9 +137,11 @@ module Applitools::Selenium
         logger.info "Set position to #{current_position}"
         logger.info 'Getting image...'
 
-        part_image = image_provider.take_screenshot
+        part_image = image_provider.take_screenshot(debug_suffix: "scrolled_(#{current_position})")
         part_image = scale_provider.scale_image part_image if scale_provider
+        debug_screenshot_provider.save(part_image, 'scaled')
         part_image = cut_provider.cut part_image if cut_provider
+        debug_screenshot_provider.save(part_image, 'cutted')
 
         logger.info 'Done!'
         begin
@@ -133,6 +150,7 @@ module Applitools::Selenium
           )
           a_screenshot = eyes_screenshot_factory.call(part_image).sub_screenshot(region_to_check,
             Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative], false)
+          debug_screenshot_provider.save_subscreenshot(a_screenshot, region_to_check)
         rescue Applitools::OutOfBoundsException => e
           logger.error e.message
           break
@@ -168,11 +186,13 @@ module Applitools::Selenium
         stitched_image.crop!(0, 0,
           [actual_image_width, stitched_image.width].min,
           [actual_image_height, stitched_image.height].min)
+        debug_screenshot_provider.save(stitched_image, 'trimmed')
         logger.info 'Done!'
       end
 
       logger.info 'Converting to screenshot...'
       result_screenshot = Applitools::Screenshot.from_any_image(stitched_image)
+      debug_screenshot_provider.save(result_screenshot, 'full_page')
       logger.info 'Done converting!'
       result_screenshot
     end

data/lib/applitools/selenium/takes_screenshot_image_provider.rb

@@ -4,7 +4,7 @@ module Applitools::Selenium
     extend Forwardable
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
 
-    attr_accessor :driver, :name_enumerator
+    attr_accessor :driver, :debug_screenshot_provider
 
     # Initialize an Applitools::Selenium::TakesScreenshotImageProvider.
     #
@@ -15,21 +15,16 @@ module Applitools::Selenium
     def initialize(driver, options = {})
       self.driver = driver
       options = { debug_screenshot: false }.merge! options
-      self.debug_screenshot = options[:debug_screenshot]
-      self.name_enumerator = options[:name_enumerator]
+      self.debug_screenshot_provider = options[:debug_screenshot_provider]
     end
 
     # Takes a screenshot.
     #
     # @return [Applitools::Screenshot::Datastream] The screenshot.
-    def take_screenshot
+    def take_screenshot(options = {})
       logger.info 'Getting screenshot...'
-      if debug_screenshot
-        screenshot = driver.screenshot_as(:png) do |raw_screenshot|
-          save_debug_screenshot(raw_screenshot)
-        end
-      else
-        screenshot = driver.screenshot_as(:png)
+      screenshot = driver.screenshot_as(:png) do |raw_screenshot|
+        save_debug_screenshot(raw_screenshot, options[:debug_suffix])
       end
       logger.info 'Done getting screenshot! Creating Applitools::Screenshot...'
       Applitools::Screenshot.from_datastream screenshot
@@ -39,8 +34,8 @@ module Applitools::Selenium
 
     attr_accessor :debug_screenshot
 
-    def save_debug_screenshot(screenshot)
-      ChunkyPNG::Image.from_string(screenshot).save(name_enumerator.next)
+    def save_debug_screenshot(screenshot, suffix)
+      debug_screenshot_provider.save(screenshot, suffix || '')
     end
   end
 end

data/lib/applitools/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.11.2
+  version: 3.11.3
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-06 00:00:00.000000000 Z
+date: 2017-08-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.2
+        version: 3.11.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.11.2
+        version: 3.11.3
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement