site_prism 3.7.2 → 4.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 177884e3ba39ca8a9e1fa0025274c31dd1d765adbba6983f86150feeef4fa301
-  data.tar.gz: 0ecc59ece70808dbb774128d1cf5e7f3fcdaa4d449b27be29f403633b3535c24
+  metadata.gz: 4ebb39462fdc078aff996d358cfadeb4feddbb443cb0655340efa51f4d4af80d
+  data.tar.gz: 2913da09df5462bcf924d3598d8d9f6f4e996c65951acb31694d0dea67990b4d
 SHA512:
-  metadata.gz: 5f402e20e4888f02d4c7695289239c1b4dfca44b47e90029699efe4ec050b2d173f78c1e427f1dbd0647c9b8238397f1c34d22697601b5f36689266f942729b7
-  data.tar.gz: 549ac4b1187a96807c34475961999bcfaa6761fceba70cf13bdcedfdce13c86b23aad1fa700bcda122841a057bd258023f26ffc270194a8258d98756b3bf294c
+  metadata.gz: '080072c82a3df37666dd079600cd75db84be14b2f73e2f06227bdf48e45f8ff2783a64d122c05e12c8eda54462491a6c0f3d3e935b48fad54278dcf4eab0d841'
+  data.tar.gz: 79157445566537187b9578113b3a3100aa13dbf4cbb615f9e8563dc6d1264177eaab62d9caa2fa79f152118aa1c919a5607477492fa33b1d2b23c6f2bf162b49

data/LICENSE.md

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

data/README.md

