metadata_presenter 0.19.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 927d4a58d76571c185ffc90cae54f4924c1d2f7e67b1b82be7e4dbe07aa3b814
-  data.tar.gz: ee66e0dc45fb8691146a7b4871c35adcec5c6e1a61e23adf96623889c9cb84d4
+  metadata.gz: 79790874d3e01606cda561899935a3161a7a018606ca7c2e1ea37e5675576b4e
+  data.tar.gz: 27ae8bc8e77f8e6dd3ca586c14ee2e435c6af695f5924d0de5b44ad6c262e167
 SHA512:
-  metadata.gz: 8d80a2047457f6923e4ec424d27617e48bb5b282436dacda25131f15c75727210c6f88cc210abffd9c428a9c487b550fb283695be870c9aa3f90d090eda6a819
-  data.tar.gz: 21c6276b40984fafc6c861140cad12c2ed4359ea0fb1195cd64f420be2719d7ea5d239fc3db180aaacee6bc9e515cd9c7c45520d21e3b8bda3c37b0ae61ffbf2
+  metadata.gz: 571d8aa49dfbe9a66cacf7c92e2bd9b1817146c4d02b56003f737c0e1dbd385f702d59bdb952a76fccff5e97c3adf499183422297cd935d09a955e217917d702
+  data.tar.gz: 5b8531e7ec4c675fe2ee9b547a677660712641ac0f634ec9ca023802bec0ab57b5a0f7e897684e378783bc4f0949124de6d19e605a3a687bca54de9201b688dc

data/app/helpers/metadata_presenter/application_helper.rb

@@ -1,14 +1,8 @@
 module MetadataPresenter
   module ApplicationHelper
     def main_title(component:, tag: :h1, classes: 'govuk-heading-xl')
-      if component.legend.present?
-        content_tag(:h1, class: 'govuk-heading-xl') do
-          component.legend
-        end
-      else
-        content_tag(tag, class: classes) do
-          component.label
-        end
+      content_tag(tag, class: classes) do
+        component.humanised_title
       end
     end
 

data/app/models/metadata_presenter/component.rb

@@ -12,4 +12,8 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
       MetadataPresenter::Item.new(item, editor: editor?)
     end
   end
+
+  def content?
+    type == 'content'
+  end
 end

data/app/presenters/metadata_presenter/page_answers_presenter.rb

@@ -1,9 +1,10 @@
 module MetadataPresenter
   class PageAnswersPresenter
     FIRST_ANSWER = 0.freeze
+    NO_USER_INPUT = %w(page.checkanswers page.confirmation page.content).freeze
 
     def self.map(view:, pages:, answers:)
