site_prism-all_there 2.0.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbdb3fd1e22f9f832cb21e808f77a1c0c236f25442874f692df69bb0d1437367
-  data.tar.gz: b98ec38bc16d1f410dc1584ced388a451856295660a9492d64a2b789cd450153
+  metadata.gz: 459330ae52be38a3c956befae04407c7752e2de0572117e905b93f2006541f96
+  data.tar.gz: bc70cd8a9754101ed16089d404c1ab51b6880eaa83fc4d6f842fc36d1c4628b7
 SHA512:
-  metadata.gz: b068d588ecb66eae71bb7a5bca3ed990b6f38a7c5b6a6b617edab27f63666a2bfb7a6afd21c07f362cfbcc4930a2ce6b4b1dd6abb724927793f5f2438ba2602a
-  data.tar.gz: 0fa5d87ac1f7aa303dac2754eb3b6303522bfb5ba0b70772e971207f8a0da0621e606f7243c8db2f6065df0d22fc2202d2d31d998606dc3cdc0201710c8a8216
+  metadata.gz: 6825eebebda6309ce4ae31783ebac11e49614763415c0816c7c8645739bbcd6260cd219e6292a980cb4b7f7984239abdc2f6368d892dba1ae1045a4a15ec7928
+  data.tar.gz: 90a30f1610bdf40dea8f3d6640ee3f6aa9d9353fc78a6db1a69834cae9f3181bf63ea09b7be09de8fdc0f271c7534d85ffbf598d6ae14df374abfd2b80dfe0f5

data/lib/site_prism/all_there/expected_items.rb

@@ -19,48 +19,30 @@ module SitePrism
       # All defined/expected mapped items
       def array
         [
-          element,
-          elements,
+          mapped_checklist_of(:element),
+          mapped_checklist_of(:elements),
           section,
           sections,
-          iframe
+          mapped_checklist_of(:iframe)
         ]
       end
 
-      # @return [Array<Symbol>]
-      # All defined/expected items that were mapped as +element+
-      def element
-        mapped_checklist_of(:element) || []
-      end
-
-      # @return [Array<Symbol>]
-      # All defined/expected items that were mapped as +elements+
-      def elements
-        mapped_checklist_of(:elements) || []
-      end
-
       # @return [Array<Symbol>]
       # All defined/expected items that were mapped as +section+
       def section
-        mapped_checklist_of(:section) || []
+        mapped_checklist_of(:section)
       end
 
       # @return [Array<Symbol>]
       # All defined/expected items that were mapped as +sections+
       def sections
-        mapped_checklist_of(:sections) || []
-      end
-
-      # @return [Array<Symbol>]
-      # All defined/expected items that were mapped as +iframe+
-      def iframe
-        mapped_checklist_of(:iframe) || []
+        mapped_checklist_of(:sections)
       end
 
       private
 
       def mapped_checklist_of(type)
-        mapped_items.hash[type]&.select { |name| mapped_checklist.include?(name) }
+        mapped_items.hash[type] & mapped_checklist
       end
 
       def mapped_checklist

data/lib/site_prism/all_there/mapped_items.rb

@@ -10,6 +10,8 @@ module SitePrism
     class MappedItems
       attr_reader :hash
 
+      # @return [Hash]
+      # Return a list of all mapped items on a SitePrism class instance (Page or Section)
       def initialize(instance)
         @hash = instance.class.mapped_items
       end

data/lib/site_prism/all_there/recursion_checker.rb

@@ -3,8 +3,9 @@
 module SitePrism
   module AllThere
     #
-    # This will recurse through all of the objects found on an individual Page/Section level
+    # @api private
     #
+    # 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
@@ -15,40 +16,39 @@ module SitePrism
         @instance = instance
       end
 
-      # @return [Boolean]
-      # This currently defaults to perform a recursion of depth +:one+ (From the main `site_prism` gem)
-      # It will be refactored to use either no input, +:none+, or +:one+ as the regular repo uses currently
-      def all_there?(recursion:)
-        recursion = SitePrism.recursion_setting if SitePrism.recursion_setting
+      # @return [Boolean || Nil]
+      # This is only meant to be invoked from the main site_prism gem where it will use whatever inputs it is given
+      def all_there?(recursion: nil, options: {})
+        setting = recursion || SitePrism.recursion_setting
 
-        case recursion
-        when :none
-          current_class_all_there?
+        case setting
+        when nil, :none
+          current_class_all_there?(**options)
         when :one
-          current_class_all_there? && section_classes_all_there? && sections_classes_all_there?
+          current_class_all_there?(**options) && section_classes_all_there?(**options) && sections_classes_all_there?(**options)
         else
-          SitePrism.logger.debug("Input value '#{recursion}'. Valid values are :none or :one.")
+          SitePrism.logger.debug("Invalid input value '#{recursion}'. Valid values are nil, :none or :one.")
           SitePrism.logger.error('Invalid recursion setting, Will not run #all_there?.')
         end
       end
 
       private
 
-      def current_class_all_there?
-        expected_items.array.flatten.all? { |name| there?(name) }.tap do |result|
+      def current_class_all_there?(**opts)
+        expected_items.array.flatten.all? { |name| there?(name, **opts) }.tap do |result|
           SitePrism.logger.info("Result of current_class_all_there?: #{result}")
         end
       end
 
-      def section_classes_all_there?
-        section_classes_to_check.all?(&:all_there?).tap do |result|
+      def section_classes_all_there?(**opts)
+        section_classes_to_check.all? { |section| section.all_there?(**opts) }.tap do |result|
           SitePrism.logger.debug("Result of section_classes_all_there?: #{result}")
         end
       end
 
-      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}")
+      def sections_classes_all_there?(**opts)
+        sections_classes_to_check.flatten.all? { |section| section.all_there?(**opts) }.tap do |result|
+          SitePrism.logger.debug("Result of sections_classes_all_there?: #{result}")
         end
       end
 
@@ -64,8 +64,8 @@ module SitePrism
         @expected_items ||= ExpectedItems.new(instance)
       end
 
-      def there?(name)
-        instance.send("has_#{name}?")
+      def there?(name, **opts)
+        instance.send("has_#{name}?", **opts)
       end
     end
   end

data/lib/site_prism/all_there/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_prism-all_there
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.1
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: 1.56.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: 1.56.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 1.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 2.23.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 2.23.2
 - !ruby/object:Gem::Dependency
   name: site_prism
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="