govuk_ab_testing 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33722ac9662c30de4c5efa423f8de33da6341a78
-  data.tar.gz: 0c65ef65524a43ee0108e33c2be4599d83550386
+  metadata.gz: '09346724d0fd9301ab185c6b7fab44652aafb5d8'
+  data.tar.gz: d5abd3933fec2bf06c63b37f24aa4f0cb5426af7
 SHA512:
-  metadata.gz: 0b89a6c500a941ec1ff9c099c96be9663b0628bb8df81ef74a107ae561300ba16750047587d1287cf02f0cca78b9a600f475ff2ffcf08b2eaeb79e02d19ac161
-  data.tar.gz: 7ef09915ff51828ad9843a44a8c2f01cb196d5edafe7fb4dcf4e5e86c29a86b09dfb80efdbbb616c7c10305c36cd7729ef748ba162f743fe3974c3f4d9325f2a
+  metadata.gz: 583ec0309596a8c24fb09e0df57f28850bfac7e6a6fffa77ce629cb37f1fa0af0a99384580d90c8889ac69b5c46c54c61a4e937926dab8947592673656ec4f13
+  data.tar.gz: 0ebf9d9b58ac077a245c657d696b314dda92e5d618cc48dfea28881a16fb316d7f23833d0092f232eb526e72038d49b6baf62b355dee7f5f453301afd992b8a4

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.4.1
+
+* Add extra validation to ActiveSupport assertions to help debug test failures.
+  In order to make assertions about the `meta` tags, the view must be rendered
+  in the test. RSpec Rails tests do not do this by default, so you need to call
+  `render_views` explicitly. Without this check, tests fail with a cryptic error
+  message "undefined method 'document' for nil:NilClass".
+
 ## 2.4.0
 
 * Add two new optional parameters to `GovukAbTesting::AbTest`:

data/README.md

@@ -50,12 +50,20 @@ Now, let's say you have this controller:
 # app/controllers/party_controller.rb
 class PartyController < ApplicationController
   def show
-    ab_test = GovukAbTesting::AbTest.new("your_ab_test_name", dimension: 300)
+    ab_test = GovukAbTesting::AbTest.new(
+      "your_ab_test_name",
+      dimension: 300,
+      allowed_variants: ['NoChange', 'LongTitle', 'ShortTitle'],
+      control_variant: 'NoChange'
+    )
     @requested_variant = ab_test.requested_variant(request.headers)
     @requested_variant.configure_response(response)
 
-    if @requested_variant.variant?('B')
-      render "new_show_template_to_be_tested"
+    case true
+    when @requested_variant.variant?('LongTitle')
+      render "show_template_with_long_title"
+    when @requested_variant.variant?('ShortTitle')
+      render "show_template_with_short_title"
     else
       render "show"
     end
@@ -63,7 +71,11 @@ class PartyController < ApplicationController
 end
 ```
 
-Add this to your layouts, so that we have a meta tag that can be picked up
+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.
 
 ```html
@@ -73,6 +85,9 @@ by the extension and analytics.
 </head>
 ```
 
+The analytics meta tag will include the allowed variants so the extension knows
+which variants to suggest the user.
+
 #### Test helpers
 
 ##### Minitest
@@ -157,7 +172,7 @@ 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 spec file:
+assertions steps in RSpec tests. Here is an example of a Capybara feature file:
 
 ```ruby
 # spec/features/ab_testing_spec.rb
@@ -175,18 +190,30 @@ feature "Viewing a page with an A/B test" do
 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`
 - `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/acceptance_tests/active_support.rb

@@ -34,6 +34,11 @@ module GovukAbTesting
       end
 
       def analytics_meta_tags
+        if scope.response.body.empty?
+          raise "Cannot find response body. If this is an RSpec Rails test, " +
+            "check that 'render_views' is being called."
+        end
+
         tags = scope.css_select(ANALYTICS_META_TAG_SELECTOR)
 
         tags.map do |tag|

data/lib/govuk_ab_testing/version.rb

@@ -1,3 +1,3 @@
 module GovukAbTesting
-  VERSION = "2.4.0".freeze
+  VERSION = "2.4.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_ab_testing
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Gem to help with A/B testing on the GOV.UK platform