site_prism 3.1 → 3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ccf39fa12f16a3de0a020f5cc51bd0e8809424392120c490b5735c7bddf8eb8
-  data.tar.gz: bd6daa8edb638af906e6582388aca9fb2185af9b71ac1bd27cddf8a7b0f1a78c
+  metadata.gz: 2bb0a772ccdabf209eba492206b0c664418fa46f1b2bdb2c8d08cbcf384b5522
+  data.tar.gz: be9c7ca220f2a20122a3bfd955fa617acda1ecb3d6aedac9472300f4c17ff014
 SHA512:
-  metadata.gz: 0c84412248c810e5539053376619abe431912f33cdc903ed8455444d2b866b6287cdec771f8045d365660c28a5f9eaac4222059172b0f4b8e42424ab0c9f884a
-  data.tar.gz: a385856b1c97a688d42a58e6ef36c4ca7e9f71a004065e505b58e0797f47c54b7ecb41a8721353b6f9625274f266768ba1492265665f4ecbd12230eff09ceae7
+  metadata.gz: d21079c647c16bcb896374557448fc9c514ce8d3d16379e77f64be741b2ef76f7c2438ff9fd3d0f5bdd96a3678d92b40e162d3847a04647de1ed553b7a786b2f
+  data.tar.gz: bf7ea9e4ff98d6ae92427a98b21a35bd519638080c5b3c55f9565e163710b748c11152374293ee783d32a1f1ef599bbac5be99a56f696d144fb1f53d0d7836d4

data/README.md

@@ -1345,6 +1345,18 @@ Load validations may be defined on `SitePrism::Page` and `SitePrism::Section`
 classes (herein referred to as `Loadables`) and are evaluated against an
 instance of the class when created.
 
+### Skipping load Validations
+
+Defined load validations can be skipped for one `load` call by 
+passing in `with_validations: false`.
+
+```ruby
+it 'loads the page without validations' do
+  some_page.load(with_validations: false)
+  some_page.loaded?    #=> true unless something has gone wrong
+end
+```
+
 ### Load Validation Inheritance and Execution Order
 
 Any number of load validations may be defined on a Loadable and they are

data/lib/site_prism/dsl.rb

@@ -122,14 +122,11 @@ module SitePrism
       def iframe(name, klass, *args)
         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
           define_method(name) do |&block|
             raise MissingBlockError unless block
 
-            within_frame(*scope_find_args) do
-              block.call(klass.new)
-            end
+            within_frame(*scope_find_args) { block.call(klass.new) }
           end
         end
       end
@@ -157,6 +154,7 @@ module SitePrism
       def add_helper_methods(name, *find_args)
         create_existence_checker(name, *find_args)
         create_nonexistence_checker(name, *find_args)
+        create_rspec_existence_matchers(name) if defined?(RSpec)
         create_visibility_waiter(name, *find_args)
         create_invisibility_waiter(name, *find_args)
       end
@@ -169,6 +167,18 @@ module SitePrism
         end
       end
 
+      def create_rspec_existence_matchers(element_name)
+        matcher = "has_#{element_name}?"
+        negated_matcher = "has_no_#{element_name}?"
+
+        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
+        end
+      end
+
       def create_existence_checker(element_name, *find_args)
         method_name = "has_#{element_name}?"
         create_helper_method(method_name, *find_args) do
@@ -215,10 +225,7 @@ module SitePrism
 
       def create_error_method(name)
         SitePrism.logger.error("#{name} has come from an item with 0 locators.")
-
-        define_method(name) do
-          raise SitePrism::InvalidElementError
-        end
+        define_method(name) { raise SitePrism::InvalidElementError }
       end
 
       def deduce_iframe_scope_find_args(args)
@@ -242,8 +249,7 @@ module SitePrism
       def warn_on_invalid_selector_input(args)
         return unless looks_like_xpath?(args[0])
 
-        msg = 'The arguments passed in look like xpath. Check your locators.'
-        SitePrism.logger.warn(msg)
+        SitePrism.logger.warn('The arguments passed in look like xpath. Check your locators.')
         SitePrism.logger.debug("Default locator: #{Capybara.default_selector}")
       end
 

data/lib/site_prism/error.rb

@@ -25,6 +25,14 @@ 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/page.rb

@@ -64,18 +64,20 @@ module SitePrism
     end
 
     def displayed?(*args)
-      expected_mappings = args.last.is_a?(::Hash) ? args.pop : {}
-      seconds = !args.empty? ? args.first : Capybara.default_max_wait_time
+      wait_until_displayed(*args)
+    rescue SitePrism::TimeoutError
+      false
+    end
+
+    def wait_until_displayed(*args)
       raise SitePrism::NoUrlMatcherForPageError unless url_matcher
 
-      begin
-        Waiter.wait_until_true(seconds) { url_matches?(expected_mappings) }
-      rescue SitePrism::TimeoutError
-        false
-      end
+      expected_mappings = args.last.is_a?(::Hash) ? args.pop : {}
+      seconds = args&.first || wait_time
+      Waiter.wait_until_true(seconds) { url_matches?(expected_mappings) }
     end
 
-    def url_matches(seconds = Capybara.default_max_wait_time)
+    def url_matches(seconds = wait_time)
       return unless displayed?(seconds)
 
       if url_matcher.is_a?(Regexp)
@@ -153,11 +155,16 @@ module SitePrism
     end
 
     def load_html_website(html, &block)
+      with_validations = html.delete(:with_validations) { true }
       expanded_url = url(html)
       raise SitePrism::NoUrlForPageError unless expanded_url
 
       visit expanded_url
-      when_loaded(&block)
+      if with_validations
+        when_loaded(&block)
+      elsif block_given?
+        yield self
+      end
     end
   end
   # rubocop:enable Metrics/ClassLength

data/lib/site_prism/version.rb

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

data/lib/site_prism/waiter.rb

@@ -2,17 +2,33 @@
 
 module SitePrism
   class Waiter
-    def self.wait_until_true(wait_time = Capybara.default_max_wait_time)
-      start_time = Time.now
+    class << self
+      def wait_until_true(wait_time = Capybara.default_max_wait_time)
+        start_time = Time.now
 
-      loop do
-        return true if yield
-        break if Time.now - start_time > wait_time
+        loop do
+          return true if yield
+          break if Time.now - start_time > wait_time
 
-        sleep(0.05)
+          sleep(0.05)
+
+          check_for_time_stopped!(start_time)
+        end
+
+        raise SitePrism::TimeoutError, "Timed out after #{wait_time}s."
       end
 
-      raise SitePrism::TimeoutError, "Timed out after #{wait_time}s."
+      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/natritmeyer/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.1'
+  version: '3.2'
 platform: ruby
 authors:
 - Nat Ritmeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -101,14 +101,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.0
+        version: 0.67.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.0
+        version: 0.67.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -137,8 +151,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.1
+  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 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
@@ -165,7 +194,7 @@ 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/HISTORY.md
+  changelog_uri: https://github.com/natritmeyer/site_prism/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/natritmeyer/site_prism
 post_install_message: 
 rdoc_options: []