site_prism_plus 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b648678b00c5ed7508a2fd1c0a2bff2109bb7817de679588c7b2470f0ee4aa5
+  data.tar.gz: 82393ae8d6b6d1a6ff1044d5b3514d84bb754c1596c4c253a617412d7f346b21
+SHA512:
+  metadata.gz: cd9c7e052a7e859a7c28db9dc5f8846e6e9ffb6306bcd5e067d7325e0f676e722fbc5e59c2309fd10a75d35e65096b6e77a032b853605540a23d3bff9179fb07
+  data.tar.gz: f548351d34ba03a954f8b854eac4b47ba18d9e086612719b136792e158f0d30ad0f5fa349500638f161875eeb94a710f641425ab77cd5c237d80dc735a9ec713

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+**/results
+.DS_Store
+.idea
+
+# rspec failure tracking
+.rspec_status

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in site_prism_metrics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    site_prism_plus (0.1.0)
+      site_prism (~> 2.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    archive-zip (0.11.0)
+      io-like (~> 0.3.0)
+    capybara (2.18.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (>= 2.0, < 4.0)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (1.2.0)
+      archive-zip (~> 0.10)
+      nokogiri (~> 1.8)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    io-like (0.3.0)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.10.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2)
+    site_prism (2.13)
+      addressable (~> 2.4)
+      capybara (~> 2.12)
+    xpath (3.1.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  chromedriver-helper (~> 1.2.0)
+  pry (~> 0.11.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  selenium-webdriver (>= 3.4.0, <= 3.10.0)
+  site_prism_plus!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ibarra Alfonso
+
+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,129 @@
+# SitePrismPlus
+
+###THIS IS NOT PUBLISHED YET.
+
+Extends the page object model [site_prism ruby gem](https://github.com/natritmeyer/site_prism). It adds common methods to make test execution robust. The gem also can log events such as click errors or page load times into a flat file.
+
+Dynamic single page applications are getting difficult to test usually caused by timing issues resulting in raised 
+exceptions. Automation frameworks or util libraries are typically written to catch these exceptions and handled accordingly. Site Prism 
+is a great POM framework so it's quite useful extend it and put your utils.
+
+## Installation
+
+###THIS IS NOT PUBLISHED YET.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'site_prism_plus'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install site_prism_plus
+
+## Usage
+
+```ruby
+class DemoSite < SitePrismPlus::Page
+  set_url 'https://some_site.com'
+  
+  element :header_logo, :xpath, '//img[@src="some_source"]'
+  element :sub_link, '#link_id'
+  element :click_result_elem, '#some_elem_loc'
+  element :name_input_field, '#user_name'
+  element :search_input, '#q_search'
+end
+```
+
+#### Loading the page and verify element
+Loads the page and verifies if the element expected is present. Method __load_and_verify__ takes an element 
+as a parameter. The page is loaded and the element is checked until visible.
+```ruby
+demo_site = DemoSite.new('page_description')
+demo_site.load('header_logo')
+```
+
+#### Clicking an element
+Clicking an element sometimes results in exceptions such as StateElement. Method __click_element__ catches 
+exceptions and does a retry. If a second element is passed as a parameter, it verifies this second element 
+to determine if the click action was successful.
+```ruby
+demo_site.click_element('sub_link', 'click_result_elem')
+```
+
+#### Send keys and verify
+For input fields with auto-complete or has match recommendation, sending keys to the field sometimes results with several 
+issues. Method __send_and_verify__ sends the text to an input field and verifies field has the correct text. If not
+field is cleared and text is resent.
+```ruby
+demo_site.send_and_verify('name_input_field', 'some_user_name')
+```
+
+#### Send chars
+Sends text to an input field one character at a time with a slight delay between characters. Useful when checking for 
+auto-complete or search matching. 
+```ruby
+demo_site.send_chars('search_input', 'cheap flights')
+```
+
+#### Checking Visibility
+Returns true or false if an element is found and is visible. Catches possible exceptions 
+(ex. SitePrism::TimeOutWaitingForElementVisibility:).
+* is_element_visible('name_of_element')
+* wait_till_element_visible('name_of_element')
+* wait_till_element_not_visible('name_of_element')
+```ruby
+demo_site.wait_till_element_visible('header_logo')
+```
+
+#### Hover and click
+Useful for hover activated drop downs. An optional third parameter (expected_element) can be passed. This element will
+be verified to determine if the click was successful.
+```ruby
+demo_site.hover_and_click('hover_element', 'drop_option')
+
+# or
+ 
+demo_site.hover_and_click('hover_element', 'drop_option', 'resulting_element')
+```
+
+### Sections
+All methods in Page are available for Section. See RSpec tests in spec folder for examples.
+
+## Capturing Some Test Metrics
+Lots of open source and commercial applications out there to capture metrics for your web application, this gem 
+just captures test related metrics such as click retries, page loads, or transitions times (like modals). These metrics are 
+saved in a flat file and can be graphed (separate application).
+
+By default, metrics are saved in current working directory __./results/metrics.txt__
+
+
+
+#### Enable capture metrics
+Set environment variable *_SITEPRISM_METRICS_ENABLED_*
+
+#### Some optional environment variables
+* SITEPRISM_PLUS_DEBUG - prints out info of commands being executed
+* SITEPRISM_PLUS_RESULT_DIR - directory where metrics file is saved
+* SITEPRISM_PLUS_RESULT_FILE - name of file to save metrics
+
+## Development
+This is the initial release, so likely a few bugs. RSpec tests in specs directory. Any contribution/collaboration/help/criticism
+is highly welcomed.
+* More methods for other use cases
+* Currently working on graph app for the metrics 
+* More RSpec tests - isn't that always the case
+* Obviously, improve this documentation
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/site_prism_plus.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# site_prism_plus

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 "site_prism_metrics"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/site_prism_plus.rb

@@ -0,0 +1,11 @@
+require "site_prism_plus/version"
+require 'capybara'
+require 'capybara/dsl'
+require_relative 'site_prism_plus/metrics.rb'
+require_relative 'site_prism_plus/page.rb'
+require_relative 'site_prism_plus/site_prism_plus_commons.rb'
+require_relative 'site_prism_plus/section.rb'
+
+module SitePrismPlus
+  # Your code goes here...
+end

data/lib/site_prism_plus/metrics.rb

@@ -0,0 +1,70 @@
+require 'csv'
+# Singleton to capture and log metrics
+#
+class Metrics
+
+  DEFAULT_METRICS_DIR = Dir.pwd
+  DEFAULT_METRICS_FILE = 'metrics.txt'
+
+  attr_accessor :default_log_file, :default_log_directory
+
+  def initialize
+    @default_log_directory = DEFAULT_METRICS_DIR
+    if ENV['SITEPRISM_PLUS_RESULT_DIR']
+      if Dir.exist?(ENV['SITEPRISM_PLUS_RESULT_DIR'])
+        @default_log_directory = ENV['SITEPRISM_PLUS_RESULT_DIR']
+      end
+    else
+      results_folder = DEFAULT_METRICS_DIR + '/results'
+      unless Dir.exist? (results_folder)
+        Dir.mkdir(results_folder)
+      end
+      @default_log_directory = results_folder
+    end
+    @default_log_file = @default_log_directory + "/" + DEFAULT_METRICS_FILE
+    if ENV['SITEPRISM_PLUS_RESULT_FILE']
+      @default_log_file = @default_log_directory + "/" + ENV['SITEPRISM_PLUS_RESULT_FILE']
+    end
+    @stime = nil
+    @etime = nil
+  end
+
+  def self.instance
+    @@instance
+  end
+
+  def clear_file
+    if File.exist?(@default_log_file)
+      File.delete(@default_log_file)
+    end
+  end
+
+  def start_time
+    @stime = Time.now
+  end
+
+  def end_time
+    @etime = Time.now
+  end
+
+  def log_metric(page, action, tag)
+    return unless ENV['SITEPRISM_METRICS_ENABLED']
+    @etime = Time.now
+    time_laps = @etime - @stime
+    CSV.open(@default_log_file, "a") do |csv|
+      csv << [page, action, tag, time_laps]
+    end
+  end
+
+  def log_error_metric(page, action, tag)
+    return unless ENV['SITEPRISM_METRICS_ENABLED']
+    CSV.open(@default_log_file, "a") do |csv|
+      csv << [page, action, tag]
+    end
+  end
+
+  @@instance = Metrics.new
+
+  private_class_method :new
+
+end

data/lib/site_prism_plus/page.rb

@@ -0,0 +1,51 @@
+require 'site_prism'
+require_relative 'metrics'
+require_relative 'site_prism_plus_commons'
+
+# Extends SitePrism Page class to include common methods
+# and logging metrics
+module SitePrismPlus
+
+  class Page < SitePrism::Page
+    include SitePrismPlusCommons
+
+    def initialize(page_name)
+      @page_name = page_name
+      @metrics = Metrics.instance
+    end
+
+    # Page loads typically takes longer.
+    def load_and_verify(element_name)
+      load_override(element_name)
+    end
+
+    def log_transition_metric(click_element, verify_element)
+      @metrics.start_time
+      result = click_element(click_element, verify_element)
+      @metrics.log_metric(@page_name, 'click', verify_element)
+      result
+    end
+
+    def reset_logfile
+      @metrics.clear_file
+    end
+
+    def metrics_file
+      @metrics.default_log_file
+    end
+
+    private
+
+    def load_override(verify_element = nil)
+      result = true
+      @metrics.start_time
+      load
+      if verify_element
+        result = wait_till_element_visible(verify_element, 3)
+      end
+      @metrics.log_metric(@page_name, 'load', verify_element)
+      result
+    end
+
+  end
+end

data/lib/site_prism_plus/section.rb

@@ -0,0 +1,26 @@
+require 'site_prism'
+
+module SitePrismPlus
+
+  class Section < SitePrism::Section
+    include SitePrismPlusCommons
+
+    def set_name(section_name)
+      @section_name = section_name
+    end
+
+    def log_transition_metric(click_element, verify_element, metric_tag = nil)
+      @metrics = Metrics.instance
+      @metrics.start_time
+      click_element(click_element, verify_element)
+      unless metric_tag
+        metric_tag = "#{click_element} => #{verify_element}"
+      end
+      @metrics.log_metric(@section_name, 'click', metric_tag)
+    end
+
+
+    private
+
+  end
+end

data/lib/site_prism_plus/site_prism_plus_commons.rb

@@ -0,0 +1,295 @@
+# Common methods to
+#    - catch exceptions
+#    - run retries
+#    - log
+# Metrics to capture
+#  - click retry
+#  - wait till found
+module SitePrismPlusCommons
+
+  LOCATOR_TYPES = [:xpath, :css, :id, :name]
+
+  # Finds element on the browser using locator
+  # * *Args*    :
+  #   - +loc_type_or_element+ -> name of element or locator type (:xpath, :id, ...)
+  #   - +locator+ -> syntax for element locator
+  # * *Returns* :
+  #   - Capybara element object if element is found, nil otherwise
+  def find_element(loc_type_or_element, locator = nil)
+    ret_elem = nil
+    begin
+      if LOCATOR_TYPES.include?(loc_type_or_element)
+        ret_elem = find(loc_type_or_element, locator)
+      else
+        ret_elem = eval(loc_type_or_element)
+      end
+    # rescue Capybara::ElementNotFound
+    #   dbg_msg("Finding Element raised ElementNotFound #{loc_type_or_element}", 'error')
+    #   return
+    # rescue Selenium::WebDriver::Error::StaleElementReferenceError
+    #   dbg_msg("Finding Element raised StaleElementReferenceError #{loc_type_or_element}", 'error')
+    #   return
+    rescue Exception => e
+      dbg_msg('error',"Finding Element unexpected exception #{loc_type_or_element} #{e.message}", loc_type_or_element)
+      return
+    end
+    if !ret_elem
+      dbg_msg('error',"Finding Element #{loc_type_or_element}NOT FOUND.", loc_type_or_element)
+    end
+    ret_elem
+  end
+
+  # Wraps click call inside begin-rescue to catch possible
+  # raised exceptions
+  # * *Args*    :
+  #   - +element_object+ -> capybara element obj, Capybara::Element
+  # * *Returns* :
+  #   - true if no exceptions are raised after clicking on element
+  #     false if exception is caught
+  def is_element_visible?(element_name)
+    result = false
+    elem_to_check = find_element(element_name)
+    unless elem_to_check.nil?
+      result = elem_to_check.visible?
+    end
+    if result
+      dbg_msg('info',"Checking Element #{element_name} is_element_visible? - true")
+    else
+      dbg_msg('info',"Checking if element is visible #{element_name} - false")
+    end
+    return result
+  end
+
+  # Checks till an element is visible or not visible anymore
+  #
+  def wait_for_visibility(element_name, visible_test = true, max_retry = 3)
+    nretry = 0
+    res = false
+    while nretry < max_retry && !res do
+      puts "CHECKING VISIBLE!!!!!!!!!!! #{element_name} result #{res}"
+      nretry += 1
+      res = is_element_visible?(element_name)
+      if !visible_test
+        res = !res
+      end
+
+      if !res
+        puts "WAITING VISIBILITY"
+        sleep(1)
+      end
+    end
+    res
+  end
+
+  # Just to be more verbose
+  def wait_till_element_visible(element_name, n_retry = 3)
+    dbg_msg('info',"Wait till element #{element_name} is visible")
+    wait_for_visibility(element_name, true, n_retry)
+  end
+
+  # Just to be more verbose
+  def wait_till_element_not_visible(element_name, n_retry = 3)
+    dbg_msg('info',"Wait till element #{element_name} is NOT visible")
+    wait_for_visibility(element_name, false, n_retry)
+  end
+
+  # Locates an element and clicks it. Verifies if the click action was successful
+  # by locating an element that results from the click action. Retries once.
+  # * *Args*    :
+  #   - +element_name+ -> name of element defined
+  #   - +expected_element_name+ -> name of element to verify after the click
+  #   - +expected_type+ -> locator type of element to verify
+  #   - +expected_locator+ -> syntax for element to verify
+  # * *Returns* :
+  #   - true if after clicking an element the expected element is found
+  #     false otherwise
+  def click_element(element_name, expected_element_name = nil)
+    result = false
+    nretry = 0
+    while !result && nretry < 2
+      nretry += 1
+      elem_to_click = find_element(element_name)
+      if elem_to_click
+        result = click_action(elem_to_click, element_name)
+        dbg_msg('info',"Clicking element - #{element_name}")
+        if expected_element_name
+          result = is_element_visible?(expected_element_name)
+          dbg_msg('info', "Expected element after click: #{expected_element_name} visible? - #{result}")
+        end
+      end
+      if !result && nretry < 2
+        dbg_msg('error', "retry_click", element_name)
+        sleep(1)
+      end
+    end
+    result
+  end
+
+  # Sends text to an input field
+  # * *Args*    :
+  #   - +element_name+ -> name of element
+  #   - +txt_to_send+ -> text (string) to type in input field
+  # * *Returns* :
+  #   - true if element is found and send_keys successful, false otherwise
+  def send_keys(element_name, txt_to_send)
+    result = false
+    dbg_msg('info', "Send keys to element: #{element_name} - Text: #{txt_to_send}")
+    elem_input = find_element(element_name)
+    unless elem_input.nil?
+      begin
+        elem_input.send_keys(txt_to_send)
+      rescue Selenium::WebDriver::Error::StaleElementReferenceError
+        dbg_msg('error', "StaleElement exception send_keys to element: #{element_name}", element_name)
+        return false
+      end
+      result = true
+    end
+    return result
+  end
+
+  # Use when dealing with auto-complete fields
+  # Sends text to an input field one character at a time with a slight
+  # delay between characters
+  def send_chars(element_name, txt_to_send)
+    elem_input = find_element(element_name)
+    unless elem_input.nil?
+      txt_to_send.chars.each do |onechar|
+        begin
+          elem_input.send_keys(onechar)
+        rescue Selenium::WebDriver::Error::StaleElementReferenceError
+          dbg_msg('error', "StaleElement exception send_keys to element: #{element_name}", element_name)
+          return false
+        end
+        sleep(0.5)
+      end
+
+      if wait_for_text(element_name, txt_to_send)
+        return true
+      else
+        return false
+      end
+    end
+  end
+
+  # Checks element for value to equal expected text.
+  #
+  def wait_for_text(element_name, expected_text)
+    wait_sec = 0
+    while wait_sec < 2
+      wait_sec += 1
+      element_with_text = find_element(element_name)
+      if element_with_text
+        found_text = ""
+        begin
+          found_text = element_with_text.value
+          if expected_text == found_text
+            return true
+          end
+        rescue Selenium::WebDriver::Error::StaleElementReferenceError
+          dbg_msg('error', "StaleElement exception wait_for_text in element: #{element_name}", element_name)
+        end
+      end
+      sleep(1)
+    end
+    return false
+  end
+
+
+  # Similar to send_chars, this method auto correct itself if the
+  # text is not the same as what was sent
+  # - happens with input fields not ready
+  # - character send does not register especially with auto-complete fields
+  def send_and_verify(element_name, txt_to_send)
+    nretry = 0
+    while nretry < 2
+      nretry += 1
+      if send_keys(element_name, txt_to_send)
+        if wait_for_text(element_name, txt_to_send)
+          return true
+        end
+      end
+      backspace_clear(element_name)
+    end
+    return false
+  end
+
+  # Clears the text inside an input field by sending backspaces
+  # * *Args*    :
+  #   - +element_name+ -> name of element defined in POM
+  # * *Returns* :
+  #   - true if element is found, false otherwise
+  def backspace_clear(element_name)
+    field_element = find_element(element_name)
+    if field_element
+      field_text = field_element.value
+      (0..field_text.size).each do
+        send_keys(element_name, :backspace)
+      end
+    else
+      return false
+    end
+    true
+  end
+
+  # Routine for hover activated dropdown menus
+  # * *Args*    :
+  #   - +hover_elem+ -> POM defined element to move mouse over
+  #   - +click_elem+ -> POM defined element to click
+  #   - +expected_elem+ -> resulting POM defined element to verify
+  # * *Returns* :
+  #   - true if element is found, false otherwise
+  def hover_and_click(hover_elem, click_elem, expected_elem = nil)
+    result = false
+    helem = find_element(hover_elem)
+    if helem
+      dbg_msg('info', "Hovering over #{hover_elem}")
+      helem.hover
+    end
+    if wait_till_element_visible(click_elem)
+      result = click_element(click_elem, expected_elem)
+    end
+    result
+  end
+
+  private
+
+  # Wraps click call inside begin-rescue to catch possible
+  # raised exceptions
+  # * *Args*    :
+  #   - +element_object+ -> capybara element obj, Capybara::Element
+  # * *Returns* :
+  #   - true if no exceptions are raised after clicking on element
+  #     false if exception is caught
+  def click_action(element_object, element_name)
+    begin
+      element_object.click
+    # rescue Selenium::WebDriver::Error::StaleElementReferenceError
+    #   dbg_msg('error', "Stale Element exception - click_element")
+    #   return false
+    # rescue Selenium::WebDriver::Error::UnknownError
+    #   dbg_msg('error', "Unknown error exception - click_element")
+    #   return false
+    rescue Exception => e
+      dbg_msg('error', 'click_exception', element_name)
+      return false
+    end
+    true
+  end
+
+  def dbg_msg(dlevel, msg, msg_tag = nil)
+    case dlevel.downcase
+      when 'info'
+        puts "INFO: #{msg}" if ENV['SITEPRISM_PLUS_DEBUG']
+      when 'error'
+        puts "ERROR: #{msg}" if ENV['SITEPRISM_PLUS_DEBUG']
+        log_metric(@page_name, msg, msg_tag) if ENV['SITEPRISM_METRICS_ENABLED']
+    end
+  end
+
+  # Log error or retry events
+  def log_metric(page, action, error_tag)
+    @metric = Metrics.instance
+    @metric.log_error_metric(page, action, error_tag)
+  end
+
+end

data/lib/site_prism_plus/version.rb

@@ -0,0 +1,3 @@
+module SitePrismPlus
+  VERSION = "0.2.0"
+end

data/site_prism_plus.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "site_prism_plus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "site_prism_plus"
+  spec.version       = SitePrismPlus::VERSION
+  spec.required_ruby_version = '>= 2.1'
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors       = ["Ibarra Alfonso"]
+  spec.email         = ["ibarraalfonso@gmail.com"]
+
+  spec.summary       = %q{Extends site_prism gem with methods for robust tests and collect test metrics }
+  spec.description   = %q{Adds more robust methods and collects test metrics. .}
+  spec.homepage      = "https://github.com/ibaralf/site_prism_plus"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "site_prism", "~> 2.9"
+
+  # NOTE: breaking with pry seems to affect webdriver that it could
+  #       not find the elements in the current window
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "selenium-webdriver", ['>= 3.4.0', '<= 3.10.0']
+  spec.add_development_dependency "chromedriver-helper", "~> 1.2.0"
+  spec.add_development_dependency "pry", "~> 0.11.0"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: site_prism_plus
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ibarra Alfonso
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: site_prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: Adds more robust methods and collects test metrics. .
+email:
+- ibarraalfonso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/site_prism_plus.rb
+- lib/site_prism_plus/metrics.rb
+- lib/site_prism_plus/page.rb
+- lib/site_prism_plus/section.rb
+- lib/site_prism_plus/site_prism_plus_commons.rb
+- lib/site_prism_plus/version.rb
+- site_prism_plus.gemspec
+homepage: https://github.com/ibaralf/site_prism_plus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Extends site_prism gem with methods for robust tests and collect test metrics
+test_files: []