ae_page_objects 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62a7c4ae245bff142532db643f26fd8d86cbeec5
-  data.tar.gz: 7f08f9ba3ee29135124a6002eee99235e19854ea
+  metadata.gz: bdbc7b1c3cc7929e18cae25d6b5a0073bc941d85
+  data.tar.gz: 0767bbea656f6a123d00c2dae7c00673714272d3
 SHA512:
-  metadata.gz: 360cc60ce2ff2ce7b5f4a4ca67ccc2c840df1a2aea9ca16fdad34629a3e9aba0d153c17514287b5be2756c12289d1f924f2f12477d7b2f4f9c6597dd8bb79213
-  data.tar.gz: 16c0429209abafbccdc3e699d41426455ae54adf340ac9398cfa885b11768c77a3223583be15e016b12ae5adba359153fae0a619aacb441dff3730c99c95c11f
+  metadata.gz: 12c29ba3329811692f161d16a46dc95bf187492c49585295e183f2d63bc356420a3ea76a4cb158b77f49db322517f18b674020741424389427f975c7189d3fb9
+  data.tar.gz: fa23580da483d787a283c96ac7495780ff52b17dd7563892aa4e89bed21205e15a97b64de1a547aafeb373f3391496fce569bf1f933d443b241e9e15eeca5d63

data/lib/ae_page_objects.rb

@@ -18,12 +18,6 @@ module AePageObjects
   autoload :Inflector,            'ae_page_objects/util/inflector'
   autoload :Waiter,               'ae_page_objects/util/waiter'
 
-  module Concerns
-    autoload :LoadEnsuring,     'ae_page_objects/concerns/load_ensuring'
-    autoload :Staleable,        'ae_page_objects/concerns/staleable'
-    autoload :Visitable,        'ae_page_objects/concerns/visitable'
-  end
-
   module MultipleWindows
     autoload :Browser,                   'ae_page_objects/multiple_windows/browser'
     autoload :Window,                    'ae_page_objects/multiple_windows/window'
@@ -66,6 +60,24 @@ module AePageObjects
       end
     end
   end
+
+  def self.wait_until(seconds_to_wait = nil, error_message = nil)
+    seconds_to_wait ||= Capybara.default_wait_time
+    start_time      = Time.now
+
+    until result = yield
+      delay = seconds_to_wait - (Time.now - start_time)
+
+      if delay <= 0
+        raise WaitTimeoutError, error_message || "Timed out waiting for condition"
+      end
+
+      sleep(0.05)
+      raise FrozenInTime, "Time appears to be frozen" if Time.now == start_time
+    end
+
+    result
+  end
 end
 
 require 'ae_page_objects/core_ext/module'

data/lib/ae_page_objects/document.rb

@@ -1,6 +1,46 @@
 module AePageObjects
   class Document < Node
-    include Concerns::Visitable
+    class << self
+      def can_load_from_current_url?
+        return true if paths.empty?
+
+        url = current_url_without_params
+
+        paths.any? do |path|
+          site.path_recognizes_url?(path, url)
+        end
+      end
+
+      def visit(*args)
+        args = args.dup
+        inner_options = args.last.is_a?(::Hash)? args.last : {}
+
+        path = inner_options.delete(:via) || paths.first
+
+        full_path = site.generate_path(path, *args)
+        raise PathNotResolvable, "#{self.name} not visitable via #{paths.first}(#{args.inspect})" unless full_path
+
+        Capybara.current_session.visit(full_path)
+
+        new
+      end
+
+      private
+
+      def paths
+        @paths ||= []
+      end
+
+      def path(path_method)
+        raise ArgumentError, "path must be a symbol or string" if ! path_method.is_a?(Symbol) && ! path_method.is_a?(String)
+
+        paths << path_method
+      end
+
+      def site
+        @site ||= Site.from(self)
+      end
+    end
 
     attr_reader :window
 
@@ -19,10 +59,19 @@ module AePageObjects
       self
     end
 
-    class << self
     private
-      def site
-        @site ||= Site.from(self)
+
+    def ensure_loaded!
+      begin
+        AePageObjects.wait_until { self.class.can_load_from_current_url? }
+      rescue WaitTimeoutError
+        raise LoadingPageFailed, "#{self.class.name} cannot be loaded with url '#{current_url_without_params}'"
+      end
+
+      begin
+        super
+      rescue LoadingElementFailed => e
+        raise LoadingPageFailed, e.message
       end
     end
   end

data/lib/ae_page_objects/document_loader.rb

@@ -1,19 +1,26 @@
+require 'ae_page_objects/util/page_polling'
+
 module AePageObjects
   class DocumentLoader
+    include AePageObjects::PagePolling
+
     def initialize(query, strategy)
       @query    = query
       @strategy = strategy
     end
 
     def load
-      Waiter.wait_until do
-        @query.conditions.each do |document_condition|
-          if document = @strategy.load_document_with_condition(document_condition)
-            return document
+      begin
+        poll_until do
+          @query.conditions.each do |document_condition|
+            if document = @strategy.load_document_with_condition(document_condition)
+              return document
+            end
           end
-        end
 
-        nil
+          nil
+        end
+      rescue AePageObjects::WaitTimeoutError
       end
 
       raise DocumentLoadError, @strategy.document_not_loaded_error_message(@query)

data/lib/ae_page_objects/element_proxy.rb

@@ -1,6 +1,7 @@
+require 'ae_page_objects/util/page_polling'
+
 module AePageObjects
   class ElementProxy
-
     # Remove all instance methods so even things like class()
     # get handled by method_missing(). <lifted from activerecord>
     instance_methods.each do |m|
@@ -9,6 +10,8 @@ module AePageObjects
       end
     end
 
+    include AePageObjects::PagePolling
+
     def initialize(element_class, *args)
       @element_class = element_class
       @args          = args
@@ -61,35 +64,30 @@ module AePageObjects
     end
 
     def wait_until_visible(timeout = nil)
-      is_visible = Waiter.wait_until(timeout) do
-        inst = presence
-        ! inst.nil? && inst.visible?
+      with_reloaded_element(timeout) do
+        !@loaded_element.nil? && @loaded_element.visible?
       end
 
-      unless is_visible
-        raise ElementNotVisible, "element_class: #{@element_class}, options: #{@options.inspect}"
-      end
+    rescue AePageObjects::WaitTimeoutError
+      raise ElementNotVisible, "element_class: #{@element_class}, options: #{@options.inspect}"
     end
 
     def wait_until_hidden(timeout = nil)
-      is_hidden = Waiter.wait_until(timeout) do
-        inst = presence
-        inst.nil? || ! inst.visible?
+      with_reloaded_element(timeout) do
+        @loaded_element.nil? || !@loaded_element.visible?
       end
 
-      unless is_hidden
-        raise ElementNotHidden, "element_class: #{@element_class}, options: #{@options.inspect}"
-      end
+    rescue AePageObjects::WaitTimeoutError
+      raise ElementNotHidden, "element_class: #{@element_class}, options: #{@options.inspect}"
     end
 
     def wait_until_present(timeout = nil)
-      is_present = Waiter.wait_until(timeout) do
-        ! presence.nil?
+      with_reloaded_element(timeout) do
+        !@loaded_element.nil?
       end
 
-      unless is_present
-        raise ElementNotPresent, "element_class: #{@element_class}, options: #{@options.inspect}"
-      end
+    rescue AePageObjects::WaitTimeoutError
+      raise ElementNotPresent, "element_class: #{@element_class}, options: #{@options.inspect}"
     end
 
     def wait_for_presence(timeout = nil)
@@ -98,13 +96,12 @@ module AePageObjects
     end
 
     def wait_until_absent(timeout = nil)
-      is_absent = Waiter.wait_until(timeout) do
-        check_absence
+      with_reloaded_element(timeout) do
+        @loaded_element.nil?
       end
 
-      unless is_absent
-        raise ElementNotAbsent, "element_class: #{@element_class}, options: #{@options.inspect}"
-      end
+    rescue AePageObjects::WaitTimeoutError
+      raise ElementNotAbsent, "element_class: #{@element_class}, options: #{@options.inspect}"
     end
 
     def wait_for_absence(timeout = nil)
@@ -132,7 +129,7 @@ module AePageObjects
       super || @element_class.allocate.respond_to?(*args)
     end
 
-  private
+    private
 
     def load_element
       @element_class.new(*@args)
@@ -142,20 +139,30 @@ module AePageObjects
       @loaded_element ||= load_element
     end
 
-    def check_absence
-      load_element
+    def reload_element
+      @loaded_element = load_element
 
-      false
+      true
     rescue LoadingElementFailed
+      @loaded_element = nil
+
       true
     rescue => e
       if Capybara.current_session.driver.is_a?(Capybara::Selenium::Driver) &&
         e.is_a?(Selenium::WebDriver::Error::StaleElementReferenceError)
-        # ignore and spin around for another check
+
+        # 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
+      end
+    end
   end
 end

data/lib/ae_page_objects/node.rb

@@ -1,66 +1,86 @@
 module AePageObjects
   class Node
-    module Methods
-      def initialize(capybara_node)
-        @node = capybara_node
-      end
-
-      def node
-        @node
-      end
-
-      def document
-        raise "Must implement!"
-      end
+    extend Dsl
 
+    class << self
       def current_url
-        self.class.current_url
+        Capybara.current_session.current_url.sub(/^https?:\/\/[^\/]*/, '')
       end
 
       def current_url_without_params
-        self.class.current_url_without_params
+        current_url.sub(/(\?|\#).*/, '')
       end
+    end
+
+    def initialize(capybara_node)
+      @node  = capybara_node
+      @stale = false
 
-      METHODS_TO_DELEGATE_TO_NODE = [:find, :all, :value, :set, :text, :visible?]
-      METHODS_TO_DELEGATE_TO_NODE.each do |m|
-        class_eval <<-RUBY
-          def #{m}(*args, &block)
-            node.send(:#{m}, *args, &block)
-          rescue Capybara::ElementNotFound => e
-            raise LoadingElementFailed, e.message
-          end
-        RUBY
+      ensure_loaded!
+    end
+
+    def node
+      if stale?
+        raise StalePageObject, "Can't access stale page object '#{self}'"
       end
 
-    private
+      @node
+    end
 
-      def eval_locator(locator)
-        return [] unless locator
+    def stale?
+      @stale
+    end
 
-        if locator.respond_to?(:call)
-          locator = instance_eval(&locator)
-        end
+    def stale!
+      @stale = true
+    end
 
-        locator.is_a?(Array) ? locator : [locator.to_s]
-      end
+    def document
+      raise "Must implement!"
     end
 
-    module ClassMethods
-      def current_url
-        Capybara.current_session.current_url.sub(/^https?:\/\/[^\/]*/, '')
-      end
+    def current_url
+      self.class.current_url
+    end
 
-      def current_url_without_params
-        current_url.sub(/(\?|\#).*/, '')
+    def current_url_without_params
+      self.class.current_url_without_params
+    end
+
+    METHODS_TO_DELEGATE_TO_NODE = [:find, :all, :value, :set, :text, :visible?]
+    METHODS_TO_DELEGATE_TO_NODE.each do |m|
+      class_eval <<-RUBY
+        def #{m}(*args, &block)
+          node.send(:#{m}, *args, &block)
+        rescue Capybara::ElementNotFound => e
+          raise LoadingElementFailed, e.message
+        end
+      RUBY
+    end
+
+    private
+
+    def eval_locator(locator)
+      return [] unless locator
+
+      if locator.respond_to?(:call)
+        locator = instance_eval(&locator)
       end
+
+      locator.is_a?(Array) ? locator : [locator.to_s]
     end
 
-    extend Dsl
+    def loaded_locator
+    end
 
-    include Methods
-    extend  ClassMethods
+    def ensure_loaded!
+      if locator = loaded_locator
+        find(*eval_locator(locator))
+      end
 
-    include Concerns::LoadEnsuring
-    include Concerns::Staleable
+      self
+    rescue Capybara::ElementNotFound => e
+      raise LoadingElementFailed, e.message
+    end
   end
 end

data/lib/ae_page_objects/single_window/window.rb

@@ -8,7 +8,7 @@ module AePageObjects
       end
 
       def current_document=(document)
-        @current_document.send(:stale!) if @current_document
+        @current_document.stale! if @current_document
         @current_document = document
       end
 

data/lib/ae_page_objects/util/page_polling.rb

@@ -0,0 +1,12 @@
+module AePageObjects
+  module PagePolling
+
+    private
+
+    def poll_until(timeout = nil, &block)
+      AePageObjects.wait_until(timeout) do
+        Capybara.using_wait_time(0, &block)
+      end
+    end
+  end
+end

data/lib/ae_page_objects/util/waiter.rb

@@ -1,38 +1,32 @@
+require 'ae_page_objects/util/page_polling'
+
 module AePageObjects
   module Waiter
-    def self.wait_until(timeout = nil, &block)
-      seconds_to_wait = timeout || Capybara.default_wait_time
-      start_time      = Time.now
-
-      until result = Capybara.using_wait_time(0, &block)
-        delay = seconds_to_wait - (Time.now - start_time)
-
-        if delay <= 0
-          return false
-        end
+    class << self
+      include AePageObjects::PagePolling
 
-        sleep(0.05)
-        raise FrozenInTime, "Time appears to be frozen" if Time.now == start_time
+      def wait_until(timeout = nil, &block)
+        warn "[DEPRECATION WARNING]: AePageObjects::Waiter.wait_until is deprecated and will be removed in version 2.0.0. Use AePageObjects.wait_until instead."
+        wait_until_return_false(timeout, &block)
       end
 
-      result
-    end
-
-    def self.wait_for(*args, &block)
-      warn "[DEPRECATION WARNING]: AePageObjects::Waiter.wait_for is deprecated and will be removed in version 2.0.0. Use AePageObjects::Waiter.wait_until instead."
-      wait_until(*args, &block)
-    end
-
-    def self.wait_until!(timeout = nil)
-      result = wait_until(timeout) do
-        yield
+      def wait_for(timeout = nil, &block)
+        warn "[DEPRECATION WARNING]: AePageObjects::Waiter.wait_for is deprecated and will be removed in version 2.0.0. Use AePageObjects.wait_until instead."
+        wait_until_return_false(timeout, &block)
       end
 
-      unless result
-        raise WaitTimeoutError, "Timed out waiting for condition"
+      def wait_until!(timeout = nil, &block)
+        warn "[DEPRECATION WARNING]: AePageObjects::Waiter.wait_until! is deprecated and will be removed in version 2.0.0. Use AePageObjects.wait_until instead."
+        poll_until(timeout, &block)
       end
 
-      result
+      private
+
+      def wait_until_return_false(timeout, &block)
+        poll_until(timeout, &block)
+      rescue WaitTimeoutError
+        false
+      end
     end
   end
 end

data/lib/ae_page_objects/version.rb

@@ -1,3 +1,3 @@
 module AePageObjects
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ae_page_objects
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Donnie Tognazzini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -19,7 +19,7 @@ dependencies:
         version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.8'
 description: Capybara Page Objects pattern
 email:
 - engineering@appfolio.com
@@ -38,9 +38,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ae_page_objects.rb
-- lib/ae_page_objects/concerns/load_ensuring.rb
-- lib/ae_page_objects/concerns/staleable.rb
-- lib/ae_page_objects/concerns/visitable.rb
 - lib/ae_page_objects/core/application_router.rb
 - lib/ae_page_objects/core/basic_router.rb
 - lib/ae_page_objects/core/dsl.rb
@@ -71,6 +68,7 @@ files:
 - lib/ae_page_objects/util/hash_symbolizer.rb
 - lib/ae_page_objects/util/inflector.rb
 - lib/ae_page_objects/util/internal_helpers.rb
+- lib/ae_page_objects/util/page_polling.rb
 - lib/ae_page_objects/util/singleton.rb
 - lib/ae_page_objects/util/waiter.rb
 - lib/ae_page_objects/version.rb

data/lib/ae_page_objects/concerns/load_ensuring.rb

@@ -1,26 +0,0 @@
-module AePageObjects
-  module Concerns
-    module LoadEnsuring
-
-      def initialize(*args)
-        super
-        ensure_loaded!
-      end
-
-    private
-
-      def loaded_locator
-      end
-
-      def ensure_loaded!
-        if locator = loaded_locator
-          find(*eval_locator(locator))
-        end
-
-        self
-      rescue Capybara::ElementNotFound => e
-        raise LoadingElementFailed, e.message
-      end
-    end
-  end
-end

data/lib/ae_page_objects/concerns/staleable.rb

@@ -1,25 +0,0 @@
-module AePageObjects
-  module Concerns
-    module Staleable
-
-      def stale?
-        !!@stale
-      end
-
-      def node
-        if stale?
-          raise StalePageObject, "Can't access stale page object '#{self}'"
-        end
-
-        super
-      end
-
-      private
-
-      def stale!
-        @stale = true
-      end
-
-    end
-  end
-end

data/lib/ae_page_objects/concerns/visitable.rb

@@ -1,66 +0,0 @@
-module AePageObjects
-  module Concerns
-    module Visitable
-
-      def self.included(target)
-        target.extend ClassMethods
-      end
-
-    private
-
-      def ensure_loaded!
-        unless Waiter.wait_until { self.class.can_load_from_current_url? }
-          raise LoadingPageFailed, "#{self.class.name} cannot be loaded with url '#{current_url_without_params}'"
-        end
-
-        begin
-          super
-        rescue LoadingElementFailed => e
-          raise LoadingPageFailed, e.message
-        end
-      end
-
-      module VisitMethod
-        def visit(*args)
-          args = args.dup
-          inner_options = args.last.is_a?(::Hash)? args.last : {}
-
-          path = inner_options.delete(:via) || paths.first
-
-          full_path = site.generate_path(path, *args)
-          raise PathNotResolvable, "#{self.name} not visitable via #{paths.first}(#{args.inspect})" unless full_path
-
-          Capybara.current_session.visit(full_path)
-          new
-        end
-      end
-
-      module ClassMethods
-
-        def can_load_from_current_url?
-          return true if paths.empty?
-
-          url = current_url_without_params
-
-          paths.any? do |path|
-            site.path_recognizes_url?(path, url)
-          end
-        end
-
-      private
-
-        def paths
-          @paths ||= []
-        end
-
-        def path(path_method)
-          raise ArgumentError, "path must be a symbol or string" if ! path_method.is_a?(Symbol) && ! path_method.is_a?(String)
-
-          paths << path_method
-
-          extend VisitMethod
-        end
-      end
-    end
-  end
-end