govuk_publishing_components 21.60.1 → 21.60.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e9b30172e3f16dbfec024528c8e5b771e652000272cca8db4de6e3d5259a6e7
-  data.tar.gz: 1e0a1c48adc79cdcfe372368223bf39153ccdfd39ec3288692ab2614b4b9560c
+  metadata.gz: 98fa4203e2dd5c9bbcc5ecfc9b64d18612a1434167c1ece8b4203ade58c0c45a
+  data.tar.gz: f24e38e566e25ad2dc6c5d6fb954cf91cc7f43a9b6f46fabd0a08b184d69bb21
 SHA512:
-  metadata.gz: 1a7f16065f473c0dfb009f2a5e19edce7467017beb7ae953fd046adace5afd82ba90d34f24ef4bf01e5f6d68dc1a16b965aa2802399e8695e3f3d7d4e526e322
-  data.tar.gz: 83774a0b06a6092303a514ace31c7cc37ac10726f6d769b88d57419867b114960aaf1ee9f7109fdb60448661fd71a2884cdb524a6e93c78bb7d2901bd5a06367
+  metadata.gz: 3c9342c8d542a1a703f5700ffa6fa87d0fa253641a45d549176b8f6d0b4b6a8cefb73602cc4351afdd3ce35f307380a599e95fd1df2c14301acc55c9542f5987
+  data.tar.gz: 1179277ccaaa0b9758c4f0dfe723472a852525a2dbd9607f2a6d52033307232f53383e17812237975a0df232cd0e3c04ea31363ae1f85c5e6b81938579932006

data/app/assets/stylesheets/govuk_publishing_components/components/_radio.scss

@@ -1,5 +1,5 @@
 @import "govuk/components/radios/radios";
 
 .gem-c-radio__heading-text {
-  margin: 0;
+  margin: 0 0 govuk-spacing(4) 0;
 }

data/app/models/govuk_publishing_components/audit_applications.rb

@@ -3,37 +3,39 @@ module GovukPublishingComponents
     attr_reader :data
 
     def initialize(path, name)
-      templates = Dir["#{path}/app/views/**/*.erb"]
-      stylesheets = Dir["#{path}/app/assets/stylesheets/**/*.scss"]
-      javascripts = Dir["#{path}/app/assets/javascripts/**/*.js"]
+      @path = path
+      application_found = application_exists(path)
+      components_found = []
+      @gem_style_references = []
 
