govuk_ab_testing 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 855c19cb71753681212ec44568952404cda4be1f
-  data.tar.gz: 003b91391e240a88f29321d2f37674895017df3a
+  metadata.gz: 84d90e7b73cb4f14c3ddc5670921e7077a85ecca
+  data.tar.gz: 6e933bd3bc167d9995097901654893c26c4300dc
 SHA512:
-  metadata.gz: efbeee80a3643a4d3839842841b552cef0e2fe61addfc818cd5649626d2be38f4579369f33359d02ce46f52ad24c2c18447bbb3d756a8848f8951c28bc310926
-  data.tar.gz: 5553b89840a15687c569c3d59c0ccb1877e36664974558e67a0572b7bde005be35459cc9feff64b15eb4cb4922ca75280525b218ddd5e7b1764fe7a997d2d21d
+  metadata.gz: 7a929e3cf5b0a044a1dc2b2cde0d8e6b7541bd110a5569c0e38c466aa5b908750658ab7749ff251774dfd89542f2457b8781c1304430f011c550f13b41315e7a
+  data.tar.gz: ab6bee9421a644a0e906f1073b3a751917c60b41306f42f4c51e7ccd84aae6f453f8c8c17e819df5868c550df0db1201b6ef34dbfa628649f2f8bc576fb04414

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.1.0
+
+* Refactor both RSpec and Minitest helpers to use the same Abstract helper
+* Allow assertions on the Vary header for multiple concurrent A/B tests
+* Fix a broken RSpec assertion
+* Fix meta tag dimension checking
+
 ## 2.0.0
 
 * **BREAKING CHANGE** `assert_response_not_modified_for_ab_test` now

data/lib/govuk_ab_testing/ab_test.rb

@@ -1,6 +1,9 @@
 module GovukAbTesting
   class AbTest
     attr_reader :ab_test_name
+    attr_reader :dimension
+
+    alias_method :name, :ab_test_name
 
     # @param request [String] the name of the A/B test
     # @param dimension [Integer] the dimension registered with Google Analytics

data/lib/govuk_ab_testing/abstract_helpers.rb

@@ -0,0 +1,128 @@
+module GovukAbTesting
+  module AbstractHelpers
+    def acceptance_test_framework
+      @acceptance_test_framework ||= GovukAbTesting.configuration.framework_class.new(self)
+    end
+
+    def with_variant(args)
+      ab_test_name, variant = args.first
+      dimension = args[:dimension]
+
+      setup_ab_variant(ab_test_name, variant, dimension)
+
+      yield
+
+      assert_response_is_cached_by_variant(ab_test_name)
+
+      unless args[:assert_meta_tag] == false
+        assert_page_tracked_in_ab_test(ab_test_name, variant, dimension)
+      end
+    end
+
+    def setup_ab_variant(ab_test_name, variant, dimension = 300)
+      ab_test = AbTest.new(ab_test_name, dimension: dimension)
+      acceptance_test_framework.set_header(ab_test.request_header, variant)
+    end
+
+    def assert_response_is_cached_by_variant(ab_test_name)
+      ab_test = AbTest.new(ab_test_name, dimension: 300)
+      vary_header_value = acceptance_test_framework.vary_header
+
+      assert_contains_substring(
+        string: vary_header_value,
+        substring: ab_test.response_header,
+        error_message: <<-ERROR
+          The 'Vary' header is not being set for the '#{ab_test.name}' A/B test.
+          You will need to use GovukAbTesting::RequestedVariant#configure_response in your controller:
+
+            requested_variant.configure_response(response)
+
+        ERROR
+      )
+    end
+
+    def assert_response_not_modified_for_ab_test(ab_test_name)
+      vary_header = acceptance_test_framework.vary_header
+      assert_does_not_contain_substring(
+        string: vary_header,
+        substring: ab_test_name,
+        error_message: <<-ERROR
+          The 'Vary' header is being set by A/B test '#{ab_test_name}' on a page that should not be modified
+          by the A/B test. Check for incorrect usage of GovukAbTesting::RequestedVariant#configure_response
+          in your controller.
+
+            'Vary': #{vary_header}
+
+        ERROR
+      )
+    end
+
+    def assert_page_not_tracked_in_ab_test(ab_test_name)
+      ab_test_meta_tags =
+        acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
+
+      assert_is_empty(
+        enumerable: ab_test_meta_tags,
+        error_message: <<-ERROR
+          Found the following '#{ab_test_name}' A/B testing meta tag on a page that should not be modified by
+          the A/B test:
+
+            #{ab_test_meta_tags.first.content}
+
+          Check for incorrect usage of GovukAbTesting::RequestedVariant#analytics_meta_tag
+        ERROR
+      )
+    end
+
+    def assert_page_tracked_in_ab_test(ab_test_name, variant, dimension)
+      ab_test = AbTest.new(ab_test_name, dimension: dimension)
+
+      ab_test_meta_tags =
+        acceptance_test_framework.analytics_meta_tags_for_test(ab_test.name)
+
+      assert_has_size(
+        enumerable: ab_test_meta_tags,
+        size: 1,
+        error_message: <<-ERROR
+          Incorrect number of analytics meta tags on the page for A/B test '#{ab_test.name}'.
+          You may need to check usage of GovukAbTesting::RequestedVariant#analytics_meta_tag in your template(s):
+
+            <%= requested_variant.analytics_meta_tag %>
+
+        ERROR
+      )
+
+      meta_tag = ab_test_meta_tags.first
+      expected_metatag_content = "#{ab_test.meta_tag_name}:#{variant}"
+
+      assert_is_equal(
+        expected: expected_metatag_content,
+        actual: meta_tag.content,
+        error_message: <<-ERROR
+          The analytics meta tag content for A/B test '#{ab_test.name}' does not match the expected value.
+          You may need to use GovukAbTesting::RequestedVariant#analytics_meta_tag in your template(s):
+
+            <%= requested_variant.analytics_meta_tag %>
+
+        ERROR
+      )
+
+      assert_not_blank(
+        string: meta_tag.dimension,
+        error_message: <<-ERROR
+          The meta tag dimension for the '#{ab_test_name}' A/B test is blank.
+        ERROR
+      )
+
+      unless ab_test.dimension.nil?
+        assert_is_equal(
+          expected: ab_test.dimension.to_s,
+          actual: meta_tag.dimension.to_s,
+          error_message: <<-ERROR
+            The analytics meta tag for the '#{ab_test.name}' A/B test does not match the expected value.
+          ERROR
+        )
+      end
+    end
+  end
+end

data/lib/govuk_ab_testing/acceptance_tests/active_support.rb

@@ -10,6 +10,7 @@ module GovukAbTesting
         end
         @scope = scope
         @request_headers = {}
+        @response = scope.instance_variable_get(:@response)
       end
 
       def set_header(name, value)
@@ -17,8 +18,8 @@ module GovukAbTesting
         @request_headers[name] = value
       end
 
-      def vary_header(response)
-        response.headers['Vary']
+      def vary_header
+        @response.headers['Vary']
       end
 
       def analytics_meta_tags_for_test(ab_test_name)

data/lib/govuk_ab_testing/minitest_assertions.rb

