govuk_ab_testing 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a131dac8f3c6fe3c8bd613056c2c639790807519
-  data.tar.gz: 247f153ccd3d578a4340594198858c34faec0bbb
+  metadata.gz: 9bc5b6a51bbc98c18d8b98be5bef8dc8f1da357b
+  data.tar.gz: 88fead7061b12d481392042abcf7c5538c719328
 SHA512:
-  metadata.gz: da4a7338ea7be7c6535637bf7f8f0d9ab7e047bdd9a55786a6c7d90e2f7e00d7f907c2179ef2e25e85a914945f487054244eb470817c80c4ae0f3ba68af3a9ae
-  data.tar.gz: 074fdfce8d5d4a9dc749fae59c495cfb3a57d5f97561939b5704e1f62ca7bc90e80fb3360ec2bddb61f30335a566c6700d0a937ecf6b8b0a8321b42570a17fec
+  metadata.gz: a923e35735f9643f0f08c59a2486fd9dbf47098996f302136a6590bd82f092bf47bd795ae1268a965d883e234b62ed8ae46e711cbd1d4ad626be4eee42ac2ec1
+  data.tar.gz: 7c4aaa517b641a8cab5437016bae55e4d3709323ebc3a3c53a4a7ef725efda1afbe9440475c66d2a1124a0bbb709c6755b90848152ca9eebfc19e8abed2f020f

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.3

data/README.md

@@ -29,7 +29,8 @@ that you pass to the Gem. The cookie name is case-sensitive.
 To enable testing in the app, your Rails app needs:
 
 1. Some piece of logic to be A/B tested
-2. A HTML meta tag that will be used to measure the results
+2. A HTML meta tag that will be used to measure the results, and which specifies
+the dimension to use in Google Analytics
 3. A response HTTP header that tells Fastly you're doing an A/B test
 
 Let's say you have this controller:
@@ -38,7 +39,7 @@ Let's say you have this controller:
 # app/controllers/party_controller.rb
 class PartyController < ApplicationController
   def show
-    ab_test = GovukAbTesting::AbTest.new("your_ab_test_name")
+    ab_test = GovukAbTesting::AbTest.new("your_ab_test_name", dimension: 300)
     @requested_variant = ab_test.requested_variant(request)
     @requested_variant.configure_response(response)
 

data/govuk_ab_testing.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "govuk-lint", "~> 1.2.1"
   spec.add_development_dependency "yard", "~> 0.8"
   spec.add_development_dependency "gem_publisher", "~> 1.5.0"
 end

data/lib/govuk_ab_testing/ab_test.rb

@@ -2,14 +2,18 @@ module GovukAbTesting
   class AbTest
     attr_reader :ab_test_name
 
-    def initialize(ab_test_name)
+    # @param request [String] the name of the A/B test
+    # @param dimension [Integer] the dimension registered with Google Analytics
+    # for this specific A/B test
+    def initialize(ab_test_name, dimension:)
       @ab_test_name = ab_test_name
+      @dimension = dimension
     end
 
     # @param request [ApplicationController::Request] the `request` in the
     # controller.
     def requested_variant(request)
-      RequestedVariant.new(self, request)
+      RequestedVariant.new(self, request, @dimension)
     end
 
     # Internal name of the header

data/lib/govuk_ab_testing/minitest_helpers.rb

@@ -3,7 +3,7 @@ module GovukAbTesting
     def with_variant(args)
       ab_test_name, variant = args.first
 
-      ab_test = GovukAbTesting::AbTest.new(ab_test_name.to_s)
+      ab_test = GovukAbTesting::AbTest.new(ab_test_name.to_s, dimension: args[:dimension])
 
       @request.headers[ab_test.request_header] = variant
       requested_variant = ab_test.requested_variant(@request)
@@ -13,8 +13,11 @@ module GovukAbTesting
       assert_equal ab_test.response_header, response.headers['Vary'], "You probably forgot to use `configure_response`"
 
       unless args[:assert_meta_tag] == false
+        raise "Cannot test the A/B meta tag because no expected :dimension parameter was specified by test" unless args[:dimension]
+
         assert_meta_tag "govuk:ab-test",
           ab_test.meta_tag_name + ':' + requested_variant.variant_name,
+          args[:dimension],
           "You probably forgot to add the `analytics_meta_tag`"
       end
     end
@@ -34,8 +37,8 @@ module GovukAbTesting
 
   private
 
-    def assert_meta_tag(name, content, message)
-      assert_select "meta[name='#{name}'][content='#{content}']", 1, message
+    def assert_meta_tag(name, content, dimension, message)
+      assert_select "meta[name='#{name}'][content='#{content}'][data-analytics-dimension='#{dimension}']", 1, message
     end
   end
 end

data/lib/govuk_ab_testing/requested_variant.rb

@@ -5,9 +5,12 @@ module GovukAbTesting
     # @param ab_test [AbTest] the A/B test being performed
     # @param request [ApplicationController::Request] the `request` in the
     # controller.
-    def initialize(ab_test, request)
+    # @param dimension [Integer] the dimension registered with Google Analytics
+    # for this specific A/B test
+    def initialize(ab_test, request, dimension)
       @ab_test = ab_test
       @request = request
+      @dimension = dimension
     end
 
     # Get the bucket this user is in
@@ -39,7 +42,9 @@ module GovukAbTesting
     #
     # @return [String]
     def analytics_meta_tag
-      '<meta name="govuk:ab-test" content="' + ab_test.meta_tag_name + ':' + variant_name + '">'
+      '<meta name="govuk:ab-test" ' +
+        'content="' + ab_test.meta_tag_name + ':' + variant_name + '" ' +
+        'data-analytics-dimension="' + @dimension.to_s + '">'
     end
   end
 end

data/lib/govuk_ab_testing/version.rb

@@ -1,3 +1,3 @@
 module GovukAbTesting
-  VERSION = "0.1.0"
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_ab_testing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: govuk-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile