site_prism-all_there 1.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5f8bcaddc7bda74aa9d9da8b7c8fdc302a5ab558e873bb0709886eeb172d30a
-  data.tar.gz: 72e50de6892de244daa9f073db6a97e0c0b7f633e8fa33d540f8a49576307ec0
+  metadata.gz: 376c04f51a8a815bae55f513721968bf3069c6fdc0f7f4685eaed8f05240f131
+  data.tar.gz: 3d181c424334f8c7be4749bc7f381508b4a9ea8f27aaa8ce74fcb817b7d6cad4
 SHA512:
-  metadata.gz: 00f2faaff2b43479484dd45fb2f5638964e202af40f9584101bc8956f07da8122625beb213f62300bcbe02a44a29bdb1ca11fe9c40a3512e6bb1473069772e1a
-  data.tar.gz: 38a66bd748671fe71e20f5bd4da0934ac25db52b4d59870b84b7d9458c86435f29f40420a40c48b2bfc3dcf3f1f3b0a9ecc7485e3fc3a2b442c78a32ea2899ed
+  metadata.gz: c12c252c431577beb45a46a895a891e486f583293f860711c3ad5fc405b05a24db55e498e1892c294a37eab9c580806a9c6660eb6438092985a7291534e495c5
+  data.tar.gz: 6024f46050a28a69fbffcfa40d763899abe0c3a7d10cbb9e32405eef14b0acfc2a6643c86560e416f6162a56e623cb5f6776337ccf6814cd0a40997cfaff4c4d

data/LICENSE.md

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

data/README.md

@@ -1,17 +1,24 @@
 # site_prism-all_there
