govuk_frontend_toolkit 7.1.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a06217abb14b1587a98e4ad17c9e10f07c426ce1
-  data.tar.gz: 32af41483145c3e4206b919f2b51013ea1bbbe31
+SHA256:
+  metadata.gz: 538b9de6aaf9bd4fa8ec41041f55e19fc38bc25716f2684efde95b3eb5a0e3b9
+  data.tar.gz: 48c37a0f38db00cef1d3472610d5890bc0f7c70938d8b84f9adb01e6ee633ee0
 SHA512:
-  metadata.gz: 81823c3100252f3e39a31438f012def0602ae917b11e330978210b5ea433378b72c363d76c080bf54f99ca6a0ce6790ae83c01a11c38ad0588b333fea8abc5d0
-  data.tar.gz: cc75f42603dcf4d59320f5e5de93c80ed9db62b304a725f9d7c82fecd03c2c8c172b59f73d4f84b90911c7732edb7d5dc49af7526f9b292ba3fee88643b4833b
+  metadata.gz: a4219bbd88e18c1bd0815f4bb89c38e01723ca3887c6ea1016673f69c3eded8818254053992659f0a0d5ad86825aedbeee190acb901c2a487b5cf9a78608a99a
+  data.tar.gz: 0d6bbce22e7e53064c9d01762f725958827bd68a2fec32c223aefb3d80d32c0fe596b4991e658be4f1861cb1a60e6351dedae60d3b075456719a5de622545d6e

data/.travis.yml

@@ -6,8 +6,8 @@ branches:
 before_install:
   - openssl aes-256-cbc -K $encrypted_839034082a06_key -iv $encrypted_839034082a06_iv -in .travis/govuk_frontend_toolkit_gem_push.enc -out ~/.ssh/id_rsa -d
   - chmod 600 ~/.ssh/id_rsa
-  - git config --global user.name "GOV.UK Patterns & Tools CI User"
-  - git config --global user.email "patterns-and-tools-github-user@digital.cabinet-office.gov.uk"
+  - git config --global user.name "GOV.UK Design System CI"
+  - git config --global user.email "design-system-pipeline@digital.cabinet-office.gov.uk"
   - git remote add origin_ssh git@github.com:alphagov/govuk_frontend_toolkit_gem.git
 install:
   - echo "No dependencies to install"

data/app/assets/.travis/README.md

