site_prism 3.4.1 → 3.7.1

data/lib/site_prism/element_checker.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module SitePrism
+  # [SitePrism::ElementChecker]
+  #
+  # This allows users to run `#all_there?` checks on an instance.
+  #
+  # NB: This functionality is being removed in v4 in favour of the all_there gem
   module ElementChecker
     # Runnable in the scope of any SitePrism::Page or Section.
     # Returns +true+ when "every item" that is being checked is
@@ -21,10 +26,9 @@ module SitePrism
     # 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
+      case recursion
+      when :none; then elements_to_check.all? { |name| there?(name) }
+      when :one;  then 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?.')
@@ -35,6 +39,10 @@ module SitePrism
       _mapped_items.select { |name| there?(name) }
     end
 
+    def elements_missing
+      elements_to_check.reject { |name| there?(name) }
+    end
+
     private
 
     def all_there_with_recursion

data/lib/site_prism/error.rb

@@ -25,14 +25,6 @@ module SitePrism
   # Formerly known as `NoSelectorForElement`
   class InvalidElementError < SitePrismError; end
 
-  # A tool like Timecop is being used to "freeze time" by overriding Time.now
-  # and similar methods. In this case, our waiter functions won't work, because
-  # Time.now does not change.
-  # If you encounter this issue, check that you are not doing Timecop.freeze without
-  # an accompanying Timecop.return.
-  # Also check out Timecop.safe_mode https://github.com/travisjeffery/timecop#timecopsafe_mode
-  class FrozenInTimeError < SitePrismError; end
-
   # The condition that was being evaluated inside the block did not evaluate
   # to true within the time limit
   # Formerly known as `TimeoutException`

data/lib/site_prism/loadable.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 module SitePrism
+  # [SitePrism::Loadable]
+  #
+  # SitePrism Loadable's are defined as checks or waiters which "must" pass before
+  # the rest of the loading logic can be performed on a class or section.
+  #
+  # Loadable's are primarily used with the `#load` method which will auto-execute them all
+  # in their defined order. But they can be used dynamically wherever desired.
   module Loadable
     module ClassMethods
       # The list of load_validations.

data/lib/site_prism/page.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'site_prism/loadable'
-
 module SitePrism
-  # rubocop:disable Metrics/ClassLength
   class Page
     include Capybara::DSL
     include ElementChecker
@@ -27,11 +24,7 @@ module SitePrism
     end
 
     def page
-      if defined?(@page)
-        @page
-      else
-        Capybara.current_session
-      end
+      (defined?(@page) && @page) || Capybara.current_session
     end
 
     # Loads the page.
@@ -73,24 +66,19 @@ module SitePrism
       raise SitePrism::NoUrlMatcherForPageError unless url_matcher
 
       expected_mappings = args.last.is_a?(::Hash) ? args.pop : {}
-      seconds = args&.first || wait_time
+      seconds = args&.first || Capybara.default_max_wait_time
       Waiter.wait_until_true(seconds) { url_matches?(expected_mappings) }
     end
 
-    def url_matches(seconds = wait_time)
+    def url_matches(seconds = Capybara.default_max_wait_time)
       return unless displayed?(seconds)
+      return regexp_backed_matches if url_matcher.is_a?(Regexp)
 
-      if url_matcher.is_a?(Regexp)
-        regexp_backed_matches
-      else
-        template_backed_matches
-      end
+      template_backed_matches
     end
 
     def url(expansion = {})
-      return nil if self.class.url.nil?
-
-      Addressable::Template.new(self.class.url).expand(expansion).to_s
+      self.class.url && Addressable::Template.new(self.class.url).expand(expansion).to_s
     end
 
     def url_matcher
@@ -103,22 +91,6 @@ module SitePrism
 
     private
 
-    def _find(*find_args)
-      page.find(*find_args)
-    end
-
-    def _all(*find_args)
-      page.all(*find_args)
-    end
-
-    def element_exists?(*find_args)
-      page.has_selector?(*find_args)
-    end
-
-    def element_does_not_exist?(*find_args)
-      page.has_no_selector?(*find_args)
-    end
-
     def regexp_backed_matches
       url_matcher.match(page.current_url)
     end
