Merge pull request #363 from alphagov/use-govuk-frontend-v5

Upgrade to use govuk-frontend v5

Author: huwd

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 ## Unreleased
+- Upgrade to govuk-frontend v5.6.0 and introduce new Javascript entry point
+  BREAKING: drop support for IE8
+
+You need to
+  - create a `govuk_frontend.js` file your project’s `source/assets/javascripts` directory
+  - add `//= require govuk_frontend_all` into it
 
 - BREAKING: drop support for end-of-life Ruby versions 2.7 and 3.0. The minimum Ruby version is now 3.1.
 - Update gem dependencies.

example/source/javascripts/govuk_frontend.js

@@ -0,0 +1 @@
+//= require govuk_frontend_all

govuk_tech_docs.gemspec

@@ -7,7 +7,7 @@ require "govuk_tech_docs/version"
 `npm install`
 abort "npm install failed" unless $CHILD_STATUS.success?
 
-unless File.exist?("node_modules/govuk-frontend/govuk/all.scss")
+unless File.exist?("node_modules/govuk-frontend/dist/govuk/all.scss")
   abort "govuk-frontend npm package not installed"
 end
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   files_in_git = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
   # Include assets from GOV.UK Frontend library in the distributed gem
-  govuk_frontend_assets = Dir["node_modules/govuk-frontend/**/*.{scss,js,woff,woff2,png,svg,ico}"]
+  govuk_frontend_assets = Dir["node_modules/govuk-frontend/**/*.{scss,js,mjs,woff,woff2,png,svg,ico}"]
 
   spec.files         = files_in_git + govuk_frontend_assets
 
@@ -52,6 +52,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "nokogiri"
   spec.add_dependency "openapi3_parser", "~> 0.9.0"
   spec.add_dependency "redcarpet", "~> 3.6"
+  spec.add_dependency "terser", "~> 1.2.3"
+  spec.add_dependency "sassc-embedded", "~> 1.78.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "capybara", "~> 3.32"

lib/assets/javascripts/_modules/table-of-contents.js

@@ -10,7 +10,7 @@
     this.isMonitoring = false
   }
   StickyOverlapMonitors.prototype.run = function () {
-    var stickyIsVisible = this.$sticky.is(':visible')
+    var stickyIsVisible = this.$sticky.length > 0 && this.$sticky.is(':visible')
     if (stickyIsVisible && !this.isMonitoring) {
       document.addEventListener('focus', this.onFocus, true)
       this.isMonitoring = true
@@ -26,11 +26,13 @@
 
     if (!applicable) { return }
 
-    var stickyEdge = this.$sticky.get(0).getBoundingClientRect().bottom + this.offset
-    var diff = focused.getBoundingClientRect().top - stickyEdge
+    if (this.$sticky && this.$sticky.is(':visible') && this.$sticky.get(0)) {
+      var stickyEdge = this.$sticky.get(0).getBoundingClientRect().bottom + this.offset
+      var diff = focused.getBoundingClientRect().top - stickyEdge
 
-    if (diff < 0) {
-      $(window).scrollTop($(window).scrollTop() + diff)
+      if (diff < 0) {
+        $(window).scrollTop($(window).scrollTop() + diff)
+      }
     }
   }
 

lib/assets/javascripts/govuk_frontend_all.js

@@ -0,0 +1,3 @@
+//= require govuk/all.bundle.js
+const { initAll } = window.GOVUKFrontend
+initAll()

lib/assets/javascripts/govuk_tech_docs.js

@@ -4,9 +4,7 @@
 //= require _vendor/lodash
 //= require _analytics
 //= require _start-modules
-//= require govuk/all.js
 
 $(function () {
   $('.fixedsticky').fixedsticky()
-  GOVUKFrontend.initAll()
 })

lib/assets/stylesheets/_govuk_tech_docs.scss

@@ -11,8 +11,8 @@ $govuk-assets-path: "/assets/govuk/assets/" !default;
 $govuk-new-link-styles: true;
 @import "govuk/base";
 
-@import "govuk/core/all";
-@import "govuk/objects/all";
+@import "govuk/core/index";
+@import "govuk/objects/index";
 
 @import "govuk/components/footer/index";
 @import "govuk/components/header/index";
@@ -22,14 +22,8 @@ $govuk-new-link-styles: true;
 @import "govuk/components/skip-link/index";
 @import "govuk/components/warning-text/index";
 
-@import "govuk/utilities/all";
-@import "govuk/overrides/all";
+@import "govuk/utilities/index";
+@import "govuk/overrides/index";
 
 @import "core";
 @import "vendor/fixedsticky";
-
-// manual Tudor Crown spacing adjustment from govuk-frontend 4.8
-.govuk-header__logotype-crown[width="32"] {
-  top: -3px;
-  margin-right: 2px;
-}

lib/assets/stylesheets/modules/_search.scss

@@ -45,10 +45,6 @@ $input-size: 40px;
     outline: $govuk-focus-width solid $govuk-focus-colour;
     outline-offset: 0;
     box-shadow: inset 0 0 0 $govuk-border-width-form-element * 2 govuk-colour("black");
-
-    @include govuk-if-ie8 {
-      border-width: $govuk-border-width-form-element * 2;
-    }
   }
 }
 

