govuk_publishing_components 29.6.0 → 29.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e3f8aaf064237fbd67e4b472e5e57dcafeb3a16ed3228c7b0b45114d7f68257
-  data.tar.gz: dc5d297b2e7d409277024778eabc48a9faf2a8b68bff7f309426d028b4736f2b
+  metadata.gz: b74221682d0047e390f314e968edf8acd3b89efebfe41d833239d9ca44413c86
+  data.tar.gz: 1f87c5a4288b2a69da1e32598422162bc5017f2dab4ac577b326b582cbd9e8e9
 SHA512:
-  metadata.gz: 38c1773770dc36ecce0857dd4516d8f6aa350542b25d3d0f946d56d664eb5661d3c53da68286b6a5a9c51344c6cd5c927a4206a9d0a2350cd47e737277e7dfb0
-  data.tar.gz: 9b5f523c0cacffa3f6f12858dfce51f1f770000447e6d29d83d47856d2a22b51e493b64fcd930755a893293566260ade49d9b295bfb31976c946120ca9e06923
+  metadata.gz: 14d60ae3e9876edbbcac836010f6dbfd1655c3be4798119f79ac064cb70cfef71a612694d7b31ae6475c31f9813ca9d7775fb1ab3b3153707643bd61190e057d
+  data.tar.gz: 4e69c991fd6db0d47136d6a7e489fd516e1aa9c62b1422ccf87ed35164e7f6641a60fd64392281f5c99b84c4b9caef8be78bbd73faa922b604d27c227ec7080f

data/app/assets/javascripts/govuk_publishing_components/lib/govspeak/magna-charta.js

@@ -51,6 +51,16 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
     // giving the table a class of mc-stacked
     this.options.stacked = this.$table.classList.contains('mc-stacked')
 
+    // stacked charts require tables to use the th element in the table header
+    // if the th element is not included, then the ENABLED flag is set to false
+    // this will stop the chart and toggleLink from being rendered
+    if (this.options.stacked) {
+      var allTheTHsInTableHead = this.$table.querySelectorAll('thead th')
+      if (allTheTHsInTableHead.length === 0) {
+        this.ENABLED = false
+      }
+    }
+
     // set the negative option based on
     // giving the table a class of mc-negative
     this.options.negative = this.$table.classList.contains('mc-negative')
@@ -106,12 +116,16 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
 
   MagnaCharta.prototype.apply = function () {
     if (this.ENABLED) {
-      this.constructChart()
-      this.addClassesToHeader()
-      this.applyWidths()
-      this.insert()
-      this.$table.classList.add('mc-hidden')
-      this.applyOutdent()
+      try {
+        this.constructChart()
+        this.addClassesToHeader()
+        this.applyWidths()
+        this.insert()
+        this.$table.classList.add('mc-hidden')
+        this.applyOutdent()
+      } catch (error) {
+        console.error('MagnaCharta error:', error)
+      }
     }
   }
 

data/app/assets/stylesheets/govuk_publishing_components/components/_layout-super-navigation-header.scss

@@ -816,7 +816,7 @@ $button-pipe-colour: darken(govuk-colour("mid-grey"), 20%);
 
 .gem-c-layout-super-navigation-header__navigation-second-items--topics {
   @include govuk-media-query($from: "desktop") {
-    @include columns($items: 17, $columns: 2, $selector: "li", $flow: column);
+    @include columns($items: 16, $columns: 2, $selector: "li", $flow: column);
   }
 }
 

data/app/controllers/govuk_publishing_components/audit_controller.rb

@@ -13,8 +13,6 @@ module GovukPublishingComponents
         frontend
         government-frontend
         govspeak-preview
-        govuk-account-manager-prototype
-        govuk-coronavirus-vulnerable-people-form
         info-frontend
         licence-finder
         manuals-frontend
@@ -32,10 +30,9 @@ module GovukPublishingComponents
       gem_path = Gem.loaded_specs["govuk_publishing_components"].full_gem_path
       gem_path = Dir.pwd if ENV["MAIN_COMPONENT_GUIDE"]
       host_dir = File.expand_path("..")
-      path = File.expand_path("..", gem_path)
 
       @in_application = false
-      @in_application = true unless path.to_s == host_dir.to_s
+      @in_application = true unless ENV["MAIN_COMPONENT_GUIDE"]
 
       components = AuditComponents.new(gem_path, false)
       applications = analyse_applications(host_dir, application_dirs)

data/app/models/govuk_publishing_components/audit_components.rb

@@ -12,29 +12,40 @@ module GovukPublishingComponents
   private
 
     def compile_data(path, simple)
+      # simple is used to reduce effort (and therefore page load time) required
+      # when loading auditing summary on the main component guide page
       @simple = simple
-      templates_path = "app/views/govuk_publishing_components/components"
-      stylesheets_path = "app/assets/stylesheets/govuk_publishing_components/components"
-      print_stylesheets_path = "app/assets/stylesheets/govuk_publishing_components/components/print"
-      javascripts_path = "app/assets/javascripts/govuk_publishing_components/components"
-      tests_path = "spec/components"
-      js_tests_path = "spec/javascripts/components"
-
-      templates = Dir["#{path}/#{templates_path}/*.erb"]
-      stylesheets = Dir["#{path}/#{stylesheets_path}/*.scss"]
-      print_stylesheets = Dir["#{path}/#{print_stylesheets_path}/*.scss"]
-      javascripts = Dir["#{path}/#{javascripts_path}/*.js"]
-      tests = Dir["#{path}/#{tests_path}/*.rb"]
-      js_tests = Dir["#{path}/#{js_tests_path}/*.js"]
-
-      @templates_full_path = "#{path}/#{templates_path}/"
-
-      @components = find_files(templates, [path, templates_path].join("/"))
-      @component_stylesheets = find_files(stylesheets, [path, stylesheets_path].join("/"))
-      @component_print_stylesheets = find_files(print_stylesheets, [path, print_stylesheets_path].join("/"))
-      @component_javascripts = find_files(javascripts, [path, javascripts_path].join("/"))
-      @component_tests = find_files(tests, [path, tests_path].join("/"))
-      @component_js_tests = find_files(js_tests, [path, js_tests_path].join("/"))
+
+      # paths to key file locations
+      @templates_path = "app/views/govuk_publishing_components/components"
+      @stylesheets_path = "app/assets/stylesheets/govuk_publishing_components/components"
+      @print_stylesheets_path = "app/assets/stylesheets/govuk_publishing_components/components/print"
+      @javascripts_path = "app/assets/javascripts/govuk_publishing_components/components"
+      @tests_path = "spec/components"
+      @js_tests_path = "spec/javascripts/components"
+      @helpers_path = "lib/govuk_publishing_components/presenters"
+
+      # get all files in key file locations
+      templates = Dir["#{path}/#{@templates_path}/*.erb"]
+      stylesheets = Dir["#{path}/#{@stylesheets_path}/*.scss"]
+      print_stylesheets = Dir["#{path}/#{@print_stylesheets_path}/*.scss"]
+      javascripts = Dir["#{path}/#{@javascripts_path}/*.js"]
+      tests = Dir["#{path}/#{@tests_path}/*.rb"]
+      js_tests = Dir["#{path}/#{@js_tests_path}/*.js"]
+      helpers = Dir["#{path}/#{@helpers_path}/*_helper.rb"]
+
+      @templates_full_path = "#{path}/#{@templates_path}/"
+
+      # find the cleaned names of components in key file locations
+      # i.e. will show that 'component name' has a stylesheet
+      # standardised like this to be used later for easier comparison
+      @components = clean_files(templates, [path, @templates_path].join("/"))
+      @component_stylesheets = clean_files(stylesheets, [path, @stylesheets_path].join("/"))
+      @component_print_stylesheets = clean_files(print_stylesheets, [path, @print_stylesheets_path].join("/"))
+      @component_javascripts = clean_files(javascripts, [path, @javascripts_path].join("/"))
+      @component_tests = clean_files(tests, [path, @tests_path].join("/"))
+      @component_js_tests = clean_files(js_tests, [path, @js_tests_path].join("/"))
+      @component_helpers = clean_files(helpers, [path, @helpers_path].join("/"))
 
       {
         gem_found: true,
@@ -44,12 +55,13 @@ module GovukPublishingComponents
         component_javascripts: @component_javascripts,
         component_tests: @component_tests,
         component_js_tests: @component_js_tests,
+        component_helpers: @component_helpers,
         components_containing_components: find_all_partials_in(templates),
         component_listing: list_all_component_details,
       }
     end
 
