metadata_presenter 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98b871be342033efb49a77309b9d1e506318660eb2b93693bc4148e609d37f7c
-  data.tar.gz: c03685b11d5c258410a5964021886c6eb4105b82698d66bc1c4dd6715559be6e
+  metadata.gz: 4502db8905d70f018c8229e2fffb8f1c392415ee4ee8214bfc9bde851e563c8e
+  data.tar.gz: ddaacc9a8520bdb2df646150e3f10001d06c9865a0008e68b8e117320b8e0d85
 SHA512:
-  metadata.gz: 57651e49df9cd24e838f578b2f61a6413524678b4e2caf82fe548d028190df8aae511af71ccc03a576e799050834c7d0cf3a1c91eac7d03e73de7641850fd08a
-  data.tar.gz: 529e16568eaba2c55b69bae60f895c3c6b275e59e49deab85a207c612561adfa9f8b2f8e85c2a3244e2c7c534beaa17e1010dca57d75f1647e818c376c382e91
+  metadata.gz: f21f6779bf1c90b4a09a7042f2117b5b2712fc72d2eb331226bd6142452abf2a6eac9f1c3b221c12bef9c2d46584f6f514b4918ba3f90381ffaf6d6daebbf9a4
+  data.tar.gz: dd6bcd473cdd65ace450ec00e1c4431d7844bf99201471e330752254b2eb2193cf15ad2ed0936a31c5483b97a3b7c4e4924c0b63d1d4a6aea21a5905279d530c

data/README.md

@@ -47,6 +47,7 @@ that you need to write the following methods in your controller:
 
 1. save_user_data
 2. load_user_data
+3. editable?
 
 The user answers can be accessed via `params[:answers]`.
 
@@ -63,6 +64,18 @@ An example of implementation:
  end
 ```
 
+The `editable?` is related if the pages and components could be editable in the
+mountable app:
+
+```ruby
+  class MyAwesomeController
+    def editable?
+      false
+    end
+    helper_method :editable?
+  end
+```
+
 ## Generate documentation
 
 Run `rake doc` and open the doc/index.html

data/app/models/metadata_presenter/component.rb

@@ -1,5 +1,5 @@
 class MetadataPresenter::Component < MetadataPresenter::Metadata
   def to_partial_path
-    "component/#{type}"
+    "metadata_presenter/component/#{type}"
   end
 end

data/app/models/metadata_presenter/next_page.rb

@@ -9,7 +9,7 @@ module MetadataPresenter
     def find(session:, current_page_url:)
       if session[:return_to_check_you_answer].present?
         session[:return_to_check_you_answer] = nil
-        service.pages.find { |page| page.type == 'page.summary' }
+        service.pages.find { |page| page.type == 'page.checkanswers' }
       else
         service.next_page(from: current_page_url)
       end

data/app/models/metadata_presenter/page.rb

@@ -10,6 +10,10 @@ module MetadataPresenter
       id == other.id if other.respond_to? :id
     end
 
+    def editable_attributes
+      self.to_h.reject { |k,_| k.in?([:_id, :_type, :steps]) }
+    end
+
     def components
       metadata.components&.map do |component|
         MetadataPresenter::Component.new(component)

data/app/validators/metadata_presenter/validate_schema.rb

@@ -6,8 +6,7 @@ class MetadataPresenter::ValidateSchema
     def before(controller)
       return unless controller.request.post?
 
-      schema_name = "request.#{controller.request.params['controller']}"
-      validate(controller.request.params, schema_name)
+      validate(controller.request.params, 'request.service')
     rescue JSON::Schema::ValidationError, JSON::Schema::SchemaError, SchemaNotFoundError => e
       controller.render(
         json: ErrorsSerializer.new(message: e.message).attributes,

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

@@ -3,5 +3,5 @@
     label: { text: component.label },
     hint: { text: component.hint },
     name: "answers[#{component.name}]",
-    value: @user_data[component.name]
+    value: @user_data ? @user_data[component.name] : nil
 %>

data/app/views/metadata_presenter/page/{summary.html.erb → checkanswers.html.erb}

@@ -25,7 +25,7 @@
     <% end %>
 
     <%= form_for @page, url: reserved_submissions_path do |f| %>
-      <div data-block-id="page.summary.answers" data-block-type="answers">
+      <div data-block-id="page.checkanswers.answers" data-block-type="answers">
         <dl class="fb-block fb-block-answers govuk-summary-list">
           <% @service.pages.each do |page| %>
             <% Array(page.components).each do |component| %>

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

@@ -11,7 +11,7 @@
           <%= render partial: component, locals: { component: component, f: f } %>
         <% end %>
 
-        <%= f.govuk_submit %>
+        <%= f.govuk_submit(disabled: editable?) %>
       <% end %>
     </div>
   </div>

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

@@ -26,13 +26,19 @@
       <%- end %>
 
       <%= form_tag(reserved_answers_path(@page.url), method: :post) do %>
-        <button class='govuk-button govuk-button--start govuk-!-margin-top-2'>
+        <button <%= 'disabled' if editable? %> class='govuk-button govuk-button--start govuk-!-margin-top-2'>
         Start
           <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" aria-hidden="true" focusable="false">
             <path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z" />
           </svg>
         </button>
       <% end %>
+
+      <% if @page.before_you_start %>
+        <p class="govuk-body-l" data-block-id="<%= @page.id %>" data-block-property="before-you-start">
+        <%= to_markdown(@page.before_you_start) %>
+        </p>
+      <%- end %>
     </div>
   </div>
 </div>

data/default_metadata/component/text.json

@@ -0,0 +1,8 @@
+{
+  "_id": "component.text",
+  "_type": "text",
+  "errors": {},
+  "hint": "Component hint",
+  "label": "Component label",
+  "name": "component-name"
+}

data/default_metadata/config/service.json

@@ -1,7 +1,4 @@
 {
   "_id": "config.service",
-  "_type": "config.service",
-  "homepage_url": "https://www.gov.uk",
-  "service_email_address": "moj-online@digital.justice.gov.uk",
-  "service_url": "page.start"
+  "_type": "config.service"
 }

data/default_metadata/page/{summary.json → checkanswers.json}

@@ -1,6 +1,8 @@
 {
-  "_id": "page.summary",
+  "_id": "page.checkanswers",
+  "_type": "page.checkanswers",
   "heading": "Check your answers",
   "send_heading": "Now send your application",
-  "send_body": "By submitting this application you confirm that, to the best of your knowledge, the details you are providing are correct."
+  "send_body": "By submitting this application you confirm that, to the best of your knowledge, the details you are providing are correct.",
+  "components": []
 }

data/default_metadata/page/confirmation.json

@@ -1,4 +1,5 @@
 {
   "_id": "page.confirmation",
+  "_type": "page.confirmation",
   "heading": "Required - Confirmation"
 }

data/default_metadata/page/singlequestion.json

@@ -0,0 +1,9 @@
+{
+  "_id": "page.singlequestion",
+  "_type": "page.singlequestion",
+  "heading": "Question",
+  "lede": "This is the lede",
+  "body": "Body section",
+  "components": [],
+  "url": ""
+}

data/default_metadata/service/base.json

@@ -1,15 +1,16 @@
 {
   "_id": "service.base",
   "_type": "service.base",
-  "service_name": "Service name goes here",
+  "service_name": "Service name",
   "configuration": {},
   "pages": [
     {
       "_id": "page.start",
       "_type": "page.start",
-      "heading": "Start page heading",
-      "body": "Start page body text",
-      "lede": "Start page lede text",
+      "heading": "Service name goes here",
+      "lede": "This is your start page first paragraph. You can only have one paragraph here.",
+      "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": "/"
     }

data/fixtures/non_finished_service.json

@@ -2,15 +2,12 @@
   "_id": "service.base",
   "_type": "service.base",
   "service_id": "d243f5c0-e8a2-4b13-982c-7b5f3fa128cf",
-  "service_name": "Main fixture to test Form builder",
+  "service_name": "Service name",
   "created_by": "4634ec01-5618-45ec-a4e2-bb5aa587e751",
   "configuration": {
     "service": {
       "_id": "config.service",
-      "_type": "config.service",
-      "homepage_url": "https://www.gov.uk",
-      "service_email_address": "moj-online@digital.justice.gov.uk",
-      "service_url": "page.start"
+      "_type": "config.service"
     },
     "meta": {
       "_id": "config.meta",
@@ -41,9 +38,9 @@
     {
       "_id": "page.start",
       "_type": "page.start",
-      "body": "You cannot use this form to complain about:\r\n\r\n* the result of a case\r\n* a judge, magistrate, coroner or member of a tribunal\r\n\r\nThis online form is also available in [Welsh (Cymraeg)](https://complain-about-a-court-or-tribunal.form.service.justice.gov.uk/cy).",
-      "heading": "Complain about a court or tribunal",
-      "lede": "Your complaint will not affect your case.",
+      "heading": "Service name goes here",
+      "lede": "This is your start page first paragraph. You can only have one paragraph here.",
+      "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.",
       "steps": [
         "page.name",
         "page.email-address",

data/fixtures/service.json

@@ -1,15 +1,12 @@
 {
   "_id": "service.base",
   "_type": "service.base",
-  "service_name": "Complain about a court or tribunal",
+  "service_name": "Service name",
   "created_by": "4634ec01-5618-45ec-a4e2-bb5aa587e751",
   "configuration": {
     "service": {
       "_id": "config.service",
-      "_type": "config.service",
-      "homepage_url": "https://www.gov.uk",
-      "service_email_address": "moj-online@digital.justice.gov.uk",
-      "service_url": "page.start"
+      "_type": "config.service"
     },
     "meta": {
       "_id": "config.meta",
@@ -40,9 +37,10 @@
     {
       "_id": "page.start",
       "_type": "page.start",
-      "body": "You cannot use this form to complain about:\r\n\r\n* the result of a case\r\n* a judge, magistrate, coroner or member of a tribunal\r\n\r\nThis online form is also available in [Welsh (Cymraeg)](https://complain-about-a-court-or-tribunal.form.service.justice.gov.uk/cy).",
-      "heading": "Complain about a court or tribunal",
-      "lede": "Your complaint will not affect your case.",
+      "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": "/"
     }

data/fixtures/version.json

@@ -2,15 +2,12 @@
   "_id": "service.base",
   "_type": "service.base",
   "service_id": "d243f5c0-e8a2-4b13-982c-7b5f3fa128cf",
-  "service_name": "Main fixture to test Form builder",
+  "service_name": "Service name",
   "created_by": "4634ec01-5618-45ec-a4e2-bb5aa587e751",
   "configuration": {
     "service": {
       "_id": "config.service",
-      "_type": "config.service",
-      "homepage_url": "https://www.gov.uk",
-      "service_email_address": "moj-online@digital.justice.gov.uk",
-      "service_url": "page.start"
+      "_type": "config.service"
     },
     "meta": {
       "_id": "config.meta",
@@ -41,9 +38,10 @@
     {
       "_id": "page.start",
       "_type": "page.start",
-      "body": "You cannot use this form to complain about:\r\n\r\n* the result of a case\r\n* a judge, magistrate, coroner or member of a tribunal\r\n\r\nThis online form is also available in [Welsh (Cymraeg)](https://complain-about-a-court-or-tribunal.form.service.justice.gov.uk/cy).",
-      "heading": "Complain about a court or tribunal",
-      "lede": "Your complaint will not affect your case.",
+      "heading": "Service name goes here",
+      "lede": "This is your start page first paragraph. You can only have one paragraph here.",
+      "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": [
         "page.name",
         "page.email-address",
@@ -124,7 +122,7 @@
     },
     {
       "_id": "page._check-answers",
-      "_type": "page.summary",
+      "_type": "page.checkanswers",
       "body": "Optional content",
       "heading": "Review your answer",
       "lede": "First paragraph",

data/lib/metadata_presenter/test_helpers.rb

@@ -0,0 +1,21 @@
+module MetadataPresenter
+  module TestHelpers
+    def service
+      MetadataPresenter::Service.new(service_metadata)
+    end
+
+    def fixtures_directory
+      @_fixtures_directory ||=
+        Pathname.new(MetadataPresenter::Engine.root.join('fixtures'))
+    end
+
+    def service_metadata
+      metadata_fixture(:version)
+      JSON.parse(File.read(fixtures_directory.join('version.json')))
+    end
+
+    def metadata_fixture(fixture_name)
+      JSON.parse(File.read(fixtures_directory.join("#{fixture_name}.json")))
+    end
+  end
+end

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/schemas/page/{summary.json → checkanswers.json}

@@ -1,12 +1,12 @@
 {
-  "$id": "http://gov.uk/schema/v1.0.0/page/summary",
-  "_name": "page.summary",
+  "$id": "http://gov.uk/schema/v1.0.0/page/checkanswers",
+  "_name": "page.checkanswers",
   "title": "Check answers",
   "description": "Let users check and change their answers before submitting",
   "type": "object",
   "properties": {
     "_type": {
-      "const": "page.summary"
+      "const": "page.checkanswers"
     },
     "section_heading": {
       "title": "Section heading",

data/schemas/page/start.json

@@ -5,9 +5,16 @@
   "description": "Let users start using a service",
   "type": "object",
   "properties": {
+    "_id": {
+      "const": "page.start"
+    },
     "_type": {
       "const": "page.start"
     },
+    "before_you_start": {
+      "title": "Before you start",
+      "description": "A body of text that goes after the Start button"
+    },
     "enable_steps": {
       "const": true
     },
@@ -25,10 +32,14 @@
   "ui_category": {
     "main": [
       "lede",
-      "body"
+      "body",
+      "before_you_start"
     ]
   },
   "required": [
+    "_id",
+    "_type",
+    "heading",
     "steps"
   ]
 }

data/schemas/request/service.json

@@ -0,0 +1,13 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/request/service",
+  "_name": "request.service",
+  "title": "Create new service",
+  "description": "Request object schema for creating and updating a new service",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "$ref": "service.base"
+    }
+  },
+  "required": ["metadata"]
+}

data/schemas/service/base.json

@@ -42,7 +42,6 @@
   "required": [
     "_id",
     "_type",
-    "service_id",
     "service_name",
     "created_by",
     "locale",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -247,18 +247,20 @@ files:
 - app/views/layouts/metadata_presenter/application.html.erb
 - app/views/metadata_presenter/component/_text.html.erb
 - app/views/metadata_presenter/header/show.html.erb
+- app/views/metadata_presenter/page/checkanswers.html.erb
 - app/views/metadata_presenter/page/confirmation.html.erb
 - app/views/metadata_presenter/page/form.html.erb
 - app/views/metadata_presenter/page/singlequestion.html.erb
 - app/views/metadata_presenter/page/start.html.erb
-- app/views/metadata_presenter/page/summary.html.erb
 - config/initializers/default_metadata.rb
 - config/initializers/schemas.rb
 - config/routes.rb
+- default_metadata/component/text.json
 - default_metadata/config/meta.json
 - default_metadata/config/service.json
+- default_metadata/page/checkanswers.json
 - default_metadata/page/confirmation.json
-- default_metadata/page/summary.json
+- default_metadata/page/singlequestion.json
 - default_metadata/service/base.json
 - default_metadata/string/error.max_length.json
 - default_metadata/string/error.min_length.json
@@ -268,6 +270,7 @@ files:
 - fixtures/version.json
 - lib/metadata_presenter.rb
 - lib/metadata_presenter/engine.rb
+- lib/metadata_presenter/test_helpers.rb
 - lib/metadata_presenter/version.rb
 - lib/tasks/metadata_presenter_tasks.rake
 - schemas/condition/condition.json
@@ -305,11 +308,10 @@ files:
 - schemas/definition/width_class.json
 - schemas/errors/errors.json
 - schemas/link/link.json
+- schemas/page/checkanswers.json
 - schemas/page/confirmation.json
 - schemas/page/start.json
-- schemas/page/summary.json
-- schemas/request/services.json
-- schemas/request/versions.json
+- schemas/request/service.json
 - schemas/service/base.json
 - schemas/service/configuration.json
 - schemas/service/locale.json

data/schemas/request/services.json

@@ -1,48 +0,0 @@
-{
-  "$id": "http://gov.uk/schema/v1.0.0/request/services",
-  "_name": "request.services",
-  "title": "Create new service",
-  "description": "Request schema for creating a new service",
-  "type": "object",
-  "properties": {
-    "metadata": {
-      "type": "object",
-      "properties": {
-        "_id": {
-          "const": "service.base"
-        },
-        "_type": {
-          "const": "service.base"
-        },
-        "service_name": {
-          "type": "string"
-        },
-        "created_by": {
-          "type": "string"
-        },
-        "configuration": {
-          "$ref": "configuration"
-        },
-        "locale": {
-          "$ref": "service.locale"
-        },
-        "pages": {
-          "type": "array",
-          "items": {
-            "$ref": "definition.page"
-          }
-        }
-      },
-      "required": [
-        "_id",
-        "_type",
-        "service_name",
-        "created_by",
-        "configuration",
-        "pages"
-      ],
-      "additionalProperties": false
-    }
-  },
-  "required": ["metadata"]
-}

data/schemas/request/versions.json

@@ -1,13 +0,0 @@
-{
-  "$id": "http://gov.uk/schema/v1.0.0/request/versions",
-  "_name": "request.versions",
-  "title": "Create new service version",
-  "description": "Request schema for creating a new version of a service",
-  "type": "object",
-  "properties": {
-    "metadata": {
-      "$ref": "service.base"
-    }
-  },
-  "required": ["metadata"]
-}