@@ -1,6 +1,6 @@
 # SitePrism
 [![Gem Version](https://badge.fury.io/rb/site_prism.svg)](https://badge.fury.io/rb/site_prism)
-[![Build Status](https://travis-ci.com/site-prism/site_prism.png)](https://travis-ci.com/site-prism/site_prism)
+[![Build Status](https://github.com/site-prism/site_prism/actions/workflows/ci.yml/badge.svg)](https://github.com/site-prism/site_prism/actions/workflows/ci.yml)
 
 _A Page Object Model DSL for Capybara_
 
@@ -29,10 +29,9 @@ We have a brief set of setup docs [HERE](https://github.com/site-prism/site_pris
 
 ## Supported Rubies / Browsers
 
-SitePrism is built and tested to work on Ruby 2.4 - 2.7. Ruby 2.4 (Now EOL), is supported but
-this version will be removed from the Support Matrix in the coming months.
-If you are using SitePrism with Ruby 2.4 it is highly advisable to upgrade to a more modern Ruby
-such as 2.7, if for any other reason, to get a noticeable speed boost!
+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
+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.
 
@@ -753,15 +752,6 @@ Work alongside developing this functionality further is being continued in the
 [site_prism-all_there](http://www.github.com/site-prism/site_prism-all_there) repo. So head on over
 there if you're interested in how this feature will work going forwards
 
-NB: At the moment a "primitive" but working copy of this is hosted inside this gem. But if you wish to
-use the bleeding edge version of the logic. Then simply set the following configuration parameter
-
-```ruby
-`require 'site_prism/all_there'`
-
-SitePrism.use_all_there_gem = true
-```
-
 ### Getting the list of missing elements
 
 If `#all_there?` returns false and you wish to get the list of missing elements for debugging purposes

data/lib/site_prism/addressable_url_matcher.rb

@@ -128,11 +128,11 @@ module SitePrism
     end
 
     # If a slug begins with non-alpha characters, it may denote the start of
-    # a new component (e.g. query or fragment). We emit thie prefix as part of
+    # a new component (e.g. query or fragment). We emit this prefix as part of
     # the substituted slug so that Addressable's URI parser can see it as such.
     def slug_prefix(slug)
       prefix = slug.match(/\A{([^A-Za-z]+)/)
-      prefix && prefix[1] || ''
+      (prefix && prefix[1]) || ''
     end
 
     # Generate a repeatable 5 character uniform alphabetical nonsense string

data/lib/site_prism/deprecator.rb

@@ -21,8 +21,8 @@ module SitePrism
       # @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
+      # 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

data/lib/site_prism/dsl.rb

@@ -11,63 +11,41 @@ module SitePrism
   module DSL
     def self.included(klass)
       klass.extend ClassMethods
+      klass.extend DSLValidator
     end
 
     private
 
-    # Call `find` inside context set on page/section
+    def raise_if_block(object, name, has_block, type)
+      return unless has_block
+
+      SitePrism.logger.debug("Type passed in: #{type}")
+      SitePrism.logger.error("#{object.class}##{name} cannot accept runtime blocks")
+      raise SitePrism::UnsupportedBlockError
+    end
+
+    # Call `find` inside `to_capybara_node` context (Either Capybara::Session or Capybara::Node::Element)
     def _find(*find_args)
       kwargs = find_args.pop
-      page.find(*find_args, **kwargs)
+      to_capybara_node.find(*find_args, **kwargs)
     end
 
-    # Call `all` inside context set on page/section
+    # Call `all` inside `to_capybara_node` context (Either Capybara::Session or Capybara::Node::Element)
     def _all(*find_args)
       kwargs = find_args.pop
-      page.all(*find_args, **kwargs)
+      to_capybara_node.all(*find_args, **kwargs)
     end
 
-    # Call `has_selector?` inside context set on page/section
+    # Call `has_selector?` inside `to_capybara_node` context (Either Capybara::Session or Capybara::Node::Element)
     def element_exists?(*find_args)
       kwargs = find_args.pop
-      page.has_selector?(*find_args, **kwargs)
+      to_capybara_node.has_selector?(*find_args, **kwargs)
     end
 
-    # Call `has_no_selector?` inside context set on page/section
+    # Call `has_no_selector?` inside `to_capybara_node` context (Either Capybara::Session or Capybara::Node::Element)
     def element_does_not_exist?(*find_args)
       kwargs = find_args.pop
-      page.has_no_selector?(*find_args, **kwargs)
-    end
-
-    # Prevent users from calling methods with blocks when they shouldn't be.
-    #
-    # Example (Triggering error):
-    #
-    #       class MyPage
-    #         element :sample, '.css-locator' do
-    #           puts "This won't be output"
-    #         end
-    #       end
-    #
-    # At runtime this will generate a `SitePrism::UnsupportedBlockError`
-    #
-    # The only DSL keywords that can use blocks are :section and :iframe
-    def raise_if_block(obj, name, has_block, type)
-      return unless has_block
-
-      SitePrism.logger.debug("Type passed in: #{type}")
-      SitePrism.logger.warn('section / iFrame can only accept blocks.')
-      SitePrism.logger.error("#{obj.class}##{name} does not accept blocks")
-
-      raise SitePrism::UnsupportedBlockError
-    end
-
-    # Warn users from naming the elements starting with no_
-    def warn_if_dsl_collision(obj, name)
-      return unless name.to_s.start_with?('no_')
-
-      SitePrism.logger.warn("#{obj.class}##{name} should not start with no_")
-      SitePrism::Deprecator.deprecate('Using no_ prefix in DSL definition')
+      to_capybara_node.has_no_selector?(*find_args, **kwargs)
     end
 
     # Sanitize method called before calling any SitePrism DSL method or
@@ -103,7 +81,7 @@ module SitePrism
       options[:wait] = Capybara.default_max_wait_time unless options.key?(:wait)
     end
 
-    # SitePrism::DSL::ClassMethods
+    # [SitePrism::DSL::ClassMethods]
     # This exposes all of the DSL definitions users will use when generating
     # their POM classes.
     #
@@ -112,17 +90,23 @@ module SitePrism
     module ClassMethods
       attr_reader :expected_items
 
+      # Sets the `expected_items` iVar on a class. This property is used in conjunction with
+      # `all_there?` to provide a way of granularising the check made to only interrogate a sub-set
+      # of DSL defined items
+      def expected_elements(*elements)
+        @expected_items = elements
+      end
+
       # Creates an instance of a SitePrism Element - This will create several methods designed to
       # Locate the element -> @return [Capybara::Node::Element]
       # Check the elements presence or non-presence -> @return [Boolean]
       # Wait for the elements to be present or not -> @return [TrueClass, SitePrism::Error]
       # Validate certain properties about the element
       def element(name, *find_args)
-        SitePrism::Deprecator.deprecate('Passing a block to :element') if block_given?
+        raise_if_block(self, name, block_given?, :element)
         build(:element, name, *find_args) do
-          define_method(name) do |*runtime_args, &element_block|
-            warn_if_dsl_collision(self, name)
-            raise_if_block(self, name, !element_block.nil?, :element)
+          define_method(name) do |*runtime_args, &runtime_block|
+            raise_if_block(self, name, runtime_block, :element)
             _find(*merge_args(find_args, runtime_args))
           end
         end
@@ -134,23 +118,15 @@ module SitePrism
       # Wait for the elements to be present or not -> @return [TrueClass, SitePrism::Error]
       # Validate certain properties about the elements
       def elements(name, *find_args)
-        SitePrism::Deprecator.deprecate('Passing a block to :elements') if block_given?
+        raise_if_block(self, name, block_given?, :elements)
         build(:elements, name, *find_args) do
-          define_method(name) do |*runtime_args, &element_block|
-            warn_if_dsl_collision(self, name)
-            raise_if_block(self, name, !element_block.nil?, :elements)
+          define_method(name) do |*runtime_args, &runtime_block|
+            raise_if_block(self, name, runtime_block, :elements)
             _all(*merge_args(find_args, runtime_args))
           end
         end
       end
 
-      # Sets the `expected_items` iVar on a class. This property is used in conjunction with
-      # `all_there?` to provide a way of granularising the check made to only interrogate a sub-set
-      # of DSL defined items
-      def expected_elements(*elements)
-        @expected_items = elements
-      end
-
       # Creates an instance of a SitePrism Section - This will create several methods designed to
       # Locate the section -> @return [SitePrism::Section]
       # Check the section presence or non-presence -> @return [Boolean]
@@ -160,7 +136,6 @@ module SitePrism
         section_class, find_args = extract_section_options(args, &block)
         build(:section, name, *find_args) do
           define_method(name) do |*runtime_args, &runtime_block|
-            warn_if_dsl_collision(self, name)
             section_element = _find(*merge_args(find_args, runtime_args))
             section_class.new(self, section_element, &runtime_block)
           end
@@ -175,8 +150,8 @@ module SitePrism
       def sections(name, *args, &block)
         section_class, find_args = extract_section_options(args, &block)
         build(:sections, name, *find_args) do
-          define_method(name) do |*runtime_args, &element_block|
-            raise_if_block(self, name, !element_block.nil?, :sections)
+          define_method(name) do |*runtime_args, &runtime_block|
+            raise_if_block(self, name, runtime_block, :sections)
             _all(*merge_args(find_args, runtime_args)).map do |element|
               section_class.new(self, element)
             end
@@ -208,20 +183,9 @@ module SitePrism
 
       private
 
-      def old_mapped_items
-        SitePrism::Deprecator.soft_deprecate(
-          '.mapped_items on a class',
-          'To allow easier recursion through the items in conjunction with #all_there?',
-          '.mapped_items(legacy: false)'
-        )
-        @old_mapped_items ||= []
-      end
-
-      def new_mapped_items
-        @new_mapped_items ||= { element: [], elements: [], section: [], sections: [], iframe: [] }
-      end
-
       def build(type, name, *find_args)
+        raise InvalidDSLNameError if ENV.fetch('SITEPRISM_DSL_VALIDATION_ENABLED', nil) && invalid?(name)
+
         if find_args.empty?
           create_error_method(name)
         else
@@ -231,11 +195,6 @@ module SitePrism
         add_helper_methods(name, *find_args)
       end
 
-      def map_item(type, name)
-        old_mapped_items << { type => name }
-        new_mapped_items[type] << name.to_sym
-      end
-
       def add_helper_methods(name, *find_args)
         create_existence_checker(name, *find_args)
         create_nonexistence_checker(name, *find_args)
@@ -303,6 +262,32 @@ module SitePrism
         define_method(name) { raise SitePrism::InvalidElementError }
       end
 
+      def raise_if_block(parent_object, name, has_block, type)
+        return unless has_block
+
+        SitePrism.logger.debug("Type passed in: #{type}")
+        SitePrism.logger.error("#{name} has been defined as a '#{type}' item in #{parent_object}. It does not accept build-time blocks.")
+        raise SitePrism::UnsupportedBlockError
+      end
+
+      def old_mapped_items
+        SitePrism::Deprecator.soft_deprecate(
+          '.mapped_items on a class',
+          'To allow easier recursion through the items in conjunction with #all_there?',
+          '.mapped_items(legacy: false)'
+        )
+        @old_mapped_items ||= []
+      end
+
+      def new_mapped_items
+        @new_mapped_items ||= { element: [], elements: [], section: [], sections: [], iframe: [] }
+      end
+
+      def map_item(type, name)
+        old_mapped_items << { type => name }
+        new_mapped_items[type] << name.to_sym
+      end
+
       def deduce_iframe_scope_find_args(args)
         warn_on_invalid_selector_input(args)
         case args[0]

data/lib/site_prism/dsl_validator.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module SitePrism
+  # [SitePrism::DSLValidator]
+  #
+  # This is the new validator module which will check all DSL items against a whitelist
+  # for any entries which are prohibited
+  module DSLValidator
+    def invalid?(name)
+      prefix_invalid?(name) ||
+        suffix_invalid?(name) ||
+        characters_invalid?(name) ||
+        blacklisted?(name)
+    end
+
+    private
+
+    def prefix_invalid?(name)
+      prefix_blacklist.any? { |prefix| name.start_with?(prefix) }.tap { |result| log_failure(name, 'prefix') unless result }
+    end
+
+    def suffix_invalid?(name)
+      suffix_blacklist.any? { |prefix| name.end_with?(prefix) }.tap { |result| log_failure(name, 'suffix') unless result }
+    end
+
+    def characters_invalid?(name)
+      !name.match?(regex_permission).tap { |result| log_failure(name, 'character(s)') unless result }
+    end
+
+    def blacklisted?(name)
+      blacklisted_names.include?(name).tap { |result| log_failure(name, 'name (blacklisted entry)') unless result }
+    end
+
+    def regex_permission
+      /^[a-z]\w+$/
+    end
+
+    def prefix_blacklist
+      %w[
+        no_
+        _
+      ]
+    end
+
+    def suffix_blacklist
+      %w[
+        _
+        ?
+      ]
+    end
+
+    def blacklisted_names
+      %w[
+        attributes
+        html
+        no
+        title
+      ]
+    end
+
+    def log_failure(name, type)
+      SitePrism.logger.error("DSL item: #{name} has an invalid #{type}")
+      SitePrism.logger.debug(debug_error(type))
+    end
+
+    def debug_error(type)
+      case type
+      when 'prefix';       then "Invalid Prefixes: #{prefix_blacklist.join(', ')}."
+      when 'suffix';       then "Invalid Suffixes: #{suffix_blacklist.join(', ')}"
+      when 'character(s)'; then "Invalid DSL Names: #{blacklisted_names.join(', ')}"
+      else                      "DSL Charset REGEX: #{regex_permission.inspect}"
+      end
+    end
+  end
+end

data/lib/site_prism/element_checker.rb

@@ -28,7 +28,7 @@ module SitePrism
     def all_there?(recursion: :none)
       case recursion
       when :none; then elements_to_check.all? { |name| there?(name) }
-      when :one;  then all_there_with_recursion
+      when :one;  then SitePrism::AllThere::RecursionChecker.new(self).all_there?
       else
         SitePrism.logger.debug("Input value '#{recursion}'. Valid values are :none or :one.")
         SitePrism.logger.error('Invalid recursion setting, Will not run #all_there?.')
@@ -51,14 +51,6 @@ module SitePrism
 
     private
 
-    def all_there_with_recursion
-      if SitePrism.use_all_there_gem
-        SitePrism::AllThere::RecursionChecker.new(self).all_there?
-      else
-        RecursionChecker.new(self).all_there?
-      end
-    end
-
     # If the page or section has expected_items set, return expected_items that are mapped
     # otherwise just return the list of all mapped_items
     def elements_to_check

data/lib/site_prism/error.rb

@@ -8,50 +8,46 @@ module SitePrism
   class PageLoadError < SitePrismError; end
 
   # A page calls #load with no URL set
-  # Formerly known as `NoUrlForPage`
   class NoUrlForPageError < PageLoadError; end
 
   # A page calls #displayed? with no URL matcher set
-  # Formerly known as `NoUrlMatcherForPage`
   class NoUrlMatcherForPageError < PageLoadError; end
 
   # The URL matcher was not recognised as a Regex or String and as such
   # it couldn't be parsed by Addressable. It also could be caused by
   # the usage of templated port numbers - which aren't supported
-  # Formerly known as `InvalidUrlMatcher`
   class InvalidUrlMatcherError < PageLoadError; end
 
   # A SitePrism defined DSL item was defined without a selector
-  # Formerly known as `NoSelectorForElement`
   class InvalidElementError < SitePrismError; end
 
   # The condition that was being evaluated inside the block did not evaluate
   # to true within the time limit
-  # Formerly known as `TimeoutException`
   class TimeoutError < SitePrismError; end
 
   # The wait_until_*_visible meta-programmed method didn't evaluate to true
   # within the prescribed time limit
-  # Formerly known as `TimeOutWaitingForElementVisibility`
   class ElementVisibilityTimeoutError < TimeoutError; end
 
   # The wait_until_*_invisible meta-programmed method didn't evaluate to true
   # within the prescribed time limit
-  # Formerly known as `TimeOutWaitingForElementInvisibility`
   class ElementInvisibilityTimeoutError < TimeoutError; end
 
   # Generic Block validation family of errors inherit from this error
   class BlockError < SitePrismError; end
 
   # A Block was passed to the method, which it cannot interpret
-  # Formerly known as `UnsupportedBlock`
   class UnsupportedBlockError < BlockError; end
 
   # A Block was required, but not supplied
-  # Formerly known as `BlockMissingError`
   class MissingBlockError < BlockError; end
 
   # A page was loaded then failed one of the validations defined by the user
-  # Formerly known as `NotLoadedError`
   class FailedLoadValidationError < PageLoadError; end
+
+  # Generic Attribute validation family of errors inherit from this error
+  class AttributeValidationError < SitePrismError; end
+
+  # DSL items are not permitted to start with certain prefixes
+  class InvalidDSLNameError < AttributeValidationError; end
 end

data/lib/site_prism/loadable.rb

@@ -9,45 +9,6 @@ module SitePrism
   # Loadable's are primarily used with the `#load` method which will auto-execute them all
   # in their defined order. But they can be used dynamically wherever desired.
   module Loadable
-    module ClassMethods
-      # The list of load_validations.
-      # They will be executed in the order they are defined.
-      #
-      # @return [Array]
-      def load_validations
-        if superclass.respond_to?(:load_validations)
-          superclass.load_validations + _load_validations
-        else
-          _load_validations
-        end
-      end
-
-      # Appends a load validation block to the page 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.
-      #
-      # @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
-      def load_validation(&block)
-        _load_validations << block
-      end
-
-      private
-
-      def _load_validations
-        @_load_validations ||= []
-      end
-    end
-
     def self.included(base)
       base.extend(ClassMethods)
     end
@@ -106,5 +67,51 @@ module SitePrism
         passed
       end
     end
+
+    # [SitePrism::Loadable::ClassMethods]
+    # 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`
+    module ClassMethods
+      # The list of load_validations.
+      # They will be executed in the order they are defined.
+      #
+      # @return [Array]
+      def load_validations
+        if superclass.respond_to?(:load_validations)
+          superclass.load_validations + _load_validations
+        else
+          _load_validations
+        end
+      end
+
+      # Appends a load validation block to the page 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.
+      #
+      # @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
+      #
+      # @return [Proc]
+      def load_validation(&block)
+        _load_validations << block
+      end
+
+      private
+
+      def _load_validations
+        @_load_validations ||= []
+      end
+    end
   end
 end

data/lib/site_prism/page.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
 module SitePrism
+  # [SitePrism::Page]
+  #
+  # SitePrism Pages are the top level construct of the POM framework
+  #
+  # Instances of this class represent a full web page that can either be dynamically navigated to
+  # through clicking buttons or filling in fields, or verbosely loaded by using the `#load` method
+  #
+  # All method calls made whilst on a page are scoped using `#to_capybara_node` which defaults to the
+  # current Capybara session
   class Page
     include Capybara::DSL
     include ElementChecker
@@ -42,6 +51,11 @@ module SitePrism
       (defined?(@page) && @page) || Capybara.current_session
     end
 
+    # This scopes our calls inside Page correctly to the `Capybara::Session`
+    def to_capybara_node
+      page
+    end
+
     # Loads the page.
     # @param expansion_or_html
     # @param block [&block] An optional block to run once the page is loaded.

data/lib/site_prism/rspec_matchers.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module SitePrism
+  #
+  # @api private
+  #
   class RspecMatchers
     attr_reader :element_name
 

data/lib/site_prism/section.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
 module SitePrism
+  # [SitePrism::Section]
+  #
+  # SitePrism Sections are the mid level construct of the POM framework
+  #
+  # Instances of this class represent a a part of a web page that can either sit inside a SitePrism::Page
+  # or sit inside another N sections, which then eventually will sit inside a page
+  #
+  # All method calls made whilst on a page are scoped using `#to_capybara_node` which will be represented by
+  # the current `#root_element`. This is the locator for the section itself and is a mandatory argument
   class Section
     include ElementChecker
     include Loadable
@@ -55,8 +64,10 @@ module SitePrism
       root_element
     end
 
-    # This allows us to return anything thats passed in as a block to the section at
+    # This allows us to return anything that's passed in as a block to the section at
     # creation time, so that an anonymous section or such-like will have the extra methods
+    #
+    # This can also be used manually at runtime to allow people to abbreviate their calls
     def within
       Capybara.within(root_element) { yield(self) }
     end
@@ -64,11 +75,8 @@ module SitePrism
     # This was the old API-style of delegating through the Capybara.page call and over-loading
     # the method so we always went through our correct `root_element`
     def page
-      SitePrism::Deprecator.deprecate('Using page inside section')
-      return root_element if root_element
-
-      SitePrism.logger.warn('Root Element not found; Falling back to Capybara.current_session')
-      capybara_session
+      SitePrism.logger.fatal('This is not supposed to be used. All delegation now happens automatically!')
+      raise SitePrism::SitePrismError
     end
 
     def capybara_session

data/lib/site_prism/version.rb

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

data/lib/site_prism/waiter.rb

@@ -7,13 +7,13 @@ module SitePrism
     #
     # A looper that will wait until the passed in block evaluates to true
     # Alternatively it will time out once the wait_time is exceeded
-    def self.wait_until_true(wait_time = Capybara.default_max_wait_time)
+    def self.wait_until_true(wait_time = Capybara.default_max_wait_time, sleep_duration = 0.05)
       Timer.run(wait_time) do |timer|
         loop do
           return true if yield
           break if timer.done?
 
-          sleep(0.05)
+          sleep(sleep_duration)
         end
         raise SitePrism::TimeoutError, "Timed out after #{wait_time}s."
       end

data/lib/site_prism.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 require 'site_prism/error'
+require 'site_prism/all_there'
 require 'addressable/template'
+require 'forwardable'
 
 # [SitePrism] namespace
 # We autoload our files underneath here to provide a slightly more optimal load solution
 module SitePrism
   autoload :AddressableUrlMatcher, 'site_prism/addressable_url_matcher'
   autoload :DSL, 'site_prism/dsl'
+  autoload :DSLValidator, 'site_prism/dsl_validator'
   autoload :Deprecator, 'site_prism/deprecator'
   autoload :ElementChecker, 'site_prism/element_checker'
   autoload :Loadable, 'site_prism/loadable'
   autoload :Logger, 'site_prism/logger'
   autoload :Page, 'site_prism/page'
-  autoload :RecursionChecker, 'site_prism/recursion_checker'
   autoload :RspecMatchers, 'site_prism/rspec_matchers'
   autoload :Section, 'site_prism/section'
   autoload :Timer, 'site_prism/timer'
   autoload :Waiter, 'site_prism/waiter'
 
   class << self
-    attr_reader :use_all_there_gem
-
     def configure
       yield self
     end
@@ -72,13 +72,5 @@ module SitePrism
     def log_level
       %i[DEBUG INFO WARN ERROR FATAL UNKNOWN][logger.level]
     end
-
-    # Whether you wish to use the new experimental all_there dependent gem
-    #   This will be enforced from site_prism v4 onwards as this is where
-    #   the development of this functionality will be focused
-    def use_all_there_gem=(value)
-      logger.debug("Setting use_all_there_gem to #{value}")
-      @use_all_there_gem = value
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 4.0.beta
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -17,172 +17,144 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.15'
 - !ruby/object:Gem::Dependency
   name: site_prism-all_there
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.0
+        version: 1.28.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.0
+        version: 1.28.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.44.0
+        version: 2.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.44.0
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -203,14 +175,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
 description: SitePrism gives you a simple, clean and semantic DSL for describing your
   site. SitePrism implements the Page Object Model pattern on top of Capybara.
 email:
@@ -226,12 +198,12 @@ files:
 - lib/site_prism/addressable_url_matcher.rb
 - lib/site_prism/deprecator.rb
 - lib/site_prism/dsl.rb
+- lib/site_prism/dsl_validator.rb
 - lib/site_prism/element_checker.rb
 - lib/site_prism/error.rb
 - lib/site_prism/loadable.rb
 - lib/site_prism/logger.rb
 - lib/site_prism/page.rb
-- lib/site_prism/recursion_checker.rb
 - lib/site_prism/rspec_matchers.rb
 - lib/site_prism/section.rb
 - lib/site_prism/timer.rb
@@ -252,14 +224,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A Page Object Model DSL for Capybara

data/lib/site_prism/recursion_checker.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module SitePrism
-  class RecursionChecker
-    attr_reader :instance
-
-    private :instance
-
-    def initialize(instance)
-      @instance = instance
-    end
-
-    def all_there?
-      regular_items_all_there = expected_item_map.flatten.all? { |name| there?(name) }
-      return false unless regular_items_all_there
-
-      section_all_there =
-        section_classes_to_check.all?(&:all_there?)
-      return false unless section_all_there
-
-      # Returning this final check here is fine, as the previous two checks must
-      # have returned +true+ in order to hit this part of the method-call
-      sections_classes_to_check.all?(&:all_there?)
-    end
-
-    def expected_item_map
-      [
-        expected(mapped_items, :element),
-        expected(mapped_items, :elements),
-        expected(mapped_items, :section),
-        expected(mapped_items, :sections),
-        expected(mapped_items, :iframe)
-      ]
-    end
-
-    def expected(_map, type)
-      mapped_items[type].select { |name| elements_to_check.include?(name) }
-    end
-
-    def section_classes_to_check
-      expected_item_map[2].map { |name| instance.send(name) }
-    end
-
-    def sections_classes_to_check
-      expected_item_map[3].map { |name| instance.send(name) }.flatten
-    end
-
-    private
-
-    # If the page or section has expected_items set, return expected_items that are mapped
-    # otherwise just return the list of all mapped_items
-    def elements_to_check
-      if _expected_items
-        SitePrism.logger.debug('Expected Items has been set.')
-        _mapped_items.select { |name| _expected_items.include?(name) }
-      else
-        _mapped_items
-      end
-    end
-
-    def _mapped_items
-      mapped_items.values.flatten.uniq
-    end
-
-    def _expected_items
-      instance.class.expected_items
-    end
-
-    def there?(name)
-      instance.send("has_#{name}?")
-    end
-
-    def mapped_items
-      @mapped_items ||= instance.class.mapped_items(legacy: false)
-    end
-  end
-end