-    def find_files(files, replace)
+    def clean_files(files, replace)
       files.map { |file| clean_file_name(file.gsub(replace, "")) }.sort
     end
 
@@ -61,6 +73,7 @@ module GovukPublishingComponents
         .gsub(".js", "")
         .gsub("spec", "")
         .gsub(".rb", "")
+        .gsub("helper", "")
         .strip
     end
 
@@ -72,11 +85,14 @@ module GovukPublishingComponents
         .tr('\"\'', "")
     end
 
+    # create link to component guide page for a given component e.g. 'component name'
     def get_component_link(component)
       "/component-guide/#{component.gsub(' ', '_')}"
     end
 
     def find_all_partials_in(templates)
+      return [] if @simple
+
       components = []
 
       templates.each do |template|
@@ -142,6 +158,7 @@ module GovukPublishingComponents
           javascript: check_component_has("javascript", component),
           tests: check_component_has("test", component),
           js_tests: check_component_has("js_test", component),
+          helper: check_component_has("helper", component),
         }
       end
 
@@ -154,8 +171,28 @@ module GovukPublishingComponents
       look_in = @component_javascripts if a_thing == "javascript"
       look_in = @component_tests if a_thing == "test"
       look_in = @component_js_tests if a_thing == "js_test"
+      look_in = @component_helpers if a_thing == "helper"
+
+      if look_in.include?(component)
+        return get_asset_link(a_thing, component)
+      end
+
+      false
+    end
 
-      true if look_in.include?(component)
+    def get_asset_link(a_thing, component)
+      url = "https://github.com/alphagov"
+      repo = "govuk_publishing_components"
+      blob = "blob/main"
+      link = nil
+      link = "#{url}/#{repo}/#{blob}/#{@stylesheets_path}/_#{component.gsub(' ', '-')}.scss" if a_thing == "stylesheet"
+      link = "#{url}/#{repo}/#{blob}/#{@print_stylesheets_path}/_#{component.gsub(' ', '-')}.scss" if a_thing == "print_stylesheet"
+      link = "#{url}/#{repo}/#{blob}/#{@javascripts_path}/#{component.gsub(' ', '-')}.js" if a_thing == "javascript"
+      link = "#{url}/#{repo}/#{blob}/#{@tests_path}/#{component.gsub(' ', '_')}_spec.rb" if a_thing == "test"
+      link = "#{url}/#{repo}/#{blob}/#{@js_tests_path}/#{component.gsub(' ', '-')}-spec.js" if a_thing == "js_test"
+      link = "#{url}/#{repo}/#{blob}/#{@helpers_path}/#{component.gsub(' ', '_')}_helper.rb" if a_thing == "helper"
+
+      link
     end
   end
 end

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

@@ -32,6 +32,7 @@
 
     <% accordion_content = capture do %>
       <% if application[:application_found] %>
+        <% github_link = 'https://github.com/alphagov/' + application[:name] + '/blob/main/' %>
         <% application[:warnings].each do |warning| %>
           <p class="govuk-body">
             <strong class="govuk-tag">Warn</strong>
@@ -74,7 +75,9 @@
           <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>
+              <li>
+                <%= link_to ref, github_link + ref, class: 'govuk-link' %>
+              </li>
             <% end %>
           </ul>
         <% end %>
@@ -86,10 +89,12 @@
             margin_bottom: 4,
             heading_level: 3,
           } %>
-          <p class="govuk-body">This shows JavaScript files that might contain jQuery, which we are trying to remove our dependency on.</p>
+          <p class="govuk-body">This shows JavaScript files that might contain jQuery, which we are trying to remove.</p>
           <ul class="govuk-list govuk-list--bullet">
             <% application[:jquery_references].each do |ref| %>
-              <li><%= ref %></li>
+              <li>
+                <%= link_to ref, github_link + ref, class: 'govuk-link' %>
+              </li>
             <% end %>
           </ul>
         <% end %>

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

