automation_helpers 5.2.0 → 7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75259b6680a81c12797e7e149e8ddf63e4c5e0a53e9abce49209eb1872797eff
-  data.tar.gz: 733f42580acc3cb78d8a4106f492d07f5f9354247a63eb05261be7ae5df1bf56
+  metadata.gz: de65c70c0d33f66469440532cf8a4d49840e8b4e48cc653dca9fc2d20280c9ee
+  data.tar.gz: b79dfae24f4df076559ddb46270b32ef2ab5168f3e12b1f3565a060d5673fc3a
 SHA512:
-  metadata.gz: 1e756396a0eca7e1dfba394c511d8b2885fe4afa1244e51cef033019b4e920e24ebc64e3ad7469be499d887482a0e074ab910eb3f44b423ab6da9d0350ae318a
-  data.tar.gz: 6d325dc0137c51061c5ff0ff14e4394a6eec54603d00122fa1a153e7084e911e0908245eae8ee215f93be7558e9ed6563f9008e70d93efd5e9eeb8af27af73e4
+  metadata.gz: 0febf6c2eaba22e6bda884a435388e57967aea3f8556f68a7f445be96a1a9534ee980cf4e80fc0731694185e716f9734c714b9d6747f31e516ae2236446e196e
+  data.tar.gz: eda61bc6fb061175fa91d996661748143fa0ae962257b1bc9ead36827e0a469b75285bf77257c48e8f69e1779c01dee0776276acac51496e464f9a9b2cca0557

data/README.md

@@ -27,7 +27,7 @@ $ bundle
 
 ## Usage
 
