site_prism 3.2 → 3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb0a772ccdabf209eba492206b0c664418fa46f1b2bdb2c8d08cbcf384b5522
-  data.tar.gz: be9c7ca220f2a20122a3bfd955fa617acda1ecb3d6aedac9472300f4c17ff014
+  metadata.gz: 95c8d9ff0cf7f2b818a8b8cb987ca39f2b512138d572a08533b8466feae6cb63
+  data.tar.gz: 6239a4a2cd9be9233396f2b221328645dcb50a56e531ee0d5b63faa3dbd9bf53
 SHA512:
-  metadata.gz: d21079c647c16bcb896374557448fc9c514ce8d3d16379e77f64be741b2ef76f7c2438ff9fd3d0f5bdd96a3678d92b40e162d3847a04647de1ed553b7a786b2f
-  data.tar.gz: bf7ea9e4ff98d6ae92427a98b21a35bd519638080c5b3c55f9565e163710b748c11152374293ee783d32a1f1ef599bbac5be99a56f696d144fb1f53d0d7836d4
+  metadata.gz: a9a7a79356b8f4c16aad85f923db99a549bba2c78ec23624f245504ce3bbffd7698bad6a572ddbb34cbf9f2406da76bda7ce5d2433d874270112025e5e9d79ea
+  data.tar.gz: 897ae6d1b6a944b52bc5f36ebb81e2796657a276bfa41994fd0a5315031457d404b46408660556644eb262258c8033b72aa5d7400bd79d13f8085993575df826

data/README.md

