watir_session 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b40a20b54cfe09649622bafd024804856695b234
+  data.tar.gz: fcccb9373fefcbc5aa44a4cb8a9dd387ece3daef
+SHA512:
+  metadata.gz: 3ef12968842c063d13215666b88ff4b5d1463058019b22c13ddf9255e82efb9b99737cd6c3c4f12583261ed046ac733dffeafc9dd6b57d14b6b82b6453bfc877
+  data.tar.gz: a7de7c9fe2a4a7e2fbf0af84a69d84ee78de403b7c7eb6016de458c6b60deb8a284a5a02fba69bc5bcce7bbbf9b0b95b5a8afdd147c18559f2a11a8f6e1ae707

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Titus Fortner
+
+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,91 @@
+# WatirSession
+
+This gem leverages the Watir test library to allow for easy access
+to configurarion and session data so they do not need to be passed around as 
+parameters throughout your tests.
+The intention is to provide a solution that is easy to use and maintain, 
+while still providing power and flexibility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watir_session'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install watir_session
+
+## Usage
+
+The default WatirConfig class uses the recommended settings without needing 

+any modifications. 
The hooks into the WatirSession class are designed to work 
+with your 
test harness (RSpec, Cucumber, etc) for maximum flexibility. 
+
At a minimum, you'll need to call:
+
+```
ruby
+WatirSession.start

+WatirSession.start_test


+WatirSession.end_test


+```
+
+## Example
+
+Here's an example for how you can add a session for Saucelabs
+
+```ruby
+class SauceSession
+  def initialize
+    @sauce_config = SuaceConfig.new
+  end
+  def create_browser)
+    @browser = Watir::Browser.new(:remote, url: @sauce_config.endpoint)
+  end
+end
+```
+```ruby
+require 'model'
+
+class SauceConfig < Model
+  key(:sauce_username) { ENV['SAUCE_USERNAME'] }
+  key(:sauce_access_key) { ENV['SAUCE_ACCESS_KEY'] }
+  key(:endpoint) {"http://#{sauce_username}:#{sauce_access_key}@ondemand.saucelabs.com:80/wd/hub"}
+end
+```
+```ruby
+RSpec.configure do |config|
+  WatirSession.start
+  WatirSession.register_session(SauceSession.new)
+
+  config.before(:each) do
+    @browser = WatirSession.start_test
+  end
+  config.after(:each) do
+    WatirSession.end_test
+  end
+end
+```
+
+## Development
+
+Run `rake spec` to run the tests
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/titusfortner/watir_session.
+
+
+## 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/watir_session/custom_config.rb

@@ -0,0 +1,5 @@
+require 'model'
+
+class CustomConfig < Model
+
+end

data/lib/watir_session/watir_config.rb

@@ -0,0 +1,70 @@
+require 'model'
+require 'yaml'
+
+class WatirConfig < Model
+
+  ## --Browser Options-- ##
+
+  # Supported browsers:
+  # chrome, firefox, safari, phantomjs, edge, internet_explorer
+  key(:browser) { (ENV['BROWSER'] || 'chrome').to_sym }
+
+  # Time in seconds to wait to hear back from the browser after sending a command
+  key(:http_timeout) { (ENV['HTTP_TIMEOUT'] || '60').to_i }
+
+
+  ## --Watir Options-- ##
+
+  # Time in seconds to wait to interact with an element
+  key(:watir_timeout) { (ENV['WATIR_TIMEOUT'] || '30').to_i }
+
+  # true means that when an element goes stale it is relocated
+  # false means that when an element goes stale, an exception is thrown
+  # Note: As currently implemented, this setting would be better named relocate_when_necessary
+  key(:always_locate) { ENV['ALWAYS_LOCATE'] != 'true' }
+
+  # true means elements will be located with CSS instead of XPATH when possible
+  # false means that elements will be located by XPATH instead of CSS when possible
+  key(:prefer_css) { ENV['PREFER_CSS'] == 'true' }
+
+
+  ## --Test Options-- ##
+
+  # true means the browser does not automatically close between session start and exit
+  # false means the browser quits and restarts after each test
+  key(:reuse_browser) { ENV['REUSE_BROWSER'] == 'true' }
+
+  # 'always' means the test takes a screenshot after the end of each test
+  # 'failing' means the test takes a screenshot after the end of each failing test
+  # 'never' means the test never takes a screenshot automatically
+  key(:take_screenshots) { (ENV['TAKE_SCREENSHOTS'] || 'never').to_sym }
+
+  # TODO - implement this, look at Watirmark code
+  # true means the browser quits as expected at the end of a session
+  # false means the browser remains open after teh session has ended
+  # Note: reuse_browser must be true for this setting to matter
+  key(:close_browser_on_exit) { ENV['CLOSE_BROWSER_ON_EXIT'] != 'true' }
+
+  # true means the browser is set to maximize after starting
+  # false means the size of the browser is not automatically changed after browser is started
+  key(:maximize_browser) { ENV['MAXIMIZE_BROWSER'] == 'true' }
+
+  # TODO - Implement Logs
+  # 'UNKNOWN'- An unknown message that should always be logged.
+  # 'FATAL' - An unhandleable error that results in a program crash.
+  # 'ERROR' - A handleable error condition.
+  # 'WARN' - A warning.
+  # 'INFO' - Generic (useful) information about system operation.
+  # 'DEBUG' - Low-level information for developers.
+  key(:log_level) { ENV['LOG_LEVEL'] || 'INFO' }
+
+  # true means the browser will run in xvfb
+  # false means the browser will run in the normal window
+  # Note: This setting will be ignored if platform is not Linux, and will raise error if xvfb is not installed
+  key(:headless) { ENV['HEADLESS'] == 'true' }
+
+  ## --Additional Options-- ##
+
+  key(:custom_config)
+
+end

