pagetience 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 004f4ab33f47df3056f939497b29b16c12105985
+  data.tar.gz: c2ccc08d0088664a2c5ede5dc686adcaee6563ff
+SHA512:
+  metadata.gz: e70f0e4b6837fcba9b3ea2e3e7582c3b1e792750c41f8fe50157c216044737ada154bdd5c7be6c4b98ac4187c561f0d88de05e2e17427b314ecab81757795eb4
+  data.tar.gz: 183ac9d6f088af1335d12fc3c7cea3452a95578d3de27ab36e6e66ceaedb23be4bb294752614d0cf8489853f5cca315287762c482441f56ffad05b44ad16e373

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pagetience.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Derek McNeil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Pagetience
+A simple gem to verify pages and important elements are loaded.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pagetience'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pagetience
+
+## Usage
+To use **Pagetience**, simply `include Pagetience` in your page object class and then use the `required` method to set which elements must be visible on the page for it to be considered loaded.
+
+```ruby
+class GooglePage
+  include PageObject
+  include Pagetience
+
+  text_field :search, name: 'q'
+  required :search
+end
+```
+
+When an instance of your page object is created then the required elements will be checked for.
+
+#### 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.
+
+The default timeout is **30** seconds, polling every second.
+
+```ruby
+class GooglePage
+  include PageObject
+  include Pagetience
+
+  text_field :search, name: 'q'
+  required :search
+  waiting 60, 5 # wait up to 60 seconds, polling every 5 seconds
+end
+```
+
+## 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.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/dmcneil/pagetience.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pagetience/exceptions.rb

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

data/lib/pagetience/timer.rb

@@ -0,0 +1,25 @@
+module Pagetience
+  class Timer
+    attr_accessor :timeout, :polling, :block
+
+    def initialize(timeout=30, polling=1, &block)
+      @timeout = timeout
+      @polling = polling
+      @block = block
+    end
+
+    def run_until(expected=nil)
+      raise ArgumentError, 'Timeout cannot be lower than the polling value.' unless @timeout > @polling
+
+      while @timeout > 0 && @timeout > @polling
+        @latest_result = @block.call
+        break unless expected && @latest_result != expected
+        sleep @polling
+        @timeout = @timeout - @polling
+      end
+
+      @latest_result
+    end
+    alias_method :run, :run_until
+  end
+end

data/lib/pagetience/version.rb

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

data/lib/pagetience.rb

@@ -0,0 +1,85 @@
+require 'pagetience/exceptions'
+require 'pagetience/timer'
+require 'pagetience/version'
+
+module Pagetience
+  SUPPORTED_ELEMENT_LIBS = [PageObject]
+
+  attr_accessor :_waiting_timeout, :_waiting_polling
+
+  attr_reader :browser
+  attr_reader :loaded
+
+  attr_reader :element_lib
+  attr_reader :_poller, :_required_elements, :_underlying_elements
+
+  def self.included(base)
+    base.extend ClassMethods
+  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
+
+    PageObject.instance_method(:initialize).bind(self).call(browser) if @element_lib == PageObject
+
+    @browser = browser
+    @loaded = false
+    @_waiting_timeout = _waiting_timeout || 30
+    @_waiting_polling = _waiting_polling || 1
+
+    @_required_elements = _required_elements || []
+    @_underlying_elements = []
+    gather_underlying_elements
+    wait_for_required_elements
+  end
+
+  def loaded?
+    !!@loaded
+  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
+    end
+  end
+
+  def wait_for_required_elements
+    @_poller = Pagetience::Timer.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.run_until 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
+
+    def waiting(timeout, polling=1)
+      define_method('_waiting_timeout') do
+        timeout
+      end
+      define_method('_waiting_polling') do
+        polling
+      end
+    end
+  end
+end

data/pagetience.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pagetience/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pagetience'
+  spec.version       = Pagetience::VERSION
+  spec.authors       = ['Derek McNeil']
+  spec.email         = ['derek.mcneil90@gmail.com']
+
+  spec.summary       = %q{A simple gem for making page object waiting easy.}
+  spec.homepage      = 'http://www.github.com/dmcneil/pagetience'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard', '~> 2.13.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6.5'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+
+  spec.add_dependency 'page-object' , '~> 1.1.1'
+  spec.add_dependency 'watir-webdriver', '~> 0.9.0'
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: pagetience
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek McNeil
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.5
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: page-object
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email:
+- derek.mcneil90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pagetience.rb
+- lib/pagetience/exceptions.rb
+- lib/pagetience/timer.rb
+- lib/pagetience/version.rb
+- pagetience.gemspec
+homepage: http://www.github.com/dmcneil/pagetience
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: A simple gem for making page object waiting easy.
+test_files: []