ae_page_objects 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37647af3548c32ece7a0c1097ea2f76cdadb9257
-  data.tar.gz: bb6472c8b228dec715c2bab1b3d5ce8186eea420
+  metadata.gz: 545addc7d4b910134d2bbb7a29b6ec990cc190e5
+  data.tar.gz: 747b5268236901cc5cdf3bfadfa50ff2e9b6cd80
 SHA512:
-  metadata.gz: 6324e07193b89af313304a1fa1847e308f0231551dea1748c579bb9461a0ab25799ed9f7c0f5b8dabc213773b1cd55a24f51d7d6a551d00a2a6cc3a4597c87ee
-  data.tar.gz: 919e40103c069c3f2c7938afcdec2a15926b0a3ec5dc1fddd9bf7a57fd77391e9b73554fdece836ae93dc7780251cb0b7dbed2c6df0b01ff560423f1fe2d9edd
+  metadata.gz: ccff7683bc850c05d0e5f055fa39e92f4bee5f489e43cd1a01a97a90a931802ea493c5f9baa666bf89728f4c0f0a8e35ee281cd8eca869f7482cff47195ba289
+  data.tar.gz: eafb28c8a5e4ef4e3e450c4dc624064fcf1ecfee5ee7903dedade84853d71155c34687051ee08ecbb5027894c987e244fa102ec89368e9997bd95d5c2fcf7cd4

data/lib/ae_page_objects.rb

@@ -3,6 +3,7 @@ require 'capybara/dsl'
 
 require 'ae_page_objects/version'
 require 'ae_page_objects/exceptions'
+require 'ae_page_objects/util/page_polling'
 
 module AePageObjects
   autoload :Node,              'ae_page_objects/node'
@@ -15,6 +16,8 @@ module AePageObjects
   autoload :Checkbox,          'ae_page_objects/elements/checkbox'
 
   class << self
+    include PagePolling
+
     attr_accessor :default_router
 
     def browser
@@ -50,8 +53,6 @@ module AePageObjects
       result
     end
 
-    private
-
     def default_max_wait_time
       if Capybara.respond_to?(:default_max_wait_time)
         Capybara.default_max_wait_time

data/lib/ae_page_objects/document_loader.rb

@@ -13,8 +13,12 @@ module AePageObjects
       begin
         poll_until do
           @query.conditions.each do |document_condition|
-            if document = @strategy.load_document_with_condition(document_condition)
-              return document
+            begin
+              if document = @strategy.load_document_with_condition(document_condition)
+                return document
+              end
+            rescue => e
+              raise unless catch_poll_util_error?(e)
             end
           end
 

data/lib/ae_page_objects/element_proxy.rb

@@ -127,21 +127,12 @@ module AePageObjects
       @loaded_element = nil
 
       true
-    rescue => e
-      if Capybara.current_session.driver.is_a?(Capybara::Selenium::Driver) &&
-        e.is_a?(Selenium::WebDriver::Error::StaleElementReferenceError)
-
-        # Inconclusive. Leave the handling up to the caller
-        false
-      else
-        raise
-      end
     end
 
     def with_reloaded_element(timeout)
       poll_until(timeout) do
-        reload_conclusive = reload_element
-        reload_conclusive && yield
+        reload_element
+        yield
       end
     end
   end

data/lib/ae_page_objects/util/page_polling.rb

@@ -1,11 +1,52 @@
 module AePageObjects
   module PagePolling
+    # Quickly polls the block until it returns (as opposed to throwing an exception). Using poll
+    # is a safer alternative to,
+    #
+    # Capybara.using_wait_time(0) do
+    #   has_content?('Admin')
+    # end
+    #
+    # where we want to determine whether 'Admin' is on the page (without waiting for it to appear).
+    # This is often used to switch login / functionality of page objects based on the state of the
+    # page.
+    #
+    # With poll, the above patterns becomes,
+    #
+    # AePageObjects.poll do
+    #   has_content?('Admin')
+    # end
+    def poll(seconds_to_wait = nil, &block)
+      result = nil
+      poll_until(seconds_to_wait) do
+        result = block.call
+        true
+      end
+      result
+    end
 
-    private
+    # Quickly polls the block until it returns something truthy. This is a helper function for
+    # special cases and probably NOT what you want to use. See AePageObjects#wait_until or
+    # #poll.
+    def poll_until(seconds_to_wait = nil, &block)
+      AePageObjects.wait_until(seconds_to_wait) do
+        # Capybara normally catches errors and retries. However, with the wait time of zero,
+        # capybara catches the errors and immediately reraises them. So we have to catch
+        # those errors in the similar fashion to capybara such that we properly can wait the
+        # whole seconds_to_wait.
+        begin
+          Capybara.using_wait_time(0, &block)
+        rescue => e
+          raise unless catch_poll_until_error?(e)
+          nil
+        end
+      end
+    end
 
-    def poll_until(timeout = nil, &block)
-      AePageObjects.wait_until(timeout) do
-        Capybara.using_wait_time(0, &block)
+    def catch_poll_until_error?(error)
+      types = Capybara.current_session.driver.invalid_element_errors + [Capybara::ElementNotFound]
+      types.any? do |type|
+        error.is_a?(type)
       end
     end
   end

data/lib/ae_page_objects/version.rb

@@ -1,3 +1,3 @@
 module AePageObjects
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ae_page_objects
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Donnie Tognazzini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara