metadata_presenter 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 066133455b4cf94730e5bebe20ac439262cacd2128e3004d988035e822efc818
-  data.tar.gz: c4513e4dc197c1730ba538b2fc50f1c5302ad70c5a31d3377cb0a23f581fae33
+  metadata.gz: f28074c7149c34365903ebb2d3f63f679fe15a9365d9d8d52212bf46781506ae
+  data.tar.gz: b5c02391b3978aaadc551076f9b0823c6e73f585d7e401ac5980d976d6e568f2
 SHA512:
-  metadata.gz: 6a83357fac7381b7191f9c46edf93f4090be55e40491e06427f108430e5ee4069cc5d797da46d32f289d7785e05a02ae2808059eb7bf470b113bdbf56caf4b91
-  data.tar.gz: 31760a4dcedb66f45ac8be4bb93882d8278d58fcccf686f734dbf3dc0a762c09608cd54bf20718220ae2b8d0c7e3b47bd546a3f2edb9bf53aa30fe9e19703ca3
+  metadata.gz: 2b94a8004d81073a597b09b27844d16d5833a8b68a458423afb330fe1fd880d3a4feea508d7f5ec00e290ce75b7f73e8dc3b5094b5276f75c8477241068ba14a
+  data.tar.gz: fb7392086d34f13606a4def4b0347190ec45a90fd2f3ec66271b1ef517a2923496e0ce131323ef8b6084491a93d570282204b33a4bf21d4515c0c1185d05fa3e

data/app/controllers/metadata_presenter/answers_controller.rb

@@ -3,7 +3,9 @@ module MetadataPresenter
     before_action :check_page_exists
 
     def create
-      if page.validate_answers(answers_params)
+      @page_answers = PageAnswers.new(page, answers_params)
+
+      if @page_answers.validate_answers
         save_user_data # method signature
         redirect_to_next_page
       else

data/app/controllers/metadata_presenter/pages_controller.rb

@@ -5,6 +5,7 @@ module MetadataPresenter
       @page ||= service.find_page_by_url(request.env['PATH_INFO'])
 
       if @page
+        @page_answers = PageAnswers.new(@page, @user_data)
         render template: @page.template
       else
         not_found

data/app/helpers/metadata_presenter/application_helper.rb

@@ -1,5 +1,19 @@
 module MetadataPresenter
   module ApplicationHelper
+    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-heading-xl') do
+            component.legend
+          end
+        end
+      else
+        content_tag(:h1, class: 'govuk-heading-xl') do
+          component.label
+        end
+      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

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/metadata.rb

@@ -24,7 +24,7 @@ class MetadataPresenter::Metadata
     metadata.respond_to?(method_name)
   end
 
-  def method_missing(method, *args, &block)
-    metadata.send(method, *args, &block)
+  def method_missing(method_name, *args, &block)
+    metadata.send(method_name, *args, &block)
   end
 end

data/app/models/metadata_presenter/page.rb

@@ -2,10 +2,6 @@ module MetadataPresenter
   class Page < MetadataPresenter::Metadata
     include ActiveModel::Validations
 
-    def validate_answers(answers)
-      ValidateAnswers.new(page: self, answers: answers).valid?
-    end
-
     def uuid
       _uuid
     end

data/app/models/metadata_presenter/page_answers.rb

@@ -0,0 +1,31 @@
+module MetadataPresenter
+  class PageAnswers
+    include ActiveModel::Model
+    include ActiveModel::Validations
+
+    def initialize(page, answers)
+      @page = page
+      @answers = answers
+    end
+
+    def validate_answers
+      ValidateAnswers.new(self, components: components).valid?
+    end
+
+    def components
+      page.components
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      answers[method_name.to_s].present?
+    end
+
+    def method_missing(method_name, *args, &block)
+      answers[method_name.to_s]
+    end
+
+    private
+
+    attr_reader :page, :answers
+  end
+end

data/app/validators/metadata_presenter/base_validator.rb

@@ -26,28 +26,26 @@ module MetadataPresenter
   #   end
   #
   class BaseValidator
-    # @return [MetadataPresenter::Page] page object from the metadata
-    attr_reader :page
-
-    # @return [Hash] the user answers
-    attr_reader :answers
+    # @return [MetadataPresenter::PageAnswers] page answers object
+    attr_reader :page_answers
 
     # @return [MetadataPresenter::Component] component object from the metadata
     attr_reader :component
 
