site_prism 5.0.beta → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 919e215261486aca371a708b7b06826e54941a29cf1580ebca68e2dea4cfbc0a
-  data.tar.gz: ecd938940c5546287ffbbf182aece2d6aacf96b454738f33a73b114c09803f19
+  metadata.gz: c79a26103d273c27df0c3417fd1764aef080c1b2d322f250dc71bd83a0e7edac
+  data.tar.gz: 834a40852d19e8976f2e7b212e58830d2b88c178a79362c9a2bec0759bd9b6b1
 SHA512:
-  metadata.gz: ebb6eb3adbe1cb9663160d4347a5c3189c333937b4cb49649bf998a397cd634be4d4b557d5dc6ad5e5415d7eee8f297a8b05e8b894d19fe98cb3a9ff7a602657
-  data.tar.gz: e63ee2fd016759f69c943de5ea7e477151c1333af5c25aef8a10834426db5e14fa1790accf5069726c405ae9ec33dd2a96d9877ad75cfb558b85b284e4e1875d
+  metadata.gz: 8f24969720f9c2a7a6587e243bf77d5c495224b5cd7814d641e72585f6604f9d7b768ad5de48d58e89fd30beca6950842d49101d423023ebe472f57e4c537837
+  data.tar.gz: 5c7c6fadbeb8480b54e5deced89208d9c4e5d6a9bf6daf9960b54c81cdfa4d4bd1e399a0376245da0250d308d64de5e1fdafb0a00a90d247f4575b6ac6669449

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2023, The SitePrism team
+Copyright (c) 2011, The SitePrism team
 
 All rights reserved.
 

data/README.md

@@ -25,12 +25,12 @@ then please do so. Visit the OpenCollective links above for more details.
 
 We love it when people want to get involved with our Open Source Project.
 
