metadata_presenter 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4502db8905d70f018c8229e2fffb8f1c392415ee4ee8214bfc9bde851e563c8e
-  data.tar.gz: ddaacc9a8520bdb2df646150e3f10001d06c9865a0008e68b8e117320b8e0d85
+  metadata.gz: f2da2dc7dc8a336839fc104af384535691bf1c4f1c1426152f53b943f2497a33
+  data.tar.gz: d8d1c7f55e4f5e116c16df0deaedbdf19a6b349bec430e2c2a30cc011bed7fe3
 SHA512:
-  metadata.gz: f21f6779bf1c90b4a09a7042f2117b5b2712fc72d2eb331226bd6142452abf2a6eac9f1c3b221c12bef9c2d46584f6f514b4918ba3f90381ffaf6d6daebbf9a4
-  data.tar.gz: dd6bcd473cdd65ace450ec00e1c4431d7844bf99201471e330752254b2eb2193cf15ad2ed0936a31c5483b97a3b7c4e4924c0b63d1d4a6aea21a5905279d530c
+  metadata.gz: d13092db05639eb3086e3bae5b56fc83204b932ddb0aa448f38ffdda0e28be743b7e2812a25c41f9a7aec8d3ea8f51b5ea20866458282d4f8c3cbf4c8f95d6ab
+  data.tar.gz: '06796c8b4edc4e017a76b0e7cdaeafdf612638f89729211a4ed880b59bbf5c66880785a4da018285d951de7cdf5bed7169081999d77ed7ac78b7b567104bf2f4'

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,7 +1,31 @@
 module MetadataPresenter
   module ApplicationHelper
-    def to_markdown(text)
+    ## 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
+
+    # Renders markdown given a text.
+    #
+    # @example
+    #   <%=m '# Some markdown' %>
+    #
+    def m(text)
       (Kramdown::Document.new(text).to_html).html_safe
     end
+    alias to_markdown m
   end
 end

data/app/models/metadata_presenter/metadata.rb

@@ -8,6 +8,10 @@ class MetadataPresenter::Metadata
     @metadata = OpenStruct.new(metadata)
   end
 
+  def to_json
+    self.to_h.to_json
+  end
+
   def id
     metadata._id
   end

data/app/models/metadata_presenter/page.rb

@@ -6,6 +6,10 @@ 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

data/app/models/metadata_presenter/service.rb

@@ -7,12 +7,20 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
     pages.first
   end
 
-  def find_page(path)
-    pages.find { |page| page.url == path }
+  def service_slug
+    service_name.parameterize
+  end
+
+  def find_page_by_url(url)
+    pages.find { |page| strip_slash(page.url) == strip_slash(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
 
@@ -25,4 +33,12 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
       page.type == 'page.confirmation'
     end
   end
+
+  private
+
+  def strip_slash(url)
+    return url if url == '/'
+
+    url.gsub(/^\//, '')
+  end
 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 ? @user_data[component.name] : nil
+    value: answer(component.name)
 %>

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

@@ -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,7 +5,7 @@
           <%= @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 } %>

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

@@ -25,7 +25,7 @@
         </p>
       <%- end %>
 
-      <%= form_tag(reserved_answers_path(@page.url), method: :post) do %>
+      <%= 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">

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/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,17 +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.",
-      "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": "/"
-    }
-  ],
+  "pages": [],
   "locale": "en"
 }

data/fixtures/service.json

@@ -35,6 +35,7 @@
   },
   "pages": [
     {
+      "_uuid": "9626b2e9-5ef0-4070-8331-ac55151b22c4",
       "_id": "page.start",
       "_type": "page.start",
       "heading": "Service name goes here",

data/fixtures/version.json

@@ -36,6 +36,7 @@
   },
   "pages": [
     {
+      "_uuid": "fa391697-ae82-4416-adc3-3433e54ce535",
       "_id": "page.start",
       "_type": "page.start",
       "heading": "Service name goes here",
@@ -52,6 +53,7 @@
       "url": "/"
     },
     {
+      "_uuid": "847c4a0c-1c5f-4391-8847-42c8d82f1d0b",
       "_id": "page.name",
       "_type": "page.singlequestion",
       "components": [
@@ -71,6 +73,7 @@
       "url": "/name"
     },
     {
+      "_uuid": "ccf49acb-ad33-4fd3-8a7e-f0594b86cc96",
       "_id": "page.email-address",
       "_type": "page.singlequestion",
       "heading": "Email address",
@@ -102,6 +105,7 @@
       "url": "/email-address"
     },
     {
+      "_uuid": "7b748584-100e-4d81-a54a-5049190136cc",
       "_id": "page.parent_name",
       "_type": "page.singlequestion",
       "components": [
@@ -121,6 +125,7 @@
       "url": "/parent-name"
     },
     {
+      "_uuid": "e819d0c2-7062-4997-89cf-44d26d098404",
       "_id": "page._check-answers",
       "_type": "page.checkanswers",
       "body": "Optional content",
@@ -132,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/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '0.2.0'
+  VERSION = '0.5.0'
 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": [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -261,6 +261,7 @@ files:
 - default_metadata/page/checkanswers.json
 - default_metadata/page/confirmation.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