watir-performance 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a58a01bfa8f5983de579bd6a5147d90b74d190333fbb93227cbe3ffb7cfb4b7
-  data.tar.gz: 4c9f94b61a0a5ad458c81cc72a14ca5bc559723d763c30d101e03cb2515bef70
+  metadata.gz: c2700a82cb1c92e5e159afd486c2135952335e7053dde17750546301c7421569
+  data.tar.gz: 605a5699aa7c5e28459578b26c858711ebb5970e47eb02b4a0b1710b7ec32853
 SHA512:
-  metadata.gz: 79b4722c0432483ddc3d6e6550cef8d79fc4d6ce897f4f3bff14d198fa5da2e4d4a4c6892ff579fe480ab2b30b7d8c79d0a432680514feeadfd35d48aac8b84f
-  data.tar.gz: 0d5176462173598b7895fee8c3acdd908d38ad02abacc9752d506ce78e91affa3d61ff5f760382abbdf48e6ded9e3cd6cabfa43deb7a1ba9436cd10110b47b6d
+  metadata.gz: de7d205aa90f8b3d4e4362d4a99b242c7fdabc5ba0dbe70bf0c300791216a1c937d4fd1b8b699eb2f09222f9506426d32b5b005bf90034bd1c3fc22c17555072
+  data.tar.gz: 2ba85db7b30e22b66c46de210570345a54739fb5529389653c5ba46aae98505873dbca63b23e84ee0da08c0106e44739f737a9ed2c78e1a344988151df656044

data/.document

@@ -1,5 +1,3 @@
 lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
+-
 LICENSE.txt

data/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+dependency_scanning:
+  image: docker:stable
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env DEP_SCAN_DISABLE_REMOTE_CHECKS="${DEP_SCAN_DISABLE_REMOTE_CHECKS:-false}"
+        --volume "$PWD:/code"
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/dependency-scanning:$SP_VERSION" /code
+  artifacts:
+    paths: [gl-dependency-scanning-report.json]

data/.travis.yml

@@ -3,86 +3,89 @@ language: ruby
 
 matrix:
   include:
-
+  # Testing all Available Ruby version from 2.3.7 - 2.6.0-preview1
   - os: linux
-    rvm: 2.6.0-preview1
+    rvm: 
+      - 2.6.0-preview1
+    env:
+      - MOZ_HEADLESS=1
     addons:
       chrome: stable
-      firefox: "59.0.2"
+      firefox: latest
     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.1
+    env:
+      - MOZ_HEADLESS=1
     addons:
       chrome: stable
-      firefox: "59.0.2"
+      firefox: latest
     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.4.4
+    env:
+      - MOZ_HEADLESS=1
     addons:
       chrome: stable
-      firefox: "59.0"
+      firefox: latest
     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.3.7
+    env:
+      - MOZ_HEADLESS=1
     addons:
       chrome: stable
-      firefox: "59.0"
+      firefox: latest
     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
     
+  # OSX is only testing unsupported browser safari - all results should be pending
   - 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
+      - sudo safaridriver --enable
+      - gem install bundler -v 1.16.1
+    script: bundle exec rake spec SPEC=spec/watir-performance-non-supported-browser_spec.rb
 
   - os: osx
     rvm: 2.4.4
-    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
-
+      - sudo safaridriver --enable
+      - gem install bundler -v 1.16.1
+    script: bundle exec rake spec SPEC=spec/watir-performance-non-supported-browser_spec.rb
+  
   - os: osx
     rvm: 2.3.7
-    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
-    
+      - sudo safaridriver --enable
+      - gem install bundler -v 1.16.1
+    script: bundle exec rake spec SPEC=spec/watir-performance-non-supported-browser_spec.rb
+
+  #- os: linux with saucelabs to test Edge and IE
+  #- os: linux
+  #  rvm: 2.5.1
+  #  env:
+  #    - SAUCELABS=true
+  #  addons:
+  #    sauce_connect: true
+  #  before_install:
+  #    - gem install bundler -v 1.16.1
+  #    - echo $SAUCELABS
+
+
 notifications: 
   email: false

data/LICENSE.txt

