govuk_publishing_components 34.11.0 → 34.13.0

data/app/models/govuk_publishing_components/audit_components.rb

@@ -34,12 +34,19 @@ module GovukPublishingComponents
   private
 
     def compile_data(path)
+      component_file_details = get_component_file_details(path)
+      helper_usage = get_helper_usage(component_file_details)
+
+      # remove the template file reference as not needed
+      component_file_details.map { |detail| detail.delete(:template_file) }
+
       {
         gem_found: true,
         component_code: clean_files(@all_templates, @templates_full_path).sort,
         components_containing_components: find_all_partials_in(@all_templates),
-        component_file_details: get_component_file_details(path),
+        component_file_details: component_file_details,
         component_numbers: @component_numbers,
+        helper_usage: helper_usage,
       }
     end
 
@@ -96,6 +103,8 @@ module GovukPublishingComponents
       type = detail[:type]
       file = detail[:file]
       details["#{type}_exists".to_sym] = false
+      # save the location of the template to later grep for helper use
+      details["#{type}_file".to_sym] = file if type == "template"
       if File.file?(file)
         # we don't have separate print stylesheets anymore
         # so check the main stylesheet for print styles
@@ -215,5 +224,50 @@ module GovukPublishingComponents
 
       link
     end
+
+    def get_helper_usage(components)
+      helpers = [
+        {
+          name: "Brand helper",
+          link: "lib/govuk_publishing_components/app_helpers/brand_helper.rb",
+          match: /(GovukPublishingComponents::AppHelpers::BrandHelper.new)/,
+          used_by: [],
+        },
+        {
+          name: "Component wrapper helper",
+          link: "lib/govuk_publishing_components/presenters/component_wrapper_helper.rb",
+          match: /(GovukPublishingComponents::Presenters::ComponentWrapperHelper.new)/,
+          used_by: [],
+        },
+        {
+          name: "Heading helper",
+          link: "lib/govuk_publishing_components/presenters/heading_helper.rb",
+          match: /(GovukPublishingComponents::Presenters::HeadingHelper.new)/,
+          used_by: [],
+        },
+        {
+          name: "Shared helper",
+          link: "lib/govuk_publishing_components/presenters/shared_helper.rb",
+          match: /(GovukPublishingComponents::Presenters::SharedHelper.new)/,
+          used_by: [],
+        },
+      ]
+
+      components.each do |component|
+        file = component[:template_file]
+        next unless File.file?(file)
+
+        helpers.each do |helper|
+          next unless File.foreach(file).grep(helper[:match]).present?
+
+          helper[:used_by] << {
+            name: component[:name],
+            link: component[:template_file].split("/components/")[1],
+          }
+        end
+      end
+
+      helpers
+    end
   end
 end

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

@@ -63,9 +63,54 @@
     items: component_items
   %>
 
+  <% helpers_by_component = capture do %>
+    <dl class="govuk-summary-list">
+      <% @components[:helper_usage].each do |helper| %>
+        <div class="govuk-summary-list__row">
+          <dt class="govuk-summary-list__key">
+            <a href="https://github.com/alphagov/govuk_publishing_components/blob/main/<%= helper[:link] %>" class="govuk-link"><%= helper[:name] %></a> 
+          </dt>
+          <dd class="govuk-summary-list__value">
+            <details class="govuk-details" data-module="govuk-details">
+              <summary class="govuk-details__summary">
+                <span class="govuk-details__summary-text">
+                  Used by <%= helper[:used_by].length %> components
+                </span>
+              </summary>
+              <div class="govuk-details__text">
+                <ul class="govuk-list govuk-list--bullet">
+                  <% helper[:used_by].each do |component| %>
+                    <% github_link = 'https://github.com/alphagov/govuk_publishing_components/tree/main/app/views/govuk_publishing_components/components/' %>                    
+                    <li>
+                      <a href="<%= github_link %><%= component[:link] %>" class="govuk-link"><%= component[:name] %></a>
+                    </li>
+                  <% end %>            
+                </ul>
+              </div>
+            </details>            
+          </dd>
+        </div>
+      <% end %>
+    </dl>
+  <% end %>
+
+  <%
+    component_items << {
+      heading: {
+        text: "Helpers by component",
+      },
+      summary: {
+        text: "Shows which components use common helpers",
+      },
+      content: {
+        html: helpers_by_component
+      },
+    }
+  %>
+
   <%= render 'items_in_applications',
     heading: 'Helpers by application',
-    summary: 'Shows any applications that use helper classes from the components gem',
+    summary: 'Shows any applications that use helpers from the components gem',
     content: @components[:helpers_used_by_applications],
     items: component_items
   %>

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("accordion")
+
   local_assigns[:margin_bottom] ||= 6
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
 

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("action-link")
+
   local_assigns[:margin_bottom] ||= 0
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
 

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("attachment")
+
   attachment = GovukPublishingComponents::Presenters::AttachmentHelper.new(attachment)
   target ||= "_self"
   hide_opendocument_metadata ||= false

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("attachment-link")
+
   attachment = GovukPublishingComponents::Presenters::AttachmentHelper.new(attachment)
   target ||= nil
   data_attributes ||= {}

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("back-link")
+
   text ||= t('components.back_link.back')
   data_attributes ||= nil
 %>

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("big-number")
+
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   big_number_helper = GovukPublishingComponents::Presenters::BigNumberHelper.new(local_assigns)
 
@@ -34,7 +36,7 @@
       </span>
     <% end %>
   <% end %>
-  
+
   <%= tag.div class: classes, aria: aria do %>
     <% unless href.nil? %>
       <%= link_to big_number_value, href, class: "govuk-link gem-c-big-number__link", data: data_attributes %>

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("breadcrumbs")
+
   border ||= false
   breadcrumbs ||= []
   collapse_on_mobile ||= false

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("button")
+
   # button_helper.css_classes generates "gem-c-button"
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   local_assigns[:classes] = shared_helper.classes

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("cards")
+
   heading ||= nil
   items ||= nil
   sub_heading_level ||= 3

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("character-count")
+
   id ||= "character-count-#{SecureRandom.hex(4)}"
   maxlength ||= nil
   maxwords ||= nil

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("checkboxes")
+
   # cb_helper.css_classes generates "gem-c-checkboxes"
   cb_helper = GovukPublishingComponents::Presenters::CheckboxesHelper.new(local_assigns)
   id = cb_helper.id

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

@@ -1,4 +1,6 @@
 <%-
