site_prism 3.0.beta → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c72504b3ebac7b0209d022bfe8851bc1cedfebfae96b1647ae5fdb043282c49e
-  data.tar.gz: c6432642fb9b5ec2a7a3405a5011e66c8f76c673b5eb14971a3117ef48eda3b4
+  metadata.gz: e9eaed0d98cdcffc5d23f9c8cadf03b5cb343a5f8e65b7f9d96334442112c115
+  data.tar.gz: 5286b415093777314940312fff696f080b980eefdb4f9d9f4134559da56155ea
 SHA512:
-  metadata.gz: 75baa0fcc7a0844bc8eda684fcb7943bf67421e30f30b8e9d200c26021f7f6d303fae4d7b43355a89784e19578916113effc5fceb1ce9a1678b5b77ce3ccff50
-  data.tar.gz: bf020114f3bb95a330dcfb05d056f39bb299a7135ea80c75896bda135c5dd67058fe60549a624de6dc8da91cc2ee834b759556163c40ecf33e856045cbcca72b
+  metadata.gz: 889e8c4aad04e3ba37d2742cdaeae1234a1665297c2fd295495fedf91eeefc7b0e21a118a63c4b86a7d2492a07685b92cf39792b6bc781a3e5e82b03720090ae
+  data.tar.gz: 828b1e6e1693c506dc082babb9bc51049a28d32aa04ea37483f8a2d89cde8e63a6392b0f4b85b52d33d22b084234d6b3ecb81e3941e6b4e7a4fe688c5469285c

data/LICENSE.md

@@ -1,4 +1,5 @@
-Copyright (c) 2011-2018, Nathaniel Ritmeyer
+Copyright (c) 2011-2018, Nathaniel Ritmeyer & the Site Prism team
+
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/lib/site_prism.rb

@@ -4,17 +4,27 @@ require 'site_prism/error'
 require 'addressable/template'
 
 module SitePrism
-  autoload :ElementContainer, 'site_prism/element_container'
+  autoload :AddressableUrlMatcher, 'site_prism/addressable_url_matcher'
   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'
   autoload :Waiter, 'site_prism/waiter'
-  autoload :AddressableUrlMatcher, 'site_prism/addressable_url_matcher'
 
   class << self
+    attr_writer :enable_logging
+
     def configure
-      warn 'SitePrism configuration is now removed.'
-      warn 'All options fed directly from Capybara.'
+      yield self
+    end
+
+    def logger
+      @logger ||= SitePrism::Logger.new.create
+    end
+
+    def enable_logging
+      @enable_logging ||= false
     end
   end
 end

data/lib/site_prism/addressable_url_matcher.rb

@@ -33,6 +33,7 @@ module SitePrism
     def matches?(url, expected_mappings = {})
       actual_mappings = mappings(url)
       return false unless actual_mappings
+
       expected_mappings.empty? ||
         all_expected_mappings_match?(expected_mappings, actual_mappings)
     end
@@ -76,13 +77,16 @@ module SitePrism
     def component_matches(component, uri)
       component_template = component_templates[component]
       return {} unless component_template
+
       component_url = uri.public_send(component).to_s
       mappings = component_template.extract(component_url)
       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]
       return nil unless prefix
+
       component_template.extract(prefix + component_url)
     end
 
@@ -90,12 +94,11 @@ module SitePrism
     # the template slugs with nonsense strings.
     def to_substituted_uri
       url = pattern
-      substitutions.each_pair do |slug, value|
-        url = url.sub(slug, value)
-      end
+      substitutions.each_pair { |slug, value| url = url.sub(slug, value) }
       begin
         Addressable::URI.parse(url)
       rescue Addressable::URI::InvalidURIError
+        SitePrism.logger.warn("Ensure you don't use templated port numbers.")
         raise SitePrism::InvalidUrlMatcherError
       end
     end

data/lib/site_prism/element_checker.rb

@@ -3,11 +3,11 @@
 module SitePrism
   module ElementChecker
     def all_there?
-      elements_to_check.all? { |element| present?(element) }
+      elements_to_check.all? { |element| there?(element) }
     end
 
     def elements_present
-      mapped_items.select { |item_name| present?(item_name) }
+      mapped_items.select { |item_name| there?(item_name) }
     end
 
     private
@@ -26,7 +26,7 @@ module SitePrism
       self.class.mapped_items.uniq
     end
 
-    def present?(element)
+    def there?(element)
       send("has_#{element}?")
     end
   end

data/lib/site_prism/element_container.rb

@@ -14,31 +14,44 @@ module SitePrism
 
     def raise_if_block(obj, name, has_block, type)
       return unless has_block
-      warn "Type passed in: #{type}"
 
-      raise SitePrism::UnsupportedBlockError, "#{obj.class}##{name}"
+      SitePrism.logger.debug("Type passed in: #{type}")
+      SitePrism.logger.warn('section / iFrame can only accept blocks.')
+      SitePrism.logger.error("#{obj.class}##{name} does not accept blocks")
+
+      raise SitePrism::UnsupportedBlockError
     end
 
     # Sanitize method called before calling any SitePrism DSL method or
     # meta-programmed method. This ensures that the Capybara query is correct.
+    #
     # Accepts any combination of arguments sent at DSL definition or runtime
     # and combines them in such a way that Capybara can operate with them.
-    # Initially it will duplicate all locators and run-time arguments,
-    # then it will combine them with any visibility arguments if defined.
     def merge_args(find_args, runtime_args, visibility_args = {})
       find_args = find_args.dup
       runtime_args = runtime_args.dup
+      options = visibility_args.dup
+      SitePrism.logger.debug("Initial args: #{find_args}, #{runtime_args}.")
 
-      options = visibility_args
-      options.merge!(find_args.pop) if find_args.last.is_a? Hash
-      options.merge!(runtime_args.pop) if runtime_args.last.is_a? Hash
-      options[:wait] = wait_time unless wait_key_present?(options)
+      recombine_args(find_args, runtime_args, options)
 
       return [*find_args, *runtime_args] if options.empty?
 
       [*find_args, *runtime_args, options]
     end
 
+    # Options re-combiner. This takes the original inputs and combines
+    # them such that there is only one hash passed as a final argument
+    # to Capybara.
+    #
+    # If the hash is empty, then the hash is omitted from the payload sent
+    # to Capybara, and the find / runtime arguments are sent alone.
+    def recombine_args(find_args, runtime_args, options)
+      options.merge!(find_args.pop) if find_args.last.is_a? Hash
+      options.merge!(runtime_args.pop) if runtime_args.last.is_a? Hash
+      options[:wait] = wait_time unless wait_key_present?(options)
+    end
+
     def wait_key_present?(options)
       options.key?(:wait)
     end
@@ -114,7 +127,7 @@ module SitePrism
 
       def build(name, *find_args)
         if find_args.empty?
-          create_no_selector(name)
+          create_error_method(name)
         else
           add_to_mapped_items(name)
           yield
@@ -136,7 +149,7 @@ module SitePrism
 
       def create_helper_method(proposed_method_name, *find_args)
         if find_args.empty?
-          create_no_selector(proposed_method_name)
+          create_error_method(proposed_method_name)
         else
           yield
         end
@@ -168,6 +181,7 @@ module SitePrism
           define_method(method_name) do |*runtime_args|
             args = merge_args(find_args, runtime_args, visible: true)
             return true if element_exists?(*args)
+
             raise SitePrism::ElementVisibilityTimeoutError
           end
         end
@@ -179,14 +193,17 @@ module SitePrism
           define_method(method_name) do |*runtime_args|
             args = merge_args(find_args, runtime_args, visible: true)
             return true if element_does_not_exist?(*args)
+
             raise SitePrism::ElementInvisibilityTimeoutError
           end
         end
       end
 
