pagetience 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 004f4ab33f47df3056f939497b29b16c12105985
-  data.tar.gz: c2ccc08d0088664a2c5ede5dc686adcaee6563ff
+  metadata.gz: 108a062d3af7caac8148b20d6862d7b6b8a5663d
+  data.tar.gz: a08091eaf61fec1f8fc7f153f1cb98c408aada5a
 SHA512:
-  metadata.gz: e70f0e4b6837fcba9b3ea2e3e7582c3b1e792750c41f8fe50157c216044737ada154bdd5c7be6c4b98ac4187c561f0d88de05e2e17427b314ecab81757795eb4
-  data.tar.gz: 183ac9d6f088af1335d12fc3c7cea3452a95578d3de27ab36e6e66ceaedb23be4bb294752614d0cf8489853f5cca315287762c482441f56ffad05b44ad16e373
+  metadata.gz: e5937d66687049bc3696cf9c03de038bc0484f2fb1a60fed4b70d1708f5a8094891e3535255485c7cba9db519e9609837a5e97dfe16d37b11e369e44667d2a21
+  data.tar.gz: afe6e463749d5206377e1e3e329273b9657598978206951e89e9287f7a2f75e5325b423314775cc097c754a0d08bf53da580ec2bb5ab5fa1b32bf16866635165

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 *.iml
 /.idea/
+*.gem

data/README.md

@@ -1,5 +1,9 @@
 # Pagetience
