govuk_publishing_components 30.7.3 → 31.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a0126e6016869d447d661d4e1c4777d68a10292c19e388bcb22477021877b7b
-  data.tar.gz: e83f7124df4f9126819c1f11310bfda63dde08be6c57749ead9395eef1d58ea0
+  metadata.gz: 23492ecba6eaaa3ed895868bf827524702313449a11c8ca79eed1e0d25565122
+  data.tar.gz: fddbfc77800da9f9999b164930528661bffaed54e70849e14d6ef9e1b1ab549d
 SHA512:
-  metadata.gz: 03ac390a2a2a9fa5378699daac0dab1a55551bee3ab995f159487c5a5d295a3ff139629fab6b9f0b95dc52bc4d89d5b941f867e00c20fe9562eafbb5d5af43ef
-  data.tar.gz: ee961b5da8eacf0d47567ae446a1c1741ea65576affbdeb84916bb48a64064de8383c1ad64de86da84def9ad5f13c034c7893dca904a7a64e8405b0133754e37
+  metadata.gz: f40277a05d20137b4695853f5c2a80bfab0ee90fb01ccf73d961e4e4c3e59a3c31c917022ed048c5e8ceff38bc1cc5a8fd9d62ceb5c5b7eef57893c30a3d4257
+  data.tar.gz: 0dc8abb57df600b8309abf46571ccb864a41b82f3f7b4cf6a2e3dcab4124777719d017719a87f51dde41855472b9d15b9920040a94a267acdf56d8222b51a472

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/{ga4-core.js.erb → ga4-core.js}

@@ -1,39 +1,31 @@
-// note that because this file is .js.erb it is not linted
-// temporarily rename to .js to check with the linter
 window.GOVUK = window.GOVUK || {}
-window.GOVUK.analyticsGA4 = window.GOVUK.analyticsGA4 || {};
+window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
 
 (function (analytics) {
   'use strict'
 
   var core = {
     load: function () {
-      var firstScript
-      var newScript
+      var firstScript = document.getElementsByTagName('script')[0]
+      var newScript = document.createElement('script')
+      newScript.async = true
 
-      if (window.GOVUK.analyticsGA4.vars.gtag_id) {
+      if (window.GOVUK.analyticsGa4.vars.gtag_id) {
         // initialise gtag
         window.dataLayer = window.dataLayer || []
         var gtag = function () { window.dataLayer.push(arguments) }
         gtag('js', new Date())
-        gtag('config', window.GOVUK.analyticsGA4.vars.gtag_id)
+        gtag('config', window.GOVUK.analyticsGa4.vars.gtag_id)
 
-        firstScript = document.getElementsByTagName('script')[0]
-        newScript = document.createElement('script')
-
-        newScript.async = true
-        newScript.src = '//www.googletagmanager.com/gtag/js?id=' + window.GOVUK.analyticsGA4.vars.gtag_id
+        newScript.src = '//www.googletagmanager.com/gtag/js?id=' + window.GOVUK.analyticsGa4.vars.gtag_id
         firstScript.parentNode.insertBefore(newScript, firstScript)
       } else {
         // initialise GTM
         window.dataLayer = window.dataLayer || []
         window.dataLayer.push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' })
 
-        firstScript = document.getElementsByTagName('script')[0]
-        newScript = document.createElement('script')
-
-        var auth = window.GOVUK.analyticsGA4.vars.auth || ''
-        var preview = window.GOVUK.analyticsGA4.vars.preview || ''
+        var auth = window.GOVUK.analyticsGa4.vars.auth || ''
+        var preview = window.GOVUK.analyticsGa4.vars.preview || ''
         if (auth) {
           auth = '&gtm_auth=' + auth
         }
@@ -41,8 +33,7 @@ window.GOVUK.analyticsGA4 = window.GOVUK.analyticsGA4 || {};
           preview = '&gtm_preview=' + preview + '&gtm_cookies_win=x'
         }
 
-        newScript.async = true
-        this.googleSrc = 'https://www.googletagmanager.com/gtm.js?id=' + window.GOVUK.analyticsGA4.vars.id + auth + preview
+        this.googleSrc = 'https://www.googletagmanager.com/gtm.js?id=' + window.GOVUK.analyticsGa4.vars.id + auth + preview
         newScript.src = this.googleSrc
         firstScript.parentNode.insertBefore(newScript, firstScript)
         window.dataLayer.push({ 'gtm.blocklist': ['customPixels', 'customScripts', 'html', 'nonGoogleScripts'] })
@@ -55,9 +46,9 @@ window.GOVUK.analyticsGA4 = window.GOVUK.analyticsGA4 || {};
     },
 
     getGemVersion: function () {
-      return '<%= GovukPublishingComponents::VERSION %>'
+      return window.GOVUK.analyticsGa4.vars.gem_version || 'not found'
     }
   }
 
   analytics.core = core
-})(window.GOVUK.analyticsGA4)
+})(window.GOVUK.analyticsGa4)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/{ga4-enhanced-ecommerce-tracker.js → ga4-ecommerce-tracker.js}

