govuk_publishing_components 38.4.2 → 39.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef32d3030ffa13a219217e5da812a2c8f60f4974dfae056b780dba0c2934ae89
-  data.tar.gz: 2d3a31d7520cd943e1c79e7054945574f7e36929604d35017372d5444deccdfa
+  metadata.gz: 8cb1e3eada3fc58f499f9da62873cf2f108355174ac5cef358f27346c9e8e93b
+  data.tar.gz: aa17baa1187ad6aa4c67b3e5fa12cd17e545283dcff78ca3a857e1bbb89abbad
 SHA512:
-  metadata.gz: 6c5e9467f9824143658930724739780947e76fa6df8a3e13621305956332e6073f46e9bde4aba41c6a9e4098efc57884437d1e03a4208e29284ca19722f3901f
-  data.tar.gz: de095dfa1e550f4f0fce76ddecf9861a0b468e000df4190f92a916e82347e4f3cd5e587f40d6de94077bc732140009f5f9081ba5639dc9f98336e157145e5350
+  metadata.gz: 9192e0474262e2053e5a4a25ca470ae133bb3af97cd070c60fe1f01980d099bfa74e764268f1a04c5d7723f755947bbedc5a0a51b2d2f16d43f590f068fd46b7
+  data.tar.gz: b1180271d163a211ded8914027beac9c071935689410546b4288bdaed649b702fa11dee474bab609522c9accfb2bf2974f74d90875076eb7b8d6cf454a220f36

data/app/assets/javascripts/govuk_publishing_components/components/accordion.js

@@ -24,6 +24,11 @@ window.GOVUK.Modules.GovukAccordion = window.GOVUKFrontend.Accordion;
   }
 
   GemAccordion.prototype.init = function () {
+    // Do not initialise if the accordion component from govuk-frontend has not initialised
+    if (this.$module.querySelector(this.showAllControls) === null) {
+      return
+    }
+
     // Indicate that JavaScript has worked
     this.$module.querySelector(this.showAllControls).classList.add('gem-c-accordion__show-all')
 

data/app/assets/javascripts/govuk_publishing_components/components/option-select.js

@@ -49,7 +49,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
     }
 
     // Attach listener to update checked count
-    this.$optionsContainer.querySelector('.gem-c-checkboxes__list').addEventListener('change', this.updateCheckedCount.bind(this))
+    this.$optionsContainer.querySelector('.govuk-checkboxes').addEventListener('change', this.updateCheckedCount.bind(this))
 
     // Replace div.container-head with a button
     this.replaceHeadingSpanWithButton()

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

@@ -10,39 +10,9 @@
   margin-top: govuk-spacing(2);
   margin-bottom: govuk-spacing(2);
   padding: govuk-spacing(2) govuk-spacing(4);
