wbench 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a99e98258f2293683471f454c7e0f9e7dbbfc9b
-  data.tar.gz: 78a484762385e2926fa49b47f0143e10bece9fa3
+  metadata.gz: b17e83ece2cbb293993ae57b6ca1c0e2df304853
+  data.tar.gz: 8b54e998322a6ea032b411c2a1bbed65ab5f56f2
 SHA512:
-  metadata.gz: 1da1f3692c3f18b4bb41313db19107c56553dae54c3dc0685d1be3e2f5893f8c52b2e991c0e923da6f8bf1d8caffe40b8354ee1f56f397b946f37316b72b96ea
-  data.tar.gz: 08ae38bf3f64536e2b2abdca96afe27b5516fc5322ab1a13321043db5c1936597563f2a22e0da00cc7867fbed5c7cc9bc13efcb2ed28cf9738a60dfd21580b2e
+  metadata.gz: 2911cefdf138f835c1d46d34d49bf4433f37ad46cf9e5248fba506ea6e9018da9087d5d7d459806c4e4a0d8a0891eb9496cbfce96d3a72ad0a19e2611f871284
+  data.tar.gz: e4239bb7299fc09cba399318c0e414e70d57aeb7add5a687937fb65ceeb99413b9d861dcf37d74eba4f550e55c60ce7b8351959e03b524e1e814d61c5b09fe33

data/README.md

@@ -23,6 +23,18 @@ You can install chromedriver (on OSX) with homebrew:
 $ brew install chromedriver
 ```
 
+If you are not using Homebrew on OSX, download the latest binary version of [chromedriver](http://chromedriver.storage.googleapis.com/index.html).
+Then unpack the ZIP archive and copy the chromedriver binary to the /usr/bin directory:
+```bash
+$ sudo cp /location/of/chromedriver/binary /usr/bin
+```
+Test that chromedriver is working by typing "chromedriver":
+```bash
+$ chromedriver
+Starting ChromeDriver (v2.7.236836) on port 9515
+```
+Note that you will NOT need the chromedriver-utility gem if you install the binary in this manner.
+
 Alternatively you can install firefox and use it with wbench. See [Running other browsers](#running-other-browsers) for more info.
 
 ## Usage
@@ -52,6 +64,17 @@ You can also pass the `-u/--user-agent` option to change the browsers user agent
 $ wbench -u "Mozilla/5.0 (iPhone; U; ..." https://www.desktoppr.co/
 ```
 
+### Color output
+
+By default the output will be in color. Piping the results to another process
+should correctly remove the coloring. If your terminal doesn't output color, or
+you're getting funny symbols in your results then you can remove color from the
+output using the `-c` flag.
+
+```bash
+$ wbench -c https://www.desktoppr.co/
+```
+
 ### Server performance measuring
 
 Server response times will be reported if the application is a ruby/rack application that returns the `X-Runtime` http header. Without that header the server performance will not be able to be measured.
@@ -129,6 +152,20 @@ assets. This means that when the benchmark is run against the authenticated
 page, some assets may be loaded from the cache, and the result may appear
 quicker than an uncahed visit.
 
+
+### Custom event timings
+
+Custom events are available to instrument through wbench. To do so use the native HTML5 function `window.performance.mark` like so:
+
+```javascript
+if(typeof(window.performance) === 'object' && typeof(window.performance.mark) == 'function') {
+  window.performance.mark('my custom event');
+}
+```
+
+You can use the `onload` event handler to call the JavaScript above to instrument when certain elements (images for example) are loaded. Currently this only works in google chrome, so we need to protect against the function not being available.
+
+
 ### Gisting results
 
 You can install the [Github gist gem](https://github.com/defunkt/gist) and pipe in the results of wbench

data/lib/javascripts/wbench.js

@@ -92,5 +92,18 @@ window.WBench = {
 
   currentURL: function() {
     return window.location.href;
+  },
+
+  performanceTimings: function() {
+    resultTimings = window.performance.timing;
+
+    // Use user defined timings that are added via window.performance.mark('event name')
+    if(typeof(window.performance.getEntriesByType) === 'function') {
+      window.performance.getEntriesByType('mark').forEach(function(item) {
+        resultTimings[item.name] = Math.ceil(window.performance.timing.navigationStart + item.startTime);
+      });
+    };
+
+    return resultTimings;
   }
 }

data/lib/wbench/browser.rb

@@ -10,7 +10,13 @@ module WBench
         selenium_options    = { :browser => browser, :http_client => http_client }
 
         if options[:user_agent]
-          add_selenium_args(selenium_options, "--user-agent='#{options[:user_agent]}'")
+          if browser == :firefox
+            profile = Selenium::WebDriver::Firefox::Profile.new
+            profile['general.useragent.override'] = options[:user_agent]
+            selenium_options[:profile] = profile
+          else
+            add_selenium_args(selenium_options, "--user-agent='#{options[:user_agent]}'")
+          end
         end
 
         SeleniumDriver.new(app, selenium_options)

data/lib/wbench/timings/browser.rb

@@ -12,7 +12,7 @@ module WBench
       private
 
       def timing_json
-        @browser.evaluate_script('window.performance.timing')
+        @browser.evaluate_script('WBench.performanceTimings()')
       end
     end
   end

data/lib/wbench/version.rb

@@ -1,3 +1,3 @@
 module WBench
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
 end

data/spec/support/test_sites.rb

@@ -3,9 +3,9 @@
 
 def sites
   [
-    #'https://www.google.com.au/',
-    #'https://www.desktoppr.co/',
-    #'http://www.giftoppr.co/',
-    #'http://au.yahoo.com/'
+    'https://www.google.com.au/',
+    'https://www.desktoppr.co/',
+    'http://www.giftoppr.co/',
+    'http://au.yahoo.com/'
   ]
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: wbench
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mario Visic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-26 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   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'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   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'
 - !ruby/object:Gem::Dependency
   name: colorize
   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'
 - !ruby/object:Gem::Dependency
   name: addressable
   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: WBench is a tool that uses the HTML5 performance timing API to benchmark
@@ -75,9 +75,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rvmrc
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -119,17 +119,17 @@ 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.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Benchmark website loading times