@@ -3,14 +3,16 @@
   'use strict'
 
   var GOVUK = global.GOVUK || {}
-  GOVUK.analyticsGA4 = GOVUK.analyticsGA4 || {}
+  GOVUK.analyticsGa4 = GOVUK.analyticsGa4 || {}
 
-  GOVUK.analyticsGA4.Ga4EnhancedEcommerceTracker = {
-    PIIRemover: new GOVUK.analyticsGA4.PIIRemover(),
+  GOVUK.analyticsGa4.Ga4EcommerceTracker = {
+    PIIRemover: new GOVUK.analyticsGa4.PIIRemover(),
     DEFAULT_LIST_TITLE: 'Site search results',
 
     init: function (isNewPageLoad) {
       if (window.dataLayer) {
+        /* The data-ga4-ecommerce attribute may be present on several DOM elements e.g. search results and spelling
+        suggestions, hence why document.querySelectorAll is required */
         this.searchResultsBlocks = document.querySelectorAll('[data-ga4-ecommerce]')
         this.isNewPageLoad = isNewPageLoad
 
@@ -22,7 +24,7 @@
         hence the pageView object push to the dataLayer. We do not need to send a pageView object on page load as
         this is handled elsewhere. */
         if (!this.isNewPageLoad) {
-          var pageViewTracker = window.GOVUK.analyticsGA4.analyticsModules.PageViewTracker
+          var pageViewTracker = window.GOVUK.analyticsGa4.analyticsModules.PageViewTracker
 
           if (pageViewTracker) {
             pageViewTracker.init()
@@ -90,7 +92,7 @@
         })
 
         ecommerceObject.event_data = {
-          external: GOVUK.analyticsGA4.analyticsModules.Ga4LinkTracker.isExternalLink(searchResult.getAttribute('data-ecommerce-path')) ? 'true' : 'false'
+          external: GOVUK.analyticsGa4.analyticsModules.Ga4LinkTracker.isExternalLink(searchResult.getAttribute('data-ecommerce-path')) ? 'true' : 'false'
         }
       } else {
         for (var i = 0; i < ecommerceRows.length; i++) {

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-event-tracker.js

@@ -31,7 +31,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
   Ga4EventTracker.prototype.trackClick = function (event) {
     var target = this.findTrackingAttributes(event.target)
     if (target) {
-      var schema = new window.GOVUK.analyticsGA4.Schemas().eventSchema()
+      var schema = new window.GOVUK.analyticsGa4.Schemas().eventSchema()
 
       try {
         var data = target.getAttribute(this.trackingTrigger)
@@ -84,7 +84,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
         }
       }
 
-      window.GOVUK.analyticsGA4.core.sendData(schema)
+      window.GOVUK.analyticsGa4.core.sendData(schema)
     }
   }
 

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-link-tracker.js

@@ -1,7 +1,7 @@
 // = require govuk/vendor/polyfills/Element/prototype/closest.js
 window.GOVUK = window.GOVUK || {}
-window.GOVUK.analyticsGA4 = window.GOVUK.analyticsGA4 || {}
-window.GOVUK.analyticsGA4.analyticsModules = window.GOVUK.analyticsGA4.analyticsModules || {};
+window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
+window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analyticsModules || {};
 
 (function (analyticsModules) {
   'use strict'
@@ -97,7 +97,7 @@ window.GOVUK.analyticsGA4.analyticsModules = window.GOVUK.analyticsGA4.analytics
       }
 
       if (Object.keys(clickData).length > 0) {
-        var schema = new window.GOVUK.analyticsGA4.Schemas().eventSchema()
+        var schema = new window.GOVUK.analyticsGa4.Schemas().eventSchema()
         schema.event = 'event_data'
 
         // get attributes from the clickData object to send to GA
@@ -108,7 +108,7 @@ window.GOVUK.analyticsGA4.analyticsModules = window.GOVUK.analyticsGA4.analytics
           }
         }
 
-        window.GOVUK.analyticsGA4.core.sendData(schema)
+        window.GOVUK.analyticsGa4.core.sendData(schema)
       }
     },
 
@@ -251,4 +251,4 @@ window.GOVUK.analyticsGA4.analyticsModules = window.GOVUK.analyticsGA4.analytics
   }
 
   analyticsModules.Ga4LinkTracker = Ga4LinkTracker
-})(window.GOVUK.analyticsGA4.analyticsModules)
+})(window.GOVUK.analyticsGa4.analyticsModules)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-page-views.js

@@ -1,12 +1,12 @@
 window.GOVUK = window.GOVUK || {}
-window.GOVUK.analyticsGA4 = window.GOVUK.analyticsGA4 || {}
-window.GOVUK.analyticsGA4.analyticsModules = window.GOVUK.analyticsGA4.analyticsModules || {};
+window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
+window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analyticsModules || {};
 
 (function (analyticsModules) {
   'use strict'
 
   var PageViewTracker = {
-    PIIRemover: new window.GOVUK.analyticsGA4.PIIRemover(), // imported in analytics-ga4.js
+    PIIRemover: new window.GOVUK.analyticsGa4.PIIRemover(), // imported in analytics-ga4.js
     nullValue: undefined,
 
     init: function () {
@@ -45,7 +45,7 @@ window.GOVUK.analyticsGA4.analyticsModules = window.GOVUK.analyticsGA4.analytics
             world_locations: this.getMetaContent('analytics:world-locations')
           }
         }
-        window.GOVUK.analyticsGA4.core.sendData(data)
+        window.GOVUK.analyticsGa4.core.sendData(data)
       }
     },
 
@@ -111,4 +111,4 @@ window.GOVUK.analyticsGA4.analyticsModules = window.GOVUK.analyticsGA4.analytics
   }
 
   analyticsModules.PageViewTracker = PageViewTracker
-})(window.GOVUK.analyticsGA4.analyticsModules)
+})(window.GOVUK.analyticsGa4.analyticsModules)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-schemas.js

@@ -26,8 +26,8 @@
     }
   }
 
-  GOVUK.analyticsGA4 = GOVUK.analyticsGA4 || {}
-  GOVUK.analyticsGA4.Schemas = Schemas
+  GOVUK.analyticsGa4 = GOVUK.analyticsGa4 || {}
+  GOVUK.analyticsGa4.Schemas = Schemas
 
   global.GOVUK = GOVUK
 })(window)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/init-ga4.js

@@ -1,5 +1,5 @@
 window.GOVUK = window.GOVUK || {}
-window.GOVUK.analyticsGA4 = window.GOVUK.analyticsGA4 || {}
+window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
 
 var initFunction = function () {
   // to be added: digital identity consent mechanism
@@ -7,9 +7,9 @@ var initFunction = function () {
   var consentCookie = window.GOVUK.getConsentCookie()
 
   if (consentCookie && consentCookie.usage) {
-    window.GOVUK.analyticsGA4.core.load()
+    window.GOVUK.analyticsGa4.core.load()
 
-    var analyticsModules = window.GOVUK.analyticsGA4.analyticsModules
+    var analyticsModules = window.GOVUK.analyticsGa4.analyticsModules
     for (var property in analyticsModules) {
       var module = analyticsModules[property]
       if (typeof module.init === 'function') {
@@ -18,8 +18,8 @@ var initFunction = function () {
     }
     // to be added: cross domain tracking code
   } else {
-    window.addEventListener('cookie-consent', window.GOVUK.analyticsGA4.init)
+    window.addEventListener('cookie-consent', window.GOVUK.analyticsGa4.init)
   }
 }
 
-window.GOVUK.analyticsGA4.init = initFunction
+window.GOVUK.analyticsGa4.init = initFunction

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/pii-remover.js

@@ -128,8 +128,8 @@
     return string
   }
 
-  GOVUK.analyticsGA4 = GOVUK.analyticsGA4 || {}
-  GOVUK.analyticsGA4.PIIRemover = PIIRemover
+  GOVUK.analyticsGa4 = GOVUK.analyticsGa4 || {}
+  GOVUK.analyticsGa4.PIIRemover = PIIRemover
 
   global.GOVUK = GOVUK
 })(window)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4.js

@@ -5,5 +5,5 @@
 //= require ./analytics-ga4/ga4-page-views
 //= require ./analytics-ga4/ga4-link-tracker
 //= require ./analytics-ga4/ga4-event-tracker
-//= require ./analytics-ga4/ga4-enhanced-ecommerce-tracker
+//= require ./analytics-ga4/ga4-ecommerce-tracker
 //= require ./analytics-ga4/init-ga4

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

@@ -59,11 +59,9 @@ window.GOVUK.Modules.GovukAccordion = window.GOVUKFrontend.Accordion;
 
   // Navigate to and open accordions with anchored content on page load if a hash is present
   GemAccordion.prototype.openByAnchorOnLoad = function () {
+    if (!window.location.hash) return
     var splitHash = window.location.hash.split('#')[1]
-
-    if (window.location.hash && document.getElementById(splitHash)) {
-      this.openForAnchor(splitHash)
-    }
+    this.openForAnchor(splitHash)
   }
 
   // Add event listeners for links to open accordion sections when navigated to using said anchor links on the page
@@ -80,7 +78,9 @@ window.GOVUK.Modules.GovukAccordion = window.GOVUKFrontend.Accordion;
 
   // Find the parent accordion section for the given id and open it
   GemAccordion.prototype.openForAnchor = function (hash) {
-    var target = document.getElementById(hash)
+    hash = hash.replace(':', '\\:')
+    var target = this.$module.querySelector('#' + hash)
+    if (!target) return
     var $section = this.getContainingSection(target)
     var $header = $section.querySelector(this.sectionHeader)
     var $expanded = this.getContainingSection($section)

data/app/views/govuk_publishing_components/components/_emergency_banner.html.erb

@@ -28,11 +28,11 @@
 
 %>
 
-<%= content_tag('div', class: banner_classes, "aria-label": "emergency banner", "role": "region", "data-nosnippet": true ) do %>
+<%= content_tag('section', class: banner_classes, "aria-labelledby": "emergency-banner-heading", "data-nosnippet": true ) do %>
   <div class="govuk-width-container">
     <div class="govuk-grid-row">
       <div class="govuk-grid-column-two-thirds">
-        <%= content_tag('h2', class: heading_classes) do %>
+        <%= content_tag('h2', id: "emergency-banner-heading", class: heading_classes) do %>
           <%= heading %>
         <% end %>
         <% if short_description %>

data/app/views/govuk_publishing_components/components/docs/accordion.yml

@@ -187,7 +187,7 @@ examples:
 
       The `data_attributes` option applies attributes to the outermost element in the accordion. Each item can also have a `data_attributes` hash, which are placed on the `button` that triggers the opening and closing - useful for differentiating between each section of the accordion.
 
-      Data attributes can be added to the 'Show/hide all' link using the `data_attributes_show_all` option, primarily where custom tracking is required. These attributes are read from the accordion markup and then added to the link by JavaScript (which is how the link is created). More details on how this can be used with the GA4 event tracking can be found in the 'Advanced' section of the [event tracking documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-gtm/ga4-event-tracker.md).
+      Data attributes can be added to the 'Show/hide all' link using the `data_attributes_show_all` option, primarily where custom tracking is required. These attributes are read from the accordion markup and then added to the link by JavaScript (which is how the link is created). More details on how this can be used with the GA4 event tracking can be found in the 'Advanced' section of the [event tracking documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-event-tracker.md).
 
       If `track_options` within `data_attributes_show_all` is set, then it is possible to pass a custom dimension when 'Show/Hide all' is clicked.
     data:

data/lib/govuk_publishing_components/presenters/machine_readable/creative_work_schema.rb

@@ -50,7 +50,7 @@ module GovukPublishingComponents
           "author" => {
             "@type" => "Organization",
             "name" => publishing_organisation["title"],
-            "url" => Plek.current.website_root + publishing_organisation["base_path"],
+            "url" => Plek.new.website_root + publishing_organisation["base_path"],
           },
         }
       end

data/lib/govuk_publishing_components/presenters/machine_readable/page.rb

@@ -12,7 +12,7 @@ module GovukPublishingComponents
       end
 
       def canonical_url
-        local_assigns[:canonical_url] || (Plek.current.website_root + content_item["base_path"])
+        local_assigns[:canonical_url] || (Plek.new.website_root + content_item["base_path"])
       end
 
       def body

data/lib/govuk_publishing_components/presenters/machine_readable/potential_search_action_schema.rb

@@ -5,7 +5,7 @@ module GovukPublishingComponents
     class PotentialSearchActionSchema
       attr_reader :facet_params, :description
 
-      BASE_SEARCH_URL = "#{Plek.current.website_root}/search/all?keywords={query}&order=relevance".freeze
+      BASE_SEARCH_URL = "#{Plek.new.website_root}/search/all?keywords={query}&order=relevance".freeze
 
       def initialize(facet_params, description)
         @facet_params = facet_params

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "30.7.3".freeze
+  VERSION = "31.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 30.7.3
+  version: 31.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -436,8 +436,8 @@ files:
 - app/assets/javascripts/component_guide/vendor/matches-polyfill.min.js
 - app/assets/javascripts/govuk_publishing_components/all_components.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4.js
-- app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-core.js.erb
-- app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-enhanced-ecommerce-tracker.js
+- app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-core.js
+- app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-ecommerce-tracker.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-event-tracker.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-link-tracker.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-page-views.js
@@ -1361,7 +1361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.3.23
 signing_key: 
 specification_version: 4
 summary: A gem to document components in GOV.UK frontend applications