site_prism 2.15 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4e3fd2e00cf2bb78219d9f9fbeabd2f7508acc6
-  data.tar.gz: 49f28a586eead92eaf7be65e8471a713a9d07f49
+  metadata.gz: 77f8efa7a200630bd4f6bb6c79afeb4e8e2a018f
+  data.tar.gz: ab7dd809c5018e60bbeb754e1c450c8cfc19b8a8
 SHA512:
-  metadata.gz: 054cfa56172cf001d9c3e3b131f9fb382fe901034bbf913831189a6b091e01f4ddc2e73af69c9c60ac5c7ad5fe32e1dc615eca04e84fe4a5aec398166c430b16
-  data.tar.gz: c539b113a2b70cb84467675346132599cc75512012860676ab21c53fd1b1e853d633809df6122d3bbaa0cc0295bc5ae2be5dc44626529799db25ac685c827ce0
+  metadata.gz: f3c9f957a980efd3262f028b211c8bb52a53d415a08e79e3b950b8d2ee90dad48bf74c2bd92a202f2fa4a4bae7f60d08d15d2176f539561ddfca7d98f81ce376
+  data.tar.gz: 3eba16133d0b5d874455f863aac542101137e446d3b81bd2e404f65dc69164572b2c5ff261db1b31cf2c797555ac9ada8166828e1ca2d1c34832db690c15ab64

data/README.md

@@ -13,7 +13,7 @@ Make sure to add your project/company to https://github.com/natritmeyer/site_pri
 
 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/development_setup.md)
+We have a brief set of setup docs [HERE](https://github.com/natritmeyer/site_prism/blob/master/development_setup.md)
 
 ## Supported Rubies / Browsers
 
@@ -35,7 +35,7 @@ class Home < SitePrism::Page
   set_url_matcher /google.com\/?/
 
   element :search_field, 'input[name="q"]'
-  element :search_button, "button[name='btnK']"
+  element :search_button, 'button[name="btnK"]'
   elements :footer_links, '#footer a'
   section :menu, MenuSection, '#gbx3'
 end
@@ -47,7 +47,7 @@ class SearchResults < SitePrism::Page
   sections :search_results, SearchResultSection, '#results li'
 
   def search_result_links
-    search_results.map {|sr| sr.title['href']}
+    search_results.map { |result| result.title['href'] }
   end
 end
 
@@ -79,7 +79,7 @@ Then(/^the home page should contain the menu and the search form$/) do
 end
 
 When(/^I search for Sausages$/) do
-  @home.search_field.set "Sausages"
+  @home.search_field.set 'Sausages'
   @home.search_button.click
 end
 
@@ -195,7 +195,7 @@ a simple example:
 
 ```ruby
 class UserProfile < SitePrism::Page
-  set_url "/users{/username}"
+  set_url '/users{/username}'
 end
 ```
 
@@ -203,7 +203,7 @@ end
 
 ```ruby
 class Search < SitePrism::Page
-  set_url "/search{?query*}"
+  set_url '/search{?query*}'
 end
 ```
 
@@ -225,7 +225,7 @@ The `#load` method takes parameters and will apply them to the URL. Using the ex
 
 ```ruby
 class UserProfile < SitePrism::Page
-  set_url "/users{/username}"
+  set_url '/users{/username}'
 end
 
 @user_profile = UserProfile.new
@@ -237,7 +237,7 @@ end
 
 ```ruby
 class Search < SitePrism::Page
-  set_url "/search{?query*}"
+  set_url '/search{?query*}'
 end
 
 @search = Search.new
@@ -259,7 +259,7 @@ currently viewed page.  For example, with the following URL template:
 
 ```ruby
 class Account < SitePrism::Page
-  set_url "/accounts/{id}{?query*}"
+  set_url '/accounts/{id}{?query*}'
 end
 ```
 

data/lib/site_prism.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'site_prism/exceptions'
+require 'site_prism/error'
 require 'addressable/template'
 
 module SitePrism

data/lib/site_prism/addressable_url_matcher.rb

@@ -5,11 +5,6 @@ require 'base64'
 
 module SitePrism
   class AddressableUrlMatcher
-    COMPONENT_NAMES = %i[scheme user password host
-                         port path query fragment ].freeze
-
-    COMPONENT_PREFIXES = { query: '?', fragment: '#' }.freeze
-
     attr_reader :pattern
 
     def initialize(pattern)
@@ -22,7 +17,7 @@ module SitePrism
     def mappings(url)
       uri = Addressable::URI.parse(url)
       result = {}
-      COMPONENT_NAMES.each do |component|
+      component_names.each do |component|
         component_result = component_matches(component, uri)
         return nil unless component_result
 
@@ -62,7 +57,7 @@ module SitePrism
     end
 
     def extract_component_templates
-      COMPONENT_NAMES.each_with_object({}) do |component, component_templates|
+      component_names.each_with_object({}) do |component, templates|
         component_url = to_substituted_uri.public_send(component).to_s
 
         next unless component_url && !component_url.empty?
@@ -71,15 +66,13 @@ module SitePrism
           component_url = component_url.sub(substituted_value, template_value)
         end
 
-        component_templates[component] =
-          Addressable::Template.new(component_url.to_s)
+        templates[component] = Addressable::Template.new(component_url)
       end
     end
 
-    # Returns empty hash if the template omits the component,
-    # a set of substitutions if the
-    # provided URI component matches the template component,
-    # or nil if the match fails.
+    # Returns empty hash if the template omits the component or a set of
+    # substitutions if the provided URI component matches the template
+    # component or nil if the match fails.
     def component_matches(component, uri)
       component_template = component_templates[component]
       return {} unless component_template
@@ -88,7 +81,7 @@ module SitePrism
       return mappings if mappings
       # to support Addressable's expansion of queries
       # ensure it's parsing the fragment as appropriate (e.g. {?params*})
-      prefix = COMPONENT_PREFIXES[component]
+      prefix = component_prefixes[component]
       return nil unless prefix
       component_template.extract(prefix + component_url)
     end
@@ -129,10 +122,9 @@ module SitePrism
       pattern.scan(/{[^}]+}/)
     end
 
