gridium 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55207517ef6c73206e73da6b350b30dc4289c6b8
+  data.tar.gz: c0658a076cbf44b733c0472a4159cbd7e898e739
+SHA512:
+  metadata.gz: 2750d1c19ee74b7d3da5ace0245cb48dcb09a85ec7f89eee4c1b60b14f134b2ecd13121f182efc4a313c2005e5b2129bec8048e614871cf06cae5ac81505dfc8
+  data.tar.gz: 46138b07ca14d1290f7f8e10919940722a44d6ca4f351dc3bffe8c37a8dd9023a03807e391e0e9fe2f1f34270a5c920090ae208ea1b026b7bdea57309fed584c

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Seth Urban
+
+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,42 @@
+# Gridium
+
+Welcome to Gridium! Gridium helps you build better automated tests using only Selenium and your advanced knowledge of page objects.  This is a replacement gem for Capybara.  I found it more difficult to use Capybara with Firefox and Selenium, and wanted to take advantage of everything that Selenium offered and Capybara lacked.
+
+Before you get started you should understand how page objects work.  A primer on Page Objects:
+[Template Design Pattern](http://www.electricsheepdreams.com/blog/2014/12/4/template-design-pattern-the-first-avenger)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gridium'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gridium
+
+## Usage
+
+Comming Soon!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sethuster/gridium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gridium"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gridium.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gridium/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gridium"
+  spec.version       = Gridium::VERSION
+  spec.authors       = ["Seth Urban"]
+  spec.email         = ["sethuster@gmail.com"]
+
+  spec.summary       = %q{This Gem is used to make building Selenium Tests without Capybara Easier.}
+  spec.description   = %q{Capybara is a great tool to start making automated tests for your web application.  However, many automation engineers find it difficult to use effectively for UI tests.  Capybara works better when webkit, and not so well with mozilla.  This makes Selenium integration difficult, this gem remedies that.}
+  spec.homepage      = "http://github.com/sethuster/gridium"
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "selenium-webdriver", ">=2.45.0"
+  spec.add_runtime_dependency "oily_png"
+
+end

data/lib/driver.rb

@@ -0,0 +1,214 @@
+require 'selenium-webdriver'
+require 'uri'
+
+
+class Driver
+  @@driver = nil
+
+  def self.reset
+    driver.manage.delete_all_cookies
+    driver.manage.timeouts.page_load = Gridium.config.page_load_timeout
+    driver.manage.timeouts.implicit_wait = Gridium.config.element_timeout
+
+    # Ensure the browser is maximized to maximize visibility of element
+    # Currently doesn't work with chromedriver, but the following workaround does:
+    if @browser_type.eql?(:chrome)
+      width = driver.execute_script("return screen.width;")
+      height = driver.execute_script("return screen.height;")
+      driver.manage.window.move_to(0, 0)
+      driver.manage.window.resize_to(width, height)
+    else
+      driver.manage.window.maximize
+    end
+  end
+
+  def self.driver
+    begin
+      unless @@driver
+        @browser_type = Gridium.config.browser
+        @@driver = Selenium::WebDriver.for(Gridium.config.browser)
+        reset
+      end
+      @@driver
+    rescue Exception => e
+      Log.debug(e.backtrace.inspect)
+      Log.info("Driver did not load within (#{Gridium.config.page_load_timeout}) seconds.  [#{e.message}]")
+      $fail_test_instantly = true
+      Kernel.fail(e.message)
+    end
+  end
+
+  def self.driver= driver
+    @@driver.quit if @@driver
+    @@driver = driver
+  end
+
+  # =============== #
+  # Driver Commands #
+  # =============== #
+
+  def self.visit(path)
+    begin
+      Log.debug("Navigating to url: (#{path}).")
+      driver
+      time_start = Time.now
+      driver.navigate.to(path)
+      time_end = Time.new
+      page_load = (time_end - time_start)
+      Log.debug("Page loaded in (#{page_load}) seconds.")
+      $verification_passes += 1
+    rescue Exception => e
+      Log.debug(e.backtrace.inspect)
+      Log.error("#{e.message} - Also be sure to check the url formatting.  http:// is required for proper test execution (www is optional).")
+    end
+  end
+
+  def self.nav(path)
+    visit(Gridium.config.url + path)
+  end
+
+  def self.quit
+    if @@driver
+      Log.debug('Shutting down web driver...')
+      @@driver.quit
+      @@driver = nil
+    end
+  end
+
+  def self.go_back
+    driver.navigate.back
+  end
+
+  def self.go_forward
+    driver.navigate.forward
+  end
+
+  def self.html
+    driver.page_source
+  end
+
+  def self.title
+    driver.title
+  end
+
+  def self.current_url
+    driver.current_url
+  end
+
+  def self.refresh
+    driver.navigate.refresh
+  end
+
+
+  def self.current_domain
+    site_url = driver.current_url.to_s
+    # domain = site_url.match(/(https?:\/\/)?(\S*\.)?([\w\d]*\.\w+)\/?/i)[3]
+    domain = URI.parse(site_url)
+    host = domain.host
+    if (!host.nil?)
+      Log.debug("Current domain is: (#{host}).")
+      return host
+    else
+      Log.error("Unable to parse URL.")
+    end
+  end
+
+  def self.verify_url(given_url)
+    Log.debug('Verifying URL...')
+    current_url = self.current_url.to_s
+    current_domain = self.current_domain.to_s
+    if current_domain.include?(given_url)
+      Log.debug("Confirmed. (#{current_url}) includes (#{given_url}).")
+      $verification_passes += 1
+    else
+      Log.error("(#{current_url}) does not include (#{given_url}).")
+      Kernel.fail
+    end
+  end
+
+  #
+  # Execute Javascript on the element
+  #
+  # @param [String] script - Javascript source to execute
+  # @param [Element] element
+  #
+  # @return The value returned from the script
+  #
+  def self.execute_script(script, element)
+    driver.execute_script(script, element)
+  end
+
+  #
+  # Execute Javascript on the page
+  #
+  # @param [String] script - Javascript source to execute
+  #
+  # @return The value returned from the script
+  #
+  def self.execute_script_driver(script)
+    driver.execute_script(script)
+  end
+
+  def self.evaluate_script(script)
+    driver.execute_script "return #{script}"
+  end
+
+  def self.save_screenshot(type = 'saved')
+    Log.debug ("Capturing screenshot of browser...")
+    timestamp = Time.now.strftime("%Y_%m_%d__%H_%M_%S")
+    screenshot_path = File.join($current_run_dir, "screenshot__#{timestamp}__#{type}.png")
+    driver.save_screenshot(screenshot_path)
+    $screenshots_captured.push("screenshot__#{timestamp}__#{type}.png")   # used by custom_formatter.rb for embedding in report
+  end
+
+  def self.list_open_windows
+    handles = driver.window_handles
+    Log.debug("List of active windows:")
+    handles.each do |handle|
+      driver.switch_to.window(handle)
+      Log.debug("|  Window with title: (#{driver.title}) and handle: #{handle} is currently open.")
+    end
+    driver.switch_to.window(driver.window_handles.first)
+  end
+
+  def self.open_new_window(url)
+    Log.debug("Opening new window and loading url (#{url})...")
+    DriverExtensions.open_new_window(url)
+  end
+
+  def self.close_window
+    Log.debug("Closing window (#{driver.title})...")
+    DriverExtensions.close_window
+  end
+
+  def self.switch_to_window(title)
+    current_title = driver.title
+    Log.debug("Current window is: (#{current_title}).  Switching to next window (#{title})...")
+    handles = driver.window_handles
+    driver.switch_to.window(handles.first)
+    handles.each do |handle|
+      driver.switch_to.window(handle)
+      if driver.title == title
+        Log.debug("Window (#{driver.title}) is now the active window.")
+        return
+      end
+    end
+    list_open_windows
+    Log.error("Unable to switch to window with title (#{title}).")
+  end
+
+  def self.switch_to_next_window
+    current_title = driver.title
+    Log.debug("Current window is: (#{current_title}).  Switching to next window...")
+    driver.switch_to.window(driver.window_handles.last)
+    Log.debug("Window (#{driver.title}) is now the active window.")
+  end
+
+  def self.switch_to_main_window
+    current_title = driver.title
+    Log.debug("Current window is: (#{current_title}).  Switching to main window...")
+    driver.switch_to.window(driver.window_handles.first)
+    Log.debug("Window (#{driver.title}) is now the active window.")
+  end
+
+end

data/lib/driver_extensions.rb

@@ -0,0 +1,11 @@
+class DriverExtensions
+  def self.open_new_window(url)
+    Driver.execute_script_driver("window.open('#{url}')")
+    sleep 1
+  end
+
+  def self.close_window
+    Driver.execute_script_driver("window.close()")
+    sleep 1
+  end
+end

data/lib/element.rb

@@ -0,0 +1,243 @@
+require 'selenium-webdriver'
+require 'oily_png'
+
+class Element
+  attr_reader :name, :by, :locator
+
+  def initialize(name, by, locator)
+    @name = name
+    @by = by
+    @locator = locator
+
+    # wrapped driver
+    @driver = Driver.driver
+
+    # selenium web element
+    @element = nil
+  end
+
+  def to_s
+    "'#{@name}' (By:#{@by} => '#{@locator}')"
+  end
+
+  def element
+    if @element.nil? or is_stale?
+      wait = Selenium::WebDriver::Wait.new :timeout => Gridium.config.element_timeout, :interval => 1
+      if Gridium.config.visible_elements_only
+        wait.until {
+          elements = @driver.find_elements(@by, @locator)
+          elements.each do |element|
+            if element.displayed?
+              @element = element;
+            end
+          end
+          @element.enabled?
+        }
+      else
+        wait.until { @element = @driver.find_element(@by, @locator); Log.debug("Finding element #{self}..."); @element.enabled? }
+      end
+
+    end
+    @element
+  end
+
+  def element= e
+    @element = e
+  end
+
+  # ================ #
+  # Element Commands #
+  # ================ #
+
+  # soft failure, will not kill test immediately
+  def verify(timeout=nil)
+    Log.debug('Verifying new element...')
+    timeout = Gridium.config.element_timeout if timeout.nil?
+    ElementVerification.new(self, timeout)
+  end
+
+  # hard failure, will kill test immediately
+  def wait_until(timeout=nil)
+    Log.debug('Waiting for new element...')
+    timeout = Gridium.config.element_timeout if timeout.nil?
+    ElementVerification.new(self, timeout, fail_test=true)
+  end
+
+  def attribute(name)
+    element.attribute(name)
+  end
+
+  def present?
+    begin
+      return element.enabled?
+    rescue Exception => e
+      return false
+    end
+  end
+
+  def displayed?
+    begin
+      return element.displayed?
+    rescue Exception => e
+      return false
+    end
+  end
+
+  def enabled?
+    return element.enabled?
+  end
+
+  def clear
+    element.clear
+  end
+
+  def click
+    Log.debug("Clicking on #{self}")
+    if element.enabled?
+      ElementExtensions.highlight(self) if Gridium.config.highlight_verifications
+      $verification_passes += 1
+      element.click
+    else
+      Log.error('Cannot click on element.  Element is not present.')
+    end
+  end
+
+  def send_keys(*args)
+    Log.debug("Typing: #{args} into element: (#{self}).")
+    if element.enabled?
+      ElementExtensions.highlight(self) if Gridium.config.highlight_verifications
+      $verification_passes += 1
+      element.send_keys *args
+    else
+      Log.error('Cannot type into element.  Element is not present.')
+    end
+  end
+
+  def location
+    element.location
+  end
+
+  def hover_over
+    Log.debug("Hovering over element (#{self.to_s})...")
+    # @driver.mouse.move_to(element)            # Note: Doesn't work with Selenium 2.42 bindings for Firefox v31
+    # @driver.action.move_to(element).perform
+    # @driver.mouse_over(@locator)
+    if element.enabled?
+      $verification_passes += 1
+      ElementExtensions.hover_over(self) # Javascript workaround to above issue
+    else
+      Log.error('Cannot hover over element.  Element is not present.')
+    end
+  end
+
+  def hover_away
+    Log.debug("Hovering away from element (#{self.to_s})...")
+    if element.enabled?
+      $verification_passes += 1
+      ElementExtensions.hover_away(self) # Javascript workaround to above issue
+    else
+      Log.error('Cannot hover away from element.  Element is not present.')
+    end
+  end
+
+  def scroll_into_view
+    if element.enabled?
+      $verification_passes += 1
+      ElementExtensions.scroll_to(self)
+    else
+      Log.error('Cannot scroll element into view.  Element is not present.')
+    end
+  end
+
+  def size
+    element.size
+  end
+
+  def selected?
+    element.selected?
+  end
+
+  def tag_name
+    element.tag_name
+  end
+
+  def submit
+    element.submit
+  end
+
+  def text
+    element.text
+  end
+
+  def text= text
+    element.send_keys text
+  end
+
+  #
+  # Search for an element within this element
+  #
+  # @param [Symbol] by  (:css or :xpath)
+  # @param [String] locator
+  #
+  # @return [Element] element
+  #
+  def find_element(by, locator)
+    Log.debug('Finding element...')
+    element.find_element(by, locator)
+  end
+
+  #
+  # Search for an elements within this element
+  #
+  # @param [Symbol] by  (:css or :xpath)
+  # @param [String] locator
+  #
+  # @return [Array] elements
+  #
+  def find_elements(by, locator)
+    element.find_elements(by, locator)
+  end
+
+  def save_element_screenshot
+    Log.debug ("Capturing screenshot of element...")
+    self.scroll_into_view
+
+    timestamp = Time.now.strftime("%Y_%m_%d__%H_%M_%S")
+    name = self.name.gsub(' ', '_')
+    screenshot_path = File.join($current_run_dir, "#{name}__#{timestamp}.png")
+    @driver.save_screenshot(screenshot_path)
+
+    location_x = self.location.x
+    location_y = self.location.y
+    element_width = self.size.width
+    element_height = self.size.height
+
+    # ChunkyPNG commands tap into oily_png (performance-enhanced version of chunky_png)
+    image = ChunkyPNG::Image.from_file(screenshot_path.to_s)
+    image1 = image.crop(location_x, location_y, element_width, element_height)
+    image2 = image1.to_image
+    element_screenshot_path = File.join($current_run_dir, "#{name}__#{timestamp}.png")
+    image2.save(element_screenshot_path)
+    $screenshots_captured.push("#{name}__#{timestamp}.png")
+  end
+
+  def method_missing(method_sym, *arguments, &block)
+    Log.debug("called #{method_sym} on element #{@locator} by #{@by_type}")
+    if @element.respond_to?(method_sym)
+      @element.method(method_sym).call(*arguments, &block)
+    else
+      super
+    end
+  end
+
+  private
+
+  def is_stale?
+    begin
+      @element.enabled?
+      return false
+    rescue Exception => e
+      return true
+    end
+  end
+end

data/lib/element_extensions.rb

@@ -0,0 +1,30 @@
+include Gridium
+
+class Gridium::ElementExtensions
+  def self.highlight(element)
+    Log.debug("Highlighting element...")
+    original_border = Driver.execute_script("return arguments[0].style.border", element.element)
+    original_background = Driver.execute_script("return arguments[0].style.backgroundColor", element.element)
+    Driver.execute_script("arguments[0].style.border='3px solid lime'; return;", element.element)
+    Driver.execute_script("arguments[0].style.backgroundColor='lime'; return;", element.element)
+    sleep (Gridium.config.highlight_duration)
+    Driver.execute_script("arguments[0].style.border='" + original_border + "'; return;", element.element)
+    Driver.execute_script("arguments[0].style.backgroundColor='" + original_background + "'; return;", element.element)
+  end
+
+  def self.scroll_to(element)
+    Log.debug("Scrolling element into view...")
+    Driver.execute_script("arguments[0].scrollIntoView(); return;", element.element)
+    sleep 1
+  end
+
+  def self.hover_over(element)
+    Driver.execute_script("var evObj = document.createEvent('MouseEvents'); evObj.initMouseEvent(\"mouseover\",true, false, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null); arguments[0].dispatchEvent(evObj);", element.element)
+    sleep 2
+  end
+
+  def self.hover_away(element)
+    Driver.execute_script("var evObj = document.createEvent('MouseEvents'); evObj.initMouseEvent(\"mouseout\",true, false, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null); arguments[0].dispatchEvent(evObj);", element.element)
+    sleep 1
+  end
+end

data/lib/element_verification.rb

@@ -0,0 +1,161 @@
+include Gridium
+
+class Gridium::ElementVerification
+  #
+  # @param [Element] element
+  # @param [Integer] timeout
+  # @param [Boolean] not_verification - Whether or not we are 'NOT' verifying something about the element
+  #
+  def initialize(element, timeout, fail_test=false, element_should_exist=true)
+    @element = element # Selement
+    @timeout = timeout
+    @should_exist = element_should_exist
+    @fail_test = fail_test
+  end
+
+  def not
+    ElementVerification.new(@element, @timeout, @fail_test, element_should_exist=false)
+  end
+
+  def text(text)
+    fail_message = nil
+    pass_message = nil
+    should_have_text = @should_exist
+    element_text = @element.text
+    if @element.present?
+      $verification_passes += 1
+    else
+      Log.error("Cannot determine element text.  Element is not present.")
+    end
+
+    if should_have_text
+      fail_message = "Element should contain text (#{text}), but does not."
+      pass_message = "contains text (#{text})."
+    else
+      fail_message = "Element should not contain text (#{text}), but does."
+      pass_message = "does not contain text (#{text}).  Actual text is: (#{element_text})."
+    end
+
+    wait = Selenium::WebDriver::Wait.new :timeout => @timeout, :interval => 1
+    begin
+      wait.until do
+        element_contains_text = element_text.eql?(text)
+        if should_have_text && element_contains_text
+          Log.debug("Confirming text (#{text}) is within element...")
+          ElementExtensions.highlight(@element) if Gridium.config.highlight_verifications
+          log_success(pass_message)
+        elsif !should_have_text && !element_contains_text
+          Log.debug("Confirming text (#{text}) is NOT within element...")
+          ElementExtensions.highlight(@element) if Gridium.config.highlight_verifications
+          log_success(pass_message)
+        else
+          log_issue("#{fail_message}  Element's text is: (#{element_text}).")
+        end
+      end
+      @element
+    end
+  end
+
+  def visible
+    fail_message = nil
+    pass_message = nil
+    should_be_visible = @should_exist
+
+    if should_be_visible
+      fail_message = "Element should be visible."
+      pass_message = "Element is visible."
+    else
+      fail_message = "Element should not be visible."
+      pass_message = "Element is not visible."
+    end
+
+    wait = Selenium::WebDriver::Wait.new :timeout => @timeout, :interval => 1
+    begin
+      wait.until do
+        element_is_displayed = @element.displayed?
+        if element_is_displayed && should_be_visible
+          ElementExtensions.highlight(@element) if Gridium.config.highlight_verifications
+          log_success(pass_message)
+          return @element
+        elsif !element_is_displayed && !should_be_visible
+          Log.debug("Confirming element is NOT visible...")
+          log_success(pass_message)
+        else
+          log_issue(fail_message)
+        end
+      end
+      @element
+    end
+  end
+
+  def present
+    fail_message = nil
+    pass_message = nil
+    should_be_present = @should_exist
+
+    if should_be_present
+      fail_message = "Element should be present."
+      pass_message = "is present."
+    else
+      fail_message = "Element should NOT be present."
+      pass_message = "is not present."
+    end
+
+    wait = Selenium::WebDriver::Wait.new :timeout => @timeout, :interval => 1
+    begin
+      wait.until do
+        element_is_present = @element.present?
+        if element_is_present && should_be_present
+          ElementExtensions.highlight(@element) if Gridium.config.highlight_verifications
+          log_success(pass_message)
+          return @element
+        elsif !element_is_present && !should_be_present
+          Log.debug("Confirming element is NOT present...")
+          log_success(pass_message)
+        else
+          log_issue(fail_message)
+        end
+      end
+      @element
+    end
+  end
+
+  # TODO:
+  def value(value)
+    raise NotImplementedError
+  end
+
+  # TODO:
+  def selected
+    raise NotImplementedError
+  end
+
+  # TODO:
+  def attribute(attribute, value)
+    raise NotImplementedError
+  end
+
+  # TODO:
+  def css(attribute, value)
+    raise NotImplementedError
+  end
+
+
+  private
+
+  def log_issue(message)
+    if @fail_test
+      Log.error("#{message} ['#{@element.name}' (By:(#{@element.by} => '#{@element.locator}'))].")
+      $fail_test_instantly = true
+      Kernel.fail(message)
+    else
+      Log.error("#{message} ['#{@element.name}' (By:(#{@element.by} => '#{@element.locator}'))].")
+      $fail_test_at_end = true
+    end
+  end
+
+  def log_success(pass_message)
+    $verification_passes += 1
+    Log.debug("Verified: '#{@element.name}' (By:(#{@element.by} => '#{@element.locator}')) #{pass_message}")
+  end
+end

data/lib/gridium.rb

@@ -0,0 +1,39 @@
+require "gridium/version"
+require "log"
+require "spec_data"
+require "driver"
+require "driver_extensions"
+require "element"
+require "element_extensions"
+require "element_verification"
+require "page"
+
+module Gridium
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield config
+  end
+
+  class Config
+    attr_accessor :report_dir, :target_environment, :browser, :url, :page_load_timeout, :element_timeout, :visible_elements_only, :log_level
+    attr_accessor :highlight_verifications, :highlight_duration, :screenshot_on_failure
+
+    def initialize
+      @report_dir = Dir.home
+      @target_environment = "localhost"
+      @browser = :firefox
+      @url = "about:blank"
+      @page_load_timeout = 15
+      @element_timeout = 15  #This needs to be changed to only look for an element after a page is done loading
+      @visible_elements_only = true
+      @log_level = :fatal
+      @highlight_verifications = false
+      @highlight_duration = 0.100
+      @screenshot_on_failure = false
+    end
+  end
+end

data/lib/gridium/version.rb

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

data/lib/log.rb

@@ -0,0 +1,142 @@
+# Logger class wraps around ruby 'logger' gem to provide diagnostic and workflow information
+
+require 'logger'
+
+# Add in multiple device logging directly into Logger class
+class Logger
+  # Creates or opens a secondary log file.
+  def attach(name)
+    @logdev.attach(name)
+  end
+
+  # Closes a secondary log file.
+  def detach(name)
+    @logdev.detach(name)
+  end
+
+  class LogDevice # :nodoc:
+    attr_reader :devs
+
+    def attach(log)
+      @devs ||= {}
+      @devs[log] = open_logfile(log)
+    end
+
+    def detach(log)
+      @devs ||= {}
+      @devs[log].close
+      @devs.delete(log)
+    end
+
+    alias_method :old_write, :write
+
+    def write(message)
+      old_write(message)
+
+      @devs ||= {}
+      @devs.each do |log, dev|
+        dev.write(message)
+      end
+    end
+  end
+end # class logger
+
+
+# Singleton Logger class
+module Gridium
+class Log
+  # make this class static
+  class << self
+
+    #
+    # more generic than INFO, useful for debugging issues
+    # DEBUG = 0
+    # generic, useful information about system operation
+    # INFO = 1
+    # a warning
+    # WARN = 2
+    # a handleable error condition
+    # ERROR = 3
+    # an unhandleable error that results in a program crash
+    # FATAL = 4
+    # an unknown message that should always be logged
+    # UNKNOWN = 5
+
+    def debug(msg)
+      log.debug(msg)
+    end
+
+    def info(msg)
+      log.info(msg)
+    end
+
+    def warn(msg)
+      log.warn(msg)
+      Driver.save_screenshot('warning') if Gridium.config.screenshot_on_failure
+      $execution_warnings << msg
+    end
+
+    def error(msg)
+      log.error(msg)
+      Driver.save_screenshot('error') if Gridium.config.screenshot_on_failure
+      $verification_errors << msg
+    end
+
+    def add_device device
+      @@devices ||= []
+      log.attach(device)
+      @@devices << device
+    end
+
+    def close
+      @@devices.each { |dev| @@logger.detach(dev) }
+      @@devices.clear
+      log.close if log
+    end
+
+
+    private
+
+    def log
+      @@logger ||= initialize_logger
+    end
+
+    def initialize_logger
+      # log to STDOUT and file
+      logger ||= Logger.new(STDOUT)
+
+      # messages that have the set level or higher will be logged
+      case Gridium.config.log_level
+        when :debug then
+          level = Logger::DEBUG
+        when :info then
+          level = Logger::INFO
+        when :warn then
+          level = Logger::WARN
+        when :error then
+          level = Logger::ERROR
+        when :fatal then
+          level = Logger::FATAL
+      end
+
+      logger.level = level
+
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        base_msg = "[#{datetime.strftime('%Y-%m-%d %H:%M:%S')}][#{severity}]"
+        sev = severity.to_s
+        if sev.eql?("DEBUG")
+          "#{base_msg}   #{msg}\n"
+        elsif sev.eql?("INFO")
+          "#{base_msg}  > #{msg}\n"
+        elsif sev.eql?("WARN")
+          "#{base_msg}  X #{msg}\n"
+        else
+          "#{base_msg} X #{msg}\n"
+        end
+      end
+
+      logger
+    end # initialize_logger
+  end # class << self
+end # Log class
+end

data/lib/page.rb

@@ -0,0 +1,106 @@
+module Gridium
+  class Page
+
+    def initialize
+
+    end
+
+    def self.switch_to_frame(frame)
+      Driver.driver.switch_to.frame(frame)
+    end
+
+    def self.switch_to_default
+      Driver.driver.switch_to.default_content
+    end
+
+    def self.assert_selector(by, locator)
+      asserted_element = Element.new("Asserted Element", by, locator)
+      unless asserted_element.enabled?
+        fail("Could not find element on page with locator #{locator} using #{by}")
+      else
+        Log.info("Asserted Element present with locator #{locator} using #{by}")
+      end
+    end
+
+    def self.has_css?(css, options={})
+      begin
+        Driver.driver.find_element(:css, css).enabled?
+      rescue Exception => e
+        return false
+      end
+    end
+
+    def self.has_xpath?(xpath, options={})
+      begin
+        Driver.driver.find_element(:xpath, xpath).enabled?
+      rescue Exception => e
+        return false
+      end
+
+    end
+
+    def self.has_link?(linktext)
+      begin
+        Driver.driver.find_element(:link_text, linktext).enabled?
+      rescue Exception => e
+        return false
+      end
+    end
+
+    def self.has_text?(text)
+      unless Driver.html.include? text
+        Log.warn("Could not find expected text: #{text} on page.")
+        return false
+      else
+        return true
+      end
+    end
+
+    def self.scroll_to_bottom
+      Driver.execute_script('window.scrollTo(0,100000)')
+    end
+
+    def self.scroll_to_top
+      #TODO Verify this
+      Driver.execute_script('window.scrollTo(100000,0)')
+    end
+
+    def self.execute_script(script)
+      Driver.execute_script(script)
+    end
+
+    def all(by, locator)
+      Driver.driver.find_elements(by, locator)
+    end
+
+    def find(by, locator)
+      Element.new("Page Find Element", by, locator)
+    end
+
+    def first(by, locator)
+      Driver.driver.find_elements(by, locator).first
+    end
+
+    def click_link(linktext)
+      link = Driver.driver.find_element(:link, linktext)
+      link.click
+    end
+
+    def click_button(button_name)
+      #The button maybe a link that looks like a button - we want to handle both
+      button = Element.new("A #{button_name} button", :xpath, "//button[contains(text(), '#{button_name}')]")
+      begin
+        button.click
+      rescue Exception => e
+        Log.debug("Button not found - Attempting Link - speed up test by using click_link method if this works...")
+        link = Element.new("A #{button_name} link", :xpath, "//a[contains(text(), '#{button_name}')]")
+        link.click
+      end
+    end
+
+    def check(id) #checks a checkbox
+      Driver.driver.find_element(:id, id).click
+    end
+
+  end
+end

data/lib/spec_data.rb

@@ -0,0 +1,63 @@
+class Spec_data
+  def self.load_suite_state
+    $screenshots_message = Array.new
+    $screenshots_captured = Array.new
+  end
+
+  def self.load_spec_state
+    $execution_warnings = Array.new
+    $verification_errors = Array.new
+    $verification_passes = 0
+    $fail_test_instantly = false
+    $fail_test_at_end = false
+  end
+
+  def self.clear_spec_state
+    $execution_warnings.clear
+    $verification_errors.clear
+    $verification_passes = 0
+    $fail_test_instantly = false
+    $fail_test_at_end = false
+  end
+
+  def self.reset_captured_screenshots
+    $screenshots_message.clear
+    $screenshots_captured.clear
+    $screenshots_data = {}
+    $fail_screenshot = nil
+  end
+
+  def self.determine_spec_result
+    if $execution_warnings.empty?
+      Log.info("No warnings detected during test run.")
+    else
+      Log.info("Warnings detected during test run: (#{$execution_warnings.length} total).")
+      msg = "Warning detected during test execution:"
+      $execution_warnings.each { |error_message| msg << "\n\t" + error_message }
+    end
+
+    if $verification_errors.empty?
+      Log.info("No errors detected during test run.")
+    else
+      Log.info("Errors detected during test run: (#{$verification_errors.length} total).")
+      msg = "TEST FAILURE: Errors detected during test execution:"
+      $verification_errors.each { |error_message| msg << "\n\t" + error_message }
+    end
+
+    if $fail_test_instantly
+      Log.info("TEST FAILED - CRITICAL ERROR DETECTED")
+      Kernel.fail("TEST FAILED - CRITICAL ERROR DETECTED\n")
+    elsif $fail_test_at_end
+      Log.info("TEST FAILED - VERIFICATION ERRORS DETECTED")
+      Kernel.fail("TEST FAILED - VERIFICATION ERRORS DETECTED\n")
+    else
+      Log.info("TEST PASSED\n")
+    end
+  end
+
+  def self.add_spec_stats_to_suite_stats
+    $verifications_total += $verification_passes
+    $warnings_total += $execution_warnings.length
+    $errors_total += $verification_errors.length
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: gridium
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seth Urban
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.45.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.45.0
+- !ruby/object:Gem::Dependency
+  name: oily_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capybara is a great tool to start making automated tests for your web
+  application.  However, many automation engineers find it difficult to use effectively
+  for UI tests.  Capybara works better when webkit, and not so well with mozilla.  This
+  makes Selenium integration difficult, this gem remedies that.
+email:
+- sethuster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gridium.gemspec
+- lib/driver.rb
+- lib/driver_extensions.rb
+- lib/element.rb
+- lib/element_extensions.rb
+- lib/element_verification.rb
+- lib/gridium.rb
+- lib/gridium/version.rb
+- lib/log.rb
+- lib/page.rb
+- lib/spec_data.rb
+homepage: http://github.com/sethuster/gridium
+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.2.2
+signing_key: 
+specification_version: 4
+summary: This Gem is used to make building Selenium Tests without Capybara Easier.
+test_files: []