govuk_frontend_toolkit 5.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10e14060edb1dcd3b797adabfa3408ee1e24b602
-  data.tar.gz: b3a7b2d53b0d3885cd1ece60fdd42061e14b4920
+  metadata.gz: c691fea11a81b6e13b02691132d0ce0c5e844650
+  data.tar.gz: ca6ab6ace0a2813e9426d2744603a5cabf366a8c
 SHA512:
-  metadata.gz: 5cd4d8a1610f9a7d7422da67d6be2f587c9e4c2bb1e342822e4095bf6befb25dbf7765f3bd517f1699d82c6db8d57181b7b8b4ab719af9e6877249ec018db3b1
-  data.tar.gz: b062f6e142d07c95774fef6fe0b259803258de20702e27b419fc711795049d1b426150b946d34aebe43fbf097bfd9cc07652eb7507b817c4914010df2962e80d
+  metadata.gz: 545412034afbd354d886e2d018c35cd6d69226106ac7108e980b8b6aeea46c5fdb7d60760c68b636d107e467a9194b30cc3cc6eecfe4d8041d9ae82693695d0d
+  data.tar.gz: 248e6eee38422db39cb27c6e88becc1c6597721296de86494ee05d71bfef2bcd378d10ccde9388cb4aa9f6dc92c21370b0ca5c23b4a8d04050481c16f087b03c

data/app/assets/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 6.0.0
+
+- Breaking change: configure the GOV.UK Analytics tracker with `govukTrackerUrl` instead of `govukTrackerGifUrl` ([PR #405](https://github.com/alphagov/govuk_frontend_toolkit/pull/405))
+- Fix the sending of the GA Client ID with calls to the GOV.UK Tracker ([PR #404](https://github.com/alphagov/govuk_frontend_toolkit/pull/404))
+- Disable GA ad tracking ([PR #401](https://github.com/alphagov/govuk_frontend_toolkit/pull/401))
+
 # 5.2.0
 
 - Deprecate selection-buttons.js. Add a deprecation warning: Custom radio buttons and checkboxes (released in GOV.UK Elements 3.0.0) no longer require this JavaScript.

data/app/assets/VERSION.txt

@@ -1 +1 @@
-5.2.0
+6.0.0

data/app/assets/javascripts/govuk/analytics/analytics.js

@@ -13,10 +13,10 @@
       delete config.universalId
       this.trackers.push(new GOVUK.GoogleAnalyticsUniversalTracker(universalId, config))
     }
-    if (typeof config.govukTrackerGifUrl !== 'undefined') {
-      var govukTrackerGifUrl = config.govukTrackerGifUrl
-      delete config.govukTrackerGifUrl
-      this.trackers.push(new GOVUK.GOVUKTracker(govukTrackerGifUrl))
+    if (typeof config.govukTrackerUrl !== 'undefined') {
+      var govukTrackerUrl = config.govukTrackerUrl
+      delete config.govukTrackerUrl
+      this.trackers.push(new GOVUK.GOVUKTracker(govukTrackerUrl))
     }
   }
 

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

@@ -15,6 +15,11 @@
       sendToGa('set', 'anonymizeIp', true)
     }
 
+    function disableAdTracking () {
+      // https://support.google.com/analytics/answer/2444872?hl=en
+      sendToGa('set', 'displayFeaturesTask', null)
+    }
+
     // Support legacy cookieDomain param
     if (typeof fieldsObject === 'string') {
       fieldsObject = { cookieDomain: fieldsObject }
@@ -22,6 +27,7 @@
 
     configureProfile()
     anonymizeIp()
+    disableAdTracking()
   }
 
   GoogleAnalyticsUniversalTracker.load = function () {
@@ -135,6 +141,7 @@
     sendToGa(name + '.linker:autoLink', [domain])
 
     sendToGa(name + '.set', 'anonymizeIp', true)
+    sendToGa(name + '.set', 'displayFeaturesTask', null)
     sendToGa(name + '.send', 'pageview')
   }
 

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

@@ -7,11 +7,6 @@
   var GOVUKTracker = function (gifUrl) {
     this.gifUrl = gifUrl
     this.dimensions = []
-    if (global.ga) {
-      global.ga(function (tracker) {
-        this.gaClientId = tracker.get('clientId')
-      }.bind(this))
-    }
   }
 
   GOVUKTracker.load = function () {}
@@ -118,7 +113,14 @@
 
   GOVUKTracker.prototype.sendToTracker = function (type, payload) {
     $(global.document).ready(function () {
-      this.sendData(this.payloadParams(type, payload))
+      if (global.ga) {
+        global.ga(function (tracker) {
+          this.gaClientId = tracker.get('clientId')
+          this.sendData(this.payloadParams(type, payload))
+        }.bind(this))
+      } else {
+        this.sendData(this.payloadParams(type, payload))
+      }
     }.bind(this))
   }
 

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

@@ -29,6 +29,8 @@ describe('GOVUK.Analytics', function () {
 
     it('configures a universal tracker', function () {
       expect(universalSetupArguments[0]).toEqual(['create', 'universal-id', {cookieDomain: '.www.gov.uk', siteSpeedSampleRate: 100}])
+      expect(universalSetupArguments[1]).toEqual(['set', 'anonymizeIp', true])
+      expect(universalSetupArguments[2]).toEqual(['set', 'displayFeaturesTask', null])
     })
   })
 
@@ -69,6 +71,7 @@ describe('GOVUK.Analytics', function () {
       expect(allArgs).toContain(['linker:autoLink', ['www.example.com']])
       expect(allArgs).toContain(['test.linker:autoLink', ['www.example.com']])
       expect(allArgs).toContain(['test.set', 'anonymizeIp', true])
+      expect(allArgs).toContain(['test.set', 'displayFeaturesTask', null])
       expect(allArgs).toContain(['test.send', 'pageview'])
     })
   })

data/app/assets/spec/unit/analytics/govuk-tracker.spec.js

@@ -8,6 +8,14 @@ describe('GOVUK.GOVUKTracker', function () {
 
   var tracker
 
+  function setupFakeGa (clientId) {
+    window.ga = function (cb) {
+      cb({
+        get: function () { return clientId }
+      })
+    }
+  }
+
   beforeEach(function () {
     tracker = new GOVUK.GOVUKTracker('http://www.example.com/a.gif')
   })
@@ -74,11 +82,22 @@ describe('GOVUK.GOVUKTracker', function () {
 
   describe('sendToTracker', function () {
     it('sends when the DOM is complete', function () {
+      setupFakeGa('123456.789012')
+
       spyOn(tracker, 'sendData')
       tracker.sendToTracker('foo')
 
       expect(tracker.sendData).toHaveBeenCalledWith(jasmine.any(Object))
     })
+
+    it('sets the ga Client ID', function () {
+      setupFakeGa('123456.789012')
+
+      spyOn(tracker, 'sendData')
+      tracker.sendToTracker('foo')
+
+      expect(tracker.gaClientId).toEqual('123456.789012')
+    })
   })
 
   describe('tracking', function () {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails