site_prism 4.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42324a6a59bf20f2c35c519c130d94e314c5170b47ddf1c9f1d3faae98238d7
-  data.tar.gz: d17845d3b0131de25848bf85b86a7c696ef1160bdc4cf759bd43958d56742d00
+  metadata.gz: de1db2cfa8b40510768bbea0bee96e548ae949149428d669e1a038c83e2b7f8d
+  data.tar.gz: 3862848b777a9fbafb8c1640df914313b6deac6da942a3859ff2dfe6dbafb214
 SHA512:
-  metadata.gz: 7e09efb630b6f8270c7c8bb23c9db92bcccaa09e54c0a7e9ef1a6f2a645f47d821bf912141588ccec1bb3c6aea73f181ff6c8e5b771116f84936d10f95e714ab
-  data.tar.gz: d1dee7191ea9c01a8cc03e0726ae55ec1de91fe1d9bbb0f6db73e0c6b8af261d598b59d4d1be54e0589e481613b40e574f0d406ac1242d6a2e4cd46a9480c08c
+  metadata.gz: 8deff2edc00b2b4c0fab86c96e10bc184ed2afc8276b7daf9f69b97a9f7ab4b105ece138f6901456d76e57d508f546971f0262e6cec90787e64ea89bac904047
+  data.tar.gz: 505eb15872469490ab314497737e04eda896f14e7b98c631efae658d42eedb09d8a8aefa53fd5d845fa0a11936951aaf5cd9e6bc99563b4f454251eb212126d9

data/lib/site_prism/addressable_url_matcher.rb

@@ -15,7 +15,8 @@ module SitePrism
       @pattern = pattern
     end
 
-    # @return the hash of extracted mappings from
+    # @return Hash
+    #
     # parsing the provided URL according to our pattern,
     # or nil if the URL doesn't conform to the matcher template.
     def mappings(url)
@@ -30,6 +31,8 @@ module SitePrism
       result
     end
 
+    # @return Boolean
+    #
     # Determine whether URL matches our pattern, and
     # optionally whether the extracted mappings match
     # a hash of expected values.  You can specify values
@@ -38,21 +41,24 @@ module SitePrism
       actual_mappings = mappings(url)
       return false unless actual_mappings
 
-      expected_mappings.empty? ||
-        all_expected_mappings_match?(expected_mappings, actual_mappings)
+      expected_mappings.empty? || all_expected_mappings_match?(expected_mappings, actual_mappings)
     end
 
     private
 
-    def all_expected_mappings_match?(expected_mappings, actual_mappings)
-      expected_mappings.all? do |key, expected_value|
-        actual_value = actual_mappings[key.to_s]
-        case expected_value
-        when Numeric; then actual_value == expected_value.to_s
-        when Regexp;  then actual_value.match(expected_value)
-        else               expected_value == actual_value
-        end
-      end
+    def component_matches(component, uri)
+      component_template = component_templates[component]
+      return {} unless component_template
+
+      component_url = uri.public_send(component).to_s
+      mappings = component_template.extract(component_url)
+      return mappings if mappings
+
+      # To support Addressable's expansion of queries - ensure it's parsing the fragment as appropriate (e.g. {?params*})
+      prefix = component_prefixes[component]
+      return nil unless prefix
+
+      component_template.extract(prefix + component_url)
     end
 
     def component_templates
@@ -73,27 +79,6 @@ module SitePrism
       end
     end
 
-    # Returns empty hash if the template omits the component or a set of
-    # substitutions if the provided URI component matches the template
-    # component or nil if the match fails.
-    def component_matches(component, uri)
-      component_template = component_templates[component]
-      return {} unless component_template
-
-      component_url = uri.public_send(component).to_s
-      mappings = component_template.extract(component_url)
-      return mappings if mappings
-
-      # to support Addressable's expansion of queries
-      # ensure it's parsing the fragment as appropriate (e.g. {?params*})
-      prefix = component_prefixes[component]
-      return nil unless prefix
-
-      component_template.extract(prefix + component_url)
-    end
-
-    # Convert the pattern into an Addressable URI by substituting
-    # the template slugs with nonsense strings.
     def to_substituted_uri
       url = pattern
       substitutions.each_pair { |slug, value| url = url.sub(slug, value) }
@@ -105,13 +90,6 @@ module SitePrism
       end
     end
 
-    def substitutions
-      @substitutions ||= slugs.each_with_index.reduce({}) do |memo, slug_index|
-        slug, index = slug_index
-        memo.merge(slug => slug_prefix(slug) + substitution_value(index))
-      end
-    end
-
     def reverse_substitutions
       @reverse_substitutions ||=
         slugs.each_with_index.reduce({}) do |memo, slug_index|
@@ -127,6 +105,24 @@ module SitePrism
       pattern.scan(/{[^}]+}/)
     end
 
