automation_helpers 4.0 → 4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e31fd999ded8a53243daee17b49c7d85c65c54c0c75ab657669b4e8753f0efc4
-  data.tar.gz: e0abb956e546004f43b9367f0c5e5bf6dbb51770f575642d6e00bfd1b5b0bcbf
+  metadata.gz: a45b85e5e998a666514c866da1cc6639fa113ebe88232a70ceb979c4a2877a03
+  data.tar.gz: d66c6284158e939d8d268126e8fd98833316ca2cfa4a29c3afbdd8002c1aa61a
 SHA512:
-  metadata.gz: 8f981fb29c66cd31b7a08459f4804cdf0917550547aeafddc1397b861b9f0935d03270db452e7cccbabd954425ab5d19e96b8c307a727b1123c842688cb5d558
-  data.tar.gz: 61a8a6dcbb015412438984f39983ea02073f15c9097428ba8cde64cfb4716b50c6dc73e68d0da9efea64b4cd86a197dfdea5e1030642c8c365191c734445a5ee
+  metadata.gz: 97f4e92ba3f4a1bc6629d07b94e60de3b9c722f27feb0700b8fbaf9953a4177302584ec8700245a942b3a9a114ca007e05f976f0ccb34d46a3e55a20b0486856
+  data.tar.gz: 6039a2641fe43f4f46ac5befd0987bd259391a2da6f59e1e553de76b58ab6ad8c01bccafb0a8ae49079036290da4de0d8571a8fb83549fa36530ab8902da3bcd

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2020-2021, The SitePrism team & Marcelo Nicolosi Santos
+Copyright (c) 2020-2022, The SitePrism team & Marcelo Nicolosi Santos
 
 All rights reserved.
 

data/README.md

@@ -34,7 +34,7 @@ Either require all of the extensions required, or require individual bits and pi
 ```
 $ bundle
 # Code anything relevant - Add tests for each public method!
-$ bundle exec rake
+$ rspec && rubocop
 # Ensure it's all green! Then commit and push
 ```
 

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

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)
       #

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

@@ -5,12 +5,13 @@ 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
       #
+      # #### Initial setup options
+      #
+      # - **ENV["HEADLESS"]** (optional) - Whether you want your browser to run headless or not
       class Options
         class << self
           # @return [Selenium::Webdriver::Options]
@@ -43,7 +44,7 @@ module AutomationHelpers
           end
 
           def headless?
-            ENV['HEADLESS'] == 'true'
+            ENV.fetch('HEADLESS', 'false') == 'true'
           end
         end
       end

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
@@ -52,7 +50,7 @@ module AutomationHelpers
         end
 
         def hub_url
-          ENV['HUB_URL']
+          ENV.fetch('HUB_URL')
         end
 
         def supported_browser?

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,15 @@
 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)
+    Array.alphabet(type).sample
+  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 +20,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 +40,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?

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
 
@@ -17,8 +20,8 @@ module AutomationHelpers
         ::ParallelTests::Gherkin::Runner.extend RetryFlagFix
       end
 
-      def deprecation_notice_date
-        Time.new(2022, 6, 30)
+      def deprecate_from
+        '3.12.0'
       end
 
       def prevent_usage_from

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
 
@@ -21,7 +25,7 @@ module AutomationHelpers
       end
 
       def prevent_usage_from
-        '4.0.0.beta5'
+        '4.0.0'
       end
 
       def gem_version
@@ -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,13 +2,16 @@
 
 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
         super()
       end
 
-      # @return [Nil || AutomationHelpers.logger.info]
+      # @return [nil || true]
       #
       # For SeleniumOptions we only want to run the patch when
       # we are on browsers without the relevant JSON fixes in upstream
@@ -30,7 +33,6 @@ module AutomationHelpers
           The issue is the driver, which is now fully W3C conformant expects `browserName`
 
           See: https://github.com/SeleniumHQ/selenium/pull/8834 for more details/discussion including this fix
-          LH - Nov 2020
         DESCRIPTION
       end
 
@@ -42,11 +44,11 @@ module AutomationHelpers
       end
 
       def deprecate_from
-        '4.0.0.beta5'
+        '4.0.0'
       end
 
       def prevent_usage_from
-        '4.0.1'
+        '4.0.3'
       end
 
       def gem_version
@@ -54,6 +56,9 @@ module AutomationHelpers
       end
     end
 
+    #
+    # @api private
+    #
     module CapabilitiesAsJsonFix
       private
 

data/lib/automation_helpers/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automation_helpers
 version: !ruby/object:Gem::Version
-  version: '4.0'
+  version: '4.1'
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.27'
+        version: '3.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.27'
+        version: '3.30'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,21 +44,21 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
@@ -79,48 +79,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        version: 1.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        version: 1.38.0
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.alpha1
-    - - "<"
+        version: 1.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 2.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.alpha1
-    - - "<"
+        version: 2.14.2
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement