metadata_presenter 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02fd8396a3e665ad2a74bf8f9d9e7caf372227fade7627333425267199f36363
-  data.tar.gz: 567a5b7647156679d8616845c929b5ef66831128dc4ad607f575375abeed6d3b
+  metadata.gz: 5bbf3dc29244816bf09f72e822f69608e9f558dcbf658191c6a655eaa86b890d
+  data.tar.gz: 9a15f8dea3df85ce18dff8341fc565325f23e1dd4813abce5000d200635b691d
 SHA512:
-  metadata.gz: 8bca1cbcb9e7d40278f1f9c78ef87a444aa086a1e3a95fff6f86efaf45b120fc493a294fcf321fb5a3aaf6a962f65ef00e3f069c0c974aaa78a855b9107275db
-  data.tar.gz: 6ccb5f0e750ee2930476e93930994dd8888f1dbf8ece429e0aa9aa85d04b3ef5273f8c24e950acf2f9df637c58da3d88796c8bf42790504292da0aa116ebecf0
+  metadata.gz: 58b6f7444ac4fe98236b773a953b4c8cda5d65f3187eacd819108baeb43a121e7ceb78c6863e2fa3ab162434ce9684c4c314be45ab86e4924704004785a83989
+  data.tar.gz: ae79d645b8c9b080c8cf11cd62b4036e30a0325c4c879591631476071f2192654fa6714ab070e712a4dc8bc1612df49a04ef486dd36f7cc8920046f7137ebc56

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/validators/metadata_presenter/base_validator.rb

@@ -42,6 +42,8 @@ module MetadataPresenter
     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)
@@ -62,6 +64,12 @@ module MetadataPresenter
       message % error_message_hash if message.present?
     end
 
+    # @return [String] user answer for the specific component
+    #
+    def user_answer
+      answers[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 +123,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

@@ -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,8 @@
+<%=
+  f.govuk_text_field component.id.to_sym,
+    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/_text.html.erb

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

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

@@ -1,6 +1,6 @@
 <%=
   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),

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, 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

@@ -124,6 +124,28 @@
       "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",
@@ -143,6 +165,37 @@
       "heading": "Family Hobbies",
       "url": "/family-hobbies"
     },
+    {
+      "_uuid": "4251b25e-08de-4dcb-8f2f-dd9848dcdca6",
+      "_id": "page.radio-buttons",
+      "_type": "page.singlequestion",
+      "components": [
+        {
+          "_id": "radio-buttons_radios_1",
+          "_type": "radios",
+          "errors": {},
+          "hint": "Component hint",
+          "label": "Component label",
+          "items": [
+            {
+              "_id": "radio-buttons_radio_1",
+              "_type": "radio",
+              "label": "Yes",
+              "value": "radio_value_1"
+            },
+            {
+              "_id": "radio-buttons_radio_2",
+              "_type": "radio",
+              "label": "No",
+              "value": "radio_value_2"
+            }
+          ],
+          "name": "radio-buttons_radios_1"
+        }
+      ],
+      "heading": "Parent name",
+      "url": "/radio-buttons"
+    },
     {
       "_uuid": "e819d0c2-7062-4997-89cf-44d26d098404",
       "_id": "page._check-answers",

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '0.7.0'
+  VERSION = '0.9.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.0
+  version: 0.9.0
 platform: ruby
 authors:
 - MoJ Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -240,11 +240,13 @@ files:
 - 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 +258,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 +272,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 +282,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,22 +300,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/page.singlequestion.json
+- schemas/definition/radio.json
 - schemas/definition/repeatable.json
 - schemas/definition/width_class.input.json
 - schemas/definition/width_class.json
@@ -315,6 +327,7 @@ files:
 - schemas/link/link.json
 - schemas/page/checkanswers.json
 - schemas/page/confirmation.json
+- schemas/page/singlequestion.json
 - schemas/page/start.json
 - schemas/request/service.json
 - schemas/service/base.json