+    def all_expected_mappings_match?(expected_mappings, actual_mappings)
+      expected_mappings.all? do |key, expected_value|
+        actual_value = actual_mappings[key.to_s]
+        case expected_value
+        when Numeric; then actual_value == expected_value.to_s
+        when Regexp;  then actual_value.match(expected_value)
+        else               expected_value == actual_value
+        end
+      end
+    end
+
+    def substitutions
+      @substitutions ||= slugs.each_with_index.reduce({}) do |memo, slug_index|
+        slug, index = slug_index
+        memo.merge(slug => slug_prefix(slug) + substitution_value(index))
+      end
+    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 this prefix as part of
     # the substituted slug so that Addressable's URI parser can see it as such.
@@ -135,8 +131,7 @@ module SitePrism
       (prefix && prefix[1]) || ''
     end
 
-    # Generate a repeatable 5 character uniform alphabetical nonsense string
-    # to allow parsing as a URI
+    # Generate a repeatable 5 character uniform alphabetical nonsense string to allow parsing as a URI
     def substitution_value(index)
       sha = Digest::SHA1.digest(index.to_s)
       Base64.urlsafe_encode64(sha).gsub(/[^A-Za-z]/, '')[0..5]

data/lib/site_prism/deprecator.rb

@@ -27,9 +27,9 @@ module SitePrism
       # 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 configurable.")
+        debug("The #{old} method is changing, as is SitePrism, and is now advised to be changed.")
         debug("REASON: #{reason}.")
-        debug('Moving forwards into SitePrism v4, the default behaviour will change.')
+        debug('Moving forwards into SitePrism v5, the default behaviour will change.')
         debug("We advise you change to using #{new}") if new
       end
 

data/lib/site_prism/dsl.rb

@@ -267,11 +267,13 @@ module SitePrism
       end
 
       def legacy_mapped_items
-        SitePrism::Deprecator.deprecate(
-          '.mapped_items structure (internally), on a class',
-          'Thew new .mapped_items structure'
-        )
-        @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)

data/lib/site_prism/element_checker.rb

@@ -13,10 +13,16 @@ module SitePrism
     # for how the definition of "every item" is derived.
     #
     # Example
-    # @my_page.mapped_items
-    # { element => :button_one, element => :button_two, section => :filters }
+    # @my_page.class.mapped_items
+    #  {
+    #    element => [:button_one, :button_two],
+    #    elements => [:button_collection_one, :button_collection_two],
+    #    section => [:filters],
+    #    sections => [:search_result],
+    #    iframe => []
+    #  }
     # @my_page.all_there?
-    # => true - If the three items above are all present
+    # => true - If the items above are all present
     #
     # Note that #elements_to_check will check the hash of mapped_items
     #

data/lib/site_prism/page.rb

@@ -48,8 +48,10 @@ module SitePrism
     #
     # @return [Capybara::Node::Simple || Capybara::Session]
     def page
-      SitePrism::Deprecator.deprecate('Calling #page on a SitePrism::Page instance')
-      (defined?(@page) && @page) || Capybara.current_session
+      @_page ||= begin
+        SitePrism::Deprecator.deprecate('Calling #page on a SitePrism::Page instance')
+        to_capybara_node
+      end
     end
 
     # This scopes our calls inside Page correctly to the `Capybara::Session`

data/lib/site_prism/timer.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
 module SitePrism
-  # [SitePrism::Timer]
   #
-  # Used to count asynchronously towards an overall desired duration or condition (Block)
+  # @api private
+  #
   class Timer
     attr_reader :wait_time
 
-    # Count towards a specified time (Supplied)
-    #
-    # @return [Proc]
     def self.run(wait_time, &block)
       new(wait_time).run(&block)
     end
@@ -19,16 +16,10 @@ module SitePrism
       @done = false
     end
 
-    # Whether the timer has completed
-    #
-    # @return [Boolean]
     def done?
       @done == true
     end
 
-    # Start the Timer and re-evaluate the block repeatedly
-    #
-    # @return [Proc]
     def run
       start
       yield self
@@ -36,9 +27,8 @@ module SitePrism
       stop
     end
 
-    # Start the Timer in a separate process
-    #
-    # Return [True]
+    private
+
     def start
       stop
       return if wait_time.zero?
@@ -50,9 +40,6 @@ module SitePrism
       end
     end
 
-    # Forcibly stop the timer, and kill any threads created by it
-    #
-    # Return [True]
     def stop
       if @thread
         @thread.kill

data/lib/site_prism/version.rb

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

data/lib/site_prism.rb

@@ -2,25 +2,25 @@
 
 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 :RSpecMatchers, 'site_prism/rspec_matchers'
-  autoload :Section, 'site_prism/section'
-  autoload :Timer, 'site_prism/timer'
-  autoload :Waiter, 'site_prism/waiter'
+require 'site_prism/addressable_url_matcher'
+require 'site_prism/dsl'
+require 'site_prism/dsl_validator'
+require 'site_prism/deprecator'
+require 'site_prism/element_checker'
+require 'site_prism/loadable'
+require 'site_prism/logger'
+require 'site_prism/page'
+require 'site_prism/rspec_matchers'
+require 'site_prism/section'
+require 'site_prism/timer'
+require 'site_prism/waiter'
 
+# [SitePrism]
+module SitePrism
   class << self
     def configure
       yield self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '4.0'
+  version: 4.0.1
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -107,28 +107,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.0
+        version: 2.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.0
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -161,22 +161,16 @@ dependencies:
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.0'
 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: