metadata_presenter 0.7.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b189562f676341b0c9b1d6ad3e06eb514e7563d43273bb5397a27871bba72d3b
-  data.tar.gz: 65fbe4941dfca36471ce0e4349f932d0209fa7abef0155416b4e855fd54fa568
+  metadata.gz: 1ef68ecaae97370722eab970f6dd1ce2490c35f762af5bb2ff7addbe51fded02
+  data.tar.gz: 5a56f15853ed9becc11b70d0d0e1532ead81a098de1f7fbe3a1f1103a60c9a5d
 SHA512:
-  metadata.gz: 8c872d7137b780e33cfa485e6d6d7dbd6647e7eaf48fea01d94003faede70531d22caf02867d8bdea634ff43b1f7878fee1ac060855d16b3db27bc9e8de7eea0
-  data.tar.gz: 517418f03929151d2dfbc420e1fec644903bf4b72cbda01f2a3d1f4fe2192d433dbda1799ed73ef664791c0be36c5dc2c92e346085de6087d48e3eecf917c794
+  metadata.gz: bccc48c9113831eed3a67fbb8aeb19ebc6f624b1526feb113578f67f4a1d6ab8989ff01f2d9f44176f03e80782fe8313f389979b042d749217b6c2d683dd8557
+  data.tar.gz: 7d8aabc2e90780a6d01ae263abfc6b93e6dd9b888f3b7c5339b16305e3008feb16f0c4aee41d91429dd8e1e24384fea93c44827e44a093db7b6aff8554b97f18

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-fieldset__heading') 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/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.
@@ -62,6 +60,12 @@ module MetadataPresenter
       message % error_message_hash if message.present?
     end
 
+    # @return [String] user answer for the specific component
+    #
+    def user_answer
+      page_answers.send(component.name)
+    end
+
     # The default error message will be look using the schema key.
     # Assuming the schema key is 'grogu' then the default message
     # will look for 'error.grogu.value'.
@@ -115,5 +119,15 @@ module MetadataPresenter
         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/max_length_validator.rb

@@ -1,7 +1,7 @@
 module MetadataPresenter
   class MaxLengthValidator < BaseValidator
     def invalid_answer?
-      answers[component.name].to_s.size > component.validation[schema_key]
+      user_answer.to_s.size > component.validation[schema_key]
     end
   end
 end

data/app/validators/metadata_presenter/min_length_validator.rb

@@ -1,7 +1,7 @@
 module MetadataPresenter
   class MinLengthValidator < BaseValidator
     def invalid_answer?
-      answers[component.name].to_s.size < component.validation[schema_key]
+      user_answer.to_s.size < component.validation[schema_key]
     end
   end
 end

data/app/validators/metadata_presenter/number_validator.rb

@@ -0,0 +1,7 @@
+module MetadataPresenter
+  class NumberValidator < BaseValidator
+    def invalid_answer?
+      Float(user_answer, exception: false).blank?
+    end
+  end
+end

data/app/validators/metadata_presenter/required_validator.rb

@@ -1,7 +1,7 @@
 module MetadataPresenter
   class RequiredValidator < BaseValidator
     def invalid_answer?
-      answers[component.name].blank?
+      user_answer.blank?
     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

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

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/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/number.json

@@ -0,0 +1,12 @@
+{
+  "_id": "component.number",
+  "_type": "number",
+  "errors": {},
+  "hint": "Component hint",
+  "label": "Component label",
+  "name": "component-name",
+  "width_class_input": "10",
+  "validation": {
+    "number": true
+  }
+}

data/default_metadata/component/radios.json

@@ -0,0 +1,10 @@
+{
+  "_id": "component.radios",
+  "_type": "radios",
+  "errors": {},
+  "hint": "Component hint",
+  "label": "Component label",
+  "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/default_metadata/string/error.number.json

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

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,
@@ -124,16 +124,38 @@
       "heading": "Parent name",
       "url": "/parent-name"
     },
+    {
+      "_id": "page.your_age",
+      "url": "your-age",
+      "_type":"page.singlequestion",
+      "_uuid":"59d1326c-32e6-45e9-b57a-bcc8e2fb6b2c",
+      "heading":"Your age",
+      "components": [
+        {
+          "_id": "your-age_number_1",
+          "hint": "Component hint",
+          "name": "your-age_number_1",
+          "_type": "number",
+          "label": "Your age",
+          "errors": {},
+          "validation": {
+            "number": true,
+            "required": true
+          },
+          "width_class_input": "10"
+        }
+      ]
+    },
     {
       "_uuid": "7b748584-100e-4d81-a54a-5049190136cc",
       "_id": "page.family_hobbies",
       "_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

data/lib/metadata_presenter/version.rb

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

data/schemas/component/number.json

@@ -0,0 +1,29 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/number",
+  "_name": "component.number",
+  "title": "Number",
+  "description": "Let users enter a number",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "number"
+    },
+    "name": {
+      "inputType": "number"
+    },
+    "width_class_input": {
+      "default": "10"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.field"
+    },
+    {
+      "$ref": "validations#/definitions/number_bundle"
+    },
+    {
+      "$ref": "definition.width_class.input"
+    }
+  ]
+}

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.7.1
+  version: 0.10.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,15 +236,18 @@ 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
 - app/validators/metadata_presenter/min_length_validator.rb
+- app/validators/metadata_presenter/number_validator.rb
 - app/validators/metadata_presenter/required_validator.rb
 - app/validators/metadata_presenter/validate_answers.rb
 - 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/_number.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
@@ -256,10 +259,13 @@ files:
 - config/initializers/default_metadata.rb
 - 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
@@ -267,6 +273,7 @@ files:
 - default_metadata/service/base.json
 - default_metadata/string/error.max_length.json
 - default_metadata/string/error.min_length.json
+- default_metadata/string/error.number.json
 - default_metadata/string/error.required.json
 - fixtures/non_finished_service.json
 - fixtures/service.json
@@ -276,6 +283,8 @@ files:
 - lib/metadata_presenter/test_helpers.rb
 - 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
@@ -292,21 +301,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