govuk_frontend_toolkit 4.14.1 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e930f48d96df464b6a83f79a134a2a832dbbf85
-  data.tar.gz: 6912fbfef5c5057925daef6c3f6365ae21aafc5a
+  metadata.gz: 851436b61e519834d96f32d1269b194d2664599c
+  data.tar.gz: bb4bec220d75477490dc8fc10ba7140380e1c34c
 SHA512:
-  metadata.gz: 34cc0e0e7b403de73f533017cac23caa7204fbf1fc327ce085b41da790c2a973ac7321a67251dc95a5895031f2a619800febb93f962fcb9545dc17146c59106d
-  data.tar.gz: 995e4a9864de22fceecad8ba353c205ba85a4c8e853f1f0b934a5b63892295f44dd4fb4cb22107192548adadc0cab27fe774e95d00b0cdd699f3c9f56d83c3a7
+  metadata.gz: 6b6c3638a4df4d76c23d5dffed432c565208ca81664890a6c1dbf2ca5969ae13281e9479c3f1c75484ba71768dbc85eca0a25685ddf1803f2f55613ac415b790
+  data.tar.gz: 2dec81dc8c4d5e1437527eaf201c6f4f34d928f6bde344d709acc8faf2443482a3bab004020beec37c0cee273fc6bde6deee6ae9ec5e561cf01a1bebaafeb76a

data/app/assets/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 4.15.0
+
+- Add support for Google Analytics fieldsObject ([PR #298](https://github.com/alphagov/govuk_frontend_toolkit/pull/298))
+- anchor-buttons.js: normalise keyboard behaviour between buttons and links with a button role ([PR #297](https://github.com/alphagov/govuk_frontend_toolkit/pull/297))
+
 # 4.14.1
 
 - Fix tabular number sizing in Firefox ([PR #301](https://github.com/alphagov/govuk_frontend_toolkit/pull/301))

data/app/assets/VERSION.txt

@@ -1 +1 @@
-4.14.1
+4.15.0

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

@@ -9,7 +9,9 @@
   var Analytics = function(config) {
     this.trackers = [];
     if (typeof config.universalId != 'undefined') {
-      this.trackers.push(new GOVUK.GoogleAnalyticsUniversalTracker(config.universalId, config.cookieDomain));
+      var universalId = config.universalId;
+      delete config.universalId;
+      this.trackers.push(new GOVUK.GoogleAnalyticsUniversalTracker(universalId, config));
     }
   };
 

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

@@ -3,25 +3,32 @@
 
   var GOVUK = global.GOVUK || {};
 
-  var GoogleAnalyticsUniversalTracker = function(id, cookieDomain) {
-    configureProfile(id, cookieDomain);
-    anonymizeIp();
+  var GoogleAnalyticsUniversalTracker = function(trackingId, fieldsObject) {
 
-    function configureProfile(id, cookieDomain) {
-      sendToGa('create', id, {'cookieDomain': cookieDomain});
+    function configureProfile() {
+      // https://developers.google.com/analytics/devguides/collection/analyticsjs/command-queue-reference#create
+      sendToGa('create', trackingId, fieldsObject);
     }
 
     function anonymizeIp() {
       // https://developers.google.com/analytics/devguides/collection/analyticsjs/advanced#anonymizeip
       sendToGa('set', 'anonymizeIp', true);
     }
+
+    // Support legacy cookieDomain param
+    if (typeof fieldsObject === 'string') {
+      fieldsObject = { cookieDomain: fieldsObject };
+    }
+
+    configureProfile();
+    anonymizeIp();
   };
 
   GoogleAnalyticsUniversalTracker.load = function() {
     (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
         (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
                              m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-    })(global,document,'script','//www.google-analytics.com/analytics.js','ga');
+    })(global,document,'script','https://www.google-analytics.com/analytics.js','ga');
   };
 
   // https://developers.google.com/analytics/devguides/collection/analyticsjs/pages

data/app/assets/javascripts/govuk/anchor-buttons.js

@@ -0,0 +1,61 @@
+// javascript 'shim' to trigger the click event of element(s)
+// when the space key is pressed.
+//
+// usage instructions:
+// GOVUK.anchorButtons.init();
+//
+// If you want to customise the shim you can pass in a custom configuration
+// object with your own selector for the target elements and addional keyup
+// codes if there becomes a need to do so. For example:
+// GOVUK.anchorButtons.init({ selector: '[role="button"]' });
+(function(global) {
+  "use strict";
+
+  var $ = global.jQuery;
+  var GOVUK = global.GOVUK || {};
+
+  GOVUK.anchorButtons = {
+
+    // default configuration that can be overridden by passing object as second parameter to module
+    config: {
+      // the target element(s) to attach the shim event to
+      selector: 'a[role="button"]',
+      // array of keys to match against upon the keyup event
+      keycodes: [
+        32 // spacekey
+      ],
+    },
+
+    // event behaviour (not a typical anonymous function for resuse if needed)
+    triggerClickOnTarget: function triggerClickOnTarget(event) {
+      var code = event.charCode || event.keyCode;
+      // if the keyCode/charCode from this event is in the keycodes array then
+      if ($.inArray(code, this.config.keycodes) !== -1) {
+        event.preventDefault();
+        // trigger the target's click event
+        $(event.target).trigger("click");
+      }
+    },
+
+    // By default this will find all anchors with role attribute set to
+    // 'button' and will trigger their click event when the space key (32) is pressed.
+    // @method init
+    // @param  {Object}   customConfig                object to override default configuration
+    //         {String}   customConfig.selector       a selector for the elements to be 'clicked'
+    //         {Array}    customConfig.keycodes       an array of javascript keycode values to match against that when pressed will trigger the click
+    init: function init(customConfig) {
+      // extend the default config with any custom attributes passed in
+      this.config = $.extend(this.config, customConfig);
+      // if we have found elements then:
+      if($(this.config.selector).length > 0) {
+        // listen to 'document' for keyup event on the elements and fire the triggerClickOnTarget
+        $(document).on('keyup', this.config.selector, this.triggerClickOnTarget.bind(this));
+      }
+    }
+
+  };
+
+  // hand back to global
+  global.GOVUK = GOVUK;
+
+})(window);

data/app/assets/javascripts/govuk/selection-buttons.js

@@ -5,7 +5,6 @@
   var GOVUK = global.GOVUK || {};
 
   var SelectionButtons = function (elmsOrSelector, opts) {
-    var $elms;
 
     this.selectedClass = 'selected';
     this.focusedClass = 'focused';
@@ -15,7 +14,6 @@
       }.bind(this));
     }
     if (typeof elmsOrSelector === 'string') {
-      $elms = $(elmsOrSelector);
       this.selector = elmsOrSelector;
       this.setInitialState($(this.selector));
     } else if (elmsOrSelector !== undefined) {

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

@@ -1,21 +1,29 @@
 describe("GOVUK.Analytics", function() {
+  function addGoogleAnalyticsSpy() {
+    window.ga = function() {};
+    spyOn(window, 'ga');
+  }
+
   var analytics;
+  var universalSetupArguments;
 
   beforeEach(function() {
-    window.ga = function() {};
-    spyOn(window, 'ga');
-    this.config = {
-      universalId: 'universal-id',
-      cookieDomain: '.www.gov.uk'
-    };
+    addGoogleAnalyticsSpy();
 
-    analytics = new GOVUK.Analytics(this.config);
+    analytics = new GOVUK.Analytics({
+      universalId: 'universal-id',
+      cookieDomain: '.www.gov.uk',
+      siteSpeedSampleRate: 100
+    });
   });
 
   describe('when created', function() {
+    beforeEach(function() {
+      universalSetupArguments = window.ga.calls.allArgs();
+    });
+
     it('configures a universal tracker', function () {
-      var universalSetupArguments = window.ga.calls.allArgs();
-      expect(universalSetupArguments[0]).toEqual(['create', 'universal-id', {'cookieDomain': '.www.gov.uk'}]);
+      expect(universalSetupArguments[0]).toEqual(['create', 'universal-id', {cookieDomain: '.www.gov.uk', siteSpeedSampleRate: 100}]);
     });
   });
 

data/app/assets/spec/unit/analytics/google-analytics-universal-tracker.spec.js

@@ -1,17 +1,26 @@
 describe("GOVUK.GoogleAnalyticsUniversalTracker", function() {
+  function addGoogleAnalyticsSpy() {
+    window.ga = function() {};
+    spyOn(window, 'ga');
+  }
+
   var universal;
+  var setupArguments;
 
   beforeEach(function() {
-    window.ga = function() {};
-    spyOn(window, 'ga');
-    universal = new GOVUK.GoogleAnalyticsUniversalTracker('id', 'cookie-domain.com');
+    addGoogleAnalyticsSpy();
+
+    universal = new GOVUK.GoogleAnalyticsUniversalTracker('id', {
+      cookieDomain: 'cookie-domain.com',
+      siteSpeedSampleRate: 100
+    });
   });
 
   it('can load the libraries needed to run universal Google Analytics', function() {
     delete window.ga;
-    $('[src="//www.google-analytics.com/analytics.js"]').remove();
+    $('[src="https://www.google-analytics.com/analytics.js"]').remove();
     GOVUK.GoogleAnalyticsUniversalTracker.load();
-    expect($('script[async][src="//www.google-analytics.com/analytics.js"]').length).toBe(1);
+    expect($('script[async][src="https://www.google-analytics.com/analytics.js"]').length).toBe(1);
     expect(typeof window.ga).toBe('function');
 
     window.ga('send message');
@@ -19,14 +28,12 @@ describe("GOVUK.GoogleAnalyticsUniversalTracker", function() {
   });
 
   describe('when created', function() {
-    var setupArguments;
-
     beforeEach(function() {
       setupArguments = window.ga.calls.allArgs();
     });
 
-    it('configures a Google tracker using the provided profile ID and cookie domain', function() {
-      expect(setupArguments[0]).toEqual(['create', 'id', {'cookieDomain': 'cookie-domain.com'}]);
+    it('configures a Google tracker using the provided profile ID and config', function() {
+      expect(setupArguments[0]).toEqual(['create', 'id', {cookieDomain: 'cookie-domain.com', siteSpeedSampleRate: 100}]);
     });
 
     it('anonymises the IP', function() {
@@ -34,6 +41,19 @@ describe("GOVUK.GoogleAnalyticsUniversalTracker", function() {
     });
   });
 
+  describe('when created (with legacy non-object syntax)', function() {
+    beforeEach(function() {
+      addGoogleAnalyticsSpy();
+
+      universal = new GOVUK.GoogleAnalyticsUniversalTracker('id', 'cookie-domain.com');
+      setupArguments = window.ga.calls.allArgs();
+    });
+
+    it('configures a Google tracker using the provided profile ID and cookie domain', function() {
+      expect(setupArguments[0]).toEqual(['create', 'id', {cookieDomain: 'cookie-domain.com'}]);
+    });
+  });
+
   describe('when pageviews are tracked', function() {
     it('sends them to Google Analytics', function() {
       universal.trackPageview();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 4.14.1
+  version: 4.15.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -229,6 +229,7 @@ files:
 - app/assets/javascripts/govuk/analytics/google-analytics-universal-tracker.js
 - app/assets/javascripts/govuk/analytics/mailto-link-tracker.js
 - app/assets/javascripts/govuk/analytics/print-intent.js
+- app/assets/javascripts/govuk/anchor-buttons.js
 - app/assets/javascripts/govuk/modules.js
 - app/assets/javascripts/govuk/modules/auto-track-event.js
 - app/assets/javascripts/govuk/multivariate-test.js