eyes_calabash 6.4.2 → 6.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9d13744470cc6a5af79f154c6711a33361514fffb0dcd1c7ec04b2f90cd6b80
-  data.tar.gz: 945b1dd3fd6dddb804d0d30480ba3311f145c1fb4a852ebbe50b5f8fa9b720b0
+  metadata.gz: 2707a121135debdc840fec15ba5323901b8a40e6e85a49dd29d6a051a4b0b409
+  data.tar.gz: dd5b77b1ec982b7280860334b98f36b48c267fd51c4fdea756d05c88cdc0eab4
 SHA512:
-  metadata.gz: 7e2d2cc531339058e401ea6aa60624e8ad089ddcd7ec1c44a03e342eacad7d3f9841793b977c4ef678ea1489623c78bce2b5c6ed7d3d2d12e9f8f4da0655884c
-  data.tar.gz: d9927fab3f84de812a7b3a93621b443a5701b6043a9a861be4b91b758104db98bfc85c73328c91d25404e75f2e76eeb90c6d6555941da8133fda958cd15e1e80
+  metadata.gz: 2b32c6907b3d555cb6a371047dbcf9d827e8688022253317fba309ce854b3d154c99c1dc0a54762f3cde11dcd04d5f9162e9a3db3796304551c7166fc8e6c64c
+  data.tar.gz: f2a81ee3e3e3c9d185f87635f22e59b2c9acd1e927fe514ffd1d83fcc8c8d01cac6ce678c8f8ac009836ebee2a43bac0b9c51c3a7065c852db6ba5bb5835f3f1

data/CHANGELOG.md

@@ -1,5 +1,97 @@
 # Changelog
 
+## [6.4.4](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_calabash@6.4.3...ruby/eyes_calabash@6.4.4) (2025-06-15)
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.22
+  #### Bug Fixes
+
+  * css media query group conditions | FLD-3151 ([#3023](https://github.com/Applitools-Dev/sdk/issues/3023)) ([56ec107](https://github.com/Applitools-Dev/sdk/commit/56ec107bcda6a5a330d19c278267d73de5d86d8b))
+
+
+
+* @applitools/req bumped to 1.7.13
+
+* @applitools/dom-capture bumped to 11.5.6
+
+* @applitools/spec-driver-webdriver bumped to 1.2.6
+
+* @applitools/screenshoter bumped to 3.11.5
+
+* @applitools/nml-client bumped to 1.9.5
+  #### Bug Fixes
+
+  * nml-client depends on core-base ([#2995](https://github.com/Applitools-Dev/sdk/issues/2995)) ([1f7cf69](https://github.com/Applitools-Dev/sdk/commit/1f7cf6930709a40a498dd1f525132648aa593af0))
+
+
+
+* @applitools/tunnel-client bumped to 1.8.0
+  #### Features
+
+  * update build script to include individual zip creation ([#3008](https://github.com/Applitools-Dev/sdk/issues/3008)) ([46a0cfc](https://github.com/Applitools-Dev/sdk/commit/46a0cfcc472ab69384560095d90a7fa58b4b9186))
+
+
+
+* @applitools/ufg-client bumped to 1.16.12
+  #### Bug Fixes
+
+  * remove safari-early-access browser version for js sdks | AD-10226 ([#3034](https://github.com/Applitools-Dev/sdk/issues/3034)) ([7ca09f5](https://github.com/Applitools-Dev/sdk/commit/7ca09f5c0c271570142058ea766533b86434dc2e))
+
+
+
+* @applitools/core-base bumped to 1.25.4
+  #### Bug Fixes
+
+  * Differentiate Between Invalid and Missing API Key Errors ([6ac17d4](https://github.com/Applitools-Dev/sdk/commit/6ac17d40d7aff45b3de5c949dc7d4673b9739bfd))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+
+
+
+* @applitools/test-server bumped to 1.2.3
+  #### Bug Fixes
+
+  * basic auth protected resources | FLD-2761 | FMRI-120 ([#2444](https://github.com/Applitools-Dev/sdk/issues/2444)) ([b48cf49](https://github.com/Applitools-Dev/sdk/commit/b48cf49dec50bbf1ed2ba111608a48cf09962565))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+  * storybook navigation timeouts ([#2701](https://github.com/Applitools-Dev/sdk/issues/2701)) ([64e3a40](https://github.com/Applitools-Dev/sdk/commit/64e3a40a524ae76ec457ae9c2d1170fbaea5e982))
+
+
+
+* @applitools/ec-client bumped to 1.10.15
+
+* @applitools/core bumped to 4.40.0
+  #### Features
+
+  * update build script to include individual zip creation ([#3008](https://github.com/Applitools-Dev/sdk/issues/3008)) ([46a0cfc](https://github.com/Applitools-Dev/sdk/commit/46a0cfcc472ab69384560095d90a7fa58b4b9186))
+
+
+  #### Bug Fixes
+
+  * css media query group conditions | FLD-3151 ([#3023](https://github.com/Applitools-Dev/sdk/issues/3023)) ([56ec107](https://github.com/Applitools-Dev/sdk/commit/56ec107bcda6a5a330d19c278267d73de5d86d8b))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+  * extractLatestCommitInfo | FLD-3217 ([#3039](https://github.com/Applitools-Dev/sdk/issues/3039)) ([3f72a23](https://github.com/Applitools-Dev/sdk/commit/3f72a230fa0166046ea85ae004cfb544de86e628))
+  * handle error when sending started message in tunnel manager server ([#3019](https://github.com/Applitools-Dev/sdk/issues/3019)) ([2cdaad8](https://github.com/Applitools-Dev/sdk/commit/2cdaad896fd679187449b69abe529b006f6255ee))
+
+
+
+* eyes_universal bumped to 4.40.0
+
+* eyes_core bumped to 6.7.2
+
+
+## [6.4.3](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_calabash@6.4.2...ruby/eyes_calabash@6.4.3) (2025-05-22)
+
+
+### Dependencies
+
+* eyes_universal bumped to 4.38.0
+  #### Features
+
+  * adding the mac-arm64 binary ([#2975](https://github.com/Applitools-Dev/sdk/issues/2975)) ([95d647f](https://github.com/Applitools-Dev/sdk/commit/95d647ff4a451309d985a786f7cec544d926f0e5))
+* eyes_core bumped to 6.7.1
+
+
 ## [6.4.2](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_calabash@6.4.1...ruby/eyes_calabash@6.4.2) (2025-04-17)
 
 

data/LICENSE

@@ -0,0 +1,26 @@
+-  -
+SDK LICENSE AGREEMENT
+IMPORTANT - PLEASE READ CAREFULLY THE TERMS OF THIS LICENSE AGREEMENT ("AGREEMENT"). BY INSTALLING, ACCESSING AND/OR USING THE SOFTWARE (AS DEFINED BELOW), YOU EXPRESSLY ACKNOWLEDGE AND AGREE THAT YOU, OR THE COMPANY YOU REPRESENT, ("YOU" OR "LICENSEE") ARE ENTERING INTO A LEGAL AGREEMENT WITH APPLITOOLS LTD. AND ITS AFFILIATES ("APPLITOOLS"), AND HAVE UNDERSTOOD AND AGREE TO COMPLY WITH, AND BE LEGALLY BOUND BY, THE TERMS AND CONDITIONS OF THIS AGREEMENT. YOU HEREBY WAIVE ANY RIGHTS OR REQUIREMENTS UNDER ANY LAWS OR REGULATIONS IN ANY JURISDICTION WHICH REQUIRE AN ORIGINAL (NON-ELECTRONIC) SIGNATURE OR DELIVERY OR RETENTION OF NON-ELECTRONIC RECORDS, TO THE EXTENT PERMITTED UNDER APPLICABLE LAW.
+THE SOFTWARE MAY BE USED SOLELY FOR YOUR PERSONAL, NON-COMMERCIAL PURPOSES. FOR COMMERCIAL PURPOSES PLEASE CONTACT THE REGIONAL APPLITOOLS BUSINESS REPRESENTATIVE.
+1. Definitions. For purposes of this Agreement, the following capitalized terms shall have the following meaning:
+   1. "Documentation" means the user's guides and technical manuals delivered by Applitools to Licensee.
+   2.  "Feedback" means suggestions, comments or feedback (whether orally or in writing) with respect to the Software.
+   3. "Intellectual Property Rights" means all intangible legal rights, titles and interests evidenced by or embodied in all: (i) inventions (regardless of patentability and whether or not reduced to practice), improvements thereto, patents, patent applications, patent disclosures, together with all reissuances, continuations, continuations in part, revisions, extensions and reexaminations thereof; (ii) trademarks, service marks, trade dress, logos, trade names, corporate names, together with translations, adaptations, derivations and combinations thereof, including goodwill associated therewith, and applications, registrations, and renewals in connection therewith; (iii) any work of authorship, regardless of copyrightable, copyrightable works, copyrights (including moral rights), and applications, registrations and renewals in connection therewith; (iv) mask works and applications, registrations and renewals in connection therewith; (v) trade secrets and Confidential Information; and (vi) other proprietary rights and any other similar rights, in each case on a worldwide basis, and copies and tangible embodiments thereof, in whatever form or medium.
+   4. "License" means the right to use the Software pursuant to Section ‎2.1 to this Agreement.
+   5.  "Software" means Applitools' software development kit software in object or source code version, Documentation and any updates and upgrade thereto (to the extent delivered).
+1. License
+   1. Grant of License. Subject to the terms and conditions of this Agreement, Applitools grants You, during the Term, a personal, non-exclusive, non-sublicensable, non-transferable, revocable license to: (i) use the Software solely for Your own personal (non-commercial) use and (ii) use and display Applitools' Marks solely for the purpose of publicizing or advertising that You are using the Software.
+   2. Documentation. Applitools may make available Documentation to Licensee for Licensee to use solely in connection with Licensee's use of the Software during the term of this Agreement. Licensee may print or copy the Documentation as needed for its own purposes provided that all copyright notices are included therein. The Documentation shall be considered the Confidential Information of Applitools.
+   1. Reservation of Rights; Use Restrictions. Other than the rights explicitly granted in this Agreement, Licensee shall have no other rights, express or implied, in the Software. Without limiting the generality of the foregoing, Licensee agrees and undertakes not to: (i) allow any third party to use the Software in any manner, including but not limited to, sell, lease, sublicense or distribute the Software, or any part thereof; (ii) modify, revise, or alter the Software or reverse engineer, decompile, disassemble or otherwise reduce to human-perceivable form the Software's source code; (iii) copy or allow copies of the Software to be made; (iv) remove, alter or obscure any proprietary notice or identification, including copyright, trademark, patent or other notices, contained in or displayed on or via the Software; (v) use the Software to violate any applicable laws, rules or regulations, or for any unlawful, harmful, irresponsible, or inappropriate purpose, or in any manner that breaches this Agreement, and/or (vi) represent that it possesses any proprietary interest in the Software.
+   1. Third Party Software. Licensee acknowledges and agrees that any third party software ("Third Party Software") that provided with the Software is provided under the terms of the license attached/linked thereto or, if no such license is attached, such Third Party Software is provided for free and on "AS IS" basis. Applitools is not liable for any losses or damages which may occur resulting from the use of any Third Party Software. Applitools does not possess any proprietary interest in such Third Party Software.
+   1. Open Source Licenses. The Software includes certain open source code software and materials (as shall be listed in the documentation of the Software) ("Open Source Software") that are subject to their respective open source licenses ("Open Source Licenses"). Such Open Source Licenses contain a list of conditions with respect to warranty, copyright policy and other provisions. By executing this Agreement, Licensee undertakes to strictly comply with the terms and condition of the Open Source Licenses, as may be amended from time to time. In order to comply with the Open Source Licenses, Licensee shall read the respective licenses or notices, such list of Open Source Licenses may be amended from time to time by Applitools, at its sole discretion. In the event of any inconsistencies or conflicting provisions between the provisions of the Open Source Licenses and the provisions of this Agreement, the provisions of the Open Source Licenses shall prevail. Without derogating from the generality of the foregoing, it is clarified that any Open Source Software is provided on an "AS IS" basis, without indemnity or warranty of any kind, whether express or implied. For clarity, the representations and warranties set forth in Section ‎4 hereunder shall not apply to any Open Source Software.
+1. Title & Ownership. APPLITOOLS DOES NOT SELL OR TRANSFER TITLE IN THE SOFTWARE, OR ANY PART THEREOF, TO LICENSEE. The Documentation, Software (excluding any Open Source Software and Third Party Software therein which are owned by their respective licensors) and/or any copies thereof, including without limitation any derivative works made (regardless of whether such derivative works were made and/or developed pursuant to the request and/or specifications of Licensee, and irrespective of any support and/or assistance Applitools may, will or had received from Licensee, or any third party on its behalf, with respect thereto), as well as any updates or upgrades thereto, if provided to Applitools pursuant to this Agreement, shall remain Applitools' sole and exclusive property. All Intellectual Property Rights evidenced by or embodied in and/or attached/connected/related to the Software, or part thereof, are and shall be owned solely and exclusively by Applitools. Nothing in this Agreement shall constitute a waiver of Applitools' Intellectual Property Rights under any law, or be in any way construed or interpreted as such. It is further agreed that to the extent Licensee provides Applitools with Feedback, Licensee acknowledges that any and all rights, including Intellectual Property Rights in such Feedback shall belong exclusively to Applitools and Licensee hereby irrevocably and unconditionally transfers and assigns to Applitools all intellectual property rights in such Feedback and waives any and all moral rights that Licensee may have in respect thereto. It is further understood that use of Feedback, if any, may be made by Applitools at its sole discretion, and that Applitools in no way shall be obliged to make use of any kind of the Feedback or part thereof.
+1. Warranty. Applitools warrants that to its knowledge it has the right to grant the license under this Agreement. Applitools' sole liability for any breach of this warranty or any other warranty under this Agreement shall be, at Applitools' sole discretion: (i) to replace or repair the Software or the applicable portion thereof; or (ii) to terminate this Agreement.
+2. Warranty Exclusions. The warranties set forth in Section ‎4 are contingent upon Licensee's proper use of the Software, and shall not apply to damage caused by abuse, misuse, alteration, neglect or unauthorized repair or installation, or by the use or attempted use of Software other than that supplied and supported by Applitools. Applitools will use reasonable commercial efforts to repair or replace the Software or the applicable portion thereof, pursuant to the foregoing warranty within thirty (30) days of being so notified.
+1. Warranty Disclaimers. AS BETWEEN LICENSEE AND APPLITOOLS, EXCEPT AS SET IN SECTION ‎4, THE SOFTWARE IS PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS WITHOUT WARRANTIES OF ANY KIND INCLUDING, WITHOUT LIMITATION, REPRESENTATIONS, WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR INTENDED OR PARTICULAR PURPOSE, TITLE, NON-INFRINGEMENT, THAT THE SOFTWARE WILL MEET LICENSEE'S REQUIREMENTS OR EXPECTATIONS OR WILL ACHIEVE ANY SPECIFIC RESULTS AND THOSE ARISING BY STATUTE OR FROM A COURSE OF DEALING OR USAGE OF TRADE. Applicable law may not allow the exclusion of certain warranties, so to that extent such exclusions may not apply.
+1. High Risk Activities. You acknowledge that the Software is not fault tolerant and is not designed, manufactured, or intended for use or resale as on-line control equipment in hazardous or high risk environments and activities requiring fail-safe performance (such as in the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, direct life support machines and/or devices, or weapons systems) in which the failure of the Software could lead directly to death, personal injury, or severe physical or environmental damage, and You agree not to use or allow the use of the Software or any portion thereof for, or in connection with, any such environment or activity.
+1. Indemnify. You agree that Applitools shall have no liability whatsoever for any use made of the Software by You or any third party. You hereby agree to defend, indemnify and hold harmless Applitools and its affiliates and their respective officers, directors, agents and employees from any and all claims, damages, liabilities, costs, and expenses (including attorney's fees) arising from claims related to Your use of the Software as well as from Your failure to comply with this Agreement.
+1. Limitation of Liability. UNDER NO CIRCUMSTANCES SHALL APPLITOOLS AND/OR ITS AFFILIATES BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, OR FOR ANY LOSS OF DATA, REVENUE, BUSINESS OR REPUTATION, THAT ARISES UNDER OR IN CONNECTION WITH THIS AGREEMENT, OR THAT RESULTS FROM THE USE OF, OR THE INABILITY TO USE, THE SOFTWARE. APPLITOOLS'S TOTAL AGGREGATE LIABILITY FOR ANY AND ALL DIRECT DAMAGES AND LOSSES THAT ARISE UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL NOT IN ANY CIRCUMSTANCE EXCEED THE AMOUNT OF 100.00 (ONE HUNDRED) UNITED STATES DOLLARS. THE FOREGOING LIMITATIONS AND EXCLUSIONS IN THIS SECTION ‎7 SHALL APPLY: (I) EVEN IF APPLITOOLS HAS BEEN ADVISED OF THE POSSIBILITY OF ANY DAMAGES OR LOSSES; (II) EVEN IF ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL PURPOSE; AND (III) REGARDLESS OF THE BASIS OR THEORY OF LIABILITY.
+1. Export Laws. Licensee agrees to comply fully with all U.S., EU, Israeli, and all applicable export laws and regulations to ensure that neither the Software nor any technical data related thereto are exported or re-exported directly or indirectly in violation of, or used for any purposes prohibited by, such laws and regulations. For clarity, and without derogating from Section ‎11 below, in case of any change of any applicable law, policy or regulation, which might affect Applitools' business, Applitools will have the right to terminate this Agreement and the license granted hereunder and the Licensee shall have no claims regarding such termination.
+1. Term and Termination. This Agreement shall continue until terminated as set forth in this section (the "Term"). You may terminate this Agreement at any time by removing the Software from Your system and destroying all copies of the Software and Documentation relating to the Software. Unauthorized copying of the Software or otherwise failing to comply with this Agreement will result in automatic immediate termination of this Agreement and will make available to Applitools legal remedies. Applitools reserves the right to terminate this Agreement and the License at any time and without notice. Upon termination of this Agreement, the License will terminate and You: (i) will cease any and all rights to use the Software, and (ii) will remove the Software from all hard drives, networks and other storage media and destroy all copies of the Software in your possession or under your control. The provisions of Sections ‎2.3, ‎2.4, ‎2.5, ‎6, ‎7, ‎8, ‎9, 10, ‎11 and ‎12 shall survive the termination, expiration or other ending of this Agreement.
+1. Miscellaneous. This Agreement represents the complete agreement concerning the Software between You and Applitools and supersedes all prior agreements and representations between You and Applitools. If any provision of this Agreement is held to be unenforceable for any reason, such provision shall be reformed only to the extent necessary to make it enforceable. Any waiver of any provision of this Agreement will be effective only if in writing and signed by Applitools. This Agreement is personal to You and may not be assigned or transferred for any reason whatsoever without the consent of Applitools and any action or conduct in violation of the foregoing shall be void and without effect. Applitools expressly reserves the right to assign this Agreement and to delegate any of its obligations hereunder. This Agreement are governed by and construed under the laws of the State of Israel, excluding its conflicts of law rules. You expressly agree that the exclusive jurisdiction for any claim or action arising out of or relating to this Agreement shall be the courts located in Tel Aviv, Israel, and You further agree and submit to the exercise of personal jurisdiction of such courts for the purpose of litigating any such claim or action. In any action or proceeding to enforce rights under this Agreement, the prevailing party shall be entitled to recover costs and attorneys' fees.

data/README.md

@@ -0,0 +1,483 @@
+# Applitools Eyes Calabash SDK
+
+[![Gem Version](https://badge.fury.io/rb/eyes_calabash.svg)](https://badge.fury.io/rb/eyes_calabash)
+
+> **⚠️ DEPRECATION NOTICE**: The Calabash framework is no longer actively maintained. Microsoft discontinued their contributions after iOS 11 and Android 8 support, and Visual Studio App Center (which integrated with Calabash) is retiring on March 31, 2025. For mobile visual testing, we strongly recommend using the [Applitools Eyes Appium SDK](../eyes_appium) instead, which provides better support and active development for mobile applications.
+
+The Applitools Eyes Calabash SDK brings visual testing to your Calabash mobile automation. Test native mobile apps on Android and iOS with AI-powered visual validations.
+
+## Table of Contents
+1. [Overview](#overview)
+2. [Installation](#installation)
+3. [Quick Start](#quick-start)
+4. [Key Components](#key-components)
+   - [Eyes Class](#eyes-class)
+   - [Target Class](#target-class)
+   - [Screenshot Management](#screenshot-management)
+   - [Environment Detection](#environment-detection)
+   - [Scrollable Content Handling](#scrollable-content-handling)
+5. [Advanced Usage](#advanced-usage)
+   - [Region-Based Testing](#region-based-testing)
+   - [Full Page Capture](#full-page-capture)
+   - [Ignoring Regions](#ignoring-regions)
+   - [Debug Screenshots](#debug-screenshots)
+   - [Device Pixel Ratio](#device-pixel-ratio)
+6. [Integration with Cucumber](#integration-with-cucumber)
+   - [Step Definitions](#step-definitions)
+   - [Hooks](#hooks)
+   - [RSpec Matchers](#rspec-matchers)
+7. [Platform-Specific Features](#platform-specific-features)
+   - [Android Specifics](#android-specifics)
+   - [iOS Specifics](#ios-specifics)
+8. [Best Practices](#best-practices)
+9. [Common Pitfalls](#common-pitfalls)
+10. [FAQ](#faq)
+
+## Overview
+
+The Applitools Eyes Calabash SDK integrates visual testing with Calabash mobile automation framework. It enables you to capture and validate the visual appearance of your mobile applications on both Android and iOS platforms.
+
+### Key Features
+
+- **Cross-Platform Support**: Works with both Android and iOS applications
+- **Cucumber Integration**: Pre-defined step definitions for easy test writing
+- **Scrollable Content**: Automatic capture of scrollable views
+- **Platform Detection**: Automatically adapts to the target platform
+- **Region-Based Testing**: Focus on specific UI elements
+- **RSpec Matchers**: Custom matchers for visual validation
+- **Debug Support**: Save screenshots for troubleshooting
+
+The SDK handles platform-specific complexities such as screenshot capturing, element detection, and scrollable content stitching, allowing you to focus on writing tests rather than dealing with implementation details.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'eyes_calabash'
+```
+
+Or install it directly:
+
+```bash
+gem install eyes_calabash
+```
+
+### Dependencies
+
+The Eyes Calabash SDK has the following dependencies:
+- `eyes_core` - Core Applitools functionality
+- `calabash-android` or `calabash-cucumber` for iOS tests
+
+> **Note:** The SDK operates with minimal dependencies for better compatibility across different environments.
+
+## Quick Start
+
+Here's a simple example of using Eyes Calabash in a Cucumber feature file:
+
+```gherkin
+Feature: Visual Testing with Calabash
+
+  Scenario: Check the home screen
+    Given I start the app
+    And I use Eyes with app name "My App" and test name "Home Screen Test"
+    Then I check the window with tag "Home Screen"
+    And I close Eyes session
+```
+
+These steps are automatically provided by the SDK. Behind the scenes, they execute the following Ruby code:
+
+```ruby
+require 'eyes_calabash'
+
+# Initialize Eyes
+eyes = Applitools::Calabash::Eyes.new
+eyes.api_key = ENV['APPLITOOLS_API_KEY']
+
+# Start the test
+eyes.open(app_name: 'My App', test_name: 'Home Screen Test')
+
+# Perform a visual validation
+eyes.check('Home Screen', Applitools::Calabash::Target.new)
+
+# Close the test
+eyes.close
+```
+
+## Key Components
+
+### Eyes Class
+
+The `Applitools::Calabash::Eyes` class is the main entry point for the SDK. It provides methods for:
+
+- Starting test sessions with `open`
+- Capturing and comparing screenshots with `check`
+- Ending test sessions with `close`
+- Setting capture options like viewport size, match level, etc.
+
+It automatically detects whether you're running on Android or iOS and adjusts its behavior accordingly.
+
+### Target Class
+
+The `Applitools::Calabash::Target` class defines what to capture during a check operation:
+
+```ruby
+# Check the entire screen
+eyes.check('Home Screen', Applitools::Calabash::Target.new)
+
+# Check with full page capturing (scrolling)
+eyes.check('Scrollable Screen', Applitools::Calabash::Target.new.fully)
+
+# Check a specific element
+element = query("* marked:'username'").first
+calabash_element = Applitools::Calabash::CalabashElement.new(element)
+eyes.check('Username Field', Applitools::Calabash::Target.new.region(calabash_element))
+```
+
+### Screenshot Management
+
+The SDK provides platform-specific screenshot handling:
+
+- Android-specific screenshot capture
+- iOS-specific screenshot capture
+
+These features handle capturing screenshots at the right resolution, accounting for device pixel ratios, and managing debug screenshot captures.
+
+### Environment Detection
+
+The `EnvironmentDetector` class automatically determines whether your test is running on Android or iOS, ensuring the right platform-specific code is used.
+
+### Scrollable Content Handling
+
+One of the most powerful features is the ability to capture scrollable content with the `fully` method:
+
+```ruby
+# Capture a scrollable view by automatically scrolling and stitching
+eyes.check('Full Page', Applitools::Calabash::Target.new.fully)
+```
+
+The SDK includes specialized algorithms for different scrollable containers:
+- Android ScrollView
+- iOS UITableView
+
+## Advanced Usage
+
+### Standardized Screenshot Handling
+
+The SDK offers standardized screenshot handling:
+
+```ruby
+# Initialize Eyes
+eyes = Applitools::Calabash::Eyes.new
+
+# Perform a check with optimized processing
+eyes.check('Home Screen', Applitools::Calabash::Target.new)
+```
+
+Benefits include:
+- Cross-platform consistency
+- Platform-optimized image processing
+- Accurate region identification
+- Efficient execution
+
+> **Note:** The SDK maintains backward compatibility with existing tests.
+
+### Region-Based Testing
+
+You can check specific regions of the screen by using the Calabash query mechanism:
+
+```ruby
+# Find an element using Calabash's query and create a Calabash Element
+element = query("* marked:'submit_button'").first
+calabash_element = Applitools::Calabash::CalabashElement.new(element)
+
+# Check just that element
+eyes.check('Submit Button', Applitools::Calabash::Target.new.region(calabash_element))
+```
+
+### Full Page Capture
+
+For scrollable content, use the `fully` method on the Target class:
+
+```ruby
+# This will automatically scroll and capture the entire content
+eyes.check('Scrollable Content', Applitools::Calabash::Target.new.fully)
+```
+
+The SDK automatically detects common scrollable containers and uses the appropriate scrolling algorithm.
+
+### Ignoring Regions
+
+To ignore specific regions during comparison:
+
+```ruby
+# Find an element to ignore (like a dynamic timestamp) and create a Calabash Element
+timestamp_element = query("* marked:'timestamp'").first
+calabash_timestamp = Applitools::Calabash::CalabashElement.new(timestamp_element)
+
+# Ignore this element during the check
+target = Applitools::Calabash::Target.new.ignore(calabash_timestamp)
+eyes.check('Home Screen', target)
+```
+
+### Debug Screenshots
+
+For troubleshooting, you can enable debug screenshots:
+
+```ruby
+eyes.debug_screenshots = true
+```
+
+This will save additional screenshots during the check process to help diagnose issues.
+
+### Device Pixel Ratio
+
+The SDK automatically handles device pixel ratio (display density) on different devices, but you can also set it manually if needed:
+
+```ruby
+eyes.device_pixel_ratio = 2.0
+```
+
+## Integration with Cucumber
+
+### Step Definitions
+
+The SDK provides pre-defined step definitions for use in your Cucumber features:
+
+```gherkin
+# Initialize Eyes
+Given I use Eyes with app name "My App" and test name "My Test"
+
+# Set the viewport size
+And I set the viewport size to 320x480
+
+# Check operations
+Then I check the window with tag "Home Screen"
+And I check the element "username_field" with tag "Username Field"
+And I check the window fully with tag "Full Page"
+
+# Close Eyes
+And I close Eyes session
+```
+
+### Hooks
+
+You can use Cucumber hooks to set up and tear down Eyes sessions:
+
+```ruby
+# env.rb or hooks.rb
+Before do |scenario|
+  @eyes = Applitools::Calabash::Eyes.new
+  @eyes.api_key = ENV['APPLITOOLS_API_KEY']
+end
+
+After do |scenario|
+  @eyes.abort_if_not_closed
+end
+```
+
+### RSpec Matchers
+
+The SDK includes RSpec matchers for visual validation:
+
+```ruby
+# Match a specific element against the baseline
+expect(element).to visually_match('Username Field')
+
+# Match the entire screen
+expect(screen).to visually_match('Home Screen')
+```
+
+## Platform-Specific Features
+
+### Android Specifics
+
+The SDK includes specialized support for Android:
+
+- Automatic handling of Android's activity hierarchy
+- Support for ScrollView and ListView scrollable elements
+- Android-specific step definitions in Cucumber
+
+### iOS Specifics
+
+For iOS, the SDK provides:
+
+- Support for UITableView and UIScrollView scrollable elements
+- Handling of iOS status bar and navigation bar
+- iOS-specific step definitions in Cucumber
+
+## Best Practices
+
+1. **API Key Management**: Always use environment variables for your API key
+   ```ruby
+   eyes.api_key = ENV['APPLITOOLS_API_KEY']
+   ```
+
+2. **Error Handling**: Always include proper cleanup in Cucumber hooks
+   ```ruby
+   After do |scenario|
+     @eyes.abort_if_not_closed
+   end
+   ```
+
+3. **Meaningful Test Names**: Use descriptive names for your tests and checks
+   ```ruby
+   eyes.open(app_name: 'Banking App', test_name: 'Login Flow - Android')
+   eyes.check('Login Form', target)
+   ```
+
+4. **Batch Tests**: Group related tests in a batch
+   ```ruby
+   batch = Applitools::BatchInfo.new('Login Flow Tests')
+   eyes.batch = batch
+   ```
+
+5. **Scrollable Content**: When testing scrollable content, use the `fully` method
+   ```ruby
+   eyes.check('Feed Screen', Applitools::Calabash::Target.new.fully)
+   ```
+
+6. **Stable Identifiers**: Use stable identifiers for elements in your application to ensure consistent testing
+   ```ruby
+   # Good - uses a stable identifier
+   element = query("* marked:'login_button'").first
+   
+   # Avoid - potentially unstable
+   element = query("button index:0").first
+   ```
+
+7. **Viewport Configuration**: Set a consistent viewport size for tests
+   ```ruby
+   eyes.open(
+     app_name: 'My App',
+     test_name: 'My Test',
+     viewport_size: { width: 375, height: 667 }
+   )
+   ```
+
+## Common Pitfalls
+
+1. **Missing API Key**: Forgetting to set the API key
+   ```ruby
+   # This must be set before calling eyes.open
+   eyes.api_key = ENV['APPLITOOLS_API_KEY']
+   ```
+
+2. **Resource Cleanup**: Failing to close Eyes or abort if an exception occurs
+   ```ruby
+   # Always include in After hook or ensure block
+   eyes.abort_if_not_closed
+   ```
+
+3. **Element Not Found**: Trying to check elements that don't exist
+   ```ruby
+   # Always check that your queries return results
+   elements = query("* marked:'login_button'")
+   if elements.any?
+     calabash_element = Applitools::Calabash::CalabashElement.new(elements.first)
+     eyes.check('Login Button', Applitools::Calabash::Target.new.region(calabash_element))
+   else
+     puts "Warning: Login button not found"
+   end
+   ```
+
+4. **Scrollable Content Issues**: Not waiting for scrolling to complete
+   ```ruby
+   # Always ensure animations have completed before visual checks
+   wait_for_none_animating
+   eyes.check('Scrollable Content', Applitools::Calabash::Target.new.fully)
+   ```
+
+5. **Device Orientation**: Inconsistent device orientation between tests
+   ```ruby
+   # Set a consistent orientation before visual testing
+   rotate_device("portrait")
+   eyes.check('Home Screen', Applitools::Calabash::Target.new)
+   ```
+
+6. **Custom Screenshot Handling**: Working with screenshots
+   ```ruby
+   # Recommended: Use public API methods for screenshot handling
+   eyes.check('Home Screen', Applitools::Calabash::Target.new)
+
+   # Avoid: Directly accessing internal implementation details
+   # Use the public API for more stable behavior
+   ```
+
+## FAQ
+
+### How do I set my API key?
+
+```ruby
+eyes.api_key = ENV['APPLITOOLS_API_KEY']
+```
+
+It's recommended to use environment variables rather than hardcoding API keys.
+
+### Can I use Eyes Calabash with both Android and iOS?
+
+Yes, the SDK automatically detects which platform you're running on and adjusts its behavior accordingly. The same code works for both platforms.
+
+### How do I handle dynamic content that changes between test runs?
+
+You can use the ignore regions feature:
+
+```ruby
+# Find the dynamic element
+dynamic_element = query("* marked:'timestamp'").first
+calabash_dynamic = Applitools::Calabash::CalabashElement.new(dynamic_element)
+
+# Ignore this element during checks
+target = Applitools::Calabash::Target.new.ignore(calabash_dynamic)
+eyes.check('Home Screen', target)
+```
+
+### How do I check scrollable content like a feed or a long form?
+
+Use the `fully` method:
+
+```ruby
+eyes.check('Feed Screen', Applitools::Calabash::Target.new.fully)
+```
+
+This will automatically scroll through the content and stitch the screenshots together.
+
+### What if my app has custom scrollable containers?
+
+The SDK supports common containers like Android ScrollView and iOS UITableView. For custom containers, you may need to implement your own scrolling in Calabash before visual checks.
+
+### How do I debug visual test failures?
+
+1. Enable debug screenshots:
+   ```ruby
+   eyes.debug_screenshots = true
+   ```
+
+2. Check the Applitools dashboard for visual differences.
+
+3. Use this code to log more information:
+   ```ruby
+   Applitools::EyesLogger.log_handler = Logger.new(STDOUT)
+   Applitools::EyesLogger.log_handler.level = Logger::DEBUG
+   ```
+
+### How do I handle different device screen sizes and resolutions?
+
+The SDK automatically handles device pixel ratios. For handling different screen sizes, you can use baseline branches:
+
+```ruby
+# Set a branch name based on the device type
+eyes.branch_name = "iPhone8"
+# or
+eyes.branch_name = "SamsungGalaxyS9"
+```
+
+### Can I use Eyes Calabash with Calabash-Android and Calabash-iOS?
+
+Yes, the SDK is designed to work with both platforms and will automatically detect which one you're using.
+
+## License
+
+This SDK is distributed under the Applitools SDK License Agreement. See the [LICENSE](LICENSE) file for more details.
+
+**Important:** This SDK may be used solely for your personal, non-commercial purposes. For commercial use, please contact your Applitools representative or visit [applitools.com](https://applitools.com) to obtain a commercial license.

data/eyes_calabash.gemspec

@@ -10,17 +10,25 @@ Gem::Specification.new do |spec|
   spec.version       = Applitools::EyesCalabash::VERSION
   spec.authors       = ['Applitools Team']
   spec.email         = ['team@applitools.com']
-  spec.description   = 'Provides SDK for writing Applitools Calabash tests.'
-  spec.summary       = 'Applitools Ruby Calabash SDK'
+  spec.description   = 'Provides SDK for writing Applitools Calabash tests. DEPRECATED: Calabash is no longer actively maintained. Please use eyes_appium for mobile testing.'
+  spec.summary       = 'Applitools Ruby Calabash SDK (DEPRECATED - use eyes_appium instead)'
   spec.homepage      = 'https://www.applitools.com'
-  spec.license       = 'Applitools'
+  spec.license       = 'Proprietary'
 
   spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
+  spec.post_install_message = <<-MESSAGE
+WARNING: eyes_calabash is deprecated!
+The Calabash framework is no longer actively maintained by Microsoft.
+Visual Studio App Center (which integrated with Calabash) is retiring on March 31, 2025.
+Please migrate to eyes_appium for mobile visual testing, which provides better support and active development.
+MESSAGE
 
   spec.files         = `git ls-files lib/applitools/calabash`.split($RS) + [
     'lib/eyes_calabash.rb',
     'lib/applitools/calabash_steps.rb',
     'lib/applitools/eyes_calabash/version.rb',
+    'LICENSE',
+    'README.md',
     'CHANGELOG.md',
     'eyes_calabash.gemspec',
     'Rakefile',
@@ -31,5 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'cucumber'
   spec.add_dependency 'file_utils'
   spec.add_dependency 'rspec-expectations'
-  spec.add_dependency 'eyes_core', "= 6.7.0"
+  spec.add_dependency 'eyes_core', "= 6.7.2"
 end

data/lib/applitools/calabash/eyes_calabash_screenshot.rb

@@ -1,80 +1,14 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
+
+# Empty placeholder for backward compatibility
+# This class has been removed as its functionality is now handled by the Universal SDK
+
+require 'applitools/core/eyes_screenshot'
 
 module Applitools
   module Calabash
+    # Empty placeholder class to maintain backward compatibility
     class EyesCalabashScreenshot < Applitools::EyesScreenshot
-      SCREENSHOT_AS_IS = Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is].freeze
-      CONTEXT_RELATIVE = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative].freeze
-      DRIVER = 'DRIVER'.freeze
-
-      attr_reader :scale_factor
-
-      def initialize(image, options = {})
-        super image
-        @scale_factor = options[:scale_factor] || 1
-        # 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 sub_screenshot(region, coordinates_type, throw_if_clipped = false, force_nil_if_clipped = false)
-        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))
-          return nil if force_nil_if_clipped
-          raise Applitools::OutOfBoundsException, "Region #{sub_screen_region} (#{coordinates_type}) is out of " \
-          " screenshot bounds #{bounds}"
-        end
-
-        sub_screenshot_image = Applitools::Screenshot.from_any_image(
-          image.crop(
-            sub_screen_region.left, sub_screen_region.top, sub_screen_region.width, sub_screen_region.height
-          ).to_datastream.to_blob
-        )
-
-        self.class.new sub_screenshot_image, scale_factor: scale_factor
-      end
-
-      def location_in_screenshot(_location, _coordinates_type)
-        raise(
-          Applitools::EyesError,
-          'Call to :convert_location is prohibited for Applitools::Calabash::EyesCalabashScreenshot'
-        )
-      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
-        intersected_region
-      end
-
-      def convert_location(_location, _from, _to)
-        raise(
-          Applitools::EyesError,
-          'Call to :convert_location is prohibited for Applitools::Calabash::EyesCalabashScreenshot'
-        )
-      end
-
-      abstract_method :convert_region_location, false
-
-      def scale_it!
-        width = (image.width.to_f / scale_factor).to_i
-        height = (image.height.to_f / scale_factor).to_i
-        image.resample_bicubic!(width, height)
-        self
-      end
-
-      private
-
-      def bounds
-        @bounds ||= Applitools::Region.new(0, 0, image.width, image.height)
-      end
     end
   end
-end
+end

data/lib/applitools/eyes_calabash/version.rb

@@ -2,6 +2,6 @@
 
 module Applitools
   module EyesCalabash
-    VERSION = '6.4.2'.freeze
+    VERSION = '6.4.4'.freeze
   end
 end

data/lib/eyes_calabash.rb

@@ -14,6 +14,7 @@ module Applitools
     end
 
     def self.require_environment(requirement, env)
+      load_dir = File.dirname(File.expand_path(__FILE__))
       dirname = File.dirname(requirement)
       filename = File.basename(requirement)
       filename += '.rb' unless /^.*\.rb$/ =~ filename

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_calabash
 version: !ruby/object:Gem::Version
-  version: 6.4.2
+  version: 6.4.4
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-17 00:00:00.000000000 Z
+date: 2025-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -58,15 +58,16 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.7.0
+        version: 6.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.7.0
-description: Provides SDK for writing Applitools Calabash tests.
+        version: 6.7.2
+description: 'Provides SDK for writing Applitools Calabash tests. DEPRECATED: Calabash
+  is no longer actively maintained. Please use eyes_appium for mobile testing.'
 email:
 - team@applitools.com
 executables: []
@@ -74,6 +75,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE
+- README.md
 - Rakefile
 - eyes_calabash.gemspec
 - lib/applitools/calabash/calabash_element.rb
@@ -105,10 +108,14 @@ files:
 - lib/eyes_calabash.rb
 homepage: https://www.applitools.com
 licenses:
-- Applitools
+- Proprietary
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message: |
+  WARNING: eyes_calabash is deprecated!
+  The Calabash framework is no longer actively maintained by Microsoft.
+  Visual Studio App Center (which integrated with Calabash) is retiring on March 31, 2025.
+  Please migrate to eyes_appium for mobile visual testing, which provides better support and active development.
 rdoc_options: []
 require_paths:
 - lib
@@ -126,5 +133,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Applitools Ruby Calabash SDK
+summary: Applitools Ruby Calabash SDK (DEPRECATED - use eyes_appium instead)
 test_files: []