metadata_presenter 0.10.0 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ef68ecaae97370722eab970f6dd1ce2490c35f762af5bb2ff7addbe51fded02
-  data.tar.gz: 5a56f15853ed9becc11b70d0d0e1532ead81a098de1f7fbe3a1f1103a60c9a5d
+  metadata.gz: 25eab7ae4724a7b0efc235808753ec4d66b966c6d9d36aefea3938839d6a18fb
+  data.tar.gz: 548f0e1c5784f72a48f29ff2555f2ed41e77deb704037f33d6ab9042b08de25a
 SHA512:
-  metadata.gz: bccc48c9113831eed3a67fbb8aeb19ebc6f624b1526feb113578f67f4a1d6ab8989ff01f2d9f44176f03e80782fe8313f389979b042d749217b6c2d683dd8557
-  data.tar.gz: 7d8aabc2e90780a6d01ae263abfc6b93e6dd9b888f3b7c5339b16305e3008feb16f0c4aee41d91429dd8e1e24384fea93c44827e44a093db7b6aff8554b97f18
+  metadata.gz: 1d33a47191c80f198c2c2318ae690b469398459d37e329667c5f81b0f857ecfa277f5f8ac797e18e2df94951dd43be551b63f9037137566e30b996e18bd1c15c
+  data.tar.gz: c9cdc90d35ce14f61f7afb9102fe39119dd84abdd4189a9f076aab5bf6bb861f4cc91bc841000718ae6184363d48a721b0fc3fe7b603baa4be46e99c8ccb9c26

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

@@ -3,7 +3,7 @@ module MetadataPresenter
     def main_h1(component)
       if component.legend.present?
         content_tag(:legend, class: 'govuk-fieldset__legend govuk-fieldset__legend--l') do
-          content_tag(:h1, class: 'govuk-fieldset__heading') do
+          content_tag(:h1, class: 'govuk-heading-xl') do
             component.legend
           end
         end
@@ -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/component.rb

@@ -2,4 +2,18 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
   def to_partial_path
     "metadata_presenter/component/#{type}"
   end
+
+  def humanised_title
+    self.label || self.legend
+  end
+
+  def items
+    metadata.items.map do |item|
+      OpenStruct.new(
+        id: item['label'],
+        name: item['label'],
+        description: item['hint']
+      )
+    end
+  end
 end

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,57 @@
+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 self.class.private_method_defined?(component.type.to_sym)
+        send(component.type.to_sym, value)
+      else
+        value
+      end
+    end
+
+    private
+
+    def date(value)
+      I18n.l(
+        Date.civil(value.year.to_i, value.month.to_i, value.day.to_i),
+        format: '%d %B %Y'
+      )
+    end
+
+    def textarea(value)
+      view.simple_format(value, {}, wrapper_tag: 'span')
+    end
+
+    def checkboxes(value)
+      value.reject(&:blank?).join("<br>").html_safe
+    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
@@ -63,7 +63,12 @@ module MetadataPresenter
     # @return [String] user answer for the specific component
     #
     def user_answer
-      page_answers.send(component.name)
+      value = page_answers.send(component.name)
+      if component.type == 'checkboxes'
+        Array(value).reject(&:blank?)
+      else
+        value
+      end
     end
 
     # The default error message will be look using the schema key.
@@ -115,7 +120,7 @@ module MetadataPresenter
     #
     def error_message_hash
       {
-        control: component.label,
+        control: component.humanised_title,
         schema_key.to_sym => component.validation[schema_key]
       }
     end
@@ -127,7 +132,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/_checkboxes.html.erb

@@ -0,0 +1,9 @@
+<%=
+  f.govuk_collection_check_boxes component.id.to_sym,
+    component.items,
+    :id,
+    :name,
+    :description,
+    legend: { text: input_title },
+    hint: { text: component.hint }
+%>

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/component/_radios.html.erb

@@ -0,0 +1,9 @@
+<%=
+  f.govuk_collection_radio_buttons component.id.to_sym,
+    component.items,
+    :id,
+    :name,
+    :description,
+    legend: { text: input_title },
+    hint: { text: component.hint }
+%>

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.label %>
-                </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/checkboxes.json

@@ -0,0 +1,24 @@
+{
+  "_id": "component.checkboxes",
+  "_type": "checkboxes",
+  "errors": {},
+  "hint": "[Hint text (optional)]",
+  "items": [
+    {
+      "_id": "component_checkbox_1",
+      "_type": "checkbox",
+      "label": "Option",
+      "hint": "[Hint text (optional)]",
+      "value": "value-1"
+    },
+    {
+      "_id": "component_checkbox_2",
+      "_type": "checkbox",
+      "label": "Option",
+      "hint": "[Hint text (optional)]",
+      "value": "value-2"
+    }
+  ],
+  "name": "component-name",
+  "legend": "Question"
+}

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/component/radios.json

@@ -2,9 +2,23 @@
   "_id": "component.radios",
   "_type": "radios",
   "errors": {},
-  "hint": "Component hint",
-  "label": "Component label",
-  "items": [],
+  "hint": "[Hint text (optional)]",
+  "items": [
+    {
+      "_id": "component_radio_1",
+      "_type": "radio",
+      "label": "Option",
+      "hint": "[Hint text (optional)]",
+      "value": "value-1"
+    },
+    {
+      "_id": "component_radio_2",
+      "_type": "radio",
+      "label": "Option",
+      "hint": "[Hint text (optional)]",
+      "value": "value-2"
+    }
+  ],
   "name": "component-name",
-  "legend": "Required legend"
+  "legend": "Question"
 }

data/default_metadata/definition/checkbox.json

@@ -0,0 +1,7 @@
+{
+	"_id": "definition.checkbox",
+	"_type": "checkbox",
+	"label": "Option",
+	"hint": "[Hint text (optional)]",
+	"value": "checkbox-value"
+}

data/default_metadata/definition/radio.json

@@ -1,6 +1,7 @@
 {
   "_id": "definition.radio",
   "_type": "radio",
-  "label": "Required label",
+  "label": "Option",
+  "hint": "[Hint text (optional)]",
   "value": "radio-value"
 }

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

@@ -165,6 +165,107 @@
       "heading": "Family Hobbies",
       "url": "/family-hobbies"
     },
+    {
+      "_uuid": "4251b25e-08de-4dcb-8f2f-dd9848dcdca6",
+      "_id": "page.do-you-like-star-wars",
+      "_type": "page.singlequestion",
+      "components": [
+        {
+          "_id": "do-you-like-star-wars_radios_1",
+          "_type": "radios",
+          "errors": {},
+          "hint": "Component hint",
+          "legend": "Do you like Star Wars?",
+          "items": [
+            {
+              "_id": "do-you-like-star-wars_radio_1",
+              "_type": "radio",
+              "label": "Only on weekends",
+              "hint": "Optional item hint",
+              "value": "only-on-weekends"
+            },
+            {
+              "_id": "do-you-like-star-wars_radio_2",
+              "_type": "radio",
+              "label": "Hell no!",
+              "hint": "Optional item hint",
+              "value": "hell-no"
+            }
+          ],
+          "name": "do-you-like-star-wars_radios_1",
+          "validation": {
+            "required": true
+          }
+        }
+      ],
+      "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": "7b748584-100e-4d81-a54a-5049190136cc",
+      "_id": "page.burgers",
+      "_type": "page.singlequestion",
+      "components": [
+        {
+          "_id": "burgers_checkboxes_1",
+          "_type": "checkboxes",
+          "errors": {},
+          "hint": "Select all that apply",
+          "legend": "What would you like on your burger?",
+          "items": [
+            {
+              "_id": "burgers_checkbox_1",
+              "_type": "checkbox",
+              "label": "Beef, cheese, tomato",
+              "hint": "Optional item hint",
+              "value": "beef-cheese-tomato"
+            },
+            {
+              "_id": "burgers_checkbox_2",
+              "_type": "checkbox",
+              "label": "Chicken, cheese, tomato",
+              "hint": "Optional item hint",
+              "value": "chicken-cheese-tomato"
+            },
+            {
+              "_id": "burgers_checkbox_3",
+              "_type": "checkbox",
+              "label": "Mozzarella, cheddar, feta",
+              "hint": "Optional item hint",
+              "value": "mozzarella-cheddar-feta"
+            }
+          ],
+          "name": "burgers_checkboxes_1",
+          "validation": {
+            "required": true
+          }
+        }
+      ],
+      "heading": "Checkboxes",
+      "url": "/burgers"
+    },
     {
       "_uuid": "e819d0c2-7062-4997-89cf-44d26d098404",
       "_id": "page._check-answers",

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '0.10.0'
+  VERSION = '0.13.2'
 end

data/schemas/component/checkboxes.json

@@ -0,0 +1,33 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/checkboxes",
+  "_name": "component.checkboxes",
+  "title": "Checkboxes",
+  "description": "Let users select one or more options from a list",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "checkboxes"
+    },
+    "items": {
+      "title": "Options",
+      "description": "Items that users can select",
+      "type": "array",
+      "items": {
+        "$ref": "definition.checkbox"
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.fieldset"
+    }
+  ],
+  "transforms": {
+    "namespace": {
+      "propagation": "items[?(@._type === 'checkbox')]"
+    }
+  },
+  "required": [
+    "items"
+  ]
+}

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/definition/checkbox.json

@@ -0,0 +1,46 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/checkbox",
+  "_name": "definition.checkbox",
+  "title": "Checkbox item",
+  "description": "Component that provides a checkbox item",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "checkbox"
+    },
+    "value": {
+      "default": "yes"
+    },
+    "label": {
+      "skipOptional": true
+    },
+    "hint": {
+      "title": "Hint text",
+      "description": "Text to help users understand an option - appears in grey under the label",
+      "type": "string",
+      "content": true
+    },
+    "conditional_component": {
+      "$ref": "definition.conditionalcomponent"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.namespace"
+    },
+    {
+      "$ref": "definition.option"
+    },
+    {
+      "$ref": "definition.name"
+    }
+  ],
+  "required": [
+    "label"
+  ],
+  "transforms": {
+    "namespace": {
+      "propagation": "conditional_component"
+    }
+  }
+}

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.10.0
+  version: 0.13.2
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-02-16 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,7 +250,10 @@ 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/_checkboxes.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
 - app/views/metadata_presenter/component/_textarea.html.erb
 - app/views/metadata_presenter/header/show.html.erb
@@ -259,18 +265,22 @@ files:
 - config/initializers/default_metadata.rb
 - config/initializers/schemas.rb
 - config/routes.rb
+- default_metadata/component/checkboxes.json
+- default_metadata/component/date.json
 - default_metadata/component/number.json
 - default_metadata/component/radios.json
 - default_metadata/component/text.json
 - default_metadata/component/textarea.json
 - default_metadata/config/meta.json
 - default_metadata/config/service.json
+- default_metadata/definition/checkbox.json
 - default_metadata/definition/radio.json
 - 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.date.json
 - default_metadata/string/error.max_length.json
 - default_metadata/string/error.min_length.json
 - default_metadata/string/error.number.json
@@ -283,6 +293,8 @@ files:
 - lib/metadata_presenter/test_helpers.rb
 - lib/metadata_presenter/version.rb
 - lib/tasks/metadata_presenter_tasks.rake
+- schemas/component/checkboxes.json
+- schemas/component/date.json
 - schemas/component/number.json
 - schemas/component/radios.json
 - schemas/component/text.json
@@ -291,6 +303,7 @@ files:
 - schemas/config/meta.json
 - schemas/config/service.json
 - schemas/definition/block.json
+- schemas/definition/checkbox.json
 - schemas/definition/component.json
 - schemas/definition/components.json
 - schemas/definition/condition.base.json