eyes_core 3.10.2 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5809ea0c1a4fce9a7233b53c2f93b811cd45e24
-  data.tar.gz: 7297d6577eb1d687fe9fd08954a9accbbd7273b1
+  metadata.gz: e4ecf0b330e7ed9c413a7c4e22ea2e2f39324d1c
+  data.tar.gz: c5792bf7600f5046341ef35f5c4387cbd99806d5
 SHA512:
-  metadata.gz: 224885021816ed5b60ba60c5e07a9469c3e991f1fb10a789935fce33b7119d2605202ea751b23da8bf3291f088e82b0ce71e461736610854b2a7ed03fb53f48a
-  data.tar.gz: 7257faf0af15b39d3d90a0708ee001f2f7aa55ffa9b4134745633af0b342bb56898316494b03da7547278431bcb5c4a6061ced8456475485de093d8ec0445d0a
+  metadata.gz: d4980e04b7a5d40183a5a632f36fae69458eef23826ea0bfc91d818bdf8c2bead8d3d5c9cc5930e349fd75229a71fbb6c74056d0af56dc09000c7b94f68bbf9f
+  data.tar.gz: 80510420088d04c8f482bd68e0701ead2033fc74d37c32a4be257b86a4d81c180260a90ed11448c96465e7c8e490cc29fd502ab7e0133ffe7ce0fdf0d9532320

data/lib/applitools/core/eyes_base.rb

@@ -93,17 +93,20 @@ module Applitools
     # @return [Target] Applitools::Selenium::Target or Applitools::Images::target
 
     def default_match_level(value, exact_options = {})
-      @match_level, self.exact = match_level_with_exact(value, exact_options)
+      result = match_level_with_exact(value, exact_options)
+      default_match_settings[:match_level] = result.first
+      self.match_level = result.first
+      default_match_settings[:exact] = result.last
+      self.exact = result.last
+      result
     end
 
-    # rubocop:disable LineLength
     # Sets default match settings
     # @param [Hash] value
     # @option value [Symbol] match_level
     # @option value [Hash] exact exact values. Available keys are 'MinDiffIntensity', 'MinDiffWidth', 'MinDiffHeight', 'MatchThreshold'
     # @option value [Fixnum] scale
     # @option value [Fixnum] remainder
-    # rubocop:enable LineLength
 
     def default_match_settings=(value)
       Applitools::ArgumentGuard.is_a? value, 'value', Hash

data/lib/applitools/core/floating_region.rb

@@ -2,30 +2,70 @@ require_relative 'region'
 module Applitools
   class FloatingRegion < Region
     class << self
