site_prism-all_there 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccad9b48e94f6dd3edc3b05f3dc21ee1a6a2282ac59e1b68d05e8b1a5ac34361
-  data.tar.gz: db69a5d921ef2821b52030eef022a769c922f86e0ed8fdae19ddf9fec11038dc
+  metadata.gz: 3b0f024978aaf7ce949a6d96866ed273c4709316f94888b3475a96653b7bbb24
+  data.tar.gz: 5ea2dc38f87a1eef69ebe2b8cb930e63f2014665f43fb2d35a1842e3266e42b5
 SHA512:
-  metadata.gz: 02b9419d51dfc2fbe5c2c45366b7dd13bb55a0b2d87c2af861a9f360083fc905b13215299375eca117b325694d817acbb04a170eb196103d93b8a09ab4099fe0
-  data.tar.gz: 0f082e123a6dd8f09df31f50c288a98febb4e207027940cfb761b86d18a3d46929c92ac6e6b59083376aed57ff7885e9e4dc9b0ce137233b92ee634c95e4ae61
+  metadata.gz: '05180b088c0322b945aed510279d50e4ca448be32586a956d24351663f2456c3914694d1163e4bd85894ea22072361b3e4194f3a198f395d92cdb9d7dc8beace'
+  data.tar.gz: 78f898bde22a8d88351b39197224d13de8f72d9b84626791e451d2dd4d6318907dc43dc78aa5965b9e3f0c10312f5b3a7fae8e39fda2d4b9efc9013c9317ea02

data/README.md

@@ -5,15 +5,14 @@ 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.
 
-At the moment, the gem is very much considered a Work in Progress and works "as is". It is
-currently released as a `0.x` version meaning it is not fully API stable.
+At the moment, the gem is currently released as a `0.x` version meaning it is **not** fully API stable.
 
 ## 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
 
@@ -24,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

@@ -4,11 +4,9 @@ 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
@@ -16,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

@@ -2,10 +2,10 @@
 
 module SitePrism
   module AllThere
-    # Returns the Expected Item Map on a specific SitePrism object
     #
-    # api private
+    # @api private
     #
+    # The Expected Item Map on a SitePrism Page or Section
     class ExpectedItems
       attr_reader :instance
       private :instance
@@ -14,32 +14,44 @@ module SitePrism
         @instance = instance
       end
 
+      # @return [Array<Hash<Symbol>>]
+      # All expected mapped items
       def array
         [
-          mapped_checklist_of(:element),
-          mapped_checklist_of(:elements),
-          mapped_checklist_of(:section),
-          mapped_checklist_of(:sections),
-          mapped_checklist_of(:iframe),
+          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
@@ -50,8 +62,6 @@ module SitePrism
         mapped_items.hash[type].select { |name| mapped_checklist.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 mapped_checklist
         if checklist
           SitePrism.logger.debug('Expected Items has been set.')
@@ -61,7 +71,6 @@ module SitePrism
         end
       end
 
-      # List of expected_items as defined during build phase
       def checklist
         instance.class.expected_items
       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 Mapped Items on a SitePrism Page or Section
     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,6 +12,7 @@ module SitePrism
         @instance = instance
       end
 
+      # @return [Boolean]
       # 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
@@ -27,20 +28,20 @@ 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_items.array.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
+      # @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?)
       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?)
       end

data/lib/site_prism/all_there/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_prism-all_there
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !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: '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.