-      pages.map do |page|
+      user_input_pages(pages).map do |page|
         Array(page.components).map do |component|
           new(
             view: view,
@@ -15,6 +16,10 @@ module MetadataPresenter
       end.reject { |page| page.empty? }
     end
 
+    def self.user_input_pages(pages)
+      pages.reject { |page| page.type.in?(NO_USER_INPUT) }
+    end
+
     attr_reader :view, :component, :page, :answers
     delegate :url, to: :page
     delegate :humanised_title, to: :component

data/app/validators/metadata_presenter/validate_schema.rb

@@ -7,6 +7,11 @@ class MetadataPresenter::ValidateSchema
       return unless controller.request.post?
 
       validate(controller.request.params, 'request.service')
+
+      metadata = controller.request.params['metadata']
+      Array(metadata['pages']).each do |page|
+        validate(page, page['_type'])
+      end
     rescue JSON::Schema::ValidationError, JSON::Schema::SchemaError, SchemaNotFoundError => e
       controller.render(
         json: ErrorsSerializer.new(message: e.message).attributes,

data/app/views/metadata_presenter/attribute/_heading.html.erb

@@ -0,0 +1,7 @@
+<% if @page.heading %>
+  <h1 class="fb-editable govuk-heading-xl"
+      data-fb-content-id="page[heading]"
+      data-fb-content-type="element">
+    <%= @page.heading %>
+  </h1>
+<%- end %>

data/app/views/metadata_presenter/component/_components.html.erb

@@ -0,0 +1,20 @@
+<% @page.components.each_with_index do |component, index| %>
+  <div class="fb-editable"
+        id="<%= component.id %>"
+        data-fb-content-type="<%= component.type %>"
+        data-fb-content-id="<%= "page[components[#{index}]]" %>"
+        data-fb-content-data="<%= component.to_json %>">
+
+    <%= render partial: component, locals: {
+        f: f,
+        component: component,
+        component_id: "page[components[#{index}]]",
+        input_title: main_title(
+          component: component,
+          tag: :h2,
+          classes: classes
+        )
+      }
+    %>
+  </div>
+<% end %>

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

@@ -11,10 +11,6 @@
       </h1>
     <% end %>
 
-    <%= render 'metadata_presenter/attribute/lede' %>
-
-    <%= render 'metadata_presenter/attribute/body' %>
-
     <%= form_for @page, url: reserved_submissions_path do |f| %>
       <div data-block-id="page.checkanswers.answers" data-block-type="answers">
         <dl class="fb-block fb-block-answers govuk-summary-list">
@@ -68,6 +64,14 @@
         </div>
       <% end %>
 
+      <%= render partial: 'metadata_presenter/component/components',
+                 locals: {
+                   f: f,
+                   components: @page.components,
+                   tag: nil,
+                   classes: nil
+                 } %>
+
       <button <%= 'disabled' if editable? %> data-prevent-double-click="true" class="fb-block fb-block-actions govuk-button" data-module="govuk-button" data-block-id="actions" data-block-type="actions">
         Accept and send application
       </button>

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

@@ -13,3 +13,11 @@
     <%= render 'metadata_presenter/attribute/body' %>
   </div>
 </div>
+
+<%= render partial: 'metadata_presenter/component/components',
+           locals: {
+             f: nil,
+             components: @page.components,
+             tag: nil,
+             classes: nil
+           } %>

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

@@ -17,20 +17,14 @@
       <%= render 'metadata_presenter/attribute/body' %>
 
       <%= form_for @page_answers, as: :answers, url: @page.url, method: :post do |f| %>
-        <%= f.govuk_error_summary %>
 
-        <% @page.components.each_with_index do |component, index| %>
-          <div class="fb-editable"
-               data-fb-content-type="<%= component._type %>"
-               data-fb-content-id="<%= "page[components[#{index}]]" %>"
-               data-fb-content-data="<%= component.to_json %>">
-            <%= render partial: component, locals: {
-              component: component,
-              f: f,
-              input_title: main_title(component: component) }
-            %>
-          </div>
-        <% end %>
+        <%= render partial: 'metadata_presenter/component/components',
+                   locals: {
+                     f: f,
+                     components: @page.components,
+                     tag: nil,
+                     classes: nil
+                   } %>
 
         <%= f.govuk_submit(disabled: editable?) %>
       <% end %>

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

@@ -3,23 +3,18 @@
     <div class="govuk-grid-column-two-thirds">
 
       <%= render 'metadata_presenter/attribute/section_heading' %>
-
-      <h1 class="govuk-heading-xl"><%= @page.heading %></h1>
+      <%= render 'metadata_presenter/attribute/heading' %>
 
       <%= form_for @page_answers, as: :answers, url: @page.url, method: :post do |f| %>
         <%= f.govuk_error_summary %>
-        <% @page.components.each_with_index do |component, index| %>
-          <%= render partial: component, locals: {
-            component: component,
-            component_id: "page[components[#{index}]]",
+
+        <%= render partial: 'metadata_presenter/component/components', locals: {
             f: f,
-            input_title: main_title(
-              component: component,
-              tag: :h2,
-              classes: 'govuk-heading-m govuk-!-margin-top-8'
-            ) }
-          %>
-        <% end %>
+            components: @page.components,
+            tag: :h2,
+            classes: 'govuk-heading-m govuk-!-margin-top-8'
+          }
+        %>
 
         <%= f.govuk_submit(disabled: editable?) %>
       <% end %>

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

@@ -2,18 +2,9 @@
   <div class="govuk-grid-row">
     <div class="govuk-grid-column-two-thirds">
 
-    <%= render 'metadata_presenter/attribute/section_heading' %>
-
-      <% if @page.heading %>
-        <h1 class="fb-editable govuk-heading-xl"
-            data-fb-content-id="page[heading]"
-            data-fb-content-type="element">
-          <%= @page.heading %>
-        </h1>
-      <% end %>
-
+      <%= render 'metadata_presenter/attribute/section_heading' %>
+      <%= render 'metadata_presenter/attribute/heading' %>
       <%= render 'metadata_presenter/attribute/lede' %>
-
       <%= render 'metadata_presenter/attribute/body' %>
 
       <%= form_tag(root_path, method: :post) do %>

data/default_metadata/component/checkboxes.json

@@ -20,5 +20,8 @@
     }
   ],
   "name": "component-name",
-  "legend": "Question"
+  "legend": "Question",
+  "validation": {
+    "required": true
+  }
 }

data/default_metadata/component/date.json

@@ -7,6 +7,7 @@
   "name": "component-name",
   "date_type": "day-month-year",
   "validation": {
+    "required": true,
     "date": true
   }
 }

data/default_metadata/component/number.json

@@ -7,6 +7,7 @@
   "name": "component-name",
   "width_class_input": "10",
   "validation": {
+    "required": true,
     "number": true
   }
 }

data/default_metadata/component/radios.json

@@ -20,5 +20,8 @@
     }
   ],
   "name": "component-name",
-  "legend": "Question"
+  "legend": "Question",
+  "validation": {
+    "required": true
+  }
 }

data/default_metadata/page/confirmation.json

@@ -1,5 +1,6 @@
 {
   "_id": "page.confirmation",
   "_type": "page.confirmation",
-  "heading": "Application complete"
+  "heading": "Application complete",
+  "components": []
 }

data/default_text/content.json

@@ -0,0 +1,7 @@
+{
+  "section_heading": "[Optional section heading]",
+  "lede": "[Optional lede paragraph]",
+  "body": "[Optional content]",
+  "html": "[Optional content]",
+  "hint": "[Optional hint text]"
+}

data/fixtures/invalid_content_page.json

@@ -0,0 +1,72 @@
+{
+  "_id": "service.base",
+  "_type": "service.base",
+  "service_name": "Service name",
+  "created_by": "4634ec01-5618-45ec-a4e2-bb5aa587e751",
+  "configuration": {
+    "service": {
+      "_id": "config.service",
+      "_type": "config.service"
+    },
+    "meta": {
+      "_id": "config.meta",
+      "_type": "config.meta",
+      "items": [
+        {
+          "_id": "config.meta--link",
+          "_type": "link",
+          "href": "/cookies",
+          "text": "Cookies"
+        },
+        {
+          "_id": "config.meta--link--2",
+          "_type": "link",
+          "href": "/privacy",
+          "text": "Privacy"
+        },
+        {
+          "_id": "config.meta--link--3",
+          "_type": "link",
+          "href": "/accessibility",
+          "text": "Accessibility"
+        }
+      ]
+    }
+  },
+  "pages": [
+    {
+      "_uuid": "9626b2e9-5ef0-4070-8331-ac55151b22c4",
+      "_id": "page.start",
+      "_type": "page.start",
+      "heading": "Service name goes here",
+      "lede": "Use this service to:",
+      "body": "Use this service to:\r\n\r\n* do something\r\n* update your name, address or other details\r\n* do something else\r\n\r\nRegistering takes around 5 minutes.",
+      "before_you_start": "###Before you start\r\nYou can also register by post.\r\n\r\nThe online service is also available in Welsh (Cymraeg).\r\n\r\nYou cannot register for this service if you’re in the UK illegally.",
+      "steps": [],
+      "url": "/"
+    },
+    {
+      "_uuid": "1ed3e4ad-5098-41c9-b4b6-426e89f7804e",
+      "_id": "page.how-many-lights",
+      "_type": "page.content",
+      "section_heading": "Chain of Command",
+      "heading": "Tell me how many lights you see",
+      "body": "There are four lights!",
+      "components": [
+        {
+          "_id": "name_text_1",
+          "_type": "text",
+          "label": "Full name",
+          "name": "name_text_1",
+          "validation": {
+            "required": true,
+            "max_length": 10,
+            "min_length": 2
+          }
+        }
+      ],
+      "url": "how-many-lights"
+    }
+  ],
+  "locale": "en"
+}

