govuk_publishing_components 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c89ac97d233cfea87960f74561b440b7b512f4f5
-  data.tar.gz: 8eead0093c99748abd32686edd8e7f664f8485d4
+  metadata.gz: d524eeb4db7af24131c3a967c345480f17bae8f8
+  data.tar.gz: ea47e54e89299120ba9937a4eca6b755ee62cd01
 SHA512:
-  metadata.gz: 605d6cab7fa68c8257bad9e133f95ce3e4050a3bf66729bfe60caa281947b876a5a9a79cb0bd96d792075c7746ab8fb2a8b5feb7343f5c145f488e6f6fcb55e8
-  data.tar.gz: 3c563b212ffa0a53cda59aba21e4873e1a2c18476b98ab103237ebc150844272749786bbc71b8a1e0d1f0aee248d026e15279529fb38524c1fa1babc5f569bfb
+  metadata.gz: 5bc0d5d9614e4d71c2713476c2f45b836726a53937bb980c4e331c0deb87b44f68afb6eb065e71163900e2a7bc25cbc4630326c22e9adc56c72e3b362d9b9095
+  data.tar.gz: fe56d2ec25a0eea3e897c84cae9509fc99a6467e3559c34c64bb21ee87cfbd944f3eec86f3a288b56a374bc132a906c8ca8efb15fa3a14d7cb225f3af2d8f8f0

data/README.md

@@ -27,6 +27,23 @@ https://government-frontend.herokuapp.com/component-guide
 
 The guide includes your application’s `application.scss` and `application.js` files by default. This is [configurable](#configuration).
 
+## Test the component guide
+
+The gem [includes integration tests](lib/govuk_publishing_components/minitest/component_guide_test.rb) to check that your component guide and examples are error free and that they meet basic accessibility needs.
+
+Automated accessibility tests use [aXe](https://github.com/dequelabs/axe-core). Using our `AccessibilityTest` wrapper the gem runs the aXe suite against each example and throws JavaScript errors for any violations. These JavaScript errors can be used to fail a build in CI.
+
+### Minitest
+
+```ruby
+# component_guide_test.rb
+require 'govuk_publishing_components/minitest/component_guide_test'
+
+class ComponentGuideTest < ActionDispatch::IntegrationTest
+  include GovukPublishingComponents::Minitest::ComponentGuideTest
+end
+```
+
 ### Install gem
 
 Add this line to your application's Gemfile in the [development and test groups](http://bundler.io/v1.12/groups.html#grouping-your-dependencies):

data/lib/govuk_publishing_components/minitest/component_guide_test.rb

@@ -0,0 +1,23 @@
+module GovukPublishingComponents
+  module Minitest
+    module ComponentGuideTest
+      extend ActiveSupport::Concern
+
+      included do
+        test "renders all component guide preview pages without erroring" do
+          visit '/component-guide'
+
+          # Confirm accessibility JS test is available
+          assert_equal 'function', evaluate_script('typeof window.GOVUK.AccessibilityTest'), "AccessibilityTest JavaScript isn’t available"
+          assert_equal 'string', evaluate_script('typeof window.axe.version'), "aXe accessibility test library isn’t available"
+
+          all(:css, '.component-list a').map { |el| "#{el[:href]}/preview" }.each do |component|
+            visit component
+            assert page.has_css?(".js-test-a11y-finished"), "Accessibility test did not run on #{component}"
+            assert page.has_css?(".js-test-a11y-success"), "Accessibility test found violations on #{component}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '1.7.0'.freeze
+  VERSION = '1.8.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -205,6 +205,7 @@ files:
 - lib/govuk_publishing_components.rb
 - lib/govuk_publishing_components/config.rb
 - lib/govuk_publishing_components/engine.rb
+- lib/govuk_publishing_components/minitest/component_guide_test.rb
 - lib/govuk_publishing_components/version.rb
 - lib/tasks/govuk_publishing_components_tasks.rake
 homepage: https://github.com/alphagov/govuk_publishing_components