pagetience 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d72d9ede5f1719c7d819dac50cd9c96de24af39d
-  data.tar.gz: 1ffef24be2c258c445a33cf0fe346b44b8f19bd7
+  metadata.gz: 047639c7bb485cabfaede710c9398d3d9f469fcc
+  data.tar.gz: cf3130de096efde5b85cfb5776213a3b1160161d
 SHA512:
-  metadata.gz: 6aa8a51684bf2443a6d9a5108226162f38faf5d442e84bdf1cade8685a1bfda2f20455ffd89b693ab037df9909285c83c19d82a640bc5dc0b7ae15804446dd35
-  data.tar.gz: 639efc4b0bb053daba6b563011862e9d993db2375d3f21426669d727e1d1d49cf6d5f97e359ea9fb75c6c32f36ea83f6482e34a03e046aae0a0a301ad5699e2b
+  metadata.gz: 77dddb513326bd516ccb69b36fc101182afb900b105fe4eb9288dbc794e4528a3f4d6d13ce2461a3b050dbcea5de2b19b87cc46ce9336e30f707e3c97b85c5f9
+  data.tar.gz: b7fe6cfc8b03af4fa6f83769b6ecd0bd7c99bcf037dbed82f2ef85ca5e25845b4d1abbfa92aa1690f66638cbd27b62758826b7202ce8533b58ac3256ab917fd3

data/README.md

@@ -91,13 +91,32 @@ class SomePage
   end
 
   def wait_longer_for_foo
-    wait_for_element :foo, 60, 5
+    wait_for_element :foo, 60, 5 # wait up to 60 seconds, polling every 5 seconds
   end
 end
+```
+
+## Configuration
+Pagetience can be configured, too.
+
+```ruby
+Pagetience.configure do |config|
+  config.timeout = 60
+  config.polling = 5
 end
 ```
 
-#### Adjusting the Timeout/Polling
+It can then be retrieve easily!
+
+```ruby
+def give_me_a_property
+  Pagetience.config.timeout
+end
+
+give_me_a_property # => 60
+````
+
+#### Adjusting the Timeout/Polling for a specific Page
 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.
 
 The default timeout is **30** seconds, polling every second.

data/lib/pagetience/configuration.rb

@@ -0,0 +1,30 @@
+module Pagetience
+  class Configuration
+    VALID_PROPERTIES = [
+        :timeout,
+        :polling,
+        :platform
+    ]
+
+    attr_accessor *VALID_PROPERTIES
+
+    # Default timeout in seconds
+    DEFAULT_TIMEOUT = 30
+
+    # Default polling in seconds
+    DEFAULT_POLLING = 1
+
+    # Default element platform
+    DEFAULT_PLATFORM = Pagetience::Platform::PageObjectGem
+
+    def initialize
+      @timeout = DEFAULT_TIMEOUT
+      @polling = DEFAULT_POLLING
+      @platform = DEFAULT_PLATFORM
+    end
+
+    def method_missing(sym, *args)
+      raise Pagetience::ConfigurationError, "Unknown property #{sym}."
+    end
+  end
+end

data/lib/pagetience/dsl.rb

@@ -5,5 +5,9 @@ module Pagetience
     def current_page
       @browser.current_page
     end
+
+    def wait_for_element(sym)
+      @browser.current_page.wait_for_element sym
+    end
   end
 end

data/lib/pagetience/meditate.rb

@@ -29,7 +29,7 @@ module Pagetience
         @timeout = @timeout - @polling
       end
 
-      raise Pagetience::Exceptions::Timeout, msg unless @latest_result == expected
+      raise Pagetience::TimeoutError, msg unless @latest_result == expected
 
       @latest_result
     end

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

@@ -1,36 +1,34 @@
 module Pagetience
-  module ElementPlatforms
-    class PageObjectGem < Base
-      attr_reader :page_object_instance
-
+  module Platform
+    class PageObjectGem
       class << self
-        def present?(klazz)
-          klazz.class.ancestors.include? PageObject
-        end
-      end
+        def init(base, *args)
+          args.flatten! if args
 
-      def initialize(klazz)
-        super
+          base.class.send(:define_method, :visit) do
+            args[1] || false
+          end
+          base.instance_eval do
+            PageObject.instance_method(:initialize).bind(self).call(base.browser, visit)
+          end
 
-        @page_object_instance = klazz
-        @browser = @page_object_instance.browser
+          self.new base
+        end
       end
 
-      def platform_initialize(args=[])
-        @page_object_instance.class.send(:define_method, :visit) do
-          args[0] || false
-        end
-        @page_object_instance.instance_eval do
-          PageObject.instance_method(:initialize).bind(self).call(@browser, visit)
-        end
+      attr_reader :page_object, :browser
+
+      def initialize(page)
+        @page_object = page
+        @browser = @page_object.browser
       end
 
       def underlying_element_for(sym)
-        @page_object_instance.send("#{sym}_element").element
+        @page_object.send("#{sym}_element").element
       end
 
       def is_element_present?(sym)
-        @page_object_instance.send("#{sym}_element").visible?
+        @page_object.send("#{sym}_element").visible?
       end
     end
   end

data/lib/pagetience/version.rb

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

data/lib/pagetience.rb

@@ -1,13 +1,26 @@
-require 'pagetience/exceptions'
+require 'pagetience/platforms/page-object-gem'
+
+require 'pagetience/configuration'
 require 'pagetience/meditate'
 require 'pagetience/version'
 
-require 'pagetience/platforms/base'
-require 'pagetience/platforms/page-object-gem'
+module Pagetience
+  class TimeoutError < StandardError; end
+  class PlatformError < StandardError; end
+  class ConfigurationError < StandardError; end
 
-require 'pagetience/platforms/element_platforms'
+  class << self
+    attr_writer :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
 
-module Pagetience
   module ClassMethods
     def required(*elements)
       elements.keep_if { |e| e.is_a? Symbol }
@@ -26,30 +39,26 @@ module Pagetience
     end
   end
 
-  attr_accessor :_waiting_timeout, :_waiting_polling
-
-  attr_reader :browser, :loaded
+  # "Private" methods to avoid naming collision but remain helpful
+  # They can be messed with though, if you ever see fit.
+  attr_accessor :_waiting_timeout, :_waiting_polling, :_required_elements
 
+  attr_reader :browser
   attr_reader :element_platform
-  attr_reader :_required_elements
 
   def self.included(base)
     base.extend ClassMethods
   end
 
-  def initialize(browser, *args)
-    @browser = browser
-
-    current_page = self
-    @browser.class.send(:define_method, :current_page) { current_page }
+  def initialize(*args)
+    @browser = args[0]
+    set_current_page
 
-    determine_platform
-    @element_platform.platform_initialize args
+    @element_platform = Pagetience.config.platform.init self, args
 
     @loaded = false
-    @_waiting_timeout = _waiting_timeout || 30
-    @_waiting_polling = _waiting_polling || 1
-
+    @_waiting_timeout = _waiting_timeout || Pagetience.config.timeout
+    @_waiting_polling = _waiting_polling || Pagetience.config.polling
     @_required_elements = _required_elements || []
     wait_for_required_elements
   end
@@ -58,11 +67,13 @@ module Pagetience
     !!@loaded
   end
 
+  # Waits for all elements specified by .required to be present
+  # @param [Fixnum] timeout Time to wait in seconds
+  # @param [Fixnum] polling How often to poll
   def wait_for_required_elements(timeout=nil, polling=nil)
     opts = {
-        timeout: timeout || @_waiting_timeout,
-        polling: polling || @_waiting_polling,
-        expecting: true,
+        timeout: timeout,
+        polling: polling,
         msg: "Timed out after polling every #{:polling}s for #{:timeout}s waiting for the page to be loaded."
     }
     wait_for(opts) do
@@ -70,37 +81,57 @@ module Pagetience
     end
   end
 
+  # Wait for an element to be present
+  # @param [Symbol] sym Name of the element
+  # @param [Fixnum] timeout Time to wait in seconds
+  # @param [Fixnum] polling How often to poll
   def wait_for_element(sym, timeout=nil, polling=nil)
     opts = {
-        timeout: timeout || @_waiting_timeout,
-        polling: polling || @_waiting_polling,
-        expecting: true,
+        timeout: timeout,
+        polling: polling,
         msg: "Timed out after waiting for the element #{sym} to be present."
     }
     wait_for(opts) { @element_platform.is_element_present? sym }
   end
 
+  # Wait for a transition to another page
+  # @param [Fixnum] timeout Time to wait in seconds
+  # @param [Fixnum] polling How often to poll
   def wait_for_transition_to(page, timeout=nil, polling=nil)
     page = page.new browser
     opts = {
-        timeout: timeout || @_waiting_timeout,
-        polling: polling || @_waiting_polling,
-        expecting: true,
+        timeout: timeout,
+        polling: polling,
         msg: "Timed out after waiting for the page to transition to #{page}."
     }
     wait_for(opts) { page.loaded? }
     page
   end
 
+  # Generic waiting method
+  # @param [Hash] opts
+  # Valid options:
+  # :timeout = Time to wait in seconds
+  # :polling = How often to poll
+  # :expecting = The expected result for the block to return
+  # :msg = The exception message if the timeout occurs
   def wait_for(opts={}, &block)
+    opts = {
+        timeout: @_waiting_timeout,
+        polling: @_waiting_polling,
+        expecting: true,
+        msg: "Timed out after waiting for #{@_waiting_timeout}s, polling every #{@_waiting_polling}s."
+    }.merge(opts) do |key, old, new|
+      new.nil? ? old : new
+    end
     Pagetience::Meditate.for(opts) { block.call }
   end
 
   private
 
-  def determine_platform
-    @element_platform = Pagetience::ElementPlatforms::Base.find(self)
-
-    raise Pagetience::Exceptions::Platform, 'Could not determine what element platform is being used.' unless @element_platform
+  # Sets .current on the browser
+  def set_current_page
+    current_page = self
+    @browser.class.send(:define_method, :current_page) { current_page }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagetience
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Derek McNeil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-29 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,12 +152,10 @@ files:
 - README.md
 - Rakefile
 - lib/pagetience.rb
+- lib/pagetience/configuration.rb
 - lib/pagetience/cucumber.rb
 - lib/pagetience/dsl.rb
-- lib/pagetience/exceptions.rb
 - lib/pagetience/meditate.rb
-- lib/pagetience/platforms/base.rb
-- lib/pagetience/platforms/element_platforms.rb
 - lib/pagetience/platforms/page-object-gem.rb
 - lib/pagetience/version.rb
 - pagetience.gemspec

data/lib/pagetience/exceptions.rb

@@ -1,9 +0,0 @@
-module Pagetience
-  module Exceptions
-    class Timeout < StandardError
-    end
-
-    class Platform < StandardError
-    end
-  end
-end

data/lib/pagetience/platforms/base.rb

@@ -1,30 +0,0 @@
-module Pagetience
-  module ElementPlatforms
-    class Base
-      attr_reader :browser
-
-      class << self
-        def find(klazz)
-          valid_ancestor = ANCESTORS.find { |a| a.present? klazz }
-          if valid_ancestor
-            valid_ancestor.new klazz
-          end
-        end
-      end
-
-      def initialize(*args)
-        @browser = nil
-      end
-
-      def platform_initialize(*args); end
-
-      def underlying_element_for(sym)
-        nil
-      end
-
-      def is_element_present?(sym)
-        false
-      end
-    end
-  end
-end

data/lib/pagetience/platforms/element_platforms.rb

@@ -1,5 +0,0 @@
-module Pagetience
-  module ElementPlatforms
-    ANCESTORS = [Pagetience::ElementPlatforms::PageObjectGem]
-  end
-end