metadata_presenter 2.16.12 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed9df3a1d56df6ff57746e7976d578741de8df0214f1080fbc661a087753bea
-  data.tar.gz: 85783ae10996111d01c523cff076ca0b82634cac855dfdf32f88665c5187a6d7
+  metadata.gz: 69339189940b628d7be7e2a6515c4382cc44d5726d3ecac9adb86b975cd1d5d8
+  data.tar.gz: 1d5724fabda8bf28f79d6d31b28f348d9c144f63f49b3ac945e9f4f7a372bd61
 SHA512:
-  metadata.gz: 9c9fc79586eef3d60144b6bdb0093adf3a0ea07db6833a504d65a0bd96c474a66009a1900d071d51370db0857231430b7e18d2777bb7748d216b708f13bd5702
-  data.tar.gz: 27b1519b719d9f0c845271523e4afe4f89366e373868e2b18b10dd3d5360b49b22ba384789dd6a8c3cca46dab4599114a5845a8ecd47d833af8a832c1fcf1f7e
+  metadata.gz: 768d25f256f70733fb563fc75604e90690c36e78d7a8191b8d468c1b678e17d7e158e88bcfda50f028c40e21aeb6de3ca509650e21f1323965a3a01923460eff
+  data.tar.gz: 026c6ba54417b041a173a8523b11baadb3e15a18eaaab57ace3db3376bf47c6b46059ea6706900940deaeaf4edb61f9959ee6d7b9c2b098a61697739845dfda8

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -35,6 +35,21 @@ module MetadataPresenter
     end
     helper_method :answered?
 
+    def analytics_cookie_name
+      @analytics_cookie_name ||= "analytics-#{service.service_name.parameterize}"
+    end
+    helper_method :analytics_cookie_name
+
+    def allow_analytics?
+      no_analytics_cookie? || cookies[analytics_cookie_name] == 'accepted'
+    end
+    helper_method :allow_analytics?
+
+    def show_cookie_banner?
+      no_analytics_cookie? && analytics_tags_present?
+    end
+    helper_method :show_cookie_banner?
+
     private
 
     def not_found
@@ -44,5 +59,15 @@ module MetadataPresenter
     def redirect_to_page(url)
       redirect_to File.join(request.script_name, url)
     end
+
+    def analytics_tags_present?
+      Rails.application.config.supported_analytics.values.flatten.any? do |analytic|
+        ENV[analytic].present?
+      end
+    end
+
+    def no_analytics_cookie?
+      cookies[analytics_cookie_name].blank?
+    end
   end
 end

data/app/models/metadata_presenter/service.rb

@@ -34,7 +34,7 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
   end
 
   def start_page
-    pages.first
+    pages.find { |page| page.type == 'page.start' }
   end
 
   def service_slug

data/app/models/metadata_presenter/traversed_pages.rb

@@ -6,41 +6,42 @@ module MetadataPresenter
       @service = service
       @user_data = user_data
       @pages = [service.start_page]
-      @current_page = current_page || service.pages[-1]
+      @current_page = current_page
     end
 
     delegate :last, to: :all
 
     def all
-      page_uuid = service.start_page.uuid
+      next_object = service.start_page
 
       service.flow.size.times do
-        break if page_uuid == current_page.uuid
-
-        flow_object = service.flow_object(page_uuid)
-
-        if flow_object.branch?
-          page = EvaluateConditionals.new(
-            service: service,
-            flow: flow_object,
-            user_data: user_data
-          ).page
-          page_uuid = page.uuid
-        else
-          page_uuid = flow_object.default_next
-          page = service.find_page_by_uuid(page_uuid)
-        end
-
-        @pages.push(page) if page && page.uuid != current_page.uuid
+        break if next_object.blank? || next_object.uuid == current_page&.uuid
+
+        flow_object = service.flow_object(next_object.uuid)
+        next_object = flow_object.branch? ? evaluated_page(flow_object) : next_flow_object(flow_object.default_next)
+        @pages.push(next_object) if page_in_flow?(next_object)
       end
 
       @pages
     end
 
-    def latest_pages
-      index = service.pages.index(current_page).to_i - 1
+    private
+
+    def evaluated_page(flow_object)
+      EvaluateConditionals.new(
+        service: service,
+        flow: flow_object,
+        user_data: user_data
+      ).page
+    end
+
+    def next_flow_object(uuid)
+      obj = service.flow_object(uuid)
+      obj.branch? ? obj : service.find_page_by_uuid(uuid)
+    end
 
-      service.pages[0..index]
+    def page_in_flow?(obj)
+      obj.is_a?(MetadataPresenter::Page) && obj.uuid != current_page&.uuid
     end
   end
 end

data/app/views/layouts/metadata_presenter/application.html.erb

@@ -4,7 +4,7 @@
     <title><%= service.service_name %></title>
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>
-    
+
   <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
   <link rel="shortcut icon" sizes="16x16 32x32 48x48" href="<%= asset_pack_url('media/images/favicon.ico') %>" type="image/x-icon" />
   <link rel="mask-icon" href="<%= asset_pack_url('media/images/govuk-mask-icon.svg') %>" color="blue">
@@ -15,9 +15,17 @@
 
     <%= stylesheet_pack_tag 'govuk' %>
     <%= stylesheet_link_tag 'application', media: 'all' %>
+
+    <% if allow_analytics? %>
+      <%= render template: 'metadata_presenter/analytics/analytics' %>
+    <% end %>
   </head>
 
   <body class="govuk-template__body">
+    <% if show_cookie_banner? %>
+      <%= render partial: 'metadata_presenter/analytics/cookie_banner' %>
+    <% end %>
+
     <%= render template: 'metadata_presenter/header/show' %>
     <div class="govuk-width-container govuk-body-m">
       <main class="govuk-main-wrapper govuk-main-wrapper--auto-spacing" id="main-content" role="main">

data/app/views/metadata_presenter/analytics/_cookie_banner.html.erb

@@ -0,0 +1,63 @@
+<div class="govuk-cookie-banner" id="govuk-cookie-banner" data-nosnippet role="region" aria-label="<%= t('analytics.heading', service_name: service.service_name) %>">
+  <div class="govuk-cookie-banner__message govuk-width-container" id="govuk-cookie-banner-message">
+
+    <div class="govuk-grid-row">
+      <div class="govuk-grid-column-two-thirds">
+        <h2 class="govuk-cookie-banner__heading govuk-heading-m">
+          <%= t('analytics.heading', service_name: service.service_name) %>
+        </h2>
+
+        <div class="govuk-cookie-banner__content">
+          <p class="govuk-body"><%= t('analytics.body_1') %></p>
+          <p class="govuk-body"><%= t('analytics.body_2') %></p>
+        </div>
+      </div>
+    </div>
+
+    <div class="govuk-button-group">
+      <button type="button" class="govuk-button" data-module="govuk-button" onclick='analytics.accept("<%= analytics_cookie_name %>")'>
+        <%= t('analytics.accept') %>
+      </button>
+      <button type="button" class="govuk-button" data-module="govuk-button" onclick='analytics.reject("<%= analytics_cookie_name %>")'>
+        <%= t('analytics.reject') %>
+      </button>
+      <a class="govuk-link" href="/cookies"><%= t('analytics.view_cookies') %></a>
+    </div>
+  </div>
+
+  <div class="govuk-cookie-banner__message govuk-width-container" id="govuk-cookie-banner-message-accepted" role="alert" style="display: none;">
+    <div class="govuk-grid-row">
+      <div class="govuk-grid-column-two-thirds">
+        <div class="govuk-cookie-banner__content">
+          <p class="govuk-body">
+            <%= t('analytics.confirmation', action: t('analytics.accepted')) %>
+          </p>
+        </div>
+      </div>
+    </div>
+
+    <div class="govuk-button-group">
+      <button class="govuk-button" data-module="govuk-button" onclick="analytics.hideCookieBanner()">
+        <%= t('analytics.hide') %>
+      </button>
+    </div>
+  </div>
+
+  <div class="govuk-cookie-banner__message govuk-width-container" id="govuk-cookie-banner-message-rejected" role="alert" style="display: none;">
+    <div class="govuk-grid-row">
+      <div class="govuk-grid-column-two-thirds">
+        <div class="govuk-cookie-banner__content">
+          <p class="govuk-body">
+            <%= t('analytics.confirmation', action: t('analytics.rejected')) %>
+          </p>
+        </div>
+      </div>
+    </div>
+
+    <div class="govuk-button-group">
+      <button class="govuk-button" data-module="govuk-button" onclick="analytics.hideCookieBanner()">
+        <%= t('analytics.hide') %>
+      </button>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/analytics/_ga4.html.erb

