watir-performance 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fad33273008c01f7ee6b8bc43838ddce2816fbb01ff2b2645095728f0fb2983a
-  data.tar.gz: 30352b0df1dbeb516ad42bf68403429588b7a6963595ec9dbed2a4aa3919222b
+  metadata.gz: 6017f0df9996f014d68143f9406bb7f7f7ca79620eaf17d282690c0a7af149cd
+  data.tar.gz: e5fa32036832cedc85736344f05c8a51c3a801a963fd2d364595ea612bf4452e
 SHA512:
-  metadata.gz: 909a756ba7e3ff1a1d14a3f2f2c743bc2396bb1ebcb38778664ad158e17b4afe9129f4fef5f88ca7671a8fb2e6151c27341101fb9390aa5859d0883e04b7b245
-  data.tar.gz: 1ea9c85abaace8f2e3f5ff36d91e9e3d38410888d99e4a74cb77fca16ebb48f2170e873698b9fcc508a4297ab09b1bf531c47108bc427eef9d60074fe157b795
+  metadata.gz: e6cf09ea0b1c504e0681e029b3e9336f2b39a9ad1d71c1bfd963ac7ce824a5d872e942b5d7dc5c4228c2b856533a1c036ceca6374730c07649af9f13c54f51d2
+  data.tar.gz: e0aa61d4822e4e9582eda6331fc97c49e68c5cdd1c8147345b8a444be0df61a7fbf6e21969f4882e0647c7420cd4154f7b47ca83fd4aa31e0833bfde1e751d31

data/.rspec

@@ -1 +1,3 @@
 --color
+--format documentation
+--require ./spec/spec_helper.rb

data/.travis.yml

@@ -0,0 +1,54 @@
+sudo: required
+language: ruby
+
+matrix:
+  include:
+  
+  - os: linux
+    rvm: 2.5.1
+    addons:
+      chrome: stable
+      firefox: "59.0.2"
+    before_install:
+    - bash ./spec/support/setup-chromedriver.sh
+    - bash ./spec/support/setup-geckodriver.sh
+    - gem install bundler -v 1.16.1
+    script: xvfb-run bundle exec rake
+    
+  - os: linux
+    rvm: 2.5.0
+    addons:
+      chrome: stable
+      firefox: "59.0"
+    before_install:
+    - bash ./spec/support/setup-chromedriver.sh
+    - bash ./spec/support/setup-geckodriver.sh
+    - gem install bundler -v 1.16.1
+    script: xvfb-run bundle exec rake
+    
+  - os: osx
+    rvm: 2.5.1
+    addons:
+      chrome: beta
+      firefox: "59.0.2"
+    before_install:
+    - sudo bash ./spec/support/setup-chromedriver.sh
+    - sudo bash ./spec/support/setup-geckodriver-alt.sh
+    - sudo safaridriver --enable
+    - gem install bundler -v 1.16.1
+    script: xvfb-run bundle exec rake
+
+  - os: osx
+    rvm: 2.5.0
+    addons:
+      chrome: beta
+      firefox: "59.0"
+    before_install:
+    - sudo bash ./spec/support/setup-chromedriver.sh
+    - sudo bash ./spec/support/setup-geckodriver-alt.sh
+    - sudo safaridriver --enable
+    - gem install bundler -v 1.16.1
+    script: xvfb-run bundle exec rake
+    
+notifications: 
+  email: false

data/Gemfile.lock

@@ -58,7 +58,7 @@ GEM
     psych (3.0.2)
     rack (2.0.5)
     rake (12.3.1)
-    rdoc (6.0.3)
+    rdoc (6.0.4)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)

data/README.rdoc

@@ -1,10 +1,18 @@
-= watir-webdriver-performance
-Predecessor to https://github.com/90kts/watir-webdriver-performance for Watir as opposed to watir-webdriver
+= watir-performance
+
+{<img src="https://badge.fury.io/rb/watir-performance.svg" alt="Gem Version" />}[https://badge.fury.io/rb/watir-performance]
+{<img src="https://beta.gemnasium.com/badges/github.com/MacCracken/watir-performance.svg" alt="Dependency Status" />}[https://beta.gemnasium.com/projects/github.com/MacCracken/watir-performance]
+{<img src="https://api.codeclimate.com/v1/badges/ce9c9de5e6146dedab27/maintainability" />}[https://codeclimate.com/github/MacCracken/watir-performance/maintainability]
+{<img src="https://travis-ci.org/MacCracken/watir-performance.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/MacCracken/watir-performance]
+
+Predecessor to https://github.com/90kts/watir-webdriver-performance for Watir as opposed to watir-webdriver.
+
+The Watir-Performance aims to provide a set of navigation timing metrics for Watir[https://github.com/watir/watir] actions using a {W3C page performance standard}[http://w3c-test.org/webperf/specs/NavigationTiming/]. This is a perfect solution to capture response time metrics, and it’s very straightforward to do.  Works for Chrome, Firefox, Edge and IE9 and up. Currently no Safari support.
 
 This gem collects and summarises metrics speficied in the W3C Navigation
 web performance specifications at
 https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/NavigationTiming/Overview.html when using
-watir-webdriver and a compatible browser.
+watir and a compatible browser.
 
 == Example output of browser.performance
 All summary times are in milliseconds, and are an abstraction of the w3c
@@ -62,7 +70,7 @@ web performance specification.
     }
   }
 
-== Contributing to watir-webdriver-performance
+== Contributing to watir-performance
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/watir-performance.rb

@@ -1,31 +1,32 @@
 require 'ostruct'
-module Watir
 
+module Watir
   # Adds helper for window.performance to Watir::Browser.
   # @see http://dev.w3.org/2006/webapi/WebTiming/
-
   class PerformanceHelper
-
     def initialize(data)
       @data = data
+      @hash = {}
     end
 
     def munge
-      hash = {}
+      OpenStruct.new(summarized_hash(data_to_hash))
+    end
+
+    def data_to_hash
       @data.each_key do |key|
-        if key == '__fxdriver_unwrapped'
-          next
-        end
-        hash[key.to_sym] = {}
+        next if key == '__fxdriver_unwrapped'
+        @hash[key.to_sym] = {}
         next unless @data[key].respond_to? :each
-        @data[key].each do |k,v|
-          if k == '__fxdriver_unwrapped'
-            next
-          end
-          hash[key.to_sym][underscored(k).to_sym] = v
+        @data[key].each do |k, v|
+          next if k == '__fxdriver_unwrapped'
+          @hash[key.to_sym][underscored(k).to_sym] = v
         end
       end
+      @hash
+    end
 
+    def summarized_hash(hash)
       hash[:summary] = {}
       hash[:summary][:redirect] = hash[:timing][:redirect_end] -
         hash[:timing][:redirect_start] if hash[:timing][:redirect_end] > 0
@@ -50,7 +51,7 @@ module Watir
       hash[:summary][:time_to_last_byte] = hash[:timing][:response_end] -
         hash[:timing][:domain_lookup_start] if hash[:timing][:domain_lookup_start] > 0
       hash[:summary][:response_time] = latest_timestamp(hash) - earliest_timestamp(hash)
-      OpenStruct.new(hash)
+      hash # Return
     end
 
     private
@@ -81,28 +82,38 @@ module Watir
       return hash[:timing][:dom_interactive] if hash[:timing][:dom_interactive] > 0
       return hash[:timing][:response_end] if hash[:timing][:response_end] > 0
     end
-
   end
 
+  PERFORMS = 'return window.performance || window.webkitPerformance || '\
+             'window.mozPerformance || window.msPerformance;'.freeze
+  ERRORMESSAGE = 'Could not collect performance metrics from your current ' \
+                'browser. Please ensure the browser you are using supports ' \
+                'collecting performance metrics.'.freeze
+
+  # Extending Watir Browser
+  # See Documentation Here
+  # https://www.rubydoc.info/gems/watir/
   class Browser
     def performance
       data = case driver.browser
-      when :internet_explorer
-        ::Object::JSON.parse(driver.execute_script("return JSON.stringify(window.performance.toJSON());"))
-      else
-        driver.execute_script("return window.performance || window.webkitPerformance || window.mozPerformance || window.msPerformance;")
-      end
-      raise 'Could not collect performance metrics from your current browser. Please ensure the browser you are using supports collecting performance metrics.' if data.nil?
+             when :internet_explorer
+               script = 'return JSON.stringify(window.performance.toJSON());'
+               cmd = driver.execute_script(script)
+               ::Object::JSON.parse(cmd)
+             else
+               driver.execute_script(PERFORMS)
+             end
+      raise ERRORMESSAGE if data.nil?
       PerformanceHelper.new(data).munge
     end
 
     def performance_supported?
-      driver.execute_script("return window.performance || window.webkitPerformance || window.mozPerformance || window.msPerformance;")
+      driver.execute_script(PERFORMS)
     end
     alias performance_data performance_supported?
 
     def with_performance
-       yield PerformanceHelper.new(performance_data).munge if performance_supported?
+      yield PerformanceHelper.new(performance_data).munge if performance_supported?
     end
   end
 end

data/spec/spec_helper.rb

@@ -4,8 +4,7 @@ require 'rspec'
 require 'watir-performance'
 require 'watir'
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-
 end

data/spec/support/setup-chromedriver.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+echo "#### Getting Chromedriver ####"
+latest_chromedriver=$(wget -qO- http://chromedriver.storage.googleapis.com/LATEST_RELEASE)
+wget https://chromedriver.storage.googleapis.com/${latest_chromedriver}/chromedriver_linux64.zip
+unzip chromedriver_linux64.zip
+sudo cp chromedriver /usr/local/bin/chromedriver
+sudo chown root /usr/local/bin/chromedriver
+sudo chmod +x /usr/local/bin/chromedriver
+sudo chmod 755 /usr/local/bin/chromedriver
+rm chromedriver*

data/spec/support/setup-geckodriver-alt.sh

@@ -0,0 +1,7 @@
+echo "#### Getting Geckodriver ####"
+GK_VERSION=0.20.1
+echo "Using GeckoDriver version: "$GK_VERSION 
+wget --no-verbose -O /tmp/geckodriver.tar.gz https://github.com/mozilla/geckodriver/releases/download/v$GK_VERSION/geckodriver-v$GK_VERSION-linux64.tar.gz
+tar -C /opt -zxf /tmp/geckodriver.tar.gz && rm /tmp/geckodriver.tar.gz 
+sudo chmod 755 /opt/geckodriver
+export PATH=$PATH:/opt/geckodriver

data/spec/support/setup-geckodriver.sh

@@ -0,0 +1,9 @@
+echo "#### Getting Geckodriver ####"
+latest_geckodriver=latest
+GK_VERSION=$(if [ ${GECKODRIVER_VERSION:-latest} = "latest" ]; then echo $(wget -qO- "https://api.github.com/repos/mozilla/geckodriver/releases/latest" | grep '"tag_name":' | sed -E 's/.*"v([0-9.]+)".*/\1/'); else echo $GECKODRIVER_VERSION; fi)
+echo "Using GeckoDriver version: "$GK_VERSION 
+wget --no-verbose -O /tmp/geckodriver.tar.gz https://github.com/mozilla/geckodriver/releases/download/v$GK_VERSION/geckodriver-v$GK_VERSION-linux64.tar.gz
+tar -C /opt -zxf /tmp/geckodriver.tar.gz && rm /tmp/geckodriver.tar.gz 
+sudo mv /opt/geckodriver /opt/geckodriver-$GK_VERSION 
+sudo chmod 755 /opt/geckodriver-$GK_VERSION 
+sudo ln -fs /opt/geckodriver-$GK_VERSION /usr/bin/geckodriver

data/spec/watir-performance-non-supported-browser_spec.rb

@@ -1,29 +1,29 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+uname=`uname -s`.chomp
+if uname == "Darwin"
+  describe 'WatirPerformance-NonSupportedBrowser' do
+    let!(:b) { @b }
 
-describe "WatirWebdriverPerformance-NonSupportedBrowser" do
+    before(:all) do
+      @b ||= Watir::Browser.new :safari
+    end
 
-  let!(:b) { @b }
+    after(:all) do
+      @b.quit
+    end
 
-  before(:all) do
-    @b ||= Watir::Browser.new :safari
-  end
-
-  after(:all) do
-    @b.close
-  end
+    pending 'should raise an error when a non supported browser is encountered' do
+      b.goto "google.com"
+      expect(-> { b.performance }).to raise_error RuntimeError, 'Could not collect performance metrics from your current browser. Please ensure the browser you are using supports collecting performance metrics.'
+    end
 
-  pending "should raise an error when a non supported browser is encountered" do
-    b.goto "google.com"
-    expect(lambda { b.performance }).to raise_error RuntimeError, 'Could not collect performance metrics from your current browser. Please ensure the browser you are using supports collecting performance metrics.'
-  end
-
-  pending "should return false for supported" do
-    b.goto "google.com"
-    expect(b).not_to be_performance_supported
-  end
+    pending "should return false for supported" do
+      b.goto "google.com"
+      expect(b).not_to be_performance_supported
+    end
 
-  pending "should not support performance as block" do
-    b.goto "google.com"
-    b.with_performance {|performance| expect(performance).not_to be_nil }
+    pending "should not support performance as block" do
+      b.goto "google.com"
+      b.with_performance {|performance| expect(performance).not_to be_nil }
+    end
   end
 end

data/spec/watir-performance_spec.rb

@@ -1,46 +1,51 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "WatirWebdriverPerformance" do
-
-  let!(:b) { @b }
-
-  before(:all) do
-    @b ||= Watir::Browser.new
-  end
-
-  after(:all) do
-    @b.close
-  end
-
-  it "should open get performance metrics from the browser" do
-    b.goto "google.com"
-    expect(b.performance).to be_an_instance_of(OpenStruct)
-  end
-
-  it "should get summary data from the performance metrics" do
-    # Summary metrics based on Processing Model of NavigationTiming
-    # http://w3c-test.org/webperf/specs/NavigationTiming/#processing-model
-    expect(b.performance.summary).to include(:app_cache)
-    expect(b.performance.summary).to include(:dns)
-    expect(b.performance.summary).to include(:tcp_connection)
-    expect(b.performance.summary).to include(:request)
-    expect(b.performance.summary).to include(:response)
-    expect(b.performance.summary).to include(:dom_processing)
-  end
-
-  it "should get the summary metrics such as Response Time, TTLB and TTFB" do
-    expect(b.performance.summary).to include(:time_to_first_byte) # aka "server time"
-    expect(b.performance.summary).to include(:time_to_last_byte) # aka "network + server time"
-    expect(b.performance.summary).to include(:response_time)
-  end
-
-  it "should return true for chrome supported" do
-    b.goto "google.com"
-    expect(b).to be_performance_supported
-  end
+uname = `uname -s`.chomp
+browsers = %i[chrome firefox]
+if %w[MINGW CYGWIN].include? uname
+  browsers << %i[edge internet_explorer]
+end
 
-  it "should support performance as block" do
-    b.goto "google.com"
-    b.with_performance {|performance| expect(performance).not_to be_nil }
+browsers.each do |browser|
+  describe "WatirPerformance-#{browser.upcase}" do
+    let!(:b) { @b }
+
+    before(:all) do
+      @b ||= Watir::Browser.new browser
+    end
+
+    after(:all) do
+      @b.close
+    end
+
+    it 'should open get performance metrics from the browser' do
+      b.goto 'google.com'
+      expect(b.performance).to be_an_instance_of(OpenStruct)
+    end
+
+    it 'should get summary data from the performance metrics' do
+      # Summary metrics based on Processing Model of NavigationTiming
+      # http://w3c-test.org/webperf/specs/NavigationTiming/#processing-model
+      expect(b.performance.summary).to include(:app_cache)
+      expect(b.performance.summary).to include(:dns)
+      expect(b.performance.summary).to include(:tcp_connection)
+      expect(b.performance.summary).to include(:request)
+      expect(b.performance.summary).to include(:response)
+      expect(b.performance.summary).to include(:dom_processing)
+    end
+
+    it 'should get the summary metrics such as Response Time, TTLB and TTFB' do
+      expect(b.performance.summary).to include(:time_to_first_byte) # aka "server time"
+      expect(b.performance.summary).to include(:time_to_last_byte) # aka "network + server time"
+      expect(b.performance.summary).to include(:response_time)
+    end
+
+    it 'should return true for chrome supported' do
+      b.goto 'google.com'
+      expect(b).to be_performance_supported
+    end
+
+    it 'should support performance as block' do
+      b.goto 'google.com'
+      b.with_performance {|performance| expect(performance).not_to be_nil }
+    end
   end
 end

data/watir-performance.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: watir-performance 0.5.0 ruby lib
+# stub: watir-performance 0.5.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "watir-performance".freeze
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Robert MacCracken".freeze, "Tim Koopmans".freeze]
-  s.date = "2018-05-04"
+  s.date = "2018-05-05"
   s.description = "This gem collects and summarises metrics speficied in the W3C Navigation web performance specifications at http://w3c-test.org/webperf/specs/NavigationTiming/ when using watir-webdriver and a compatible browser".freeze
   s.email = ["robert.maccracken@gmail.com".freeze, "tim.koops@gmail.com".freeze]
   s.extra_rdoc_files = [
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -32,6 +33,9 @@ Gem::Specification.new do |s|
     "lib/performance.rb",
     "lib/watir-performance.rb",
     "spec/spec_helper.rb",
+    "spec/support/setup-chromedriver.sh",
+    "spec/support/setup-geckodriver-alt.sh",
+    "spec/support/setup-geckodriver.sh",
     "spec/watir-performance-non-supported-browser_spec.rb",
     "spec/watir-performance_spec.rb",
     "watir-performance.gemspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-performance
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Robert MacCracken
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir
@@ -123,6 +123,7 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -134,6 +135,9 @@ files:
 - lib/performance.rb
 - lib/watir-performance.rb
 - spec/spec_helper.rb
+- spec/support/setup-chromedriver.sh
+- spec/support/setup-geckodriver-alt.sh
+- spec/support/setup-geckodriver.sh
 - spec/watir-performance-non-supported-browser_spec.rb
 - spec/watir-performance_spec.rb
 - watir-performance.gemspec