data/fixtures/no_component_page.json

@@ -0,0 +1,60 @@
+{
+  "_id": "service.base",
+  "_type": "service.base",
+  "service_name": "Service name",
+  "created_by": "4634ec01-5618-45ec-a4e2-bb5aa587e751",
+  "configuration": {
+    "service": {
+      "_id": "config.service",
+      "_type": "config.service"
+    },
+    "meta": {
+      "_id": "config.meta",
+      "_type": "config.meta",
+      "items": [
+        {
+          "_id": "config.meta--link",
+          "_type": "link",
+          "href": "/cookies",
+          "text": "Cookies"
+        },
+        {
+          "_id": "config.meta--link--2",
+          "_type": "link",
+          "href": "/privacy",
+          "text": "Privacy"
+        },
+        {
+          "_id": "config.meta--link--3",
+          "_type": "link",
+          "href": "/accessibility",
+          "text": "Accessibility"
+        }
+      ]
+    }
+  },
+  "pages": [
+    {
+      "_uuid": "9626b2e9-5ef0-4070-8331-ac55151b22c4",
+      "_id": "page.start",
+      "_type": "page.start",
+      "heading": "Service name goes here",
+      "lede": "Use this service to:",
+      "body": "Use this service to:\r\n\r\n* do something\r\n* update your name, address or other details\r\n* do something else\r\n\r\nRegistering takes around 5 minutes.",
+      "before_you_start": "###Before you start\r\nYou can also register by post.\r\n\r\nThe online service is also available in Welsh (Cymraeg).\r\n\r\nYou cannot register for this service if you’re in the UK illegally.",
+      "steps": [],
+      "url": "/"
+    },
+    {
+      "_uuid": "b238a22f-c180-48d0-a7d9-8aad2036f1f2",
+      "_id": "page._confirmation",
+      "_type": "page.confirmation",
+      "body": "You'll receive a confirmation email",
+      "heading": "Complaint sent",
+      "lede": "Optional lede",
+      "url": "/confirmation",
+      "components": []
+    }
+  ],
+  "locale": "en"
+}

data/fixtures/version.json

@@ -326,20 +326,31 @@
       "section_heading": "Chain of Command",
       "heading": "Tell me how many lights you see",
       "body": "There are four lights!",
-      "components": [],
+      "components": [
+        {
+          "_id": "how-many-lights_content_1",
+          "_type": "content",
+          "html": "What lights?"
+        }
+      ],
       "url": "how-many-lights"
     },
     {
       "_uuid": "e819d0c2-7062-4997-89cf-44d26d098404",
       "_id": "page._check-answers",
       "_type": "page.checkanswers",
-      "body": "Optional content",
       "heading": "Review your answer",
-      "lede": "First paragraph",
       "section_heading": "This section is optional",
       "send_body": "By submitting this answer you confirm all your answers",
       "send_heading": "Send your answer",
-      "url": "/check-answers"
+      "url": "/check-answers",
+      "components": [
+        {
+          "_id": "check-answers_content_1",
+          "_type": "content",
+          "html": "Check yourself before you wreck yourself."
+        }
+      ]
     },
     {
       "_uuid": "b238a22f-c180-48d0-a7d9-8aad2036f1f2",
@@ -348,7 +359,14 @@
       "body": "You'll receive a confirmation email",
       "heading": "Complaint sent",
       "lede": "Optional lede",
-      "url": "/confirmation"
+      "url": "/confirmation",
+      "components": [
+        {
+          "_id": "confirmation_content_1",
+          "_type": "content",
+          "html": "Some day I will be the most powerful Jedi ever!"
+        }
+      ]
     }
   ],
   "locale": "en"

