automation_helpers 4.0.1 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b76d24db41e2d9211d253fe3985f632bf3ac56c6f2053a0932622eff9fab3dd
-  data.tar.gz: 794c1192df35048a0e7f8d06b0a4043a3f7a207ad5ed00cf4039ebcd389c8219
+  metadata.gz: 154b3a0f5fc399e0c379455a963dd13d3094be200957ecff1740dccfdd75418c
+  data.tar.gz: ba4e03604da108f8a68661f3879f69180c4f35b27796cc41660a4ee51d25f47f
 SHA512:
-  metadata.gz: 5eda215013852802b916764ff564844bb336f39d363fa241de875c1199f07e09b46860273741fead783abb068fefd8e734e10cd004c12720465b3719109313c5
-  data.tar.gz: f875ff9b0c007eb72f3282222ff9fff1276561c82d3f0061bb0644b8ded894e6b8d466e127b26094379030300f080a11577e8baf96de58c3b0bf07fa9c03b0e8
+  metadata.gz: 7fc83981d84eabd3887d096b0ab415598aa5243b9027b6b0a8e1de2fb76520346db275fd9f51ea10642946646ae0319f214ab30af76fcc218fbe56c629c17165
+  data.tar.gz: 6cf8cf6feb9820e8b781d5830557d0d4aaf2ad1e5d370b2db1e0fb7ef8198a5fe012f67ae5d30184068eabb45cfeebaa053f6926cc99955239f5cdfe0cc378e3

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2020-2022, The SitePrism team & Marcelo Nicolosi Santos
+Copyright (c) 2020-2023, The SitePrism team & Marcelo Nicolosi Santos
 
 All rights reserved.
 
@@ -10,4 +10,4 @@ Redistributions in binary form must reproduce the above copyright notice, this l
 
 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

@@ -29,6 +29,19 @@ $ bundle
 
 Either require all of the extensions required, or require individual bits and pieces
 
