govuk_publishing_components 24.7.1 → 24.9.3

data/app/controllers/govuk_publishing_components/component_guide_controller.rb

@@ -13,6 +13,7 @@ module GovukPublishingComponents
       @components_in_use_sass = components_in_use_sass(false)
       @components_in_use_print_sass = components_in_use_sass(true)
       @components_in_use_js = components_in_use_js
+      @index_audit_summary = index_audit_summary
     end
 
     def show
@@ -161,5 +162,13 @@ module GovukPublishingComponents
         h[:url] = component_doc_path(component_doc.id) if component_example
       end
     end
+
+    def index_audit_summary
+      components_gem_path = Gem.loaded_specs["govuk_publishing_components"].full_gem_path
+      components = AuditComponents.new(components_gem_path, true)
+      application = AuditApplications.new(@application_path, GovukPublishingComponents::ApplicationHelper.get_application_name_from_path(@application_path))
+      compared_data = AuditComparer.new(components.data, [application.data], true)
+      compared_data.applications_data[0]
+    end
   end
 end

data/app/helpers/govuk_publishing_components/application_helper.rb

@@ -1,4 +1,7 @@
 module GovukPublishingComponents
   module ApplicationHelper
+    def self.get_application_name_from_path(path)
+      path.to_s.split("/")[-1]
+    end
   end
 end

data/app/models/govuk_publishing_components/audit_applications.rb

@@ -86,8 +86,8 @@ module GovukPublishingComponents
           gem_style_references = find_code_references(file, src, /gem-c-[-_a-zA-Z]+/)
           @gem_style_references << gem_style_references if gem_style_references
         end
-      rescue StandardError
-        puts "File #{file} not found"
+      rescue StandardError => e
+        puts e.message
       end
 
       components_found.flatten.uniq.sort
@@ -108,7 +108,7 @@ module GovukPublishingComponents
     end
 
     def find_code_references(file, src, regex)