@@ -167,5 +139,4 @@ module SitePrism
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/site_prism/recursion_checker.rb

@@ -3,6 +3,7 @@
 module SitePrism
   class RecursionChecker
     attr_reader :instance
+
     private :instance
 
     def initialize(instance)
@@ -28,7 +29,7 @@ module SitePrism
         expected(mapped_items, :elements),
         expected(mapped_items, :section),
         expected(mapped_items, :sections),
-        expected(mapped_items, :iframe),
+        expected(mapped_items, :iframe)
       ]
     end
 

data/lib/site_prism/rspec_matchers.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class RspecMatchers
+    attr_reader :element_name
+
+    def initialize(element_name)
+      @element_name = element_name
+    end
+
+    def _create_rspec_existence_matchers
+      SitePrism.logger.debug('Including all relevant matcher names / warnings in RSpec scope.')
+      create_rspec_existence_matchers(matcher, object_method, negated_object_method, warning)
+    end
+
+    private
+
+    def create_rspec_existence_matchers(matcher, object_method, negated_object_method, warning)
+      RSpec::Matchers.define(matcher) do |*args|
+        match { |actual| actual.public_send(object_method, *args) }
+        match_when_negated do |actual|
+          return actual.public_send(negated_object_method, *args) if actual.respond_to?(negated_object_method)
+
+          SitePrism.logger.debug(warning)
+          !actual.public_send(object_method, *args)
+        end
+      end
+    end
+
+    def matcher
+      "have_#{element_name}"
+    end
+
+    def object_method
+      "has_#{element_name}?"
+    end
+
+    def negated_object_method
+      "has_no_#{element_name}?"
+    end
+
+    def warning
+      "The RSpec matcher '#{matcher}' was added by SitePrism, but the object under test "\
+        "does not respond to '#{negated_object_method}' and is probably not a SitePrism object. "\
+        'Falling back to the default RSpec matcher.'
+    end
+  end
+end

data/lib/site_prism/section.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'site_prism/loadable'
-
 module SitePrism
   class Section
-    include Capybara::DSL
     include ElementChecker
     include Loadable
     include DSL
@@ -12,44 +9,67 @@ module SitePrism
 
     attr_reader :root_element, :parent
 
-    def self.set_default_search_arguments(*args)
-      @default_search_arguments = args
-    end
+    class << self
+      def set_default_search_arguments(*args)
+        @default_search_arguments = args
+      end
+
+      def default_search_arguments
+        return @default_search_arguments if @default_search_arguments
+
+        superclass.respond_to?(:default_search_arguments) && superclass.default_search_arguments
+      end
 
-    def self.default_search_arguments
-      @default_search_arguments ||
-        (
-          superclass.respond_to?(:default_search_arguments) &&
-          superclass.default_search_arguments
-        ) ||
-        nil
+      private
+
+      def root_element_methods
+        ::Capybara::Session::NODE_METHODS + %i[native visible?]
+      end
+
+      def session_methods
+        ::Capybara::Session::DSL_METHODS - root_element_methods
+      end
     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
 
-    # Capybara::DSL module "delegates" Capybara methods to the "page" method
-    # as such we need to overload this method so that the correct scoping
-    # occurs and calls within a section (For example section.find(element))
-    # correctly scope to look within the section only
-    def page
-      return root_element if root_element
+    # Send all root_element methods through `#root_element`
+    # NB: This requires a method called `#to_capybara_node` being created and
+    # then set to this value (Capybara agnostic API)
+    root_element_methods.each do |method|
+      def_delegators :root_element, method
+    end
+
+    # Send all methods that previously acted on the `#page` method that existed previously
+    # through to the same location - But directly as `Capybara.current_session`
+    session_methods.each do |method|
+      def_delegators :capybara_session, method
+    end
 
-      SitePrism.logger.warn('Root Element not found; Falling back to `super`')
-      super
+    # This scopes our calls inside Section correctly to the `Capybara::Node::Element`
+    def to_capybara_node
+      root_element
     end
 
-    def visible?
-      page.visible?
+    # This allows us to return anything thats passed in as a block to the section at
+    # creation time, so that an anonymous section or such-like will have the extra methods
+    def within
+      Capybara.within(root_element) { yield(self) }
     end
 