-
-  &.gem-c-checkboxes__list {
-    padding-left: govuk-spacing(4);
-  }
-}
-
-.govuk-checkboxes__conditional {
-  margin-top: govuk-spacing(2);
-  margin-left: -(govuk-spacing(4) + 2px); // 22px
-}
-
-.gem-c-checkboxes__list {
-  padding-left: govuk-spacing(0);
-  margin: 0;
-}
-
-.gem-c-checkboxes__divider {
-  @include govuk-font($size: 19);
-  @include govuk-text-colour;
-  list-style-type: none;
-  margin-bottom: govuk-spacing(2);
-  text-align: center;
-  width: 40px;
 }
 
 .gem-c-checkboxes {
-  // this is complex but needed to override the govuk-frontend styles in
-  // https://github.com/alphagov/govuk-frontend/blob/b8058640b9602ecb6e1f66f887553190cbae7b46/src/components/hint/_hint.scss#L16
-  // our elements are wrapped in list items that already provide a margin-bottom
-  .govuk-label:not(.govuk-label--m):not(.govuk-label--l):not(.govuk-label--xl) + .govuk-hint {
-    margin-bottom: 0;
-  }
-
   .gem-c-checkboxes__legend--hidden {
     @include govuk-visually-hidden;
   }

data/app/assets/stylesheets/govuk_publishing_components/components/_document-list.scss

@@ -131,10 +131,13 @@
   padding-top: govuk-spacing(2);
 
   &::before {
-    content: "—";
+    content: "";
     position: absolute;
     left: 0;
+    width: govuk-spacing(3);
     overflow: hidden;
+    border-top: solid 1px $govuk-text-colour;
+    transform: translate(0, 0.5em);
   }
 
   @include govuk-media-query($from: desktop) {

data/app/models/govuk_publishing_components/audit_components.rb

@@ -22,6 +22,8 @@ module GovukPublishingComponents
         stylesheet: 0,
         print_stylesheet: 0,
         javascript: 0,
+        uses_govuk_frontend_js: 0,
+        uses_govuk_frontend_css: 0,
         test: 0,
         javascript_test: 0,
         helper: 0,
@@ -120,6 +122,16 @@ module GovukPublishingComponents
           details["#{type}_exists".to_sym] = true
           details["#{type}_lines".to_sym] = count_lines_in(file)
           details["#{type}_link".to_sym] = get_asset_link(type, component)
+
+          if type == "javascript" && uses_govuk_frontend_js?(file)
+            details[:uses_govuk_frontend_js] = true
+            @component_numbers[:uses_govuk_frontend_js] += 1
+          end
+
+          if type == "stylesheet" && uses_govuk_frontend_css?(file)
+            details[:uses_govuk_frontend_css] = true
+            @component_numbers[:uses_govuk_frontend_css] += 1
+          end
         end
       end
 
@@ -130,6 +142,14 @@ module GovukPublishingComponents
       File.read(file).each_line.count
     end
 
+    def uses_govuk_frontend_js?(file)
+      File.read(file).match(/require govuk\/components/)
+    end
+
+    def uses_govuk_frontend_css?(file)
+      File.read(file).match(/@import "govuk\/components/)
+    end
+
     def clean_files(files, replace)
       files.map { |file| clean_file_name(file.gsub(replace, "")) }.sort
     end

data/app/models/govuk_publishing_components/component_wrapper_helper_options.rb

@@ -10,6 +10,7 @@ This component uses the component wrapper helper. It accepts the following optio
 - `classes` - accepts a space separated string of classes, these should not be used for styling and must be prefixed with `js-`
 - `role` - accepts a space separated string of roles
 - `lang` - accepts a language attribute value
+- `open` - accepts an open attribute value (true or false)
       "
     end
   end

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

@@ -1,44 +1,59 @@
+<p class="govuk-body">
+  Numbers in table headers show column totals. Numbers in table cells show number of lines in files. Note that component test files cannot currently be detected in applications that use minitest instead of Rspec.</p>
+</p>
 <table class="govuk-table">
   <thead class="govuk-table__head">
     <tr class="govuk-table__row" <% if show_application_name %>data-audit-headings<% end %>>
       <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="total">Component</th>
-      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="template">
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="template" title="Component has a template">
         Template
         <% unless show_application_name %>
           <span class="component__count"><%= passed_components[:component_numbers][:template] %></span>
         <% end %>
       </th>
-      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="stylesheet">
-        CSS 
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="stylesheet" title="Component has a stylesheet">
+        CSS
         <% unless show_application_name %>
           <span class="component__count"><%= passed_components[:component_numbers][:stylesheet] %></span>
         <% end %>
       </th>
-      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="print_stylesheet">
-        Print styles
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="print_stylesheet" title="Component has print styles">
+        Print CSS
         <% unless show_application_name %>
           <span class="component__count"><%= passed_components[:component_numbers][:print_stylesheet] %></span>
         <% end %>
       </th>
-      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="javascript">
-        JS 
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="javascript" title="Component has JavaScript">
+        JS
         <% unless show_application_name %>
           <span class="component__count"><%= passed_components[:component_numbers][:javascript] %></span>
         <% end %>
       </th>
-      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="test">
-        Test 
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="javascript_test" title="Component has a JavaScript test file">
+        JS test
         <% unless show_application_name %>
-          <span class="component__count"><%= passed_components[:component_numbers][:test] %></span>
+          <span class="component__count"><%= passed_components[:component_numbers][:javascript_test] %></span>
         <% end %>
       </th>
-      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="javascript_test">
-        JS test
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="uses-govuk-frontend-css" title="Component includes styles imported from govuk-frontend">
+        GF CSS
         <% unless show_application_name %>
-          <span class="component__count"><%= passed_components[:component_numbers][:javascript_test] %></span>
+          <span class="component__count"><%= passed_components[:component_numbers][:uses_govuk_frontend_css] %></span>
         <% end %>
       </th>
-      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="helper">
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="uses-govuk-frontend-js" title="Component includes JavaScript imported from govuk-frontend">
+        GF JS
+        <% unless show_application_name %>
+          <span class="component__count"><%= passed_components[:component_numbers][:uses_govuk_frontend_js] %></span>
+        <% end %>
+      </th>
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="test" title="Component has a test file">
+        Test
+        <% unless show_application_name %>
+          <span class="component__count"><%= passed_components[:component_numbers][:test] %></span>
+        <% end %>
+      </th>
+      <th scope="col" class="govuk-table__header sticky-table-header" data-component-type="helper" title="Component has a helper file">
         Helper
         <% unless show_application_name %>
           <span class="component__count"><%= passed_components[:component_numbers][:helper] %></span>
@@ -65,7 +80,7 @@
         </th>
         <td class="govuk-table__cell" data-component-type="template">
           <% if component[:template_exists] %>
-            <a href="<%= component[:template_link] %>" class="govuk-link">
+            <a href="<%= component[:template_link] %>" class="govuk-link" title="This file has <%= component[:template_lines] %> lines">
               <%= component[:template_lines] %>
               <span class="govuk-visually-hidden">lines of code in <%= component[:name] %> template</span>
             </a>
@@ -73,7 +88,7 @@
         </td>
         <td class="govuk-table__cell" data-component-type="stylesheet">
           <% if component[:stylesheet_exists] %>
-            <a href="<%= component[:stylesheet_link] %>" class="govuk-link">
+            <a href="<%= component[:stylesheet_link] %>" class="govuk-link" title="This file has <%= component[:stylesheet_lines] %> lines">
               <%= component[:stylesheet_lines] %>
               <span class="govuk-visually-hidden">lines of code in <%= component[:name] %> stylesheet</span>
             </a>
@@ -81,36 +96,52 @@
         </td>
         <td class="govuk-table__cell" data-component-type="print_stylesheet">
           <% if component[:print_stylesheet_exists] %>
-            Yes
+            <span title="This component has a print stylesheet">
+              Yes
+            </span>
           <% end %>
         </td>
         <td class="govuk-table__cell" data-component-type="javascript">
           <% if component[:javascript_exists] %>
-            <a href="<%= component[:javascript_link] %>" class="govuk-link">
+            <a href="<%= component[:javascript_link] %>" class="govuk-link" title="This file has <%= component[:javascript_lines] %> lines">
               <%= component[:javascript_lines] %>
               <span class="govuk-visually-hidden">lines of code in <%= component[:name] %> javascript</span>
             </a>
           <% end %>
         </td>
-        <td class="govuk-table__cell" data-component-type="test">
-          <% if component[:test_exists] %>
-            <a href="<%= component[:test_link] %>" class="govuk-link">
-              <%= component[:test_lines] %>
-              <span class="govuk-visually-hidden">lines of code in <%= component[:name] %> test</span>
-            </a>
-          <% end %>
-        </td>
         <td class="govuk-table__cell" data-component-type="javascript_test">
           <% if component[:javascript_test_exists] %>
-            <a href="<%= component[:javascript_test_link] %>" class="govuk-link">
+            <a href="<%= component[:javascript_test_link] %>" class="govuk-link" title="This file has <%= component[:javascript_test_lines] %> lines">
               <%= component[:javascript_test_lines] %>
               <span class="govuk-visually-hidden">lines of code in <%= component[:name] %> javascript test</span>
             </a>
           <% end %>
         </td>
+        <td class="govuk-table__cell" data-component-type="uses-govuk-frontend-css">
+          <% if component[:uses_govuk_frontend_css] %>
+            <span title="Component includes styles imported from govuk-frontend">
+              Yes
+            </span>
+          <% end %>
+        </td>
+        <td class="govuk-table__cell" data-component-type="uses-govuk-frontend-js">
+          <% if component[:uses_govuk_frontend_js] %>
+            <span title="Component includes JavaScript imported from govuk-frontend">
+              Yes
+            </span>
+          <% end %>
+        </td>
+        <td class="govuk-table__cell" data-component-type="test">
+          <% if component[:test_exists] %>
+            <a href="<%= component[:test_link] %>" class="govuk-link" title="This file has <%= component[:test_lines] %> lines">
+              <%= component[:test_lines] %>
+              <span class="govuk-visually-hidden">lines of code in <%= component[:name] %> test</span>
+            </a>
+          <% end %>
+        </td>
         <td class="govuk-table__cell" data-component-type="helper">
           <% if component[:helper_exists] %>
-            <a href="<%= component[:helper_link] %>" class="govuk-link">
+            <a href="<%= component[:helper_link] %>" class="govuk-link" title="This file has <%= component[:helper_lines] %> lines">
               <%= component[:helper_lines] %>
               <span class="govuk-visually-hidden">lines of code in <%= component[:name] %> helper</span>
             </a>

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

@@ -26,31 +26,32 @@
           <%= tag.p error, id: "#{id}-error", class: "govuk-error-message" %>
         <% end %>
 
-        <%= tag.ul class: cb_helper.list_classes, data: {
+        <%= tag.div class: "govuk-checkboxes", data: {
           module: ('govuk-checkboxes' if cb_helper.has_conditional),
           nested: ('true' if cb_helper.has_nested)
         } do %>
           <% cb_helper.items.each_with_index do |item, index| %>
             <% if item === :or %>
-              <%= tag.li t('components.checkboxes.or'), class: "gem-c-checkboxes__divider" %>
+              <%= tag.div t('components.checkboxes.or'), class: "govuk-checkboxes__divider" %>
             <% else %>
-              <%= tag.li class: "govuk-checkboxes__item" do %>
+              <%= tag.div class: "govuk-checkboxes__item" do %>
                 <%= cb_helper.checkbox_markup(item, index) %>
 
-                <% if item[:conditional] %>
-                  <%= tag.div item[:conditional], id: "#{id}-#{index}-conditional-#{index}", class: "govuk-checkboxes__conditional govuk-checkboxes__conditional--hidden" %>
-                <% end %>
-
                 <% if item[:items].present? %>
-                  <%= tag.ul id: "#{id}-nested-#{index}", class: "govuk-checkboxes govuk-checkboxes--nested", data: { parent: "#{id}-#{index}" } do %>
+                  <%= tag.div id: "#{id}-nested-#{index}", class: "govuk-checkboxes--nested", data: { parent: "#{id}-#{index}" } do %>
                     <% item[:items].each_with_index do |nested_item, nested_index| %>
-                      <%= tag.li class: "govuk-checkboxes__item" do %>
+                      <%= tag.div class: "govuk-checkboxes__item" do %>
                         <%= cb_helper.checkbox_markup(nested_item, "#{index}-#{nested_index}") %>
                       <% end %>
                     <% end %>
                   <% end %>
                 <% end %>
               <% end %>
+
+              <% if item[:conditional] %>
+                <%= tag.div item[:conditional], id: "#{id}-#{index}-conditional-#{index}", class: "govuk-checkboxes__conditional govuk-checkboxes__conditional--hidden" %>
+              <% end %>
+
             <% end %>
           <% end %>
         <% end %>

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

@@ -13,6 +13,7 @@ accessibility_criteria: |
   The component must:
 
   * inform the user how many items are in the list
+  * ensure dashes before each list item are hidden from screen readers
 shared_accessibility_criteria:
   - link
 uses_component_wrapper_helper: true

data/lib/govuk_publishing_components/app_helpers/environment.rb

@@ -8,7 +8,7 @@ module GovukPublishingComponents
       def self.current_acceptance_environment
         return "example" if ENV["HEROKU"]
 
-        GOVUK_ENVIRONMENTS.include?(ENV["GOVUK_ENVIRONMENT_NAME"]) ? ENV["GOVUK_ENVIRONMENT_NAME"] : "development"
+        GOVUK_ENVIRONMENTS.include?(ENV["GOVUK_ENVIRONMENT"]) ? ENV["GOVUK_ENVIRONMENT"] : "development"
       end
     end
   end

data/lib/govuk_publishing_components/presenters/checkboxes_helper.rb

@@ -7,7 +7,6 @@ module GovukPublishingComponents
       attr_reader :items,
                   :name,
                   :css_classes,
-                  :list_classes,
                   :error,
                   :has_conditional,
                   :has_nested,
@@ -24,8 +23,6 @@ module GovukPublishingComponents
         @css_classes << "govuk-checkboxes--small" if options[:small]
         @error = true if options[:error]
 
-        @list_classes = %w[govuk-checkboxes gem-c-checkboxes__list]
-
         # check if any item is set as being conditional
         @has_conditional = options[:items].any? { |item| item.is_a?(Hash) && item[:conditional] }
         @has_nested = options[:items].any? { |item| item.is_a?(Hash) && item[:items] }
@@ -100,7 +97,7 @@ module GovukPublishingComponents
         capture do
           concat check_box_tag(checkbox_name, checkbox[:value], checked, class: "govuk-checkboxes__input", id: checkbox_id, data:)
           concat content_tag(:label, checkbox[:label], for: checkbox_id, class: "govuk-label govuk-checkboxes__label")
-          concat content_tag(:span, checkbox[:hint], id: "#{checkbox_id}-item-hint", class: "govuk-hint govuk-checkboxes__hint") if checkbox[:hint]
+          concat content_tag(:div, checkbox[:hint], id: "#{checkbox_id}-item-hint", class: "govuk-hint govuk-checkboxes__hint") if checkbox[:hint]
         end
       end
     end

data/lib/govuk_publishing_components/presenters/component_wrapper_helper.rb

@@ -10,6 +10,7 @@ module GovukPublishingComponents
         check_aria_is_valid(@options[:aria]) if @options.include?(:aria)
         check_role_is_valid(@options[:role]) if @options.include?(:role)
         check_lang_is_valid(@options[:lang]) if @options.include?(:lang)
+        check_open_is_valid(@options[:open]) if @options.include?(:open)
       end
 
       def all_attributes
@@ -21,6 +22,7 @@ module GovukPublishingComponents
         attributes[:class] = @options[:classes] unless @options[:classes].blank?
         attributes[:role] = @options[:role] unless @options[:role].blank?
         attributes[:lang] = @options[:lang] unless @options[:lang].blank?
+        attributes[:open] = @options[:open] unless @options[:open].blank?
 
         attributes
       end
@@ -55,6 +57,11 @@ module GovukPublishingComponents
         @options[:lang] = lang
       end
 
+      def set_open(open_attribute)
+        check_open_is_valid(open_attribute)
+        @options[:open] = open_attribute
+      end
+
     private
 
       def check_id_is_valid(id)
@@ -114,6 +121,15 @@ module GovukPublishingComponents
         end
       end
 
+      def check_open_is_valid(open_attribute)
+        return if open_attribute.blank?
+
+        options = [true, false]
+        unless options.include? open_attribute
+          raise(ArgumentError, "open attribute (#{open_attribute}) is not recognised")
+        end
+      end
+
       def extend_string(option, string)
         ((@options[option] ||= "") << " #{string}").strip!
       end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "38.4.2".freeze
+  VERSION = "39.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 38.4.2
+  version: 39.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -1605,7 +1605,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.14
 signing_key: 
 specification_version: 4
 summary: A gem to document components in GOV.UK frontend applications