@@ -1,6 +1,6 @@
 # SitePrism
 [![Gem Version](https://badge.fury.io/rb/site_prism.svg)](https://badge.fury.io/rb/site_prism)
-[![Build Status](https://travis-ci.org/natritmeyer/site_prism.png)](https://travis-ci.org/natritmeyer/site_prism)
+[![Build Status](https://travis-ci.com/site-prism/site_prism.png)](https://travis-ci.com/site-prism/site_prism)
 
 _A Page Object Model DSL for Capybara_
 
@@ -9,24 +9,24 @@ for use with Capybara in automated acceptance testing.
 
 Find the pretty documentation here: http://rdoc.info/gems/site_prism/frames
 
-Make sure to add your project/company to https://github.com/natritmeyer/site_prism/wiki/Who-is-using-SitePrism
+Make sure to add your project/company to https://github.com/site-prism/site_prism/wiki/Who-is-using-SitePrism
 
 ## Developing / Contributing to SitePrism
 
 We love it when people want to get involved with our Open Source Project.
 
-We have a brief set of setup docs [HERE](https://github.com/natritmeyer/site_prism/blob/master/development_setup.md)
+We have a brief set of setup docs [HERE](https://github.com/site-prism/site_prism/blob/master/HACKING.md)
 
 ## Supported Rubies / Browsers
 
 SitePrism is built and tested to work on Ruby 2.4 - 2.6. Ruby 2.3 (Now EOL), is supported but not tested against.
 If you are using SitePrism with Ruby 2.3 it is highly advisable to upgrade to a more modern Ruby
-such as 2.5 or 2.6, if for any other reason, to get a noticeable speed boost!
+such as 2.6 or 2.7, if for any other reason, to get a noticeable speed boost!
 
 SitePrism should run on all major browsers. The gem's integration tests are ran on Chrome and Firefox.
 
 If you find you cannot integrate nicely with SitePrism, please open an
-[issue request](https://github.com/natritmeyer/site_prism/issues/new)
+[issue request](https://github.com/site-prism/site_prism/issues/new)
 
 ## Synopsis
 
@@ -42,14 +42,14 @@ class Home < SitePrism::Page
   element :search_field, 'input[name="q"]'
   element :search_button, 'button[name="btnK"]'
   elements :footer_links, '#footer a'
-  section :menu, MenuSection, '#gbx3'
+  section :menu, Menu, '#gbx3'
 end
 
 class SearchResults < SitePrism::Page
   set_url_matcher(/google.com\/results\?.*/)
 
-  section :menu, MenuSection, '#gbx3'
-  sections :search_results, SearchResultSection, '#results li'
+  section :menu, Menu, '#gbx3'
+  sections :search_results, SearchResults, '#results li'
 
   def search_result_links
     search_results.map { |result| result.title['href'] }
@@ -58,13 +58,13 @@ end
 
 # define sections used on multiple pages or multiple times on one page
 
-class MenuSection < SitePrism::Section
+class Menu < SitePrism::Section
   element :search, 'a.search'
   element :images, 'a.image-search'
   element :maps, 'a.map-search'
 end
 
-class SearchResultSection < SitePrism::Section
+class SearchResults < SitePrism::Section
   element :title, 'a.title'
   element :blurb, 'span.result-description'
 end
@@ -124,6 +124,22 @@ require 'capybara'
 require 'capybara/cucumber'
 require 'selenium-webdriver'
 require 'site_prism'
+require 'site_prism/all_there' # Optional but needed to perform more complex matching
+```
+
+The driver creation is identical to how you would normally create a Capybara driver,
+a sample Selenium one could look something like this...
+
+```ruby
+Capybara.register_driver :site_prism do |app|
+  browser = ENV.fetch('browser', 'firefox').to_sym
+  Capybara::Selenium::Driver.new(app, browser: browser, desired_capabilities: capabilities)
+end
+
+# Then tell Capybara to use the Driver you've just defined as its default driver
+Capybara.configure do |config|
+  config.default_driver = :site_prism
+end
 ```
 
 ### Using SitePrism with RSpec
@@ -135,8 +151,11 @@ require 'capybara'
 require 'capybara/rspec'
 require 'selenium-webdriver'
 require 'site_prism'
+require 'site_prism/all_there' # Optional but needed to perform more complex matching
 ```
 
+And again, as above, a sample driver is no different to a normal driver instantiation in Capybara.
+
 ## Introduction to the Page Object Model
 
 The Page Object Model is a test automation pattern that aims to create
@@ -158,7 +177,7 @@ multiple pages, or many times on a page using the concept of sections.
 As you might be able to guess from the name, pages are fairly central to
 the Page Object Model. Here's how SitePrism models them:
 
-### Creating a Page Model
+### Creating your first Page using the Page Object Model
 
 The simplest page is one that has nothing defined in it. Here's an
 example of how to begin modelling a home page:
@@ -168,7 +187,7 @@ class Home < SitePrism::Page
 end
 ```
 
-The above has nothing useful defined, only the name.
+The above has nothing useful defined, so to start with lets give it some properties.
 
 ### Adding a URL
 
@@ -177,7 +196,7 @@ you'll need to set its URL. Here's how:
 
 ```ruby
 class Home < SitePrism::Page
-  set_url 'http://www.google.com'
+  set_url 'http://www.mysite.com/home.htm'
 end
 ```
 
@@ -332,7 +351,7 @@ end
 SitePrism's `#displayed?` predicate method allows for semantic code in your tests:
 
 ```ruby
-Then /^the account page is displayed$/ do
+Then(/^the account page is displayed$/) do
   expect(@account_page).to be_displayed
   expect(@some_other_page).not_to be_displayed
 end
@@ -431,7 +450,7 @@ end
 #### Testing for the existence of the element
 
 Another method added to the Page class by the `element` method is the
-`has_<element name>?` method. Using the same example as above:
+`has_<element_name>?` method. Using the same example as above:
 
 ```ruby
 class Home < SitePrism::Page
@@ -452,7 +471,7 @@ end
 ...which makes for nice test code:
 
 ```ruby
-Then /^the search field exists$/ do
+Then(/^the search field exists$/) do
   expect(@home).to have_search_field
 end
 ```
@@ -472,14 +491,14 @@ that should be used to test for non-existence. Using the above example:
 ...which makes for nice test code:
 
 ```ruby
-Then /^the search field exists$/ do
+Then(/^the search field exists$/)do
   expect(@home).to have_no_search_field #NB: NOT => expect(@home).not_to have_search_field
 end
 ```
 
 #### Waiting for an element to become visible
 
-A method that gets added by calling `element` is the 
+A method that gets added by calling `element` is the
 `wait_until_<element_name>_visible` method. Calling this method will
 cause the test to wait for Capybara's default wait time for the element
 to become visible. You can customise the wait time by supplying a number
@@ -594,7 +613,6 @@ Or even run some tests ...
 ```ruby
 expect(@friends_page.names.map { |name| name.text }).to eq(['Alice', 'Bob', 'Fred'])
 expect(@friends_page.names.size).to eq(3)
-expect(@friends_page).to have(3).names
 ```
 
 #### Testing for the existence of the element collection
@@ -620,7 +638,7 @@ Then the following method is available:
 This in turn allows the following nice test code
 
 ```ruby
-Then /^there should be some names listed on the page$/ do
+Then(/^there should be some names listed on the page$/) do
   expect(@friends_page).to have_names #=> This only passes if there is at least one `name`
 end
 ```
@@ -661,7 +679,7 @@ are present in the browser and `false` if they're not all there.
 
 # and...
 
-Then /^the friends page contains all the expected elements$/ do
+Then(/^the friends page contains all the expected elements$/) do
   expect(@friends_page).to be_all_there
 end
 ```
@@ -696,6 +714,28 @@ end
 @test_page.elements_present #=> [:address_field]
 ```
 
+If you are specifying a highly nested set of sections inside a Page and need to recurse
+through them to find out if all of your items are present then you can also do this.
+
+Simply pass a recursion parameter to the `#all_there?` check. Note that the only valid values
+for this at the moment are `:none` and `:one`
+
+Passing `:none` (default), will not change the functionality. However passing in `:one` will cause
+`site_prism` to recurse through all `section` / `sections` items defined in your present scope.
+
+Work alongside developing this functionality further is being continued in the
+[site_prism-all_there](http://www.github.com/site-prism/site_prism-all_there) repo. So head on over
+there if you're interested in how this feature will work going forwards
+
+NB: At the moment a "primitive" but working copy of this is hosted inside this gem. But if you wish to
+use the bleeding edge version of the logic. Then simply set the following configuration parameter
+
+```ruby
+`require 'site_prism/all_there'`
+
+SitePrism.use_all_there_gem = true
+```
+
 ## Sections
 
 SitePrism allows you to model sections of a page that appear on multiple
@@ -751,7 +791,7 @@ class People < SitePrism::Section
   element :footer, 'h4'
 end
 
-class HomePage < SitePrism::Page
+class Home < SitePrism::Page
   # section people_with_block will have `headline` and
   # `footer` elements in it
   section :people_with_block, People do
@@ -871,7 +911,7 @@ end
 This then leads to some pretty test code ...
 
 ```ruby
-Then /^the home page menu contains a link to the various search functions$/ do
+Then(/^the home page menu contains a link to the various search functions$/) do
   expect(@home.menu).to have_search
   expect(@home.menu.search['href']).to include('google.com')
   expect(@home.menu).to have_images
@@ -881,14 +921,13 @@ end
 
 ##### Accessing section elements using a block
 
-A Section can be scoped so it is only accessible inside a block. This is
+You can execute a block within the context of a Section. This is
 similar to Capybara's `within` method and allows for shorter test code
-particularly with nested sections. Some of this test code can be
-made a little prettier by simply passing a block in.
+particularly with nested sections. Test code that might have to repeat the block name can be shortened up this way.
 
 ```ruby
-Then /^the home page menu contains a link to the various search functions$/ do
-  @home.menu do |menu|
+Then(/^the home page menu contains a link to the various search functions$/) do
+  @home.menu.within do |menu|
     expect(menu).to have_search
     expect(menu.search['href']).to include('google.com')
     expect(menu).to have_images
@@ -897,33 +936,43 @@ Then /^the home page menu contains a link to the various search functions$/ do
 end
 ```
 
+Note that on an individual section it's possible to pass a block directly to the section without using `within`.  Because the block is executed only during `Section` initialization this won't work when accessing a single Section from an array of Sections.  For that reason we recommend using `within` which works in either case.
+
+```ruby
+Then(/^the home page menu contains a link to the various search functions$/) do
+  @home.menu do |menu|  # possible, but prefer: `@home.menu.within`
+    expect(menu).to have_search
+  end
+end
+```
+
 #### Getting a section's parent
 
 It is possible to ask a section for its parent (page, or section if this
 section is a subsection). For example, given the following setup:
 
 ```ruby
-class MySubSection < SitePrism::Section
-  element :some_element, 'abc'
+class DestinationFilters < SitePrism::Section
+  element :morocco, 'abc'
 end
 
-class MySection < SitePrism::Section
-  section :my_subsection, MySubSection, 'def'
+class FilterPanel < SitePrism::Section
+  section :destination_filters, DestinationFilters, 'def'
 end
 
-class MyPage < SitePrism::Page
-  section :my_section, MySection, 'ghi'
+class Home < SitePrism::Page
+  section :filter_panel, FilterPanel, 'ghi'
 end
 ```
 
 Then calling `#parent` will return the following:
 
 ```ruby
-@my_page = MyPage.new
-@my_page.load
+@home = Home.new
+@home.load
 
-@my_page.my_section.parent #=> returns @my_page
-@my_page.my_section.my_subsection.parent #=> returns @my_page.my_section
+@home.filter_panel.parent #=> returns @home
+@home.filter_panel.destination_filters.parent #=> returns @home.filter_panel
 ```
 
 #### Getting a section's parent page
@@ -1044,7 +1093,7 @@ end
 
 # how to login (fatuous, but demonstrates the point):
 
-Then /^I sign in$/ do
+Then(/^I sign in$/) do
   @home = Home.new
   @home.load
   expect(@home).to have_login_and_registration
@@ -1056,7 +1105,7 @@ end
 
 # how to sign up:
 
-When /^I enter my name into the home page's registration form$/ do
+When(/^I enter my name into the home page's registration form$/) do
   @home = Home.new
   @home.load
   expect(@home.login_and_registration).to have_first_name
@@ -1133,9 +1182,9 @@ end
 This allows for pretty tests ...
 
 ```ruby
-Then /^there are lots of search_results$/ do
+Then(/^there are lots of search_results$/) do
   expect(@results_page.search_results.size).to eq(10)
-  
+
   @home.search_results.each do |result|
     expect(result).to have_title
     expect(result.blurb.text).not_to be_empty
@@ -1144,13 +1193,33 @@ end
 ```
 
 The css selector that is passed as the 3rd argument to the
-`sections` method ("#results li") is used to find a number of capybara
+`sections` method (`#results li`) is used to find a number of capybara
 elements. Each capybara element found using the css selector is used to
 create a new instance of `SearchResults` and becomes its root
 element. So if the css selector finds 3 `li` elements, calling
 `search_results` will return an array containing 3 instances of
 `SearchResults`, each with one of the `li` elements as it's root element.
 
+##### Accessing Within a Collection of Sections
+
+When using an iterator such as `each` to pass a block through to a collection of sections it is possible to skip using `within`.  However some caution is warranted when accessing the Sections directly from an array, as the block can only be executed when the section is being initialized.  The following does not work:
+
+```rb
+  @home.search_results.first do |result|
+    # This block is silently ignored.
+    expect(result).to have_title
+  end
+```
+Instead use `within` to access the inner-context of the Section.
+
+```rb
+  @home.search_results.first.within do |result|
+    # This block is run within the context of the Section.
+    expect(result).to have_title
+  end
+```
+
+
 #### Anonymous Section Collections
 
 You can define collections of anonymous sections the same way you would
@@ -1197,7 +1266,7 @@ Here's how to test for the existence of the section:
 This allows for some pretty tests ...
 
 ```ruby
-Then /^there are search results on the page$/ do
+Then(/^there are search results on the page$/) do
   expect(@home).to have_search_results
 end
 ```
@@ -1347,7 +1416,7 @@ instance of the class when created.
 
 ### Skipping load Validations
 
-Defined load validations can be skipped for one `load` call by 
+Defined load validations can be skipped for one `load` call by
 passing in `with_validations: false`.
 
 ```ruby
@@ -1398,7 +1467,7 @@ the validations will be performed in the following order:
 **NB:** `SitePrism::Page` **used to** include a default load validation on
 `page.displayed?` however for v3 this has been removed. It is therefore
 necessary to re-define this if you want to retain the behaviour
-from site_prism v2. See [UPGRADING.md](https://github.com/natritmeyer/site_prism/blob/master/UPGRADING.md#default-load-validations)
+from site_prism v2. See [UPGRADING.md](https://github.com/site-prism/site_prism/blob/master/UPGRADING.md#default-load-validations)
 for more info on this.
 
 ## Using Capybara Query Options
@@ -1448,7 +1517,7 @@ Now we can write pretty, non-failing tests without hard coding these options
 into our page and section classes:
 
 ```ruby
-Then /^there are search results on the page$/ do
+Then(/^there are search results on the page$/) do
   expect(@results_page).to have_search_results(count: 25)
 end
 ```
@@ -1581,7 +1650,7 @@ class Home < SitePrism::Page
 end
 
 # cucumber step that performs login
-When /^I log in$/ do
+When(/^I log in$/) do
   @home = Home.new
   @home.load
 
@@ -1612,9 +1681,9 @@ as per the code below
 
 ```ruby
 Capybara.configure do |config|
-  config.default_max_wait_time = 11 #=> Wait up to 11 seconds for all querys to fail
-  # or alternatively, if you don't want to ever wait
-  config.default_max_wait_time = 0 #=> Don't ever wait! 
+  config.default_max_wait_time = 11 #=> Wait up to 11 seconds for all queries to fail
+  # or if you don't want to ever wait
+  config.default_max_wait_time = 0 #=> Don't ever wait!
 end
 ```
 
@@ -1636,6 +1705,9 @@ end
 There's a SitePrism plugin called `site_prism.vcr` that lets you use
 SitePrism with the VCR gem. Check it out [HERE](https://github.com/dnesteryuk/site_prism.vcr)
 
+Note that as of 2016 this plugin doesn't appear to have been under active development. Also it is
+still pinned to the `2.x` series of site_prism so use it of your own accord.
+
 # Epilogue
 
 So, we've seen how to use SitePrism to put together page objects made up

data/lib/site_prism.rb

@@ -5,14 +5,18 @@ require 'addressable/template'
 
 module SitePrism
   autoload :AddressableUrlMatcher, 'site_prism/addressable_url_matcher'
+  autoload :Deprecator, 'site_prism/deprecator'
   autoload :DSL, 'site_prism/dsl'
   autoload :ElementChecker, 'site_prism/element_checker'
+  autoload :RecursionChecker, 'site_prism/recursion_checker'
   autoload :Logger, 'site_prism/logger'
   autoload :Page, 'site_prism/page'
   autoload :Section, 'site_prism/section'
   autoload :Waiter, 'site_prism/waiter'
 
   class << self
+    attr_reader :use_all_there_gem
+
     def configure
       yield self
     end
@@ -63,5 +67,13 @@ module SitePrism
     def log_level
       %i[DEBUG INFO WARN ERROR FATAL UNKNOWN][logger.level]
     end
+
+    # Whether you wish to use the new experimental all_there dependent gem
+    #   This will be enforced from site_prism v4 onwards as this is where
+    #   the development of this functionality will be focused
+    def use_all_there_gem=(value)
+      logger.debug("Setting use_all_there_gem to #{value}")
+      @use_all_there_gem = value
+    end
   end
 end

data/lib/site_prism/addressable_url_matcher.rb

@@ -98,7 +98,7 @@ module SitePrism
       begin
         Addressable::URI.parse(url)
       rescue Addressable::URI::InvalidURIError
-        SitePrism.logger.warn("Ensure you don't use templated port numbers.")
+        SitePrism.logger.fatal("Ensure you don't use templated port numbers.")
         raise SitePrism::InvalidUrlMatcherError
       end
     end

data/lib/site_prism/deprecator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class Deprecator
+    class << self
+      def deprecate(old, new = nil)
+        if new
+          warn("#{old} is being deprecated and should no longer be used. Use #{new} instead.")
+        else
+          warn("#{old} is being deprecated and should no longer be used.")
+        end
+
+        warn("#{old} will be removed in SitePrism v4. You have been warned!")
+      end
+
+      def soft_deprecate(old, reason, new = nil)
+        debug("The #{old} method is changing, as is SitePrism, and is now configurable.")
+        debug("REASON: #{reason}.")
+        debug('Moving forwards into SitePrism v4, the default behaviour will change.')
+        debug("We advise you change to using #{new}") if new
+      end
+
+      private
+
+      def warn(msg)
+        SitePrism.logger.warn(msg)
+      end
+
+      def debug(msg)
+        SitePrism.logger.debug(msg)
+      end
+    end
+  end
+end

data/lib/site_prism/dsl.rb

@@ -36,6 +36,14 @@ module SitePrism
       raise SitePrism::UnsupportedBlockError
     end
 
+    # Warn users from naming the elements starting with no_
+    def warn_if_dsl_collision(obj, name)
+      return unless name.to_s.start_with?('no_')
+
+      SitePrism.logger.warn("#{obj.class}##{name} should not start with no_")
+      SitePrism::Deprecator.deprecate('Using no_ prefix in DSL definition')
+    end
+
     # Sanitize method called before calling any SitePrism DSL method or
     # meta-programmed method. This ensures that the Capybara query is correct.
     #
@@ -49,7 +57,7 @@ module SitePrism
 
       recombine_args(find_args, runtime_args, options)
 
-      return [*find_args, *runtime_args] if options.empty?
+      return [*find_args, *runtime_args, {}] if options.empty?
 
       [*find_args, *runtime_args, options]
     end
@@ -76,8 +84,10 @@ module SitePrism
       attr_reader :expected_items
 
       def element(name, *find_args)
+        SitePrism::Deprecator.deprecate('Passing a block to :element') if block_given?
         build(:element, name, *find_args) do
           define_method(name) do |*runtime_args, &element_block|
+            warn_if_dsl_collision(self, name)
             raise_if_block(self, name, !element_block.nil?, :element)
             _find(*merge_args(find_args, runtime_args))
           end
@@ -85,8 +95,10 @@ module SitePrism
       end
 
       def elements(name, *find_args)
+        SitePrism::Deprecator.deprecate('Passing a block to :elements') if block_given?
         build(:elements, name, *find_args) do
           define_method(name) do |*runtime_args, &element_block|
+            warn_if_dsl_collision(self, name)
             raise_if_block(self, name, !element_block.nil?, :elements)
             _all(*merge_args(find_args, runtime_args))
           end
@@ -101,6 +113,7 @@ module SitePrism
         section_class, find_args = extract_section_options(args, &block)
         build(:section, name, *find_args) do
           define_method(name) do |*runtime_args, &runtime_block|
+            warn_if_dsl_collision(self, name)
             section_element = _find(*merge_args(find_args, runtime_args))
             section_class.new(self, section_element, &runtime_block)
           end
@@ -120,6 +133,7 @@ module SitePrism
       end
 
       def iframe(name, klass, *args)
+        SitePrism.logger.debug('Block passed into iFrame construct at build time') if block_given?
         element_find_args = deduce_iframe_element_find_args(args)
         scope_find_args = deduce_iframe_scope_find_args(args)
         build(:iframe, name, *element_find_args) do
@@ -131,12 +145,35 @@ module SitePrism
         end
       end
 
-      def mapped_items
-        @mapped_items ||= []
+      def mapped_items(legacy: true)
+        if legacy
+          old_mapped_items
+        else
+          new_mapped_items
+        end
       end
 
       private
 
+      def old_mapped_items
+        SitePrism::Deprecator.soft_deprecate(
+          '.mapped_items on a class',
+          'To allow easier recursion through the items in conjunction with #all_there?',
+          '.mapped_items(legacy: false)'
+        )
+        @old_mapped_items ||= []
+      end
+
+      def new_mapped_items
+        @new_mapped_items ||= {
+          element: [],
+          elements: [],
+          section: [],
+          sections: [],
+          iframe: [],
+        }
+      end
+
       def build(type, name, *find_args)
         if find_args.empty?
           create_error_method(name)
@@ -148,7 +185,8 @@ module SitePrism
       end
 
       def map_item(type, name)
-        mapped_items << { type => name.to_sym }
+        old_mapped_items << { type => name }
+        new_mapped_items[type] << name.to_sym
       end
 
       def add_helper_methods(name, *find_args)
@@ -173,9 +211,7 @@ module SitePrism
 
         RSpec::Matchers.define "have_#{element_name}" do |*args|
           match { |actual| actual.public_send(matcher, *args) }
-          match_when_negated do |actual|
-            actual.public_send(negated_matcher, *args)
-          end
+          match_when_negated { |actual| actual.public_send(negated_matcher, *args) }
         end
       end
 
@@ -224,7 +260,7 @@ module SitePrism
       end
 
       def create_error_method(name)
-        SitePrism.logger.error("#{name} has come from an item with 0 locators.")
+        SitePrism.logger.error("#{name} has come from an item with no locators.")
         define_method(name) { raise SitePrism::InvalidElementError }
       end
 
@@ -250,7 +286,7 @@ module SitePrism
         return unless looks_like_xpath?(args[0])
 
         SitePrism.logger.warn('The arguments passed in look like xpath. Check your locators.')
-        SitePrism.logger.debug("Default locator: #{Capybara.default_selector}")
+        SitePrism.logger.debug("Default locator strategy: #{Capybara.default_selector}")
       end
 
       def looks_like_xpath?(arg)

data/lib/site_prism/element_checker.rb

@@ -13,54 +13,59 @@ module SitePrism
     # @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
+    # Note that #elements_to_check will check the hash of mapped_items
     #
-    # When using the recursion parameter, one of three values is valid.
+    # When using the recursion parameter, one of two 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) }
+    # Override: 'one' => Perform one recursive dive into all section/sections
+    # items and call #all_there? on all of those items too.
+    def all_there?(recursion: :none)
+      if recursion == :none
+        elements_to_check.all? { |name| there?(name) }
+      elsif recursion == :one
+        all_there_with_recursion
       else
-        SitePrism.logger.error('Invalid recursion setting, Will not run.')
+        SitePrism.logger.debug("Input value '#{recursion}'. Valid values are :none or :one.")
+        SitePrism.logger.error('Invalid recursion setting, Will not run #all_there?.')
       end
     end
 
     def elements_present
-      _mapped_items.select { |item_name| there?(item_name) }
+      _mapped_items.select { |name| there?(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 all_there_with_recursion
+      if SitePrism.use_all_there_gem
+        SitePrism::AllThere::RecursionChecker.new(self).all_there?
+      else
+        RecursionChecker.new(self).all_there?
+      end
+    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.')
-        _mapped_items.select { |item_name| _expected_items.include?(item_name) }
+        _mapped_items.select { |name| _expected_items.include?(name) }
       else
         _mapped_items
       end
     end
 
     def _mapped_items
-      mapped_items_list.map(&:values).flatten
-    end
-
-    def mapped_items_list
-      self.class.mapped_items.uniq
+      self.class.mapped_items(legacy: false).values.flatten.uniq
     end
 
     def _expected_items
       self.class.expected_items
     end
 
-    def there?(item_name)
-      send("has_#{item_name}?")
+    def there?(name)
+      send("has_#{name}?")
     end
   end
 end

data/lib/site_prism/page.rb

@@ -3,7 +3,6 @@
 require 'site_prism/loadable'
 
 module SitePrism
-  # rubocop:disable Metrics/ClassLength
   class Page
     include Capybara::DSL
     include ElementChecker
@@ -104,19 +103,23 @@ module SitePrism
     private
 
     def _find(*find_args)
-      page.find(*find_args)
+      kwargs = find_args.pop
+      page.find(*find_args, **kwargs)
     end
 
     def _all(*find_args)
-      page.all(*find_args)
+      kwargs = find_args.pop
+      page.all(*find_args, **kwargs)
     end
 
     def element_exists?(*find_args)
-      page.has_selector?(*find_args)
+      kwargs = find_args.pop
+      page.has_selector?(*find_args, **kwargs)
     end
 
     def element_does_not_exist?(*find_args)
-      page.has_no_selector?(*find_args)
+      kwargs = find_args.pop
+      page.has_no_selector?(*find_args, **kwargs)
     end
 
     def regexp_backed_matches
@@ -167,5 +170,4 @@ module SitePrism
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/site_prism/recursion_checker.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class RecursionChecker
+    attr_reader :instance
+    private :instance
+
+    def initialize(instance)
+      @instance = instance
+    end
+
+    def all_there?
+      regular_items_all_there = expected_item_map.flatten.all? { |name| there?(name) }
+      return false unless regular_items_all_there
+
+      section_all_there =
+        section_classes_to_check.all?(&:all_there?)
+      return false unless section_all_there
+
+      # 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?)
+    end
+
+    def expected_item_map
+      [
+        expected(mapped_items, :element),
+        expected(mapped_items, :elements),
+        expected(mapped_items, :section),
+        expected(mapped_items, :sections),
+        expected(mapped_items, :iframe),
+      ]
+    end
+
+    def expected(_map, type)
+      mapped_items[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
+      if _expected_items
+        SitePrism.logger.debug('Expected Items has been set.')
+        _mapped_items.select { |name| _expected_items.include?(name) }
+      else
+        _mapped_items
+      end
+    end
+
+    def _mapped_items
+      mapped_items.values.flatten.uniq
+    end
+
+    def _expected_items
+      instance.class.expected_items
+    end
+
+    def there?(name)
+      instance.send("has_#{name}?")
+    end
+
+    def mapped_items
+      @mapped_items ||= instance.class.mapped_items(legacy: false)
+    end
+  end
+end

data/lib/site_prism/section.rb

@@ -25,10 +25,14 @@ module SitePrism
         nil
     end
 
-    def initialize(parent, root_element)
+    def initialize(parent, root_element, &block)
       @parent = parent
       @root_element = root_element
-      Capybara.within(@root_element) { yield(self) } if block_given?
+      within(&block) if block_given?
+    end
+
+    def within
+      Capybara.within(@root_element) { yield(self) }
     end
 
     # Capybara::DSL module "delegates" Capybara methods to the "page" method
@@ -68,19 +72,23 @@ module SitePrism
     private
 
     def _find(*find_args)
-      page.find(*find_args)
+      kwargs = find_args.pop
+      page.find(*find_args, **kwargs)
     end
 
     def _all(*find_args)
-      page.all(*find_args)
+      kwargs = find_args.pop
+      page.all(*find_args, **kwargs)
     end
 
     def element_exists?(*find_args)
-      page.has_selector?(*find_args)
+      kwargs = find_args.pop
+      page.has_selector?(*find_args, **kwargs)
     end
 
     def element_does_not_exist?(*find_args)
-      page.has_no_selector?(*find_args)
+      kwargs = find_args.pop
+      page.has_no_selector?(*find_args, **kwargs)
     end
   end
 end

data/lib/site_prism/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SitePrism
-  VERSION = '3.2'
+  VERSION = '3.5'
 end

data/lib/site_prism/waiter.rb

@@ -26,7 +26,7 @@ module SitePrism
         raise(
           SitePrism::FrozenInTimeError,
           'Time appears to be frozen. For more info, see ' \
-          'https://github.com/natritmeyer/site_prism/blob/master/lib/site_prism/error.rb'
+          'https://github.com/site-prism/site_prism/blob/master/lib/site_prism/error.rb'
         )
       end
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '3.2'
+  version: '3.5'
 platform: ruby
 authors:
-- Nat Ritmeyer
 - Luke Hill
+- Nat Ritmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -29,16 +29,36 @@ dependencies:
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.29'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3.29'
+- !ruby/object:Gem::Dependency
+  name: site_prism-all_there
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -54,31 +74,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
@@ -101,28 +121,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.75.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.75.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.33.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.33.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -143,35 +177,33 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.1
-description: |-
-  SitePrism gives you a simple,
-  clean and semantic DSL for describing your site.
-  SitePrism implements the Page Object Model pattern on top of Capybara.
+        version: '4.0'
+description: SitePrism gives you a simple, clean and semantic DSL for describing your
+  site. SitePrism implements the Page Object Model pattern on top of Capybara.
 email:
-- nat@natontesting.com
 - lukehill_uk@hotmail.com
+- nat@natontesting.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -180,22 +212,24 @@ files:
 - README.md
 - lib/site_prism.rb
 - lib/site_prism/addressable_url_matcher.rb
+- lib/site_prism/deprecator.rb
 - lib/site_prism/dsl.rb
 - lib/site_prism/element_checker.rb
 - lib/site_prism/error.rb
 - lib/site_prism/loadable.rb
 - lib/site_prism/logger.rb
 - lib/site_prism/page.rb
+- lib/site_prism/recursion_checker.rb
 - lib/site_prism/section.rb
 - lib/site_prism/version.rb
 - lib/site_prism/waiter.rb
-homepage: https://github.com/natritmeyer/site_prism
+homepage: https://github.com/site-prism/site_prism
 licenses:
 - BSD-3-Clause
 metadata:
-  bug_tracker_uri: https://github.com/natritmeyer/site_prism/issues
-  changelog_uri: https://github.com/natritmeyer/site_prism/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/natritmeyer/site_prism
+  bug_tracker_uri: https://github.com/site-prism/site_prism/issues
+  changelog_uri: https://github.com/site-prism/site_prism/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/site-prism/site_prism
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -211,8 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A Page Object Model DSL for Capybara