+```shell
+# Require all of the drivers/patches/extensions code
+require 'automation_helpers'
+# Require all driver code
+require 'automation_helpers/drivers'
+# Require just local drivers
+require 'automation_helpers/drivers/local'
+# Require all patches
+require 'automation_helpers/patches'
+# Require all extensions
+require 'automation_helpers/extensions'
+```
+
 ## Development
 
 ```

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

@@ -9,11 +9,9 @@ require 'automation_helpers/drivers/v4/options'
 module AutomationHelpers
   module Drivers
     module V4
-      #
-      # {AutomationHelpers::Drivers::V4::Browserstack}
       #
       # The Browserstack Driver that will connect to a hosted grid
-      # Requires a series of pre-set values to be passed in
+      # This requires a series of pre-set values to be passed in
       #
       class Browserstack
         attr_reader :browser, :browserstack_options, :device_options

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

@@ -6,10 +6,7 @@ module AutomationHelpers
   module Drivers
     module V4
       #
-      # {AutomationHelpers::Drivers::V4::Capabilities}
-      #
-      # The Capabilities object that will be used to instantiate whatever driver you
-      # are configuring
+      # The Capabilities object that will be used to instantiate whatever driver you are configuring
       #
       class Capabilities
         class << self
@@ -29,6 +26,7 @@ module AutomationHelpers
             when :firefox;           then firefox_capabilities
             when :internet_explorer; then internet_explorer_capabilities
             when :ios;               then ios_capabilities(device_options)
+            when :safari;            then safari_capabilities
             else {}
             end
           end
@@ -99,6 +97,14 @@ module AutomationHelpers
             else raise ArgumentError, "Your iOS Version is too low. Please don't use lower than iOS 11."
             end
           end
+
+          def safari_capabilities
+            AutomationHelpers.logger.warn('Altering Browser Name request to alleviate Capybara failure with STP.')
+
+            {
+              'browserName' => 'Safari Technology Preview'
+            }
+          end
         end
       end
     end

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

@@ -7,8 +7,6 @@ require 'automation_helpers/drivers/v4/options'
 module AutomationHelpers
   module Drivers
     module V4
-      #
-      # {AutomationHelpers::Drivers::V4::Local}
       #
       # The Local Driver that will spin up and run on your machine (Without connecting to any grid)
       #
@@ -71,11 +69,10 @@ module AutomationHelpers
         #
         # NB: Whilst using Safari TP this is required.
         def desired_capabilities
-          ::Selenium::WebDriver::Remote::Capabilities.new.tap do |capabilities|
-            if safari?
-              capabilities['browserName'] = 'Safari Technology Preview'
-              AutomationHelpers.logger.warn('Altering Browser Name request to alleviate Capybara failure with STP.')
-            end
+          if safari?
+            Capabilities.for(:safari)
+          else
+            ::Selenium::WebDriver::Remote::Capabilities.new
           end
         end
 

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

@@ -5,8 +5,6 @@ require 'selenium/webdriver'
 module AutomationHelpers
   module Drivers
     module V4
-      #
-      # {AutomationHelpers::Drivers::V4::Options}
       #
       # The Options object that will be used to instantiate whatever driver you
       # are configuring

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

@@ -6,11 +6,9 @@ require 'automation_helpers/drivers/v4/options'
 module AutomationHelpers
   module Drivers
     module V4
-      #
-      # {AutomationHelpers::Drivers::V4::Remote}
       #
       # The Remote Driver that will connect to a dockerised self-hosted grid
-      # Expects the grid to be live and accepting node requests
+      # This expects the grid to be live **and** accepting node requests
       #
       class Remote
         attr_reader :browser

data/lib/automation_helpers/drivers.rb

@@ -1,5 +1,7 @@
 # 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/array.rb

@@ -2,11 +2,17 @@
 
 # Additional useful methods to extend the Array class with
 class Array
-  # @return [Boolean]
+  # @return [Array]
   #
-  # Test whether an array is wholly unique
-  def uniq?
-    uniq == self
+  # Generates an array of the english alphabet
+  # Accepts an input to determine what case of alphabet you want
+  def self.alphabet(type = :upper)
+    case type
+    when :upper; then ('A'..'Z').to_a
+    when :lower; then ('a'..'z').to_a
+    when :both;  then ('a'..'z').to_a + ('A'..'Z').to_a
+    else raise ArgumentError, 'Invalid alphabet type. Must be :upper (default), :lower or :both'
+    end
   end
 
   # @return [Array]
@@ -15,4 +21,11 @@ class Array
   def non_uniq
     tally.select { |_key, count| count > 1 }.map(&:first)
   end
+
+  # @return [Boolean]
+  #
+  # Test whether an array is wholly unique
+  def uniq?
+    uniq == self
+  end
 end

data/lib/automation_helpers/extensions/string.rb

@@ -4,7 +4,20 @@
 class String
   # @return [String]
   #
-  # Convert's a regular string name into it's pascalized format
+  # Generates a single random letter from an array of the english alphabet
+  # Accepts an input to determine what case of alphabet you want
+  def self.alphabet_char(type = :upper)
+    case type
+    when :upper; then ('A'..'Z').to_a.sample
+    when :lower; then ('a'..'z').to_a.sample
+    when :both;  then (('a'..'z').to_a + ('A'..'Z').to_a).sample
+    else raise ArgumentError, 'Invalid character type. Must be :upper (default), :lower or :both'
+    end
+  end
+
+  # @return [String]
+  #
+  # Converts a regular string name into it's pascalized format
   # This can then be used to generate a ClassName
   def pascalize
     split('_').map(&:capitalize).join
@@ -12,7 +25,15 @@ class String
 
   # @return [String]
   #
-  # Convert's a regular string into a snake cased format
+  # Sanitize and convert every individual whitespace character to
+  # a regular space character (Does not sanitize newlines)
+  def sanitize_whitespace
+    gsub(/[ \t\r\f\u00A0]/, ' ')
+  end
+
+  # @return [String]
+  #
+  # Converts a regular string into a snake cased format
   # Will sanitize out some characters (Designed for titles)
   def snake_case
     gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
@@ -24,11 +45,10 @@ class String
       .downcase
   end
 
-  # @return [String]
+  # @return [Boolean]
   #
-  # Sanitize and convert every individual whitespace character to
-  # a regular space character (Does not sanitize newlines)
-  def sanitize_whitespace
-    gsub(/[ \t\r\f\u00A0]/, ' ')
+  # Cast any string to true or false
+  def to_bool
+    %w[yes on true].include?(downcase)
   end
 end

data/lib/automation_helpers/logger.rb

@@ -7,6 +7,9 @@ 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'

data/lib/automation_helpers/patches/base.rb

@@ -2,9 +2,12 @@
 
 module AutomationHelpers
   module Patches
+    #
+    # @api private
+    #
     class Base
       #
-      # api private (Not intended to be instantiated directly!)
+      # api private (Not intended to be instantiated directly! Use the child classes)
       #
       def patch!
         raise 'This is no longer supported' if prevent_usage?
@@ -24,6 +27,7 @@ module AutomationHelpers
       # From what point should this patch start throwing deprecation notices
       # If a date is provided, then after that date
       # If a version from is provided, then all releases after that one (NB: You must provide a link to the gem version)
+      # Otherwise the patch is considered never to be deprecated
       #
       def deprecate?
         if defined?(deprecation_notice_date)
@@ -39,6 +43,7 @@ module AutomationHelpers
       # From what point should this patch start preventing usage deprecation notices
       # If a date is provided, then after that date
       # If a version from is provided, then all releases after that one (NB: You must provide a link to the gem version)
+      # Otherwise the patch is considered never to be prevented from being used
       #
       def prevent_usage?
         if defined?(prevent_usage_date)

data/lib/automation_helpers/patches/capybara.rb

@@ -2,6 +2,9 @@
 
 module AutomationHelpers
   module Patches
+    #
+    # Fix the issue where the `#text` method doesn't normalize whitespace (Only the matchers do)
+    #
     class Capybara < Base
       private
 
