metadata_presenter 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f28074c7149c34365903ebb2d3f63f679fe15a9365d9d8d52212bf46781506ae
-  data.tar.gz: b5c02391b3978aaadc551076f9b0823c6e73f585d7e401ac5980d976d6e568f2
+  metadata.gz: ea5f406433591e375a3c137f9f12df05ee0b0679cba535293d71e4629773d49b
+  data.tar.gz: 65311d8db37019816d041808cb1bf8ae409b5811052d50c05a6e7651ba1cea6b
 SHA512:
-  metadata.gz: 2b94a8004d81073a597b09b27844d16d5833a8b68a458423afb330fe1fd880d3a4feea508d7f5ec00e290ce75b7f73e8dc3b5094b5276f75c8477241068ba14a
-  data.tar.gz: fb7392086d34f13606a4def4b0347190ec45a90fd2f3ec66271b1ef517a2923496e0ce131323ef8b6084491a93d570282204b33a4bf21d4515c0c1185d05fa3e
+  metadata.gz: 0b302de50d21f93d1d87f253a6d843b2037138988567911d1d78293d44489d8f3a800b60f3a0ca325a10fac43ac23a5eea7fcddaf4213035409fdf8fd70fd96c
+  data.tar.gz: 13e2a9c6aa54657ddfa4ebda15a4defc981ee880581ca55cece8f24996823b4f120db58d1cffa3744df3f650302493e79a816366d9fb3e3cd935433b605a5311

data/app/controllers/metadata_presenter/pages_controller.rb

@@ -11,5 +11,14 @@ module MetadataPresenter
         not_found
       end
     end
+
+    def page_answers_presenters
+      PageAnswersPresenter.map(
+        view: view_context,
+        pages: service.pages,
+        answers: @user_data
+      )
+    end
+    helper_method :page_answers_presenters
   end
 end

data/app/helpers/metadata_presenter/application_helper.rb

@@ -14,32 +14,6 @@ module MetadataPresenter
       end
     end
 
-    ## 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
-
-    ## Display user answers on the view formatted.
-    ##
-    def formatted_answer(component_key)
-      user_answer = answer(component_key)
-
-      simple_format(user_answer) if user_answer.present?
-    end
-
     # Renders markdown given a text.
     #
     # @example

data/app/models/metadata_presenter/date_field.rb

@@ -0,0 +1,19 @@
+module MetadataPresenter
+  class DateField
+    attr_reader :day, :month, :year
+
+    def initialize(day:, month:, year:)
+      @day = day
+      @month = month
+      @year = year
+    end
+
+    def present?
+      !blank?
+    end
+
+    def blank?
+      @day.blank? || @month.blank? || @year.blank?
+    end
+  end
+end

data/app/models/metadata_presenter/page_answers.rb

@@ -17,11 +17,33 @@ module MetadataPresenter
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      answers[method_name.to_s].present?
+      method_name.to_s.in?(components.map(&:id))
     end
 
     def method_missing(method_name, *args, &block)
-      answers[method_name.to_s]
+      component = components.find { |component| component.id == method_name.to_s }
+
+      if component && component.type == 'date'
+        date_answer(component.id)
+      else
+        answers[method_name.to_s]
+      end
+    end
+
+    def date_answer(component_id)
+      date = raw_date_answer(component_id)
+
+      MetadataPresenter::DateField.new(day: date[0], month: date[1], year: date[2])
+    end
+
+    def raw_date_answer(component_id)
+      [
+        GOVUKDesignSystemFormBuilder::Elements::Date::SEGMENTS[:day],
+        GOVUKDesignSystemFormBuilder::Elements::Date::SEGMENTS[:month],
+        GOVUKDesignSystemFormBuilder::Elements::Date::SEGMENTS[:year]
+      ].map do |segment|
+        answers["#{component_id.to_s}(#{segment})"]
+      end
     end
 
     private

data/app/presenters/metadata_presenter/page_answers_presenter.rb

