site_prism 3.3 → 3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21261a1fb826c5500f7bc30e44729cb733b2f75b1ea7d3d5243400d9d29e8b2c
-  data.tar.gz: e50ab9e1b7d6c0e651d15aa6888828b789f38b7aed80511caa96d50dc767dcda
+  metadata.gz: c80d215b3527e90d15660f863dcb13b251e10f465dfc0ef47c344ebf6ea4b54b
+  data.tar.gz: 04cf863dcd21233726aea475e4eefc676c7d387717c29e9dda68ede2113b7319
 SHA512:
-  metadata.gz: 423f9ffb5d2b26f9619f81414074ab1006b72d7ac8516a355f6d4ffc3959aadb56bacda3a25f06c4bff8e4898609d6c5540e9e9856b3f53d613c5ec9e819125e
-  data.tar.gz: 1541d15de381f59d4b75c46ae322e26e3e89ccc80549f7b11d55fa05cd32ccd314ca41f67724d310d56ce48d87c6aec3cfe4a1275a1295279ec6de6ef1cb48b2
+  metadata.gz: 9a53a48fd0f06f6ee754b9d78e27251a9768c9e227c6970807c85aefbc4e3a1f2d36fe90baa4d01867cef1f7a446ccc7d97177865a5e5da4760a5d75428338fe
+  data.tar.gz: 9c88141815dfc9b5e3299efa204d9bead7ecf89c91a58a66fdacc3544abca17afd65c265a8d0a484d4d90122835317449cd8d9bf875b594085244449989dfc73

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,7 +9,7 @@ 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
 
@@ -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
@@ -126,6 +126,20 @@ require 'selenium-webdriver'
 require 'site_prism'
 ```
 
+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
+
+Capybara.configure do |config|
+  config.default_driver = :site_prism
+end
+```
+
 ### Using SitePrism with RSpec
 
 If you're using rspec instead, here's what needs requiring:
@@ -137,6 +151,8 @@ require 'selenium-webdriver'
 require 'site_prism'
 ```
 
+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 +174,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 +184,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 +193,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 +348,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 +447,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 +468,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,7 +488,7 @@ 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
 ```
@@ -619,7 +635,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
 ```
@@ -660,7 +676,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
 ```
@@ -695,6 +711,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` in (default), will not change the functionality. However passing in `:one` will cause
+site_prism to recurse through all section / sections items defined in your current 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
+
+```rb
+SitePrism.use_all_there_gem = true
+```
+
+Make sure as well to require the gem code by doing `require 'site_prism/all_there'`
+
 ## Sections
 
 SitePrism allows you to model sections of a page that appear on multiple
@@ -750,7 +788,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
@@ -870,7 +908,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
@@ -886,7 +924,7 @@ particularly with nested sections. Some of this test code can be
 made a little prettier by simply passing a block in.
 
 ```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
   @home.menu do |menu|
     expect(menu).to have_search
     expect(menu.search['href']).to include('google.com')
@@ -902,27 +940,27 @@ 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
@@ -1043,7 +1081,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
@@ -1055,7 +1093,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
@@ -1132,7 +1170,7 @@ 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|
@@ -1143,7 +1181,7 @@ 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
@@ -1196,7 +1234,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
 ```
@@ -1397,7 +1435,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
@@ -1447,7 +1485,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
 ```
@@ -1580,7 +1618,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
 
@@ -1611,8 +1649,8 @@ 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 = 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
 ```
@@ -1635,6 +1673,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

@@ -15,6 +15,8 @@ module SitePrism
   autoload :Waiter, 'site_prism/waiter'
 
   class << self
+    attr_reader :use_all_there_gem
+
     def configure
       yield self
     end
@@ -65,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/dsl.rb

@@ -76,6 +76,7 @@ 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|
             raise_if_block(self, name, !element_block.nil?, :element)
@@ -85,6 +86,7 @@ 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|
             raise_if_block(self, name, !element_block.nil?, :elements)
@@ -120,6 +122,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
@@ -142,10 +145,11 @@ module SitePrism
       private
 
       def old_mapped_items
-        SitePrism.logger.debug("Calling .mapped_items on a class is changing!
-The structure will soon be changing format. This will allow #all_there? to
-recurse through section / sections going forwards. The old format will remain
-until a v5 has been released (And will be deprecated in v4 of site_prism")
+        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
 
@@ -196,9 +200,7 @@ until a v5 has been released (And will be deprecated in v4 of site_prism")
 
         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
 
@@ -247,7 +249,7 @@ until a v5 has been released (And will be deprecated in v4 of site_prism")
       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
 
@@ -273,7 +275,7 @@ until a v5 has been released (And will be deprecated in v4 of site_prism")
         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

@@ -24,7 +24,7 @@ module SitePrism
       if recursion == :none
         elements_to_check.all? { |name| there?(name) }
       elsif recursion == :one
-        RecursionChecker.new(self).all_there?
+        all_there_with_recursion
       else
         SitePrism.logger.debug("Input value '#{recursion}'. Valid values are :none or :one.")
         SitePrism.logger.error('Invalid recursion setting, Will not run #all_there?.')
@@ -37,6 +37,14 @@ module SitePrism
 
     private
 
+    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

data/lib/site_prism/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SitePrism
-  VERSION = '3.3'
+  VERSION = '3.4'
 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.3'
+  version: '3.4'
 platform: ruby
 authors:
-- Nat Ritmeyer
 - Luke Hill
+- Nat Ritmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -101,28 +101,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.73.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.73.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.4.0
+- !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.33.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -143,35 +157,35 @@ 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: 3.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.1
+        version: 3.9.3
 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: []
@@ -191,13 +205,13 @@ files:
 - 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: |-
   site_prism has now moved to a new organisation to facilitate better
   management of the codebase. The new organisation link is available at www.github.com/site-prism