eyes_core 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd1acdd13827926e57fe2bf72251ed21ebe7090a
-  data.tar.gz: 265b88d8fca7e2e5bc1dca8cc837254bc7307af6
+  metadata.gz: 3cd56839e5721775879c8103fe725889fd804eb6
+  data.tar.gz: 1a22c8653ccf48d6021b5d6416e2de18d55c98ca
 SHA512:
-  metadata.gz: 3517e061b53fb5669ad5f18383932718e00c4b09fba300ec4ac2a24754b2b34425bd5f4f23ca0e1438af35b653537f47b51bbf8a971b1a2224e0078338a00202
-  data.tar.gz: 1838ddf5bd8396bd81f4fe471dff33a80184eeb511094cf15afdb9efd4d4602bdb00fc6b975888b6d2bfe2bfd53646d13e4088502cb51f1bd7e4f8862d9ec8a2
+  metadata.gz: 024443174ee13d25181fbdd8f92fdc2daced4cbbf43394b189d7f22921c867d1e64e700f179c79d433072b5f390b065ecc3f37b2d992d8692b574066aa6cc109
+  data.tar.gz: ab4d97600d218dbd6f0920ae3230638c2c4b25898dd074176b548b86e76ac1bad15d16c3bef49309ba38f1052cca930c12b69a58e9c082c809b9ee13d05cd7e7

data/lib/applitools/connectivity/server_connector.rb

@@ -66,14 +66,19 @@ module Applitools::Connectivity
     RETRY_STEP_FACTOR = 1.5
     RETRY_MAX_DELAY = 5
 
-    def match_single_window(data)
+    def match_single_window_data(data)
       # Notice that this does not include the screenshot.
       json_data = Oj.dump(data.to_hash).force_encoding('BINARY')
       body = [json_data.length].pack('L>') + json_data + data.screenshot
       # Applitools::EyesLogger.debug json_data
       begin
         Applitools::EyesLogger.debug 'Sending match data...'
-        res = long_post(@single_check_endpoint_url, content_type: 'application/octet-stream', body: body)
+        res = long_post(
+          @single_check_endpoint_url,
+          content_type: 'application/octet-stream',
+          body: body,
+          query: { agent_id: data.agent_id }
+        )
       rescue Errno::EWOULDBLOCK, Faraday::ConnectionFailed
         @delays ||= request_delay(RETRY_DELAY, RETRY_STEP_FACTOR, RETRY_MAX_DELAY)
         begin
@@ -81,11 +86,16 @@ module Applitools::Connectivity
         rescue StopIteration
           raise Applitools::UnknownNetworkStackError.new('Unknown network stack error')
         end
-        res = match_single_window(data)
+        res = match_single_window_data(data)
       ensure
         @delays = nil
       end
       raise Applitools::EyesError.new("Request failed: #{res.status} #{res.headers} #{res.body}") unless res.success?
+      res
+    end
+
+    def match_single_window(data)
+      res = match_single_window_data(data)
       Applitools::TestResults.new Oj.load(res.body)
     end
 

data/lib/applitools/core/eyes_base.rb

@@ -111,7 +111,7 @@ module Applitools
     end
 
     def add_property(name, value)
-      @properties << {name: name, value: value}
+      @properties << { name: name, value: value }
     end
 
     def abort_if_not_closed

data/lib/applitools/core/floating_region.rb