@@ -0,0 +1,82 @@
+<%
+  total_components = components.length
+  components_with_stylesheet = 0
+  components_with_print_stylesheet = 0
+  components_with_javascript = 0
+  components_with_test = 0
+  components_with_javascript_test = 0
+  components_with_helper = 0
+
+  components.each do |component|
+    components_with_stylesheet += 1 if component[:stylesheet]
+    components_with_print_stylesheet += 1 if component[:print_stylesheet]
+    components_with_javascript += 1 if component[:javascript]
+    components_with_test += 1 if component[:tests]
+    components_with_javascript_test += 1 if component[:js_tests]
+    components_with_helper += 1 if component[:helper]
+  end
+%>
+<table class="govuk-table">
+  <thead class="govuk-table__head">
+    <tr class="govuk-table__row">
+      <th scope="col" class="govuk-table__header sticky-table-header">Component (<%= total_components %>)</th>
+      <th scope="col" class="govuk-table__header sticky-table-header">CSS (<%= components_with_stylesheet %>)</th>
+      <th scope="col" class="govuk-table__header sticky-table-header">Print CSS (<%= components_with_print_stylesheet %>)</th>
+      <th scope="col" class="govuk-table__header sticky-table-header">JS (<%= components_with_javascript %>)</th>
+      <th scope="col" class="govuk-table__header sticky-table-header">Test (<%= components_with_test %>)</th>
+      <th scope="col" class="govuk-table__header sticky-table-header">JS test (<%= components_with_javascript_test %>)</th>
+      <th scope="col" class="govuk-table__header sticky-table-header">Helper (<%= components_with_helper %>)</th>
+    </tr>
+  </thead>
+  <tbody class="govuk-table__body">
+    <% components.each do |component| %>
+      <tr class="govuk-table__row">
+        <th scope="row" class="govuk-table__header">
+          <a href="<%= component[:link] %>" class="govuk-link"><%= component[:name] %></a>
+        </th>
+        <td class="govuk-table__cell">
+          <% if component[:stylesheet] %>
+            <strong class="govuk-tag govuk-tag--green">
+              <a href="<%= component[:stylesheet] %>" class="govuk-link">Yes</a>
+            </strong>
+          <% end %>
+        </td>
+        <td class="govuk-table__cell">
+          <% if component[:print_stylesheet] %>
+            <strong class="govuk-tag govuk-tag--green">
+              <a href="<%= component[:print_stylesheet] %>" class="govuk-link">Yes</a>
+            </strong>
+          <% end %>
+        </td>
+        <td class="govuk-table__cell">
+          <% if component[:javascript] %>
+            <strong class="govuk-tag govuk-tag--green">
+              <a href="<%= component[:javascript] %>" class="govuk-link">Yes</a>
+            </strong>
+          <% end %>
+        </td>
+        <td class="govuk-table__cell">
+          <% if component[:tests] %>
+            <strong class="govuk-tag govuk-tag--green">
+              <a href="<%= component[:tests] %>" class="govuk-link">Yes</a>
+            </strong>
+          <% end %>
+        </td>
+        <td class="govuk-table__cell">
+          <% if component[:js_tests] %>
+            <strong class="govuk-tag govuk-tag--green">
+              <a href="<%= component[:js_tests] %>" class="govuk-link">Yes</a>
+            </strong>
+          <% end %>
+        </td>
+        <td class="govuk-table__cell">
+          <% if component[:helper] %>
+            <strong class="govuk-tag govuk-tag--green">
+              <a href="<%= component[:helper] %>" class="govuk-link">Yes</a>
+            </strong>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -1,6 +1,6 @@
 <% if @other_applications %>
   <%= render "govuk_publishing_components/components/heading", {
-    text: "Components",
+    text: "Components in the gem",
     font_size: "l",
     margin_bottom: 6,
   } %>
@@ -10,52 +10,7 @@
   <% component_items = [] %>
 
   <% component_files = capture do %>