-      def create_no_selector(method_name)
-        define_method(method_name) do
-          raise SitePrism::InvalidElementError, "#{self.class}##{method_name}"
+      def create_error_method(name)
+        SitePrism.logger.debug("#{name} has come from an item with 0 locators.")
+
+        define_method(name) do
+          raise SitePrism::InvalidElementError
         end
       end
 

data/lib/site_prism/error.rb

@@ -16,40 +16,28 @@ module SitePrism
   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
+  # it couldn't be parsed by Addressable. It also could be caused by
+  # the usage of templated port numbers - which aren't supported
   # Formerly known as `InvalidUrlMatcher`
-  class InvalidUrlMatcherError < PageLoadError
-    def message
-      warn 'Templated port numbers are unsupported.'
-
-      'Your URL and/or matcher could not be interpreted.'
-    end
-  end
+  class InvalidUrlMatcherError < PageLoadError; end
 
   # A SitePrism defined DSL item was defined without a selector
   # Formerly known as `NoSelectorForElement`
-  class InvalidElementError < SitePrismError
-    def message
-      "#{super} has been derived from an item with no selectors defined."
-    end
-  end
+  class InvalidElementError < SitePrismError; end
 
   # The condition that was being evaluated inside the block did not evaluate
   # to true within the time limit
   # Formerly known as `TimeoutException`
   class TimeoutError < SitePrismError; 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
-  # Formerly known as `TimeOutWaitingForExistenceError`,
-  # `TimeOutWaitingForNonExistenceError`
-  # `TimeOutWaitingForElementVisibility` and
-  # `TimeOutWaitingForElementInvisibility` respectively
-
-  class ExistenceTimeoutError < TimeoutError; end
-  class NonExistenceTimeoutError < TimeoutError; end
+  # The wait_until_*_visible meta-programmed method didn't evaluate to true
+  # within the prescribed time limit
+  # Formerly known as `TimeOutWaitingForElementVisibility`
   class ElementVisibilityTimeoutError < TimeoutError; end
+
+  # The wait_until_*_invisible meta-programmed method didn't evaluate to true
+  # within the prescribed time limit
+  # Formerly known as `TimeOutWaitingForElementInvisibility`
   class ElementInvisibilityTimeoutError < TimeoutError; end
 
   # Generic Block validation family of errors inherit from this error
@@ -57,32 +45,13 @@ module SitePrism
 
   # A Block was passed to the method, which it cannot interpret
   # Formerly known as `UnsupportedBlock`
-  class UnsupportedBlockError < BlockError
-    def message
-      warn 'section and iframe are the only items which can accept a block.'
-
-      "#{super} does not accept blocks."
-    end
-  end
+  class UnsupportedBlockError < BlockError; end
 
-  # A Block was required, but not passed into the iframe at runtime
+  # A Block was required, but not supplied
   # Formerly known as `BlockMissingError`
-  class MissingBlockError < BlockError
-    def message
-      'You can only use iFrames in a block context - Please pass in a block.'
-    end
-  end
+  class MissingBlockError < BlockError; 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
+  # A page was loaded then failed one of the validations defined by the user
   # Formerly known as `NotLoadedError`
-  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
+  class FailedLoadValidationError < PageLoadError; end
 end

data/lib/site_prism/loadable.rb

@@ -53,19 +53,22 @@ module SitePrism
     # Executes the given block after the page is loaded.
     #
     # The loadable object instance is yielded into the block.
-    #
-    # @param block [&block] The block to be executed once the page
-    # has finished loading.
-    def when_loaded(&_block)
+    def when_loaded
       # Get original loaded value, in case we are nested
       # inside another when_loaded block.
       previously_loaded = loaded
-      message = 'A block was expected, but none received.'
-      raise ArgumentError, message unless block_given?
 
-      # Within the block, cache loaded? to optimize performance.
+      # Ensure we have passed in a block. else stop the system.
+      # This would be because a user has not defined the load validation
+      # correctly (i.e. with a block argument)
+      throw_missing_block_error unless block_given?
+
+      # Within the block, check (and cache) loaded?, to see whether the
+      # page has indeed loaded according to the rules defined by the user.
       self.loaded = loaded?
 