@@ -0,0 +1,35 @@
+require_relative 'region'
+module Applitools
+  class FloatingRegion < Region
+    class << self
+      def for_element(element, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
+        Applitools::ArgumentGuard.is_a? element, 'element', Applitools::Selenium::Element
+        new element.location.x, element.location.y, element.size.width, element.size.height, max_left_offset,
+          max_top_offset, max_right_offset, max_bottom_offset
+      end
+    end
+
+    attr_accessor :max_top_offset, :max_right_offset, :max_bottom_offset, :max_left_offset
+
+    def initialize(left, top, width, height, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
+      super(left, top, width, height)
+      self.max_left_offset = max_left_offset
+      self.max_top_offset = max_top_offset
+      self.max_right_offset = max_right_offset
+      self.max_bottom_offset = max_bottom_offset
+    end
+
+    def to_hash
+      {
+        'Top' => top,
+        'Left' => left,
+        'Width' => width,
+        'Height' => height,
+        'MaxUpOffset' => max_top_offset,
+        'MaxLeftOffset' => max_left_offset,
+        'MaxRightOffset' => max_right_offset,
+        'MaxDownOffset' => max_bottom_offset
+      }
+    end
+  end
+end

data/lib/applitools/core/match_single_check_data.rb

@@ -90,5 +90,9 @@ module Applitools
     def remove_session_if_matching=(value)
       current_data['removeSessionIfMatching'] = value ? true : false
     end
+
+    def agent_id
+      current_data['startInfo']['agentId']
+    end
   end
 end

data/lib/applitools/core/match_window_data.rb

@@ -22,6 +22,7 @@ module Applitools
               'SplitBottomHeight' => 0,
               'IgnoreCaret' => false,
               'Ignore' => [],
+              'Floating' => [],
               'Exact' => {
                 'MinDiffIntensity' => 0,
                 'MinDiffWidth' => 0,
@@ -65,7 +66,9 @@ module Applitools
     def initialize
       @app_output = nil
       @ignored_regions = []
+      @floating_regions = []
       @need_convert_ignored_regions_coordinates = false
+      @need_convert_floating_regions_coordinates = false
     end
 
     def screenshot
@@ -97,6 +100,13 @@ module Applitools
       end
     end
 
+    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
+
     def app_output=(value)
       Applitools::ArgumentGuard.is_a? value, 'value', Applitools::AppOutputWithScreenshot
       @app_output = value
@@ -116,7 +126,7 @@ module Applitools
 
     def read_target(target, driver)
       # options
-      %w(trim).each do |field|
+      target_options_to_read.each do |field|
         send("#{field}=", target.options[field.to_sym])
       end
       # ignored regions
@@ -131,8 +141,28 @@ module Applitools
           @need_convert_ignored_regions_coordinates = true
         end
       end
+      # 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
 
+    def target_options_to_read
+      %w(trim ignore_caret)
+    end
+
+    private :target_options_to_read
+
     def ignore_mismatch
       current_data['IgnoreMismatch']
     end
@@ -145,6 +175,10 @@ module Applitools
       current_data['Options']['Trim']['Enabled'] = value ? true : false
     end
 
+    def ignore_caret=(value)
+      current_data['Options']['ImageMatchSettings']['IgnoreCaret'] = value
+    end
+
     def convert_ignored_regions_coordinates
       return unless @need_convert_ignored_regions_coordinates
       self.ignored_regions = @ignored_regions.map do |r|
@@ -153,12 +187,31 @@ module Applitools
       @need_convert_ignored_regions_coordinates = false
     end
 
+    def convert_floating_regions_coordinates
+      return unless @need_convert_floating_regions_coordinates
+      self.floating_regions = @floating_regions.map do |r|
+        r.location = app_output.screenshot.convert_location(
+          r.location,
+          Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
+          Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
+        )
+        r.to_hash
+      end
+      @need_convert_floating_regions_coordinates = false
+    end
+
     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
 

data/lib/applitools/core/match_window_task.rb

@@ -41,12 +41,14 @@ module Applitools
         app_output = app_output_provider.app_output(region_provider, last_screenshot)
         match_window_data.app_output = app_output
         match_window_data.convert_ignored_regions_coordinates
+        match_window_data.convert_floating_regions_coordinates
         match_result = perform_match(match_window_data)
       else
         passed_ignore_mismatch = match_window_data.ignore_mismatch
         app_output = app_output_provider.app_output(region_provider, last_screenshot)
         match_window_data.app_output = app_output
         match_window_data.convert_ignored_regions_coordinates
+        match_window_data.convert_floating_regions_coordinates
         match_window_data.ignore_mismatch = true
         start = Time.now
         match_result = perform_match(match_window_data)
@@ -63,6 +65,7 @@ module Applitools
           app_output = app_output_provider.app_output(region_provider, last_screenshot)
           match_window_data.app_output = app_output
           match_window_data.convert_ignored_regions_coordinates
+          match_window_data.convert_floating_regions_coordinates
           match_window_data.ignore_mismatch = true
           match_result = perform_match(match_window_data)
           retry_time = Time.now - start
@@ -72,6 +75,7 @@ module Applitools
           app_output = app_output_provider.app_output(region_provider, last_screenshot)
           match_window_data.app_output = app_output
           match_window_data.convert_ignored_regions_coordinates
+          match_window_data.convert_floating_regions_coordinates
           match_window_data.ignore_mismatch = passed_ignore_mismatch
           match_result = perform_match(match_window_data)
         end

data/lib/applitools/images/target.rb

@@ -42,13 +42,14 @@ module Applitools::Images
       end
     end
 
-    attr_accessor :image, :options, :ignored_regions, :region_to_check
+    attr_accessor :image, :options, :ignored_regions, :region_to_check, :floating_regions
 
     def initialize(image)
       Applitools::ArgumentGuard.not_nil(image, 'image')
       Applitools::ArgumentGuard.is_a? image, 'image', Applitools::Screenshot
       self.image = image
       self.ignored_regions = []
+      self.floating_regions = []
       self.options = {
         trim: false
       }
@@ -64,6 +65,22 @@ module Applitools::Images
       self
     end
 
+    def floating(*args)
+      value = case args.first
+                when Applitools::FloatingRegion
+                  proc { args.first }
+                when Applitools::Region
+                  proc do
+                    region = args.shift
+                    Applitools::FloatingRegion.new region.left, region.top, region.width, region.height, *args
+                  end
+                else
+                  self.floating_regions = []
+              end
+      floating_regions << value
+      self
+    end
+
     def region(region = nil)
       if region
         Applitools::ArgumentGuard.is_a? region, 'region', Applitools::Region

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '3.8.0'.freeze
+  VERSION = '3.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -217,6 +217,7 @@ files:
 - lib/applitools/core/eyes_screenshot.rb
 - lib/applitools/core/fixed_cut_provider.rb
 - lib/applitools/core/fixed_scale_provider.rb
+- lib/applitools/core/floating_region.rb
 - lib/applitools/core/hash_extension.rb
 - lib/applitools/core/helpers.rb
 - lib/applitools/core/location.rb