govuk_frontend_toolkit 4.0.1 → 4.1.0

data/app/assets/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 4.1.0
+
+- Add support for sending the `page` option to `GOVUK.analytics.trackEvent` (PR #203)
+
 # 4.0.1
 
 - Fix: stop multiline text from dropping below phase tag.

data/app/assets/VERSION.txt

@@ -1 +1 @@
-4.0.1
+4.1.0

data/app/assets/docs/analytics.md

@@ -90,6 +90,7 @@ Argument | Description
 
 Option | Description
 -------|------------
+`page`  | Useful for sending the URL when `window.location` has been updated using JavaScript since the Analytics tracking object was created
 `label` | Useful for categorising events, eg Javascript error source
 `value` | Values must be non-negative. Useful to pass counts, eg error happened 5 times
 `nonInteraction` | Defaults to false. When set the event will not affect bounce rate
@@ -98,8 +99,9 @@ Option | Description
 // Track a custom event with required category and action fields
 GOVUK.analytics.trackEvent('category', 'action');
 
-// Track a custom event with optional label, value and nonInteraction options
+// Track a custom event with optional page, label, value and nonInteraction options
 GOVUK.analytics.trackEvent('category', 'action', {
+  page: '/path/to/page',
   label: 'label',
   value: 1,
   nonInteraction: true // event will not affect bounce rate

data/app/assets/javascripts/govuk/analytics/google-analytics-universal-tracker.js

@@ -54,6 +54,11 @@
       evt.eventLabel = options.label;
     }
 
+    // Page is optional
+    if (typeof options.page === "string") {
+      evt.page = options.page;
+    }
+
     // Value is optional, but when used must be an
     // integer, otherwise the event will be invalid
     // and not logged

data/app/assets/spec/unit/analytics/GoogleAnalyticsUniversalTrackerSpec.js

@@ -94,6 +94,13 @@ describe("GOVUK.GoogleAnalyticsUniversalTracker", function() {
         }]
       );
     });
+
+    it('sends the page if supplied', function() {
+      universal.trackEvent('category', 'action', {page: '/path/to/page'});
+      expect(window.ga.calls.mostRecent().args).toEqual(
+        ['send', {hitType: 'event', eventCategory: 'category', eventAction: 'action', page: '/path/to/page'}]
+      );
+    });
   });
 
   describe('when social events are tracked', function() {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -286,7 +286,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3399682699568352727
+      hash: 4509289467583034213
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -295,7 +295,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3399682699568352727
+      hash: 4509289467583034213
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23