@@ -0,0 +1,46 @@
+module MetadataPresenter
+  class PageAnswersPresenter
+    def self.map(view:, pages:, answers:)
+      pages.map do |page|
+        Array(page.components).map do |component|
+          new(
+            view: view,
+            component: component,
+            page: page,
+            answers: answers
+          )
+        end
+      end.flatten
+    end
+
+    attr_reader :view, :component, :page, :answers
+    delegate :url, to: :page
+    delegate :humanised_title, to: :component
+
+    def initialize(view:, component:, page:, answers:)
+      @view = view
+      @component = component
+      @page = page
+      @answers = answers
+
+      @page_answers = PageAnswers.new(page, answers)
+    end
+
+    def answer
+      value = @page_answers.send(component.id)
+
+      return '' if value.blank?
+
+      if component.type == 'date'
+        I18n.l(
+          Date.civil(value.year.to_i, value.month.to_i, value.day.to_i),
+          format: '%d %B %Y'
+        )
+      elsif component.type == 'textarea'
+        view.simple_format(value)
+      else
+        value
+      end
+    end
+  end
+end

data/app/validators/metadata_presenter/base_validator.rb

@@ -38,7 +38,7 @@ module MetadataPresenter
     end
 
     def valid?
-      return true if user_answer.blank? && allow_blank?
+      return true if allow_blank?
 
       if invalid_answer?
         error_message = custom_error_message || default_error_message
@@ -127,7 +127,7 @@ module MetadataPresenter
     # @return [TrueClass]
     #
     def allow_blank?
-      true unless self.class.name.demodulize.include?('RequiredValidator')
+      user_answer.blank? && !self.class.name.demodulize.include?('RequiredValidator')
     end
   end
 end

data/app/validators/metadata_presenter/date_validator.rb

@@ -0,0 +1,14 @@
+module MetadataPresenter
+  class DateValidator < BaseValidator
+    def invalid_answer?
+      Date.strptime(
+        "#{user_answer.year}-#{user_answer.month}-#{user_answer.day}",
+        '%Y-%m-%d'
+      )
+
+      false
+    rescue Date::Error
+      true
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<%=
+  f.govuk_date_field component.id.to_sym,
+    hint: { text: component.hint },
+    legend: { text: input_title }
+%>

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

@@ -27,27 +27,25 @@
     <%= 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">
-          <% @service.pages.each do |page| %>
-            <% Array(page.components).each do |component| %>
-              <div class="govuk-summary-list__row">
-                <dt class="govuk-summary-list__key">
-                  <%= component.humanised_title %>
-                </dt>
+          <% page_answers_presenters.each do |page_answers_presenter| %>
+            <div class="govuk-summary-list__row">
+              <dt class="govuk-summary-list__key">
+                <%= page_answers_presenter.humanised_title %>
+              </dt>
 
-                <dd class="govuk-summary-list__value">
-                  <%= formatted_answer(component.name) %>
-                </dd>
-                <dd class="govuk-summary-list__actions">
-                <%= link_to(
-                      change_answer_path(url: page.url),
-                      class: 'govuk-link'
-                    ) do %>
-                       Change<span class="govuk-visually-hidden"> Your answer for <%= component.label %></span>
-                  <% end %>
-                  </a>
-                </dd>
-              </div>
-            <% end %>
+              <dd class="govuk-summary-list__value">
+                <%= page_answers_presenter.answer %>
+              </dd>
+              <dd class="govuk-summary-list__actions">
+              <%= link_to(
+                    change_answer_path(url: page_answers_presenter.url),
+                    class: 'govuk-link'
+                  ) do %>
+                     Change<span class="govuk-visually-hidden"> Your answer for <%= page_answers_presenter.humanised_title %></span>
+                <% end %>
+                </a>
+              </dd>
+            </div>
           <% end %>
         </dl>
       </div>

data/default_metadata/component/date.json

@@ -0,0 +1,12 @@
+{
+  "_id": "component.date",
+  "_type": "date",
+  "errors": {},
+  "hint": "Component hint",
+  "legend": "Component legend",
+  "name": "component-name",
+  "date_type": "day-month-year",
+  "validation": {
+    "date": true
+  }
+}

data/default_metadata/string/error.date.json

@@ -0,0 +1,6 @@
+{
+  "_id": "error.date",
+  "_type": "string.error",
+  "description": "Input (date) is not a valid date",
+  "value": "Enter a valid date for %{control}"
+}

data/fixtures/version.json

@@ -201,6 +201,28 @@
       "heading": "Radio buttons",
       "url": "/do-you-like-star-wars"
     },
+    {
+      "_id": "page.holiday",
+      "url": "holiday",
+      "_type":"page.singlequestion",
+      "_uuid":"ff4557b2-486b-481e-9eef-f315718639e8",
+      "heading":"Question",
+      "components": [
+        {
+          "_id": "holiday_date_1",
+          "hint": "Component hint",
+          "name": "holiday_date_1",
+          "_type": "date",
+          "legend": "What is the day that you like to take holidays?",
+          "errors": {},
+          "date_type": "day-month-year",
+          "validation": {
+            "date": true,
+            "required": true
+          }
+        }
+      ]
+    },
     {
       "_uuid": "e819d0c2-7062-4997-89cf-44d26d098404",
       "_id": "page._check-answers",

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/schemas/component/date.json

@@ -0,0 +1,48 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/date",
+  "_name": "component.date",
+  "title": "Date",
+  "description": "Let users enter an exact date",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "date"
+    },
+    "name": {
+      "inputType": "date"
+    },
+    "date_type": {
+      "title": "Date type",
+      "description": "The format for entering dates",
+      "type": "string",
+      "enum": [
+        "day-month-year",
+        "month-year",
+        "day-month",
+        "year"
+      ],
+      "default": "day-month-year"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.fieldset"
+    },
+    {
+      "$ref": "validations#/definitions/date_bundle"
+    }
+  ],
+  "composite": [
+    "day",
+    "month",
+    "year"
+  ],
+  "definitions": {
+    "date_type_enum": {
+      "day-month-year": "Day / Month / Year",
+      "month-year": "Month / Year",
+      "year": "Year",
+      "day-month": "Day / Month"
+    }
+  }
+}

data/schemas/validations/validations.json

@@ -25,6 +25,15 @@
       ],
       "default": true
     },
+    "date": {
+      "title": "Date",
+      "description": "Whether the user must answer with a valid date",
+      "oneOf": [
+        {
+          "$ref": "definition.conditional.boolean"
+        }
+      ]
+    },
     "errors_required": {
       "title": "Error messages for ‘Required’",
       "allOf": [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -233,12 +233,15 @@ files:
 - app/helpers/metadata_presenter/application_helper.rb
 - app/jobs/metadata_presenter/application_job.rb
 - app/models/metadata_presenter/component.rb
+- app/models/metadata_presenter/date_field.rb
 - app/models/metadata_presenter/metadata.rb
 - app/models/metadata_presenter/next_page.rb
 - app/models/metadata_presenter/page.rb
 - app/models/metadata_presenter/page_answers.rb
 - app/models/metadata_presenter/service.rb
+- app/presenters/metadata_presenter/page_answers_presenter.rb
 - app/validators/metadata_presenter/base_validator.rb
+- app/validators/metadata_presenter/date_validator.rb
 - app/validators/metadata_presenter/max_length_validator.rb
 - app/validators/metadata_presenter/min_length_validator.rb
 - app/validators/metadata_presenter/number_validator.rb
@@ -247,6 +250,7 @@ files:
 - app/validators/metadata_presenter/validate_schema.rb
 - app/views/errors/404.html
 - app/views/layouts/metadata_presenter/application.html.erb
+- app/views/metadata_presenter/component/_date.html.erb
 - app/views/metadata_presenter/component/_number.html.erb
 - app/views/metadata_presenter/component/_radios.html.erb
 - app/views/metadata_presenter/component/_text.html.erb
@@ -260,6 +264,7 @@ files:
 - config/initializers/default_metadata.rb
 - config/initializers/schemas.rb
 - config/routes.rb
+- default_metadata/component/date.json
 - default_metadata/component/number.json
 - default_metadata/component/radios.json
 - default_metadata/component/text.json
@@ -272,6 +277,7 @@ files:
 - default_metadata/page/singlequestion.json
 - default_metadata/page/start.json
 - default_metadata/service/base.json
+- default_metadata/string/error.date.json
 - default_metadata/string/error.max_length.json
 - default_metadata/string/error.min_length.json
 - default_metadata/string/error.number.json
@@ -284,6 +290,7 @@ files:
 - lib/metadata_presenter/test_helpers.rb
 - lib/metadata_presenter/version.rb
 - lib/tasks/metadata_presenter_tasks.rake
+- schemas/component/date.json
 - schemas/component/number.json
 - schemas/component/radios.json
 - schemas/component/text.json