+  add_gem_component_stylesheet("contents-list")
+
   cl_helper = GovukPublishingComponents::Presenters::ContentsListHelper.new(local_assigns)
   underline_links ||= false
   aria_label ||= t("components.contents_list.contents")

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("contextual-guidance")
+
   id ||= nil
   title ||= nil
   content ||= nil

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("contextual-sidebar")
+
   ga4_tracking ||= false
   request.query_parameters[:ga4_tracking] = ga4_tracking
   navigation = GovukPublishingComponents::Presenters::ContextualNavigation.new(content_item, request)

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("cookie-banner")
+
   id ||= 'global-cookie-message'
   title ||= t("components.cookie_banner.title")
   text ||= t("components.cookie_banner.text")

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("date-input")
+
   id ||= "input-#{SecureRandom.hex(4)}"
   name ||= nil
   items ||= [

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("details")
+
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
 
   open ||= nil

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("devolved-nations")
+
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   devolved_nations_helper = GovukPublishingComponents::Presenters::DevolvedNationsHelper.new(local_assigns)
 

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("document-list")
+
   items ||= []
 
   classes = "gem-c-document-list"

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("emergency-banner")
+
   heading ||= ""
   short_description ||= nil
   link ||= nil

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("error-alert")
+
   id ||= nil
   description ||= nil
   data_attributes ||= {}

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("error-message")
+
   id ||= "error-message-#{SecureRandom.hex(4)}"
   classes ||= ''
   css_classes = %w( gem-c-error-message govuk-error-message )

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("error-summary")
+
   id ||= "error-summary-#{SecureRandom.hex(4)}"
   title ||= false
   description ||= false

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("feedback")
+
   def utf_encode(element)
     element.is_a?(String) ? element.encode : element
   end

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("fieldset")
+
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
 
   text = text || yield

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("file-upload")
+
   id ||= "file-upload-#{SecureRandom.hex(4)}"
   value ||= nil
   accept ||= nil

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

@@ -1,4 +1,5 @@
 <%
+  add_gem_component_stylesheet("govspeak")
   inverse ||= false
   direction_class = "direction-#{direction}" if local_assigns.include?(:direction)
   disable_youtube_expansions = local_assigns.fetch(:disable_youtube_expansions) if local_assigns.include?(:disable_youtube_expansions)

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("govspeak-html-publication")
+
   govspeak_locals = {}
   govspeak_locals[:content] = local_assigns.fetch(:content) if local_assigns.include?(:content)
   govspeak_locals[:direction] = local_assigns.fetch(:direction) if local_assigns.include?(:direction)

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("heading")
+
   brand ||= false
   lang = local_assigns[:lang].presence
 

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("hint")
+
   id ||= "hint-#{SecureRandom.hex(4)}"
   right_to_left ||= false
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("image-card")
+
   sizes ||= false
   brand ||= false
 
@@ -17,7 +19,7 @@
   heading_link_classes = %w[
     gem-c-image-card__title-link
     govuk-link
-  ] 
+  ]
   heading_link_classes << brand_helper.color_class
   extra_link_classes = %w[
     gem-c-image-card__list-item-link
@@ -59,8 +61,8 @@
                 %>
               <% else %>
                 <%= link[:text] %>
-              <% end %>  
-            </li>    
+              <% end %>
+            </li>
           <% end %>
         </ul>
       <% end %>

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("input")
+
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
 
   autocomplete ||= nil

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("inset-text")
+
   id ||= "inset-text-#{SecureRandom.hex(4)}"
   margin_top ||= 6
   margin_bottom ||= 6

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("intervention")
+
   dismiss_text ||= false
   suggestion_link_text ||= false
   suggestion_link_url ||= false

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("inverse-header")
+
   css_classes = []
   css_classes << " gem-c-inverse-header--full-width" if local_assigns[:full_width]
   css_classes << " gem-c-inverse-header--padding-top" unless local_assigns[:padding_top].eql?(false)

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("label")
+
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
 
   hint_text ||= ""

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("layout-footer")
+
   meta ||= []
   navigation ||= []
   with_border ||= false

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

@@ -1,4 +1,8 @@
-<% product_name ||= "Publishing" %>
+<%
+  add_gem_component_stylesheet("layout-for-admin")
+
+  product_name ||= "Publishing"
+%>
 
 <!DOCTYPE html>
 <html lang="en" class="govuk-template">

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("layout-for-public")
+
   emergency_banner ||= nil
   full_width ||= false
   global_bar ||= nil

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("layout-header")
+
   environment ||= nil
   full_width ||= false
   navigation_aria_label ||= t("components.layout_header.top_level")

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("layout-super-navigation-header")
+
   logo_link ||= "https://www.gov.uk/"
   logo_link_title ||= t("components.layout_super_navigation_header.logo_link_title")
   logo_text = t("components.layout_super_navigation_header.logo_text")
@@ -262,6 +264,9 @@
               <form
                 class="gem-c-layout-super-navigation-header__search-form"
                 id="search"
+                data-module="ga4-form-tracker"
+                data-ga4-form='{ "event_name": "search", "type": "header menu bar", "section": "Search GOV.UK", "action": "Search", "url": "/search/all" }'
+                data-ga4-form-include-text
                 action="/search"
                 method="get"
                 role="search"

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("lead-paragraph")
+
   text ||= ""
   inverse ||= false
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("metadata")
+
   from ||= []
   from = Array(from)
 

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("modal-dialogue")
+
   id ||= "modal-dialogue-#{SecureRandom.hex(4)}"
   wide ||= false
   data_attributes = {}

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("notice")
+
   title ||= false
   description_text ||= false
   description_govspeak ||= false

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("organisation-logo")
+
   logo_helper = GovukPublishingComponents::Presenters::OrganisationLogoHelper.new(local_assigns)
   brand_helper = GovukPublishingComponents::AppHelpers::BrandHelper.new(organisation[:brand])
 

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("panel")
+
   description ||= false
   prepend ||= false
   append ||= false

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

@@ -1,4 +1,6 @@
 <%
+add_gem_component_stylesheet("phase-banner")
+
 app_name ||= nil
 phase ||= nil
 message ||= nil

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

@@ -1,4 +1,9 @@
-<% if local_assigns.include?(:next_page) || local_assigns.include?(:previous_page) %>
+<%
+  add_gem_component_stylesheet("previous-and-next-navigation")
+
+  if local_assigns.include?(:next_page) || local_assigns.include?(:previous_page)
+%>
+  
   <nav
     class="govuk-pagination govuk-pagination--block"
     role="navigation"

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("print-link")
+
   text ||= t('components.print_link.text')
   href ||= nil
   data_attributes ||= {}

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("radio")
+
   local_assigns[:margin_bottom] ||= 6
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   id ||= nil

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

@@ -7,6 +7,10 @@
   data[:module] << " ga4-link-tracker" if ga4_tracking
 %>
 
+<%
+  add_gem_component_stylesheet("related-navigation")
+%>
+
 <% if related_nav_helper.related_navigation? %>
   <% random = SecureRandom.hex(4) %>
   <%= tag.div(class: "gem-c-related-navigation", data: data) do %>

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("reorderable-list")
+
   items ||= []
   input_name ||= "ordering"
   data_attributes ||= {}

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("search")
+
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   heading_helper = GovukPublishingComponents::Presenters::HeadingHelper.new(local_assigns)
 

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("select")
+
   # select_helper.css_classes generates "gem-c-select"
   id ||= false
   label ||= false

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("share-links")
+
   links ||= []
   title ||= false
   track_as_sharing ||= false

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

@@ -1,4 +1,6 @@
 <%
+  add_gem_component_stylesheet("show-password")
+
   disable_form_submit_check ||= false
   label ||= nil
   value ||= nil