-    def initialize(page:, answers:, component:)
-      @page = page
-      @answers = answers
+    def initialize(page_answers:, component:)
+      @page_answers = page_answers
       @component = component
     end
 
     def valid?
+      return true if user_answer.blank? && allow_blank?
+
       if invalid_answer?
         error_message = custom_error_message || default_error_message
-        page.errors.add(component.id, error_message)
+        page_answers.errors.add(component.id, error_message)
       end
 
-      page.errors.blank?
+      page_answers.errors.blank?
     end
 
     # The custom message will be lookup from the schema key on the metadata.
@@ -65,7 +63,7 @@ module MetadataPresenter
     # @return [String] user answer for the specific component
     #
     def user_answer
-      answers[component.name]
+      page_answers.send(component.name)
     end
 
     # The default error message will be look using the schema key.
@@ -117,9 +115,19 @@ module MetadataPresenter
     #
     def error_message_hash
       {
-        control: component.label,
+        control: component.humanised_title,
         schema_key.to_sym => component.validation[schema_key]
       }
     end
+
+    # Method signature to be overwrite in the subclass if you do not want to allow
+    # blank values. We should not allow blank when performing the required
+    # validation.
+    #
+    # @return [TrueClass]
+    #
+    def allow_blank?
+      true unless self.class.name.demodulize.include?('RequiredValidator')
+    end
   end
 end

data/app/validators/metadata_presenter/validate_answers.rb

@@ -1,11 +1,10 @@
 module MetadataPresenter
   class ValidateAnswers
-    attr_reader :page, :components, :answers
+    attr_reader :page_answers, :components
 
-    def initialize(page:, answers:)
-      @page = page
-      @answers = answers
-      @components = Array(page.components)
+    def initialize(page_answers, components:)
+      @page_answers = page_answers
+      @components = Array(components)
     end
 
     def valid?
@@ -16,12 +15,13 @@ module MetadataPresenter
       !valid?
     end
 
+    private
+
     def validators
       components.map do |component|
         component_validations(component).map do |key|
           "MetadataPresenter::#{key.classify}Validator".constantize.new(
-            page: page,
-            answers: answers,
+            page_answers: page_answers,
             component: component
           )
         end
@@ -31,18 +31,7 @@ module MetadataPresenter
     def component_validations(component)
       return [] if component.validation.blank?
 
-      component.validation.reject do |_, value|
-        value.blank? ||
-        (optional_question?(component) && question_not_answered?)
-      end.keys
-    end
-
-    def optional_question?(component)
-      component.validation['required'] == false
-    end
-
-    def question_not_answered?
-      answers.values.any?(&:blank?)
+      component.validation.select { |_,value| value.present? }.keys
     end
   end
 end

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

@@ -1,8 +1,7 @@
 <%=
   f.govuk_text_field component.id.to_sym,
-    label: { text: component.label },
+    label: { text: input_title },
     hint: { text: component.hint },
     name: "answers[#{component.name}]",
-    value: answer(component.name),
     width: component.width_class_input.to_i
 %>

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

@@ -1,7 +1,6 @@
 <%=
   f.govuk_text_field component.id.to_sym,
-    label: { text: component.label },
+    label: { text: input_title },
     hint: { text: component.hint },
-    name: "answers[#{component.name}]",
-    value: answer(component.name)
+    name: "answers[#{component.name}]"
 %>

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

@@ -1,9 +1,8 @@
 <%=
   f.govuk_text_area component.id.to_sym,
-    label: { text: component.label },
+    label: { text: input_title },
     hint: { text: component.hint },
     name: "answers[#{component.name}]",
-    value: answer(component.name),
     max_chars: component.maxchars,
     max_words: component.maxwords,
     threshold: component.threshold,

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

@@ -31,7 +31,7 @@
             <% Array(page.components).each do |component| %>
               <div class="govuk-summary-list__row">
                 <dt class="govuk-summary-list__key">
-                  <%= component.label %>
+                  <%= component.humanised_title %>
                 </dt>
 
                 <dd class="govuk-summary-list__value">

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

@@ -1,14 +1,14 @@
 <div class="fb-main-grid-wrapper" data-block-id="<%= @page.id %>" data-block-type="page" data-block-pagetype="<%= @page.type %>">
   <div class="govuk-grid-row">
     <div class="govuk-grid-column-two-thirds">
