govuk_publishing_components 21.58.0 → 21.60.3

data/app/models/govuk_publishing_components/audit_comparer.rb

@@ -0,0 +1,198 @@
+module GovukPublishingComponents
+  class AuditComparer
+    attr_reader :applications_data, :gem_data
+
+    def initialize(gem_data, results)
+      if gem_data[:gem_found]
+        @gem_data = gem_data
+        @applications_data = sort_results(results)
+        @gem_data[:components_by_application] = get_components_by_application || []
+      end
+    end
+
+  private
+
+    def prettify_key(key)
+      key.to_s.gsub("_", " ").capitalize
+    end
+
+    def sort_results(results)
+      data = []
+
+      results.each do |result|
+        if result[:application_found]
+          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 << warn_about_style_overrides(result[:gem_style_references])
+          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,
+            gem_style_references: result[:gem_style_references],
+          }
+        else
+          data << {
+            name: result[:name],
+            application_found: result[:application_found],
+          }
+        end
+      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 warn_about_style_overrides(results)
+      warnings = []
+
+      results.each do |result|
+        warnings << create_warning("Possible component style override", result) if result.include? ".scss"
+        warnings << create_warning("Possible hard coded component markup", result) if [".html", ".rb"].any? { |needle| result.include? needle }
+      end
+
+      warnings
+    end
+
+    def find_missing(needle, haystack)
+      (haystack - needle).flatten.sort
+    end
+
+    def get_components_by_application
+      results = []
+      found_something = false
+
+      @gem_data[:component_listing].each do |component|
+        found_in_applications = []
+
+        @applications_data.each do |application|
+          next unless application[:application_found]
+
+          name = application[:name]
+          found_something = true
+
+          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 if found_something
+    end
+  end
+end

data/app/models/govuk_publishing_components/audit_components.rb

@@ -0,0 +1,158 @@
+module GovukPublishingComponents
+  class AuditComponents
+    attr_reader :data
+
+    def initialize(path)
+      @data = {
+        gem_found: false,
+      }
+      @data = compile_data(path) if Dir.exist?(path)
+    end
+
+  private
+
+    def compile_data(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}/*.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("/"))
+
+      {
+        gem_found: true,
+        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
+
+    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(".erb", "")
+        .gsub(".scss", "")
+        .gsub(".js", "")
+        .gsub("spec", "")
+        .gsub(".rb", "")
+        .strip
+    end
+
+    def get_component_name_from_full_path(path)
+      path.gsub(/.*\K\/_/, "/")
+        .gsub(@templates_full_path, "")
+        .gsub(".html.erb", "")
+        .gsub(".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,258 @@
+<% content_for :title, "Component audit" %>
+
+<%= render 'govuk_publishing_components/components/title', title: "Components audit", margin_top: 0; %>
+
+<% if ENV["MAIN_COMPONENT_GUIDE"] %>
+  <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">
+      <%= render "govuk_publishing_components/components/heading", {
+        text: "Applications",
+        font_size: "l",
+        margin_bottom: 6
+      } %>
+
+      <% if @applications.any? %>
+        <details class="govuk-details" data-module="govuk-details">
+          <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 %>
+
+                  <%= render "govuk_publishing_components/components/heading", {
+                    text: "Components used",
+                    font_size: "m",
+                    margin_bottom: 4,
+                    heading_level: 3,
+                  } %>
+
+                  <dl class="govuk-summary-list">
+                    <% application[:summary].each do |item| %>
+                      <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>
+
+                  <% if application[:gem_style_references].any? %>
+                    <%= render "govuk_publishing_components/components/heading", {
+                      text: "Component references",
+                      font_size: "m",
+                      margin_bottom: 4,
+                      heading_level: 3,
+                    } %>
+
+                    <p class="govuk-body">This shows instances of `gem-c-` classes found in the application. If a reference is found in a stylesheet or in code a warning is created, as this could be a style override or hard coded component markup.</p>
+                    <ul class="govuk-list govuk-list--bullet">
+                      <% application[:gem_style_references].each do |ref| %>
+                        <li><%= ref %></li>
+                      <% end %>
+                    </ul>
+                  <% end %>
+                <% else %>
+                  <p class="govuk-body">This application was not found. This could be because you do not have this repository checked out locally.</p>
+                <% end %>
+              </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">
+      <%= render "govuk_publishing_components/components/heading", {
+        text: "Components",
+        font_size: "l",
+        margin_bottom: 6,
+      } %>
+
+      <% if @components.any? %>
+        <div class="govuk-accordion" data-module="govuk-accordion" id="accordion-default">
+          <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 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>
+            </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">
+              <% if @components[:components_by_application].any? %>
+                <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>
+              <% else %>
+                <p class="govuk-body">Sorry, no applications found.</p>
+              <% end %>
+            </div>
+          </div>
+        </div>
+      <% else %>
+        <p class="govuk-body">No components found.</p>
+      <% end %>
+    </div>
+  </div>
+<% else %>
+  <p class="govuk-body">Component auditing is only available when the component guide is running locally as a standalone app.</p>
+<% end %>