-      clean_file_path = /(?<=#{Regexp.escape(@path)}\/)[\/a-zA-Z_-]+.[a-zA-Z.]+/
+      clean_file_path = /(?<=#{Regexp.escape(@path.to_s)}\/)[\/a-zA-Z_-]+.[a-zA-Z.]+/
 
       return file[clean_file_path] if regex.match?(src)
     end

data/app/models/govuk_publishing_components/audit_comparer.rb

@@ -2,10 +2,10 @@ module GovukPublishingComponents
   class AuditComparer
     attr_reader :applications_data, :gem_data
 
-    def initialize(gem_data, results)
+    def initialize(gem_data, results, simple)
       if gem_data[:gem_found]
         @gem_data = gem_data
-        @applications_data = sort_results(results)
+        @applications_data = sort_results(results, simple)
         @gem_data[:components_by_application] = get_components_by_application || []
       end
     end
@@ -16,7 +16,8 @@ module GovukPublishingComponents
       key.to_s.gsub("_", " ").capitalize
     end
 
-    def sort_results(results)
+    def sort_results(results, simple)
+      @simple = simple
       data = []
 
       results.each do |result|
@@ -40,10 +41,9 @@ module GovukPublishingComponents
           warnings << warn_about_jquery_references(result[:jquery_references])
           warnings = warnings.flatten
 
-          data << {
-            name: result[:name],
-            application_found: result[:application_found],
-            summary: [
+          summary = []
+          unless @simple
+            summary = [
               {
                 name: "Components in templates",
                 value: templates[:components].flatten.uniq.sort.join(", "),
@@ -64,7 +64,13 @@ module GovukPublishingComponents
                 name: "Components in ruby",
                 value: ruby[:components].join(", "),
               },
-            ],
+            ]
+          end
+
+          data << {
+            name: result[:name],
+            application_found: result[:application_found],
+            summary: summary,
             warnings: warnings,
             warning_count: warnings.length,
             gem_style_references: result[:gem_style_references],
@@ -180,6 +186,8 @@ module GovukPublishingComponents
     end
 
     def get_components_by_application
+      return [] if @simple
+
       results = []
       found_something = false
 

data/app/models/govuk_publishing_components/audit_components.rb

@@ -2,16 +2,17 @@ module GovukPublishingComponents
   class AuditComponents
     attr_reader :data
 
-    def initialize(path)
+    def initialize(path, simple)
       @data = {
         gem_found: false,
       }
-      @data = compile_data(path) if Dir.exist?(path)
+      @data = compile_data(path, simple) if Dir.exist?(path)
     end
 
   private
 
-    def compile_data(path)
+    def compile_data(path, simple)
+      @simple = simple
       templates_path = "app/views/govuk_publishing_components/components"
       stylesheets_path = "app/assets/stylesheets/govuk_publishing_components/components"
       print_stylesheets_path = "app/assets/stylesheets/govuk_publishing_components/components/print"
@@ -128,6 +129,8 @@ module GovukPublishingComponents
     end
 
     def list_all_component_details
+      return [] if @simple
+
       all_component_information = []
 
       @components.each do |component|

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

@@ -0,0 +1,126 @@
+<%
+  title = "Applications"
+  title = "This application" unless ENV["MAIN_COMPONENT_GUIDE"]
+%>
+<%= render "govuk_publishing_components/components/heading", {
+  text: title,
+  font_size: "l",
+  margin_bottom: 6
+} %>
+
+<% if @applications.any? %>
+  <%= render "govuk_publishing_components/components/details", {
+    title: "How to use this information"
+  } do %>
+    <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>
+  <% end %>
+
+  <%
+    accordion_content = nil
+    summary = nil
+  %>
+  <% application_items = @applications.map do |application| %>
+    <%
+      summary = '<strong class="govuk-tag govuk-tag--red">Application not found</strong>'
+
+      if application[:application_found]
+        summary = "Warnings: 0"
+        summary = "Warnings: <strong class=\"govuk-tag govuk-tag--red\">#{application[:warning_count]}</strong>" if application[:warning_count] > 0
+      end
+    %>
+
+    <% accordion_content = capture do %>
+      <% 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 %>
+
+        <% if application[:jquery_references].any? %>
+          <%= render "govuk_publishing_components/components/heading", {
+            text: "jQuery references",
+            font_size: "m",
+            margin_bottom: 4,
+            heading_level: 3,
+          } %>
+          <p class="govuk-body">This shows JavaScript files that might contain jQuery, which we are trying to remove our dependency on.</p>
+          <ul class="govuk-list govuk-list--bullet">
+            <% application[:jquery_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 %>
+    <% end %>
+
+    <%
+      {
+        heading: {
+          text: application[:name]
+        },
+        summary: {
+          text: sanitize(summary)
+        },
+        content: {
+          html: sanitize(accordion_content)
+        },
+      }
+    %>
+  <% end %>
+
+  <% if ENV["MAIN_COMPONENT_GUIDE"] %>
+    <%= render "govuk_publishing_components/components/accordion", {
+      items: application_items
+    } %>
+  <% else %>
+    <p class="govuk-body"><%= sanitize(summary) %></p>
+    <%= accordion_content %>
+  <% end %>
+<% else %>
+  <p class="govuk-body">No applications found.</p>
+<% end %>

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

@@ -0,0 +1,142 @@
+<% if @applications_found %>
+  <%= render "govuk_publishing_components/components/heading", {
+    text: "Components",
+    font_size: "l",
+    margin_bottom: 6,
+  } %>
+<% end %>
+
+<% if @components.any? %>
+  <% component_items = [] %>
+
+  <% component_files = capture do %>
+    <table class="govuk-table">
+      <thead class="govuk-table__head">
+        <tr class="govuk-table__row">
+          <th scope="col" class="govuk-table__header sticky-table-header">Component</th>
+          <th scope="col" class="govuk-table__header sticky-table-header">Stylesheet</th>
+          <th scope="col" class="govuk-table__header sticky-table-header">Print stylesheet</th>
+          <th scope="col" class="govuk-table__header sticky-table-header">JS</th>
+          <th scope="col" class="govuk-table__header sticky-table-header">Test</th>
+          <th scope="col" class="govuk-table__header sticky-table-header">JS test</th>
+        </tr>
+      </thead>
+      <tbody class="govuk-table__body">
+        <% @components[:component_listing].each do |component| %>
+          <tr class="govuk-table__row">
+            <th scope="row" class="govuk-table__header">
+              <a href="<%= component[:link] %>" class="govuk-link"><%= component[:name] %></a>
+            </th>
+            <td class="govuk-table__cell">
+              <% if component[:stylesheet] %>
+                <strong class="govuk-tag govuk-tag--green">Yes</strong>
+              <% end %>
+            </td>
+            <td class="govuk-table__cell">
+              <% if component[:print_stylesheet] %>
+                <strong class="govuk-tag govuk-tag--green">Yes</strong>
+              <% end %>
+            </td>
+            <td class="govuk-table__cell">
+              <% if component[:javascript] %>
+                <strong class="govuk-tag govuk-tag--green">Yes</strong>
+              <% end %>
+            </td>
+            <td class="govuk-table__cell">
+              <% if component[:tests] %>
+                <strong class="govuk-tag govuk-tag--green">Yes</strong>
+              <% end %>
+            </td>
+            <td class="govuk-table__cell">
+              <% if component[:js_tests] %>
+                <strong class="govuk-tag govuk-tag--green">Yes</strong>
+              <% end %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  <% end %>
+
+  <%
+    component_items << {
+      heading: {
+        text: "Component files",
+      },
+      summary: {
+        text: "Lists what files each component has",
+      },
+      content: {
+        html: component_files
+      },
+    }
+  %>
+
+  <% components_within_components = capture do %>
+    <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>
+  <% end %>
+
+  <%
+    component_items << {
+      heading: {
+        text: "Components containing other components",
+      },
+      summary: {
+        text: "Shows which components contain other components",
+      },
+      content: {
+        html: components_within_components
+      },
+    }
+  %>
+
+  <% if @applications_found %>
+    <% components_by_application = capture do %>
+      <% 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>
+      <% end %>
+    <% end %>
+
+    <%
+      component_items << {
+        heading: {
+          text: "Components by application",
+        },
+        summary: {
+          text: "Shows which applications use each component",
+        },
+        content: {
+          html: components_by_application
+        },
+      }
+    %>
+  <% end %>
+
+  <%= render "govuk_publishing_components/components/accordion", {
+    items: component_items
+  } %>
+<% else %>
+  <p class="govuk-body">No components found.</p>
+<% end %>

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

@@ -2,284 +2,29 @@
 
 <%= 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>
-
-        <% #application_items = [] %>
-        <% application_items = @applications.map do |application| %>
-          <%
-            summary = '<strong class="govuk-tag govuk-tag--red">Application not found</strong>'
-
-            if application[:application_found]
-              summary = "Warnings: 0"
-              if application[:warning_count] > 0
-                summary = "Warnings: <strong class=\"govuk-tag govuk-tag--red\">#{application[:warning_count]}</strong>"
-              end
-            end
-          %>
-
-          <% accordion_content = capture do %>
-            <% 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 %>
-
-              <% if application[:jquery_references].any? %>
-                <%= render "govuk_publishing_components/components/heading", {
-                  text: "jQuery references",
-                  font_size: "m",
-                  margin_bottom: 4,
-                  heading_level: 3,
-                } %>
-                <p class="govuk-body">This shows JavaScript files that might contain jQuery, which we are trying to remove our dependency on.</p>
-                <ul class="govuk-list govuk-list--bullet">
-                  <% application[:jquery_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 %>
-          <% end %>
-
-          <%
-            {
-              heading: {
-                text: application[:name]
-              },
-              summary: {
-                text: sanitize(summary)
-              },
-              content: {
-                html: sanitize(accordion_content)
-              },
-            }
-          %>
-        <% end %>
-
-        <%= render "govuk_publishing_components/components/accordion", {
-          items: application_items
-        } %>
-      <% 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? %>
-        <% component_files = capture do %>
-          <table class="govuk-table">
-            <thead class="govuk-table__head">
-              <tr class="govuk-table__row">
-                <th scope="col" class="govuk-table__header sticky-table-header">Component</th>
-                <th scope="col" class="govuk-table__header sticky-table-header">Stylesheet</th>
-                <th scope="col" class="govuk-table__header sticky-table-header">Print stylesheet</th>
-                <th scope="col" class="govuk-table__header sticky-table-header">JS</th>
-                <th scope="col" class="govuk-table__header sticky-table-header">Test</th>
-                <th scope="col" class="govuk-table__header sticky-table-header">JS test</th>
-              </tr>
-            </thead>
-            <tbody class="govuk-table__body">
-              <% @components[:component_listing].each do |component| %>
-                <tr class="govuk-table__row">
-                  <th scope="row" class="govuk-table__header">
-                    <a href="<%= component[:link] %>" class="govuk-link"><%= component[:name] %></a>
-                  </th>
-                  <td class="govuk-table__cell">
-                    <% if component[:stylesheet] %>
-                      <strong class="govuk-tag govuk-tag--green">Yes</strong>
-                    <% end %>
-                  </td>
-                  <td class="govuk-table__cell">
-                    <% if component[:print_stylesheet] %>
-                      <strong class="govuk-tag govuk-tag--green">Yes</strong>
-                    <% end %>
-                  </td>
-                  <td class="govuk-table__cell">
-                    <% if component[:javascript] %>
-                      <strong class="govuk-tag govuk-tag--green">Yes</strong>
-                    <% end %>
-                  </td>
-                  <td class="govuk-table__cell">
-                    <% if component[:tests] %>
-                      <strong class="govuk-tag govuk-tag--green">Yes</strong>
-                    <% end %>
-                  </td>
-                  <td class="govuk-table__cell">
-                    <% if component[:js_tests] %>
-                      <strong class="govuk-tag govuk-tag--green">Yes</strong>
-                    <% end %>
-                  </td>
-                </tr>
-              <% end %>
-            </tbody>
-          </table>
-        <% end %>
-
-        <% components_within_components = capture do %>
-          <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>
-        <% end %>
-
-        <% components_by_application = capture do %>
-          <% 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 %>
-        <% end %>
+<% applications = capture do %>
+  <%= render "applications" %>
+<% end %>
 
-        <%
-          component_items = [
-            {
-              heading: {
-                text: "Component files",
-              },
-              summary: {
-                text: "Lists what files each component has",
-              },
-              content: {
-                html: component_files
-              },
-            },
-            {
-              heading: {
-                text: "Components containing other components",
-              },
-              summary: {
-                text: "Shows which components contain other components",
-              },
-              content: {
-                html: components_within_components
-              },
-            },
-            {
-              heading: {
-                text: "Components by application",
-              },
-              summary: {
-                text: "Shows which applications use each component",
-              },
-              content: {
-                html: components_by_application
-              },
-            },
-          ]
-        %>
+<% components = capture do %>
+  <%= render "components" %>
+<% end %>
 
-        <%= render "govuk_publishing_components/components/accordion", {
-          items: component_items
-        } %>
-      <% else %>
-        <p class="govuk-body">No components found.</p>
-      <% end %>
-    </div>
-  </div>
+<% if @applications_found %>
+  <%= render "govuk_publishing_components/components/tabs", {
+    tabs: [
+      {
+        id: "applications",
+        label: "Applications",
+        content: applications,
+      },
+      {
+        id: "components-gem",
+        label: "Components",
+        content: components,
+      }
+    ]
+  } %>
 <% else %>
-  <p class="govuk-body">Component auditing is only available when the component guide is running locally as a standalone app.</p>
+  <%= render "components" %>
 <% end %>