govuk_frontend_toolkit 1.2.0 → 1.3.0

data/app/assets/README.md

@@ -703,7 +703,7 @@ var test = new GOVUK.MultivariateTest({
   customVarIndex: 555,
   cohorts: {
     pay_your_car_tax: {html: "Pay Your Car Tax"},
-    give_us_money: {html: "Give Us Money Or We Will Crush Your Car"},
+    give_us_money: {html: "Give Us Money Or We Will Crush Your Car"}
   }
 });
 ```
@@ -717,7 +717,21 @@ var test = new GOVUK.MultivariateTest({
   customVarIndex: 555,
   cohorts: {
     pay_your_car_tax: {callback: function() { ... }},
-    give_us_money: {callback: function() { ... }},
+    give_us_money: {callback: function() { ... }}
+  }
+});
+```
+
+If you want one cohort to appear 25% of the time then you can optionally weight
+that cohort:
+
+```javascript
+var test = new GOVUK.MultivariateTest({
+  name: 'car_tax_button_text',
+  customVarIndex: 555,
+  cohorts: {
+    pay_your_car_tax: {weight: 25, callback: function() { ... }}, // 25%
+    give_us_money:    {weight: 75, callback: function() { ... }}  // 75%
   }
 });
 ```
@@ -730,9 +744,11 @@ Takes these options:
  - `el`: Element to run this test on (optional)
  - `name`: The name of the text (alphanumeric and underscores)
  - `customVarIndex`: The index of the custom variable in Google Analytics. GA only gives 50 integer slots to each account, and it is important that a unique integer is assigned to each test. Current contact for assigning a custom var slot for GOV.UK is: Ashraf Chohan <ashraf.chohan@digital.cabinet-office.gov.uk>
- - `cohorts`: An object that maps cohort name to an object that defines the cohort. Name must be same format as test name. Object contains keys (both optional):
+ - `defaultWeight`: Number of times each cohorts should appear in an array the random cohort is picked from, to be used in conjunction with weights on individual cohorts.
+ - `cohorts`: An object that maps cohort name to an object that defines the cohort. Name must be same format as test name. Object contains keys (all optional):
    - `html`: HTML to fill element with when this cohort is picked.
    - `callback`: Function to call when this cohort is chosen. If it is a string, that method on the test object is called.
+   - `weight`: Number of times this cohort should appear in an array the random cohort is picked from, defaults to the `defaultWeight` of the test.
 
 Full documentation on how to design multivariate tests, use the data in GA and construct hypothesis tests is on its way soon.
 

data/app/assets/javascripts/govuk/multivariate-test.js

@@ -15,6 +15,7 @@
     this._loadOption(options, 'customVarIndex');
     this._loadOption(options, 'cohorts');
     this._loadOption(options, 'runImmediately', true);
+    this._loadOption(options, 'defaultWeight', 1);
 
     if (this.runImmediately) {
       this.run();
@@ -84,12 +85,29 @@
     window._gaq.push(['_trackEvent', this.cookieName(), 'run', '-', 0, true]);
   };
 
-  MultivariateTest.prototype.cohortNames = function() {
-    return $.map(this.cohorts, function(v, i) { return i; });
+  MultivariateTest.prototype.weightedCohortNames = function() {
+    var names = [],
+        defaultWeight = this.defaultWeight;
+
+    $.each(this.cohorts, function(key, cohortSettings) {
+      var numberForCohort, i;
+
+      if (typeof cohortSettings.weight === 'undefined'){
+        numberForCohort = defaultWeight;
+      } else {
+        numberForCohort = cohortSettings.weight;
+      }
+
+      for(i=0; i<numberForCohort; i++){
+        names.push(key);
+      }
+    });
+
+    return names;
   };
 
   MultivariateTest.prototype.chooseRandomCohort = function() {
-    var names = this.cohortNames();
+    var names = this.weightedCohortNames();
     return names[Math.floor(Math.random() * names.length)];
   };
 

data/app/assets/spec/MultivariateTestSpec.js

@@ -142,14 +142,43 @@ describe("MultivariateTest", function() {
     });
   });
 
-  describe("#cohortNames", function() {
-    it("should return the names of the cohorts", function() {
+  describe("#weightedCohortNames", function() {
+    it("should return the weighted names of the cohorts when no weights are defined", function() {
       var test = new GOVUK.MultivariateTest({
         name: 'stuff',
         customVarIndex: 1,
-        cohorts: {foo: {}, bar: {}}
+        cohorts: {foo: {}, bar: {}, baz: {}}
+      });
+      expect(test.weightedCohortNames()).toEqual(['foo', 'bar', 'baz']);
+    });
+
+    it("should return the weighted names of the cohorts when weights are defined", function() {
+      var test = new GOVUK.MultivariateTest({
+        name: 'stuff',
+        customVarIndex: 1,
+        cohorts: {foo: { weight: 2 }, bar: { weight: 1 }, baz: { weight: 3 }}
+      });
+      expect(test.weightedCohortNames()).toEqual(['foo', 'foo', 'bar', 'baz', 'baz', 'baz']);
+    });
+
+    it("should return the weighted names of the cohorts using default weighting", function() {
+      var test = new GOVUK.MultivariateTest({
+        name: 'stuff',
+        customVarIndex: 1,
+        defaultWeight: 2,
+        cohorts: {foo: {}, bar: {}, baz: {}}
+      });
+      expect(test.weightedCohortNames()).toEqual(['foo', 'foo', 'bar', 'bar', 'baz', 'baz']);
+    });
+
+    it("should return the weighted names of the cohorts using default weighting or defined weighting", function() {
+      var test = new GOVUK.MultivariateTest({
+        name: 'stuff',
+        customVarIndex: 1,
+        defaultWeight: 2,
+        cohorts: {foo: {}, bar: { weight: 1 }, baz: {}}
       });
-      expect(test.cohortNames()).toEqual(['foo', 'bar']);
+      expect(test.weightedCohortNames()).toEqual(['foo', 'foo', 'bar', 'baz', 'baz']);
     });
   });
 

data/app/assets/stylesheets/design-patterns/_media-player.scss

@@ -1,3 +1,6 @@
+@import '../_colours';
+@import '../_url-helpers';
+
 // Player overrides
 
 @mixin media-player {
@@ -62,11 +65,11 @@
       }
 
       .play {
-        background-image: image-url('player-icon-play.png');
+        background-image: file-url('player-icon-play.png');
       }
 
       .pause {
-        background-image: image-url('player-icon-pause.png');
+        background-image: file-url('player-icon-pause.png');
       }
 
       .rewind, .forward {
@@ -83,13 +86,13 @@
 
       .rewind {
         left: 0;
-        background-image: image-url('player-icon-rewind.png');
+        background-image: file-url('player-icon-rewind.png');
       }
 
       .forward {
         left: 100%;
         margin-left: -40px;
-        background-image: image-url('player-icon-forward.png');
+        background-image: file-url('player-icon-forward.png');
       }
     }
 
@@ -166,7 +169,7 @@
         line-height: 40px;
         background-repeat: no-repeat;
         background-position: center left;
-        background-image: image-url('player-icon-volume.png');
+        background-image: file-url('player-icon-volume.png');
       }
 
       .muted ~ .vol-display {

data/lib/govuk_frontend_toolkit/version.rb

@@ -1,3 +1,3 @@
 module GovUKFrontendToolkit
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -264,7 +264,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4354231487439092246
+      hash: -1772834152994469322
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -273,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4354231487439092246
+      hash: -1772834152994469322
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23