govuk_frontend_toolkit 3.5.0 → 3.5.1

data/app/assets/CHANGELOG.md

@@ -1,6 +1,13 @@
+#3.5.1
+- Changes Analytics API library to accept one, both or neither of the
+analytics tracking codes. This means we can start removing classic
+tracking codes from apps.
+
+
 #3.5.0
 
 - Adds cross domain tracking to Analytics API library: https://github.com/alphagov/govuk_frontend_toolkit/pull/185
+- Adds sass variables for discovery and live phases
 
 #3.4.2
 

data/app/assets/VERSION.txt

@@ -1 +1 @@
-3.5.0
+3.5.1

data/app/assets/docs/analytics.md

@@ -18,6 +18,7 @@ The minimum you need to use the analytics function is:
   * google-analytics-universal-tracker.js
   * tracker.js
 2. Copy the following `init` script into your own project and replace the dummy IDs with your own (they begin with `UA-`).
+  * Tracker.js accepts one or both analytics tracking code, so if you are only using one type of analytics (Classic or Universal) omit the one you don't need from the instantiation of GOVUK.Tracker. (NB you will still need to include both google-analytics-classic-tracker.js and google-analytics-universal-tracker.js in your project as they are currently loaded ahead of instantiation.)
   * This initialisation can occur immediately as this API has no dependencies.
   * Load and create the analytics tracker at the earliest opportunity so that:
     * the time until the first pageview is tracked is kept small and pageviews aren’t missed

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

@@ -121,7 +121,10 @@
   // Match tracker and universal API
   GoogleAnalyticsClassicTracker.prototype.setDimension = function(index, value, name, scope) {
     this.setCustomVariable(index, value, name, scope);
-  }
+  };
+
+  // Match tracker and universal API
+  GoogleAnalyticsClassicTracker.prototype.addLinkedTrackerDomain = function() {};
 
   GOVUK.GoogleAnalyticsClassicTracker = GoogleAnalyticsClassicTracker;
 })();

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

@@ -6,8 +6,13 @@
   // https://github.com/alphagov/govuk_frontend_toolkit/blob/master/docs/analytics.md#create-an-analytics-tracker
 
   var Tracker = function(config) {
-    this.universal = new GOVUK.GoogleAnalyticsUniversalTracker(config.universalId, config.cookieDomain);
-    this.classic = new GOVUK.GoogleAnalyticsClassicTracker(config.classicId, config.cookieDomain);
+    this.trackers = [];
+    if (typeof config.universalId != 'undefined') {
+      this.trackers.push(new GOVUK.GoogleAnalyticsUniversalTracker(config.universalId, config.cookieDomain));
+    }
+    if (typeof config.classicId != 'undefined') {
+      this.trackers.push(new GOVUK.GoogleAnalyticsClassicTracker(config.classicId, config.cookieDomain));
+    }
   };
 
   Tracker.load = function() {
@@ -16,8 +21,9 @@
   };
 
   Tracker.prototype.trackPageview = function(path, title) {
-    this.classic.trackPageview(path);
-    this.universal.trackPageview(path, title);
+    for (var i=0; i < this.trackers.length; i++) {
+      this.trackers[i].trackPageview(path, title);
+    }
   };
 
   /*
@@ -27,14 +33,16 @@
     options.nonInteraction – Prevent event from impacting bounce rate
   */
   Tracker.prototype.trackEvent = function(category, action, options) {
-    this.classic.trackEvent(category, action, options);
-    this.universal.trackEvent(category, action, options);
+    for (var i=0; i < this.trackers.length; i++) {
+      this.trackers[i].trackEvent(category, action, options);
+    }
   };
 
   Tracker.prototype.trackShare = function(network) {
     var target = location.pathname;
-    this.classic.trackSocial(network, 'share', target);
-    this.universal.trackSocial(network, 'share', target);
+    for (var i=0; i < this.trackers.length; i++) {
+      this.trackers[i].trackSocial(network, 'share', target);
+    }
   };
 
   /*
@@ -42,15 +50,18 @@
     Check this for your app before using this
    */
   Tracker.prototype.setDimension = function(index, value, name, scope) {
-    this.universal.setDimension(index, value);
-    this.classic.setCustomVariable(index, value, name, scope);
+    for (var i=0; i < this.trackers.length; i++) {
+      this.trackers[i].setDimension(index, value, name, scope);
+    }
   };
 
   /*
    Add a beacon to track a page in another GA account on another domain.
    */
   Tracker.prototype.addLinkedTrackerDomain = function(trackerId, name, domain) {
-    this.universal.addLinkedTrackerDomain(trackerId, name, domain);
+    for (var i=0; i < this.trackers.length; i++) {
+      this.trackers[i].addLinkedTrackerDomain(trackerId, name, domain);
+    }
   };
 
   GOVUK.Tracker = Tracker;

data/app/assets/spec/manifest.js

@@ -6,12 +6,19 @@ var manifest = {
     '../../javascripts/govuk/primary-links.js',
     '../../javascripts/govuk/stick-at-top-when-scrolling.js',
     '../../javascripts/govuk/stop-scrolling-at-footer.js',
-    '../../javascripts/govuk/selection-buttons.js'
+    '../../javascripts/govuk/selection-buttons.js',
+    '../../javascripts/govuk/analytics/google-analytics-classic-tracker.js',
+    '../../javascripts/govuk/analytics/google-analytics-universal-tracker.js',
+    '../../javascripts/govuk/analytics/tracker.js'
+
   ],
   test : [
     '../unit/MultivariateTestSpec.js',
     '../unit/PrimaryLinksSpec.js',
     '../unit/StickAtTopWhenScrollingSpec.js',
-    '../unit/SelectionButtonSpec.js'
+    '../unit/SelectionButtonSpec.js',
+    '../unit/analytics/GoogleAnalyticsClassicTrackerSpec.js',
+    '../unit/analytics/GoogleAnalyticsUniversalTrackerSpec.js',
+    '../unit/analytics/TrackerSpec.js'
   ]
 };

data/app/assets/spec/support/LocalTestRunner.html

@@ -3,16 +3,16 @@
 <head>
   <title>Jasmine Test Runner</title>
 
-  <link rel="stylesheet" type="text/css" href="../../node_modules/grunt-contrib-jasmine/vendor/jasmine-1.3.1/jasmine.css">
+  <link rel="stylesheet" type="text/css" href="../../node_modules/grunt-contrib-jasmine/vendor/jasmine-2.0.1/jasmine.css">
   <style>
     #wrapper { display: none; }
   </style>
 
   <!-- JASMINE FILES -->
-  <script type="text/javascript" src="../../node_modules/grunt-contrib-jasmine/vendor/jasmine-1.3.1/jasmine.js"></script>
-  <script type="text/javascript" src="../../node_modules/grunt-contrib-jasmine/vendor/jasmine-1.3.1/jasmine-html.js"></script>
+  <script type="text/javascript" src="../../node_modules/grunt-contrib-jasmine/vendor/jasmine-2.0.1/jasmine.js"></script>
+  <script type="text/javascript" src="../../node_modules/grunt-contrib-jasmine/vendor/jasmine-2.0.1/jasmine-html.js"></script>
 
-  <script type="text/javascript" src="./console-runner.js"></script>
+  <script type="text/javascript" src="../../node_modules/grunt-contrib-jasmine/vendor/jasmine-2.0.1/boot.js"></script>
   <script type="text/javascript" src="./load.js"></script>
 </head>
 <body>

data/app/assets/spec/support/load.js

@@ -1,5 +1,5 @@
 (function (root) {
-  "use strict";
+  "use strict"
   var loadedScripts = 0,
       totalScripts,
       merge,
@@ -22,7 +22,7 @@
   };
   loadScript = function (src, nextIdx) {
     var script = document.createElement('script'),
-        nextScript; 
+        nextScript;
 
     script.type = 'text/javascript';
     script.src = src;
@@ -32,23 +32,15 @@
     script.onload = function () {
       if (nextIdx < totalScripts.length) {
         loadScript(totalScripts[nextIdx], nextIdx + 1);
-      } else {
-        runJasmine();
       }
     };
     return script;
   };
-  runJasmine = function () {
-    var console_reporter = new jasmine.ConsoleReporter();
-    jasmine.getEnv().addReporter(new jasmine.TrivialReporter());
-    jasmine.getEnv().addReporter(console_reporter);
-    jasmine.getEnv().execute();
-  };
   manifestScript = loadScript('../manifest.js');
 
   manifestScript.onload = function () {
     var idx = 0;
-  
+
     totalScripts = merge([manifest.support, manifest.test]);
     loadScript(totalScripts[idx], idx + 1);
   };

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

@@ -25,6 +25,26 @@ describe("GOVUK.Tracker", function() {
       expect(window._gaq[1]).toEqual(['_setDomainName', '.www.gov.uk']);
       expect(universalSetupArguments[0]).toEqual(['create', 'universal-id', {'cookieDomain': '.www.gov.uk'}]);
     });
+
+  });
+
+  describe('when created with only universal analytics', function() {
+    var universalSetupArguments;
+
+    beforeEach(function () {
+    });
+
+    it ('doesn\'t require both trackers to be present', function() {
+      universalOnlyConfig = { universalId: 'universal-id',
+                              cookieDomain: '.www.gov.uk'
+                            };
+
+      var tracker = new GOVUK.Tracker(universalOnlyConfig);
+
+      universalSetupArguments = window.ga.calls.allArgs();
+      expect(typeof(window._gaq[0])).toEqual('undefined');
+      expect(universalSetupArguments[0]).toEqual(['create', 'universal-id', {'cookieDomain': '.www.gov.uk'}]);
+    });
   });
 
   describe('when tracking pageviews, events and custom dimensions', function() {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -288,7 +288,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3226103132821622177
+      hash: 609319140606558990
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -297,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3226103132821622177
+      hash: 609319140606558990
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23