govuk_publishing_components 34.9.1 → 34.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8b043d1285aa3d0477957b2472686e584b62fc8dc89f0e74dde18c989f3c4a
-  data.tar.gz: 4bf6daf82bb9958e9d042b75f03d424be2f985ec02ffc3b18aef68f3b8a3b47c
+  metadata.gz: '02198ba8894765b065f3835bbc229f0a5ebe82da8d81b7eae0cd2926874c629d'
+  data.tar.gz: c74c4a44f50497650fe6f13acead0ecf07ae005c2c4b83327135e68c556d4445
 SHA512:
-  metadata.gz: 61de44ede7ebe2d0f79c642648edf6ec9e7894c05d5e36a0d8f4dbf15f82dc66d43c0320819459d4034a8c9dc8b42b6ae2c69f2946b200160cf6eebc7a6c3aae
-  data.tar.gz: 16ef6c35ed6ef86b4ad420baaa2ecac77b513065d68a7c9b7380d910d1318a5e4ee1ac314fa7d69e0474333761f3e615bad1ff817e84dbf132c6b74042f6d7bd
+  metadata.gz: 7d710c78158dc0f1b6a194e133fc1e8fa10b6611d38025261cef1f4d1076be4c4e5e516d2ef008a3d619ee672c0af3870468481a7960585d9ce37340aaf41c83
+  data.tar.gz: dc8fb3e2b90175173e7d39a0bcd8da797c8b0713676b1184cdb56b46146ff9ef55e5a3707e843dcc65b52ebf60efb04af331386c4b4a2e7bb41c0b65a7e7c390

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

@@ -0,0 +1,46 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {};
+
+(function (Modules) {
+  'use strict'
+
+  function Ga4AutoTracker (module) {
+    this.module = module
+    this.trackingTrigger = 'data-ga4-auto'
+  }
+
+  Ga4AutoTracker.prototype.init = function () {
+    var consentCookie = window.GOVUK.getConsentCookie()
+
+    if (consentCookie && consentCookie.settings) {
+      this.startModule()
+    } else {
+      this.startModule = this.startModule.bind(this)
+      window.addEventListener('cookie-consent', this.startModule)
+    }
+  }
+
+  Ga4AutoTracker.prototype.startModule = function () {
+    this.sendEvent()
+  }
+
+  Ga4AutoTracker.prototype.sendEvent = function () {
+    if (window.dataLayer) {
+      try {
+        var data = this.module.getAttribute(this.trackingTrigger)
+        data = JSON.parse(data)
+      } catch (e) {
+        // if there's a problem with the config, don't start the tracker
+        console.error('GA4 configuration error: ' + e.message, window.location)
+        return
+      }
+
+      var schemas = new window.GOVUK.analyticsGa4.Schemas()
+      var schema = schemas.mergeProperties(data, 'event_data')
+
+      window.GOVUK.analyticsGa4.core.sendData(schema)
+    }
+  }
+
+  Modules.Ga4AutoTracker = Ga4AutoTracker
+})(window.GOVUK.Modules)

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

@@ -63,13 +63,17 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
           return
         }
 
+        return this.splitStringIntoParts(path)
+      },
+
+      splitStringIntoParts: function (string) {
         /*
         This will create an object with 5 keys that are indexes ("1", "2", etc.)
-        The values will be each part of the link path split every 100 characters, or undefined.
+        The values will be each part of the string split every 100 characters, or undefined.
         For example: {"1": "/hello/world/etc...", "2": "/more/path/text...", "3": undefined, "4": undefined, "5": undefined}
         Undefined values are needed to override the persistent object in GTM so that any values from old pushes are overwritten.
         */
-        var parts = path.match(/.{1,100}/g)
+        var parts = string.match(/.{1,100}/g)
         var obj = {}
         for (var i = 0; i < 5; i++) {
           obj[(i + 1).toString()] = parts[i]
@@ -188,8 +192,10 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
         } else {
           // This regex matches a protocol and domain name at the start of a string such as https://www.gov.uk, http://gov.uk, //gov.uk
           var domainRegex = /^(http:||https:)?(\/\/)([^\/]*)/ // eslint-disable-line no-useless-escape
-          var domain = domainRegex.exec(href)[0]
-          return domain
+          var domain = domainRegex.exec(href)
+          if (domain) {
+            return domain[0]
+          }
         }
       },
 

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

