govuk_frontend_toolkit 3.1.0 → 3.2.0

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

@@ -0,0 +1,124 @@
+describe("GOVUK.GoogleAnalyticsClassicTracker", function() {
+  var classic;
+
+  beforeEach(function() {
+    window._gaq = [];
+    classic = new GOVUK.GoogleAnalyticsClassicTracker('id', 'cookie-domain.com');
+  });
+
+  it('can load the libraries needed to run classic Google Analytics', function() {
+    delete window._gaq;
+    $('[src*="google-analytics.com/ga.js"]').remove();
+
+    GOVUK.GoogleAnalyticsClassicTracker.load();
+    expect($('script[async][src*="google-analytics.com/ga.js"]').length).toBe(1);
+  });
+
+  describe('when created', function() {
+    it('configures a Google tracker using the provided profile ID and cookie domain', function() {
+      expect(window._gaq[0]).toEqual(['_setAccount', 'id']);
+      expect(window._gaq[1]).toEqual(['_setDomainName', 'cookie-domain.com']);
+    });
+
+    it('allows cross site linking', function() {
+      expect(window._gaq[2]).toEqual(['_setAllowLinker', true]);
+    });
+
+    it('anonymises the IP', function() {
+      expect(window._gaq[3]).toEqual(['_gat._anonymizeIp']);
+    });
+  });
+
+  describe('when pageviews are tracked', function() {
+    beforeEach(function() {
+      // reset queue after setup
+      window._gaq = [];
+    });
+
+    it('sends them to Google Analytics', function() {
+      classic.trackPageview();
+      expect(window._gaq[0]).toEqual(['_trackPageview']);
+    });
+
+    it('can track a virtual pageview', function() {
+      classic.trackPageview('/nicholas-page');
+      expect(window._gaq[0]).toEqual(['_trackPageview', '/nicholas-page']);
+    });
+  });
+
+  describe('when events are tracked', function() {
+    beforeEach(function() {
+      // reset queue after setup
+      window._gaq = [];
+    });
+
+    it('sends them to Google Analytics', function() {
+      classic.trackEvent('category', 'action', {label: 'label'});
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action', 'label']);
+    });
+
+    it('the label is optional', function() {
+      classic.trackEvent('category', 'action');
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action']);
+    });
+
+    it('a value can be tracked if the label is omitted', function() {
+      classic.trackEvent('category', 'action', {value: 10});
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action', '', 10]);
+    });
+
+    it('only sends values if they are parseable as numbers', function() {
+      classic.trackEvent('category', 'action', {label: 'label', value: '10'});
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action', 'label', 10]);
+
+      classic.trackEvent('category', 'action', {label: 'label', value: 10});
+      expect(window._gaq[1]).toEqual(['_trackEvent', 'category', 'action', 'label', 10]);
+
+      classic.trackEvent('category', 'action', {label: 'label', value: 'not a number'});
+      expect(window._gaq[2]).toEqual(['_trackEvent', 'category', 'action', 'label']);
+    });
+
+    it('can mark an event as non interactive', function() {
+      classic.trackEvent('category', 'action', {label: 'label', value: 1, nonInteraction: true});
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action', 'label', 1, true]);
+    });
+
+    it('can mark an event as non interactive without a value', function() {
+      classic.trackEvent('category', 'action', {label: 'label', nonInteraction: true});
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action', 'label', 0, true]);
+    });
+
+    it('can mark an event as non interactive without a label or value', function() {
+      classic.trackEvent('category', 'action', {nonInteraction: true});
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action', '', 0, true]);
+    });
+  });
+
+  describe('when social events are tracked', function() {
+    beforeEach(function() {
+      window._gaq = [];
+    });
+
+    it('sends them to Google Analytics', function() {
+      classic.trackSocial('network', 'action', 'target');
+      expect(window._gaq[0]).toEqual(['_trackSocial', 'network', 'action', 'target']);
+    });
+  });
+
+  describe('when setting a custom variable', function() {
+    beforeEach(function() {
+      // reset queue after setup
+      window._gaq = [];
+    });
+
+    it('sends the variable to Google Analytics', function() {
+      classic.setCustomVariable(1, 'value', 'name', 10);
+      expect(window._gaq[0]).toEqual(['_setCustomVar', 1, 'name', 'value', 10]);
+    });
+
+    it('coerces the value to a string', function() {
+      classic.setCustomVariable(1, 100, 'name', 10);
+      expect(window._gaq[0]).toEqual(['_setCustomVar', 1, 'name', '100', 10]);
+    });
+  });
+});

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

