automation_helpers 5.0.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c1bb38f10286b2d053d364594e05d3e6eacfad9ef2c72facfcdf6f4aad4e992
-  data.tar.gz: 316f98bb817bd51ff66a62c5131ae8ad8fccd88a50eb3c2576e6eb5b38e4562e
+  metadata.gz: 75259b6680a81c12797e7e149e8ddf63e4c5e0a53e9abce49209eb1872797eff
+  data.tar.gz: 733f42580acc3cb78d8a4106f492d07f5f9354247a63eb05261be7ae5df1bf56
 SHA512:
-  metadata.gz: 49ef1152fa3ab209a72b23e6caa5c94576cf55f7037d930b4df333c0b5286377962a098c35613eb1e6792c516000f49bf2d50aa3e51ee361b2d88f1922ef3b87
-  data.tar.gz: 57c121b3976d5d694a6a4027048afa06fefb1930f987ee524244c90222874e4ab2349f5296c5a8a80e50135bdf176de10c960dd46dd7fdb37e08be668a8225b8
+  metadata.gz: 1e756396a0eca7e1dfba394c511d8b2885fe4afa1244e51cef033019b4e920e24ebc64e3ad7469be499d887482a0e074ab910eb3f44b423ab6da9d0350ae318a
+  data.tar.gz: 6d325dc0137c51061c5ff0ff14e4394a6eec54603d00122fa1a153e7084e911e0908245eae8ee215f93be7558e9ed6563f9008e70d93efd5e9eeb8af27af73e4

data/LICENSE.txt

@@ -1,13 +1,25 @@
+BSD 3-Clause License
+
 Copyright (c) 2020 - The SitePrism team & Marcelo Nicolosi Santos
 
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided
+that the following conditions are met:
 
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions of source code must retain the above copyright notice, this list of conditions
+and the following disclaimer.
 
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
+the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+Neither the name of the copyright holder nor the names of its contributors may be used to endorse or
+promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -57,4 +57,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/site-p
 
 ## Verbose Documentation
 
-This will come in time. Meanwhile if you check the gem code most methods are documented. Also check the specs
+This will come in time. Meanwhile if you check the gem code most methods are
+documented. Also check the specs for more detailed information

data/lib/automation_helpers/drivers/v4/browserstack.rb

@@ -14,8 +14,7 @@ module AutomationHelpers
       # This requires a series of pre-set values to be passed in
       #
       class Browserstack
-        attr_reader :browser, :browserstack_options, :device_options
-        private :browser, :browserstack_options, :device_options
+        attr_reader :browser, :browserstack_options, :device_options, :options
 
         # #### Initial setup options
         #
@@ -31,11 +30,15 @@ module AutomationHelpers
         #     i.e. Windows_10_92 means run on Windows Operating System, OS Version 10, Browser Version 92
         #   - :username (String)                 -> The username for Browserstack
         #   - :api_key (String)                  -> The api key for Browserstack
-        #
-        def initialize(browser, browserstack_options, device_options = {})
+        # - **device_options** (optional)        - A Hash of all device specific options that can customise your device
+        #   - :device_name (String)              -> The name of your device
+        #   - :os_version (String)               -> The operating system for your device
+        # - **options** (optional) -> You can instantiate an Options payload that can be used when registering your driver
+        def initialize(browser, browserstack_options, device_options = {}, options = Options.for(browser))
           @browser = browser
           @browserstack_options = browserstack_options
           @device_options = device_options
+          @options = options
         end
 
         # @return [Nil]
