site_prism-all_there 2.0.1 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c5d744ba8f905404ca0528296024d8cde291be2e7608d2c50202c74990edbe
-  data.tar.gz: 6f10c96510f93848b8ecb2088fb344c28d89a0e0059e686811dd076777d14e05
+  metadata.gz: 3508b03f4e5a02c0dd04ec670549bd2462b9c749de74373747ced1c10d2b1e5d
+  data.tar.gz: 198324b39aa2eb29bb622028e383446043dbd9f8352f545d78e3dd0f35dfc26f
 SHA512:
-  metadata.gz: e8a8ec5769a6a32eb9b8c7475544a3d39491e35d4f30b38418e3b8eb59f5daa8b3de8a98ae0bb0d2aa8aa51166a53902db5d41d70750a76493c028c088ae9cdb
-  data.tar.gz: d1d7abc5f369069f99681c8488aa1ee500c1ffdaf41702a7496b3292eff9769e8ddf5e11c4261b146691051f0b40ca8df8debb168ec486be5557ed1d6c17daa6
+  metadata.gz: 1bf75250e248cb6b07c69d88bf7742e79eb31bf6a8d8565d58587dfe93994bbcb292077182035c9d233b2c8e502bf366106003263d3e835120e3ee444f5e0d93
+  data.tar.gz: 4a92b0b0d433de1717634d3dcb32ebadce9ce492dfc69cd8efa9f00cf0c65d505615555400d731a323b0a7a2df567755847ba8f5426f1de58b4604124f12d104

data/lib/site_prism/all_there/expected_items.rb

@@ -19,63 +19,41 @@ 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
-        if expected_items
+        if instance.class.expected_items
           SitePrism.logger.debug('Expected Items has been set.')
-          mapped_items.array.select { |name| expected_items.include?(name) }
+          mapped_items.array & instance.class.expected_items
         else
           mapped_items.array
         end
       end
 
-      def expected_items
-        instance.class.expected_items
-      end
-
       def mapped_items
         @mapped_items ||= MappedItems.new(instance)
       end

data/lib/site_prism/all_there/mapped_items.rb

@@ -8,11 +8,12 @@ module SitePrism
     # The Expected Items on a SitePrism Page or Section structured in an enumerable way
     #
     class MappedItems
-      attr_reader :instance
-      private :instance
+      attr_reader :hash
 
+      # @return [Hash]
+      # Return a list of all mapped items on a SitePrism class instance (Page or Section)
       def initialize(instance)
-        @instance = instance
+        @hash = instance.class.mapped_items
       end
 
       # @return [Array<Symbol>]
@@ -20,12 +21,6 @@ module SitePrism
       def array
         hash.values.flatten.uniq
       end
-
-      # @return [Hash<Symbol>]
-      # All expected mapped items on the SitePrism instance as a Symbol Hash
-      def hash
-        instance.class.mapped_items
-      end
     end
   end
 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.1'
+    VERSION = '3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_prism-all_there
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: '3.0'
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -125,14 +125,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: An extension to allow you to recurse through your SitePrism Pages/Sections