@@ -1,5 +1,5 @@
+Copyright (c) 2018 Robert MacCracken
 Copyright (c) 2011 Tim Koopmans
-Copyright (c) 2017 Robert MacCracken
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,18 +1,15 @@
 = 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.
+Successor to 90kts:watir-webdriver-performance[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 and a compatible browser.
+This gem collects and summarises metrics speficied in the W3C:Navigation[https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/NavigationTiming/Overview.html]
+web performance specifications when using watir and a compatible browser.
 
 == Example output of browser.performance
 All summary times are in milliseconds, and are an abstraction of the w3c
@@ -82,7 +79,7 @@ web performance specification.
 
 == Copyright
 
-Copyright (c) 2011 Tim Koopmans, 2017 Robert MacCracken. 
+Copyright (c) 2018 Robert MacCracken, 2011 Tim Koopmans
 
 See LICENSE.txt for further details.
 

data/Rakefile

@@ -15,7 +15,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/MacCracken/watir-performance"
   gem.license = "MIT"
   gem.summary = %Q{A simple helper gem for watir performance metrics}
-  gem.description = %Q{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}
+  gem.description = %Q{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 and a compatible browser}
   gem.email = ['robert.maccracken@gmail.com', "tim.koops@gmail.com"]
   gem.authors = ['Robert MacCracken', "Tim Koopmans"]
   gem.required_rubygems_version = '~> 2.7'

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.6.0

data/examples/basic.rb

@@ -1,5 +1,5 @@
-require 'watir-performance'
 require 'watir'
+require 'watir-performance'
 b = Watir::Browser.new :chrome
 b.goto "altentee.com"
 p b.performance

data/lib/idl_extractor.rb

@@ -14,7 +14,7 @@ idl.each do |spec|
 end
 
 results = {}
-results[:class] = "Performance"
+results[:class] = 'Performance'
 results[:interfaces] = {}
 nodes.each do |node|
   interface_name = node.children.first.header.name.gsub("Performance","")

data/lib/watir-performance.rb

@@ -51,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)
-      hash # Return
+      hash
     end
 
     private
@@ -59,28 +59,29 @@ module Watir
     def underscored(camel_cased_word)
       word = camel_cased_word.to_s.dup
       word.gsub!(/::/, '/')
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-      word.tr!("-", "_")
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
       word.downcase!
       word
     end
 
+    def timer_checks(timers, hash)
+      timers.each do |timer|
+        return hash[:timing][timer] if hash[:timing][timer] > 0
+      end
+    end
+
     def earliest_timestamp(hash)
-      return hash[:timing][:navigation_start] if hash[:timing][:navigation_start] > 0
-      return hash[:timing][:redirect_start] if hash[:timing][:redirect_start] > 0
-      return hash[:timing][:redirect_end] if hash[:timing][:redirect_end] > 0
-      return hash[:timing][:fetch_start] if hash[:timing][:fetch_start] > 0
+      timers = %i[navigation_start redirect_start redirect_end fetch_start]
+      timer_checks(timers, hash)
     end
 
     def latest_timestamp(hash)
-      return hash[:timing][:load_event_end] if hash[:timing][:load_event_end] > 0
-      return hash[:timing][:load_event_start] if hash[:timing][:load_event_start] > 0
-      return hash[:timing][:dom_complete] if hash[:timing][:dom_complete] > 0
-      return hash[:timing][:dom_content_loaded_event_end] if hash[:timing][:dom_content_loaded_event_end] > 0
-      return hash[:timing][:dom_content_loaded_event_start] if hash[:timing][:dom_content_loaded_event_start] > 0
-      return hash[:timing][:dom_interactive] if hash[:timing][:dom_interactive] > 0
-      return hash[:timing][:response_end] if hash[:timing][:response_end] > 0
+      timers = %i[load_event_end load_event_start dom_complete
+                  dom_content_loaded_event_end dom_content_loaded_event_start
+                  dom_interactive response_end]
+      timer_checks(timers, hash)
     end
   end
 

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

@@ -3,5 +3,4 @@ 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
+sudo chmod 755 /opt/geckodriver

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

@@ -1,5 +1,5 @@
 uname=`uname -s`.chomp
-if uname == "Darwin"
+if uname == 'Darwin'
   describe 'WatirPerformance-NonSupportedBrowser' do
     let!(:b) { @b }
 
@@ -8,22 +8,27 @@ if uname == "Darwin"
     end
 
     after(:all) do
-      @b.quit
+      @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.'
+    pending 'should raise an error when a non supported' \
+            'browser is encountered' do
+
+      b.goto 'google.com'
+      error = 'Could not collect performance metrics from your current browser'\
+              '. Please ensure the browser you are using supports collecting ' \
+              'performance metrics.'
+      expect(-> { b.performance }).to raise_error RuntimeError, error
     end
 
-    pending "should return false for supported" do
-      b.goto "google.com"
+    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,15 +1,41 @@
-uname = `uname -s`.chomp
-browsers = %i[chrome firefox]
-if %w[MINGW CYGWIN].include? uname
-  browsers << %i[edge internet_explorer]
-end
+browsers = if ENV['SAUCELABS'] == 'true'
+             %i[edge internet_explorer]
+           else
+             %i[chrome firefox]
+           end
 
 browsers.each do |browser|
   describe "WatirPerformance-#{browser.upcase}" do
     let!(:b) { @b }
 
     before(:all) do
-      @b ||= Watir::Browser.new browser
+      opt = case browser
+            when :chrome
+              Selenium::WebDriver::Chrome::Options.new(args: %w[no-sandbox
+                                                                headless
+                                                                disable-gpu])
+            when :firefox
+              Selenium::WebDriver::Firefox::Options.new(args: %w[no-sandbox
+                                                                 headless
+                                                                 disable-gpu])
+            when :edge
+              Selenium::WebDriver::Remote::Capabilities.edge
+              opt['platform'] = 'Windows 10'
+              opt['version'] = '17.17134'
+              opt['build'] = ENV['TRAVIS_JOB_NUMBER']
+            when :internet_explorer
+              Selenium::WebDriver::Remote::Capabilities.internet_explorer(
+                platform: 'Windows 10', version: '11.103',
+                device: 'Desktop', build: ENV['TRAVIS_JOB_NUMBER']
+              )
+            end
+
+      @b ||= if ENV['SAUCELABS'] == 'true'
+               test_url = "http://#{ENV['SAUCE_USERNAME']}:#{ENV['SAUCE_ACCESS_KEY']}@ondemand.saucelabs.com/wd/hub"
+               Watir::Browser.new(browser, url: test_url, options: opt)
+             else
+               Watir::Browser.new(browser, options: opt)
+             end
     end
 
     after(:all) do
@@ -24,28 +50,25 @@ browsers.each do |browser|
     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)
+      included = %i[app_cache dns tcp_connection request response dom_processing]
+      included.each { |item| expect(b.performance.summary).to include(item) }
     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)
+      # time_to_first_byte aka "server time"
+      # time_to_last_byte aka "network + server time"
+      included = %i[time_to_first_byte time_to_last_byte response_time]
+      included.each { |item| expect(b.performance.summary).to include(item) }
     end
 
-    it 'should return true for chrome supported' do
+    it 'should return true for 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 }
+      b.with_performance { |performance| expect(performance).not_to be_nil }
     end
   end
 end

data/watir-performance.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: watir-performance 0.5.4 ruby lib
+# stub: watir-performance 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "watir-performance".freeze
-  s.version = "0.5.4"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new("~> 2.7".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-07"
-  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.date = "2018-05-08"
+  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 and a compatible browser".freeze
   s.email = ["robert.maccracken@gmail.com".freeze, "tim.koops@gmail.com".freeze]
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".gitlab-ci.yml",
     ".rspec",
     ".travis.yml",
     "Gemfile",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-performance
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Robert MacCracken
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir
@@ -111,7 +111,7 @@ dependencies:
         version: '5.2'
 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
+  when using watir and a compatible browser
 email:
 - robert.maccracken@gmail.com
 - tim.koops@gmail.com
@@ -122,6 +122,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - ".document"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".travis.yml"
 - Gemfile