-      find_components = /(?<=govuk_publishing_components\/components\/)[\/a-zA-Z_-]+(?=['"])/
+      if application_found
+        templates = Dir["#{path}/app/views/**/*.erb"]
+        stylesheets = Dir["#{path}/app/assets/stylesheets/**/*.scss"]
+        javascripts = Dir["#{path}/app/assets/javascripts/**/*.js"]
 
-      @find_all_stylesheets = /@import ["']{1}govuk_publishing_components\/all_components/
-      find_stylesheets = /(?<=@import ["']{1}govuk_publishing_components\/components\/)(?!print\/)+[a-zA-Z_-]+(?=['"])/
+        find_components = /(?<=govuk_publishing_components\/components\/)[\/a-zA-Z_-]+(?=['"])/
 
-      @find_all_print_stylesheets = /@import ["']{1}govuk_publishing_components\/all_components_print/
-      find_print_stylesheets = /(?<=@import ["']{1}govuk_publishing_components\/components\/print\/)[a-zA-Z_-]+(?=['"])/
+        @find_all_stylesheets = /@import ["']{1}govuk_publishing_components\/all_components/
+        find_stylesheets = /(?<=@import ["']{1}govuk_publishing_components\/components\/)(?!print\/)+[a-zA-Z_-]+(?=['"])/
 
-      @find_all_javascripts = /\/\/[ ]*= require govuk_publishing_components\/all_components/
-      find_javascripts = /(?<=require govuk_publishing_components\/components\/)[a-zA-Z_-]+/
+        @find_all_print_stylesheets = /@import ["']{1}govuk_publishing_components\/all_components_print/
+        find_print_stylesheets = /(?<=@import ["']{1}govuk_publishing_components\/components\/print\/)[a-zA-Z_-]+(?=['"])/
 
-      components_in_templates = find_components(templates, find_components, "templates") || []
-      components_in_stylesheets = find_components(stylesheets, find_stylesheets, "stylesheets") || []
-      components_in_print_stylesheets = find_components(stylesheets, find_print_stylesheets, "print_stylesheets") || []
-      components_in_javascripts = find_components(javascripts, find_javascripts, "javascripts") || []
+        @find_all_javascripts = /\/\/[ ]*= require govuk_publishing_components\/all_components/
+        find_javascripts = /(?<=require govuk_publishing_components\/components\/)[a-zA-Z_-]+/
 
-      ruby_paths = %w[/app/helpers/ /app/presenters/ /lib/]
-      components_in_ruby = []
-      ruby_paths.each do |ruby_path|
-        components_in_ruby << find_components(Dir["#{path}#{ruby_path}**/*.{rb,erb}"], find_components, "ruby") || []
-      end
-      components_in_ruby = components_in_ruby.flatten.uniq
+        components_in_templates = find_components(templates, find_components, "templates") || []
+        components_in_stylesheets = find_components(stylesheets, find_stylesheets, "stylesheets") || []
+        components_in_print_stylesheets = find_components(stylesheets, find_print_stylesheets, "print_stylesheets") || []
+        components_in_javascripts = find_components(javascripts, find_javascripts, "javascripts") || []
 
-      application_found = application_exists(path)
-      components_found = []
+        ruby_paths = %w[/app/helpers/ /app/presenters/ /lib/]
+        components_in_ruby = []
+        ruby_paths.each do |ruby_path|
+          components_in_ruby << find_components(Dir["#{path}#{ruby_path}**/*.{rb,erb}"], find_components, "ruby") || []
+        end
+        components_in_ruby = components_in_ruby.flatten.uniq
 
-      if application_found
         components_found = [
           {
             location: "templates",
@@ -62,6 +64,7 @@ module GovukPublishingComponents
         name: name,
         application_found: application_found,
         components_found: components_found,
+        gem_style_references: @gem_style_references.flatten.uniq.sort,
       }
     end
 
@@ -73,6 +76,8 @@ module GovukPublishingComponents
       files.each do |file|
         src = File.read(file)
         components_found << find_match(find, src, type)
+        gem_references = find_gem_references(file, src)
+        @gem_style_references << gem_references if gem_references
       rescue StandardError
         puts "File #{file} not found"
       end
@@ -94,6 +99,13 @@ module GovukPublishingComponents
       all_matches
     end
 
+    def find_gem_references(file, src)
+      find_gem_classes = /gem-c-[-_a-zA-Z]+/
+      clean_file_path = /(?<=#{Regexp.escape(@path)}\/)[\/a-zA-Z_-]+.[a-zA-Z.]+/
+
+      return file[clean_file_path] if find_gem_classes.match?(src)
+    end
+
     def clean_file_name(name)
       name.tr("_-", " ").strip
     end

data/app/models/govuk_publishing_components/audit_comparer.rb

@@ -36,6 +36,7 @@ module GovukPublishingComponents
           warnings = []
           warnings << warn_about_missing_components(result[:components_found])
           warnings << warn_about_missing_assets(result[:components_found])
+          warnings << warn_about_style_overrides(result[:gem_style_references])
           warnings = warnings.flatten
 
           data << {
@@ -65,6 +66,7 @@ module GovukPublishingComponents
             ],
             warnings: warnings,
             warning_count: warnings.length,
+            gem_style_references: result[:gem_style_references],
           }
         else
           data << {
@@ -150,6 +152,17 @@ module GovukPublishingComponents
       !@gem_data[:component_code].include?(component) unless component == "all"
     end
 
+    def warn_about_style_overrides(results)
+      warnings = []
+
+      results.each do |result|
+        warnings << create_warning("Possible component style override", result) if result.include? ".scss"
+        warnings << create_warning("Possible hard coded component markup", result) if [".html", ".rb"].any? { |needle| result.include? needle }
+      end
+
+      warnings
+    end
+
     def find_missing(needle, haystack)
       (haystack - needle).flatten.sort
     end

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

@@ -20,7 +20,11 @@
       </li>
     </ul>
     <div class="govuk-tabs__panel" id="applications">
-      <h2 class="govuk-heading-l">Applications</h2>
+      <%= render "govuk_publishing_components/components/heading", {
+        text: "Applications",
+        font_size: "l",
+        margin_bottom: 6
+      } %>
 
       <% if @applications.any? %>
         <details class="govuk-details" data-module="govuk-details">
@@ -66,7 +70,12 @@
                     </p>
                   <% end %>
 
-                  <h3 class="govuk-heading-m">Components used</h3>
+                  <%= render "govuk_publishing_components/components/heading", {
+                    text: "Components used",
+                    font_size: "m",
+                    margin_bottom: 4,
+                    heading_level: 3,
+                  } %>
 
                   <dl class="govuk-summary-list">
                     <% application[:summary].each do |item| %>
@@ -84,6 +93,22 @@
                       </div>
                     <% end %>
                   </dl>
+
+                  <% if application[:gem_style_references].any? %>
+                    <%= render "govuk_publishing_components/components/heading", {
+                      text: "Component references",
+                      font_size: "m",
+                      margin_bottom: 4,
+                      heading_level: 3,
+                    } %>
+
+                    <p class="govuk-body">This shows instances of `gem-c-` classes found in the application. If a reference is found in a stylesheet or in code a warning is created, as this could be a style override or hard coded component markup.</p>
+                    <ul class="govuk-list govuk-list--bullet">
+                      <% application[:gem_style_references].each do |ref| %>
+                        <li><%= ref %></li>
+                      <% end %>
+                    </ul>
+                  <% end %>
                 <% else %>
                   <p class="govuk-body">This application was not found. This could be because you do not have this repository checked out locally.</p>
                 <% end %>
@@ -97,7 +122,11 @@
     </div>
 
     <div class="govuk-tabs__panel govuk-tabs__panel--hidden" id="components-gem">
-      <h2 class="govuk-heading-l">Components</h2>
+      <%= render "govuk_publishing_components/components/heading", {
+        text: "Components",
+        font_size: "l",
+        margin_bottom: 6,
+      } %>
 
       <% if @components.any? %>
         <div class="govuk-accordion" data-module="govuk-accordion" id="accordion-default">

data/app/views/govuk_publishing_components/components/_image_card.html.erb

@@ -7,7 +7,7 @@
 <% if card_helper.href || card_helper.extra_links.any? %>
   <div class="gem-c-image-card <%= "gem-c-image-card--large" if card_helper.large %> <%= brand_helper.brand_class %>"
     <%= "data-module=track-click" if card_helper.is_tracking? %>
-  >
+    <%= "lang=#{card_helper.lang}" if card_helper.lang %>>
     <%= card_helper.image %>
 
     <div class="gem-c-image-card__text-wrapper">

data/app/views/govuk_publishing_components/components/docs/image_card.yml

@@ -9,6 +9,7 @@ accessibility_criteria: |
 
   - include alt text for images when present
   - not have duplicate links for the image and the text
+  - if the contents of the component are in a different language than the rest of the document, include an appropriate `lang` attribute to correctly identify the language used in the component
 shared_accessibility_criteria:
   - link
 examples:
@@ -191,7 +192,7 @@ examples:
     description: Can be used for links to people pages to indicate payment type
     data:
       href: "/government/people/"
-      image_src: "http://placekitten.com/215/140"
+      image_src: "https://assets.publishing.service.gov.uk/government/uploads/system/uploads/feature/image/62756/s300_courts-of-justice.JPG"
       image_alt: "some meaningful alt text please"
       context:
         text: "The Rt Hon"
@@ -204,3 +205,14 @@ examples:
         }
       ]
       extra_links_no_indent: true
+  with_lang:
+    description: |
+      Pass through an appropriate `lang` to set a HTML lang attribute for the component.
+      
+      The `lang` attribute **must** be set to a [valid BCP47 string](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang#Language_tag_syntax). A valid code can be the two or three letter language code - for example, English is `en` or `eng`, Korean is `ko` or `kor` - but if in doubt please check.
+    data:
+      href: "/not-a-page"
+      image_src: "https://assets.publishing.service.gov.uk/government/uploads/system/uploads/feature/image/62756/s300_courts-of-justice.JPG"
+      image_alt: "some meaningful alt text please"
+      heading_text: Yr hyn rydym ni'n ei wneud
+      lang: cy

data/lib/govuk_publishing_components/presenters/image_card_helper.rb

@@ -4,7 +4,7 @@ module GovukPublishingComponents
       include ActionView::Helpers
       include ActionView::Context
 
-      attr_reader :href, :href_data_attributes, :extra_links, :large, :extra_links_no_indent, :heading_text, :metadata
+      attr_reader :href, :href_data_attributes, :extra_links, :large, :extra_links_no_indent, :heading_text, :metadata, :lang
 
       def initialize(local_assigns)
         @href = local_assigns[:href]
@@ -18,6 +18,7 @@ module GovukPublishingComponents
         @heading_text = local_assigns[:heading_text]
         @extra_links_no_indent = local_assigns[:extra_links_no_indent]
         @metadata = local_assigns[:metadata]
+        @lang = local_assigns[:lang]
       end
 
       def is_tracking?

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "21.60.1".freeze
+  VERSION = "21.60.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 21.60.1
+  version: 21.60.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config