metadata_presenter 2.16.10 → 2.16.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 485ccb033ebf65579ec72329d55c564cdbc34506e3f1969fcb50f9a23c8c5eb4
-  data.tar.gz: 8a37bba5f55e35afb405f9b264ffaf6e42467bafeaf84ffee36982b3275ca3ce
+  metadata.gz: f654eb8910e6b544c20c7b4966c923dfaa60fe94bf2afb0602ba6522b22c897b
+  data.tar.gz: fdaf6374f850ecd62c1b41fb2c985d98e5fd422943012e437344086a7fd9ad07
 SHA512:
-  metadata.gz: 9df9ad7705f673275fcebe228a6b1868dbd0985daadf05b97bf43014920bc18a213bac3b537c5306db36d4de530480915dd76a6ae00c7602f79e2147fb4765c3
-  data.tar.gz: e87be78ce97fdc4b0bca7d093b40a3e956e7dd29a72427523780bcf1176801e1eb264980b1a862e83eaac7fe8811a86cf4491fa2ea8b9a24b01ab46fea704963
+  metadata.gz: bd349181c6279c3f338b6004a8730d4b6f9f5624be90d99712875e16c799827936837c66b24d99738440588b26ee8ab67213bf18cabfb35e788da8e7734f49d7
+  data.tar.gz: ae76a89d85d486dfea4f4154e5bfd3da23455501eec8ac6c9b8ec28a015fa87253e5d093afcdec60e9e0928cdeff4b43072376f8f2c3ba0d1bb572168d7ef223

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/component.rb

@@ -6,6 +6,10 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
     'textarea' => 'string'
   }.freeze
 
+  # Used for max_length and max_word validations.
+  # Threshold percentage at which the remaining count is shown
+  VALIDATION_STRING_LENGTH_THRESHOLD = 75
+
   def to_partial_path
     "metadata_presenter/component/#{type}"
   end
@@ -46,6 +50,10 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
                    .keys
   end
 
+  def validation_threshold
+    VALIDATION_STRING_LENGTH_THRESHOLD
+  end
+
   private
 
   def validation_bundle_key

data/app/validators/metadata_presenter/base_validator.rb

@@ -75,10 +75,9 @@ module MetadataPresenter
     # is not present
     def default_error_message
       default_error_message_key = "error.#{schema_key}"
-      default_message = Rails
-                          .application
-                          .config
-                          .default_metadata[default_error_message_key]
+      default_message = Rails.application
+                             .config
+                             .default_metadata[default_error_message_key]
 
       if default_message.present?
         default_message['value'] % error_message_hash
@@ -116,10 +115,16 @@ module MetadataPresenter
     def error_message_hash
       {
         control: component.humanised_title,
-        schema_key.to_sym => component.validation[schema_key]
+        schema_key.to_sym => validation_value
       }
     end
 
+    # The validation configuration value
+    # Override if additional formatting of the value is required
+    def validation_value
+      component.validation[schema_key]
+    end
+
     # Method signature to be overwrite in the subclass if you do not want to allow
     # blank values. We should not allow blank when performing the required
     # validation.

data/app/validators/metadata_presenter/date_validator.rb

@@ -1,5 +1,7 @@
 module MetadataPresenter
   class DateValidator < BaseValidator
+    DATE_STRING_VALIDATIONS = %w[date_after date_before].freeze
+
     def invalid_answer?
       Date.strptime(
         "#{user_answer.year}-#{user_answer.month}-#{user_answer.day}",
@@ -10,5 +12,11 @@ module MetadataPresenter
     rescue Date::Error
       true
     end
+
+    def validation_value
+      return unless schema_key.in?(DATE_STRING_VALIDATIONS)
+
+      Date.parse(component.validation[schema_key]).strftime('%d %m %Y')
+    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/app/views/metadata_presenter/component/_textarea.html.erb

@@ -6,8 +6,8 @@
       text: component.hint
     },
     name: "answers[#{component.name}]",
-    max_chars: component.maxchars,
-    max_words: component.maxwords,
-    threshold: component.threshold,
+    max_chars: component.validation['max_length'],
+    max_words: component.validation['max_word'],
+    threshold: component.validation_threshold,
     rows: component.rows
 %>

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/default_metadata/component/autocomplete.json

@@ -0,0 +1,12 @@
+{
+  "_id": "component.autocomplete",
+  "_type": "autocomplete",
+  "errors": {},
+  "hint": "",
+  "options": [],
+  "name": "component-name",
+  "legend": "Question",
+  "validation": {
+    "required": true
+  }
+}

data/default_metadata/string/error.accept.json

@@ -2,5 +2,5 @@
   "_id": "error.accept",
   "_type": "string.error",
   "description": "File uploaded is wrong type",
-  "value": "%{control} was not uploaded successfully as it is the wrong type"
+  "value": "\"%{control}\" was not uploaded successfully as it is the wrong type"
 }

data/default_metadata/string/error.date.json

@@ -2,5 +2,5 @@
   "_id": "error.date",
   "_type": "string.error",
   "description": "Input (date) is not a valid date",
-  "value": "Enter a valid date for %{control}"
+  "value": "Enter a valid date for \"%{control}\""
 }

data/default_metadata/string/error.date_after.json

@@ -2,5 +2,5 @@
   "_id": "error.date_after",
   "_type": "string.error",
   "description": "Input (date) is earlier than allowed",
-  "value": "Enter a later date for %{control}"
+  "value": "Your answer for \"%{control}\" must be %{date_after} or later"
 }

data/default_metadata/string/error.date_before.json

@@ -2,5 +2,5 @@
   "_id": "error.date_before",
   "_type": "string.error",
   "description": "Input (date) is later than allowed",
