govuk_frontend_toolkit 5.1.2 → 5.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 177c21aaa74abca4dfa655928bb2f6742e1e046f
-  data.tar.gz: 2743d40802f0408afcd2618e227f7f22432d8ec2
+  metadata.gz: a82ba1d90400414889eccb25aaa31d8bb7a501b1
+  data.tar.gz: ba6c1ef52e25342be951a80f9399fa0f2e1de113
 SHA512:
-  metadata.gz: 2de75c8841daa62163dc4d7ec1cfa9c7390b897264ee35231bb594db1350b72690d8a1a1093746eb79d2ca33dd8e32d1c14f704d76142d4bc2e6a8f6f6a8b5b6
-  data.tar.gz: 00e6cb4ccb8133885947b119987287667341d0d3ec0bf10d21754cb14ee6d2af79d551fbc0220f8c6e645e93e6b186b2971a08387e23a0732722f7df8d9d3f3a
+  metadata.gz: 96eb1d31eed114633be86dbed4b4882f64acf47f5694e861e7189b6f5a29656b3dcfe5ecdd6d035e9c6377d30f13d160be7c434f733dff65fff6cce383a11446
+  data.tar.gz: 5451ede4e5a42621ccb09482a817f4f3b033f85e860223b867b33870aac6a7e63426f927f42cb357e6e4c0d45a19355007d0e999600454abc1750322e2b56924

data/app/assets/.travis.yml

@@ -5,18 +5,11 @@ node_js:
 before_install:
   # Node project, so Ruby dependencies must be installed manually (see `govuk-lint`)
   - bundle install
-  - git config --global user.name "Travis CI"
-  - git config --global user.email "travis@travis-ci.org"
-  - git remote add origin_ssh git@github.com:alphagov/govuk_frontend_toolkit.git
-  # Encrypted SSH config used to `push.sh` to Github (See `.travis/README.md`)
-  - 'if [ "$TRAVIS_PULL_REQUEST_BRANCH" = "master" ]; then openssl aes-256-cbc -K $encrypted_909ac1036a94_key -iv $encrypted_909ac1036a94_iv -in .travis/govuk_frontend_toolkit_push.enc -out ~/.ssh/id_rsa -d && chmod 600 ~/.ssh/id_rsa; fi'
-script:
-  - npm test
 before_deploy:
   - test $TRAVIS_TEST_RESULT = 0
 deploy:
   - provider: script
-    script: './push.sh'
+    script: './create-release.sh'
     on:
       branch: master
   - provider: script

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

@@ -6,7 +6,9 @@ The public key is a deploy key which has been added to the GitHub repo for push
 
 The private key is encrypted using `travis encrypt-file` and then committed to this repo.
 
-The decrypt commands are in `.travis.yml`.
+The decrypt commands are in `.travis.yml`. We only decrypt these files on the master
+branch because people who have forked the repo don't have access to the
+`$encrypted` environment variables.
 
 ## Trigger script
 

