eyes_images 3.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84bf491952e354ad6a8bd5b1be3557471c590c9c
+  data.tar.gz: 544807f8ef98e2bdf44348a25d75fca8a7245369
+SHA512:
+  metadata.gz: d8ff16ae3a07aa78b2a97bf018c72d1466debafd6568b68c7e9586845709cdbf395da3a73fd5a63ce3913b7042b2d884407a990e6625d9bbbb36aee8d55acfee
+  data.tar.gz: 3730cc602a76bf267f7e8cdcf2ca62909e5031f785d759b075b7fc4665947efd63e24e2eb94b317671733808ec44783b16134bdeb350dec8570209a75da73e28

data/lib/applitools/images/eyes.rb

@@ -0,0 +1,204 @@
+require 'applitools/core/eyes_base'
+
+# Eyes Images SDK
+#
+module Applitools::Images
+  # A class to perform visual validation on images. Allows to handle user data like +Mouse trigger+ and +Text trigger+
+  # @example
+  #   eyes = Applitools::Images::Eyes.new
+  #   eyes.open(app_name: 'App name', test_name: 'Test name')
+  #   eyes.check_image(eyes.check_image(image_path: '~/test/some_screenshot.png', tag: 'My Test')
+  #   eyes.close(true)
+  class Eyes < Applitools::EyesBase
+    # @!visibility private
+    attr_accessor :base_agent_id, :screenshot, :inferred_environment, :title
+
+    # @!visibility private
+    def capture_screenshot
+      @screenshot
+    end
+
+    # Creates a new eyes object
+    # @example
+    #   eyes = Applitools::Images::Eyes.new
+    # @param server_url The Eyes Server URL
+    def initialize(server_url = Applitools::Connectivity::ServerConnector::DEFAULT_SERVER_URL)
+      super
+      self.base_agent_id = 'eyes.images.ruby/1.0.0'
+    end
+
+    # Starts a test.
+    # @param [Hash] options
+    # @option options [String] :app_name the name of the application under trest. Required.
+    # @option options [String] :test_name the test name. Required
+    # @option options [String | Hash] :viewport_size viewport size for the baseline, may be passed as a
+    #   string (<tt>'800x600'</tt>) or as a hash (<tt>{width: 800, height: 600}</tt>).
+    #   If ommited, the viewport size will be grabbed from the actual image size
+    # @example
+    #   eyes.open app_name: 'my app', test_name: 'my test'
+    def open(options = {})
+      Applitools::ArgumentGuard.hash options, 'open(options)', [:app_name, :test_name]
+      options[:viewport_size] = Applitools::RectangleSize.from_any_argument options[:viewport_size]
+      open_base options
+    end
+
+    # Opens eyes using passed options, yields the block and then closes eyes session.
+    # Use Applitools::Images::Eyes method inside the block to perform the test. If the block throws an exception,
+    # eyes session will be closed correctly.
+    # @example
+    #  eyes.test(app_name: 'Eyes.Java', test_name: 'home2') do
+    #    eyes.check_image(image_path: './images/viber-home.png')
+    #    eyes.check_image(image_path: './images/viber-bada.png')
+    #  end
+    def test(options = {}, &_block)
+      open(options)
+      yield
+      close
+    ensure
+      abort_if_not_closed
+    end
+
+    # Matches the input image with the next expected image. Takes a hash as an argument. Returns +boolean+
+    # as result of matching.
+    # @param [Hash] options
+    # @option options [Applitools::Screenshot] :image
+    # @option options [String] :image_bytes image in PNG format. Can be obtained as ChunkyPNG::Image.to_blob()
+    # @option options [String] :image_path
+    # @option options [String] :tag An optional tag to be associated with the validation checkpoint.
+    # @option options [Boolean] :ignore_mismatch If set to +true+ the server should ignore a negative
+    #   result for the visual validation. (+false+ by default)
+    # @example Image is a file
+    #   eyes.check_image(image_path: '~/test/some_screenshot.png', tag: 'My Test')
+    # @example Image is a +Applitools::Screenshot+ instance
+    #   eyes.check_image(image: my_image, tag: 'My Test')
+    # @example Image is a +String+
+    #   eyes.check_image(image_bytes: string_represents_image, tag: 'My Test')
+    # @example Ignore mismatch
+    #   eyes.check_image(image: my_image, tag: 'My Test', ignore_mismatch: true)
+    def check_image(options)
+      options = { tag: nil, ignore_mismatch: false }.merge options
+
+      if disabled?
+        logger.info "check_image(image, #{options[:tag]}, #{options[:ignore_mismatch]}): Ignored"
+        return false
+      end
+
+      image = get_image_from_options options
+
+      logger.info "check_image(image, #{options[:tag]}, #{options[:ignore_mismatch]})"
+      if image.is_a? Applitools::Screenshot
+        self.viewport_size = Applitools::RectangleSize.new image.width, image.height if viewport_size.nil?
+        self.screenshot = EyesImagesScreenshot.new image
+      end
+      self.title = options[:tag] || ''
+      region_provider = Object.new
+      region_provider.instance_eval do
+        define_singleton_method :region do
+          Applitools::Region::EMPTY
+        end
+
+        define_singleton_method :coordinate_type do
+          nil
+        end
+      end
+      mr = check_window_base region_provider, options[:tag], options[:ignore_mismatch],
+        Applitools::EyesBase::USE_DEFAULT_TIMEOUT
+      mr.as_expected?
+    end
+
+    # Performs visual validation for the current image.
+    # @param [Hash] options
+    # @option options [Applitools::Region] :region A region to validate within the image
+    # @option options [Applitools::Screenshot] :image Image to validate
+    # @option options [String] :image_bytes Image in +PNG+ format. Can be obtained as ChunkyPNG::Image.to_blob()
+    # @option options [String] :image_path Path to image file
+    # @option options [String] :tag An optional tag to be associated with the validation checkpoint.
+    # @option options [Boolean] :ignore_mismatch If set to +true+ the server would ignore a negative
+    #   result for the visual validation
+    # @example Image is a file
+    #   eyes.check_region(image_path: '~/test/some_screenshot.png', region: my_region, tag: 'My Test')
+    # @example Image is a Applitools::Screenshot instance
+    #   eyes.check_region(image: my_image, tag: 'My Test', region: my_region)
+    # @example Image is a +String+
+    #   eyes.check_region(image_bytes: string_represents_image, tag: 'My Test', region: my_region)
+    def check_region(options)
+      options = { tag: nil, ignore_mismatch: false }.merge options
+
+      if disabled?
+        logger.info "check_region(image, #{options[:tag]}, #{options[:ignore_mismatch]}): Ignored"
+        return false
+      end
+
+      Applitools::ArgumentGuard.not_nil options[:region], 'options[:region] can\'t be nil!'
+      image = get_image_from_options options
+
+      logger.info "check_region(image, #{options[:region]}, #{options[:tag]}, #{options[:ignore_mismatch]})"
+
+      if image.is_a? Applitools::Screenshot
+        self.viewport_size = Applitools::RectangleSize.new image.width, image.height if viewport_size.nil?
+        self.screenshot = EyesImagesScreenshot.new image
+      end
+      self.title = options[:tag] || ''
+
+      region_provider = Object.new
+      region_provider.instance_eval do
+        define_singleton_method :region do
+          options[:region]
+        end
+        define_singleton_method :coordinate_type do
+          Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
+        end
+      end
+      mr = check_window_base region_provider, options[:tag], options[:ignore_mismatch],
+        Applitools::EyesBase::USE_DEFAULT_TIMEOUT
+      mr.as_expected?
+    end
+
+    # Adds a mouse trigger
+    # @param [Symbol] action A mouse action. Can be one of  +:click+, +:right_click+, +:double_click+, +:move+,
+    #   +:down+, +:up+
+    # @param [Applitools::Region] control The control on which the trigger is activated
+    #   (context relative coordinates).
+    # @param [Applitools::Location] cursor The cursor's position relative to the control.
+    def add_mouse_trigger(action, control, cursor)
+      add_mouse_trigger_base action, control, cursor
+    end
+
+    # Adds a keyboard trigger
+    # @param [Applitools::Region] control the control's context-relative region.
+    # @param text The trigger's text.
+    def add_text_trigger(control, text)
+      add_text_trigger_base control, text
+    end
+
+    private
+
+    def vp_size
+      viewport_size
+    end
+
+    def vp_size=(value)
+      Applitools::ArgumentGuard.not_nil 'value', value
+      @viewport_size = Applitools::RectangleSize.for value
+    end
+
+    alias get_viewport_size vp_size
+    alias set_viewport_size vp_size=
+
+    def get_image_from_options(options)
+      if options[:image].nil? && !options[:image].is_a?(Applitools::Screenshot)
+        if !options[:image_path].nil? && !options[:image_path].empty?
+          image = Applitools::Screenshot.new ChunkyPNG::Datastream.from_file(options[:image_path]).to_s
+        elsif options[:image_bytes].nil? && !options[:image_bytes].empty?
+          image = Applitools::Screenshot.new options[:image_bytes]
+        end
+      else
+        image = options[:image]
+      end
+
+      Applitools::ArgumentGuard.not_nil image, 'options[:image] can\'t be nil!'
+
+      image
+    end
+  end
+end