lib/govuk_tech_docs.rb

@@ -10,6 +10,8 @@
 require "nokogiri"
 require "chronic"
 require "active_support/all"
+require "terser"
+require "sassc-embedded"
 
 require "govuk_tech_docs/redirects"
 require "govuk_tech_docs/table_of_contents/helpers"
@@ -23,6 +25,18 @@
 require "govuk_tech_docs/warning_text_extension"
 require "govuk_tech_docs/api_reference/api_reference_extension"
 
+module SassWarningSupressor
+  def warn(message)
+    if message.to_s.match?(/Sass|dart-sass/i)
+      # suppress dart sass warnings
+    else
+      super
+    end
+  end
+end
+
+Warning.extend(SassWarningSupressor)
+
 module GovukTechDocs
   # Configure the tech docs template
   #
@@ -32,7 +46,7 @@ module GovukTechDocs
   def self.configure(context, options = {})
     context.activate :sprockets
 
-    context.sprockets.append_path File.join(__dir__, "../node_modules/govuk-frontend/")
+    context.sprockets.append_path File.join(__dir__, "../node_modules/govuk-frontend/dist")
     context.sprockets.append_path File.join(__dir__, "./source")
 
     context.activate :syntax
@@ -50,14 +64,17 @@ def self.configure(context, options = {})
                 tables: true,
                 no_intra_emphasis: true
 
+    # this doesnt seem to work
+    context.set :sass, { output_style: "nested", quiet_deps: true }
+
     # Reload the browser automatically whenever files change
     context.configure :development do
       activate :livereload, options[:livereload].to_h
     end
 
     context.configure :build do
       activate :autoprefixer
-      activate :minify_javascript, ignore: ["/raw_assets/*"]
+      activate :minify_javascript, compressor: Terser.new, ignore: ["/raw_assets/*"]
     end
 
     config_file = ENV.fetch("CONFIG_FILE", "config/tech-docs.yml")

lib/govuk_tech_docs/meta_tags.rb

@@ -48,7 +48,7 @@ def canonical_url
     attr_reader :config, :current_page
 
     def page_image
-      "#{host}/images/govuk-large.png"
+      "#{host}/assets/govuk/assets/images/govuk-opengraph-image.png"
     end
 
     def site_name

lib/source/favicon.ico

@@ -8,22 +8,18 @@
       <% end %>
         <% if config[:tech_docs][:show_govuk_logo] %>
         <svg
-          aria-hidden="true"
           focusable="false"
-          class="govuk-header__logotype-crown"
+          role="img"
+          class="govuk-header__logotype"
           xmlns="http://www.w3.org/2000/svg"
-          viewBox="0 0 32 30"
+          viewBox="0 0 148 30"
           height="30"
-          width="32"
+          width="148"
+          aria-label="GOV.UK"
         >