@@ -0,0 +1,28 @@
+module GovukAbTesting
+  module MinitestAssertions
+    def assert_is_equal(expected:, actual:, error_message:)
+      assert_equal(expected, actual, error_message)
+    end
+
+    def assert_contains_substring(string:, substring:, error_message:)
+      assert_match(/#{substring}/, string, error_message)
+    end
+
+    def assert_does_not_contain_substring(string:, substring:, error_message:)
+      refute_match(/#{substring}/, string, error_message)
+    end
+
+    def assert_has_size(enumerable:, size:, error_message:)
+      assert_equal(size, enumerable.count, error_message)
+    end
+
+    def assert_is_empty(enumerable:, error_message:)
+      assert_has_size(enumerable, 0, error_message)
+    end
+
+    def assert_not_blank(string:, error_message:)
+      refute_nil(string, error_message)
+      refute_equal(string.length, 0, error_message)
+    end
+  end
+end

data/lib/govuk_ab_testing/minitest_helpers.rb

@@ -1,90 +1,6 @@
 module GovukAbTesting
   module MinitestHelpers
-    def acceptance_test_framework
-      @acceptance_test_framework ||=
-        GovukAbTesting.configuration.framework_class.new(self)
-    end
-
-    def with_variant(args)
-      ab_test_name, variant = args.first
-      dimension = args[:dimension]
-
-      ab_test =
-        GovukAbTesting::AbTest.new(ab_test_name.to_s, dimension: dimension)
-
-      acceptance_test_framework.set_header(ab_test.request_header, variant)
-      requested_variant = ab_test.requested_variant(acceptance_test_framework.request_headers)
-
-      yield
-
-      vary_header_value = acceptance_test_framework.vary_header(response)
-      assert_match ab_test.response_header, vary_header_value,
-        "You probably forgot to use `configure_response`"
-
-      unless args[:assert_meta_tag] == false
-        expected_content =
-          ab_test.meta_tag_name + ':' + requested_variant.variant_name
-        message = "You probably forgot to add the `analytics_meta_tag` to the views"
-        meta_tags =
-          acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
-
-        assert_equal(1, meta_tags.count, message)
-
-        meta_tag = meta_tags.first
-
-        assert_equal(
-          expected_content,
-          meta_tag.content,
-          "Meta tag's content doesnt match."
-        )
-
-        if dimension.nil?
-          assert(meta_tag.dimension, "No custom dimension number found")
-        else
-          assert_equal(
-            dimension.to_s,
-            meta_tag.dimension,
-            "The custom dimension found in meta tag doesn't match"
-          )
-        end
-      end
-    end
-
-    def setup_ab_variant(ab_test_name, variant, dimension = 300)
-      ab_test = GovukAbTesting::AbTest.new(ab_test_name, dimension: dimension)
-
-      acceptance_test_framework.set_header(ab_test.request_header, variant)
-    end
-
-    def assert_response_is_cached_by_variant(ab_test_name)
-      ab_test = GovukAbTesting::AbTest.new(ab_test_name, dimension: 123)
-
-      vary_header_value = acceptance_test_framework.vary_header(response)
-      assert_match ab_test.response_header, vary_header_value,
-        "You probably forgot to use `configure_response`"
-    end
-
-    def assert_response_not_modified_for_ab_test(ab_test_name)
-      vary_header = acceptance_test_framework.vary_header(response)
-
-      assert_no_match(
-        /#{ab_test_name}/,
-        vary_header,
-        "`Vary` header is being added to a page which should not be modified by the A/B test"
-      )
-
-      assert_page_not_tracked_in_ab_test(ab_test_name)
-    end
-
-    def assert_page_not_tracked_in_ab_test(ab_test_name)
-      meta_tags =
-        acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
-
-      assert_equal(
-        0,
-        meta_tags.count,
-        "A/B meta tag is being added to a page which should not be modified by the A/B test"
-      )
-    end
+    include AbstractHelpers
+    include MinitestAssertions
   end
 end

data/lib/govuk_ab_testing/rspec_assertions.rb

@@ -0,0 +1,29 @@
+module GovukAbTesting
+  module RspecAssertions
+    def assert_is_equal(expected:, actual:, error_message:)
+      expect(actual).to eq(expected), error_message
+    end
+
+    def assert_contains_substring(string:, substring:, error_message:)
+      expect(string).to include(substring), error_message
+    end
+
+    def assert_does_not_contain_substring(string:, substring:, error_message:)
+      return if string.nil?
+      expect(string).not_to include(substring), error_message
+    end
+
+    def assert_has_size(enumerable:, size:, error_message:)
+      expect(enumerable.count).to eq(size), error_message
+    end
+
+    def assert_is_empty(enumerable:, error_message:)
+      assert_has_size(enumerable, 0, error_message)
+    end
+
+    def assert_not_blank(string:, error_message:)
+      expect(string).not_to be_nil, error_message
+      expect(string.length).not_to eq(0), error_message
+    end
+  end
+end

data/lib/govuk_ab_testing/rspec_helpers.rb

@@ -1,73 +1,6 @@
 module GovukAbTesting
   module RspecHelpers
-    def acceptance_test_framework
-      @acceptance_test_framework ||=
-        GovukAbTesting.configuration.framework_class.new(self)
-    end
-
-    def with_variant(args)
-      ab_test_name, variant = args.first
-      dimension = args[:dimension]
-
-      ab_test =
-        GovukAbTesting::AbTest.new(ab_test_name.to_s, dimension: dimension)
-
-      acceptance_test_framework.set_header(ab_test.request_header, variant)
-      requested_variant = ab_test.requested_variant(acceptance_test_framework.request_headers)
-
-      yield
-
-      vary_header_value = acceptance_test_framework.vary_header
-      expect(ab_test.response_header).to eq(vary_header_value)
-
-      unless args[:assert_meta_tag] == false
-        content = [ab_test.meta_tag_name, requested_variant.variant_name].join(':')
-        ab_test_metatags =
-          acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
-
-        expect(ab_test_metatags.count).to eq(1)
-
-        meta_tag = ab_test_metatags.first
-
-        expect(meta_tag.content).to eq(content)
-        dimension = meta_tag.dimension
-
-        if dimension.nil?
-          expect(dimension).to_not be_nil
-        else
-          expect(dimension).to eq(dimension.to_s)
-        end
-      end
-    end
-
-    def setup_ab_variant(ab_test_name, variant, dimension = 300)
-      ab_test = GovukAbTesting::AbTest.new(ab_test_name, dimension: dimension)
-
-      acceptance_test_framework.set_header(ab_test.request_header, variant)
-    end
-
-    def assert_response_is_cached_by_variant(ab_test_name)
-      ab_test = GovukAbTesting::AbTest.new(ab_test_name, dimension: 123)
-
-      vary_header_value = acceptance_test_framework.vary_header
-      expect(vary_header_value).to eq(ab_test.response_header)
-    end
-
-    def assert_response_not_modified_for_ab_test(ab_test_name)
-      vary_header = acceptance_test_framework.vary_header
-
-      expect(vary_header).to_not match?(/#{ab_test_name}/),
-        "`Vary` header is being added to a page which should not be modified by the A/B test"
-
-      assert_page_not_tracked_in_ab_test(ab_test_name)
-    end
-
-    def assert_page_not_tracked_in_ab_test(ab_test_name)
-      meta_tags =
-        acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
-
-      expect(meta_tags).to be_empty,
-        "A/B meta tag is being added to a page which should not be modified by the A/B test"
-    end
+    include AbstractHelpers
+    include RspecAssertions
   end
 end

data/lib/govuk_ab_testing/version.rb

@@ -1,3 +1,3 @@
 module GovukAbTesting
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/govuk_ab_testing.rb

@@ -1,9 +1,12 @@
-require "govuk_ab_testing/version"
+require 'govuk_ab_testing/version'
 require 'govuk_ab_testing/configuration'
-require "govuk_ab_testing/requested_variant"
-require "govuk_ab_testing/ab_test"
-require "govuk_ab_testing/minitest_helpers"
-require "govuk_ab_testing/rspec_helpers"
+require 'govuk_ab_testing/requested_variant'
+require 'govuk_ab_testing/ab_test'
+require 'govuk_ab_testing/minitest_assertions'
+require 'govuk_ab_testing/rspec_assertions'
+require 'govuk_ab_testing/abstract_helpers'
+require 'govuk_ab_testing/minitest_helpers'
+require 'govuk_ab_testing/rspec_helpers'
 require 'govuk_ab_testing/acceptance_tests/meta_tag'
 require 'govuk_ab_testing/acceptance_tests/capybara'
 require 'govuk_ab_testing/acceptance_tests/active_support'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_ab_testing
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -102,12 +102,15 @@ files:
 - govuk_ab_testing.gemspec
 - lib/govuk_ab_testing.rb
 - lib/govuk_ab_testing/ab_test.rb
+- lib/govuk_ab_testing/abstract_helpers.rb
 - lib/govuk_ab_testing/acceptance_tests/active_support.rb
 - lib/govuk_ab_testing/acceptance_tests/capybara.rb
 - lib/govuk_ab_testing/acceptance_tests/meta_tag.rb
 - lib/govuk_ab_testing/configuration.rb
+- lib/govuk_ab_testing/minitest_assertions.rb
 - lib/govuk_ab_testing/minitest_helpers.rb
 - lib/govuk_ab_testing/requested_variant.rb
+- lib/govuk_ab_testing/rspec_assertions.rb
 - lib/govuk_ab_testing/rspec_helpers.rb
 - lib/govuk_ab_testing/version.rb
 homepage: https://github.com/alphagov/govuk_ab_testing