-Either require all of the extensions required, or require individual bits and pieces
+Either require all the extensions required, or require the individual bits and pieces you need
 
 ```shell
 # Require all of the drivers/patches/extensions code
@@ -57,5 +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
+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

@@ -25,9 +25,9 @@ module AutomationHelpers
         #   - :session_name (String)             -> The session name to be stored on browserstack servers
         #   - :browserstack_debug_mode (Boolean) -> Set this to true to run in browserstack debug mode (Note this runs slower!)
         #   - :config (String)                   -> This is an underscore separated key that distils the granular running information
-        #     i.e. Windows_7_86 means run on Windows Operating System, OS Version 7, Browser Version 86
+        #     i.e. Windows_7_115 means run on Windows Operating System, OS Version 7, Browser Version 115
         #     i.e. OSX_Mojave_12 means run on Mac Operating System, OS Version Mojave, Browser Version 12
-        #     i.e. Windows_10_92 means run on Windows Operating System, OS Version 10, Browser Version 92
+        #     i.e. Windows_10_113 means run on Windows Operating System, OS Version 10, Browser Version 113
         #   - :username (String)                 -> The username for Browserstack
         #   - :api_key (String)                  -> The api key for Browserstack
         # - **device_options** (optional)        - A Hash of all device specific options that can customise your device
@@ -62,7 +62,7 @@ module AutomationHelpers
             ::Faraday::Utils.deep_merge(
               # Browserstack Capabilities and General Capabilities are at different levels, so we merge first
               browserstack_capabilities.merge(browser_version_capability),
-              # Then we deep merge with anything specifically passed into the driver registration (as these can be nested)
+              # Then we "deep-merge" with anything specifically passed into the driver registration (Which can be nested)
               browser_specific_capabilities.as_json
             )
           )
@@ -89,7 +89,7 @@ module AutomationHelpers
           {
             'bstack:options' => {
               'local' => 'false',
-              'seleniumVersion' => '4.15.0',
+              'seleniumVersion' => '4.39.0',
               'consoleLogs' => 'verbose',
               'networkLogs' => 'true',
               'resolution' => '1920x1080'

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

@@ -61,9 +61,8 @@ module AutomationHelpers
               'browserName' => 'internet explorer',
               'bstack:options' => {
                 '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' => '4.14.0.0',
+                  # This appears to be the last maintained version and we will remove IE support in V8 of helpers
+                  'driver' => '4.16.0.0',
                   'arch' => 'x32'
                 }
               }
@@ -82,22 +81,21 @@ module AutomationHelpers
 
           def android_appium_version(android_version)
             case android_version.to_f
-            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)."
+            when 16..; then '3.1.0'
+            when 14..; then '2.19.0'
+            when 12..; then '2.15.0'
+            when 10..; then '2.0.1'
+            else raise ArgumentError, "Your Android Version is too low. Please don't use lower than Android Quince (10)."
             end
           end
 
           def ios_appium_version(ios_version)
             case ios_version.to_f
-            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."
+            when 17..; then '3.1.0'
+            when 16..; then '2.15.0'
+            when 15..; then '2.4.1'
+            when 14..; then '2.0.1'
+            else raise ArgumentError, "Your iOS Version is too low. Please don't use lower than iOS 14."
             end
           end
         end

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

@@ -39,8 +39,7 @@ module AutomationHelpers
         private
 
         # This is required to make local drivers work with Safari TP
-        # This is required in V13+ of Safari as the driver there is notoriously flaky
-        # Safari V11/V12 is unsupported
+        # This is required for v13+ of Safari as the old(er), drivers are notoriously flaky
         def service
           return unless safari?
 

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

@@ -6,8 +6,7 @@ module AutomationHelpers
   module Drivers
     module V4
       #
-      # The Options object that will be used to instantiate whatever driver you
-      # are configuring
+      # The Options object for the relevant browser whose driver you are configuring
       #
       # #### Initial setup options
       #

data/lib/automation_helpers/drivers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'automation_helpers/logger'
-
 require 'automation_helpers/drivers/browserstack'
 require 'automation_helpers/drivers/local'
 require 'automation_helpers/drivers/remote'

data/lib/automation_helpers/extensions/capybara/node/element.rb

@@ -8,14 +8,14 @@ module Capybara
     class Element
       # @return [Integer]
       #
-      # The Left-Most pixel's horizontal position in the DOM (From element.rect)
+      # The Left-Most pixel's horizontal position in the DOM (From `element.rect`)
       def horizontal_position
         native.rect.x.to_i
       end
 
       # @return [Integer]
       #
-      # The Left-Most pixel's vertical position in the DOM (From element.rect)
+      # The Left-Most pixel's vertical position in the DOM (From `element.rect`)
       def vertical_position
         native.rect.y.to_i
       end

data/lib/automation_helpers/extensions/cucumber/core/test/case.rb

@@ -9,14 +9,14 @@ module Cucumber
       class Case
         # @return [String]
         #
-        # The file name of the feature being ran (Without the .feature extension)
+        # The file name of the feature that is running (Without the .feature extension)
         def feature_file_name
           feature_file_path.split('/').last&.split('.')&.first.to_s
         end
 
         # @return [String]
         #
-        # The fully qualified location of the feature being ran
+        # The fully qualified location (filepath), of the feature file that is running
         def feature_file_path
           location.to_s
         end

data/lib/automation_helpers/patches/base.rb

@@ -13,10 +13,8 @@ module AutomationHelpers
         raise 'This is no longer supported' if prevent_usage?
 
         Kernel.warn('This is now deprecated and should not be used') if deprecate?
-        AutomationHelpers.logger.info("Adding patch: #{self.class}")
-        AutomationHelpers.logger.info(description)
+        $stdout.puts("Adding patch: #{self.class}\n#{description}")
         perform
-        AutomationHelpers.logger.info('Patch successfully added.')
       end
 
       private

data/lib/automation_helpers/patches/{capybara.rb → capybara_safari.rb}

@@ -5,7 +5,7 @@ module AutomationHelpers
     #
     # Fix the issue where the `#text` method doesn't normalize whitespace (Only the matchers do)
     #
-    class Capybara < Base
+    class CapybaraSafari < Base
       private
 
       def description
@@ -19,6 +19,14 @@ module AutomationHelpers
       def perform
         ::Capybara::Node::Element.prepend SafariTextPatch
       end
+
+      def deprecate?
+        true
+      end
+
+      def prevent_usage_date
+        Time.new(2027, 3, 30)
+      end
     end
 
     #

data/lib/automation_helpers/patches/capybara_window.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AutomationHelpers
+  module Patches
+    #
+    # Fix the issue where you cannot close the first window in the handle array with `#close_window`
+    #
+    class CapybaraWindow < Base
+      private
+
+      def description
+        <<~DESCRIPTION
+          The method `#close_window` in Capybara::Selenium::Driver (Base), does not permit closing of the first window in the handle array
+
+          This was introduced over a decade ago and given the propensity for new windows to be opened in the course of testing,
+          this is a significant issue for users of Capybara and Selenium.
+
+          See https://github.com/teamcapybara/capybara/issues/2834 for more details.
+        DESCRIPTION
+      end
+
+      def perform
+        ::Capybara::Selenium::Driver.prepend WindowPatch
+      end
+    end
+
+    #
+    # @api private
+    #
+    module WindowPatch
+      def close_window(handle)
+        within_given_window(handle) do
+          browser.close
+        end
+      end
+    end
+  end
+end

data/lib/automation_helpers/patches/selenium_logger.rb

@@ -31,8 +31,8 @@ module AutomationHelpers
         DESCRIPTION
       end
 
-      def deprecation_notice_date
-        Time.new(2025, 12, 3)
+      def deprecate?
+        true
       end
 
       def prevent_usage_date

data/lib/automation_helpers/patches.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'automation_helpers/logger'
-
 require 'automation_helpers/patches/base'
-require 'automation_helpers/patches/capybara'
+require 'automation_helpers/patches/capybara_safari'
+require 'automation_helpers/patches/capybara_window'
 require 'automation_helpers/patches/selenium_logger'

data/lib/automation_helpers/version.rb

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

data/lib/automation_helpers.rb

@@ -2,7 +2,6 @@
 
 require 'automation_helpers/drivers'
 require 'automation_helpers/extensions'
-require 'automation_helpers/logger'
 require 'automation_helpers/patches'
 require 'automation_helpers/version'
 
@@ -10,33 +9,5 @@ require 'automation_helpers/version'
 module AutomationHelpers
   class << self
     attr_accessor :chrome_log_path
-
-    def configure
-      yield self
-    end
-
-    # The Automation Helpers logger object - This is called automatically in several
-    # locations and will log messages according to the normal Ruby protocol
-    #
-    # This logger object can also be used to manually log messages
-    #
-    # To Manually log a message
-    #   AutomationHelpers.logger.info('Information')
-    #   AutomationHelpers.logger.debug('Input debug message')
-    #
-    # By default the logger will output all messages to $stdout, but can be
-    # altered to log to a file or another IO location by calling `.log_path=`
-    def logger
-      @logger ||= Logger.create
-    end
-
-    # This writer method allows you to configure where you want the output of
-    # the automation_helpers logs to go (Default is $stdout)
-    #
-    # example: AutomationHelpers.log_path = 'automation_helpers.log' would save all
-    # log messages to `./automation_helpers.log`
-    def log_path=(logdev)
-      logger.reopen(logdev)
-    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: automation_helpers
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: '7.0'
 platform: ruby
 authors:
 - Luke Hill
 - Marcelo Nicolosi Santos
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -40,7 +40,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -85,56 +85,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.0
+        version: 1.85.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.0
+        version: 1.85.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.12'
+        version: '4.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.12'
+        version: '4.18'
 description: Automation Patches / Extensions that allow you to extend your Ruby-based
   testing frameworks
 email:
@@ -163,10 +163,10 @@ files:
 - lib/automation_helpers/extensions/cucumber/core/test/case.rb
 - lib/automation_helpers/extensions/selenium/webdriver/logs.rb
 - lib/automation_helpers/extensions/string.rb
-- lib/automation_helpers/logger.rb
 - lib/automation_helpers/patches.rb
 - lib/automation_helpers/patches/base.rb
-- lib/automation_helpers/patches/capybara.rb
+- lib/automation_helpers/patches/capybara_safari.rb
+- lib/automation_helpers/patches/capybara_window.rb
 - lib/automation_helpers/patches/selenium_logger.rb
 - lib/automation_helpers/version.rb
 homepage: https://www.github.com/site-prism/automation_helpers
@@ -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
@@ -184,15 +184,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.3
+      version: 3.2.8
 requirements: []
 rubygems_version: 3.5.22
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Automation Helpers - Avoid writing the most common things in Ruby Automation
 test_files: []

data/lib/automation_helpers/logger.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-module AutomationHelpers
-  #
-  # @api private
-  #
-  class Logger
-    #
-    # Generate the Logger used in the gem
-    #
-    def self.create(output = $stdout)
-      logger = ::Logger.new(output)
-      logger.progname = 'Automation Helpers'
-      logger.level = :INFO
-      logger.formatter = proc do |severity, time, progname, msg|
-        "#{time.strftime('%F %T')} - #{severity} - #{progname} - #{msg}\n"
-      end
-
-      logger
-    end
-  end
-end