-          <path
-            fill="currentColor" fill-rule="evenodd"
-            d="M22.6 10.4c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m-5.9 6.7c-.9.4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m10.8-3.7c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s0 2-1 2.4m3.3 4.8c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4M17 4.7l2.3 1.2V2.5l-2.3.7-.2-.2.9-3h-3.4l.9 3-.2.2c-.1.1-2.3-.7-2.3-.7v3.4L15 4.7c.1.1.1.2.2.2l-1.3 4c-.1.2-.1.4-.1.6 0 1.1.8 2 1.9 2.2h.7c1-.2 1.9-1.1 1.9-2.1 0-.2 0-.4-.1-.6l-1.3-4c-.1-.2 0-.2.1-.3m-7.6 5.7c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m-5 3c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s.1 2 1 2.4m-3.2 4.8c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m14.8 11c4.4 0 8.6.3 12.3.8 1.1-4.5 2.4-7 3.7-8.8l-2.5-.9c.2 1.3.3 1.9 0 2.7-.4-.4-.8-1.1-1.1-2.3l-1.2 4c.7-.5 1.3-.8 2-.9-1.1 2.5-2.6 3.1-3.5 3-1.1-.2-1.7-1.2-1.5-2.1.3-1.2 1.5-1.5 2.1-.1 1.1-2.3-.8-3-2-2.3 1.9-1.9 2.1-3.5.6-5.6-2.1 1.6-2.1 3.2-1.2 5.5-1.2-1.4-3.2-.6-2.5 1.6.9-1.4 2.1-.5 1.9.8-.2 1.1-1.7 2.1-3.5 1.9-2.7-.2-2.9-2.1-2.9-3.6.7-.1 1.9.5 2.9 1.9l.4-4.3c-1.1 1.1-2.1 1.4-3.2 1.4.4-1.2 2.1-3 2.1-3h-5.4s1.7 1.9 2.1 3c-1.1 0-2.1-.2-3.2-1.4l.4 4.3c1-1.4 2.2-2 2.9-1.9-.1 1.5-.2 3.4-2.9 3.6-1.9.2-3.4-.8-3.5-1.9-.2-1.3 1-2.2 1.9-.8.7-2.3-1.2-3-2.5-1.6.9-2.2.9-3.9-1.2-5.5-1.5 2-1.3 3.7.6 5.6-1.2-.7-3.1 0-2 2.3.6-1.4 1.8-1.1 2.1.1.2.9-.3 1.9-1.5 2.1-.9.2-2.4-.5-3.5-3 .6 0 1.2.3 2 .9l-1.2-4c-.3 1.1-.7 1.9-1.1 2.3-.3-.8-.2-1.4 0-2.7l-2.9.9C1.3 23 2.6 25.5 3.7 30c3.7-.5 7.9-.8 12.3-.8"></path>
+          <title>GOV.UK</title>
+          <path d="M22.6 10.4c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m-5.9 6.7c-.9.4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m10.8-3.7c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s0 2-1 2.4m3.3 4.8c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4M17 4.7l2.3 1.2V2.5l-2.3.7-.2-.2.9-3h-3.4l.9 3-.2.2c-.1.1-2.3-.7-2.3-.7v3.4L15 4.7c.1.1.1.2.2.2l-1.3 4c-.1.2-.1.4-.1.6 0 1.1.8 2 1.9 2.2h.7c1-.2 1.9-1.1 1.9-2.1 0-.2 0-.4-.1-.6l-1.3-4c-.1-.2 0-.2.1-.3m-7.6 5.7c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m-5 3c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s.1 2 1 2.4m-3.2 4.8c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m14.8 11c4.4 0 8.6.3 12.3.8 1.1-4.5 2.4-7 3.7-8.8l-2.5-.9c.2 1.3.3 1.9 0 2.7-.4-.4-.8-1.1-1.1-2.3l-1.2 4c.7-.5 1.3-.8 2-.9-1.1 2.5-2.6 3.1-3.5 3-1.1-.2-1.7-1.2-1.5-2.1.3-1.2 1.5-1.5 2.1-.1 1.1-2.3-.8-3-2-2.3 1.9-1.9 2.1-3.5.6-5.6-2.1 1.6-2.1 3.2-1.2 5.5-1.2-1.4-3.2-.6-2.5 1.6.9-1.4 2.1-.5 1.9.8-.2 1.1-1.7 2.1-3.5 1.9-2.7-.2-2.9-2.1-2.9-3.6.7-.1 1.9.5 2.9 1.9l.4-4.3c-1.1 1.1-2.1 1.4-3.2 1.4.4-1.2 2.1-3 2.1-3h-5.4s1.7 1.9 2.1 3c-1.1 0-2.1-.2-3.2-1.4l.4 4.3c1-1.4 2.2-2 2.9-1.9-.1 1.5-.2 3.4-2.9 3.6-1.9.2-3.4-.8-3.5-1.9-.2-1.3 1-2.2 1.9-.8.7-2.3-1.2-3-2.5-1.6.9-2.2.9-3.9-1.2-5.5-1.5 2-1.3 3.7.6 5.6-1.2-.7-3.1 0-2 2.3.6-1.4 1.8-1.1 2.1.1.2.9-.3 1.9-1.5 2.1-.9.2-2.4-.5-3.5-3 .6 0 1.2.3 2 .9l-1.2-4c-.3 1.1-.7 1.9-1.1 2.3-.3-.8-.2-1.4 0-2.7l-2.9.9C1.3 23 2.6 25.5 3.7 30c3.7-.5 7.9-.8 12.3-.8m28.3-11.6c0 .9.1 1.7.3 2.5.2.8.6 1.5 1 2.2.5.6 1 1.1 1.7 1.5.7.4 1.5.6 2.5.6.9 0 1.7-.1 2.3-.4s1.1-.7 1.5-1.1c.4-.4.6-.9.8-1.5.1-.5.2-1 .2-1.5v-.2h-5.3v-3.2h9.4V28H55v-2.5c-.3.4-.6.8-1 1.1-.4.3-.8.6-1.3.9-.5.2-1 .4-1.6.6s-1.2.2-1.8.2c-1.5 0-2.9-.3-4-.8-1.2-.6-2.2-1.3-3-2.3-.8-1-1.4-2.1-1.8-3.4-.3-1.4-.5-2.8-.5-4.3s.2-2.9.7-4.2c.5-1.3 1.1-2.4 2-3.4.9-1 1.9-1.7 3.1-2.3 1.2-.6 2.6-.8 4.1-.8 1 0 1.9.1 2.8.3.9.2 1.7.6 2.4 1s1.4.9 1.9 1.5c.6.6 1 1.3 1.4 2l-3.7 2.1c-.2-.4-.5-.9-.8-1.2-.3-.4-.6-.7-1-1-.4-.3-.8-.5-1.3-.7-.5-.2-1.1-.2-1.7-.2-1 0-1.8.2-2.5.6-.7.4-1.3.9-1.7 1.5-.5.6-.8 1.4-1 2.2-.3.8-.4 1.9-.4 2.7zM71.5 6.8c1.5 0 2.9.3 4.2.8 1.2.6 2.3 1.3 3.1 2.3.9 1 1.5 2.1 2 3.4s.7 2.7.7 4.2-.2 2.9-.7 4.2c-.4 1.3-1.1 2.4-2 3.4-.9 1-1.9 1.7-3.1 2.3-1.2.6-2.6.8-4.2.8s-2.9-.3-4.2-.8c-1.2-.6-2.3-1.3-3.1-2.3-.9-1-1.5-2.1-2-3.4-.4-1.3-.7-2.7-.7-4.2s.2-2.9.7-4.2c.4-1.3 1.1-2.4 2-3.4.9-1 1.9-1.7 3.1-2.3 1.2-.5 2.6-.8 4.2-.8zm0 17.6c.9 0 1.7-.2 2.4-.5s1.3-.8 1.7-1.4c.5-.6.8-1.3 1.1-2.2.2-.8.4-1.7.4-2.7v-.1c0-1-.1-1.9-.4-2.7-.2-.8-.6-1.6-1.1-2.2-.5-.6-1.1-1.1-1.7-1.4-.7-.3-1.5-.5-2.4-.5s-1.7.2-2.4.5-1.3.8-1.7 1.4c-.5.6-.8 1.3-1.1 2.2-.2.8-.4 1.7-.4 2.7v.1c0 1 .1 1.9.4 2.7.2.8.6 1.6 1.1 2.2.5.6 1.1 1.1 1.7 1.4.6.3 1.4.5 2.4.5zM88.9 28 83 7h4.7l4 15.7h.1l4-15.7h4.7l-5.9 21h-5.7zm28.8-3.6c.6 0 1.2-.1 1.7-.3.5-.2 1-.4 1.4-.8.4-.4.7-.8.9-1.4.2-.6.3-1.2.3-2v-13h4.1v13.6c0 1.2-.2 2.2-.6 3.1s-1 1.7-1.8 2.4c-.7.7-1.6 1.2-2.7 1.5-1 .4-2.2.5-3.4.5-1.2 0-2.4-.2-3.4-.5-1-.4-1.9-.9-2.7-1.5-.8-.7-1.3-1.5-1.8-2.4-.4-.9-.6-2-.6-3.1V6.9h4.2v13c0 .8.1 1.4.3 2 .2.6.5 1 .9 1.4.4.4.8.6 1.4.8.6.2 1.1.3 1.8.3zm13-17.4h4.2v9.1l7.4-9.1h5.2l-7.2 8.4L148 28h-4.9l-5.5-9.4-2.7 3V28h-4.2V7zm-27.6 16.1c-1.5 0-2.7 1.2-2.7 2.7s1.2 2.7 2.7 2.7 2.7-1.2 2.7-2.7-1.2-2.7-2.7-2.7z"></path>
         </svg>