+      # If the page hasn't loaded. Then crash and return the error message.
+      # If one isn't defined, just return the Error code.
       raise SitePrism::FailedLoadValidationError, load_error unless loaded
 
       yield self
@@ -99,5 +102,11 @@ module SitePrism
         passed
       end
     end
+
+    def throw_missing_block_error
+      SitePrism.logger.debug('This code point should not be reachable')
+      SitePrism.logger.error('A block was expected, but none received.')
+      raise SitePrism::MissingBlockError
+    end
   end
 end

data/lib/site_prism/logger.rb

@@ -0,0 +1,35 @@
+require 'logger'
+
+module SitePrism
+  # To enable full logging
+  #   SitePrism.enable_logging = true
+  #
+  # To disable all logging (Done by default)
+  #   SitePrism.enable_logging = false
+  #
+  # To Manually log a message
+  #   SitePrism.logger.info('Information')
+  #   SitePrism.logger.debug('Input debug message')
+  class Logger
+    def create(output = $stdout)
+      logger = ::Logger.new(output)
+      logger.progname = 'SitePrism'
+      logger.level = log_level
+      logger.formatter = proc do |severity, time, progname, msg|
+        "#{time.strftime('%F %T')} - #{severity} - #{progname} - #{msg}\n"
+      end
+
+      logger
+    end
+
+    private
+
+    def log_level
+      if SitePrism.enable_logging
+        0 # This is equivalent to debug standard logging
+      else
+        5 # This is equivalent to unknown (or no), logging
+      end
+    end
+  end
+end

data/lib/site_prism/page.rb

@@ -9,6 +9,22 @@ module SitePrism
     include Loadable
     include ElementContainer
 
+    class << self
+      attr_reader :url
+
+      def set_url(page_url)
+        @url = page_url.to_s
+      end
+
+      def set_url_matcher(page_url_matcher)
+        @url_matcher = page_url_matcher
+      end
+
+      def url_matcher
+        @url_matcher || url
+      end
+    end
+
     # When instantiating the page. A default validation will be added to all
     # validations you define and add to the Page Class.
     # When calling #load, all of the validations that are set will be ran
@@ -34,6 +50,7 @@ module SitePrism
       else
         expanded_url = url(expansion_or_html)
         raise SitePrism::NoUrlForPageError unless expanded_url
+
         visit expanded_url
         when_loaded(&block) if block_given?
       end
@@ -42,8 +59,8 @@ module SitePrism
     def displayed?(*args)
       expected_mappings = args.last.is_a?(::Hash) ? args.pop : {}
       seconds = !args.empty? ? args.first : Capybara.default_max_wait_time
-
       raise SitePrism::NoUrlMatcherForPageError unless url_matcher
+
       begin
         Waiter.wait_until_true(seconds) { url_matches?(expected_mappings) }
       rescue SitePrism::TimeoutError
@@ -61,24 +78,9 @@ module SitePrism
       end
     end
 
-    def self.set_url(page_url)
-      @url = page_url.to_s
-    end
-
-    def self.set_url_matcher(page_url_matcher)
-      @url_matcher = page_url_matcher
-    end
-
-    class << self
-      attr_reader :url
-    end
-
-    def self.url_matcher
-      @url_matcher || url
-    end
-
     def url(expansion = {})
       return nil if self.class.url.nil?
+
       Addressable::Template.new(self.class.url).expand(expansion).to_s
     end
 

data/lib/site_prism/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: 3.0.beta
+  version: '3.0'
 platform: ruby
 authors:
 - Nat Ritmeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -17,34 +17,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '2.17'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '2.17'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +161,7 @@ files:
 - lib/site_prism/element_container.rb
 - lib/site_prism/error.rb
 - lib/site_prism/loadable.rb
+- lib/site_prism/logger.rb
 - lib/site_prism/page.rb
 - lib/site_prism/section.rb
 - lib/site_prism/version.rb
@@ -183,9 +184,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.7