govuk_ab_testing 2.4.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a292ccc01842df0545f9ddfeec92414895271e6127c1cd9905ea30a152f3f58
-  data.tar.gz: 75d28b74e22e0efa9137e7e033daebafd697012fd9f2f17a876fc40c4ef3e66c
+  metadata.gz: 2d473c839937d932bfad0e7dc33673c907f47dedffdf15d1b5bc4bd2d9c61df1
+  data.tar.gz: 4ba58b2b6b499b8b670fff033740d3efb8ce421a0d5f561a58bb4b028968fd36
 SHA512:
-  metadata.gz: 0d88b6a20a1c3ffae1bc55abb2deba0cfeec443a12c8d0adad615475de3b889c3ec502bb8bdef5d49fff548cef4bc7bf56eaf826d11322d7a4a554dd8b92c9c2
-  data.tar.gz: e7d98c27fa20cde80ea0ddfbe28be2f9274a6a668257b2cc266387e0db12b1a374b1dbecff1826cceb1bfd9e8aa38386a243c7437bae3eb1d4b31a32b9112525
+  metadata.gz: 2e5f893dcd4b96da54646fa5f951f7949f1d3e499cc51fe84b22b3869f281857ca74259ee927a4337a50a34dc50b6ef24460f578ed3af38c26b0c8dde0cad366
+  data.tar.gz: b438372d3a2a309acbe83dde157cd09a5a9f857ddf03ad28009e10cd212cb4034716b831fa87f41c301ee892329f9c5e3f47d8d23eb49dd34e2f3a9135f6b752

data/.github/workflows/ci.yml

@@ -1,16 +1,25 @@
 on: [push, pull_request]
 
 jobs:
+  codeql-sast:
+    name: CodeQL SAST scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main
+    permissions:
+      security-events: write
+
+  dependency-review:
+    name: Dependency Review scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/dependency-review.yml@main
+  
   # This matrix job runs the test suite against multiple Ruby versions
   test_matrix:
     strategy:
       fail-fast: false
       matrix:
-        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: ['3.0', 3.1, 3.2]
+        ruby: [3.1, 3.2, 3.3]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.ruby-version

@@ -1 +1 @@
-3.0.5
+3.1.4

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.0.0
+
+* Drop support for Ruby 3.0. The minimum required Ruby version is now 3.1
+* **BREAKING CHANGE** No longer allow a GA custom dimension to be passed
+  when creating a GovukAbTesting::AbTest object. The dimension parameter
+  needs to be removed.
+
 ## 2.4.3
 
 * Updated gem dependencies and development ruby version to 3.0.5

data/README.md

@@ -18,19 +18,18 @@ And then execute:
 
 Before starting this, you'll need to:
 