@@ -86,7 +89,7 @@ module AutomationHelpers
           {
             'bstack:options' => {
               'local' => 'false',
-              'seleniumVersion' => '4.0.0-alpha-6',
+              'seleniumVersion' => '4.15.0',
               'consoleLogs' => 'verbose',
               'networkLogs' => 'true',
               'resolution' => '1920x1080'
@@ -104,10 +107,6 @@ module AutomationHelpers
           { 'browserVersion' => browser_version }
         end
 
-        def options
-          Options.for(browser)
-        end
-
         def browserstack_hub_url
           "https://#{browserstack_options[:username]}:#{browserstack_options[:api_key]}@hub-cloud.browserstack.com/wd/hub"
         end

data/lib/automation_helpers/drivers/v4/capabilities.rb

@@ -63,7 +63,7 @@ module AutomationHelpers
                 'ie' => {
                   # This is a minor hack until the IEDriver catches up and releases a V4 compliant copy
                   # It is confirmed to be compliant with V4 selenium jars e.t.c.
-                  'driver' => '3.141.59',
+                  'driver' => '4.14.0.0',
                   'arch' => 'x32'
                 }
               }
@@ -82,7 +82,8 @@ module AutomationHelpers
 
           def android_appium_version(android_version)
             case android_version.to_f
-            when 12..; then '1.22.0'
+            when 14..; then '2.0.0'
+            when 12..; then '1.22.3'
             when 10..; then '1.21.0'
             when 9..;  then '1.20.2'
             else raise ArgumentError, "Your Android Version is too low. Please don't use lower than Android Pie (9)."
@@ -91,7 +92,9 @@ module AutomationHelpers
 
           def ios_appium_version(ios_version)
             case ios_version.to_f
-            when 14..; then '1.22.0'
+            when 16..; then '2.0.0'
+            when 15..; then '1.22.3'
+            when 14..; then '1.22.2'
             when 13..; then '1.21.0'
             when 12..; then '1.20.2'
             else raise ArgumentError, "Your iOS Version is too low. Please don't use lower than iOS 12."

data/lib/automation_helpers/drivers/v4/local.rb

@@ -11,15 +11,15 @@ module AutomationHelpers
       # The Local Driver that will spin up and run on your machine (Without connecting to any grid)
       #
       class Local
-        attr_reader :browser
-        private :browser
+        attr_reader :browser, :options
 
         # #### Initial setup options
         #
         # - **browser** (required) - When instantiating, the first argument must be the symbol that represents what browser to use
-        #
-        def initialize(browser)
+        # - **options** (optional) -> You can instantiate an Options payload that can be used when registering your driver
+        def initialize(browser, options = Options.for(browser))
           @browser = browser
+          @options = options
         end
 
         # @return [Nil]
@@ -48,10 +48,6 @@ module AutomationHelpers
           ::Selenium::WebDriver::Service.safari(args: ['--diagnose'])
         end
 
-        def options
-          Options.for(browser)
-        end
-
         def safari?
           browser == :safari
         end

data/lib/automation_helpers/drivers/v4/options.rb

@@ -48,11 +48,7 @@ module AutomationHelpers
 
           # Constantly fire mouseOver events on click actions (Should help mitigate flaky clicks)
           def internet_explorer_options
-            ::Selenium::WebDriver::IE::Options.new(persistent_hover: true).tap do |opts|
-              # This can be removed once we migrate past Se4 proper (As the space version name is present there)
-              AutomationHelpers.logger.info('Removing `browser_name` key from options payload.')
-              opts.options.delete(:browser_name)
-            end
+            ::Selenium::WebDriver::IE::Options.new(persistent_hover: true)
           end
 
           def headless?

data/lib/automation_helpers/drivers/v4/remote.rb

@@ -11,16 +11,18 @@ module AutomationHelpers
       # This expects the grid to be live **and** accepting node requests
       #
       class Remote
-        attr_reader :browser
-        private :browser
+        attr_reader :browser, :options
 
         # #### Initial setup options
         #
         # - **browser** (required) - When instantiating, the first argument must be the symbol that represents what browser to use
+        # - **options** (optional) -> You can instantiate an Options payload that can be used when registering your driver
+        #
         # - **ENV["HUB_URL"]** (required) - The environment variable HUB_URL must be set to the actively running dockerized grid
         #   (By default this should be +http://hub:4444/wd/hub+)
-        def initialize(browser)
+        def initialize(browser, options = Options.for(browser))
           @browser = browser
+          @options = options
         end
 
         # @return [Nil]
@@ -45,12 +47,8 @@ module AutomationHelpers
           Capabilities.for(browser)
         end
 
-        def options
-          Options.for(browser)
-        end
-
         def hub_url
-          ENV.fetch('HUB_URL')
+          ENV.fetch('HUB_URL') { raise ArgumentError, 'Please set HUB_URL env key for your grid' }
         end
 
         def supported_browser?

data/lib/automation_helpers/patches/capybara.rb

@@ -26,7 +26,7 @@ module AutomationHelpers
     #
     module SafariTextPatch
       def text(type = nil, normalize_ws: ::Capybara.default_normalize_ws)
-        super(type, normalize_ws: normalize_ws)
+        super
       end
     end
   end

data/lib/automation_helpers/patches/selenium_logger.rb

@@ -11,6 +11,17 @@ module AutomationHelpers
 
       def description
         <<~DESCRIPTION
+          UPDATE: 3/12/2024
+          This patch should in theory be redundant now the root cause has been identified as a processing
+          debugger fault in RubyMine. Since Ruby 3.2 this should no longer be an issue providing you are
+          using an "up-to-date" RubyMine. I personally haven't encountered this issue for a couple of years
+
+          As such this patch is now considered a deprecated patch with a 1 year TTL, at which point we'll then
+          consider it for removal from the gem proper
+
+          ~~~~~~~~~~~~~~~~~~~~~
+
+          ORIGINAL ISSUE:
           When using the Selenium Logger that is set to pipe to a file, the Net::HTTP adapter (default),
           can return unencoded binary (confusingly called ASCII-8BIT in Ruby).
           Consequently we set the logger to binmode so it doesn't try to encode the data - this would always
@@ -20,6 +31,14 @@ module AutomationHelpers
         DESCRIPTION
       end
 
+      def deprecation_notice_date
+        Time.new(2025, 12, 3)
+      end
+
+      def prevent_usage_date
+        Time.new(2026, 12, 3)
+      end
+
       def perform
         ::Selenium::WebDriver.logger.io.binmode
       end

data/lib/automation_helpers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AutomationHelpers
-  VERSION = '5.0.1'
+  VERSION = '5.2.0'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: automation_helpers
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Luke Hill
 - Marcelo Nicolosi Santos
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -17,7 +17,7 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.30'
+        version: '3.35'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.30'
+        version: '3.35'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,56 +85,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.2
+        version: 1.68.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.2
+        version: 1.68.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.22.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.22.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.25.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.25.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.12'
 description: Automation Patches / Extensions that allow you to extend your Ruby-based
   testing frameworks
 email:
@@ -176,7 +176,7 @@ metadata:
   homepage_uri: https://www.github.com/site-prism/automation_helpers
   source_code_uri: https://www.github.com/site-prism/automation_helpers
   changelog_uri: https://www.github.com/site-prism/automation_helpers/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,10 +189,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.3
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Automation Helpers - Avoid writing the most common things in Ruby Automation
 test_files: []