site_prism-all_there 0.2 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33b0ff10287854efb639165548ea3718efc57094ab5e0e1f11daf8ec7a0f58c6
-  data.tar.gz: 9257c12cd32806afeca3a0891754d942b3cfeac06dc62b082680bf2bac2ee9dd
+  metadata.gz: dfdb2e58753050c18dafb4f340680c2b0457eac8e14df383ea489f0d54d43732
+  data.tar.gz: 89adfcebffec1dcea1354ce4d34c2836d87346807569759ff5e5c7e9b151bdf8
 SHA512:
-  metadata.gz: 5a2603278f614090cd7ecca80d1baf2ae6cf4085eec044fbb68df527d89e1dcec8729e634b89b5fcf70f5eef28bcf529e4f8be60bedd5ef2905c002390f02a14
-  data.tar.gz: 4357d5ce9856f1e9b0193481d813e3f6aeb9189e1950ed5b212e219144b66b3307ab9a710fb5150e8d3711551b1c57faef52bed3a896395fd2ba46accd320951
+  metadata.gz: 2db1c79b4ed2c79920d4f230b494e6de494d6a476d8ba688e1bcac3993cb4cbf48a65e7b12eb65303e220016574bb497f2289b198d1b052635cce488799cb298
+  data.tar.gz: af7bc4602c1ac4e49da866a4f1ef75ac4a247c578f567d894936c100aa4b6be5ea23899a7e836df4fe7d28c1a548cdfe72199a24d225f4b5c7c8dc2250d9f2b6

data/README.md

@@ -1,17 +1,18 @@
 # site_prism-all_there
+
 The breakout gem from SitePrism to perform recursion checks for `#all_there?`
 
-This gem is currently being developed by copying over the code-base from the existing
-SitePrism repo and slowly refactoring it and breaking it out
+This gem is a breakout of the current `SitePrism::Page#all_there?` and `SitePrism::Section#all_there?`
+methods which already exist.
 
-As such at the moment, the gem is very much considered a Work in Progress and works "as is".
+At the moment, the gem is currently released as a `0.x` version meaning it is **not** fully API stable.
 
-It is fully expected to have a number of bug-fix / refactor PR's in between each minor release.
+## Usage
 
 Add the following code to either `spec_helper.rb` or `env.rb`
 
 ```rb
-require 'site_prism/all_there
+require 'site_prism/all_there'
 
 SitePrism.use_all_there_gem = true
 
@@ -22,8 +23,7 @@ SitePrism.configure do |config|
 end
 ```
 
-This gem is currently in the `0.x` phase, meaning it is API unstable and likely to change
-structure going forwards, to conform to the pairing of both gems.
+This gem is likely to change structure going forwards, to conform to the pairing of both gems, expected in 2020.
 
 Happy Testing / Developing!
 

data/lib/site_prism/all_there.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
+require 'site_prism/all_there/expected_items'
 require 'site_prism/all_there/mapped_items'
 require 'site_prism/all_there/recursion_checker'
 
-# Configure the behaviour of the site_prism-all_there gem
+# {SitePrism} namespace - In different folder to avoid namespace clashes with core gem
 module SitePrism
   class << self
-    # Configuration setting to use on a global scale
-    # Note this global setting can be overridden at runtime for each individual call
     attr_accessor :recursion_setting
 
     def configure
@@ -15,3 +14,8 @@ module SitePrism
     end
   end
 end
+
+module SitePrism
+  # {SitePrism::AllThere} namespace
+  module AllThere; end
+end

data/lib/site_prism/all_there/expected_items.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module SitePrism
+  module AllThere
+    #
+    # @api private
+    #
+    # The Expected Items to be present on a SitePrism Page or Section
+    class ExpectedItems
+      attr_reader :instance
+      private :instance
+
+      def initialize(instance)
+        @instance = instance
+      end
+
+      # @return [Array<Hash<Symbol>>]
+      # All expected mapped items
+      def array
+        [
+          element,
+          elements,
+          section,
+          sections,
+          iframe,
+        ]
+      end
+
+      # @return [Hash<Symbol>]
+      # All expected items that were mapped as +element+
+      def element
+        mapped_checklist_of(:element)
+      end
+
+      # @return [Hash<Symbol>]
+      # All expected items that were mapped as +elements+
+      def elements
+        mapped_checklist_of(:elements)
+      end
+
+      # @return [Hash<Symbol>]
+      # All expected items that were mapped as +section+
+      def section
+        mapped_checklist_of(:section)
+      end
+
+      # @return [Hash<Symbol>]
+      # All expected items that were mapped as +sections+
+      def sections
+        mapped_checklist_of(:sections)
+      end
+
+      # @return [Hash<Symbol>]
+      # All expected items that were mapped as +iframe+
+      def iframe
+        mapped_checklist_of(:iframe)
+      end
+
+      private
+
+      def mapped_checklist_of(type)
+        mapped_items.hash[type].select { |name| mapped_checklist.include?(name) }
+      end
+
+      def mapped_checklist
+        if checklist
+          SitePrism.logger.debug('Expected Items has been set.')
+          mapped_items.array.select { |name| checklist.include?(name) }
+        else
+          mapped_items.array
+        end
+      end
+
+      def checklist
+        instance.class.expected_items
+      end
+
+      def mapped_items
+        @mapped_items ||= MappedItems.new(instance)
+      end
+    end
+  end
+end

data/lib/site_prism/all_there/mapped_items.rb

@@ -2,10 +2,10 @@
 
 module SitePrism
   module AllThere
-    # Returns the Mapped Items on a specific SitePrism object
     #
-    # api private
+    # @api private
     #
+    # The Expected Items on a SitePrism Page or Section structured in an enumerable way
     class MappedItems
       attr_reader :instance
       private :instance
@@ -14,12 +14,14 @@ module SitePrism
         @instance = instance
       end
 
-      # All Mapped items on the SitePrism instance as a Symbol Array
+      # @return [Array<Symbol>]
+      # All expected mapped items on the SitePrism instance as a Symbol Array
       def array
         hash.values.flatten.uniq
       end
 
-      # All Mapped items on the SitePrism instance as a Symbol Hash
+      # @return [Hash<Symbol>]
+      # All expected mapped items on the SitePrism instance as a Symbol Hash
       def hash
         instance.class.mapped_items(legacy: false)
       end

data/lib/site_prism/all_there/recursion_checker.rb

@@ -12,7 +12,8 @@ module SitePrism
         @instance = instance
       end
 
-      # This is currently hard-coded to perform a recursion of depth +:one+
+      # @return [Boolean]
+      # 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)
@@ -27,61 +28,40 @@ module SitePrism
 
       private
 
-      # This will check all elements that are in the current scope
-      # This is equivalent to checking with a recursion value of +:none+
+      # @return [Boolean]
+      # Are all SitePrism objects that exist in +self+ present?
       def current_class_all_there?
-        expected_item_map.flatten.all? { |name| there?(name) }
+        expected_items.array.flatten.all? { |name| there?(name) }.tap do |result|
+          SitePrism.logger.info("Result of current_class_all_there?: #{result}")
+        end
       end
 
-      # This will check all elements that are in any of the individual
-      # +section+ items defined in the current scope
+      # @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?)
+        section_classes_to_check.all?(&:all_there?).tap do |result|
+          SitePrism.logger.debug("Result of section_classes_all_there?: #{result}")
+        end
       end
 
-      # This will check all elements that are in any instance of any of the
-      # +sections+ items defined in the current scope
+      # @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?)
+        sections_classes_to_check.flatten.all?(&:all_there?).tap do |result|
+          SitePrism.logger.debug("Result of section_classes_all_there?: #{result}")
+        end
       end
 
       def section_classes_to_check
-        expected_item_map[2].map { |name| instance.send(name) }
+        expected_items.section.map { |name| instance.send(name) }
       end
 
       def sections_classes_to_check
-        expected_item_map[3].map { |name| instance.send(name) }
-      end
-
-      def expected_item_map
-        [
-          expected(:element),
-          expected(:elements),
-          expected(:section),
-          expected(:sections),
-          expected(:iframe),
-        ]
-      end
-
-      def expected(type)
-        MappedItems.new(instance).hash[type].select { |name| elements_to_check.include?(name) }
-      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
-        if _expected_items
-          SitePrism.logger.debug('Expected Items has been set.')
-          MappedItems.new(instance).array.select do |name|
-            _expected_items.include?(name)
-          end
-        else
-          MappedItems.new(instance).array
-        end
+        expected_items.sections.map { |name| instance.send(name) }
       end
 
-      def _expected_items
-        instance.class.expected_items
+      def expected_items
+        @expected_items ||= ExpectedItems.new(instance)
       end
 
       def there?(name)

data/lib/site_prism/all_there/version.rb

@@ -2,6 +2,8 @@
 
 module SitePrism
   module AllThere
-    VERSION = '0.2'
+    # @return [String]
+    # Version of the gem
+    VERSION = '1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_prism-all_there
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '1.0'
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,70 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: site_prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.9'
 description: |-
   SitePrism AllThere gives you a simple DSL in order to recursively query,
   page/section/element structures on your page - exclusively for use with the SitePrism gem.
@@ -92,6 +120,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/site_prism/all_there.rb
+- lib/site_prism/all_there/expected_items.rb
 - lib/site_prism/all_there/mapped_items.rb
 - lib/site_prism/all_there/recursion_checker.rb
 - lib/site_prism/all_there/version.rb
@@ -100,7 +129,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/site-prism/site_prism-all_there/issues
-  changelog_uri: https://github.com/site-prism/site_prism-all_there/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/site-prism/site_prism-all_there/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/site-prism/site_prism-all_there
 post_install_message: 
 rdoc_options: []
@@ -110,15 +139,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: An extension to allow you to recurse through your SitePrism Pages/Sections