data/lib/watir_session/watir_session.rb

@@ -0,0 +1,144 @@
+module WatirSession
+
+  extend self
+
+  attr_reader :browser
+  attr_accessor :watir_config
+
+  def watir_config
+    @watir_config ||= WatirConfig.new
+  end
+
+  def registered_sessions
+    @registered_sessions ||= []
+  end
+
+  def register_session(session)
+    registered_sessions << session
+  end
+
+  def execute_hook(method, *args)
+    sessions = registered_sessions.select do |session|
+      session.public_methods(false).include? method
+    end
+
+    sessions.each_with_object([]) do |session, array|
+      array << session.send(method, *args)
+    end
+  end
+
+  def create_browser(*args)
+    use_headless_display if @watir_config.headless
+
+    @browser = execute_hook(:create_browser, *args).compact.first
+
+    unless @browser
+      http_client = Selenium::WebDriver::Remote::Http::Default.new
+      http_client.timeout = @watir_config.http_timeout
+      @browser = Watir::Browser.new(@watir_config.browser,
+                                    http_client: http_client)
+    end
+    @browser
+  end
+
+  def before_tests(config = nil, *args)
+    @watir_config = config || watir_config
+
+    configure_watir
+
+    create_browser if @watir_config.reuse_browser
+
+    execute_hook :before_tests, *args
+    execute_hook :start, *args
+  end
+  alias_method :start, :before_tests
+
+  def start_test(*args)
+    if @watir_config.reuse_browser && browser.nil
+      raise StandardError, "#before_tests method must be set in order to use
+the #reuse_browser configuration setting"
+    end
+
+    before_test(*args)
+
+    @browser = create_browser(*args) unless @watir_config.reuse_browser
+    @browser.window.maximize if @watir_config.maximize_browser
+
+    execute_hook :start_test, *args
+
+    @browser
+  end
+
+  def end_test(*args)
+    execute_hook :end_test, *args
+
+    take_screenshot(*args) unless watir_config.take_screenshots == :never
+
+    quit_browser unless watir_config.reuse_browser
+
+    after_test(*args)
+  end
+
+  def after_tests(*args)
+    quit_browser if @watir_config.reuse_browser
+
+    execute_hook :after_tests, *args
+    execute_hook :end, *args
+  end
+  alias_method :end, :after_tests
+
+  def take_screenshot(*args)
+    screenshot = execute_hook(:take_screenshot, *args).compact
+    browser.screenshot.save("screenshot.png") if screenshot.nil?
+  end
+
+  def before_test(*args)
+    execute_hook :before_test, *args
+  end
+
+  def after_test(*args)
+    execute_hook :after_test, *args
+  end
+
+  def quit_browser
+    if @headless
+      @headless.destroy
+      @headless = nil
+    end
+
+    return if @browser.nil?
+
+    @browser.quit
+    @browser = nil
+  end
+
+  def restart_browser!
+    quit_browser
+    create_browser
+  end
+
+  def reset_config!
+    @watir_config = nil
+  end
+
+  def reset_registered_sessions!
+    @registered_sessions = nil
+  end
+
+  def configure_watir
+    Watir.default_timeout = @watir_config.watir_timeout
+    Watir.prefer_css = @watir_config.prefer_css
+    Watir.always_locate = @watir_config.always_locate
+  end
+
+  def use_headless_display
+    unless RbConfig::CONFIG['host_os'].match('linux')
+      warn "Headless only supported on Linux"
+      return
+    end
+    require 'headless'
+    @headless = Headless.new
+    @headless.start
+  end
+
+end

data/lib/watir_session.rb

@@ -0,0 +1,7 @@
+require 'watir-webdriver'
+
+require 'watir_session/custom_config'
+require 'watir_session/watir_config'
+require 'watir_session/watir_session'
+
+include WatirSession

data/watir_session.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'watir_session'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Titus Fortner']
+  spec.email         = ['titusfortner@gmail.com']
+
+  spec.summary       = %q{Allows easy access to configuration and session data for Watir tests.}
+  spec.description   = %q{This gem leverages the Watir test library to allow for easy access
+to configurarion and session data so they do not need to be passed around as parameters throughout your tests.}
+  spec.homepage      = 'https://github.com/titusfortner/watir_session'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'headless' # This only gets required when on Linux
+  spec.add_development_dependency 'watir-webdriver'
+  spec.add_development_dependency 'test-model'
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: watir_session
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Titus Fortner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: headless
+  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: watir-webdriver
+  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: test-model
+  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'
+description: |-
+  This gem leverages the Watir test library to allow for easy access
+  to configurarion and session data so they do not need to be passed around as parameters throughout your tests.
+email:
+- titusfortner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/watir_session.rb
+- lib/watir_session/custom_config.rb
+- lib/watir_session/watir_config.rb
+- lib/watir_session/watir_session.rb
+- watir_session.gemspec
+homepage: https://github.com/titusfortner/watir_session
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Allows easy access to configuration and session data for Watir tests.
+test_files: []
+has_rdoc: