metadata_presenter 2.17.22 → 2.17.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2aeee9b33d6e83a66ad780ca547fb98930d7b393f421ae82d2c43f079ce34b3
-  data.tar.gz: 07ce4abf077d450fa7b9e75803e963d52580ad8b869d0d31f1f3801cfe0869e8
+  metadata.gz: 1ac0f24124b3fec15ae97ead53024f38d6994e43ed13bb5403b9ba95d1aff223
+  data.tar.gz: 150cda8e9b2baeb4b6dfc63b0d8c1c267d4e6567dae47f5bab47a248d1e32291
 SHA512:
-  metadata.gz: 00d52aa887dc76063ecf6073627112dcb7e3dca493fd29c2441c0521bb9b03f538f77397c6cb70830c8dbd5c351e5ca0a16691dab4bf11104e0edf3d2084f89c
-  data.tar.gz: b5c56e15a0bfb6235b5a26568fa22945f3530ed97ce1e0be166250c3ae2d7493870f81e8edb87fc3efd4cd645b5faa399fe8b3a33debeace00a22c888ae8b18b
+  metadata.gz: 01dfcea0c9dac9a424e3ca1ae6c52e46ec3806dd81e0ed76ba3d4d80d22a7ca2f9c83135fa5e2d5740b97d7f6655060dc96f0fc9bee94496c500b595b7807391
+  data.tar.gz: 858ae2046f74cd98d9544beeaef47bc822a49fe36fc1a4067d5b35e85f3bcc1a5e0e3a4d413e97244cf22502c2447772b05d4cdfbe6e7fda96010d9c549d1186

data/README.md

@@ -50,6 +50,8 @@ that you need to write the following methods in your controller:
 3. editable?
 4. create_submission
 5. assign_autocomplete_items
+6. reference_number_enabled?
+7. show_reference_number
 
 The user answers can be accessed via `params[:answers]`.
 
@@ -83,6 +85,10 @@ service.
 
 The `autocomplete_items` takes the components on a page and retrieves any items for them that may exist. For the Editor it will make an API call, for the Runner it will look it up via an environment variable.
 
+`reference_number_enabled?` method checks whether reference number is enabled in the Runner or Editor app. For the Runner app reference number is enabled when the `ENV['REFERENCE_NUMBER']` variable is present. In the Editor, reference number enabled is checked by checking the `ServiceConfiguration` table.
+
+`show_reference_number` method will present the placeholder reference number if viewing in the Editor/Preview or will present a generated reference number if in the Runner.
+
 ## Generate documentation
 
 Run `rake doc` and open the doc/index.html

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -5,6 +5,8 @@ module MetadataPresenter
     helper MetadataPresenter::ApplicationHelper
     default_form_builder GOVUKDesignSystemFormBuilder::FormBuilder
 
+    before_action :show_maintenance_page
+
     def reload_user_data
       if defined? super
         super
@@ -64,6 +66,10 @@ module MetadataPresenter
       end
     end
 
+    def maintenance_mode?
+      ENV['MAINTENANCE_MODE'].present? && ENV['MAINTENANCE_MODE'] == '1'
+    end
+
     private
 
     def not_found
@@ -77,5 +83,22 @@ module MetadataPresenter
     def no_analytics_cookie?
       cookies[analytics_cookie_name].blank?
     end
+
+    def maintenance_page_content
+      return t('presenter.maintenance.maintenance_page_content') unless ENV['MAINTENANCE_PAGE_CONTENT']
+
+      Base64.decode64(ENV['MAINTENANCE_PAGE_CONTENT'])
+    end
+
+    def show_maintenance_page
+      if maintenance_mode?
+        @maintenance_page = {
+          heading: ENV['MAINTENANCE_PAGE_HEADING'] || t('presenter.maintenance.maintenance_page_heading'),
+          content: maintenance_page_content
+        }
+
+        render 'metadata_presenter/maintenance/show'
+      end
+    end
   end
 end

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

@@ -14,7 +14,7 @@
   <link rel="apple-touch-icon" sizes="152x152" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon-152x152.png') %>">
   <link rel="apple-touch-icon" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon.png') %>">
 
-    <%= javascript_pack_tag 'runner_application', 'govuk', defer: true %> 
+    <%= javascript_pack_tag 'runner_application', 'govuk', defer: true %>
     <%= stylesheet_pack_tag 'govuk', 'runner_application', media: 'all' %>
 
     <% if allow_analytics? %>

data/app/views/metadata_presenter/maintenance/show.html.erb

@@ -0,0 +1,8 @@
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <h1 class="govuk-heading-l"><%= @maintenance_page[:heading] %></h1>
+    <div class="maintenance-content">
+      <%= to_html @maintenance_page[:content] %>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/page/confirmation.html.erb

@@ -7,15 +7,23 @@
       <%= @page.heading %>
     </h1>
 
-    <%# Do not replace with app/views/metadata_presenter/attribute _lede.html.erb because that is different %>
-    <% if @page.lede %>
-      <div class="fb-editable govuk-panel__body"
-           data-fb-content-id="page[lede]"
-           data-fb-content-type="element"
-           data-fb-default-text="<%= default_text('lede') %>">
-        <%= @page.lede %>
-      </div>
-    <%- end %>
+    <div class="govuk-panel__body">
+      <% if reference_number_enabled? %>
+        <p>Your reference number<br />
+          <strong><%= show_reference_number %></strong>
+        </p>
+      <% end %>
+
+      <%# Do not replace with app/views/metadata_presenter/attribute _lede.html.erb because that is different %>
+      <% if @page.lede %>
+        <div class="fb-editable"
+            data-fb-content-id="page[lede]"
+            data-fb-content-type="element"
+            data-fb-default-text="<%= default_text('lede') %>">
+          <%= @page.lede %>
+        </div>
+      <%- end %>
+    </div>
   </div>
 
   <div class="govuk-grid-row">

data/config/locales/en.yml

@@ -16,6 +16,9 @@ en:
       rejected: rejected
       confirmation: You've %{action} analytics cookies.
       hide: Hide this message
+    maintenance:
+      maintenance_page_heading: 'Sorry, this form is unavailable'
+      maintenance_page_content: "If you were in the middle of completing the form, your data has not been saved.\r\n\r\nThe form will be available again from 9am on Monday 19 November 2018.\r\n\r\n\r\n\r\n### Other ways to apply\r\n\r\nContact us if your application is urgent \r\n\r\nEmail:  \r\nTelephone:  \r\nMonday to Friday, 9am to 5pm  \r\n[Find out about call charges](https://www.gov.uk/call-charges)"
     footer:
       cookies:
         heading: "Cookies"

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.17.22'.freeze
+  VERSION = '2.17.24'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.17.22
+  version: 2.17.24
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -346,6 +346,7 @@ files:
 - app/views/metadata_presenter/footer/_meta.html.erb
 - app/views/metadata_presenter/footer/footer.html.erb
 - app/views/metadata_presenter/header/show.html.erb
+- app/views/metadata_presenter/maintenance/show.html.erb
 - app/views/metadata_presenter/page/checkanswers.html.erb
 - app/views/metadata_presenter/page/confirmation.html.erb
 - app/views/metadata_presenter/page/content.html.erb