@@ -0,0 +1,10 @@
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=<%= analytic_tag %>"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '<%= analytic_tag %>');
+</script>
+<!-- End Global site tag (gtag.js) - Google Analytics -->

data/app/views/metadata_presenter/analytics/_google.html.erb

@@ -0,0 +1,5 @@
+<% analytics.each do |analytic| %>
+  <% if ENV[analytic].present? %>
+    <%= render partial: "metadata_presenter/analytics/#{analytic.downcase}", locals: { analytic_tag: ENV[analytic] } %>
+  <% end %>
+<% end %>

data/app/views/metadata_presenter/analytics/_gtm.html.erb

@@ -0,0 +1,7 @@
+<!-- Google Tag Manager -->
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','<%= analytic_tag %>');</script>
+<!-- End Google Tag Manager -->

data/app/views/metadata_presenter/analytics/_ua.html.erb

@@ -0,0 +1,11 @@
+<!-- Google Universal Analytics -->
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '<%= analytic_tag %>', 'auto');
+  ga('send', 'pageview');
+</script>
+<!-- End Google Universal Analytics -->

data/app/views/metadata_presenter/analytics/analytics.html.erb

@@ -0,0 +1,3 @@
+<% Rails.application.config.supported_analytics.each do |provider, analytics| %>
+  <%= render partial: "metadata_presenter/analytics/#{provider}", locals: { analytics: analytics } %>
+<% end %>

data/config/initializers/supported_analytics.rb

@@ -0,0 +1 @@
+Rails.application.config.supported_analytics = { google: %w[UA GTM GA4] }

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  analytics:
+    heading: Cookies on %{service_name}
+    body_1: We use some essential cookies to make this service work.
+    body_2: We'd also like to use analytics cookies so we can understand how you use the service and make improvements.
+    accept: Accept analytics cookies
+    reject: Reject analytics cookies
+    view_cookies: View cookies
+    accepted: accepted
+    rejected: rejected
+    confirmation: You've %{action} analytics cookies.
+    hide: Hide this message

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.16.12'.freeze
+  VERSION = '2.17.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.16.12
+  version: 2.17.0
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-01 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -333,6 +333,12 @@ files:
 - app/validators/metadata_presenter/word_count.rb
 - app/views/errors/404.html
 - app/views/layouts/metadata_presenter/application.html.erb
+- app/views/metadata_presenter/analytics/_cookie_banner.html.erb
+- app/views/metadata_presenter/analytics/_ga4.html.erb
+- app/views/metadata_presenter/analytics/_google.html.erb
+- app/views/metadata_presenter/analytics/_gtm.html.erb
+- app/views/metadata_presenter/analytics/_ua.html.erb
+- app/views/metadata_presenter/analytics/analytics.html.erb
 - app/views/metadata_presenter/attribute/_body.html.erb
 - app/views/metadata_presenter/attribute/_heading.html.erb
 - app/views/metadata_presenter/attribute/_lede.html.erb
@@ -363,7 +369,9 @@ files:
 - config/initializers/default_text.rb
 - config/initializers/inflections.rb
 - config/initializers/schemas.rb
+- config/initializers/supported_analytics.rb
 - config/initializers/supported_components.rb
+- config/locales/en.yml
 - config/routes.rb
 - default_metadata/component/autocomplete.json
 - default_metadata/component/checkboxes.json