@@ -18,6 +21,9 @@ module AutomationHelpers
       end
     end
 
+    #
+    # @api private
+    #
     module SafariTextPatch
       def text(type = nil, normalize_ws: ::Capybara.default_normalize_ws)
         super(type, normalize_ws: normalize_ws)

data/lib/automation_helpers/patches/parallel_cucumber.rb

@@ -2,6 +2,9 @@
 
 module AutomationHelpers
   module Patches
+    #
+    # Fix the issue where the parser for parallel_tests doesn't permit the --retry flag (Or other flags at the end)
+    #
     class ParallelCucumber < Base
       private
 

data/lib/automation_helpers/patches/selenium_logger.rb

@@ -2,6 +2,10 @@
 
 module AutomationHelpers
   module Patches
+    #
+    # Fix the issue where the Selenium Logger isn't designed to parse characters that aren't standard ASCII
+    # (This is an issue in the parent Net-HTTP adapter that most loggers are built on)
+    #
     class SeleniumLogger < Base
       private
 

data/lib/automation_helpers/patches/selenium_manager.rb

@@ -2,6 +2,10 @@
 
 module AutomationHelpers
   module Patches
+    #
+    # Fix the issue where the `#convert_cookie` API private method in selenium-webdriver doesn't include the
+    # 'httpOnly' property in the returned cookie hash structure
+    #
     class SeleniumManager < Base
       private
 
@@ -29,6 +33,9 @@ module AutomationHelpers
       end
     end
 
+    #
+    # @api private
+    #
     module CookieConverter
       def convert_cookie(cookie)
         super(cookie)

data/lib/automation_helpers/patches/selenium_options.rb

@@ -2,6 +2,9 @@
 
 module AutomationHelpers
   module Patches
+    #
+    # Fix the issue where for some drivers selenium doesn't camelize the browser name key 'browserName' correctly
+    #
     class SeleniumOptions < Base
       def initialize(browser)
         @browser = browser
@@ -53,6 +56,9 @@ module AutomationHelpers
       end
     end
 
+    #
+    # @api private
+    #
     module CapabilitiesAsJsonFix
       private
 

data/lib/automation_helpers/patches.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'automation_helpers/logger'
+
 require 'automation_helpers/patches/base'
 require 'automation_helpers/patches/capybara'
 require 'automation_helpers/patches/parallel_cucumber'

data/lib/automation_helpers/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automation_helpers
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.1
 platform: ruby
 authors:
 - Luke Hill
@@ -9,29 +9,35 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.30'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.30'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -41,7 +47,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -51,91 +57,97 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.35.0
+        version: 1.45.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.35.0
+        version: 1.45.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.3
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.3
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.1
+        version: 2.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.1
+        version: 2.22.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta2
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -145,7 +157,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta2
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -155,14 +167,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '5.2'
 description: Automation Patches / Extensions that allow you to extend your Ruby-based
   testing frameworks
 email: