govuk_ab_testing 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b853a7e8fbdf08a5b6ee28c3b670e329fe7db86
-  data.tar.gz: 8fb1463ede612931504805e6623798b473b806f9
+  metadata.gz: 3fd5d31f02d60fa9d23dc37c87747ad8ad3dfb4a
+  data.tar.gz: 0f3521e417baebb222969d59b3214d4ca094c88c
 SHA512:
-  metadata.gz: 35a7f5be723f8941346bab0f6a9c610b6634b342c8bf69f342e8c33282d4225861d8c1cb75e029f531cd305f451b8d6fcee65903c480457441dfdd680de491d3
-  data.tar.gz: 5f1f4741da3ad9f0f852df037ba7c6b4d59c4fbc3fc0a20af128751a4b03078b14d1acbb4a9698760e60f1e2f53b57b44adfd9a908934d0260ec4abf6d241914
+  metadata.gz: 2b11005c795f0f63ec5a4b9443448b4952355a167ef21cb7f3d27671016cdb6cf011a8748bc587b362d1d5553b8abe83adf8f323bfbc80198dbaef51b4f40fed
+  data.tar.gz: 65b2c4e8462261800bcb707983853b104b5cf9fa53fbbdc5f85a63d6f4af02e24dfcba7ab20cf5346064b20446bb47383845f48960b198832ec9256d60e3739d

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.2.0
+
+* Include RSpec + Capybara helper class
+* Test custom dimensions on all helper classes

data/Jenkinsfile

@@ -1,5 +1,7 @@
 #!/usr/bin/env groovy
 
+REPOSITORY = 'govuk_ab_testing'
+
 node {
   def govuk = load '/var/lib/jenkins/groovy_scripts/govuk_jenkinslib.groovy'
 
@@ -23,13 +25,12 @@ node {
     }
 
     stage('Tests') {
-      govuk.setEnvar('RAILS_ENV', 'test')
       govuk.runTests()
     }
 
     if(env.BRANCH_NAME == "master") {
       stage('Publish Gem') {
-        govuk.runRakeTask("publish_gem --trace")
+        govuk.publishGem(REPOSITORY, env.BRANCH_NAME)
       }
     }
 

data/README.md

@@ -64,6 +64,8 @@ by the extension and analytics.
 
 #### Test helpers
 
+##### 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`.
 It will configure the request and assert that the response is configured
@@ -121,6 +123,36 @@ class PartyControllerTest < ActionController::TestCase
 end
 ```
 
+##### RSpec + Capybara
+
+It is also possible to use `with_variant` in RSpec tests that use Capybara. 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
+
+  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
+```
+
+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>`
+
 ### Running the test suite
 
 `bundle exec rake`

data/lib/govuk_ab_testing/minitest_helpers.rb

@@ -2,8 +2,10 @@ module GovukAbTesting
   module MinitestHelpers
     def with_variant(args)
       ab_test_name, variant = args.first
+      dimension = args[:dimension]
 
-      ab_test = GovukAbTesting::AbTest.new(ab_test_name.to_s, dimension: args[:dimension])
+      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)
@@ -14,9 +16,32 @@ module GovukAbTesting
         "You probably forgot to use `configure_response`"
 
       unless args[:assert_meta_tag] == false
-        content = ab_test.meta_tag_name + ':' + requested_variant.variant_name
+        expected_content =
+          ab_test.meta_tag_name + ':' + requested_variant.variant_name
         message = "You probably forgot to add the `analytics_meta_tag` to the views"
-        assert_select "meta[name='govuk:ab-test'][content='#{content}']", 1, message
+        meta_tags = css_select("meta[name='govuk:ab-test']")
+
+        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
+
+        assert_equal(
+          expected_content,
+          content_value,
+          "Meta tag's content doesn't match."
+        )
+
+        if dimension.nil?
+          assert(dimension_value, "No custom dimension number found")
+        else
+          assert_equal(
+            dimension.to_s,
+            dimension_value,
+            "The custom dimension found in meta tag doesn't match"
+          )
+        end
       end
     end
 

data/lib/govuk_ab_testing/rspec_capybara_helpers.rb

@@ -0,0 +1,33 @@
+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

data/lib/govuk_ab_testing/version.rb

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

data/lib/govuk_ab_testing.rb

@@ -2,6 +2,7 @@ require "govuk_ab_testing/version"
 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"
 
 module GovukAbTesting
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_ab_testing
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,6 +104,7 @@ files:
 - lib/govuk_ab_testing/ab_test.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/version.rb
 homepage: https://github.com/alphagov/govuk_ab_testing
 licenses: