pagetience 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac8814a6ca776d7fad70c90486f9f38f2c1f42bf
-  data.tar.gz: f74c2089d1e57e30212be940474b0714e856f6b0
+  metadata.gz: d72d9ede5f1719c7d819dac50cd9c96de24af39d
+  data.tar.gz: 1ffef24be2c258c445a33cf0fe346b44b8f19bd7
 SHA512:
-  metadata.gz: 94e46d93b746a9b957273cdd4dbbefc7f6f0ee8babcfc30ccf8e6683aff72be5e703a963f5c120fabbb5e84b84988dffcc2ada371ab8d9d7f372e7685f1d1c0d
-  data.tar.gz: 0669d2022d009a022c61ca9be99bf2a3cf8ca357ff935651470ab7fd2628cfcab8e5b4e8323d1f3de1cdbdab13abd952cceec5d6956a47cf350d44acc4654c81
+  metadata.gz: 6aa8a51684bf2443a6d9a5108226162f38faf5d442e84bdf1cade8685a1bfda2f20455ffd89b693ab037df9909285c83c19d82a640bc5dc0b7ae15804446dd35
+  data.tar.gz: 639efc4b0bb053daba6b563011862e9d993db2375d3f21426669d727e1d1d49cf6d5f97e359ea9fb75c6c32f36ea83f6482e34a03e046aae0a0a301ad5699e2b

data/README.md

@@ -36,7 +36,7 @@ end
 When an instance of your page object is created then the required elements will be checked for.
 
 #### Page transitions
-Using the `transition_to` method within your page object, you can now wait for an expected page to transition to.
+Using the `wait_for_transition_to` method within your page object, you can now wait for an expected page to transition to.
 
 ```ruby
 class FirstPage
@@ -76,6 +76,27 @@ expect(@current_page.loaded?).to eq true # true
 expect(@current_page).to be_an_instance_of SecondPage # true
 ```
 
+#### Waiting for individual elements
+The `wait_for_element` method allows you to wait for a specific element on the page to be there. It doesn't have to be one of your `required` fields -- it just has to declared.
+
+```ruby
+class SomePage
+  include PageObject
+  include Pagetience
+
+  button :foo, id: 'foo'
+
+  def wait_for_foo
+    wait_for_element :foo
+  end
+
+  def wait_longer_for_foo
+    wait_for_element :foo, 60, 5
+  end
+end
+end
+```
+
 #### Adjusting the Timeout/Polling
 You can use the `waiting` method to specify how long you want to wait and, optionally, at what interval to poll the page for element visibility.
 

data/lib/pagetience/platforms/base.rb

@@ -21,6 +21,10 @@ module Pagetience
       def underlying_element_for(sym)
         nil
       end
+
+      def is_element_present?(sym)
+        false
+      end
     end
   end
 end

data/lib/pagetience/platforms/page-object-gem.rb

@@ -28,6 +28,10 @@ module Pagetience
       def underlying_element_for(sym)
         @page_object_instance.send("#{sym}_element").element
       end
+
+      def is_element_present?(sym)
+        @page_object_instance.send("#{sym}_element").visible?
+      end
     end
   end
 end

data/lib/pagetience/version.rb

@@ -1,3 +1,3 @@
 module Pagetience
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/lib/pagetience.rb

@@ -31,7 +31,7 @@ module Pagetience
   attr_reader :browser, :loaded
 
   attr_reader :element_platform
-  attr_reader :_poller, :_required_elements, :_underlying_elements
+  attr_reader :_required_elements
 
   def self.included(base)
     base.extend ClassMethods
@@ -51,8 +51,6 @@ module Pagetience
     @_waiting_polling = _waiting_polling || 1
 
     @_required_elements = _required_elements || []
-    @_underlying_elements = []
-    gather_underlying_elements
     wait_for_required_elements
   end
 
@@ -60,35 +58,43 @@ module Pagetience
     !!@loaded
   end
 
-  def gather_underlying_elements
-    @_required_elements.each do |e|
-      @_underlying_elements << @element_platform.underlying_element_for(e)
+  def wait_for_required_elements(timeout=nil, polling=nil)
+    opts = {
+        timeout: timeout || @_waiting_timeout,
+        polling: polling || @_waiting_polling,
+        expecting: true,
+        msg: "Timed out after polling every #{:polling}s for #{:timeout}s waiting for the page to be loaded."
+    }
+    wait_for(opts) do
+      @loaded = true unless @_required_elements.any? { |e| !@element_platform.is_element_present? e }
     end
   end
 
-  def wait_for_required_elements
-    @_poller = Pagetience::Meditate.new(@_waiting_timeout, @_waiting_polling) do
-      begin
-        unless @_underlying_elements.any? { |e| !e.visible? }
-          @loaded = true
-        end
-      rescue
-        # TODO implement better strategy for certain platforms
-      end
-    end
-    @_poller.until_enlightened true
-
-    unless loaded?
-      raise Pagetience::Exceptions::Timeout, "Timed out after polling every #{@_poller.polling}s for #{@_poller.timeout}s waiting for the page to be loaded."
-    end
+  def wait_for_element(sym, timeout=nil, polling=nil)
+    opts = {
+        timeout: timeout || @_waiting_timeout,
+        polling: polling || @_waiting_polling,
+        expecting: true,
+        msg: "Timed out after waiting for the element #{sym} to be present."
+    }
+    wait_for(opts) { @element_platform.is_element_present? sym }
   end
 
-  def transition_to(page, timeout=30, polling=1)
+  def wait_for_transition_to(page, timeout=nil, polling=nil)
     page = page.new browser
-    Pagetience::Meditate.for(timeout: timeout, polling: polling, msg: 'Timed out waiting for page transition.', expecting: true) { page.loaded? }
+    opts = {
+        timeout: timeout || @_waiting_timeout,
+        polling: polling || @_waiting_polling,
+        expecting: true,
+        msg: "Timed out after waiting for the page to transition to #{page}."
+    }
+    wait_for(opts) { page.loaded? }
     page
   end
-  alias_method :wait_for_transition_to, :transition_to
+
+  def wait_for(opts={}, &block)
+    Pagetience::Meditate.for(opts) { block.call }
+  end
 
   private
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagetience
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Derek McNeil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-28 00:00:00.000000000 Z
+date: 2016-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler