site_prism 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484d33816dfd3b61f4ebd4c4e0b96418877c84730b3d5edacc214895c17ac565
-  data.tar.gz: 3c18ff1ba0590d025eea607b46bb44d733f67669d53fd5cc535491cc85e5eae1
+  metadata.gz: 99cb79c78e6dba7cac9a03b9bdc0bd5c3b68a25995ec38160e9705274ab04cfd
+  data.tar.gz: 6d91b63cd449fe3f16a364008d5178d7175bd6c4bf65297e5dfe5ae1a0673848
 SHA512:
-  metadata.gz: 55df767a6fe3d3a2234c94d69c496396bcab8fd095177e780d2c16bc30ad8f08d5339e0e02a9f65be3d46c58b8d16718c56c52b9482db515ef5084dcef17dbd4
-  data.tar.gz: 1bc2a80d5bb5926d4db0c209a14a6c368266329eb26e5ab8ddb17de7fbfbcb265f80b01edbdb9ded18e8d8a14f2ced7731f5cb1404c4fade0bda3aee9d2959d9
+  metadata.gz: 2de60bd237a1d29d1594ba3a8db75e01a09310fe78e48a81d7ea0b1dd7fa53a36d6bdb274c4b592daa0c39a2768c7a371a2939d35177598b146d018dd6ff35f9
+  data.tar.gz: bbc12f3639fc7bfe30ab28b3dd65b68f30f4c8c6943e306ae849a3b4e16dda104f96c746f21e3b5fe8162c7a4e05388ba9aebe5fd61c024fc27abc4df0b74a16

data/README.md

@@ -17,7 +17,7 @@ We have a brief set of setup docs [HERE](https://github.com/natritmeyer/site_pri
 
 ## Supported Rubies / Browsers
 
-SitePrism is built and tested to work on Ruby 2.3 - 2.5. There is also some limited support for the Ruby 2.2 series.
+SitePrism is built and tested to work on Ruby 2.3 - 2.6. There is also some limited support for the Ruby 2.2 series.
 
 SitePrism should run on all major browsers. The gem's integration tests are ran on Chrome and Firefox.
 

data/lib/site_prism.rb

@@ -5,8 +5,8 @@ require 'addressable/template'
 
 module SitePrism
   autoload :AddressableUrlMatcher, 'site_prism/addressable_url_matcher'
+  autoload :DSL, 'site_prism/dsl'
   autoload :ElementChecker, 'site_prism/element_checker'
-  autoload :ElementContainer, 'site_prism/element_container'
   autoload :Logger, 'site_prism/logger'
   autoload :Page, 'site_prism/page'
   autoload :Section, 'site_prism/section'

data/lib/site_prism/{element_container.rb → dsl.rb}

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
 
 module SitePrism
-  module ElementContainer
+  module DSL
     def self.included(klass)
       klass.extend ClassMethods
     end
 
     private
 
+    # The default waiting time set by Capybara's configuration settings.
     def wait_time
       Capybara.default_max_wait_time
     end
 
+    # Prevent users from calling methods with blocks when they shouldn't be.
+    #
+    # Example (Triggering error):
+    #
+    #       class MyPage
+    #         element :sample, '.css-locator' do
+    #           puts "This won't be output"
+    #         end
+    #       end
+    #
+    # At runtime this will generate a `SitePrism::UnsupportedBlockError`
+    #
+    # The only DSL keywords that can use blocks are :section and :iframe
     def raise_if_block(obj, name, has_block, type)
       return unless has_block
 
@@ -52,6 +66,9 @@ module SitePrism
       options[:wait] = wait_time unless wait_key_present?(options)
     end
 
+    # True if the +wait+ key is present in the options hash.
+    #
+    # Note that setting it to to false or 0, still will return true here.
     def wait_key_present?(options)
       options.key?(:wait)
     end

data/lib/site_prism/element_checker.rb

@@ -2,26 +2,52 @@
 
 module SitePrism
   module ElementChecker
-    def all_there?
-      elements_to_check.all? { |item_name| there?(item_name) }
+    # Runnable in the scope of any SitePrism::Page or Section.
+    # Returns +true+ when "every item" that is being checked is
+    # present within the current scope. See #elements_to_check
+    # for how the definition of "every item" is derived.
+    #
+    # Example
+    # @my_page.mapped_items
+    # { element => :button_one, element => :button_two, section => :filters }
+    # @my_page.all_there?
+    # => true - If the three items above are all present
+    #
+    # Note that #elements_to_check will affect the hash of mapped_items
+    #
+    # When using the recursion parameter, one of three values is valid.
+    #
+    # Default: 'none' => Perform no recursion when calling #all_there?
+    # Override: 'one' => Perform one recursive dive into all section
+    # items and call #all_there? on those items too.
+    def all_there?(recursion: 'none')
+      SitePrism.logger.info('Setting for recursion is being ignored for now.')
+
+      if %w[none one].include?(recursion)
+        elements_to_check.all? { |item_name| there?(item_name) }
+      else
+        SitePrism.logger.error('Invalid recursion setting, Will not run.')
+      end
     end
 
     def elements_present
-      mapped_items.select { |item_name| there?(item_name) }
+      _mapped_items.select { |item_name| there?(item_name) }
     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
-      if expected_items
+      if _expected_items
         SitePrism.logger.debug('Expected Items has been set.')
-        mapped_items.select { |item_name| expected_items.include?(item_name) }
+        _mapped_items.select { |item_name| _expected_items.include?(item_name) }
       else
-        mapped_items
+        _mapped_items
       end
     end
 
-    def mapped_items
+    def _mapped_items
       mapped_items_list.map(&:values).flatten
     end
 
@@ -29,7 +55,7 @@ module SitePrism
       self.class.mapped_items.uniq
     end
 
-    def expected_items
+    def _expected_items
       self.class.expected_items
     end
 

data/lib/site_prism/page.rb

@@ -7,7 +7,7 @@ module SitePrism
     include Capybara::DSL
     include ElementChecker
     include Loadable
-    include ElementContainer
+    include DSL
 
     class << self
       attr_reader :url

data/lib/site_prism/section.rb

@@ -7,7 +7,7 @@ module SitePrism
     include Capybara::DSL
     include ElementChecker
     include Loadable
-    include ElementContainer
+    include DSL
     extend Forwardable
 
     attr_reader :root_element, :parent

data/lib/site_prism/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SitePrism
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.0.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Nat Ritmeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -107,14 +107,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.62.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.62.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +157,8 @@ files:
 - README.md
 - lib/site_prism.rb
 - lib/site_prism/addressable_url_matcher.rb
+- lib/site_prism/dsl.rb
 - lib/site_prism/element_checker.rb
-- lib/site_prism/element_container.rb
 - lib/site_prism/error.rb
 - lib/site_prism/loadable.rb
 - lib/site_prism/logger.rb