metadata_presenter 0.1.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec5c5a811a4ff57b7306a6876ce1db7b8ab8dc38a11db49e5922e05bf7b81308
-  data.tar.gz: f4dda5fe741a8fdd349d053cfa746b82d62798a32cc306a4d2249bf0db514358
+  metadata.gz: da4d7d444ed39c7f2f0815e1c7a6034893106531275dd4de9f97f655e5b6615f
+  data.tar.gz: 3e952b54e9652043c6f56d601a82e6bdc414f0c76a932cd17209be26a0914933
 SHA512:
-  metadata.gz: 0b2546d19e21b30e80d37416cfeb92a3c77ecb4afdcf062dde4bfe8b29be20e9b8e592c2790cd6985b4b4c12a78236f9b6f43a506fcdfa20c646255f3eddaf51
-  data.tar.gz: 40ab623c319681fa1e65d0fb612c19fea09a87cf299b8bc9f7d1ab94a103c3b715c7169efc610c361d041120a8141f2e85cd98cf68b5da77ba029ae8ae6a433c
+  metadata.gz: e0fd8beaea7b9141a1d58b94083b1757efeaee7160df08f347a5a47d1253736c3cdc7912e17fc0da28cd4ce8c0e8ad210c594a2bd4287c39e9ce0f8477977909
+  data.tar.gz: 1e768d8037be04a9e6f94c20a901cd3e29a9196cdcde94addd206ce468d2cc1ceaf19991daf22f02a2e1f42415f9a355e0e9b666f905a7f947c9d0345fa12ce5

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/controllers/metadata_presenter/answers_controller.rb

@@ -1,5 +1,7 @@
 module MetadataPresenter
   class AnswersController < EngineController
+    before_action :check_page_exists
+
     def create
       if page.validate_answers(answers_params)
         save_user_data # method signature
@@ -12,15 +14,16 @@ module MetadataPresenter
     private
 
     def page
-      @page ||= MetadataPresenter::Page.new(
-        service.find_page(params[:page_url]).metadata
-      )
+      @page ||= begin
+        current_page = service.find_page_by_url(page_url)
+        MetadataPresenter::Page.new(current_page.metadata) if current_page
+      end
     end
 
     def redirect_to_next_page
       next_page = NextPage.new(service).find(
         session: session,
-        current_page_url: params[:page_url]
+        current_page_url: page_url
       )
 
       if next_page.present?
@@ -38,5 +41,13 @@ module MetadataPresenter
     def answers_params
       params[:answers] ? params[:answers].permit! : {}
     end
+
+    def page_url
+      request.env['PATH_INFO']
+    end
+
+    def check_page_exists
+      not_found if page.blank?
+    end
   end
 end

data/app/controllers/metadata_presenter/pages_controller.rb

@@ -2,7 +2,7 @@ module MetadataPresenter
   class PagesController < EngineController
     def show
       @user_data = load_user_data # method signature
-      @page ||= service.find_page(request.env['PATH_INFO'])
+      @page ||= service.find_page_by_url(request.env['PATH_INFO'])
 
       if @page
         render template: @page.template

data/app/helpers/metadata_presenter/application_helper.rb

@@ -1,5 +1,23 @@
 module MetadataPresenter
   module ApplicationHelper
+    ## Display user answers on the view
+    ## When the user doesn't answered yet the component will be blank
+    # or with data otherwise, so doing the if in every output is not
+    # pratical.
+    #
+    # The below example search for 'first_name' in the user data instance
+    # variable as long your load_user_data in the controller sets the variable.
+    #
+    # @example
+    #   <%= a('first_name') %>
+    #
+    def a(component_key)
+      if @user_data.present?
+        @user_data[component_key]
+      end
+    end
+    alias answer a
+
     def to_markdown(text)
       (Kramdown::Document.new(text).to_html).html_safe
     end

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

@@ -6,10 +6,18 @@ module MetadataPresenter
       ValidateAnswers.new(page: self, answers: answers).valid?
     end
 
+    def uuid
+      _uuid
+    end
+
     def ==(other)
       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/models/metadata_presenter/service.rb

@@ -7,12 +7,16 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
     pages.first
   end
 
-  def find_page(path)
-    pages.find { |page| page.url == path }
+  def find_page_by_url(url)
+    pages.find { |page| page.url == url }
+  end
+
+  def find_page_by_uuid(uuid)
+    pages.find { |page| page.uuid == uuid }
   end
 
   def next_page(from:)
-    current_page = find_page(from)
+    current_page = find_page_by_url(from)
     pages[pages.index(current_page) + 1] if current_page.present?
   end
 

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: answer(component.name)
 %>

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| %>
@@ -35,7 +35,7 @@
                 </dt>
 
                 <dd class="govuk-summary-list__value">
-                  <%= @user_data[component.name] %>
+                  <%=a component.name %>
                 </dd>
                 <dd class="govuk-summary-list__actions">
                 <%= link_to(
@@ -66,7 +66,7 @@
         </div>
       <% end %>
 
-      <button 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">
+      <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>
     <% end %>

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

@@ -5,13 +5,13 @@
           <%= @page.heading.html_safe %>
       </h1>
 
-      <%= form_for @page, url: reserved_answers_path(@page.url) do |f| %>
+      <%= form_for @page, url: @page.url, method: :post do |f| %>
         <%= f.govuk_error_summary %>
         <% @page.components.each do |component| %>
           <%= 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

@@ -25,14 +25,20 @@
         </p>
       <%- end %>
 
-      <%= form_tag(reserved_answers_path(@page.url), method: :post) do %>
-        <button class='govuk-button govuk-button--start govuk-!-margin-top-2'>
+      <%= form_tag(@page.url, method: :post) do %>
+        <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/config/routes.rb

@@ -1,8 +1,10 @@
 MetadataPresenter::Engine.routes.draw do
   root to: 'service#start'
 
-  post '/reserved/:page_url/answers', to: 'answers#create', as: :reserved_answers
   post '/reserved/submissions', to: 'submissions#create', as: :reserved_submissions
   get '/reserved/change-answer', to: 'change_answer#create', as: :change_answer
+
+  post '/', to: 'answers#create'
+  match '*path', to: 'answers#create', via: :post
   match '*path', to: 'pages#show', via: :all
 end

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/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/page/start.json

@@ -0,0 +1,10 @@
+{
+  "_id": "page.start",
+  "_type": "page.start",
+  "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/default_metadata/service/base.json

@@ -3,16 +3,6 @@
   "_type": "service.base",
   "service_name": "Service name",
   "configuration": {},
-  "pages": [
-    {
-      "_id": "page.start",
-      "_type": "page.start",
-      "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": [],
-      "url": "/"
-    }
-  ],
+  "pages": [],
   "locale": "en"
 }

data/fixtures/service.json

@@ -35,11 +35,13 @@
   },
   "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": "/"
     }

data/fixtures/version.json

@@ -36,11 +36,13 @@
   },
   "pages": [
     {
+      "_uuid": "fa391697-ae82-4416-adc3-3433e54ce535",
       "_id": "page.start",
       "_type": "page.start",
       "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",
@@ -51,6 +53,7 @@
       "url": "/"
     },
     {
+      "_uuid": "847c4a0c-1c5f-4391-8847-42c8d82f1d0b",
       "_id": "page.name",
       "_type": "page.singlequestion",
       "components": [
@@ -70,6 +73,7 @@
       "url": "/name"
     },
     {
+      "_uuid": "ccf49acb-ad33-4fd3-8a7e-f0594b86cc96",
       "_id": "page.email-address",
       "_type": "page.singlequestion",
       "heading": "Email address",
@@ -101,6 +105,7 @@
       "url": "/email-address"
     },
     {
+      "_uuid": "7b748584-100e-4d81-a54a-5049190136cc",
       "_id": "page.parent_name",
       "_type": "page.singlequestion",
       "components": [
@@ -120,8 +125,9 @@
       "url": "/parent-name"
     },
     {
+      "_uuid": "e819d0c2-7062-4997-89cf-44d26d098404",
       "_id": "page._check-answers",
-      "_type": "page.summary",
+      "_type": "page.checkanswers",
       "body": "Optional content",
       "heading": "Review your answer",
       "lede": "First paragraph",
@@ -131,6 +137,7 @@
       "url": "/check-answers"
     },
     {
+      "_uuid": "b238a22f-c180-48d0-a7d9-8aad2036f1f2",
       "_id": "page._confirmation",
       "_type": "page.confirmation",
       "body": "You'll receive a confirmation email",

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.6'
+  VERSION = '0.3.1'
 end

data/schemas/definition/page.json

@@ -4,6 +4,10 @@
   "id_seed": "url",
   "title": "Page definition",
   "properties": {
+    "_uuid": {
+      "title": "Unique identifier of the page",
+      "description": "Used internally in the editor and the runner."
+    },
     "url": {
       "title": "URL",
       "description": "The page’s relative url - it must not contain any spaces",
@@ -95,6 +99,7 @@
     }
   ],
   "required": [
+    "_uuid",
     "url"
   ],
   "category": [

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"
   ]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.3.1
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -247,18 +247,21 @@ 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/page/start.json
 - default_metadata/service/base.json
 - default_metadata/string/error.max_length.json
 - default_metadata/string/error.min_length.json
@@ -268,6 +271,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,9 +309,9 @@ 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/service.json
 - schemas/service/base.json
 - schemas/service/configuration.json