-          <span class="govuk-header__logotype-text">
-            GOV.UK
-          </span>
-        </span>
         <% end %>
         <span class="govuk-header__product-name">
           <%= config[:tech_docs][:service_name] %>

lib/source/layouts/_header.erb

@@ -10,6 +10,11 @@
     <%= stylesheet_link_tag :manifest %>
 
     <link rel="canonical" href="<%= meta_tags.canonical_url %>">
+    <link rel="icon" sizes="48x48" href="/assets/govuk/assets/images/favicon.ico">
+    <link rel="icon" sizes="any" href="/assets/govuk/assets/images/favicon.svg" type="image/svg+xml">
+    <link rel="mask-icon" href="/assets/govuk/assets/images/govuk-icon-mask.svg" color="#0b0c0c">
+    <link rel="apple-touch-icon" href="/assets/govuk/assets/images/govuk-icon-180.png">
+    <link rel="manifest" href="/assets/govuk/assets/manifest.json">
 
     <% meta_tags.tags.each do |name, content| %>
       <%= tag :meta, name: name, content: content %>
@@ -23,7 +28,7 @@
   </head>
 
   <body class="govuk-template__body">
-    <script>document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled');</script>
+    <script>document.body.className += ' js-enabled' + ('noModule' in HTMLScriptElement.prototype ? ' govuk-frontend-supported' : '');</script>
 
     <div class="app-pane">
       <div class="app-pane__header toc-open-disabled">
@@ -75,6 +80,7 @@
     </div>
 
     <%= partial 'layouts/analytics' %>
+    <%= javascript_include_tag :govuk_frontend, :type => "module" %>
     <%= javascript_include_tag :application %>
   </body>
 </html>

lib/source/layouts/core.erb

@@ -1,3 +1,3 @@
-//= link_tree ../../../node_modules/govuk-frontend/govuk/assets
+//= link_tree ../../../node_modules/govuk-frontend/dist/govuk/assets
 
 //= require screen

lib/source/stylesheets/manifest.css

@@ -6,7 +6,7 @@
     "lint": "standard"
   },
   "dependencies": {
-    "govuk-frontend": "~4.7.0"
+    "govuk-frontend": "~5.6.0"
   },
   "devDependencies": {
     "standard": "^14.3.4"

package-lock.json

@@ -50,7 +50,7 @@ def generate_title(site_name:, page_title:)
         "description" => "The description.",
         "twitter:card" => "summary",
         "twitter:domain" => "www.example.org",
-        "twitter:image" => "https://www.example.org/images/govuk-large.png",
+        "twitter:image" => "https://www.example.org/assets/govuk/assets/images/govuk-opengraph-image.png",
         "twitter:title" => "The Title - Test Site",
         "twitter:url" => "https://www.example.org/foo.html",
       )
@@ -139,7 +139,7 @@ def generate_title(site_name:, page_title:)
 
       expect(og_tags).to eql(
         "og:description" => "The description.",
-        "og:image" => "https://www.example.org/images/govuk-large.png",
+        "og:image" => "https://www.example.org/assets/govuk/assets/images/govuk-opengraph-image.png",
         "og:site_name" => "Test Site",
         "og:title" => "The Title",
         "og:type" => "object",

package.json

@@ -13,7 +13,7 @@
 src_files:
   - lib/assets/javascripts/_vendor/jquery.js
   - lib/assets/javascripts/**/*.js
-  - node_modules/govuk-frontend/govuk/all.js
+  - "!lib/assets/javascripts/govuk_frontend_all.js"
 
 # helpers
 #

spec/govuk_tech_docs/meta_tags_spec.rb

@@ -7,6 +7,7 @@ describe('Table of contents', function () {
   var $toc
   var $closeButton
   var $openButton
+  var $tocStickyHeader
   var module
 
   beforeAll(function () {
@@ -64,13 +65,18 @@ describe('Table of contents', function () {
 
     $closeButton = $toc.find('.js-toc-close')
     $openButton = $html.find('.js-toc-show')
+
+    $tocStickyHeader = $html.find('.toc-show')
   })
 
   afterEach(function () {
     // clear up any classes left on <html>
-    $html.removeClass('.toc-open')
+    $html.removeClass('toc-open')
     $html.find('body #toc-heading').remove()
     $html.find('body .toc').remove()
+    if ($tocStickyHeader && $tocStickyHeader.length) {
+      $tocStickyHeader.remove()
+    }
   })
 
   describe('when the module is started', function () {