-We have a brief set of setup docs [HERE](https://github.com/site-prism/site_prism/blob/main/HACKING.md)
+We have a brief set of contribution documents [HERE](https://github.com/site-prism/site_prism/blob/main/CONTRIBUTING.md)
 
 ## Supported Rubies / Browsers
 
-SitePrism is built and tested to work on Ruby 2.6 - 3.1.
-If you are using SitePrism with Ruby 2.5-2.7 it is highly advisable to upgrade to a more modern
+SitePrism is built and tested to work on Ruby 2.7 - 3.2.
+If you are using SitePrism with Ruby 2.7 it is highly advisable to upgrade to a more modern
 Ruby (v3+), if for any other reason, to get a performance improvement!
 
 SitePrism should run on all major browsers. The gem's integration tests are run on Chrome and Firefox.
@@ -66,7 +66,7 @@ class SearchResults < SitePrism::Page
   end
 end
 
-# define sections used on multiple pages or multiple times on one page
+# Define sections that are used on multiple pages or multiple times on one page
 
 class Menu < SitePrism::Section
   element :search, 'a.search'
@@ -79,7 +79,7 @@ class SearchResults < SitePrism::Section
   element :blurb, 'span.result-description'
 end
 
-# now for some tests
+# Then we can write some tests
 
 When('I navigate to the google home page') do
   @home = Home.new
@@ -88,6 +88,7 @@ end
 
 Then('the home page should contain the menu and the search form') do
   @home.wait_until_menu_visible(wait: 5)
+  
   expect(@home).to have_menu
   expect(@home).to have_search_field
   expect(@home).to have_search_button
@@ -100,11 +101,13 @@ end
 
 Then('the search results page is displayed') do
   @results_page = SearchResults.new
+  
   expect(@results_page).to be_displayed
 end
 
 Then('the search results page contains 10 individual search results') do
   @results_page.wait_until_search_results_visible(wait: 5)
+  
   expect(@results_page).to have_search_results(count: 10)
 end
 
@@ -113,8 +116,6 @@ Then('the search results contain a link to the wikipedia sausages page') do
 end
 ```
 
-Now for the details...
-
 ## Setup
 
 ### Installation
@@ -166,19 +167,15 @@ And again, as above, a sample driver is no different to a normal driver instanti
 
 ## Introduction to the Page Object Model
 
-The Page Object Model is a test automation pattern that aims to create
-an abstraction of your site's user interface that can be used in tests.
-The most common way to do this is to model each page as a class, and
-to then use instances of those classes in your tests.
+The Page Object Model is a test automation pattern that aims to create an abstraction of your sites user
+interface that can be used in tests. The most common way to do this is to model each page as a class and
+then to use instances of those classes in your tests.
 
-If a class represents a page then each element of the page is
-represented by a method that, when called, returns a reference to that
-element that can then be acted upon (clicked, type in some text), or
-queried (is it enabled? / visible?).
+If a class represents a page then each element of the page is represented by a method that, when called, returns a
+reference to that element that can then be acted upon (clicked, type in some text), or queried (is it enabled? / visible?).
 
-SitePrism is based around this concept, but goes further as you'll see
-below by also allowing modelling of repeated sections that appear on
-multiple pages, or many times on a page using the concept of sections.
+SitePrism is based around this concept, but goes further as you'll see below by also allowing modelling of
+repeated sections that appear on multiple pages, or many times on a page using the concept of sections.
 
 ## Pages
 
@@ -216,9 +213,8 @@ class Home < SitePrism::Page
 end
 ```
 
-Note that setting a URL is **optional** - you only need to set a url if you want to be able to
-navigate directly to that page. It makes sense to set the URL for a page model of a
-home page or a login page, but probably not a search results page.
+Note that setting a URL is **optional** - you only need to set a url if you want to be able to navigate directly to that page.
+It makes sense to set the URL for a page model of a home page or a login page, but probably not a search results page.
 
 #### Parametrized URLs
 
@@ -281,10 +277,9 @@ navigate to the URL set against that page's class.
 
 ### Verifying that a particular page is displayed
 
-Automated tests often need to verify that a particular page is
-displayed. SitePrism can automatically parse your URL template
-and verify that whatever components your template specifies match the
-currently viewed page. For example, with the following URL template:
+Automated tests often need to verify that a particular page is displayed. SitePrism can automatically parse
+your templated URL and verify that whatever components your template specifies match the currently viewed page.
+For example, with the following URL template:
 
 ```ruby
 class Account < SitePrism::Page
@@ -302,10 +297,9 @@ expect(@account_page.current_url).to end_with('/accounts/22?token=ca2786616a4285
 expect(@account_page).to be_displayed
 ```
 
-Calling `#displayed?` will return true if the browser's current URL
-matches the page's template and false if it doesn't. It will wait for
-`Capybara.default_max_wait_time` seconds or you can pass an explicit
-wait time in seconds as the first argument like this:
+Calling `#displayed?` will return true if the browser's current URL matches the page's template and false if
+it doesn't. It will wait for `Capybara.default_max_wait_time` seconds or you can pass an explicit wait time in
+seconds as the first argument like this:
 
 ```ruby
 @account_page.displayed?(10) # wait up to 10 seconds for display
@@ -346,9 +340,8 @@ expect(@account_page.url_matches.dig('query', 'token')).to eq('ca2786616a4285bc'
 
 #### Falling back to basic regexp matchers
 
-If SitePrism's built-in URL matching is not sufficient for your needs
-you can override and use SitePrism's previous support for regular expression-based
-URL matchers by it by calling `set_url_matcher`:
+If SitePrism's built-in URL matching is not sufficient for your needs you can override and use SitePrism's
+support for regular expression-based URL matchers by it by calling `set_url_matcher`:
 
 ```ruby
 class Account < SitePrism::Page
@@ -377,6 +370,7 @@ end
 
 @account = Account.new
 @account.current_url #=> "http://www.example.com/account/123"
+
 expect(@account.current_url).to include('example.com/account/')
 ```
 
@@ -394,10 +388,9 @@ end
 
 ### HTTP vs. HTTPS
 
-You can easily tell if the page is secure or not by checking to see if
-the current URL begins with 'https' or not. SitePrism provides the
-`secure?` method that will return true if the current url begins with
-'https' and false if it doesn't. For example:
+You can easily tell if the page is secure or not by checking to see if the current URL begins with 'https' or not.
+SitePrism provides the `#secure?` method that will return true if the current url begins with 'https' and false if it doesn't.
+For example:
 
 ```ruby
 class Account < SitePrism::Page
@@ -405,16 +398,15 @@ end
 
 @account = Account.new
 @account.secure? #=> true/false
+
 expect(@account).to be_secure
 ```
 
 ## Elements
 
-Pages are made up of elements (text fields, buttons, combo boxes, etc),
-either individual elements or groups of them. Examples of individual
-elements would be a search field or a company logo image; examples of
-element collections would be items in any sort of list, eg: menu items,
-images in a carousel, etc.
+Pages are made up of elements (text fields, buttons, combo boxes, etc), either individual elements or groups of
+them. Examples of individual elements would be a search field or a company logo image; examples of element collections would
+be items in any sort of list, eg: menu items,images in a carousel, etc.
 
 ### Individual Elements
 
@@ -508,18 +500,16 @@ Using the above example:
 
 ```ruby
 Then('the search field exists')do
-  expect(@home).to have_no_search_field #NB: NOT => expect(@home).not_to have_search_field
+  expect(@home).to have_no_search_field #NB: NOT THE SAME AS => expect(@home).not_to have_search_field
 end
 ```
 
 #### Waiting for an element to become visible
 
-A method that gets added by calling `element` is the
-`wait_until_<element_name>_visible` method.
+A method that gets added by calling `element` is the `wait_until_<element_name>_visible` method.
 This method delegates to [Capybara::Node::Matchers#has_selector?](https://www.rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Matchers#has_selector%3F-instance_method).
-Calling this method will cause the test to wait for Capybara's default wait time for the element
-to become visible. You can customise the wait time by supplying a number
-of seconds to wait in-line or configuring the default wait time.
+Calling this method will cause the test to wait for Capybara's default wait time for the element to become visible. You can customise
+the wait time by supplying a number of seconds to wait in-line or configuring the default wait time.
 
 ```ruby
 @home.wait_until_search_field_visible # using the default wait time set
@@ -529,12 +519,10 @@ of seconds to wait in-line or configuring the default wait time.
 
 #### Waiting for an element to become invisible
 
-Another method added by calling `element` is the
-`wait_until_<element_name>_invisible` method.
+Another method added by calling `element` is the `wait_until_<element_name>_invisible` method.
 This method delegates to [Capybara::Node::Matchers#has_no_selector?](https://www.rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Matchers#has_no_selector%3F-instance_method).
-Calling this method will cause the test to wait for Capybara's default
-wait time for the element to become invisible. You can as with the visibility
-waiter, customise the wait time in the same way.
+Calling this method will cause the test to wait for Capybara's default wait time for the element to become invisible.
+You can (as with the visibility waiter), customise the wait time in the same way.
 
 ```ruby
 @home.wait_until_search_field_invisible # using the default wait time set
@@ -544,9 +532,8 @@ waiter, customise the wait time in the same way.
 
 #### CSS Selectors vs. XPath Expressions
 
-While the above examples all use CSS selectors to find elements, it is
-possible to use XPath expressions too. In SitePrism, everywhere that you
-can use a CSS selector, you can use an XPath expression.
+While the above examples all use CSS selectors to find elements, it is possible to use XPath expressions too.
+In SitePrism, everywhere that you can use a CSS selector, you can use an XPath expression (Standard Capybara logic).
 
 An example:
 
@@ -1686,6 +1673,25 @@ When('I log in') do
 end
 ```
 
+## Shadow Root
+
+SitePrism allows you to interact with Shadow Roots too.
+
+### Creating an Shadow Root
+
+You can use the `section` methods and provide the arguments. Specify the reference name for the Shadow Root,
+the CSS selector to locate it, and add the `:shadow_root` option. For example:
+
+```ruby
+class Home < SitePrism::Page
+  section :foo, '.foo', shadow_root: true do
+    element :bar, '.bar'
+  end
+end
+```
+
+NB: By default `shadow_root` will be set to false
+
 ## SitePrism Configuration
 
 SitePrism can be configured to change its behaviour.

data/lib/site_prism/deprecator.rb

@@ -4,7 +4,7 @@ module SitePrism
   # [SitePrism::Deprecator]
   class Deprecator
     class << self
-      # @return SitePrism.logger.warn(msg)
+      # @return [SitePrism.logger.warn(msg)]
       #
       # Tells the user that they are using old functionality, which needs removing in the
       # next major version
@@ -15,22 +15,7 @@ module SitePrism
           warn("#{old} is being deprecated and should no longer be used.")
         end
 
-        warn("#{old} will be removed in SitePrism v5. You have been warned!")
-      end
-
-      # @return SitePrism.logger.debug(msg)
-      #
-      # Tells the user that they are using functionality which is non-optimal
-      # The functionality should usually provide a reason for it being poor, as well as an
-      # optional way of upgrading to something different
-      #
-      # NB: As this is bubbled up at debug level, often users will not see this. So it will
-      # never be a candidate for removal directly
-      def soft_deprecate(old, reason, new = nil)
-        debug("The #{old} method is changing, as is SitePrism, and is now advised to be changed.")
-        debug("REASON: #{reason}.")
-        debug('Moving forwards into SitePrism v5, the default behaviour will change.')
-        debug("We advise you change to using #{new}") if new
+        warn("#{old} will be removed in SitePrism v6. You have been warned!")
       end
 
       private
@@ -38,10 +23,6 @@ module SitePrism
       def warn(msg)
         SitePrism.logger.warn(msg)
       end
-
-      def debug(msg)
-        SitePrism.logger.debug(msg)
-      end
     end
   end
 end

data/lib/site_prism/dsl/builder.rb

@@ -15,35 +15,37 @@ module SitePrism
     #
     module Builder
       # Return a list of all mapped items on a SitePrism class instance (Page or Section)
-      # If legacy is set to false (Default) -> @return [Hash]
-      # If legacy is set to true (Old behaviour) -> @return [Array]
-      def mapped_items(legacy: false)
-        return legacy_mapped_items if legacy
-
+      #
+      # @return [Hash]
+      def mapped_items
         @mapped_items ||= { element: [], elements: [], section: [], sections: [], iframe: [] }
       end
 
       private
 
       def build(type, name, *find_args)
-        raise InvalidDSLNameError if ENV.fetch('SITEPRISM_DSL_VALIDATION_ENABLED', 'true') == 'true' && invalid?(name)
+        invalid_element_name if invalid_element_name?(name)
+        blank_element(name) if find_args.empty?
 
-        if find_args.empty?
-          create_error_method(name)
-        else
-          map_item(type, name)
-          yield
-        end
+        mapped_items[type] << name.to_sym
+        yield
         add_helper_methods(name, type, *find_args)
       end
 
-      def create_error_method(name)
-        SitePrism::Deprecator.deprecate(
-          'DSL definition with no find_args',
-          'DSL definition with at least 1 find_arg'
-        )
-        SitePrism.logger.error("#{name} has come from an item with no locators.")
-        define_method(name) { raise SitePrism::InvalidElementError }
+      def invalid_element_name
+        raise InvalidDSLNameError, dsl_name_error
+      end
+
+      def invalid_element_name?(name)
+        !dsl_validation_disabled? && name_invalid?(name)
+      end
+
+      def dsl_validation_disabled?
+        SitePrism.dsl_validation_disabled || ENV.key?('SITEPRISM_DSL_VALIDATION_DISABLED')
+      end
+
+      def blank_element(name)
+        raise SitePrism::InvalidElementError, "#{name} has come from an item with no locators."
       end
 
       def add_helper_methods(name, _type, *find_args)
@@ -99,26 +101,11 @@ module SitePrism
       end
 
       def create_helper_method(proposed_method_name, *find_args)
-        return create_error_method(proposed_method_name) if find_args.empty?
+        return blank_element(proposed_method_name) if find_args.empty?
 
         yield
       end
 
-      def legacy_mapped_items
-        @legacy_mapped_items ||= begin
-          SitePrism::Deprecator.deprecate(
-            '.mapped_items structure (internally), on a class',
-            'the new .mapped_items structure'
-          )
-          []
-        end
-      end
-
-      def map_item(type, name)
-        mapped_items(legacy: true) << { type => name }
-        mapped_items[type] << name.to_sym
-      end
-
       def extract_section_options(args, &block)
         if args.first.is_a?(Class)
           klass = args.shift

data/lib/site_prism/dsl/locators.rb

@@ -13,21 +13,31 @@ module SitePrism
 
       def _find(*find_args)
         kwargs = find_args.pop
-        to_capybara_node.find(*find_args, **kwargs)
+        shadow_root = kwargs.delete(:shadow_root) { false }
+        check_capybara_version_if_creating_shadow_root if shadow_root
+        to_capybara_node.find(*find_args, **kwargs).tap do |element|
+          break element.shadow_root if shadow_root
+        end
       end
 
       def _all(*find_args)
         kwargs = find_args.pop
-        to_capybara_node.all(*find_args, **kwargs)
+        shadow_root = kwargs.delete(:shadow_root) { false }
+        check_capybara_version_if_creating_shadow_root if shadow_root
+        to_capybara_node.all(*find_args, **kwargs).tap do |element|
+          break element.map(&:shadow_root) if shadow_root
+        end
       end
 
       def element_exists?(*find_args)
         kwargs = find_args.pop
+        kwargs.delete(:shadow_root)
         to_capybara_node.has_selector?(*find_args, **kwargs)
       end
 
       def element_does_not_exist?(*find_args)
         kwargs = find_args.pop
+        kwargs.delete(:shadow_root)
         to_capybara_node.has_no_selector?(*find_args, **kwargs)
       end
 
@@ -63,6 +73,13 @@ module SitePrism
         options.merge!(runtime_args.pop) if runtime_args.last.is_a? Hash
         options[:wait] = Capybara.default_max_wait_time unless options.key?(:wait)
       end
+
+      def check_capybara_version_if_creating_shadow_root
+        minimum_version = '3.37.0'
+        raise SitePrism::UnsupportedGemVersionError unless Capybara::VERSION >= minimum_version
+
+        SitePrism.logger.error("Shadow root support requires Capybara version >= #{minimum_version}. You are using #{Capybara::VERSION}.")
+      end
     end
   end
 end

data/lib/site_prism/dsl/validator.rb

@@ -2,7 +2,7 @@
 
 module SitePrism
   module DSL
-    # [SitePrism::DSL::Validators]
+    # [SitePrism::DSL::Validator]
     #
     # This is the new validator module which will check all DSL items against a whitelist
     # for any entries which break specific rules
@@ -10,7 +10,9 @@ module SitePrism
     # @api private
     #
     module Validator
-      def invalid?(name)
+      attr_accessor :dsl_name_error
+
+      def name_invalid?(name)
         prefix_invalid?(name) ||
           suffix_invalid?(name) ||
           characters_invalid?(name) ||
@@ -20,25 +22,25 @@ module SitePrism
       private
 
       def prefix_invalid?(name)
-        return unless prefix_blacklist.any? { |prefix| name.start_with?(prefix) }
+        return false unless prefix_blacklist.any? { |prefix| name.start_with?(prefix) }
 
         log_failure(name, 'prefix')
       end
 
       def suffix_invalid?(name)
-        return unless suffix_blacklist.any? { |prefix| name.end_with?(prefix) }
+        return false unless suffix_blacklist.any? { |prefix| name.end_with?(prefix) }
 
         log_failure(name, 'suffix')
       end
 
       def characters_invalid?(name)
-        return if name.match?(regex_permission)
+        return false if name.match?(regex_permission)
 
         log_failure(name, 'character(s)')
       end
 
       def blacklisted?(name)
-        return unless blacklisted_names.include?(name)
+        return false unless blacklisted_names.include?(name)
 
         log_failure(name, 'name (blacklisted entry)')
       end
@@ -76,7 +78,7 @@ module SitePrism
       end
 
       def log_failure(name, type)
-        SitePrism.logger.error("DSL item: #{name} has an invalid #{type}")
+        self.dsl_name_error = "DSL item: #{name} has an invalid #{type}"
         SitePrism.logger.debug(debug_error(type))
       end
 

data/lib/site_prism/element_checker.rb

@@ -13,7 +13,7 @@ module SitePrism
     # for how the definition of "every item" is derived.
     #
     # Example
-    # @my_page.class.mapped_items
+    # `@my_page.class.mapped_items`
     #  {
     #    element => [:button_one, :button_two],
     #    elements => [:button_collection_one, :button_collection_two],
@@ -21,7 +21,7 @@ module SitePrism
     #    sections => [:search_result],
     #    iframe => []
     #  }
-    # @my_page.all_there?
+    # `@my_page.all_there?`
     # => true - If the items above are all present
     #
     # Note that #elements_to_check will check the hash of mapped_items
@@ -56,7 +56,7 @@ module SitePrism
     end
 
     def there?(name)
-      send("has_#{name}?")
+      send(:"has_#{name}?")
     end
   end
 end

data/lib/site_prism/error.rb

@@ -50,4 +50,7 @@ module SitePrism
 
   # DSL items are not permitted to be named in certain ways
   class InvalidDSLNameError < AttributeValidationError; end
+
+  # The version of the target gem is unsupported, so using that feature is not possible
+  class UnsupportedGemVersionError < SitePrismError; end
 end

data/lib/site_prism/loadable.rb

@@ -13,10 +13,8 @@ module SitePrism
       base.extend(ClassMethods)
     end
 
-    # In certain circumstances, we cache that the page has already
-    # been confirmed to be loaded so that actions which
-    # call `loaded?` a second time do not need to perform
-    # the load_validation queries against the page a second time.
+    # In certain circumstances, we cache that the page or section has already been "loaded" so that actions which
+    # call `loaded?` a second time do not need to perform the load_validation queries against the page a second time.
     attr_accessor :loaded, :load_error
 
     # Executes the given block after the page is loaded.
@@ -27,8 +25,7 @@ module SitePrism
       # inside another when_loaded block.
       previously_loaded = loaded
 
-      # Within the block, check (and cache) loaded?, to see whether the
-      # page has indeed loaded according to the rules defined by the user.
+      # Within the block, check (and cache) loaded?, to see whether the page has indeed loaded according to the rules defined by the user.
       self.loaded = loaded?
 
       # If the page hasn't loaded. Then crash and return the error message.
@@ -68,13 +65,12 @@ module SitePrism
     end
 
     # [SitePrism::Loadable::ClassMethods]
-    # This exposes all of the DSL definitions users will use when generating "loadables"
+    # This exposes all of the DSL definitions users will use when generating "Loadables"
     #
-    # A "Loadable" is a definition whereby the page object once loaded must pass a boolean check
-    # These loadables are typically provided using the method `load_validation`
+    # A "Loadable" is a definition whereby the page/section object once loaded must pass a boolean check
+    # These Loadables are typically provided using the method `load_validation`
     module ClassMethods
-      # The list of load_validations.
-      # They will be executed in the order they are defined.
+      # The list of load_validations. They are executed in the order they are defined.
       #
       # @return [Array]
       def load_validations
@@ -85,21 +81,15 @@ module SitePrism
         end
       end
 
-      # Appends a load validation block to the page class.
+      # Appends a load validation block to the page/section class.
       #
-      # When `loaded?` is called, these blocks are instance_eval'd
-      # against the current page instance.
-      # This allows users to wait for specific events to occur on
-      # the page or certain elements to be loaded before performing
-      # any actions on the page.
+      # When `loaded?` is called, these blocks are instance_eval'd against the current page instance. This allows users to wait for
+      # specific events to occur on the page or certain elements to be loaded before performing any actions on the page.
       #
-      # @param block [&block] A block which returns true if the page
-      # loaded successfully, or false if it did not.
-      # This block can contain up to 2 elements in an array
-      # The first is the physical validation test to be truthily evaluated.
+      # @param block [&block] A block which returns true if the page loaded successfully, or false if it did not.
+      # This block can contain up to 2 elements in an array -> The first is the physical validation test to be truthily evaluated.
       #
-      # If this does not pass, then the 2nd item (if defined), is output
-      # as an error message to the +FailedLoadValidationError+ that is thrown
+      # If this does not pass, then the 2nd item (if defined), is output as an error message on the +FailedLoadValidationError+
       #
       # @return [Proc]
       def load_validation(&block)

data/lib/site_prism/logger.rb

@@ -10,7 +10,7 @@ module SitePrism
     def create(output = $stdout)
       logger = ::Logger.new(output)
       logger.progname = 'SitePrism'
-      logger.level = :UNKNOWN
+      logger.level = :WARN
       logger.formatter = proc do |severity, time, progname, msg|
         "#{time.strftime('%F %T')} - #{severity} - #{progname} - #{msg}\n"
       end

data/lib/site_prism/page.rb

@@ -36,7 +36,7 @@ module SitePrism
       # The specific url matcher that is used to validate the page is loaded.
       # When one hasn't been previously set, use the url that was set as a direct Regexp exact matcher
       #
-      # @return [Regexp]
+      # @return [Regexp || String]
       def url_matcher
         @url_matcher ||= url
       end
@@ -170,6 +170,7 @@ module SitePrism
     end
 
     def load_html_string(string)
+      SitePrism::Deprecator.deprecate('Using an input fragment (Loading partials using html strings).')
       @page = Capybara.string(string)
       yield to_capybara_node if block_given?
     end

data/lib/site_prism/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SitePrism
-  VERSION = '5.0.beta'
+  VERSION = '5.0.1'
 end

data/lib/site_prism.rb

@@ -22,6 +22,11 @@ require 'site_prism/waiter'
 # [SitePrism]
 module SitePrism
   class << self
+    # SitePrism will enforce strict validation on all generated DSL items i.e. `element`
+    # The validations are found inside the SitePrism::DSL::Validator module
+    # NB: To ensure no unwanted validation issues, this must be disabled BEFORE any page / section code is autoloaded
+    attr_accessor :dsl_validation_disabled
+
     def configure
       yield self
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: 5.0.beta
+  version: 5.0.1
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -49,22 +49,22 @@ dependencies:
   name: site_prism-all_there
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: automation_helpers
   requirement: !ruby/object:Gem::Requirement
@@ -119,42 +119,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.53.0
+        version: 1.60.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.53.0
+        version: 1.60.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.23.2
+        version: 2.25.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.23.2
+        version: 2.25.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -230,9 +230,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key: