govuk_publishing_components 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e46bcab548aa86ded198500c1ef47b6967a4405
-  data.tar.gz: b29345bd70ee782b127bbe8e5c5640a28dfe3649
+  metadata.gz: 04b3957a214548180a22d3921bcc25b1fa69163e
+  data.tar.gz: 5a593705b493da4e2cf8cd098201a8acd4751b21
 SHA512:
-  metadata.gz: 2f18566d1fc8338914133467e623d20b8a31adcec1cde09f20be989987952a6cd8fb925856930cbff7bc227088c2e2913e65330170ab956cc29cdce8096d623e
-  data.tar.gz: 8a32cd97cfcf7d34bdfb9d0fc056e686b6300b6bb18e3bfe6838719bdfdc80ce6e3e8e33276675a5a98886dd92bebe3192b67adb63259c7a4eb7630d72a11494
+  metadata.gz: 26c42d56b90861b235c351040bffa9a8e9297ba50a83b2500f6557d9929c38d02148911217d6fb051807b4e8c4825f01c6cc8305ea4bd29e56682df833c2476e
+  data.tar.gz: aea09284f8bedd1969ab41eb3a9acfd433133a3a3534a748522b31bf26cc46d8e52069ae7d726c0aae2553b495aa03539ecbb33365c172af44327ec0f99ddf61

data/Rakefile

@@ -19,11 +19,11 @@ end
 namespace :assets do
   desc "Test precompiling assets through dummy application"
 
-  task :precompile do |t|
+  task :precompile do
     Rake::Task['app:assets:precompile'].invoke
   end
 
-  task :clean do |t|
+  task :clean do
     Rake::Task['app:assets:clean'].invoke
   end
 end

data/app/assets/stylesheets/govuk_publishing_components/application.scss

@@ -46,6 +46,23 @@ $border-color: #ccc;
   }
 }
 
+.component-violation {
+  border: 3px solid $error-colour;
+  margin: 0 0 $gutter;
+  padding: $gutter $gutter;
+
+  .component-violation__title {
+    @include bold-24;
+  }
+
+  .component-violation__link {
+    display: block;
+    @include bold-19;
+    color: $error-colour;
+    margin: $gutter-half 0;
+  }
+}
+
 .component-doc-h2 {
   @include bold-27;
   margin: ($gutter * 1.5) 0 $gutter;

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

@@ -4,6 +4,12 @@
 <div class="component-show">
   <div class="grid-row">
     <div class="column-two-thirds">
+      <% if !@component_doc.accessibility_criteria.present? %>
+        <div class="component-violation">
+          <h2 class="component-violation__title">This component is not valid</h2>
+          <p><a class="component-violation__link" href="https://github.com/alphagov/govuk_publishing_components/blob/master/docs/accessibility_acceptance_criteria.md">Please define accessibility acceptance criteria for this component.</a></p>
+        </div>
+      <% end %>
       <p class="component-description">
         <%= @component_doc.description %>
       </p>

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '1.11.0'.freeze
+  VERSION = '1.12.0'.freeze
 end

data/lib/tasks/govuk_publishing_components_tasks.rake

@@ -1,22 +1,50 @@
-desc 'warns if component view files exist without corresponding documentation'
-task :validate_component_documentation do
-  components_missing_docs = []
-  component_views = Dir["app/views/#{GovukPublishingComponents::Config.component_directory_name}/**/*.html.erb"]
 
-  component_views.each do |partial|
-    expected_component_docs_file = partial.split('/')[-1].gsub('html.erb', 'yml')
-    expected_component_docs_file.sub!(/^_/, '')
+namespace :component do
+  desc 'warns if component view files exist without corresponding documentation'
+  task :validate_documentation_exists do
+    print "Validating that each component has documentation... "
+    components_missing_docs = []
+    component_views = Dir["app/views/#{GovukPublishingComponents::Config.component_directory_name}/**/*.html.erb"]
+    component_views.each do |partial|
+      expected_component_docs_file = partial.split('/')[-1].gsub('html.erb', 'yml')
+      expected_component_docs_file.sub!(/^_/, '')
 
-    expected_component_docs_path = "app/views/#{GovukPublishingComponents::Config.component_directory_name}/docs/#{expected_component_docs_file}"
-    components_missing_docs << partial unless File.exist?(expected_component_docs_path)
+      expected_component_docs_path = "app/views/#{GovukPublishingComponents::Config.component_directory_name}/docs/#{expected_component_docs_file}"
+      components_missing_docs << partial unless File.exist?(expected_component_docs_path)
+    end
+
+    if components_missing_docs.any?
+      error = "You have components which are missing documentation. These components will not be displayed in the component guide:\n"
+      components_missing_docs.each { |component| error += "\t" + component + "\n" }
+      error += "\n"
+      raise NotImplementedError, error
+    end
+    puts "✔︎"
+  end
+
+  desc 'warns if component is missing accessibility criteria'
+  task :validate_accessibility_criteria_exist do
+    print "Validating that each component has accessibility criteria... "
+    errors = []
+
+    component_docs = Dir["app/views/#{GovukPublishingComponents::Config.component_directory_name}/**/*.yml"]
+    component_docs.each do |doc_file|
+      file = YAML.load_file(doc_file)
+
+      if file['accessibility_criteria'].nil? && file['shared_accessibility_criteria'].nil?
+        errors << file['name']
+      end
+    end
+    if errors.any?
+      error = "The following components need accessibility criteria:\n#{errors.join("\n")}"
+      raise NotImplementedError, error
+    end
+    puts "✔︎"
   end
 
-  if components_missing_docs.any?
-    error = "You have components which are missing documentation. These components will not be displayed in the component guide:\n"
-    components_missing_docs.each { |component| error += "\t" + component + "\n" }
-    error += "\n"
-    raise NotImplementedError, error
+  desc 'warns if component view files exist without corresponding documentation or accessibility critera'
+  task :validate_documentation do
+    Rake::Task["component:validate_documentation_exists"].invoke
+    Rake::Task["component:validate_accessibility_criteria_exist"].invoke
   end
 end
-
-Rake::Task["validate_component_documentation"].invoke

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement