govuk_frontend_toolkit 4.6.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3779c00293b0da0da9ee29c55858b374ad0ef687
-  data.tar.gz: 7056419a578825e7a121e77aa3e5d452e17c86f9
+  metadata.gz: eaa5f7117e30f5312a36798eb20156bfe780d2a9
+  data.tar.gz: 1325ad166e0234a847bde510e26f8f0eb69fc774
 SHA512:
-  metadata.gz: 725c9056c9c9df4776ba0739ac759a3f8c2b718b95692e5feea94e81f7dbd54db9c6af05f0820ea29d0a8e30a984f5e33cb9fecd5be4890c911242244c901ab1
-  data.tar.gz: c304286d59fdeacf68d1c8adb1c8903ea4ef816263cd35e24af9beaff21bd175007d2d3c74e393d9596b1d534c2ef46b949e70a9a3bc895b9be9e1efece88855
+  metadata.gz: d46e13e3da38fe2c8a70d0ff7bf14a0c3e8b8933a8652a1165a0deb0b3fe8d20a0279f8f93afc31d6beec86e0fc06a998aff298d8109e52b0e96f2cb2c3e95cd
+  data.tar.gz: 1aaa3cd5fafc3450c5ac8f6425822e8faf7798168458fb0b6019ea0f034841afe9309f023ac02671ec89de7a06342509add753ec36110587d62ac237b93d0bad

data/app/assets/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 4.7.0
+
+- Add 'mailto' tracking to GOV.UK Analytics (PR #244)
+
 # 4.6.1
 
 - Use the Sass variable $light-blue for link active and hover colours (PR #242)

data/app/assets/README.md

@@ -144,6 +144,7 @@ In production:
   * [Error tracking](/docs/analytics.md#error-tracking-error-trackingjs)
   * [External link tracking](/docs/analytics.md#external-link-tracking-external-link-trackerjs)
   * [Download link tracking](/docs/analytics.md#download-link-tracking-download-link-trackerjs)
+  * [Mailto link tracking](/docs/analytics.md#mailto-link-tracking-mailto-link-trackerjs)
 
 ## Licence
 

data/app/assets/VERSION.txt

@@ -1 +1 @@
-4.6.1
+4.7.0

data/app/assets/docs/analytics.md

@@ -202,3 +202,12 @@ GOVUK.analyticsPlugins.downloadTracker({selector: 'a[rel="download"]'});
 Category | Action | Label
 ---------|--------|-------
 Download Link Clicked | `/some/upload/attachment/file.pdf` | Link text
+
+### Mailto link tracking (`mailto-link-tracker.js`)
+
+The tracker will send events for clicks on links beginning with `mailto`. By default the
+plugin uses Google Analytics’ `transport: beacon` method so that events are tracked even if the page unloads.
+
+Category | Action | Label
+---------|--------|-------
+Mailto Link Clicked | mailto:name@email.com | Link text

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

@@ -0,0 +1,33 @@
+(function() {
+  "use strict";
+  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {};
+  GOVUK.analyticsPlugins.mailtoLinkTracker = function () {
+
+    var mailtoLinkSelector = 'a[href^="mailto:"]';
+
+    $('body').on('click', mailtoLinkSelector, trackClickEvent);
+
+    function trackClickEvent(evt) {
+      var $link = getLinkFromEvent(evt),
+          options = {transport: 'beacon'},
+          href = $link.attr('href'),
+          linkText = $.trim($link.text());
+
+      if (linkText) {
+        options.label = linkText;
+      }
+
+      GOVUK.analytics.trackEvent('Mailto Link Clicked', href, options);
+    }
+
+    function getLinkFromEvent(evt) {
+      var $target = $(evt.target);
+
+      if (!$target.is('a')) {
+        $target = $target.parents('a');
+      }
+
+      return $target;
+    }
+  }
+}());

data/app/assets/spec/manifest.js

@@ -13,7 +13,8 @@ var manifest = {
     '../../javascripts/govuk/analytics/analytics.js',
     '../../javascripts/govuk/analytics/error-tracking.js',
     '../../javascripts/govuk/analytics/external-link-tracker.js',
-    '../../javascripts/govuk/analytics/download-link-tracker.js'
+    '../../javascripts/govuk/analytics/download-link-tracker.js',
+    '../../javascripts/govuk/analytics/mailto-link-tracker.js'
   ],
   test : [
     '../unit/modules.spec.js',
@@ -26,6 +27,7 @@ var manifest = {
     '../unit/analytics/analytics.spec.js',
     '../unit/analytics/error-tracking.spec.js',
     '../unit/analytics/external-link-tracker.spec.js',
-    '../unit/analytics/download-link-tracker.spec.js'
+    '../unit/analytics/download-link-tracker.spec.js',
+    '../unit/analytics/mailto-link-tracker.spec.js'
   ]
 };

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

@@ -0,0 +1,54 @@
+describe("GOVUK.analyticsPlugins.mailtoLinkTracker", function() {
+  var $links;
+
+  beforeEach(function() {
+    $links = $('\
+      <div class="mailto-links">\
+        <a href="mailto:name1@email.com"></a>\
+        <a href="mailto:name2@email.com">The link for a mailto</a>\
+        <a href="mailto:name3@email.com"><img src="/img" /></a>\
+      </div>');
+
+    $('html').on('click', function(evt) { evt.preventDefault(); });
+    $('body').append($links);
+    GOVUK.analytics = {trackEvent:function(){}};
+
+    GOVUK.analyticsPlugins.mailtoLinkTracker();
+  });
+
+  afterEach(function() {
+    $('html').off();
+    $('body').off();
+    $links.remove();
+    delete GOVUK.analytics;
+  });
+
+  it('listens to click events on mailto links', function() {
+    spyOn(GOVUK.analytics, 'trackEvent');
+
+    $('.mailto-links a').each(function() {
+      $(this).trigger('click');
+      expect(GOVUK.analytics.trackEvent).toHaveBeenCalled();
+      GOVUK.analytics.trackEvent.calls.reset();
+    });
+  });
+
+  it('tracks mailto addresses and link text', function() {
+    spyOn(GOVUK.analytics, 'trackEvent');
+    $('.mailto-links a').trigger('click');
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'Mailto Link Clicked', 'mailto:name1@email.com', {transport: 'beacon'});
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'Mailto Link Clicked', 'mailto:name2@email.com', {transport: 'beacon', label: 'The link for a mailto'});
+  });
+
+  it('listens to click events on elements within mailto links', function() {
+    spyOn(GOVUK.analytics, 'trackEvent');
+
+    $('.mailto-links a img').trigger('click');
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'Mailto Link Clicked', 'mailto:name3@email.com', {transport: 'beacon'});
+  });
+});

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Bradley Wright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -227,6 +227,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/mailto-link-tracker.js
 - app/assets/javascripts/govuk/analytics/print-intent.js
 - app/assets/javascripts/govuk/modules.js
 - app/assets/javascripts/govuk/modules/auto-track-event.js
@@ -251,6 +252,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/mailto-link-tracker.spec.js
 - app/assets/spec/unit/modules.spec.js
 - app/assets/spec/unit/modules/auto-track-event.spec.js
 - app/assets/spec/unit/multivariate-test.spec.js