govuk_ab_testing 2.4.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf9c70a0d36f4d97dec173bfc21738a3266700997a1af70cf3e5fac2b654c313
-  data.tar.gz: 7d63ce7fe82da0f11076b29498a6188691ee765bad005805bfecdea1fc022894
+  metadata.gz: 2d473c839937d932bfad0e7dc33673c907f47dedffdf15d1b5bc4bd2d9c61df1
+  data.tar.gz: 4ba58b2b6b499b8b670fff033740d3efb8ce421a0d5f561a58bb4b028968fd36
 SHA512:
-  metadata.gz: 59ca9f4101ddea9d142c492052ceedc08af2a29e35601a25afd6e057e976ab4e7745ca9dac4b27156210122314df78da84ee4d42c84fd09fef32ec56a9017ae7
-  data.tar.gz: 9543b01d05c4e12ed4b8c0c029b3c5ff2e313b283541b47cdef0d2135c5273938d5cdcb5304981320e58a99a2399d92749729f2fc76680bbecfca60c6e938fab
+  metadata.gz: 2e5f893dcd4b96da54646fa5f951f7949f1d3e499cc51fe84b22b3869f281857ca74259ee927a4337a50a34dc50b6ef24460f578ed3af38c26b0c8dde0cad366
+  data.tar.gz: b438372d3a2a309acbe83dde157cd09a5a9f857ddf03ad28009e10cd212cb4034716b831fa87f41c301ee892329f9c5e3f47d8d23eb49dd34e2f3a9135f6b752

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: daily

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+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:
+        ruby: [3.1, 3.2, 3.3]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "All matrix tests have passed 🚀"
+
+  publish:
+    needs: test
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.1.4

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 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
+* Fixed new rubocop violations
+
 ## 2.4.2
 
 * Updated gem dependencies and development ruby version to 2.6.6

data/README.md

@@ -2,9 +2,7 @@
 
 Gem to help with A/B testing on the GOV.UK platform.
 
-## Technical documentation
-
-### Installation
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -16,35 +14,26 @@ And then execute:
 
     $ bundle
 
-### Usage
+## Pre-requisites
 
 Before starting this, you'll need to:
 
