govuk_publishing_components 24.5.0 → 24.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3b0fa1ddc43a2e926edce2c1f0417db5cbb0b1924caa41f91b817f3fc0d5647
-  data.tar.gz: 9e165fe5648aa0d6be420b8a00517c5295b58d5c6050b4b55646c8924272338f
+  metadata.gz: '0970bb03929bfc783d477b903ce46f8f8fa47ad800b74303f61c4f2e473a914e'
+  data.tar.gz: e1bc0b5d89be175278b988b30b85269b7128fc9fa5fbb3286b582bf66c91b7f0
 SHA512:
-  metadata.gz: 75bb0f5311883c23c5b83cfb18cf619acc923fed727d174f4d72ea8cae9aacd99e1a701889b72779cc76d72b2596a2e0d4765fa8c11a150c01c7554f95e76719
-  data.tar.gz: 51c83f3aadc86d2ed048e34c739c4d2a976524855152890a392c1f633e8e371914bdf64525c6297c310b2855bd6062dddb80930923f994c61ca469dbbba88953
+  metadata.gz: 7dfb6d556b81cc890eec0fa6884a7738d2c47b0b5bba80d0f8b35788682ba8cd0c4d9528370f7175c3b2361f47592fa405ebb43e8b5fa43954fc57bc23960dcc
+  data.tar.gz: 3e58e5f9b229c8c85e734b74fd2ba98db39cd9f66ba80bab12cf8ac6acc8a482a059f200d9b721e530c190a6dff73915c9641377a77afaef5506eef8d4ca9aaf

data/app/assets/javascripts/component_guide/application.js

@@ -1,2 +1,5 @@
 //= require_tree ./vendor
 //= require_tree .
+//= require ../govuk_publishing_components/dependencies
+//= require ../govuk_publishing_components/components/accordion
+//= require ../govuk_publishing_components/components/tabs

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

@@ -293,8 +293,10 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
 
   // Navigate to and open accordions with anchored content on page load if a hash is present
   GemAccordion.prototype.openByAnchorOnLoad = function () {
-    if (window.location.hash && this.$module.querySelector(window.location.hash)) {
-      this.openForAnchor(window.location.hash)
+    var splitHash = window.location.hash.split('#')[1]
+
+    if (window.location.hash && document.getElementById(splitHash)) {
+      this.openForAnchor(splitHash)
     }
   }
 
@@ -305,20 +307,20 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
 
     links.forEach(function (link) {
       if (link.pathname === window.location.pathname) {
-        link.addEventListener('click', this.openForAnchor.bind(this, link.hash))
+        link.addEventListener('click', this.openForAnchor.bind(this, link.hash.split('#')[1]))
       }
     }.bind(this))
   }
 
   // Find the parent accordion section for the given id and open it
   GemAccordion.prototype.openForAnchor = function (hash) {
-    var target = document.querySelector(hash)
+    var target = document.getElementById(hash)
     var section = this.getContainingSection(target)
 
     this.setExpanded(true, section)
   }
 
-  // Loop through the given ids ancestors until the parent section class is found
+  // Loop through the given id's ancestors until the parent section class is found
   GemAccordion.prototype.getContainingSection = function (target) {
     while (!target.classList.contains(this.sectionClass)) {
       target = target.parentElement

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

@@ -1,7 +1,8 @@
 /* eslint-env jquery */
 // = require govuk/components/details/details.js
 window.GOVUK = window.GOVUK || {}
-window.GOVUK.Modules = window.GOVUK.Modules || {};
+window.GOVUK.Modules = window.GOVUK.Modules || {}
+window.GOVUK.Modules.Details = window.GOVUKFrontend;
 
 (function (Modules) {
   function GovukDetails () { }

data/app/assets/javascripts/govuk_publishing_components/lib/cookie-functions.js

@@ -25,6 +25,7 @@
     govuk_browser_upgrade_dismisssed: 'settings',
     govuk_not_first_visit: 'settings',
     analytics_next_page_call: 'usage',
+    user_nation: 'settings',
     _ga: 'usage',
     _gid: 'usage',
     _gat: 'usage',

data/app/assets/javascripts/govuk_publishing_components/modules.js

@@ -40,7 +40,9 @@
           module = new GOVUK.Modules[moduleName]()
           module.start(element)
           element.data('module-started', true)
-        } else if ( // GOV.UK Frontend Modules
+        }
+
+        if ( // GOV.UK Frontend Modules
           typeof GOVUK.Modules[frontendModuleName] === 'function' &&
           GOVUK.Modules[frontendModuleName].prototype.init &&
           !started

data/app/assets/stylesheets/component_guide/application.scss

@@ -148,7 +148,7 @@ $gem-guide-border-width: 1px;
 
 .component-guide-preview--simple {
   border: 0;
-  padding: 0;
+  padding: govuk-spacing(2);
 
   &:before {
     display: none;

data/app/assets/stylesheets/govuk_publishing_components/components/_layout-for-public.scss

@@ -1,4 +1,13 @@
 .gem-c-layout-for-public {
-  margin: 0;
   font-family: $govuk-font-family;
 }
+
+.gem-c-layout-for-public__blue-bar {
+  background: $govuk-brand-colour;
+  height: govuk-spacing(2);
+}
+
+.js-enabled .gem-c-layout-for-public__global-banner-wrapper {
+  margin-top: - govuk-spacing(2);
+  position: relative;
+}

data/app/assets/stylesheets/govuk_publishing_components/components/_layout-header.scss

@@ -78,12 +78,14 @@
   }
 }
 
-.gem-c-layout-header__search.govuk-grid-column-one-third-from-desktop,
-.gem-c-layout-header__logo.govuk-grid-column-one-third-from-desktop,
-.gem-c-layout-header__search.govuk-grid-column-one-third,
-.gem-c-layout-header__logo.govuk-grid-column-two-thirds {
-  padding-right: 0;
-  padding-left: 0;
+@include govuk-compatibility(govuk_template) {
+  .gem-c-layout-header__search.govuk-grid-column-one-third-from-desktop,
+  .gem-c-layout-header__logo.govuk-grid-column-one-third-from-desktop,
+  .gem-c-layout-header__search.govuk-grid-column-one-third,
+  .gem-c-layout-header__logo.govuk-grid-column-two-thirds {
+    padding-right: 0;
+    padding-left: 0;
+  }
 }
 
 .gem-c-layout-header__logo,
@@ -104,7 +106,6 @@
 
 .gem-c-header__content.govuk-header__content {
   width: auto;
-  padding-left: 0;
 
   @include govuk-media-query($from: desktop) {
     float: right;

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

@@ -9,7 +9,6 @@ $large-input-size: 50px;
 .gem-c-search__label {
   @include govuk-font($size: 19, $line-height: $input-size);
   display: block;
-  background: govuk-colour("white");
   color: $govuk-text-colour;
 
   h1 {
@@ -25,6 +24,7 @@ $large-input-size: 50px;
     padding-left: govuk-spacing(3);
     z-index: 1;
     color: $govuk-secondary-text-colour;
+    background: govuk-colour("white");
   }
 
   // match label colour with the label component colour
@@ -144,6 +144,10 @@ $large-input-size: 50px;
 }
 
 .gem-c-search--on-govuk-blue {
+  .gem-c-search__label {
+    color: govuk-colour("white");
+  }
+
   .gem-c-search__input {
     border-width: 0;
 
@@ -191,9 +195,19 @@ $large-input-size: 50px;
 }
 
 .gem-c-search--no-border {
+  .gem-c-search__label {
+    color: govuk-colour("white");
+  }
+
   .gem-c-search__input[type="search"] {
     border: 0;
   }
+
+  .js-enabled & {
+    .gem-c-search__label {
+      color: $govuk-secondary-text-colour;
+    }
+  }
 }
 
 .gem-c-search--large {

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

@@ -38,3 +38,15 @@
 .gem-c-summary__block {
   @include govuk-responsive-margin(6, "bottom");
 }
+
+.gem-c-summary-list--wide-title {
+  @include govuk-media-query($from: 'tablet') {
+    .govuk-summary-list__key {
+      width: 60%;
+    }
+
+    .govuk-summary-list__value {
+      width: 20%;
+    }
+  }
+}

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

@@ -26,10 +26,5 @@
 }
 
 .gem-c-title__text {
-  @extend %govuk-heading-xl;
   margin: 0;
 }
-
-.gem-c-title__text--long {
-  @extend %govuk-heading-l;
-}

data/app/controllers/govuk_publishing_components/audit_controller.rb

@@ -1,22 +1,7 @@
 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.applications_data || []
-      @components = compared_data.gem_data || []
-    end
-
-  private
-
-    def analyse_applications(path)
-      results = []
-      applications = %w[
-        calculators
+      application_dirs = %w[
         collections
         collections-publisher
         content-data-admin
@@ -42,10 +27,29 @@ module GovukPublishingComponents
         travel-advice-publisher
         whitehall
       ].sort
+      application_dirs = [GovukPublishingComponents::ApplicationHelper.get_application_name_from_path(Rails.root)] unless ENV["MAIN_COMPONENT_GUIDE"]
+
+      gem_path = Gem.loaded_specs["govuk_publishing_components"].full_gem_path
+      gem_path = Dir.pwd if ENV["MAIN_COMPONENT_GUIDE"]
+
+      components = AuditComponents.new(gem_path, false)
+      applications = analyse_applications(File.expand_path("..", gem_path), application_dirs)
+      compared_data = AuditComparer.new(components.data, applications, false)
+
+      @applications = compared_data.applications_data || []
+      @components = compared_data.gem_data || []
+    end
+
+  private
+
+    def analyse_applications(path, application_dirs)
+      results = []
+      @applications_found = false
 
-      applications.each do |application|
+      application_dirs.each do |application|
         application_path = [path, application].join("/")
         app = AuditApplications.new(application_path, application)
+        @applications_found = true if app.data[:application_found]
         results << app.data
       end
 

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 %>