-      <h1 class="<%= @page.heading_class %>" data-block-id="<%= @page.id %>" data-block-property="heading">
-          <%= @page.heading.html_safe %>
-      </h1>
-
-      <%= form_for @page, url: @page.url, method: :post do |f| %>
+      <%= form_for @page_answers, as: :answers, url: @page.url, method: :post do |f| %>
         <%= f.govuk_error_summary %>
         <% @page.components.each do |component| %>
-          <%= render partial: component, locals: { component: component, f: f } %>
+          <%= render partial: component, locals: {
+            component: component,
+            f: f,
+            input_title: main_h1(component) }
+          %>
         <% end %>
 
         <%= f.govuk_submit(disabled: editable?) %>

data/default_metadata/component/radios.json

@@ -0,0 +1,9 @@
+{
+  "_id": "component.radios",
+  "_type": "radios",
+  "errors": {},
+  "hint": "Component hint",
+  "items": [],
+  "name": "component-name",
+  "legend": "Required legend"
+}

data/default_metadata/definition/radio.json

@@ -0,0 +1,6 @@
+{
+  "_id": "definition.radio",
+  "_type": "radio",
+  "label": "Required label",
+  "value": "radio-value"
+}

data/fixtures/version.json

@@ -58,10 +58,10 @@
       "_type": "page.singlequestion",
       "components": [
         {
-          "_id": "page.name--text.auto_name__1",
+          "_id": "name_text_1",
           "_type": "text",
           "label": "Full name",
-          "name": "full_name",
+          "name": "name_text_1",
           "validation": {
             "required": true,
             "max_length": 10,
@@ -79,7 +79,7 @@
       "heading": "Email address",
       "components": [
         {
-          "_id": "page.email-address--email.auto_name__2",
+          "_id": "email-address_email_1",
           "_type": "text",
           "errors": {
             "format": {},
@@ -94,7 +94,7 @@
             }
           },
           "label": "Your email address",
-          "name": "email_address",
+          "name": "email-address_email_1",
           "validation": {
             "required": true,
             "max_length": 30,
@@ -110,10 +110,10 @@
       "_type": "page.singlequestion",
       "components": [
         {
-          "_id": "page.parent-name--text.auto_name__3",
+          "_id": "parent-name_text_1",
           "_type": "text",
           "label": "Parent name",
-          "name": "parent_name",
+          "name": "parent-name_text_1",
           "validation": {
             "required": false,
             "max_length": 10,
@@ -132,15 +132,15 @@
       "heading":"Your age",
       "components": [
         {
-          "_id": "your_age_number_1",
+          "_id": "your-age_number_1",
           "hint": "Component hint",
-          "name": "your_age_number_1",
+          "name": "your-age_number_1",
           "_type": "number",
           "label": "Your age",
           "errors": {},
           "validation": {
-            "required": true,
-            "number": true
+            "number": true,
+            "required": true
           },
           "width_class_input": "10"
         }
@@ -152,10 +152,10 @@
       "_type": "page.singlequestion",
       "components": [
         {
-          "_id": "page.family-hobbies--text.auto_name__3",
+          "_id": "family-hobbies_text_1",
           "_type": "textarea",
           "label": "Your family hobbies",
-          "name": "family_hobbies",
+          "name": "family-hobbies_text_1",
           "rows": 5,
           "validation": {
             "required": true
@@ -165,6 +165,42 @@
       "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"
+    },
     {
       "_uuid": "e819d0c2-7062-4997-89cf-44d26d098404",
       "_id": "page._check-answers",

data/lib/metadata_presenter/version.rb

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

data/schemas/component/radios.json

@@ -0,0 +1,37 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/radios",
+  "_name": "component.radios",
+  "title": "Radios",
+  "description": "Let users select one option from a list",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "radios"
+    },
+    "items": {
+      "title": "Options",
+      "description": "Items that users can select",
+      "type": "array",
+      "items": {
+        "$ref": "definition.radio"
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.fieldset"
+    },
+    {
+      "$ref": "definition.name"
+    }
+  ],
+  "transforms": {
+    "namespace": {
+      "propagation": "items[*].conditional_component"
+    }
+  },
+  "required": [
+    "name",
+    "items"
+  ]
+}

data/schemas/definition/conditionalcomponent.json

@@ -0,0 +1,12 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/conditionalcomponent",
+  "_name": "definition.conditionalcomponent",
+  "nestable": true,
+  "title": "Conditional component",
+  "description": "Component revealed when user chooses option",
+  "allOf": [
+    {
+      "$ref": "definition.component"
+    }
+  ]
+}

data/schemas/definition/fieldset.json

@@ -0,0 +1,37 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/fieldset",
+  "_name": "definition.fieldset",
+  "title": "Fieldset",
+  "description": "Group related form inputs",
+  "type": "object",
+  "category": [
+    "control",
+    "fieldset"
+  ],
+  "properties": {
+    "_type": {
+      "const": "fieldset"
+    },
+    "legend": {
+      "title": "Legend",
+      "description": "Text to use in fieldset legend",
+      "type": "string"
+    },
+    "hint": {
+      "title": "Hint",
+      "description": "Text to help users answer a question - appears in grey under the legend",
+      "type": "string"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.repeatable"
+    },
+    {
+      "$ref": "definition.grouping"
+    }
+  ],
+  "required": [
+    "legend"
+  ]
+}

data/schemas/definition/grouping.json

@@ -0,0 +1,27 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/grouping",
+  "_name": "definition.grouping",
+  "title": "Grouping definition",
+  "allOf": [
+    {
+      "$ref": "definition.component"
+    },
+    {
+      "$ref": "definition.components"
+    },
+    {
+      "$ref": "definition.namespace"
+    },
+    {
+      "$ref": "definition.html_attributes"
+    }
+  ],
+  "category": [
+    "grouping"
+  ],
+  "transforms": {
+    "namespace": {
+      "propagation": "components[?(@.$control || @.$grouping)]"
+    }
+  }
+}

data/schemas/definition/option.json

@@ -0,0 +1,35 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/option",
+  "_name": "definition.option",
+  "title": "Option definition",
+  "properties": {
+    "value": {
+      "title": "Option value",
+      "description": "Value captured by system when users choose this option",
+      "type": "string"
+    },
+    "hasDivider": {
+      "title": "Option divider",
+      "description": "Whether to display a textual divider before the option - defaults to ‘or’",
+      "type": "boolean"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.block"
+    },
+    {
+      "$ref": "definition.label"
+    },
+    {
+      "$ref": "definition.namespace"
+    }
+  ],
+  "required": [
+    "value"
+  ],
+  "category": [
+    "component",
+    "option"
+  ]
+}

data/schemas/definition/radio.json

@@ -0,0 +1,30 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/radio",
+  "_name": "definition.radio",
+  "idSeed": "value",
+  "title": "Radio option",
+  "description": "Component that provides a radio option",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "radio"
+    },
+    "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.option"
+    }
+  ],
+  "required": [
+    "label"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.11.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -236,6 +236,7 @@ files:
 - 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/validators/metadata_presenter/base_validator.rb
 - app/validators/metadata_presenter/max_length_validator.rb
@@ -247,6 +248,7 @@ files:
 - app/views/errors/404.html
 - app/views/layouts/metadata_presenter/application.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,10 +261,12 @@ files:
 - config/initializers/schemas.rb
 - config/routes.rb
 - 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/radio.json
 - default_metadata/page/checkanswers.json
 - default_metadata/page/confirmation.json
 - default_metadata/page/singlequestion.json
@@ -281,6 +285,7 @@ files:
 - lib/metadata_presenter/version.rb
 - lib/tasks/metadata_presenter_tasks.rake
 - schemas/component/number.json
+- schemas/component/radios.json
 - schemas/component/text.json
 - schemas/component/textarea.json
 - schemas/condition/condition.json
@@ -297,21 +302,26 @@ files:
 - schemas/definition/condition.text.json
 - schemas/definition/condition.value_type.json
 - schemas/definition/conditional.boolean.json
+- schemas/definition/conditionalcomponent.json
 - schemas/definition/conditions.all.json
 - schemas/definition/conditions.any.json
 - schemas/definition/conditions.exactly.json
 - schemas/definition/control.json
 - schemas/definition/data.json
 - schemas/definition/field.json
+- schemas/definition/fieldset.json
+- schemas/definition/grouping.json
 - schemas/definition/html_attributes.json
 - schemas/definition/label.json
 - schemas/definition/link_list.json
 - schemas/definition/name.json
 - schemas/definition/namespace.json
 - schemas/definition/next_page.json
+- schemas/definition/option.json
 - schemas/definition/page.content.json
 - schemas/definition/page.form.json
 - schemas/definition/page.json
+- schemas/definition/radio.json
 - schemas/definition/repeatable.json
 - schemas/definition/width_class.input.json
 - schemas/definition/width_class.json