-      def any(element, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
+      def any(element, *args)
         case element
-        when Applitools::Selenium::Element, ::Selenium::WebDriver::Element, Applitools::Region
-          for_element(element, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
+        when Applitools::Region
+          for_element(element, *args)
+        when ::Selenium::WebDriver::Element
+          for_element(Applitools::Region.from_location_size(element.location, element.size), *args)
+        when Applitools::Selenium::Element
+          for_element(element.bounds, *args)
         else
           raise Applitools::EyesIllegalArgument.new "Unsupported element - #{element.class}"
         end
       end
 
-      def for_element(element, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
-        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
+      def for_element(element, *args)
+        case args.count
+        when 1
+          new element, args.first
+        when 4
+          new element, FloatingBounds.new(*args)
+        else
+          raise(
+            Applitools::EyesIllegalArgument,
+            'Applitools::FloatingRegion.for_element has been called with illegal argument'
+          )
+        end
       end
       private :for_element
     end
 
     attr_accessor :max_top_offset, :max_right_offset, :max_bottom_offset, :max_left_offset
+    NAMES = [
+      :left, :top, :width, :height, :max_left_offset, :max_top_offset, :max_right_offset, :max_bottom_offset
+    ].freeze
 
-    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
+    def initialize(*args)
+      case args.size
+      when 2
+        region = args.first
+        bounds = args.last
+        super(region.left, region.top, region.width, region.height)
+        self.max_left_offset = bounds.max_left_offset
+        self.max_top_offset = bounds.max_top_offset
+        self.max_right_offset = bounds.max_right_offset
+        self.max_bottom_offset = bounds.max_bottom_offset
+      when 8
+        args.each_with_index do |a, i|
+          Applitools::ArgumentGuard.is_a? a, NAMES[i], Integer
+          Applitools::ArgumentGuard.greater_than_or_equal_to_zero(a, NAMES[i])
+        end
+        super(*args[0..3])
+        self.max_left_offset = args[4]
+        self.max_top_offset = args[5]
+        self.max_right_offset = args[6]
+        self.max_bottom_offset = args[7]
+      else
+        raise(
+          Applitools::EyesIllegalArgument,
+          'Expected Applitools::FloatingRegion.new to be called as ' \
+          'Applitools::FloatingRegion.new(region, floating_bounds)' \
+          'or ' \
+          'Applitools::FloatingRegion.new(left, top, width, height, ' \
+          'bounds_leeft, bounds_top, bounds_right, bounds_bottom)'
+        )
+      end
     end
 
     def to_hash
@@ -34,11 +74,31 @@ module Applitools
         'Left' => left,
         'Width' => width,
         'Height' => height,
-        'MaxUpOffset' => max_top_offset,
-        'MaxLeftOffset' => max_left_offset,
-        'MaxRightOffset' => max_right_offset,
-        'MaxDownOffset' => max_bottom_offset
+        'MaxUpOffset' => max_top_offset + padding_top,
+        'MaxLeftOffset' => max_left_offset + padding_left,
+        'MaxRightOffset' => max_right_offset + padding_right,
+        'MaxDownOffset' => max_bottom_offset + padding_bottom
       }
     end
   end
+
+  class FloatingBounds
+    attr_accessor :max_left_offset, :max_top_offset, :max_right_offset, :max_bottom_offset
+    def initialize(max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
+      Applitools::ArgumentGuard.is_a?(max_left_offset, 'max_left_offset', Integer)
+      Applitools::ArgumentGuard.is_a?(max_top_offset, 'max_top_offset', Integer)
+      Applitools::ArgumentGuard.is_a?(max_right_offset, 'max_right_offset', Integer)
+      Applitools::ArgumentGuard.is_a?(max_bottom_offset, 'max_bottom_offset', Integer)
+
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(max_left_offset, 'max_left_offset')
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(max_top_offset, 'max_top_offset')
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(max_right_offset, 'max_right_offset')
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(max_bottom_offset, 'max_bottom_offset')
+
+      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
+  end
 end

data/lib/applitools/core/match_window_data.rb

@@ -3,7 +3,7 @@ module Applitools
     class << self
       def convert_coordinates(region, screenshot)
         screenshot.convert_region_location(
-          Applitools::Region.from_location_size(region.location, region.size),
+          region.with_padding,
           Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
           Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
         ).to_hash
@@ -166,8 +166,7 @@ module Applitools
         target.ignored_regions.each do |r|
           case r
           when Proc
-            region = r.call(driver)
-            @ignored_regions << Applitools::Region.from_location_size(region.location, region.size)
+            @ignored_regions << r.call(driver)
             @need_convert_ignored_regions_coordinates = true
           when Applitools::Region
             @ignored_regions << r

data/lib/applitools/core/padding_bounds.rb

@@ -0,0 +1,24 @@
+module Applitools
+  class PaddingBounds
+    attr_accessor :padding_left, :padding_top, :padding_right, :padding_bottom
+    def initialize(padding_left, padding_top, padding_right, padding_bottom)
+      Applitools::ArgumentGuard.is_a?(padding_left, 'padding_left', Integer)
+      Applitools::ArgumentGuard.is_a?(padding_top, 'padding_top', Integer)
+      Applitools::ArgumentGuard.is_a?(padding_right, 'padding_right', Integer)
+      Applitools::ArgumentGuard.is_a?(padding_bottom, 'padding_bottom', Integer)
+
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(padding_left, 'padding_left')
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(padding_top, 'padding_top')
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(padding_right, 'padding_right')
+      Applitools::ArgumentGuard.greater_than_or_equal_to_zero(padding_bottom, 'padding_bottom')
+
+      self.padding_left = padding_left
+      self.padding_top = padding_top
+      self.padding_right = padding_right
+      self.padding_bottom = padding_bottom
+    end
+
+    ZERO_PADDING = PaddingBounds.new(0, 0, 0, 0).freeze
+    PIXEL_PADDING = PaddingBounds.new(1, 1, 1, 1).freeze
+  end
+end

data/lib/applitools/core/region.rb

@@ -1,6 +1,11 @@
+require_relative 'padding_bounds'
 module Applitools
   class Region
+    extend Forwardable
     attr_accessor :left, :top, :width, :height
+
+    def_delegators :@padding, :padding_left, :padding_top, :padding_right, :padding_bottom
+
     alias x left
     alias y top
 
@@ -15,6 +20,7 @@ module Applitools
       @top = top.round
       @width = width.round
       @height = height.round
+      @padding = Applitools::PaddingBounds::ZERO_PADDING
     end
 
     EMPTY = Region.new(0, 0, 0, 0)
@@ -106,6 +112,23 @@ module Applitools
       width == region.width && height == region.height
     end
 
+    # Sets padding for a current region. If called without any argument, all paddings will be set to 0
+    # @param padding[Applitools::PaddingBounds] represents paddings to be set for a region
+    # @return [Applitools::Region]
+    def padding(padding = nil)
+      padding = Applitools::PaddingBounds::ZERO_PADDING unless padding
+      Applitools::ArgumentGuard.is_a?(padding, 'padding', Applitools::PaddingBounds)
+      @padding = padding
+      self
+    end
+
+    def with_padding
+      Applitools::Region.from_location_size(
+        Applitools::Location.new(left - padding_left, top - padding_top),
+        Applitools::RectangleSize.new(width + padding_left + padding_right, height + padding_top + padding_bottom)
+      )
+    end
+
     class << self
       def sub_regions_with_fixed_size(container_region, sub_region)
         Applitools::ArgumentGuard.not_nil container_region, 'container_region'

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '3.10.2'.freeze
+  VERSION = '3.11.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.10.2
+  version: 3.11.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -230,6 +230,7 @@ files:
 - lib/applitools/core/match_window_data.rb
 - lib/applitools/core/match_window_task.rb
 - lib/applitools/core/mouse_trigger.rb
+- lib/applitools/core/padding_bounds.rb
 - lib/applitools/core/rectangle_size.rb
 - lib/applitools/core/region.rb
 - lib/applitools/core/region_provider.rb