@@ -0,0 +1,122 @@
+describe("GOVUK.GoogleAnalyticsUniversalTracker", function() {
+  var universal;
+
+  beforeEach(function() {
+    window.ga = function() {};
+    spyOn(window, 'ga');
+    universal = new GOVUK.GoogleAnalyticsUniversalTracker('id', 'cookie-domain.com');
+  });
+
+  it('can load the libraries needed to run universal Google Analytics', function() {
+    delete window.ga;
+    $('[src="//www.google-analytics.com/analytics.js"]').remove();
+    GOVUK.GoogleAnalyticsUniversalTracker.load();
+    expect($('script[async][src="//www.google-analytics.com/analytics.js"]').length).toBe(1);
+    expect(typeof window.ga).toBe('function');
+
+    window.ga('send message');
+    expect(window.ga.q[0]).toEqual(jasmine.any(Object));
+  });
+
+  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('anonymises the IP', function() {
+      expect(setupArguments[1]).toEqual(['set', 'anonymizeIp', true]);
+    });
+  });
+
+  describe('when pageviews are tracked', function() {
+    it('sends them to Google Analytics', function() {
+      universal.trackPageview();
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview']);
+    });
+
+    it('can track a virtual pageview', function() {
+      universal.trackPageview('/nicholas-page');
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', {page: '/nicholas-page'}]);
+    });
+
+    it('can track a virtual pageview with a custom title', function() {
+      universal.trackPageview('/nicholas-page', 'Nicholas Page');
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', {page: '/nicholas-page', title: 'Nicholas Page'}]);
+    });
+  });
+
+  describe('when events are tracked', function() {
+    function eventObjectFromSpy() {
+      return window.ga.calls.mostRecent().args[1];
+    }
+
+    it('sends them to Google Analytics', function() {
+      universal.trackEvent('category', 'action', {label: 'label'});
+      expect(window.ga.calls.mostRecent().args).toEqual(
+        ['send', {hitType: 'event', eventCategory: 'category', eventAction: 'action', eventLabel: 'label'}]
+      );
+    });
+
+    it('the label is optional', function() {
+      universal.trackEvent('category', 'action');
+      expect(window.ga.calls.mostRecent().args).toEqual(
+        ['send', {hitType: 'event', eventCategory: 'category', eventAction: 'action'}]
+      );
+    });
+
+    it('only sends values if they are parseable as numbers', function() {
+      universal.trackEvent('category', 'action', {label: 'label', value: '10'});
+      expect(eventObjectFromSpy()['eventValue']).toEqual(10);
+
+      universal.trackEvent('category', 'action', {label: 'label', value: 10});
+      expect(eventObjectFromSpy()['eventValue']).toEqual(10);
+
+      universal.trackEvent('category', 'action', {label: 'label', value: 'not a number'});
+      expect(eventObjectFromSpy()['eventValue']).toEqual(undefined);
+    });
+
+    it('can mark an event as non interactive', function() {
+      universal.trackEvent('category', 'action', {label: 'label', value: 0, nonInteraction: true});
+      expect(window.ga.calls.mostRecent().args).toEqual(
+        ['send', {
+          hitType: 'event',
+          eventCategory: 'category',
+          eventAction: 'action',
+          eventLabel: 'label',
+          eventValue: 0,
+          nonInteraction: 1
+        }]
+      );
+    });
+  });
+
+  describe('when social events are tracked', function() {
+    it('sends them to Google Analytics', function() {
+      universal.trackSocial('network', 'action', 'target');
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {
+        'hitType': 'social',
+        'socialNetwork': 'network',
+        'socialAction': 'action',
+        'socialTarget': 'target'
+      }]);
+    });
+  });
+
+  describe('when setting a custom dimension', function() {
+    it('sends the dimension to Google Analytics with the specified index and value', function() {
+      universal.setDimension(1, 'value');
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', 'value']);
+    });
+
+    it('coerces the value to a string', function() {
+      universal.setDimension(1, 10);
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', '10']);
+    });
+  });
+});

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

@@ -0,0 +1,74 @@
+describe("GOVUK.Tracker", function() {
+  var tracker;
+
+  beforeEach(function() {
+    window._gaq = [];
+    window.ga = function() {};
+    spyOn(window, 'ga');
+    this.config = {
+      universalId: 'universal-id',
+      classicId: 'classic-id',
+      cookieDomain: '.www.gov.uk'
+    };
+  });
+
+  describe('when created', function() {
+    var universalSetupArguments;
+
+    beforeEach(function () {
+      tracker = new GOVUK.Tracker(this.config);
+      universalSetupArguments = window.ga.calls.allArgs();
+    });
+
+    it('configures classic and universal trackers', function () {
+      expect(window._gaq[0]).toEqual(['_setAccount', 'classic-id']);
+      expect(window._gaq[1]).toEqual(['_setDomainName', '.www.gov.uk']);
+      expect(universalSetupArguments[0]).toEqual(['create', 'universal-id', {'cookieDomain': '.www.gov.uk'}]);
+    });
+  });
+
+  describe('when tracking pageviews, events and custom dimensions', function() {
+
+    beforeEach(function() {
+      tracker = new GOVUK.Tracker(this.config);
+    });
+
+    it('tracks in both classic and universal', function() {
+      window._gaq = [];
+      tracker.trackPageview('/path', 'Title');
+      expect(window._gaq[0]).toEqual(['_trackPageview', '/path']);
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', {page: '/path', title: 'Title'}]);
+
+      window._gaq = [];
+      tracker.trackEvent('category', 'action');
+      expect(window._gaq[0]).toEqual(['_trackEvent', 'category', 'action']);
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {hitType: 'event', eventCategory: 'category', eventAction: 'action'}]);
+
+      window._gaq = [];
+      tracker.setDimension(1, 'value', 'name');
+      expect(window._gaq[0]).toEqual(['_setCustomVar', 1, 'name', 'value', 3]);
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', 'value']);
+    });
+  });
+
+  describe('when tracking social media shares', function() {
+
+    beforeEach(function() {
+      tracker = new GOVUK.Tracker(this.config);
+    });
+
+    it('tracks in both classic and universal', function() {
+      window._gaq = [];
+      tracker.trackShare('network');
+
+      expect(window._gaq[0]).toEqual(['_trackSocial', 'network', 'share', jasmine.any(String)]);
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {
+        hitType: 'social',
+        socialNetwork: 'network',
+        socialAction: 'share',
+        socialTarget: jasmine.any(String)
+      }]);
+    });
+  });
+
+});

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &11238300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *11238300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &11236700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,29 +37,44 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *11236700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &11235360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *11235360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &11234200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *11234200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
 description: 
 email: bradley.wright@digital.cabinet-office.gov.uk
 executables: []
@@ -84,6 +104,9 @@ files:
 - app/assets/LICENCE
 - app/assets/README.md
 - app/assets/VERSION.txt
+- app/assets/docs/analytics.md
+- app/assets/docs/javascript.md
+- app/assets/docs/mixins.md
 - app/assets/images/accordian-arrow-2x.png
 - app/assets/images/accordian-arrow.png
 - app/assets/images/arrow-sprite.png
@@ -207,6 +230,11 @@ files:
 - app/assets/images/player-icon-play.png
 - app/assets/images/player-icon-rewind.png
 - app/assets/images/player-icon-volume.png
+- app/assets/javascripts/govuk/analytics/error-tracking.js
+- app/assets/javascripts/govuk/analytics/google-analytics-classic-tracker.js
+- app/assets/javascripts/govuk/analytics/google-analytics-universal-tracker.js
+- app/assets/javascripts/govuk/analytics/print-intent.js
+- app/assets/javascripts/govuk/analytics/tracker.js
 - app/assets/javascripts/govuk/multivariate-test.js
 - app/assets/javascripts/govuk/primary-links.js
 - app/assets/javascripts/govuk/selection-buttons.js
@@ -227,6 +255,9 @@ files:
 - app/assets/spec/unit/PrimaryLinksSpec.js
 - app/assets/spec/unit/SelectionButtonSpec.js
 - app/assets/spec/unit/StickAtTopWhenScrollingSpec.js
+- app/assets/spec/unit/analytics/GoogleAnalyticsClassicTrackerSpec.js
+- app/assets/spec/unit/analytics/GoogleAnalyticsUniversalTrackerSpec.js
+- app/assets/spec/unit/analytics/TrackerSpec.js
 - app/assets/stylesheets/.gitkeep
 - app/assets/stylesheets/_colours.scss
 - app/assets/stylesheets/_conditionals.scss
@@ -257,7 +288,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4114693619292822888
+      hash: -1949845834061421958
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -266,10 +297,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4114693619292822888
+      hash: -1949845834061421958
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Tools for building frontend applications