site_prism-all_there 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8336dc1b0631ca12cefaac99dbcc056d4f3711670647848f5d8a9d98e5bd17c
-  data.tar.gz: 61f56cfd1073989ae922c244236d732fce4395053db7e9ac05e500834da290c5
+  metadata.gz: 13d340b7a35050d9497c7f8f581bdd9fd52e2e1de277dc8898160f00d589b116
+  data.tar.gz: 63f61f0accbe52abb0037aeb77d9f4a3f290281f0257e261520e20499beb5298
 SHA512:
-  metadata.gz: c40aa2a060d407a3f38781627a3d8ca5294025add8b05a7118896a574835144e4835a2394cc51988435b0937882271c6cadb4d4f69fb7c9d87d851846b6461b9
-  data.tar.gz: 96eeb9d5e0fbc82042bff60f88e4146581cad2329a135ec2179aff4c6d5b53ba271b87f3648b65670903c600d475d913957485b950b33b18d4e8ff7d95ff9880
+  metadata.gz: 82a6b3eaa4873687a697e2f969cf85b20c74ffb72fe84572a47ee37f076a1e5a26868f8be48c6aefce3ac42888d079d846a10cb84eb5eeca6f345c53a2684841
+  data.tar.gz: 952de2d7fb8aafef01786dadd9e3bc329d0d278fe660fab4835a1f2f085cdc9558ae1ff398c85d60dd2cf72567ed4ed3df605aef641f7da8145ba538fc7a3f59

data/LICENSE.md

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

data/README.md

@@ -1,2 +1,34 @@
 # site_prism-all_there
-The breakout gem from SitePrism to perform recursion checks for 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
+
+As such at the moment, the gem is very much considered a Work in Progress and works "as is".
+
+It is fully expected to have a number of bug-fix / refactor PR's in between each minor release.
+
+In order to use this gem you simply need to do the following
+
+```rb
+# In either spec_helper.rb or env.rb
+
+require 'site_prism/all_there
+
+# Then in either a config or initializer location (Or env.rb / spec_helper.rb)
+
+SitePrism.use_all_there_gem = true
+
+or ...
+
+SitePrism.configure do |config|
+  config.use_all_there_gem = true
+end
+```
+
+v1.0 is slated for release some-time in the Autumn/Winter of 2019, with a variety of small interim
+releases being planned in the meantime.
+
+Happy Testing / Developing!
+
+The SitePrism team

data/lib/site_prism/all_there/recursion_checker.rb

@@ -2,6 +2,8 @@
 
 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
     class RecursionChecker
       attr_reader :instance
       private :instance
@@ -10,17 +12,41 @@ module SitePrism
         @instance = instance
       end
 
+      # This is currently hard-coded 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?
-        regular_items_all_there = expected_item_map.flatten.all? { |name| there?(name) }
-        return false unless regular_items_all_there
+        current_class_all_there? &&
+          section_classes_all_there? &&
+          sections_classes_all_there?
+      end
+
+      private
 
-        section_all_there =
-          section_classes_to_check.all?(&:all_there?)
-        return false unless section_all_there
+      # This will check all elements that are in the current scope
+      # This is equivalent to checking a recursion value of +:none+
+      def current_class_all_there?
+        expected_item_map.flatten.all? { |name| there?(name) }
+      end
+
+      # This will check all elements that are in any of the individual
+      # +section+ items defined in the current scope
+      def section_classes_all_there?
+        section_classes_to_check.all?(&:all_there?)
+      end
+
+      # This will check all elements that are in any instance of any of the
+      # +sections+ items defined in the current scope
+      def sections_classes_all_there?
+        sections_classes_to_check.flatten.all?(&:all_there?)
+      end
+
+      def section_classes_to_check
+        expected_item_map[2].map { |name| instance.send(name) }
+      end
 
-        # Returning this final check here is fine, as the previous two checks must
-        # have returned +true+ in order to hit this part of the method-call
-        sections_classes_to_check.all?(&:all_there?)
+      def sections_classes_to_check
+        expected_item_map[3].map { |name| instance.send(name) }
       end
 
       def expected_item_map
@@ -37,16 +63,6 @@ module SitePrism
         map[type].select { |name| elements_to_check.include?(name) }
       end
 
-      def section_classes_to_check
-        expected_item_map[2].map { |name| instance.send(name) }
-      end
-
-      def sections_classes_to_check
-        expected_item_map[3].map { |name| instance.send(name) }.flatten
-      end
-
-      private
-
       # 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

data/lib/site_prism/all_there/version.rb

@@ -2,6 +2,6 @@
 
 module SitePrism
   module AllThere
-    VERSION = '0.1'
+    VERSION = '0.1.1'
   end
 end

data/lib/site_prism/all_there.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'site_prism/all_there/recursion_checker'
+
+# Configure the behaviour of the site_prism-all_there gem
+module SitePrism
+  class << self
+    attr_writer :recursion_setting
+
+    def configure
+      yield self
+    end
+
+    # Pass in a configuration setting to use on a global scale
+    # Note this can be overridden at runtime for each individual call
+    def recursion_setting
+      @recursion_setting ||= :none
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_prism-all_there
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -91,16 +91,16 @@ extra_rdoc_files: []
 files:
 - LICENSE.md
 - README.md
-- lib/site_prism.rb
+- lib/site_prism/all_there.rb
 - lib/site_prism/all_there/recursion_checker.rb
 - lib/site_prism/all_there/version.rb
-homepage: https://github.com/site_prism/site_prism-all_there
+homepage: https://github.com/site-prism/site_prism-all_there
 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
-  source_code_uri: https://github.com/site_prism/site_prism-all_there
+  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
+  source_code_uri: https://github.com/site-prism/site_prism-all_there
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -120,5 +120,5 @@ rubyforge_project:
 rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
-summary: 'An extension to SitePrism to allow you to use recursive checks on #all_there?'
+summary: An extension to allow you to recurse through your SitePrism Pages/Sections
 test_files: []

data/lib/site_prism.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module SitePrism
-  autoload :RecursionChecker, 'site_prism/all_there/recursion_checker'
-
-  class << self
-    attr_writer :recursion_setting
-
-    def configure
-      yield self
-    end
-
-    def recursion_setting
-      @recursion_setting ||= :none
-    end
-  end
-end