data/lib/applitools/images/eyes_images_screenshot.rb

@@ -0,0 +1,102 @@
+module Applitools::Images
+  # @!visibility private
+  class EyesImagesScreenshot < ::Applitools::EyesScreenshot
+    SCREENSHOT_AS_IS = Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is].freeze
+    CONTEXT_RELATIVE = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative].freeze
+
+    def initialize(image, options = {})
+      super image
+      return if (location = options[:location]).nil?
+      Applitools::ArgumentGuard.is_a? location, 'options[:location]', Applitools::Location
+      @bounds = Applitools::Region.new location.x, location.y, image.width, image.height
+    end
+
+    def convert_location(location, from, to)
+      Applitools::ArgumentGuard.not_nil location, 'location'
+      Applitools::ArgumentGuard.not_nil from, 'from'
+      Applitools::ArgumentGuard.not_nil to, 'to'
+
+      Applitools::ArgumentGuard.is_a? location, 'location', Applitools::Location
+
+      result = Applitools::Location.new location.x, location.y
+      return result if from == to
+
+      case from
+      when SCREENSHOT_AS_IS
+        raise "Coordinate type conversation error: #{from} -> #{to}" unless to == CONTEXT_RELATIVE
+        result.offset bounds
+        return result
+      when CONTEXT_RELATIVE
+        raise "Coordinate type conversation error: #{from} -> #{to}" unless to == SCREENSHOT_AS_IS
+        result.offset(Applitools::Location.new(-bounds.x, -bounds.y))
+        return result
+      else
+        raise "Coordinate type conversation error: #{from} -> #{to}"
+      end
+    end
+
+    def convert_region_location(region, from, to)
+      Applitools::ArgumentGuard.not_nil region, 'region'
+      return Core::Region.new(0, 0, 0, 0) if region.empty?
+
+      Applitools::ArgumentGuard.not_nil from, 'from'
+      Applitools::ArgumentGuard.not_nil to, 'to'
+
+      updated_location = convert_location region.location, from, to
+
+      Applitools::Region.new updated_location.x, updated_location.y, region.width, region.height
+    end
+
+    def intersected_region(region, from, to = CONTEXT_RELATIVE)
+      Applitools::ArgumentGuard.not_nil region, 'region'
+      Applitools::ArgumentGuard.not_nil from, 'coordinates Type (from)'
+
+      return Applitools::Region.new(0, 0, 0, 0) if region.empty?
+
+      intersected_region = convert_region_location region, from, to
+      intersected_region.intersect bounds
+      return intersected_region if intersected_region.empty?
+
+      intersected_region.location = convert_location intersected_region.location, to, from
+      intersected_region
+    end
+
+    def location_in_screenshot(location, coordinates_type)
+      Applitools::ArgumentGuard.not_nil location, 'location'
+      Applitools::ArgumentGuard.not_nil coordinates_type, 'coordinates_type'
+      location = convert_location(location, coordinates_type, CONTEXT_RELATIVE)
+
+      unless bounds.contains? location.left, location.top
+        raise Applitools::OutOfBoundsException.new "Location #{location} is not available in screenshot!"
+      end
+
+      convert_location location, CONTEXT_RELATIVE, SCREENSHOT_AS_IS
+    end
+
+    def sub_screenshot(region, coordinates_type, throw_if_clipped)
+      Applitools::ArgumentGuard.not_nil region, 'region'
+      Applitools::ArgumentGuard.not_nil coordinates_type, 'coordinates_type'
+
+      sub_screen_region = intersected_region region, coordinates_type, SCREENSHOT_AS_IS
+
+      if sub_screen_region.empty? || (throw_if_clipped && !region.size_equals?(sub_screen_region))
+        Applitools::OutOfBoundsException.new "Region #{sub_screen_region} (#{coordinates_type}) is out of " \
+          " screenshot bounds #{bounds}"
+      end
+
+      sub_screenshot_image = Applitools::Screenshot.new image.crop(sub_screen_region.left, sub_screen_region.top,
+        sub_screen_region.width, sub_screen_region.height).to_datastream.to_blob
+
+      relative_sub_screenshot_region = convert_region_location(sub_screen_region, SCREENSHOT_AS_IS, CONTEXT_RELATIVE)
+
+      Applitools::Images::EyesImagesScreenshot.new sub_screenshot_image,
+        location: relative_sub_screenshot_region.location
+    end
+
+    private
+
+    def bounds
+      @bounds ||= Applitools::Region.new(0, 0, image.width, image.height)
+    end
+  end
+end

data/lib/applitools/version.rb

@@ -0,0 +1,3 @@
+module Applitools
+  VERSION = '3.0.4'.freeze
+end

data/lib/eyes_images.rb

@@ -0,0 +1,15 @@
+require 'eyes_core'
+
+module Applitools::Images
+  # @!visibility private
+  class << self
+    # @!visibility private
+    def require_dir(dir)
+      Dir[File.join(File.dirname(File.expand_path(__FILE__)), 'applitools', dir, '*.rb')].sort.each do |f|
+        require f
+      end
+    end
+  end
+end
+
+Applitools::Images.require_dir 'images'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: eyes_images
+version: !ruby/object:Gem::Version
+  version: 3.0.4
+platform: ruby
+authors:
+- Applitools Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eyes_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+description: Applitools Ruby Images SDK
+email:
+- team@applitools.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/applitools/images/eyes.rb
+- lib/applitools/images/eyes_images_screenshot.rb
+- lib/applitools/version.rb
+- lib/eyes_images.rb
+homepage: https://www.applitools.com
+licenses:
+- Apache License, Version 2.0
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Applitools Ruby Images SDK
+test_files: []