-A simple gem to verify pages and important elements are loaded.
+[![Build Status](https://travis-ci.org/dmcneil/pagetience.svg?branch=master)](https://travis-ci.org/dmcneil/pagetience)
+
+Pronounced like "patience".
+
+Using a simple DSL, you can declare which of your page object elements must be present and visible on the page before your code can consider it **loaded**.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -47,9 +51,15 @@ class GooglePage
 end
 ```
 
+## Supported Platforms
+Currently, this gem only works with the [page-object](https://github.com/cheezy/page-object) gem. It's a high priority to make working with other page object/webdriver libraries easier.
+
 ## Notes/Todo/Issues
-### IMPORTANT
-Currently, this gem only works with the [page-object](https://github.com/cheezy/page-object)gem. It's a high priority to make working with other page object/webdriver libraries easier.
+1. Add platform support for Selenium WebDriver
+2. Add platform support for Watir WebDriver
+3. SitePrism?
+4. Documentation
+5. Organize unit tests
 
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/dmcneil/pagetience.

data/lib/pagetience/exceptions.rb

@@ -2,5 +2,8 @@ module Pagetience
   module Exceptions
     class Timeout < StandardError
     end
+
+    class Platform < StandardError
+    end
   end
 end

data/lib/pagetience/{timer.rb → meditate.rb}

@@ -1,5 +1,5 @@
 module Pagetience
-  class Timer
+  class Meditate
     attr_accessor :timeout, :polling, :block
 
     def initialize(timeout=30, polling=1, &block)
@@ -8,7 +8,7 @@ module Pagetience
       @block = block
     end
 
-    def run_until(expected=nil)
+    def until_enlightened(expected=nil, msg='Timed out waiting for the expected result.')
       raise ArgumentError, 'Timeout cannot be lower than the polling value.' unless @timeout > @polling
 
       while @timeout > 0 && @timeout > @polling
@@ -18,8 +18,9 @@ module Pagetience
         @timeout = @timeout - @polling
       end
 
+      raise Pagetience::Exceptions::Timeout, msg unless @latest_result
+
       @latest_result
     end
-    alias_method :run, :run_until
   end
 end

data/lib/pagetience/platforms/base.rb

@@ -0,0 +1,26 @@
+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; end
+
+      def underlying_element_for(sym)
+        nil
+      end
+    end
+  end
+end

data/lib/pagetience/platforms/element_platforms.rb

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

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

@@ -0,0 +1,30 @@
+module Pagetience
+  module ElementPlatforms
+    class PageObjectGem < Base
+      attr_reader :page_object_instance
+
+      class << self
+        def present?(klazz)
+          klazz.class.ancestors.include? PageObject
+        end
+      end
+
+      def initialize(klazz)
+        super
+
+        @page_object_instance = klazz
+        @browser = @page_object_instance.browser
+      end
+
+      def platform_initialize
+        @page_object_instance.instance_eval do
+          PageObject.instance_method(:initialize).bind(self).call(@browser)
+        end
+      end
+
+      def underlying_element_for(sym)
+        @page_object_instance.send("#{sym}_element").element
+      end
+    end
+  end
+end

data/lib/pagetience/version.rb

@@ -1,3 +1,3 @@
 module Pagetience
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/pagetience.rb

@@ -1,16 +1,37 @@
 require 'pagetience/exceptions'
-require 'pagetience/timer'
+require 'pagetience/meditate'
 require 'pagetience/version'
 
+require 'pagetience/platforms/base'
+require 'pagetience/platforms/page-object-gem'
+
+require 'pagetience/platforms/element_platforms'
+
 module Pagetience
-  SUPPORTED_ELEMENT_LIBS = [PageObject]
+  module ClassMethods
+    def required(*elements)
+      elements.keep_if { |e| e.is_a? Symbol }
+      define_method('_required_elements') do
+        elements
+      end
+    end
+
+    def waiting(timeout, polling=1)
+      define_method('_waiting_timeout') do
+        timeout
+      end
+      define_method('_waiting_polling') do
+        polling
+      end
+    end
+  end
 
   attr_accessor :_waiting_timeout, :_waiting_polling
 
   attr_reader :browser
   attr_reader :loaded
 
-  attr_reader :element_lib
+  attr_reader :element_platform
   attr_reader :_poller, :_required_elements, :_underlying_elements
 
   def self.included(base)
@@ -18,12 +39,11 @@ module Pagetience
   end
 
   def initialize(browser)
-    @element_lib = self.class.ancestors.find { |m| SUPPORTED_ELEMENT_LIBS.include? m }
-    raise StandardError, 'Could not determine what page object platform is being used.' unless @element_lib
+    @browser = browser
 
-    PageObject.instance_method(:initialize).bind(self).call(browser) if @element_lib == PageObject
+    determine_platform
+    @element_platform.platform_initialize
 
-    @browser = browser
     @loaded = false
     @_waiting_timeout = _waiting_timeout || 30
     @_waiting_polling = _waiting_polling || 1
@@ -39,17 +59,13 @@ module Pagetience
   end
 
   def gather_underlying_elements
-    if @element_lib == PageObject
-      @_required_elements.each do |e|
-        if respond_to? "#{e}_element"
-          @_underlying_elements << self.send("#{e}_element").element
-        end
-      end
+    @_required_elements.each do |e|
+      @_underlying_elements << @element_platform.underlying_element_for(e)
     end
   end
 
   def wait_for_required_elements
-    @_poller = Pagetience::Timer.new(@_waiting_timeout, @_waiting_polling) do
+    @_poller = Pagetience::Meditate.new(@_waiting_timeout, @_waiting_polling) do
       begin
         unless @_underlying_elements.any? { |e| !e.visible? }
           @loaded = true
@@ -58,28 +74,18 @@ module Pagetience
         # TODO implement better strategy for certain platforms
       end
     end
-    @_poller.run_until true
+    @_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
   end
 
-  module ClassMethods
-    def required(*elements)
-      elements.keep_if { |e| e.is_a? Symbol }
-      define_method('_required_elements') do
-        elements
-      end
-    end
+  private
 
-    def waiting(timeout, polling=1)
-      define_method('_waiting_timeout') do
-        timeout
-      end
-      define_method('_waiting_polling') do
-        polling
-      end
-    end
+  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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagetience
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Derek McNeil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-21 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,10 @@ files:
 - Rakefile
 - lib/pagetience.rb
 - lib/pagetience/exceptions.rb
-- lib/pagetience/timer.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
 homepage: http://www.github.com/dmcneil/pagetience
@@ -176,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple gem for making page object waiting easy.