govuk_publishing_components 1.12.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dfd2d6f3dd09f61826bb8efa761a6967c2f38c3
-  data.tar.gz: 6701db53f1595abf1a985288ebb40b50d4eca892
+  metadata.gz: e4dc58d36544b1596c32214fd0f900a58e3f9eca
+  data.tar.gz: 3c758cf643c55aed354257f7ff90bea0bb2ec3ba
 SHA512:
-  metadata.gz: 231cdf8a06f6a0cfdad9cac0472bd67bb1af5360ff408f5371094c75d874726a2fefdcf902c053a623b7c83e6789b403f033c418d97bff30af248c160055a493
-  data.tar.gz: 56a0713b941833ea54d0b84d07865e4a7ba48cdbc339ab31d298d730aabcced4f9bb4a55513c7972257d6cffc26b0be9de3011a90103155b691fcf576cf02940
+  metadata.gz: a88f615ce939922932f1e09a7e11dca0c314263a0cf5f28b75eb99cf98746119ea6537819de7c96284373e5d30f52b3d70ca4e66c2772a59b84a1f4f3981080f
+  data.tar.gz: d5ed207ce42a0c003d499e9b806a521ccd23f75b71ef400f43515d2841e8ec4ae6e89d8d80caed66f2e78c7cfb97b664f5f69f785b1efe97e551991c91392dbc

data/README.md

@@ -112,6 +112,15 @@ class ComponentGuideTest < ActionDispatch::IntegrationTest
 end
 ```
 
+### Exclude accessibility rules
+
+Sometimes you will have a component that will throw an error due to it being in isolation, for example radio buttons not being in a fieldset.
+
+For this case you can add `accessibility_excluded_rules` to your components' documentation yml file with the rules you want to exclude. These rules can be found in brackets in the error messages displayed.
+
+For an example of this check [test/.../docs/test-component-with-duplicate-ids.yml](test/dummy/app/views/components/docs/test-component-with-duplicate-ids.yml)
+
+
 ## Component generator
 
 The gem includes a component generator to stub the minimal files required for a component.

data/Rakefile

@@ -18,14 +18,19 @@ end
 
 namespace :assets do
   desc "Test precompiling assets through dummy application"
-
   task :precompile do
     Rake::Task['app:assets:precompile'].invoke
   end
 
+  desc "Test cleaning assets through dummy application"
   task :clean do
     Rake::Task['app:assets:clean'].invoke
   end
+
+  desc "Test clobbering assets through dummy application"
+  task :clobber do
+    Rake::Task['app:assets:clobber'].invoke
+  end
 end
 
 task default: [:spec, 'app:jasmine:ci']

data/app/assets/javascripts/govuk_publishing_components/accessibility-test.js

@@ -6,18 +6,25 @@
       return
     }
 
-    if (!document.querySelector(selector)) {
+    var element = document.querySelector(selector)
+
+    if (!element) {
       return callback()
     }
 
+    var dataDisabledRules = element.getAttribute('data-excluded-rules')
+    var disabledRules = dataDisabledRules ? JSON.parse(dataDisabledRules) : []
+
+    var axeRules = {}
+
+    disabledRules.forEach(function (rule) {
+      axeRules[rule] = { enabled: false }
+    })
+
     var axeOptions = {
       restoreScroll: true,
       include: [selector],
-      rules: {
-        "duplicate-id": {
-          enabled: false
-        }
-      }
+      rules: axeRules
     }
 
     // TODO: Remove when aXe core patched
@@ -50,7 +57,7 @@
         '\n' + 'Accessibility issues at ' +
         url + '\n\n' +
         violations.map(function (violation) {
-          var help = 'Problem: ' + violation.help
+          var help = 'Problem: ' + violation.help + ' (' + violation.id + ')'
           var helpUrl = 'Try fixing it with this help: ' + _formatHelpUrl(violation.helpUrl)
           var htmlAndTarget = violation.nodes.map(_renderNode).join('\n\n')
 
@@ -84,6 +91,7 @@
                           }
                         })
       return {
+        'id': result.id,
         'summary': result.help,
         'selectors': cssSelector,
         'url': _formatHelpUrl(result.helpUrl)
@@ -125,7 +133,7 @@
         var wrapper = activeElParent.querySelector(resultContainerSelector)
 
         if (wrapper) {
-          var resultHTML = '<h3>' + result.summary + ' <a href="' + result.url + '">(see guidance)</a></h3>' +
+          var resultHTML = '<h3>(' + result.id + ') ' + result.summary + ' <a href="' + result.url + '">(see guidance)</a></h3>' +
           '<p>' + selectorObj.reasons.join('<br />') + '</p>' +
           '<p>Element can be found using the selector:<br /><span class="selector">' +
           selectorObj.selector +

data/app/models/govuk_publishing_components/component_doc.rb

@@ -5,14 +5,24 @@ module GovukPublishingComponents
                 :description,
                 :body,
                 :accessibility_criteria,
+                :accessibility_excluded_rules,
                 :examples
 
-    def initialize(id, name, description, body, accessibility_criteria, examples)
+    def initialize(
+      id,
+      name,
+      description,
+      body,
+      accessibility_criteria,
+      accessibility_excluded_rules,
+      examples
+    )
       @id = id
       @name = name
       @description = description
       @body = body
       @accessibility_criteria = accessibility_criteria
+      @accessibility_excluded_rules = accessibility_excluded_rules
       @examples = examples
     end
 

data/app/models/govuk_publishing_components/component_doc_resolver.rb

@@ -17,12 +17,15 @@ module GovukPublishingComponents
         ComponentExample.new(id.to_s, example["data"], example["context"], example["description"])
       }
 
-      ComponentDoc.new(component[:id],
-                       component[:name],
-                       component[:description],
-                       component[:body],
-                       combined_accessibility_criteria(component),
-                       examples)
+      ComponentDoc.new(
+        component[:id],
+        component[:name],
+        component[:description],
+        component[:body],
+        combined_accessibility_criteria(component),
+        component[:accessibility_excluded_rules],
+        examples
+      )
     end
 
     def combined_accessibility_criteria(component)

data/app/views/govuk_publishing_components/component_guide/component_doc/_preview.html.erb

@@ -1,4 +1,4 @@
-<div data-module="test-a11y">
+<div data-module="test-a11y" data-excluded-rules="<%= @component_doc.accessibility_excluded_rules %>">
   <%= render "govuk_publishing_components/component_guide/component_doc/component", component_doc: @component_doc, example: example, preview_page: false %>
   <div class="component-guide-preview component-guide-preview--violation" data-module="test-a11y-violation" data-content="Accessibility Issues"></div>
   <div class="component-guide-preview component-guide-preview--warning" data-module="test-a11y-warning" data-content="Potential accessibility issues: need manual check"></div>

data/app/views/govuk_publishing_components/component_guide/preview.html.erb

@@ -3,7 +3,7 @@
     <% if @component_examples.length > 1 %>
       <h2 class="preview-title"><a href="<%= component_example_path(@component_doc.id, example.id) %>"><%= example.name %></a></h2>
     <% end %>
-    <div data-module="test-a11y">
+    <div data-module="test-a11y" data-excluded-rules="<%= @component_doc.accessibility_excluded_rules %>">
       <%= render "govuk_publishing_components/component_guide/component_doc/component", component_doc: @component_doc, example: example, preview_page: true %>
     </div>
   </div>

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '1.12.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 2.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement