govuk_publishing_components 21.58.0 → 21.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e165b9cdf4f92f02644b2e82c82c8c6b116379b86d5d4508437dc8ccfd25bd81
-  data.tar.gz: 2be44d5b0942debce73048f3bec3786cc9398ae37de322016b253ccfe220442a
+  metadata.gz: 1d31d1f48a5d3491e568c0412fdbbcfaf2e1a98a71aaf84ff703556e83a19b6b
+  data.tar.gz: 45ecc8d0b068dd621f3a5a4fb2b4add39f542cfe14ba22f5a2e9828ae9638438
 SHA512:
-  metadata.gz: 9a3a06af1b35ecdc351c4d1da7b65ac95bd601a9b2f6f0049e17a84b15768872e478b44c170d2e9579992fd0ca092d60c4c91c049ed2edf48c0e0a1e9f9e7b44
-  data.tar.gz: 457fceebbb07d07f8afa3c0ab11c7057659a7df2e6d7a409a472ecfdb5a821147cd6918c4568ded4a063a9c53ef5a9764543c0de507085f62b33f1f0aca91df1
+  metadata.gz: 89fd3c928d07a3cda0079255ea980e7731bda3eb1b9033eeba53131f85f05c12a9073334b17a04b86c050ddd5329fcef28be3ced3373137b6c4385cefb1070aa
+  data.tar.gz: 82d9e99c1d65f4441404f8a76c18ccc11a3357250ac579bdd6844e8f0b57c63d41dfca449cb848b3f86e37576c7e5dcd6eb3e373860c5d1814882ac52a6d3052

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

@@ -20,9 +20,11 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
         var detailsClick = detailsComponent.querySelector('[data-details-track-click]')
         var that = this
 
-        detailsClick.addEventListener('click', function (event) {
-          that.trackDefault(detailsComponent)
-        })
+        if (detailsClick) {
+          detailsClick.addEventListener('click', function (event) {
+            that.trackDefault(detailsComponent)
+          })
+        }
       }
     }
 

data/app/controllers/govuk_publishing_components/audit_controller.rb

@@ -0,0 +1,52 @@
+module GovukPublishingComponents
+  class AuditController < GovukPublishingComponents::ApplicationController
+    def show
+      path = Dir.pwd
+
+      components = AuditComponents.new(path)
+      applications = analyse_applications(File.expand_path("..", path))
+      compared_data = AuditComparer.new(components.data, applications)
+
+      @applications = compared_data.data
+      @components = compared_data.gem_data
+    end
+
+  private
+
+    def analyse_applications(path)
+      results = []
+      applications = %w[
+        calculators
+        collections
+        collections-publisher
+        content-data-admin
+        content-publisher
+        email-alert-frontend
+        feedback
+        finder-frontend
+        frontend
+        government-frontend
+        govspeak-preview
+        info-frontend
+        licence-finder
+        manuals-frontend
+        release
+        search-admin
+        service-manual-frontend
+        signon
+        smart-answers
+        static
+        travel-advice-publisher
+        whitehall
+      ].sort
+
+      applications.each do |application|
+        application_path = [path, application].join("/")
+        app = AuditApplications.new(application_path, application)
+        results << app.data
+      end
+
+      results
+    end
+  end
+end

data/app/models/govuk_publishing_components/audit_applications.rb

@@ -0,0 +1,99 @@
+module GovukPublishingComponents
+  class AuditApplications
+    attr_reader :data
+
+    def initialize(path, name)
+      templates = Dir["#{path}/app/views/**/*.html.erb"]
+      stylesheets = Dir["#{path}/app/assets/stylesheets/**/*.scss"]
+      javascripts = Dir["#{path}/app/assets/javascripts/**/*.js"]
+
+      find_templates = /(?<=govuk_publishing_components\/components\/)[\/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_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_javascripts = /\/\/[ ]*= require govuk_publishing_components\/all_components/
+      find_javascripts = /(?<=require govuk_publishing_components\/components\/)[a-zA-Z_-]+/
+
+      components_in_templates = find_components(templates, find_templates, "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_ruby = /(?<=render\(["']{1}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"], find_ruby, "ruby") || []
+      end
+
+      components_in_ruby = components_in_ruby.flatten.uniq
+
+      @data = {
+        name: name,
+        application_found: application_exists(path),
+        components_found: [
+          {
+            location: "templates",
+            components: components_in_templates,
+          },
+          {
+            location: "stylesheets",
+            components: components_in_stylesheets,
+          },
+          {
+            location: "print_stylesheets",
+            components: components_in_print_stylesheets,
+          },
+          {
+            location: "javascripts",
+            components: components_in_javascripts,
+          },
+          {
+            location: "ruby",
+            components: components_in_ruby,
+          },
+        ],
+      }
+    end
+
+  private
+
+    def find_components(files, find, type)
+      components_found = []
+
+      files.each do |file|
+        src = File.read(file)
+        components_found << find_match(find, src, type)
+      end
+
+      components_found.flatten.uniq.sort
+    end
+
+    def find_match(find, src, type)
+      return %w[all] if src.match(@find_all_stylesheets) && type == "stylesheets"
+      return %w[all] if src.match(@find_all_print_stylesheets) && type == "print_stylesheets"
+      return %w[all] if src.match(@find_all_javascripts) && type == "javascripts"
+
+      matches = src.scan(find)
+      all_matches = []
+      matches.each do |match|
+        all_matches << clean_file_name(match.tr('[])\'"', ""))
+      end
+
+      all_matches
+    end
+
+    def clean_file_name(name)
+      name.tr("_-", " ").strip
+    end
+
+    def application_exists(directory)
+      File.directory?(directory)
+    end
+  end
+end

data/app/models/govuk_publishing_components/audit_comparer.rb

@@ -0,0 +1,172 @@
+module GovukPublishingComponents
+  class AuditComparer
+    attr_reader :data, :gem_data
+
+    def initialize(gem_data, results)
+      @gem_data = gem_data
+      @data = sort_results(results)
+      @gem_data[:components_by_application] = get_components_by_application
+    end
+
+  private
+
+    def prettify_key(key)
+      key.to_s.gsub("_", " ").capitalize
+    end
+
+    def sort_results(results)
+      data = []
+
+      results.each do |result|
+        templates = result[:components_found].find { |c| c[:location] == "templates" }
+        stylesheets = result[:components_found].find { |c| c[:location] == "stylesheets" }
+        print_stylesheets = result[:components_found].find { |c| c[:location] == "print_stylesheets" }
+        javascripts = result[:components_found].find { |c| c[:location] == "javascripts" }
+        ruby = result[:components_found].find { |c| c[:location] == "ruby" }
+
+        @all_stylesheets = true if stylesheets[:components].include?("all")
+        @all_print_stylesheets = true if print_stylesheets[:components].include?("all")
+        @all_javascripts = true if javascripts[:components].include?("all")
+
+        templates[:components] = include_any_components_within_components(templates[:components])
+
+        warnings = []
+        warnings << warn_about_missing_components(result[:components_found])
+        warnings << warn_about_missing_assets(result[:components_found])
+        warnings = warnings.flatten
+
+        data << {
+          name: result[:name],
+          application_found: result[:application_found],
+          summary: [
+            {
+              name: "Components in templates",
+              value: templates[:components].flatten.uniq.sort.join(", "),
+            },
+            {
+              name: "Components in stylesheets",
+              value: stylesheets[:components].join(", "),
+            },
+            {
+              name: "Components in print stylesheets",
+              value: print_stylesheets[:components].join(", "),
+            },
+            {
+              name: "Components in javascripts",
+              value: javascripts[:components].join(", "),
+            },
+            {
+              name: "Components in ruby",
+              value: ruby[:components].join(", "),
+            },
+          ],
+          warnings: warnings,
+          warning_count: warnings.length,
+        }
+      end
+
+      data
+    end
+
+    def include_any_components_within_components(components)
+      @gem_data[:components_containing_components].each do |component|
+        components << component[:sub_components] if components.include?(component[:component])
+      end
+
+      components.flatten.uniq.sort
+    end
+
+    def create_warning(component, message)
+      {
+        component: component,
+        message: message,
+      }
+    end
+
+    def find_missing_items(first_group, second_group)
+      warnings = []
+
+      first_group.each do |first|
+        first_location = first[:location]
+
+        second_group.each do |second|
+          second_location = second[:location]
+          second_location = "code" if %w[templates ruby].include?(second_location)
+          in_current = find_missing(second[:components].clone, first[:components].clone)
+
+          next if second[:components].include?("all")
+
+          in_current.each do |component|
+            if @gem_data.include?("component_#{second_location}".to_sym)
+              warnings << create_warning(component, "Included in #{first_location} but not #{second_location}") if @gem_data["component_#{second_location}".to_sym].include?(component)
+            end
+          end
+        end
+      end
+
+      warnings
+    end
+
+    def warn_about_missing_assets(components)
+      warnings = []
+
+      code = components.select { |c| c[:location] == "templates" || c[:location] == "ruby" }
+      code = [
+        {
+          location: "code",
+          components: code.map { |c| c[:components] }.flatten.uniq.sort,
+        },
+      ]
+      assets = components.select { |c| c[:location] == "stylesheets" || c[:location] == "print_stylesheets" || c[:location] == "javascripts" }
+
+      warnings << find_missing_items(code, assets)
+      warnings << find_missing_items(assets, code)
+      warnings.flatten
+    end
+
+    def warn_about_missing_components(results)
+      warnings = []
+
+      results.each do |result|
+        location = result[:location]
+        result[:components].each do |component|
+          warnings << create_warning(component, "Included in #{location} but component does not exist") if component_does_not_exist(component)
+        end
+      end
+
+      warnings
+    end
+
+    def component_does_not_exist(component)
+      !@gem_data[:component_code].include?(component) unless component == "all"
+    end
+
+    def find_missing(needle, haystack)
+      (haystack - needle).flatten.sort
+    end
+
+    def get_components_by_application
+      results = []
+
+      @gem_data[:component_listing].each do |component|
+        found_in_applications = []
+
+        @data.each do |application|
+          name = application[:name]
+
+          application[:summary].each do |item|
+            found_in_applications << name if item[:value].include?(component[:name])
+          end
+        end
+
+        results << {
+          component: component[:name],
+          count: found_in_applications.uniq.length,
+          list: found_in_applications.uniq.join(", "),
+        }
+      end
+
+      results
+    end
+  end
+end

data/app/models/govuk_publishing_components/audit_components.rb

@@ -0,0 +1,139 @@
+module GovukPublishingComponents
+  class AuditComponents
+    attr_reader :data
+
+    def initialize(path)
+      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}/*.html.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("/"))
+
+      @data = {
+        component_code: @components,
+        component_stylesheets: @component_stylesheets,
+        component_print_stylesheets: @component_print_stylesheets,
+        component_javascripts: @component_javascripts,
+        component_tests: @component_tests,
+        component_js_tests: @component_js_tests,
+        components_containing_components: find_all_partials_in(templates),
+        component_listing: list_all_component_details,
+      }
+    end
+
+  private
+
+    def find_files(files, replace)
+      files.map { |file| clean_file_name(file.gsub(replace, "")) }.sort
+    end
+
+    def clean_file_name(name)
+      name.tr("/_-", " ").gsub(".html.erb", "").gsub(".scss", "").gsub(".js", "").gsub("spec", "").gsub(".rb", "").strip
+    end
+
+    def get_component_name_from_full_path(path)
+      path.gsub("/_", "/").gsub(@templates_full_path, "").gsub(".html.erb", "").tr('\"\'', "")
+    end
+
+    def get_component_link(component)
+      "/component-guide/#{component.gsub(' ', '_')}"
+    end
+
+    def find_all_partials_in(templates)
+      components = []
+
+      templates.each do |template|
+        partials_found = true
+        components_to_search = [template]
+        components_found = []
+
+        while partials_found
+          extra_components = find_partials_in(components_to_search)
+
+          if extra_components.any?
+            components_found << extra_components
+            components_to_search = extra_components
+          else
+            partials_found = false
+            components_found = components_found.flatten.reject { |c| c.include?("/") }
+
+            if components_found.any?
+              component_name = clean_file_name(get_component_name_from_full_path(template))
+              components << {
+                component: component_name,
+                link: get_component_link(component_name),
+                sub_components: components_found.uniq.sort.map { |name| clean_file_name(name) },
+              }
+            end
+          end
+        end
+      end
+
+      components.sort_by { |c| c[:component] }
+    end
+
+    def find_partials_in(components)
+      extra_components = []
+      components.each do |component|
+        extra_components << components_within_component(component)
+      end
+
+      extra_components.flatten.uniq.sort
+    end
+
+    def components_within_component(file)
+      file = get_component_name_from_full_path(file)
+      file = "#{@templates_full_path}#{file}.html.erb".sub(/.*\K\//, "/_")
+      data = File.read(file)
+      match = data.scan(/["']{1}(govuk_publishing_components\/components\/[\/a-z_-]+["']{1})/)
+      match.flatten.uniq.map(&:to_s).sort.map do |m|
+        m.gsub("govuk_publishing_components/components/", "").tr('\"\'', "")
+      end
+    end
+
+    def list_all_component_details
+      all_component_information = []
+
+      @components.each do |component|
+        all_component_information << {
+          name: component,
+          link: get_component_link(component),
+          stylesheet: check_component_has("stylesheet", component),
+          print_stylesheet: check_component_has("print_stylesheet", component),
+          javascript: check_component_has("javascript", component),
+          tests: check_component_has("test", component),
+          js_tests: check_component_has("js_test", component),
+        }
+      end
+
+      all_component_information
+    end
+
+    def check_component_has(a_thing, component)
+      look_in = @component_stylesheets if a_thing == "stylesheet"
+      look_in = @component_print_stylesheets if a_thing == "print_stylesheet"
+      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"
+
+      true if look_in.include?(component)
+    end
+  end
+end

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

@@ -0,0 +1,221 @@
+<% content_for :title, "Component audit" %>
+
+<%= render 'govuk_publishing_components/components/title', title: "Components audit", margin_top: 0; %>
+
+<div class="govuk-tabs" data-module="govuk-tabs">
+  <h2 class="govuk-tabs__title">
+    Contents
+  </h2>
+  <ul class="govuk-tabs__list">
+    <li class="govuk-tabs__list-item govuk-tabs__list-item--selected">
+      <a class="govuk-tabs__tab" href="#applications">
+        Applications
+      </a>
+    </li>
+    <li class="govuk-tabs__list-item">
+      <a class="govuk-tabs__tab" href="#components-gem">
+        Components
+      </a>
+    </li>
+  </ul>
+  <div class="govuk-tabs__panel" id="applications">
+    <h2 class="govuk-heading-l">Applications</h2>
+
+    <% if @applications.any? %>
+      <details class="govuk-details" data-module="govuk-details">
+        <summary class="govuk-details__summary">
+          <span class="govuk-details__summary-text">
+            How to use this information
+          </span>
+        </summary>
+        <div class="govuk-details__text">
+          <p class="govuk-body">This page shows information about component use on GOV.UK. This information has been cross referenced with the components in the gem to produce warnings where e.g. a print stylesheet for a component exists but has not been included in an application.</p>
+          <p class="govuk-body">Warnings should be investigated, although there may be a reason why the application has been configured as it is. Note that 'code' can refer to templates or ruby code.</p>
+        </div>
+      </details>
+
+      <div class="govuk-accordion" data-module="govuk-accordion" id="accordion-with-summary-sections">
+        <% @applications.each_with_index do |application, index| %>
+          <div class="govuk-accordion__section ">
+            <div class="govuk-accordion__section-header">
+              <h2 class="govuk-accordion__section-heading">
+                <span class="govuk-accordion__section-button" id="accordion-with-summary-sections-heading-<%= index %>">
+                  <%= application[:name] %>
+                </span>
+              </h2>
+              <div class="govuk-accordion__section-summary govuk-body" id="accordion-with-summary-sections-summary-<%= index %>">
+                <% if application[:application_found] %>
+                  Warnings:
+                  <% if application[:warning_count] > 0 %>
+                    <strong class="govuk-tag govuk-tag--red"><%= application[:warning_count] %></strong>
+                  <% else %>
+                    <%= application[:warning_count] %>
+                  <% end %>
+                <% else %>
+                  <strong class="govuk-tag govuk-tag--red">Application not found</strong>
+                <% end %>
+              </div>
+            </div>
+            <div id="accordion-with-summary-sections-content-<%= index %>" class="govuk-accordion__section-content" aria-labelledby="accordion-with-summary-sections-heading-<%= index %>">
+              <% if application[:application_found] %>
+                <% application[:warnings].each do |warning| %>
+                  <p class="govuk-body">
+                    <strong class="govuk-tag">Warn</strong>
+                    <strong><%= warning[:component] %></strong> - <%= warning[:message] %>
+                  </p>
+                <% end %>
+
+                <h3 class="govuk-heading-m">Components used</h3>
+
+                <dl class="govuk-summary-list">
+                  <% application[:summary].each do |item| %>
+                    <div class="govuk-summary-list__row">
+                      <dt class="govuk-summary-list__key">
+                        <%= item[:name] %>
+                      </dt>
+                      <dd class="govuk-summary-list__value">
+                        <% if item[:value].length > 0 %>
+                          <%= item[:value] %>
+                        <% else %>
+                          None
+                        <% end %>
+                      </dd>
+                    </div>
+                  <% end %>
+                </dl>
+              <% 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 %>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    <% else %>
+      <p class="govuk-body">No applications found.</p>
+    <% end %>
+  </div>
+
+  <div class="govuk-tabs__panel govuk-tabs__panel--hidden" id="components-gem">
+    <h2 class="govuk-heading-l">Components</h2>
+
+    <% if @components.any? %>
+      <div class="govuk-accordion" data-module="govuk-accordion" id="accordion-default">
+        <div class="govuk-accordion__section ">
+          <div class="govuk-accordion__section-header">
+            <h2 class="govuk-accordion__section-heading">
+              <span class="govuk-accordion__section-button" id="accordion-default-heading-1">
+                Component files
+              </span>
+            </h2>
+            <div class="govuk-accordion__section-summary govuk-body" id="accordion-with-summary-sections-summary-1">
+              Lists what files each component has
+            </div>
+          </div>
+          <div id="accordion-default-content-1" class="govuk-accordion__section-content" aria-labelledby="accordion-default-heading-1">
+            <table class="govuk-table">
+              <thead class="govuk-table__head">
+                <tr class="govuk-table__row">
+                  <th scope="col" class="govuk-table__header">Component</th>
+                  <th scope="col" class="govuk-table__header">Stylesheet</th>
+                  <th scope="col" class="govuk-table__header">Print stylesheet</th>
+                  <th scope="col" class="govuk-table__header">JS</th>
+                  <th scope="col" class="govuk-table__header">Test</th>
+                  <th scope="col" class="govuk-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>
+          </div>
+        </div>
+
+        <div class="govuk-accordion__section ">
+          <div class="govuk-accordion__section-header">
+            <h2 class="govuk-accordion__section-heading">
+              <span class="govuk-accordion__section-button" id="accordion-default-heading-2">
+                Components containing components
+              </span>
+            </h2>
+            <div class="govuk-accordion__section-summary govuk-body" id="accordion-with-summary-sections-summary-2">
+              Shows which components contain other components
+            </div>
+          </div>
+          <div id="accordion-default-content-2" class="govuk-accordion__section-content" aria-labelledby="accordion-default-heading-2">
+            <dl class="govuk-summary-list">
+              <% @components[:components_containing_components].each do |component| %>
+                <div class="govuk-summary-list__row">
+                  <dt class="govuk-summary-list__key">
+                    <a href="<%= component[:link] %>" class="govuk-link"><%= component[:component] %></a>
+                  </dt>
+                  <dd class="govuk-summary-list__value">
+                    <%= component[:sub_components].join(', ') %>
+                  </dd>
+                </div>
+              <% end %>
+            </dl>
+          </div>
+        </div>
+        <div class="govuk-accordion__section ">
+          <div class="govuk-accordion__section-header">
+            <h2 class="govuk-accordion__section-heading">
+              <span class="govuk-accordion__section-button" id="accordion-default-heading-2">
+                Components by application
+              </span>
+            </h2>
+            <div class="govuk-accordion__section-summary govuk-body" id="accordion-with-summary-sections-summary-2">
+              Shows which applications use each component
+            </div>
+          </div>
+          <div id="accordion-default-content-2" class="govuk-accordion__section-content" aria-labelledby="accordion-default-heading-2">
+            <dl class="govuk-summary-list">
+              <% @components[:components_by_application].each do |component| %>
+                <div class="govuk-summary-list__row">
+                  <dt class="govuk-summary-list__key">
+                    <%= component[:component] %> (<%= component[:count] %>)
+                  </dt>
+                  <dd class="govuk-summary-list__value">
+                    <%= component[:list] %>
+                  </dd>
+                </div>
+              <% end %>
+            </dl>
+          </div>
+        </div>
+      </div>
+    <% else %>
+      <p class="govuk-body">No components found.</p>
+    <% end %>
+  </div>
+</div>

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

@@ -2,7 +2,11 @@
 
 <div class="component-markdown">
   <p>Components are packages of template, style, behaviour and documentation that live in your application.</p>
-  <p>See the <a href="https://github.com/alphagov/govuk_publishing_components">govuk_publishing_components gem</a> for further details, or <a href="https://docs.publishing.service.gov.uk/manual/components.html#component-guides">a list of all component guides</a>. Read about how to <a href="https://github.com/alphagov/govuk_publishing_components/blob/master/docs/publishing-to-rubygems.md">release a new version of the gem</a>.</p>
+  <p>See the <a href="https://github.com/alphagov/govuk_publishing_components">govuk_publishing_components gem</a> for further details, or <a href="https://docs.publishing.service.gov.uk/manual/components.html#component-guides">a list of all component guides</a>.</p>
+  <ul>
+    <li>Read about how to <a href="https://github.com/alphagov/govuk_publishing_components/blob/master/docs/publishing-to-rubygems.md">release a new version of the gem</a></li>
+    <li><a href="/component-guide/audit">View component audits</a></li>
+  </ul>
 </div>
 
 <form role="search" data-module="filter-components" class="component-search">

data/config/routes.rb

@@ -1,4 +1,5 @@
 GovukPublishingComponents::Engine.routes.draw do
+  get "/audit" => "audit#show", as: :audit
   root to: "component_guide#index", as: :component_guide
   get ":component/preview" => "component_guide#preview", as: :component_preview_all
   get ":component/:example/preview" => "component_guide#preview", as: :component_preview

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "21.58.0".freeze
+  VERSION = "21.59.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 21.58.0
+  version: 21.59.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -597,12 +597,17 @@ files:
 - app/assets/stylesheets/govuk_publishing_components/components/print/_translation-nav.scss
 - app/assets/stylesheets/govuk_publishing_components/govuk_frontend_support.scss
 - app/controllers/govuk_publishing_components/application_controller.rb
+- app/controllers/govuk_publishing_components/audit_controller.rb
 - app/controllers/govuk_publishing_components/component_guide_controller.rb
 - app/helpers/govuk_publishing_components/application_helper.rb
+- app/models/govuk_publishing_components/audit_applications.rb
+- app/models/govuk_publishing_components/audit_comparer.rb
+- app/models/govuk_publishing_components/audit_components.rb
 - app/models/govuk_publishing_components/component_doc.rb
 - app/models/govuk_publishing_components/component_docs.rb
 - app/models/govuk_publishing_components/component_example.rb
 - app/models/govuk_publishing_components/shared_accessibility_criteria.rb
+- app/views/govuk_publishing_components/audit/show.html.erb
 - app/views/govuk_publishing_components/component_guide/_application_stylesheet.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_call.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_component.html.erb