data/app/assets/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 5.1.3
+
+- Add an experimental GOV.UK analytics tracker. Given the URL to a single pixel GIF, it will encode analytics data as query string parameters on the call to the GIF ([PR #387](https://github.com/alphagov/govuk_frontend_toolkit/pull/387))
+
 # 5.1.2
 
 - Update show-hide-content.js to work with new `.multiple-choice` custom radio buttons and checkboxes, released in GOV.UK elements 3.0.0 ([PR #390](https://github.com/alphagov/govuk_frontend_toolkit/pull/390))

data/app/assets/Gruntfile.js

@@ -32,6 +32,7 @@ module.exports = function (grunt) {
         src: [
           'node_modules/jquery/dist/jquery.js',
           'javascripts/govuk/analytics/google-analytics-universal-tracker.js',
+          'javascripts/govuk/analytics/govuk-tracker.js',
           'javascripts/govuk/analytics/analytics.js',
           'javascripts/**/*.js'
         ],

data/app/assets/VERSION.txt

@@ -1 +1 @@
-5.1.2
+5.1.3

data/app/assets/create-release.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+set -e
+
+REPO_PATH="alphagov/govuk_frontend_toolkit"
+
+echo "Add config for alphagov/$REPO_PATH"
+
+git config --global user.name "Travis CI"
+git config --global user.email "travis@travis-ci.org"
+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
+openssl aes-256-cbc -K $encrypted_909ac1036a94_key -iv $encrypted_909ac1036a94_iv -in .travis/govuk_frontend_toolkit_push.enc -out ~/.ssh/id_rsa -d
+chmod 600 ~/.ssh/id_rsa
+
+echo "Check to see if the version file has been updated"
+
+# get the version from the version file
+VERSION_TAG="v`cat VERSION.txt`"
+
+# Create a new tag - if the version file has been updated and a tag for that
+# version doesn't already exist
+
+# check to make sure the tag doesn't already exist
+if ! git rev-parse $VERSION_TAG >/dev/null 2>&1; then
+  echo "Creating new tag: $VERSION_TAG"
+
+  # Create a new tag and push to Github
+  git tag $VERSION_TAG
+  git push origin_ssh $VERSION_TAG
+
+  # Alias branch for the most recently released tag, for easier diffing
+  # Force push local `master` branch to the `latest-release` branch on Github
+  git push --force origin_ssh master:latest-release
+  echo "Pushed latest-release branch to GitHub"
+else
+  echo "Not creating a new tag, or updating the latest-release branch as the tag already exists..."
+fi

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

@@ -13,6 +13,11 @@
       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))
+    }
   }
 
   Analytics.prototype.sendToTrackers = function (method, args) {
@@ -28,6 +33,7 @@
 
   Analytics.load = function () {
     GOVUK.GoogleAnalyticsUniversalTracker.load()
+    GOVUK.GOVUKTracker.load()
   }
 
   Analytics.prototype.trackPageview = function (path, title, options) {

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

@@ -0,0 +1,128 @@
+;(function (global) {
+  'use strict'
+
+  var $ = global.jQuery
+  var GOVUK = global.GOVUK || {}
+
+  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 () {}
+
+  GOVUKTracker.prototype.trackPageview = function (path, title, options) {
+    var pageviewObject
+
+    if (typeof path === 'string') {
+      pageviewObject = { page: path }
+    }
+
+    if (typeof title === 'string') {
+      pageviewObject = pageviewObject || {}
+      pageviewObject.title = title
+    }
+
+    // Set an options object for the pageview (e.g. transport, sessionControl)
+    // https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#transport
+    if (typeof options === 'object') {
+      pageviewObject = $.extend(pageviewObject || {}, options)
+    }
+
+    if (!$.isEmptyObject(pageviewObject)) {
+      this.sendToTracker('pageview', pageviewObject)
+    } else {
+      this.sendToTracker('pageview')
+    }
+  }
+
+  // https://developers.google.com/analytics/devguides/collection/analyticsjs/events
+  GOVUKTracker.prototype.trackEvent = function (category, action, options) {
+    options = options || {}
+    var evt = {
+      eventCategory: category,
+      eventAction: action
+    }
+
+    if (options.label) {
+      evt.eventLabel = options.label
+      delete options.label
+    }
+
+    if (options.value) {
+      evt.eventValue = options.value.toString()
+      delete options.value
+    }
+
+    if (typeof options === 'object') {
+      $.extend(evt, options)
+    }
+
+    this.sendToTracker('event', evt)
+  }
+
+  GOVUKTracker.prototype.trackSocial = function (network, action, target) {
+    this.sendToTracker('social', {
+      'socialNetwork': network,
+      'socialAction': action,
+      'socialTarget': target
+    })
+  }
+
+  GOVUKTracker.prototype.addLinkedTrackerDomain = function () { /* noop */ }
+
+  GOVUKTracker.prototype.setDimension = function (index, value) {
+    this.dimensions['dimension' + index] = value
+  }
+
+  GOVUKTracker.prototype.payloadParams = function (type, payload) {
+    var data = $.extend({},
+      payload,
+      this.dimensions,
+      {
+        eventType: type,
+        referrer: global.document.referrer,
+        gaClientId: this.gaClientId,
+        windowWidth: global.innerWidth,
+        windowHeight: global.innerHeight,
+        screenWidth: global.screen.width,
+        screenHeight: global.screen.height,
+        colorDepth: global.screen.colorDepth
+      }
+    )
+
+    if (global.performance) {
+      data.navigationType = global.performance.navigation.type.toString()
+      data.redirectCount = global.performance.navigation.redirectCount.toString()
+
+      for (var k in global.performance.timing) {
+        var v = global.performance.timing[k]
+        if (typeof v === 'string' || typeof v === 'number') {
+          data['timing_' + k] = v.toString()
+        }
+      }
+    }
+
+    return data
+  }
+
+  GOVUKTracker.prototype.sendData = function (params) {
+    var url = this.gifUrl + '?' + $.param(params)
+    $.get(url)
+  }
+
+  GOVUKTracker.prototype.sendToTracker = function (type, payload) {
+    $(global.document).ready(function () {
+      this.sendData(this.payloadParams(type, payload))
+    }.bind(this))
+  }
+
+  GOVUK.GOVUKTracker = GOVUKTracker
+
+  global.GOVUK = GOVUK
+})(window)

data/app/assets/spec/manifest.js

@@ -12,6 +12,7 @@ var manifest = {
     '../../javascripts/govuk/stop-scrolling-at-footer.js',
     '../../javascripts/govuk/selection-buttons.js',
     '../../javascripts/govuk/analytics/google-analytics-universal-tracker.js',
+    '../../javascripts/govuk/analytics/govuk-tracker.js',
     '../../javascripts/govuk/analytics/analytics.js',
     '../../javascripts/govuk/analytics/error-tracking.js',
     '../../javascripts/govuk/analytics/external-link-tracker.js',
@@ -28,6 +29,7 @@ var manifest = {
     '../unit/stick-at-top-when-scrolling.spec.js',
     '../unit/selection-button.spec.js',
     '../unit/analytics/google-analytics-universal-tracker.spec.js',
+    '../unit/analytics/govuk-tracker.spec.js',
     '../unit/analytics/analytics.spec.js',
     '../unit/analytics/error-tracking.spec.js',
     '../unit/analytics/external-link-tracker.spec.js',

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

@@ -0,0 +1,152 @@
+/* global describe it expect beforeEach spyOn jasmine */
+
+var $ = window.jQuery
+
+describe('GOVUK.GOVUKTracker', function () {
+  'use strict'
+  var GOVUK = window.GOVUK
+
+  var tracker
+
+  beforeEach(function () {
+    tracker = new GOVUK.GOVUKTracker('http://www.example.com/a.gif')
+  })
+
+  describe('sendData', function () {
+    it('sends the data using AJAX', function () {
+      spyOn($, 'get')
+
+      tracker.sendData({foo: 'bar'})
+      expect($.get).toHaveBeenCalledWith('http://www.example.com/a.gif?foo=bar')
+    })
+  })
+
+  describe('payloadParams', function () {
+    it('adds the event type', function () {
+      var params = tracker.payloadParams('foo', {bar: 'qux'})
+
+      expect(params.eventType).toEqual('foo')
+      expect(params.bar).toEqual('qux')
+    })
+
+    it('adds the GA Client ID', function () {
+      tracker.gaClientId = '123456.789012'
+      var params = tracker.payloadParams('foo')
+
+      expect(params.gaClientId).toEqual('123456.789012')
+    })
+
+    it('adds the referrer', function () {
+      var params = tracker.payloadParams('foo')
+
+      // Can't stub window.referrer so just test that we got a string, not undefined
+      expect(typeof params.referrer).toEqual('string')
+    })
+
+    it('adds performance data', function () {
+      var params = tracker.payloadParams('foo')
+
+      expect(params.navigationType).toEqual('0')
+      expect(params.redirectCount).toEqual('0')
+
+      expect(params.timing_domComplete).toEqual(window.performance.timing.domComplete.toString())
+    })
+
+    it('adds custom dimensions', function () {
+      tracker.setDimension(1, 'foo')
+      tracker.setDimension(10, 'bar')
+      var params = tracker.payloadParams('foo')
+
+      expect(params.dimension1).toEqual('foo')
+      expect(params.dimension10).toEqual('bar')
+    })
+
+    it('adds screen and window measurements', function () {
+      var params = tracker.payloadParams('foo')
+
+      expect(params.screenWidth).toEqual(window.screen.width)
+      expect(params.screenHeight).toEqual(window.screen.height)
+      expect(params.windowWidth).toEqual(window.innerWidth)
+      expect(params.windowHeight).toEqual(window.innerHeight)
+      expect(params.colorDepth).toEqual(window.screen.colorDepth)
+    })
+  })
+
+  describe('sendToTracker', function () {
+    it('sends when the DOM is complete', function () {
+      spyOn(tracker, 'sendData')
+      tracker.sendToTracker('foo')
+
+      expect(tracker.sendData).toHaveBeenCalledWith(jasmine.any(Object))
+    })
+  })
+
+  describe('tracking', function () {
+    beforeEach(function () {
+      spyOn(tracker, 'sendToTracker')
+    })
+
+    describe('when pageviews are tracked', function () {
+      it('sends them to the tracker', function () {
+        tracker.trackPageview()
+        expect(tracker.sendToTracker.calls.mostRecent().args).toEqual(['pageview'])
+      })
+    })
+
+    describe('when events are tracked', function () {
+      it('sends them to the tracker', function () {
+        tracker.trackEvent('category', 'action', {label: 'label'})
+        expect(tracker.sendToTracker.calls.mostRecent().args).toEqual(
+          ['event', {eventCategory: 'category', eventAction: 'action', eventLabel: 'label'}]
+        )
+      })
+
+      it('tracks custom dimensions', function () {
+        tracker.trackEvent('category', 'action', {dimension29: 'Home'})
+        expect(tracker.sendToTracker.calls.mostRecent().args).toEqual(
+          ['event', {eventCategory: 'category', eventAction: 'action', dimension29: 'Home'}]
+        )
+      })
+
+      it('the label is optional', function () {
+        tracker.trackEvent('category', 'action')
+        expect(tracker.sendToTracker.calls.mostRecent().args).toEqual(
+          ['event', {eventCategory: 'category', eventAction: 'action'}]
+        )
+      })
+
+      it('sends the page if supplied', function () {
+        tracker.trackEvent('category', 'action', {page: '/path/to/page'})
+        expect(tracker.sendToTracker.calls.mostRecent().args).toEqual(
+          ['event', {eventCategory: 'category', eventAction: 'action', page: '/path/to/page'}]
+        )
+      })
+
+      it('tracks multiple events', function () {
+        tracker.trackEvent('category', 'action', {label: 'foo'})
+        tracker.trackEvent('category', 'action', {label: 'bar'})
+
+        expect(tracker.sendToTracker).toHaveBeenCalledWith(
+          'event', {eventCategory: 'category', eventAction: 'action', eventLabel: 'foo'}
+        )
+        expect(tracker.sendToTracker).toHaveBeenCalledWith(
+          'event', {eventCategory: 'category', eventAction: 'action', eventLabel: 'bar'}
+        )
+      })
+    })
+
+    describe('when social events are tracked', function () {
+      it('sends them to Google Analytics', function () {
+        tracker.trackSocial('network', 'action', 'target')
+        expect(tracker.sendToTracker.calls.mostRecent().args).toEqual([
+          'social',
+          {
+            'socialNetwork': 'network',
+            'socialAction': 'action',
+            'socialTarget': 'target'
+          }
+        ])
+      })
+    })
+  })
+})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.1.3
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,6 +84,7 @@ files:
 - app/assets/LICENCE
 - app/assets/README.md
 - app/assets/VERSION.txt
+- app/assets/create-release.sh
 - app/assets/docs/analytics.md
 - app/assets/docs/functions.md
 - app/assets/docs/javascript.md
@@ -221,6 +222,7 @@ files:
 - app/assets/javascripts/govuk/analytics/error-tracking.js
 - app/assets/javascripts/govuk/analytics/external-link-tracker.js
 - app/assets/javascripts/govuk/analytics/google-analytics-universal-tracker.js
+- app/assets/javascripts/govuk/analytics/govuk-tracker.js
 - app/assets/javascripts/govuk/analytics/mailto-link-tracker.js
 - app/assets/javascripts/govuk/analytics/print-intent.js
 - app/assets/javascripts/govuk/modules.js
@@ -237,7 +239,6 @@ files:
 - app/assets/javascripts/vendor/jquery/jquery.player.min.js
 - app/assets/javascripts/vendor/polyfills/bind.js
 - app/assets/package.json
-- app/assets/push.sh
 - app/assets/spec/manifest.js
 - app/assets/spec/stylesheets/_colour_contrast_spec.scss
 - app/assets/spec/support/LocalTestRunner.html
@@ -249,6 +250,7 @@ files:
 - app/assets/spec/unit/analytics/error-tracking.spec.js
 - app/assets/spec/unit/analytics/external-link-tracker.spec.js
 - app/assets/spec/unit/analytics/google-analytics-universal-tracker.spec.js
+- app/assets/spec/unit/analytics/govuk-tracker.spec.js
 - app/assets/spec/unit/analytics/mailto-link-tracker.spec.js
 - app/assets/spec/unit/modules.spec.js
 - app/assets/spec/unit/modules/auto-track-event.spec.js

data/app/assets/push.sh

@@ -1,23 +0,0 @@
-#!/bin/bash
-set -e
-
-# Create a new tag if the version file has been updated and a tag for that
-# version doesn't already exist
-
-# Are we on master branch, we shouldn't push tags for version bump branches
-MASTER_SHA=`git rev-parse origin/master`
-HEAD_SHA=`git rev-parse HEAD`
-if [ "$MASTER_SHA" == "$HEAD_SHA" ]; then
-  # get the version from the version file
-  VERSION_TAG="v`cat VERSION.txt`"
-
-  # check to make sure the tag doesn't already exist
-  if ! git rev-parse $VERSION_TAG >/dev/null 2>&1; then
-    echo "Creating new tag: $VERSION_TAG"
-    git tag $VERSION_TAG
-    git push origin_ssh $VERSION_TAG
-
-    # Alias branch for the most recently released tag, for easier diffing
-    git push -f origin_ssh master:latest-release
-  fi
-fi