-    # If a slug begins with non-alpha characters,
-    # it may denote the start of a new component (e.g. query or fragment).
-    # We emit this prefix as part of the substituted slug
-    # so that Addressable's URI parser can see it as such.
+    # If a slug begins with non-alpha characters, it may denote the start of
+    # a new component (e.g. query or fragment). We emit thie prefix as part of
+    # the substituted slug so that Addressable's URI parser can see it as such.
     def slug_prefix(slug)
       prefix = slug.match(/\A{([^A-Za-z]+)/)
       prefix && prefix[1] || ''
@@ -144,5 +136,13 @@ module SitePrism
       sha = Digest::SHA1.digest(index.to_s)
       Base64.urlsafe_encode64(sha).gsub(/[^A-Za-z]/, '')[0..5]
     end
+
+    def component_names
+      %i[scheme user password host port path query fragment]
+    end
+
+    def component_prefixes
+      { query: '?', fragment: '#' }
+    end
   end
 end

data/lib/site_prism/element_container.rb

@@ -12,8 +12,9 @@ module SitePrism
       Capybara.default_max_wait_time
     end
 
-    def raise_if_block(obj, name, has_block)
+    def raise_if_block(obj, name, has_block, type)
       return unless has_block
+      warn "Type passed in: #{type}"
 
       raise SitePrism::UnsupportedBlock, "#{obj.class}##{name}"
     end
@@ -62,7 +63,7 @@ module SitePrism
       def element(name, *find_args)
         build(name, *find_args) do
           define_method(name) do |*runtime_args, &element_block|
-            raise_if_block(self, name, !element_block.nil?)
+            raise_if_block(self, name, !element_block.nil?, :element)
             _find(*merge_args(find_args, runtime_args))
           end
         end
@@ -71,7 +72,7 @@ module SitePrism
       def elements(name, *find_args)
         build(name, *find_args) do
           define_method(name) do |*runtime_args, &element_block|
-            raise_if_block(self, name, !element_block.nil?)
+            raise_if_block(self, name, !element_block.nil?, :elements)
             _all(*merge_args(find_args, runtime_args))
           end
         end
@@ -101,7 +102,7 @@ module SitePrism
         section_class, find_args = extract_section_options(args, &block)
         build(name, *find_args) do
           define_method(name) do |*runtime_args, &element_block|
-            raise_if_block(self, name, !element_block.nil?)
+            raise_if_block(self, name, !element_block.nil?, :sections)
             _all(*merge_args(find_args, runtime_args)).map do |element|
               section_class.new(self, element)
             end
@@ -238,8 +239,7 @@ module SitePrism
 
       def create_no_selector(method_name)
         define_method(method_name) do
-          raise SitePrism::NoSelectorForElement.new,
-                "#{self.class.name} => :#{method_name} needs a selector"
+          raise SitePrism::NoSelectorForElement, "#{self.class}##{method_name}"
         end
       end
 

data/lib/site_prism/error.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module SitePrism
+  # Generic SitePrism family of errors which specific errors are children of
+  class SitePrismError < StandardError; end
+
+  # Generic PageLoad family of errors inherit from this error
+  class PageLoadError < SitePrismError; end
+
+  # A page calls #load with no URL set
+  class NoUrlForPageError < PageLoadError; end
+
+  # A page calls #displayed? with no URL matcher set
+  class NoUrlMatcherForPageError < PageLoadError; end
+
+  # The URL matcher was not recognised as a Regex or String and as such
+  # it couldn't be parsed by Addressable
+  class InvalidUrlMatcherError < PageLoadError
+    def message
+      warn 'Templated port numbers are unsupported.'
+
+      'Your URL and/or matcher could not be interpreted.'
+    end
+  end
+
+  # A SitePrism defined DSL item was defined without a selector
+  class InvalidElementError < SitePrismError
+    def message
+      "#{super} has been derived from an item with no selectors defined."
+    end
+  end
+
+  # The condition that was being evaluated inside the block did not evaluate
+  # to true within the time limit
+  class TimeoutError < SitePrismError
+    def message
+      "Timed out after #{super}s."
+    end
+  end
+
+  # These errors are not yet migrated and are fired from their source
+  # They are raised when the meta-programmed method has not yielded true
+  # in the prescribed time limit
+  class ExistenceTimeoutError < TimeoutError; end
+  class NonExistenceTimeoutError < TimeoutError; end
+  class ElementVisibilityTimeoutError < TimeoutError; end
+  class ElementInvisibilityTimeoutError < TimeoutError; end
+
+  # A Block was passed to the method, which it cannot interpret
+  class UnsupportedBlockError < SitePrismError
+    def message
+      warn 'section and iframe are the only items which can accept a block.'
+
+      "#{super} does not accept blocks."
+    end
+  end
+
+  # A Block was required, but not passed into the iframe at runtime
+  class MissingBlockError < SitePrismError
+    def message
+      'You can only use iFrames in a block context - Please pass in a block.'
+    end
+  end
+
+  # A page was loaded via #load - And then failed one of the load validations
+  # that was either pre-defined or defined by the user
+  class FailedLoadValidationError < PageLoadError
+    def message
+      if super == self.class.to_s
+        'Failed to load - No reason specified.'
+      else
+        "Failed to load. Reason: #{super}"
+      end
+    end
+  end
+
+  # Legacy Error Code aliases for backwards compatibility
+  NoUrlForPage                         = NoUrlForPageError
+  NoUrlMatcherForPage                  = NoUrlMatcherForPageError
+  InvalidUrlMatcher                    = InvalidUrlMatcherError
+  NoSelectorForElement                 = InvalidElementError
+  TimeoutException                     = TimeoutError
+  TimeOutWaitingForExistenceError      = Class.new(StandardError) # To avoid message leaking
+  TimeOutWaitingForNonExistenceError   = Class.new(StandardError) # To avoid message leaking
+  TimeOutWaitingForElementVisibility   = Class.new(StandardError) # To avoid message leaking
+  TimeOutWaitingForElementInvisibility = Class.new(StandardError) # To avoid message leaking
+  UnsupportedBlock                     = UnsupportedBlockError
+  BlockMissingError                    = MissingBlockError
+  NotLoadedError                       = FailedLoadValidationError
+end

data/lib/site_prism/loadable.rb

@@ -25,6 +25,10 @@ module SitePrism
       #
       # @param block [&block] A block which returns true if the page
       # loaded successfully, or false if it did not.
+      # This block can contain up to 2 elements in an array
+      # The first is the physical validation test to be truthily evaluated
+      # If this does not pass, then the 2nd item (If defined), is output
+      # as an error message to the NotLoadedError Error that will be thrown
       def load_validation(&block)
         _load_validations << block
       end
@@ -62,8 +66,7 @@ module SitePrism
       # Within the block, cache loaded? to optimize performance.
       self.loaded = loaded?
 
-      message = "Failed to load because: #{load_error || 'no reason given'}"
-      raise ::SitePrism::NotLoadedError, message unless loaded
+      raise SitePrism::NotLoadedError, load_error unless loaded
 
       yield self
     ensure

data/lib/site_prism/section.rb

@@ -8,6 +8,7 @@ module SitePrism
     include ElementChecker
     include Loadable
     include ElementContainer
+    extend Forwardable
 
     attr_reader :root_element, :parent
 
@@ -42,12 +43,13 @@ module SitePrism
       page.visible?
     end
 
-    def execute_script(input)
-      Capybara.current_session.execute_script(input)
-    end
+    def_delegators :capybara_session,
+                   :execute_script,
+                   :evaluate_script,
+                   :within_frame
 
-    def evaluate_script(input)
-      Capybara.current_session.evaluate_script(input)
+    def capybara_session
+      Capybara.current_session
     end
 
     def parent_page

data/lib/site_prism/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '2.15'
+  version: 2.15.1
 platform: ruby
 authors:
 - Nat Ritmeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-09 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -34,7 +34,7 @@ dependencies:
         version: '2.14'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
         version: '2.14'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -105,16 +105,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.58'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.58'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -135,14 +135,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.16'
 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.
@@ -159,7 +159,7 @@ files:
 - lib/site_prism/addressable_url_matcher.rb
 - lib/site_prism/element_checker.rb
 - lib/site_prism/element_container.rb
-- lib/site_prism/exceptions.rb
+- lib/site_prism/error.rb
 - lib/site_prism/loadable.rb
 - lib/site_prism/page.rb
 - lib/site_prism/section.rb

data/lib/site_prism/exceptions.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module SitePrism
-  class NoUrlForPage < StandardError; end
-  class NoUrlMatcherForPage < StandardError; end
-
-  class InvalidUrlMatcher < StandardError
-    def message
-      "Could not automatically match your URL. \
-Templated port numbers are unsupported."
-    end
-  end
-
-  class NoSelectorForElement < StandardError; end
-
-  class TimeoutException < StandardError
-    def message
-      "Timed out after #{super}s while waiting for block to evaluate as true."
-    end
-  end
-
-  class TimeOutWaitingForExistenceError < StandardError; end
-  class TimeOutWaitingForNonExistenceError < StandardError; end
-  class TimeOutWaitingForElementVisibility < StandardError; end
-  class TimeOutWaitingForElementInvisibility < StandardError; end
-
-  class UnsupportedBlock < StandardError
-    def message
-      "#{super} does not accept blocks, did you mean to define a (i)frame?"
-    end
-  end
-
-  class BlockMissingError < StandardError
-    def message
-      'You can only use iFrames in a block context. See docs for more details.'
-    end
-  end
-
-  NotLoadedError = Class.new(StandardError)
-end