-- [Read the documentation](https://docs.publishing.service.gov.uk/manual/ab-testing.html) for an overview on how a/b testing works on GOV.UK. 
+- [Read the documentation](https://docs.publishing.service.gov.uk/manual/ab-testing.html) for an overview on how a/b testing works on GOV.UK.
 - The cookie and header name in [govuk-cdn-config](https://github.com/alphagov/govuk-cdn-config/blob/master/ab_tests/ab_tests.yaml) must match the test name parameter that you pass to the Gem. The cookie name is case-sensitive.
 
 ## Usage
 
-### Outline 
+### Outline
 
 To enable testing in the app, your Rails app needs:
 
 1. [Some piece of logic to be A/B tested](#1-example-ab-test-logic)
 2. [A response HTTP header that tells Fastly you're doing an A/B test](#2-http-response-header-to-fastly)
-3. [A HTML meta tag that will be used to measure the results, and which specifies
-   the dimension to use in Google Analytics](#3-add-html-metatag-tags-to-your-layouts)
+3. [A HTML meta tag that will be used to measure the results in Google Analytics](#3-add-html-metatag-tags-to-your-layouts)
 
 ### 1. Example A/B test logic
 
@@ -42,7 +41,6 @@ class PartyController < ApplicationController
   def show
     ab_test = GovukAbTesting::AbTest.new(
       "your_ab_test_name",
-      dimension: 300,
       allowed_variants: ['NoChange', 'LongTitle', 'ShortTitle'],
       control_variant: 'NoChange'
     )
@@ -63,7 +61,7 @@ end
 
 In this example, we are running a multivariate test with 3 options being
 tested: the existing version (control), and two title changes. The minimum
-number of variants in any test should be two. 
+number of variants in any test should be two.
 
 ### 2. HTTP response header to Fastly
 
@@ -148,7 +146,6 @@ As with the `minitest` version, you can also pass in the following options to
 `with_variant`:
 
 - `assert_meta_tag: false`
-- `dimension: <number>`
 
 #### Minitest
 
@@ -200,7 +197,7 @@ class PartyControllerTest < ActionController::TestCase
   include GovukAbTesting::MinitestHelpers
 
   should "show the original" do
-    setup_ab_variant("your_ab_test_name", "B") # optionally pass in a analytics dimension as the third argument
+    setup_ab_variant("your_ab_test_name", "B")
 
     get :show
 

data/govuk_ab_testing.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Gem to help with A/B testing on the GOV.UK platform"
   spec.homepage      = "https://github.com/alphagov/govuk_ab_testing"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop-govuk", "4.10.0"
+  spec.add_development_dependency "rubocop-govuk", "5.0.2"
   spec.add_development_dependency "yard"
 end

data/lib/govuk_ab_testing/ab_test.rb

@@ -1,18 +1,15 @@
 module GovukAbTesting
   class AbTest
-    attr_reader :ab_test_name, :dimension, :allowed_variants, :control_variant
+    attr_reader :ab_test_name, :allowed_variants, :control_variant
 
     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
-    # for this specific A/B test
     # @param allowed_variants [Array] an array of Strings representing the
     # possible variants
     # @param control_variant [String] the control variant (typically 'A')
-    def initialize(ab_test_name, dimension:, allowed_variants: %w[A B], control_variant: "A")
+    def initialize(ab_test_name, allowed_variants: %w[A B], control_variant: "A")
       @ab_test_name = ab_test_name
-      @dimension = dimension
       @allowed_variants = allowed_variants
       @control_variant = control_variant
     end
@@ -20,7 +17,7 @@ module GovukAbTesting
     # @param request [ActionDispatch::Http::Headers] the `request.headers` in
     # the controller.
     def requested_variant(request_headers)
-      RequestedVariant.new(self, request_headers, @dimension)
+      RequestedVariant.new(self, request_headers)
     end
 
     # Internal name of the header

data/lib/govuk_ab_testing/abstract_helpers.rb

@@ -6,26 +6,25 @@ module GovukAbTesting
 
     def with_variant(args)
       ab_test_name, variant = args.first
-      dimension = args[:dimension]
 
-      setup_ab_variant(ab_test_name, variant, dimension)
+      setup_ab_variant(ab_test_name, variant)
 
       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)
+        assert_page_tracked_in_ab_test(ab_test_name, variant)
       end
     end
 
-    def setup_ab_variant(ab_test_name, variant, dimension = 300)
-      ab_test = AbTest.new(ab_test_name, dimension: dimension)
+    def setup_ab_variant(ab_test_name, variant)
+      ab_test = AbTest.new(ab_test_name)
       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)
+      ab_test = AbTest.new(ab_test_name)
       vary_header_value = acceptance_test_framework.vary_header
 
       assert_contains_substring(
@@ -72,8 +71,8 @@ module GovukAbTesting
       )
     end
 
-    def assert_page_tracked_in_ab_test(ab_test_name, variant, dimension)
-      ab_test = AbTest.new(ab_test_name, dimension: dimension)
+    def assert_page_tracked_in_ab_test(ab_test_name, variant)
+      ab_test = AbTest.new(ab_test_name)
 
       ab_test_meta_tags =
         acceptance_test_framework.analytics_meta_tags_for_test(ab_test.name)
@@ -104,23 +103,6 @@ module GovukAbTesting
 
         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

@@ -44,7 +44,6 @@ module GovukAbTesting
         tags.map do |tag|
           MetaTag.new(
             content: tag.attributes["content"].value,
-            dimension: tag.attributes["data-analytics-dimension"].value,
           )
         end
       end

data/lib/govuk_ab_testing/acceptance_tests/capybara.rb

@@ -37,7 +37,6 @@ module GovukAbTesting
         tags.map do |tag|
           MetaTag.new(
             content: tag["content"],
-            dimension: tag["data-analytics-dimension"],
           )
         end
       end

data/lib/govuk_ab_testing/acceptance_tests/meta_tag.rb

@@ -1,11 +1,10 @@
 module GovukAbTesting
   module AcceptanceTests
     class MetaTag
-      attr_reader :content, :dimension
+      attr_reader :content
 
-      def initialize(content:, dimension:)
+      def initialize(content:)
         @content = content
-        @dimension = dimension
       end
 
       def for_ab_test?(ab_test_name)

data/lib/govuk_ab_testing/minitest_assertions.rb

@@ -17,7 +17,7 @@ module GovukAbTesting
     end
 
     def assert_is_empty(enumerable:, error_message:)
-      assert_has_size(enumerable: enumerable, size: 0, error_message: error_message)
+      assert_has_size(enumerable:, size: 0, error_message:)
     end
 
     def assert_not_blank(string:, error_message:)

data/lib/govuk_ab_testing/requested_variant.rb

@@ -5,12 +5,9 @@ module GovukAbTesting
     # @param ab_test [AbTest] the A/B test being performed
     # @param request_headers [ActionDispatch::Http::Headers] the
     # `request.headers` in the controller.
-    # @param dimension [Integer] the dimension registered with Google Analytics
-    # for this specific A/B test
-    def initialize(ab_test, request_headers, dimension)
+    def initialize(ab_test, request_headers)
       @ab_test = ab_test
       @request_headers = request_headers
-      @dimension = dimension
     end
 
     # Get the bucket this user is in
@@ -66,7 +63,6 @@ module GovukAbTesting
       tag = <<~HTML
         <meta name="govuk:ab-test"
           content="#{ab_test.meta_tag_name}:#{variant_name}"
-          data-analytics-dimension="#{@dimension}"
           data-allowed-variants="#{ab_test.allowed_variants.join(',')}">
       HTML
 

data/lib/govuk_ab_testing/version.rb

@@ -1,3 +1,3 @@
 module GovukAbTesting
-  VERSION = "2.4.3".freeze
+  VERSION = "3.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_ab_testing
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 3.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.10.0
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.10.0
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.5.17
 signing_key: 
 specification_version: 4
 summary: Gem to help with A/B testing on the GOV.UK platform