govuk_ab_testing 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fd5d31f02d60fa9d23dc37c87747ad8ad3dfb4a
-  data.tar.gz: 0f3521e417baebb222969d59b3214d4ca094c88c
+  metadata.gz: 74c9eed0d845a4d1139c618e74bbc6cab109f2c6
+  data.tar.gz: bca89588653315d83e4a3a8387695685bd21558d
 SHA512:
-  metadata.gz: 2b11005c795f0f63ec5a4b9443448b4952355a167ef21cb7f3d27671016cdb6cf011a8748bc587b362d1d5553b8abe83adf8f323bfbc80198dbaef51b4f40fed
-  data.tar.gz: 65b2c4e8462261800bcb707983853b104b5cf9fa53fbbdc5f85a63d6f4af02e24dfcba7ab20cf5346064b20446bb47383845f48960b198832ec9256d60e3739d
+  metadata.gz: 694cddcacc3320548b0d558dfc7b10dd5f14f4dabc559e2edc006e14e33ce718acdaa7b4bc8c0db859ffaf3bcb78f8d71bc67e6b4ddcc79c88da33e59e7ba8a8
+  data.tar.gz: f9a25ff78213c7012fd5ef5e5145b3ff3db28fa8b34f0e89b9654560bb5b60a789a0fc4cc309f49a0549a68ff4d02e5cd558716d0bdafc11ea47918e30df2e5f

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.0
+
+* Pass in request headers instead of the actual request to RequestedVariant.
+  This is a breaking change.
+* Slit testing framework helpers from acceptance test frameworks. This means we
+  can now use a combination of RSpec/Minitest and Capybara/ActiveSupport test
+  cases.
+
 ## 0.2.0
 
 * Include RSpec + Capybara helper class

data/README.md

@@ -33,7 +33,21 @@ To enable testing in the app, your Rails app needs:
 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:
+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.
+
+Now, let's say you have this controller:
 
 ```ruby
 # app/controllers/party_controller.rb
@@ -123,15 +137,15 @@ class PartyControllerTest < ActionController::TestCase
 end
 ```
 
-##### RSpec + Capybara
+##### RSpec
 
-It is also possible to use `with_variant` in RSpec tests that use Capybara. Here
-is an example of a spec file:
+It is also possible to use `with_variant` in RSpec tests. Here is an example of
+a spec file:
 
 ```ruby
 # spec/features/ab_testing_spec.rb
 feature "Viewing a page with an A/B test" do
-  include GovukAbTesting::RspecCapybaraHelpers
+  include GovukAbTesting::RspecHelpers
 
   scenario "viewing the B version of the page" do
     with_variant your_ab_test_name: 'B' do
@@ -144,15 +158,18 @@ feature "Viewing a page with an A/B test" do
 end
 ```
 
-Please note that `with_variant` in `GovukAbTesting::RspecCapybaraHelpers`
-expects both `page` (Capybara session) and RSpec expectations to be available.
-
 As with the `minitest` version, you can also pass in the following options to
 `with_variant`:
 
 - `assert_meta_tag: false`
 - `dimension: <number>`
 
+### Current limitations
+
+This library assumes we are only using one A/B test per page. The acceptance
+test classes look for only one analytics' meta tag and will fail in the presence
+of more than one.
+
 ### Running the test suite
 
 `bundle exec rake`

data/lib/govuk_ab_testing/ab_test.rb

@@ -10,10 +10,10 @@ module GovukAbTesting
       @dimension = dimension
     end
 
-    # @param request [ApplicationController::Request] the `request` in the
-    # controller.
-    def requested_variant(request)
-      RequestedVariant.new(self, request, @dimension)
+    # @param request [ActionDispatch::Http::Headers] the `request.headers` in
+    # the controller.
+    def requested_variant(request_headers)
+      RequestedVariant.new(self, request_headers, @dimension)
     end
 
     # Internal name of the header

data/lib/govuk_ab_testing/acceptance_tests/active_support.rb