-- [read the documentation](https://docs.publishing.service.gov.uk/manual/ab-testing.html) on how to set up an a/b test. The cookie and header name in [fastly-configure](https://github.com/alphagov/fastly-configure) and  [CDN config](https://github.digital.cabinet-office.gov.uk/gds/cdn-configs) must match the test name parameter that you pass to the Gem. The cookie name is case-sensitive.
-- configure Google Analytics (guidelines to follow)
+- [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.
 
-To enable testing in the app, your Rails app needs:
+## Usage
 
-1. Some piece of logic to be A/B tested
-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
+### Outline
 
-Start by defining which acceptance testing framework you will use. This gem
-supports both Capybara and ActiveSupport. In order to configure it, add this to
-your test helper file:
+To enable testing in the app, your Rails app needs:
 
-```
-GovukAbTesting.configure do |config|
-  config.acceptance_test_framework = :capybara # or :active_support
-end
-```
+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 in Google Analytics](#3-add-html-metatag-tags-to-your-layouts)
 
-If we use capybara, the gem expects `page` to be defined in the scope of the
-test cases. If we use ActiveSupport, the gem expects `@request` to be defined in
-the scope of the test cases.
+### 1. Example A/B test logic
 
-Now, let's say you have this controller:
+Let's say you have this controller:
 
 ```ruby
 # app/controllers/party_controller.rb
@@ -52,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'
     )
@@ -75,8 +63,13 @@ 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.
 
-Then, add this to your layouts, so that we have a meta tag that can be picked up
-by the extension and analytics.
+### 2. HTTP response header to Fastly
+
+The `configure_response` method used in the example in `step 1` sends the response header. The header helps Fastly to understand which variant was returned to the user and cache appropriately.
+
+### 3. Add HTML metatag tags to your layouts
+
+This is for the extension and analytics.
 
 ```html
 <!-- application.html.erb -->
@@ -86,11 +79,75 @@ by the extension and analytics.
 ```
 
 The analytics meta tag will include the allowed variants so the extension knows
-which variants to suggest the user.
+which variants to suggest to the user.
 
-#### Test helpers
+## Running the test suite for the gem
 
-##### Minitest
+`bundle exec rake`
+
+## Acceptance testing
+
+Start by defining which acceptance testing framework you will use. This gem
+supports both Capybara and ActiveSupport. In order to configure it, add this to
+your test helper file:
+
+```
+GovukAbTesting.configure do |config|
+  config.acceptance_test_framework = :capybara # or :active_support
+end
+```
+
+If we use capybara, the gem expects `page` to be defined in the scope of the
+test cases. If we use ActiveSupport, the gem expects `@request` to be defined in
+the scope of the test cases.
+
+### Test helpers
+
+#### RSpec
+
+It is also possible to use `with_variant` and all the individual setup and
+assertions steps in RSpec tests. Here is an example of a Capybara feature file:
+
+```ruby
+# spec/features/ab_testing_spec.rb
+feature "Viewing a page with an A/B test" do
+  include GovukAbTesting::RspecHelpers
+
+  scenario "viewing the B version of the page" do
+    with_variant your_ab_test_name: 'B' do
+      visit root_path
+
+      expect(page).to have_breadcrumbs
+      expect(page).to have_beta_label
+    end
+  end
+end
+```
+
+And here is an RSpec controller test:
+
+```ruby
+# spec/controllers/some_controller_spec.rb
+describe SomeController, type :controller do
+  include GovukAbTesting::RspecHelpers
+
+  # RSpec doesn't render views for controller specs by default
+  render_views
+
+  it "should render the B version of the page" do
+    with_variant your_ab_test_name: 'B' do
+      get :index
+    end
+  end
+end
+```
+
+As with the `minitest` version, you can also pass in the following options to
+`with_variant`:
+
+- `assert_meta_tag: false`
+
+#### Minitest
 
 The most common usage of an A/B test is to serve two different variants of the
 same page. In this situation, you can test the controller using `with_variant`.
@@ -140,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
 
@@ -169,71 +226,22 @@ class PartyControllerTest < ActionController::TestCase
 end
 ```
 
-##### RSpec
-
-It is also possible to use `with_variant` and all the individual setup and
-assertions steps in RSpec tests. Here is an example of a Capybara feature file:
-
-```ruby
-# spec/features/ab_testing_spec.rb
-feature "Viewing a page with an A/B test" do
-  include GovukAbTesting::RspecHelpers
-
-  scenario "viewing the B version of the page" do
-    with_variant your_ab_test_name: 'B' do
-      visit root_path
-
-      expect(page).to have_breadcrumbs
-      expect(page).to have_beta_label
-    end
-  end
-end
-```
-
-And here is an RSpec controller test:
-
-```ruby
-# spec/controllers/some_controller_spec.rb
-describe SomeController, type :controller do
-  include GovukAbTesting::RspecHelpers
-
-  # RSpec doesn't render views for controller specs by default
-  render_views
-
-  it "should render the B version of the page" do
-    with_variant your_ab_test_name: 'B' do
-      get :index
-    end
-  end
-end
-```
-
-As with the `minitest` version, you can also pass in the following options to
-`with_variant`:
+## API documentation
 
-- `assert_meta_tag: false`
-- `dimension: <number>`
+See [RubyDoc](http://www.rubydoc.info/gems/govuk_ab_testing) for documentation including all of the assertions for tests.
 
-### Running the test suite
+To run a Yard server locally to preview documentation, run:
 
-`bundle exec rake`
+    $ bundle exec yard server --reload
 
-### Testing in a browser
+## Checking your A/B test in a browser
 
 If you want to test this behaviour in a browser then you should use the
-[GOV.UK Toolkit for Chrome](https://github.com/alphagov/govuk-toolkit-chrome).
+[GOV.UK Toolkit browser extension](https://github.com/alphagov/govuk-browser-extension).
 
 This detects when you have a test running on a page and enables you to choose
 between variants.
 
-### Documentation
-
-See [RubyDoc](http://www.rubydoc.info/gems/govuk_ab_testing) for some limited documentation.
-
-To run a Yard server locally to preview documentation, run:
-
-    $ bundle exec yard server --reload
-
 ## Licence
 
-[MIT License](LICENCE.txt)
+[MIT License](LICENCE)

data/govuk_ab_testing.gemspec

@@ -12,8 +12,9 @@ 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.1"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
@@ -22,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop-govuk"
+  spec.add_development_dependency "rubocop-govuk", "5.0.2"
   spec.add_development_dependency "yard"
 end

data/lib/govuk_ab_testing/ab_test.rb

@@ -1,21 +1,15 @@
 module GovukAbTesting
   class AbTest
-    attr_reader :ab_test_name
-    attr_reader :dimension
-    attr_reader :allowed_variants
-    attr_reader :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
@@ -23,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/configuration.rb

@@ -21,16 +21,14 @@ module GovukAbTesting
     end
 
     def framework_class
-      @framework_class ||= begin
-        case config[:acceptance_test_framework]
-        when :capybara
-          GovukAbTesting::AcceptanceTests::Capybara
-        when :active_support
-          GovukAbTesting::AcceptanceTests::ActiveSupport
-        else
-          raise "Invalid framework #{acceptance_test_framework}"
-        end
-      end
+      @framework_class ||= case config[:acceptance_test_framework]
+                           when :capybara
+                             GovukAbTesting::AcceptanceTests::Capybara
+                           when :active_support
+                             GovukAbTesting::AcceptanceTests::ActiveSupport
+                           else
+                             raise "Invalid framework #{acceptance_test_framework}"
+                           end
     end
   end
 end

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
@@ -63,10 +60,13 @@ module GovukAbTesting
     #
     # @return [String]
     def analytics_meta_tag
-      '<meta name="govuk:ab-test" ' \
-        'content="' + ab_test.meta_tag_name + ":" + variant_name + '" ' \
-        'data-analytics-dimension="' + @dimension.to_s + '" ' \
-        'data-allowed-variants="' + ab_test.allowed_variants.join(",") + '">'
+      tag = <<~HTML
+        <meta name="govuk:ab-test"
+          content="#{ab_test.meta_tag_name}:#{variant_name}"
+          data-allowed-variants="#{ab_test.allowed_variants.join(',')}">
+      HTML
+
+      tag.gsub(/\n/, "")
     end
   end
 end

data/lib/govuk_ab_testing/version.rb

@@ -1,3 +1,3 @@
 module GovukAbTesting
-  VERSION = "2.4.2".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.2
+  version: 3.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -42,16 +42,16 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +73,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
-- Jenkinsfile
-- LICENSE.txt
+- LICENCE
 - README.md
 - Rakefile
 - bin/console
@@ -111,14 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.17
 signing_key: 
 specification_version: 4
 summary: Gem to help with A/B testing on the GOV.UK platform

data/Jenkinsfile

@@ -1,7 +0,0 @@
-#!/usr/bin/env groovy
-
-library("govuk")
-
-node {
-  govuk.buildProject()
-}