data/lib/metadata_presenter/test_helpers.rb

@@ -11,7 +11,6 @@ module MetadataPresenter
 
     def service_metadata
       metadata_fixture(:version)
-      JSON.parse(File.read(fixtures_directory.join('version.json')))
     end
 
     def metadata_fixture(fixture_name)

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '0.19.1'
+  VERSION = '0.22.0'
 end

data/schemas/page/checkanswers.json

@@ -17,16 +17,6 @@
       "type": "string",
       "default": "Check your answers"
     },
-    "lede": {
-      "title": "Lede",
-      "type": "string",
-      "description": "Content before the body"
-    },
-    "body": {
-      "title": "Body",
-      "type": "string",
-      "description": "Optional content before showing the summary"
-    },
     "summary_of": {
       "title": "Summary of",
       "description": "Page/section that summary summarises"
@@ -45,6 +35,14 @@
       "content": true,
       "multiline": true,
       "default": "By submitting this application you confirm that, to the best of your knowledge, the details you are providing are correct."
+    },
+    "components": {
+      "title": "Components",
+      "description": "The form or content elements used on the page",
+      "type": "array",
+      "items": {
+        "$ref": "component.content"
+      }
     }
   },
   "required": [

data/schemas/page/confirmation.json

@@ -19,6 +19,14 @@
     },
     "lede": {
       "multiline": true
+    },
+    "components": {
+      "title": "Components",
+      "description": "The form or content elements used on the page",
+      "type": "array",
+      "items": {
+        "$ref": "component.content"
+      }
     }
   },
   "required": [

data/schemas/page/content.json

@@ -7,6 +7,14 @@
   "properties": {
     "_type": {
       "const": "page.content"
+    },
+    "components": {
+      "title": "Components",
+      "description": "The form or content elements used on the page",
+      "type": "array",
+      "items": {
+        "$ref": "component.content"
+      }
     }
   },
   "allOf": [

data/schemas/service/base.json

@@ -35,7 +35,26 @@
     "pages": {
       "type": "array",
       "items": {
-        "$ref": "definition.page"
+        "anyOf": [
+          {
+            "$ref": "page.start"
+          },
+          {
+            "$ref": "page.checkanswers"
+          },
+          {
+            "$ref": "page.confirmation"
+          },
+          {
+            "$ref": "page.content"
+          },
+          {
+            "$ref": "page.multiplequestions"
+          },
+          {
+            "$ref": "page.singlequestion"
+          }
+        ]
       }
     }
   },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.22.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -253,9 +253,11 @@ files:
 - app/views/errors/404.html
 - app/views/layouts/metadata_presenter/application.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
 - app/views/metadata_presenter/attribute/_section_heading.html.erb
 - app/views/metadata_presenter/component/_checkboxes.html.erb
+- app/views/metadata_presenter/component/_components.html.erb
 - app/views/metadata_presenter/component/_content.html.erb
 - app/views/metadata_presenter/component/_date.html.erb
 - app/views/metadata_presenter/component/_number.html.erb
@@ -298,6 +300,9 @@ files:
 - default_metadata/string/error.min_length.json
 - default_metadata/string/error.number.json
 - default_metadata/string/error.required.json
+- default_text/content.json
+- fixtures/invalid_content_page.json
+- fixtures/no_component_page.json
 - fixtures/non_finished_service.json
 - fixtures/service.json
 - fixtures/version.json