-  "value": "Enter an earlier date for %{control}"
+  "value": "Your answer for \"%{control}\" must be %{date_before} or earlier"
 }

data/default_metadata/string/error.max_length.json

@@ -2,5 +2,5 @@
   "_id": "error.max_length",
   "_type": "string.error",
   "description": "Input (string) is too long",
-  "value": "Your answer for '%{control}' is too long (%{max_length} characters at most)"
+  "value": "Your answer for \"%{control}\" must be %{max_length} characters or fewer"
 }

data/default_metadata/string/error.max_word.json

@@ -2,5 +2,5 @@
   "_id": "error.max_word",
   "_type": "string.error",
   "description": "Input (number) is higher than the maximum number of words allowed",
-  "value": "Enter a lower number of words for %{control}"
+  "value": "Your answer for \"%{control}\" must be %{max_word} words or fewer"
 }

data/default_metadata/string/error.maximum.json

@@ -2,5 +2,5 @@
   "_id": "error.maximum",
   "_type": "string.error",
   "description": "Input (number) is larger than the maximum allowed",
-  "value": "Enter a lower number for %{control}"
+  "value": "Your answer for \"%{control}\" must be %{maximum} or lower"
 }

data/default_metadata/string/error.min_length.json

@@ -2,5 +2,5 @@
   "_id": "error.min_length",
   "_type": "string.error",
   "description": "Input (string) is too short",
-  "value": "Your answer for '%{control}' is too short (%{min_length} characters at least)"
+  "value": "Your answer for \"%{control}\" must be %{min_length} characters or more"
 }

data/default_metadata/string/error.min_word.json

@@ -2,5 +2,5 @@
   "_id": "error.min_word",
   "_type": "string.error",
   "description": "Input (number) is lower than the minimum number of words allowed",
-  "value": "Enter a higher number of words for %{control}"
+  "value": "Your answer for \"%{control}\" must be %{min_word} words or more"
 }

data/default_metadata/string/error.minimum.json

@@ -2,5 +2,5 @@
   "_id": "error.minimum",
   "_type": "string.error",
   "description": "Input (number) is lower than the minimum allowed",
-  "value": "Enter a higher number for %{control}"
+  "value": "Your answer for \"%{control}\" must be %{minimum} or higher"
 }

data/default_metadata/string/error.number.json

@@ -2,5 +2,5 @@
   "_id": "error.number",
   "_type": "string.error",
   "description": "Input (number) is not a number",
-  "value": "Enter a number for %{control}"
+  "value": "Enter a number for \"%{control}\""
 }

data/default_metadata/string/error.required.json

@@ -2,6 +2,6 @@
   "_id": "error.required",
   "_type": "string.error",
   "description": "Input is required",
-  "value": "Enter an answer for %{control}",
-  "value:cy": "Rhowch ateb i {control}"
+  "value": "Enter an answer for \"%{control}\"",
+  "value:cy": "Rhowch ateb i \"{control}\""
 }

data/default_metadata/string/error.virus_scan.json

@@ -2,6 +2,6 @@
   "_id": "error.virus_scan",
   "_type": "string.error",
   "description": "File uploaded contains virus",
-  "value": "%{control} was not uploaded successfully because it contains a virus"
+  "value": "\"%{control}\" was not uploaded successfully because it contains a virus"
 }
 

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.16.10'.freeze
+  VERSION = '2.16.13'.freeze
 end

data/schemas/component/autocomplete.json

@@ -0,0 +1,17 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/autocomplete",
+  "_name": "autocomplete",
+  "title": "Autocomplete",
+  "description": "Let users select one option from an auto-completing list",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "definition.select"
+    }
+  ],
+  "properties": {
+    "_type": {
+      "const": "autocomplete"
+    }
+  }
+}

data/schemas/definition/select.json

@@ -0,0 +1,29 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/select",
+  "_name": "definition.select",
+  "title": "Select component definition",
+  "allOf": [
+    {
+      "$ref": "definition.field"
+    },
+    {
+      "$ref": "definition.width_class.input"
+    }
+  ],
+  "properties": {
+    "items": {
+      "title": "Options",
+      "description": "Items that users can select",
+      "type": "array",
+      "items": {
+        "$ref": "definition.select_option"
+      }
+    }
+  },
+  "required": [
+    "items"
+  ],
+  "category": [
+    "select"
+  ]
+}

data/schemas/definition/select_option.json

@@ -0,0 +1,34 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/select_option",
+  "_name": "definition.select_option",
+  "title": "Select option",
+  "description": "Component that provides a select option",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "select_option"
+    },
+    "text": {
+      "title": "Option text",
+      "description": "Text displayed to users for that option",
+      "type": "string",
+      "content": true
+    },
+    "value": {
+      "title": "Option value",
+      "description": "Value assigned when users select option",
+      "type": "string"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.component"
+    }
+  ],
+  "required": [
+    "value"
+  ],
+  "category": [
+    "select_option"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.16.10
+  version: 2.16.13
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-06-08 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,8 +369,11 @@ 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
 - default_metadata/component/content.json
 - default_metadata/component/date.json
@@ -448,6 +457,7 @@ files:
 - lib/metadata_presenter/test_helpers.rb
 - lib/metadata_presenter/version.rb
 - lib/tasks/metadata_presenter_tasks.rake
+- schemas/component/autocomplete.json
 - schemas/component/checkboxes.json
 - schemas/component/content.json
 - schemas/component/date.json
@@ -493,6 +503,8 @@ files:
 - schemas/definition/page.json
 - schemas/definition/radio.json
 - schemas/definition/repeatable.json
+- schemas/definition/select.json
+- schemas/definition/select_option.json
 - schemas/definition/width_class.input.json
 - schemas/definition/width_class.json
 - schemas/errors/errors.json