-    def_delegators :capybara_session,
-                   :execute_script,
-                   :evaluate_script,
-                   :within_frame
+    # This was the old API-style of delegating through the Capybara.page call and over-loading
+    # the method so we always went through our correct `root_element`
+    def page
+      SitePrism::Deprecator.deprecate('Using page inside section')
+      return root_element if root_element
+
+      SitePrism.logger.warn('Root Element not found; Falling back to Capybara.current_session')
+      capybara_session
+    end
 
     def capybara_session
       Capybara.current_session
@@ -60,27 +80,5 @@ module SitePrism
       candidate = candidate.parent until candidate.is_a?(SitePrism::Page)
       candidate
     end
-
-    def native
-      root_element.native
-    end
-
-    private
-
-    def _find(*find_args)
-      page.find(*find_args)
-    end
-
-    def _all(*find_args)
-      page.all(*find_args)
-    end
-
-    def element_exists?(*find_args)
-      page.has_selector?(*find_args)
-    end
-
-    def element_does_not_exist?(*find_args)
-      page.has_no_selector?(*find_args)
-    end
   end
 end

data/lib/site_prism/timer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class Timer
+    attr_reader :wait_time
+
+    def self.run(wait_time, &block)
+      new(wait_time).run(&block)
+    end
+
+    def initialize(wait_time)
+      @wait_time = wait_time
+      @done = false
+    end
+
+    def done?
+      @done == true
+    end
+
+    def run
+      start
+      yield self
+    ensure
+      stop
+    end
+
+    def start
+      stop
+      return if wait_time.zero?
+
+      @done = false
+      @thread = Thread.start do
+        sleep wait_time
+        @done = true
+      end
+    end
+
+    def stop
+      if @thread
+        @thread.kill
+        @thread.join
+        @thread = nil
+      end
+      @done = true
+    end
+  end
+end

data/lib/site_prism/version.rb

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

data/lib/site_prism/waiter.rb

@@ -2,33 +2,20 @@
 
 module SitePrism
   class Waiter
-    class << self
-      def wait_until_true(wait_time = Capybara.default_max_wait_time)
-        start_time = Time.now
+    def self.sleep_duration
+      0.05
+    end
 
+    def self.wait_until_true(wait_time = Capybara.default_max_wait_time)
+      Timer.run(wait_time) do |timer|
         loop do
           return true if yield
-          break if Time.now - start_time > wait_time
-
-          sleep(0.05)
+          break if timer.done?
 
-          check_for_time_stopped!(start_time)
+          sleep(sleep_duration)
         end
-
         raise SitePrism::TimeoutError, "Timed out after #{wait_time}s."
       end
-
-      private
-
-      def check_for_time_stopped!(start_time)
-        return unless start_time == Time.now
-
-        raise(
-          SitePrism::FrozenInTimeError,
-          'Time appears to be frozen. For more info, see ' \
-          'https://github.com/site-prism/site_prism/blob/master/lib/site_prism/error.rb'
-        )
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.7.1
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -31,126 +31,152 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: site_prism-all_there
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        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: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 0.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 0.90.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 1.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 1.38.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.11'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -171,18 +197,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        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.
+        version: '4.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:
 - lukehill_uk@hotmail.com
 - nat@natontesting.com
@@ -202,7 +226,9 @@ files:
 - lib/site_prism/logger.rb
 - lib/site_prism/page.rb
 - lib/site_prism/recursion_checker.rb
+- lib/site_prism/rspec_matchers.rb
 - lib/site_prism/section.rb
+- lib/site_prism/timer.rb
 - lib/site_prism/version.rb
 - lib/site_prism/waiter.rb
 homepage: https://github.com/site-prism/site_prism
@@ -210,15 +236,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/site-prism/site_prism/issues
-  changelog_uri: https://github.com/site-prism/site_prism/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/site-prism/site_prism/blob/main/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
-  and will house the site_prism gem plus new associated co-dependent gems.
-
-  NB: The old repo will soon be discontinued and all existing issues will be moved over to the new
-  repo.
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -226,15 +246,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A Page Object Model DSL for Capybara