@@ -31,8 +31,8 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
             taxonomy_level1: this.getMetaContent('themes'),
             taxonomy_main: this.getMetaContent('taxon-slug'),
             taxonomy_main_id: this.getMetaContent('taxon-id'),
-            taxonomy_all: this.getMetaContent('taxon-slugs'),
-            taxonomy_all_ids: this.getMetaContent('taxon-ids'),
+            taxonomy_all: this.splitLongMetaContent('taxon-slugs'),
+            taxonomy_all_ids: this.splitLongMetaContent('taxon-ids'),
 
             language: this.getLanguage(),
             history: this.getHistory(),
@@ -106,6 +106,13 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       return (withdrawn === 'withdrawn') ? 'true' : 'false'
     },
 
+    splitLongMetaContent: function (metatag) {
+      var tag = this.getMetaContent(metatag)
+      if (tag) {
+        return window.GOVUK.analyticsGa4.core.trackFunctions.splitStringIntoParts(tag)
+      }
+    },
+
     // return only the date from given timestamps of the form
     // 2022-03-28T19:11:00.000+00:00
     stripTimeFrom: function (value) {

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

@@ -8,4 +8,5 @@
 //= require ./analytics-ga4/ga4-event-tracker
 //= require ./analytics-ga4/ga4-ecommerce-tracker
 //= require ./analytics-ga4/ga4-form-tracker
+//= require ./analytics-ga4/ga4-auto-tracker
 //= require ./analytics-ga4/init-ga4

data/app/assets/stylesheets/govuk_publishing_components/govuk_frontend_support.scss

@@ -17,3 +17,12 @@ $gem-quiet-button-colour: govuk-colour("dark-grey", $legacy: "grey-1");
 $gem-quiet-button-hover-colour: darken($gem-quiet-button-colour, 5%);
 
 $gem-hover-dark-background: #dddcdb;
+
+$govuk-colours-organisations: map-merge(
+  $govuk-colours-organisations,
+  (
+    "department-for-energy-security-and-net-zero": (
+      colour: #0da04a
+    )
+  )
+);

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

@@ -29,6 +29,6 @@
   <% end %>
 
   <% if navigation.show_ukraine_cta? %>
-    <%= render 'govuk_publishing_components/components/contextual_sidebar/ukraine_cta', content_item: content_item %>
+    <%= render 'govuk_publishing_components/components/contextual_sidebar/ukraine_cta', content_item: content_item, ga4_tracking: ga4_tracking %>
   <% end %>
 </div>

data/app/views/govuk_publishing_components/components/contextual_sidebar/_ukraine_cta.html.erb

@@ -1,14 +1,23 @@
-<% shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns) %>
-<%
+<% 
+  shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   title = t("components.related_navigation.ukraine.title")
   lang = shared_helper.t_locale("components.related_navigation.ukraine.title")
+  data_module = "gem-track-click"
+  data_module << " ga4-link-tracker" if ga4_tracking
 %>
-
-<%= tag.div class: "gem-c-contextual-sidebar__cta gem-c-contextual-sidebar__cta--ukraine", data: { module: "gem-track-click" } do %>
+<%= tag.div class: "gem-c-contextual-sidebar__cta gem-c-contextual-sidebar__cta--ukraine", data: { module: data_module } do %>
   <%= tag.h2 title, class: "gem-c-contextual-sidebar__heading govuk-heading-s" %>
   <%= tag.ul class: "gem-c-contextual-sidebar__list" do %>
-    <% t("components.related_navigation.ukraine.links").each do |link| %>
+    <% t("components.related_navigation.ukraine.links").each_with_index do |link, index| %>
       <%= tag.li class: "gem-c-contextual-sidebar__text govuk-body" do %>
+        <%
+          ga4_attributes = {
+            event_name: "navigation",
+            type: "related content",
+            index: "1.#{index + 1}",
+            section: title,
+          } if ga4_tracking
+        %>
         <%= link_to link[:label],
           link[:href],
           class: "govuk-link",
@@ -18,9 +27,10 @@
             "track-label": link[:href],
             "track-dimension": link[:label],
             "track-dimension-index": "29",
+            ga4_link: ga4_attributes,
           },
           lang: lang %>
       <% end %>
     <% end %>
-  <% end %>    
+  <% end %>
 <% end %>

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

@@ -104,7 +104,7 @@ examples:
               base_path: "/government/topical-events/russian-invasion-of-ukraine-uk-government-response"
               locale: "en"
   with_ga4_tracking_on_related_navigation:
-    description: Adds Google Analytics 4 tracking to components within the sidebar. Currently only the Related Navigation and Step by Step navigation components accept this option.
+    description: Adds Google Analytics 4 tracking to components within the sidebar. Currently only the Related Navigation component, Step by Step navigation component and Ukraine CTA accept this option.
     data:
       ga4_tracking: true
       content_item:
@@ -124,40 +124,36 @@ examples:
           - title: The future of jobs and skills
             base_path: /government/collections/the-future-of-jobs-and-skills
             document_type: document_collection
+          topical_events:
+            - content_id: "bfa79635-ffda-4b5d-8266-a9cd3a03649c"
+              title: "Russian invasion of Ukraine: UK government response"
+              base_path: "/government/topical-events/russian-invasion-of-ukraine-uk-government-response"
+              locale: "en"
   with_ga4_tracking_on_step_by_step:
-    description: Adds Google Analytics 4 tracking to components within the sidebar. Currently only the Related Navigation and Step by Step navigation components accept this option.
+    description: Adds Google Analytics 4 tracking to components within the sidebar. Currently only the Related Navigation component, Step by Step navigation component and Ukraine CTA accept this option.
     data:
       ga4_tracking: true
       content_item:
         title: "A content item"
         links:
           part_of_step_navs:
-            - title: "Learn to drive a car: step by step"
-              base_path: "/micropigs-vs-micropugs"
+            - title: "What to do when someone dies: step by step"
+              base_path: "/when-someone-dies"
               details:
                 step_by_step_nav:
-                  title: 'Stay in the UK after it leaves the EU (''settled status''): step by step'
+                  title: 'What to do when someone dies: step by step'
                   steps:
-                  - title: Check you're allowed to drive
+                  - title: Register the death
                     contents:
-                    - type: paragraph
-                      text: Most people can start learning to drive when they’re 17.
                     - type: list
                       contents:
-                      - text: Check what age you can drive
-                        href: "/vehicles-can-drive"
+                      - text: Register the death
+                        href: "/after-a-death"
                     optional: false
-                  - title: Testing the and
-                    logic: and
+                  - title: Arrange the funeral
                     contents:
-                    - type: paragraph
-                      text: hello hello what's UP
-                  - title: Driving lessons and practice
-                    contents:
-                    - type: paragraph
-                      text: You need a provisional driving licence to take lessons or practice.
                     - type: list
                       contents:
-                      - text: The Highway Code
-                        href: "/guidance/the-highway-code"
+                      - text: Arrange the funeral
+                        href: "/after-a-death/arrange-the-funeral"
                     optional: false

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "34.9.1".freeze
+  VERSION = "34.10.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 34.9.1
+  version: 34.10.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -439,6 +439,7 @@ 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-auto-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