-    <table class="govuk-table">
-      <thead class="govuk-table__head">
-        <tr class="govuk-table__row">
-          <th scope="col" class="govuk-table__header sticky-table-header">Component</th>
-          <th scope="col" class="govuk-table__header sticky-table-header">Stylesheet</th>
-          <th scope="col" class="govuk-table__header sticky-table-header">Print stylesheet</th>
-          <th scope="col" class="govuk-table__header sticky-table-header">JS</th>
-          <th scope="col" class="govuk-table__header sticky-table-header">Test</th>
-          <th scope="col" class="govuk-table__header sticky-table-header">JS test</th>
-        </tr>
-      </thead>
-      <tbody class="govuk-table__body">
-        <% @components[:component_listing].each do |component| %>
-          <tr class="govuk-table__row">
-            <th scope="row" class="govuk-table__header">
-              <a href="<%= component[:link] %>" class="govuk-link"><%= component[:name] %></a>
-            </th>
-            <td class="govuk-table__cell">
-              <% if component[:stylesheet] %>
-                <strong class="govuk-tag govuk-tag--green">Yes</strong>
-              <% end %>
-            </td>
-            <td class="govuk-table__cell">
-              <% if component[:print_stylesheet] %>
-                <strong class="govuk-tag govuk-tag--green">Yes</strong>
-              <% end %>
-            </td>
-            <td class="govuk-table__cell">
-              <% if component[:javascript] %>
-                <strong class="govuk-tag govuk-tag--green">Yes</strong>
-              <% end %>
-            </td>
-            <td class="govuk-table__cell">
-              <% if component[:tests] %>
-                <strong class="govuk-tag govuk-tag--green">Yes</strong>
-              <% end %>
-            </td>
-            <td class="govuk-table__cell">
-              <% if component[:js_tests] %>
-                <strong class="govuk-tag govuk-tag--green">Yes</strong>
-              <% end %>
-            </td>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
+    <%= render partial: "component_contents", locals: { components: @components[:component_listing] } %>
   <% end %>
 
   <%

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

@@ -1,5 +1,5 @@
 <%
-  attachment = GovukPublishingComponents::Presenters::Attachment.new(attachment)
+  attachment = GovukPublishingComponents::Presenters::AttachmentHelper.new(attachment)
   target ||= "_self"
   hide_opendocument_metadata ||= false
   hide_order_copy_link ||= false

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

@@ -1,5 +1,5 @@
 <%
-  attachment = GovukPublishingComponents::Presenters::Attachment.new(attachment)
+  attachment = GovukPublishingComponents::Presenters::AttachmentHelper.new(attachment)
   target ||= nil
   data_attributes ||= {}
   attributes = []

data/config/locales/en.yml

@@ -175,8 +175,6 @@ en:
           href: "/browse/childcare-parenting"
         - label: Citizenship and living in the UK
           href: "/browse/citizenship"
-        - label: Coronavirus (COVID‑19)
-          href: "/coronavirus"
         - label: Crime, justice and the law
           href: "/browse/justice"
         - label: Disabled people

data/lib/govuk_publishing_components/presenters/{attachment.rb → attachment_helper.rb}

@@ -1,6 +1,6 @@
 module GovukPublishingComponents
   module Presenters
-    class Attachment
+    class AttachmentHelper
       # Various departments are taking part in a pilot to use a form
       # rather than direct email for users to request accessible formats. When the pilot
       # scheme is rolled out further this can be removed.

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "29.6.0".freeze
+  VERSION = "29.7.0".freeze
 end

data/lib/govuk_publishing_components.rb

@@ -5,7 +5,7 @@ require "govuk_personalisation"
 require "govuk_publishing_components/config"
 require "govuk_publishing_components/engine"
 require "govuk_publishing_components/presenters/shared_helper"
-require "govuk_publishing_components/presenters/attachment"
+require "govuk_publishing_components/presenters/attachment_helper"
 require "govuk_publishing_components/presenters/big_number_helper"
 require "govuk_publishing_components/presenters/breadcrumbs"
 require "govuk_publishing_components/presenters/breadcrumb_selector"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 29.6.0
+  version: 29.7.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -636,6 +636,7 @@ files:
 - app/models/govuk_publishing_components/component_example.rb
 - app/models/govuk_publishing_components/shared_accessibility_criteria.rb
 - app/views/govuk_publishing_components/audit/_applications.html.erb
+- app/views/govuk_publishing_components/audit/_component_contents.html.erb
 - app/views/govuk_publishing_components/audit/_components.html.erb
 - app/views/govuk_publishing_components/audit/show.html.erb
 - app/views/govuk_publishing_components/component_guide/_application_stylesheet.html.erb
@@ -899,7 +900,7 @@ files:
 - 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/presenters/attachment.rb
+- lib/govuk_publishing_components/presenters/attachment_helper.rb
 - lib/govuk_publishing_components/presenters/big_number_helper.rb
 - lib/govuk_publishing_components/presenters/breadcrumb_selector.rb
 - lib/govuk_publishing_components/presenters/breadcrumbs.rb