+- [History](#history)
+- [Enabling gem methods](#enabling-gem-methods)
+- [Usage](#usage)
+  - [In-line configuration](#in-line-configuration)
+  - [Global configuration](#global-configuration)
+- [Troubleshooting](#troubleshooting)
 
-The breakout gem from SitePrism to perform recursion checks for `#all_there?`
+## History
+
+This in the breakout gem from SitePrism to perform recursion checks for `#all_there?`
 
 This gem is a breakout of the current `SitePrism::Page#all_there?` and `SitePrism::Section#all_there?`
-methods which already exist in the core gem proper.
+methods which have already existed in the gem since version 2.
 
-The gem is currently released as `1.0.1` meaning it is version stable. It will be added as default
+The gem is **now finally** version stable. It will be added as default
 functionality in `site_prism` version 4. Which is slated for release early 2023!
 
-## Usage
+## Enabling gem methods
 
 - Add the following code to either `spec_helper.rb` or `env.rb` (Pre version 4)
-- From version 4 onwards this is done by default and isn't required
 
 ```rb
 require 'site_prism/all_there'
@@ -20,11 +27,50 @@ SitePrism.use_all_there_gem = true
 
 # or...
 
+require 'site_prism/all_there'
+
 SitePrism.configure do |config|
   config.use_all_there_gem = true
 end
 ```
 
+> From version 4 onwards this is done by default and isn't required
+
+## Usage
+
+### In-line configuration
+
+```rb
+your_page = YourPage.new
+
+your_page.all_there?(recursion: :none)     # This will do the standard `#all_there?` check on the current page
+your_page.all_there?(recursion: :one)      # This will do the standard `#all_there?` check on the current page as well recursing into all `:section` or `:sections` objects and then doing the standard `#all_there?` check on those `Section` instances
+your_page.all_there?(recursion: :invalid)  # This will not perform any checks and just throw an error message
+```
+
+### Global configuration
+
+```rb
+SitePrism.recursion_setting = :one
+your_page = YourPage.new
+your_page.all_there?(recursion: :ignore) # This will do the standard `#all_there?` check on the current page as well recursing into all `:section` or `:sections` objects and then doing the standard `#all_there?` check on those sections
+
+# or...
+
+SitePrism.configure do |config|
+  config.recursion_setting = :one
+end
+
+your_page = YourPage.new
+your_page.all_there?(recursion: :ignore) # This will do the standard `#all_there?` check on the current page as well recursing into all `:section` or `:sections` objects and then doing the standard `#all_there?` check on those `Section` instances
+```
+
+Then you can perform the above checks using the global config.
+
+## Troubleshooting
+
+Mixing and matching the global config won't work - To come in v3!
+
 Happy Testing / Developing!
 
 The SitePrism team

data/lib/site_prism/all_there/expected_items.rb

@@ -6,6 +6,7 @@ module SitePrism
     # @api private
     #
     # The Expected Items to be present on a SitePrism Page or Section
+    #
     class ExpectedItems
       attr_reader :instance
       private :instance
@@ -15,7 +16,7 @@ module SitePrism
       end
 
       # @return [Array<Array<Symbol>>]
-      # All expected mapped items
+      # All defined/expected mapped items
       def array
         [
           element,
@@ -27,31 +28,31 @@ module SitePrism
       end
 
       # @return [Array<Symbol>]
-      # All expected items that were mapped as +element+
+      # All defined/expected items that were mapped as +element+
       def element
         mapped_checklist_of(:element) || []
       end
 
       # @return [Array<Symbol>]
-      # All expected items that were mapped as +elements+
+      # All defined/expected items that were mapped as +elements+
       def elements
         mapped_checklist_of(:elements) || []
       end
 
       # @return [Array<Symbol>]
-      # All expected items that were mapped as +section+
+      # All defined/expected items that were mapped as +section+
       def section
         mapped_checklist_of(:section) || []
       end
 
       # @return [Array<Symbol>]
-      # All expected items that were mapped as +sections+
+      # All defined/expected items that were mapped as +sections+
       def sections
         mapped_checklist_of(:sections) || []
       end
 
       # @return [Array<Symbol>]
-      # All expected items that were mapped as +iframe+
+      # All defined/expected items that were mapped as +iframe+
       def iframe
         mapped_checklist_of(:iframe) || []
       end

data/lib/site_prism/all_there/mapped_items.rb

@@ -6,6 +6,7 @@ module SitePrism
     # @api private
     #
     # The Expected Items on a SitePrism Page or Section structured in an enumerable way
+    #
     class MappedItems
       attr_reader :instance
       private :instance

data/lib/site_prism/all_there/recursion_checker.rb

@@ -2,8 +2,11 @@
 
 module SitePrism
   module AllThere
-    # Recurse through all of the objects found on an individual Page/Section
-    # Perform the all_there? check according to what recursion level is specified
+    #
+    # This will recurse through all of the objects found on an individual Page/Section level
+    #
+    # It will perform the `#all_there?` check on each `@instance` item that it is initialized with
+    #
     class RecursionChecker
       attr_reader :instance
       private :instance
@@ -16,36 +19,34 @@ module SitePrism
       # This currently defaults to perform a recursion of depth +:one+
       # It will be refactored to use either no input, +:none+, or +:one+ as the
       # regular repo uses currently
-      def all_there?(recursion: :one)
-        if recursion == :one || SitePrism.recursion_setting == :one
-          current_class_all_there? &&
-            section_classes_all_there? &&
-            sections_classes_all_there?
-        else
+      def all_there?(recursion:)
+        recursion = SitePrism.recursion_setting if SitePrism.recursion_setting
+
+        case recursion
+        when :none
           current_class_all_there?
+        when :one
+          current_class_all_there? && section_classes_all_there? && sections_classes_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?.')
         end
       end
 
       private
 
-      # @return [Boolean]
-      # Are all SitePrism objects that exist in +self+ present?
       def current_class_all_there?
         expected_items.array.flatten.all? { |name| there?(name) }.tap do |result|
           SitePrism.logger.info("Result of current_class_all_there?: #{result}")
         end
       end
 
-      # @return [Boolean]
-      # Are all SitePrism objects that exist in all +self.section+ items present?
       def section_classes_all_there?
         section_classes_to_check.all?(&:all_there?).tap do |result|
           SitePrism.logger.debug("Result of section_classes_all_there?: #{result}")
         end
       end
 
-      # @return [Boolean]
-      # Are all SitePrism objects that exist in all +self.sections+ items present?
       def sections_classes_all_there?
         sections_classes_to_check.flatten.all?(&:all_there?).tap do |result|
           SitePrism.logger.debug("Result of section_classes_all_there?: #{result}")

data/lib/site_prism/all_there/version.rb

@@ -4,6 +4,6 @@ module SitePrism
   module AllThere
     # @return [String]
     # Version of the gem
-    VERSION = '1.1'
+    VERSION = '2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_prism-all_there
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '2.0'
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.39.0
+        version: 1.47.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.39.0
+        version: 1.47.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.1
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.1
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.15.0
+        version: 2.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.15.0
+        version: 2.17.1
 - !ruby/object:Gem::Dependency
   name: site_prism
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: An extension to allow you to recurse through your SitePrism Pages/Sections