@@ -0,0 +1,41 @@
+module GovukAbTesting
+  module AcceptanceTests
+    class ActiveSupport
+      attr_reader :request, :request_headers, :scope
+
+      def initialize(scope)
+        @request = scope.instance_variable_get(:@request)
+        if @request.nil?
+          raise "Couldn't find '@request' defined, are you using ActiveSupport test cases?"
+        end
+        @scope = scope
+        @request_headers = {}
+      end
+
+      def set_header(name, value)
+        request.headers[name] = value
+        @request_headers[name] = value
+      end
+
+      def vary_header(response)
+        response.headers['Vary']
+      end
+
+      def analytics_meta_tags
+        @analytics_meta_tags ||= scope.css_select(ANALYTICS_META_TAG_SELECTOR)
+      end
+
+      def analytics_meta_tag
+        analytics_meta_tags.first
+      end
+
+      def content
+        analytics_meta_tag.attributes['content'].value
+      end
+
+      def dimension
+        analytics_meta_tag.attributes['data-analytics-dimension'].value
+      end
+    end
+  end
+end

data/lib/govuk_ab_testing/acceptance_tests/capybara.rb

@@ -0,0 +1,46 @@
+module GovukAbTesting
+  module AcceptanceTests
+    class Capybara
+      attr_reader :capybara_page, :request_headers
+
+      def initialize(scope)
+        unless scope.respond_to?(:page)
+          raise "Page is not defined, are you using capybara?"
+        end
+        @capybara_page = scope.page
+        @request_headers = {}
+      end
+
+      def request
+        @capybara_page
+      end
+
+      def set_header(name, value)
+        capybara_page.driver.options[:headers] = { name => value }
+        capybara_page.driver.header(name, value)
+        @request_headers[name] = value
+      end
+
+      def vary_header(*)
+        capybara_page.response_headers['Vary']
+      end
+
+      def analytics_meta_tags
+        @analytics_meta_tags ||=
+          capybara_page.all(ANALYTICS_META_TAG_SELECTOR, visible: :all)
+      end
+
+      def analytics_meta_tag
+        analytics_meta_tags.first
+      end
+
+      def content
+        analytics_meta_tag['content']
+      end
+
+      def dimension
+        analytics_meta_tag['data-analytics-dimension']
+      end
+    end
+  end
+end

data/lib/govuk_ab_testing/configuration.rb

@@ -0,0 +1,36 @@
+module GovukAbTesting
+  class Configuration
+    VALID_FRAMEWORKS = %i(capybara active_support).freeze
+    attr_accessor :config, :acceptance_test_framework
+
+    def initialize
+      @config = {}
+    end
+
+    def acceptance_test_framework
+      config[:acceptance_test_framework]
+    end
+
+    def acceptance_test_framework=(framework)
+      unless VALID_FRAMEWORKS.include?(framework)
+        raise "Invalid acceptance test framework '#{framework}'"
+      end
+
+      config[:acceptance_test_framework] = framework
+      @framework_class = nil
+    end
+
+    def framework_class
+      @framework_class ||= begin
+        case config[:acceptance_test_framework]
+        when :capybara
+          then GovukAbTesting::AcceptanceTests::Capybara
+        when :active_support
+          then GovukAbTesting::AcceptanceTests::ActiveSupport
+        else
+          raise "Invalid framework #{acceptance_test_framework}"
+        end
+      end
+    end
+  end
+end

data/lib/govuk_ab_testing/minitest_helpers.rb

@@ -1,5 +1,10 @@
 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]
@@ -7,29 +12,28 @@ module GovukAbTesting
       ab_test =
         GovukAbTesting::AbTest.new(ab_test_name.to_s, dimension: dimension)
 
-      @request.headers[ab_test.request_header] = variant
-      requested_variant = ab_test.requested_variant(@request)
+      acceptance_test_framework.set_header(ab_test.request_header, variant)
+      requested_variant = ab_test.requested_variant(acceptance_test_framework.request_headers)
 
       yield
 
-      assert_match ab_test.response_header, response.headers['Vary'],
+      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 = css_select("meta[name='govuk:ab-test']")
+        meta_tags = acceptance_test_framework.analytics_meta_tags
 
         assert_equal(1, meta_tags.count, message)
 
-        meta_tag = meta_tags.first
-        content_value = meta_tag.attributes['content'].value
-        dimension_value = meta_tag.attributes['data-analytics-dimension'].value
+        dimension_value = acceptance_test_framework.dimension
 
         assert_equal(
           expected_content,
-          content_value,
+          acceptance_test_framework.content,
           "Meta tag's content doesn't match."
         )
 
@@ -48,7 +52,7 @@ module GovukAbTesting
     def setup_ab_variant(ab_test_name, variant, dimension = 300)
       ab_test = GovukAbTesting::AbTest.new(ab_test_name, dimension: dimension)
 
-      @request.headers[ab_test.request_header] = variant
+      acceptance_test_framework.set_header(ab_test.request_header, variant)
     end
 
     def assert_response_not_modified_for_ab_test

data/lib/govuk_ab_testing/requested_variant.rb

@@ -1,15 +1,15 @@
 module GovukAbTesting
   class RequestedVariant
-    attr_reader :ab_test, :request
+    attr_reader :ab_test, :request_headers
 
     # @param ab_test [AbTest] the A/B test being performed
-    # @param request [ApplicationController::Request] the `request` in the
-    # controller.
+    # @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, dimension)
+    def initialize(ab_test, request_headers, dimension)
       @ab_test = ab_test
-      @request = request
+      @request_headers = request_headers
       @dimension = dimension
     end
 
@@ -17,7 +17,7 @@ module GovukAbTesting
     #
     # @return [String] the current variant, "A" or "B"
     def variant_name
-      request.headers[ab_test.request_header] == "B" ? "B" : "A"
+      request_headers[ab_test.request_header] == "B" ? "B" : "A"
     end
 
     # @return [Boolean] if the user is to be served variant A

data/lib/govuk_ab_testing/rspec_helpers.rb

@@ -0,0 +1,40 @@
+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
+
+        expect(ab_test_metatags.count).to eq(1)
+
+        expect(acceptance_test_framework.content).to eq(content)
+        dimension = acceptance_test_framework.dimension
+
+        if dimension.nil?
+          expect(dimension).to_not be_nil
+        else
+          expect(dimension).to eq(dimension.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/govuk_ab_testing/version.rb

@@ -1,3 +1,3 @@
 module GovukAbTesting
-  VERSION = "0.2.0".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/govuk_ab_testing.rb

@@ -1,8 +1,20 @@
 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_capybara_helpers"
+require "govuk_ab_testing/rspec_helpers"
+require 'govuk_ab_testing/acceptance_tests/capybara'
+require 'govuk_ab_testing/acceptance_tests/active_support'
 
 module GovukAbTesting
+  ANALYTICS_META_TAG_SELECTOR = "meta[name='govuk:ab-test']".freeze
+
+  def self.configuration
+    @configuration ||= GovukAbTesting::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_ab_testing
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -102,9 +102,12 @@ files:
 - govuk_ab_testing.gemspec
 - lib/govuk_ab_testing.rb
 - lib/govuk_ab_testing/ab_test.rb
+- lib/govuk_ab_testing/acceptance_tests/active_support.rb
+- lib/govuk_ab_testing/acceptance_tests/capybara.rb
+- lib/govuk_ab_testing/configuration.rb
 - lib/govuk_ab_testing/minitest_helpers.rb
 - lib/govuk_ab_testing/requested_variant.rb
-- lib/govuk_ab_testing/rspec_capybara_helpers.rb
+- lib/govuk_ab_testing/rspec_helpers.rb
 - lib/govuk_ab_testing/version.rb
 homepage: https://github.com/alphagov/govuk_ab_testing
 licenses:

data/lib/govuk_ab_testing/rspec_capybara_helpers.rb

@@ -1,33 +0,0 @@
-module GovukAbTesting
-  module RspecCapybaraHelpers
-    def with_variant(args)
-      unless defined?(page)
-        raise "The variable 'page' is not defined, are you using capybara?"
-      end
-
-      ab_test_name, variant = args.first
-      dimension = args[:dimension]
-      ab_test =
-        GovukAbTesting::AbTest.new(ab_test_name.to_s, dimension: dimension)
-
-      page.driver.header(ab_test.response_header, variant)
-
-      yield
-
-      expect(ab_test.response_header).to eq(page.response_headers['Vary'])
-
-      unless args[:assert_meta_tag] == false
-        content = [ab_test.meta_tag_name, variant].join(':')
-        ab_test_metatag = page.find("meta[name='govuk:ab-test']", visible: :all)
-
-        expect(ab_test_metatag['content']).to eq(content)
-
-        if dimension.nil?
-          expect(ab_test_metatag['data-analytics-dimension']).to_not be_nil
-        else
-          expect(ab_test_metatag['data-analytics-dimension']).to eq(dimension.to_s)
-        end
-      end
-    end
-  end
-end