@@ -20,4 +20,4 @@ and RubyGems.
 
 The [Travis settings](https://travis-ci.org/alphagov/govuk_frontend_toolkit/settings)
 contains a Travis token that belongs to
-[@govuk-patterns-and-tools-ci](https://github.com/govuk-patterns-and-tools-ci).
+[@govuk-design-system-ci](https://github.com/govuk-design-system-ci).

data/app/assets/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 7.2.0
+
+- Add custom dimension on TrackEvent to duplicate the url information that we normally send on a the `event action`. This will be used to join up with a scheduled custom upload called "External Link Status". We can only join uploads on custom dimensions, not on `event actions`, where we normally add the url info. ([PR #436](alphagov/govuk_frontend_toolkit#436) and [PR #439](alphagov/govuk_frontend_toolkit#439))
+
 # 7.1.0
 
 - Promote the details polyfill to Frontend Toolkit from GOV.UK Elements ([PR #426](https://github.com/alphagov/govuk_frontend_toolkit/pull/426)).

data/app/assets/VERSION.txt

@@ -1 +1 @@
-7.1.0
+7.2.0

data/app/assets/create-release.sh

@@ -5,8 +5,8 @@ REPO_PATH="alphagov/govuk_frontend_toolkit"
 
 echo "Add config for alphagov/$REPO_PATH"
 
-git config --global user.name "GOV.UK Patterns & Tools CI User"
-git config --global user.email "patterns-and-tools-github-user@digital.cabinet-office.gov.uk"
+git config --global user.name "GOV.UK Design System CI"
+git config --global user.email "design-system-pipeline@digital.cabinet-office.gov.uk"
 git remote add origin_ssh git@github.com:$REPO_PATH.git
 
 # This openssl command was generated automatically by `travis encrypt-file`, see `.travis/README.md` for more details

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

@@ -5,7 +5,9 @@
   var GOVUK = global.GOVUK || {}
 
   GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}
-  GOVUK.analyticsPlugins.externalLinkTracker = function () {
+  GOVUK.analyticsPlugins.externalLinkTracker = function (options) {
+    options = options || {}
+    var externalLinkUploadCustomDimension = options.externalLinkUploadCustomDimension
     var currentHost = GOVUK.analyticsPlugins.externalLinkTracker.getHostname()
     var externalLinkSelector = 'a[href^="http"]:not(a[href*="' + currentHost + '"])'
 
@@ -21,6 +23,17 @@
         options.label = linkText
       }
 
+      if (externalLinkUploadCustomDimension !== undefined) {
+        // This custom dimension will be used to duplicate the url information
+        // that we normally send in an "event action". This will be used to join
+        // up with a scheduled custom upload called "External Link Status".
+        // We can only join uploads on custom dimensions, not on `event actions`
+        // where we normally add the url info.
+        var externalLinkToJoinUploadOn = href
+
+        GOVUK.analytics.setDimension(externalLinkUploadCustomDimension, externalLinkToJoinUploadOn)
+      }
+
       GOVUK.analytics.trackEvent('External Link Clicked', href, options)
     }
 

data/app/assets/spec/unit/analytics/external-link-tracker.spec.js

@@ -24,10 +24,12 @@ describe('GOVUK.analyticsPlugins.externalLinkTracker', function () {
 
     $('html').on('click', function (evt) { evt.preventDefault() })
     $('body').append($links)
-    GOVUK.analytics = {trackEvent: function () {}}
+    GOVUK.analytics = {
+      trackEvent: function () {},
+      setDimension: function () {}
+    }
 
     spyOn(GOVUK.analyticsPlugins.externalLinkTracker, 'getHostname').and.returnValue('fake-hostname.com')
-    GOVUK.analyticsPlugins.externalLinkTracker()
   })
 
   afterEach(function () {
@@ -38,6 +40,8 @@ describe('GOVUK.analyticsPlugins.externalLinkTracker', function () {
   })
 
   it('listens to click events on only external links', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
     spyOn(GOVUK.analytics, 'trackEvent')
 
     $('.external-links a').each(function () {
@@ -54,6 +58,8 @@ describe('GOVUK.analyticsPlugins.externalLinkTracker', function () {
   })
 
   it('listens to click events on elements within external links', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
     spyOn(GOVUK.analytics, 'trackEvent')
 
     $('.external-links a img').trigger('click')
@@ -62,6 +68,8 @@ describe('GOVUK.analyticsPlugins.externalLinkTracker', function () {
   })
 
   it('tracks an external link\'s href and link text', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
     spyOn(GOVUK.analytics, 'trackEvent')
     $('.external-links a').trigger('click')
 
@@ -74,4 +82,28 @@ describe('GOVUK.analyticsPlugins.externalLinkTracker', function () {
     expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
       'External Link Clicked', 'https://www.nationalarchives.gov.uk/one.pdf', {transport: 'beacon', label: 'National Archives PDF'})
   })
+
+  it('duplicates the url info in a custom dimension to be used to join with a Google Analytics upload', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
+    spyOn(GOVUK.analytics, 'setDimension')
+    spyOn(GOVUK.analytics, 'trackEvent')
+    $('.external-links a').trigger('click')
+
+    expect(GOVUK.analytics.setDimension).toHaveBeenCalledWith(36, 'http://www.nationalarchives.gov.uk')
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'http://www.nationalarchives.gov.uk', {transport: 'beacon', label: 'National Archives'})
+  })
+
+  it('does not duplicate the url info if a custom dimension is not provided', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker()
+
+    spyOn(GOVUK.analytics, 'setDimension')
+    spyOn(GOVUK.analytics, 'trackEvent')
+    $('.external-links a').trigger('click')
+
+    expect(GOVUK.analytics.setDimension).not.toHaveBeenCalled()
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'http://www.nationalarchives.gov.uk', {transport: 'beacon', label: 'National Archives'})
+  })
 })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -305,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Tools for building frontend applications