metadata_presenter 2.17.11 → 2.17.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c0fc8809f2ded3ff926abae242977d1e502bb49f2dfecc64c91c8fd43e3ca8d
-  data.tar.gz: afaf9751bf92bfccdfb9b5ca8362b179b6999acab4efb1e098f51873ef15149e
+  metadata.gz: e97452ef08994e231a3652ad8f9ccdae67668e04bb3e449fd958a0872e4320ca
+  data.tar.gz: 6bacb894b8f40bda5ac33ffa4625d9a0970ba676d11184cdd97c8c1c5db2d0d4
 SHA512:
-  metadata.gz: e738295503ef40d85ea5129be00bd0896e8f0b7273a27bce1f8203a3b12e7d2e4f50cc5d214f9503c308aa0d3033bbe69f31499b5584da64725ea90b77066fc9
-  data.tar.gz: 0c4d1f59c8809212399ea14d8446dff1088d26446463a3eabf9ba6c0435df16c4a05901f2d66c5fde4ae969d16a0149b6b71505fda987bad2b4f13529a4bcaf7
+  metadata.gz: c446088262eea4845c754ed6f17b30237fc50acdd1b9f96b9bb78e2acb28d45445bf50d26a699188497ef58e90e8799fa2d7d384f350dac509e46d98b77faa36
+  data.tar.gz: e583b37191f8d82e357c06eb0bd17113bf2531ae1f7e4de3a40991d20ddcb4ce2877bf9cfa8bc81ae8da1964ab5c0b0150154feb2e6f8e7a013eed632fdf07e1

data/app/controllers/metadata_presenter/answers_controller.rb

@@ -4,7 +4,7 @@ module MetadataPresenter
 
     def create
       @previous_answers = reload_user_data.deep_dup
-      @page_answers = PageAnswers.new(page, answers_params)
+      @page_answers = PageAnswers.new(page, answers_params, autocomplete_items(page.components))
 
       upload_files if upload?
 
@@ -43,6 +43,8 @@ module MetadataPresenter
 
     def render_validation_error
       @user_data = answers_params
+      load_autocomplete_items
+
       render template: page.template, status: :unprocessable_entity
     end
 

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -57,6 +57,13 @@ module MetadataPresenter
     end
     helper_method :analytics_tags_present?
 
+    def load_autocomplete_items
+      if @page.autocomplete_component_present?
+        items = autocomplete_items(@page.components)
+        @page.assign_autocomplete_items(items)
+      end
+    end
+
     private
 
     def not_found

data/app/controllers/metadata_presenter/pages_controller.rb

@@ -5,10 +5,7 @@ module MetadataPresenter
       @page ||= service.find_page_by_url(request.env['PATH_INFO'])
 
       if @page
-        if @page.autocomplete_component_present?
-          items = autocomplete_items(@page.components)
-          @page.assign_autocomplete_items(items)
-        end
+        load_autocomplete_items
 
         @page_answers = PageAnswers.new(@page, @user_data)
         render template: @page.template

data/app/models/metadata_presenter/autocomplete_item.rb

@@ -1,6 +1,6 @@
 class MetadataPresenter::AutocompleteItem < MetadataPresenter::Metadata
   def id
-    value
+    { text: text, value: value }.to_json
   end
 
   def name

data/app/models/metadata_presenter/component.rb

@@ -10,6 +10,17 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
   # Threshold percentage at which the remaining count is shown
   VALIDATION_STRING_LENGTH_THRESHOLD = 75
 
+  # Overriding here because autocomplete component's items property is non interactable
+  # in the Editor therefore it does not need to exist in the data-fb-content-data
+  # attribute on the page. The data-fb-content-data attribute is what is used to
+  # update user interactable elements such as the component question or page section
+  # heading etc.
+  def to_json(*_args)
+    return super unless autocomplete?
+
+    JSON.parse(super).to_json(except: 'items')
+  end
+
   def to_partial_path
     "metadata_presenter/component/#{type}"
   end
@@ -25,7 +36,7 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
   end
 
   def item_klass
-    type == 'autocomplete' ? MetadataPresenter::AutocompleteItem : MetadataPresenter::Item
+    autocomplete? ? MetadataPresenter::AutocompleteItem : MetadataPresenter::Item
   end
 
   SUPPORTS_BRANCHING = %w[radios checkboxes].freeze
@@ -34,6 +45,10 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
     type.in?(SUPPORTS_BRANCHING)
   end
 
+  def autocomplete?
+    type == 'autocomplete'
+  end
+
   def content?
     type == 'content'
   end

data/app/models/metadata_presenter/page.rb

@@ -106,7 +106,7 @@ module MetadataPresenter
     end
 
     def autocomplete_component_present?
-      components.any? { |component| component.type == 'autocomplete' }
+      components.any?(&:autocomplete?)
     end
 
     def assign_autocomplete_items(items)

data/app/models/metadata_presenter/page_answers.rb

@@ -3,16 +3,17 @@ module MetadataPresenter
     include ActiveModel::Model
     include ActiveModel::Validations
     include ActionView::Helpers
-    attr_reader :page, :answers, :uploaded_files
+    attr_reader :page, :answers, :uploaded_files, :autocomplete_items
 
-    def initialize(page, answers)
+    def initialize(page, answers, autocomplete_items = nil)
       @page = page
       @answers = answers
+      @autocomplete_items = autocomplete_items
       @uploaded_files = []
     end
 
     def validate_answers
-      ValidateAnswers.new(self, components: components).valid?
+      ValidateAnswers.new(self, components: components, autocomplete_items: autocomplete_items).valid?
     end
 
     delegate :components, to: :page

data/app/presenters/metadata_presenter/page_answers_presenter.rb

@@ -83,5 +83,9 @@ module MetadataPresenter
     def upload(file_hash)
       file_hash['original_filename']
     end
+
+    def autocomplete(value)
+      JSON.parse(value)['text']
+    end
   end
 end

data/app/validators/metadata_presenter/autocomplete_validator.rb

@@ -0,0 +1,21 @@
+module MetadataPresenter
+  class AutocompleteValidator < BaseValidator
+    attr_reader :autocomplete_items
+
+    def initialize(page_answers:, component:, autocomplete_items:)
+      super(page_answers: page_answers, component: component)
+
+      @autocomplete_items = autocomplete_items
+    end
+
+    def invalid_answer?
+      return if autocomplete_item_list.blank?
+
+      autocomplete_item_list.exclude?(JSON.parse(user_answer))
+    end
+
+    def autocomplete_item_list
+      @autocomplete_item_list ||= autocomplete_items[component.uuid]
+    end
+  end
+end

data/app/validators/metadata_presenter/validate_answers.rb

@@ -1,10 +1,11 @@
 module MetadataPresenter
   class ValidateAnswers
-    attr_reader :page_answers, :components
+    attr_reader :page_answers, :components, :autocomplete_items
 
-    def initialize(page_answers, components:)
+    def initialize(page_answers, components:, autocomplete_items:)
       @page_answers = page_answers
       @components = Array(components)
+      @autocomplete_items = autocomplete_items
     end
 
     def valid?
@@ -21,8 +22,10 @@ module MetadataPresenter
       components.map { |component|
         component_validations(component).map do |key|
           "MetadataPresenter::#{key.classify}Validator".constantize.new(
-            page_answers: page_answers,
-            component: component
+            {
+              component: component,
+              page_answers: page_answers
+            }.merge(autocomplete_param(key))
           )
         end
       }.compact.flatten
@@ -33,5 +36,9 @@ module MetadataPresenter
 
       component.validation.select { |_, value| value.present? }.keys
     end
+
+    def autocomplete_param(key)
+      key == 'autocomplete_item' ? { autocomplete_items: autocomplete_items } : {}
+    end
   end
 end

data/app/views/layouts/metadata_presenter/application.html.erb

@@ -14,8 +14,8 @@
   <link rel="apple-touch-icon" sizes="152x152" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon-152x152.png') %>">
   <link rel="apple-touch-icon" href="<%= asset_pack_url('media/images/govuk-apple-touch-icon.png') %>">
 
-    <%= stylesheet_pack_tag 'govuk' %>
-    <%= stylesheet_link_tag 'application', media: 'all' %>
+    <%= javascript_pack_tag 'runner_application', 'govuk', defer: true %> 
+    <%= stylesheet_pack_tag 'govuk', 'runner_application', media: 'all' %>
 
     <% if allow_analytics? %>
       <%= render template: 'metadata_presenter/analytics/analytics' %>
@@ -30,15 +30,12 @@
     <%= render template: 'metadata_presenter/header/show' %>
     <div class="govuk-width-container govuk-body-m">
       <main class="govuk-main-wrapper govuk-main-wrapper--auto-spacing" id="main-content" role="main">
-      <% if back_link.present? %>
-        <a class="govuk-back-link" href="<%= back_link %>">Back</a>
-      <% end %>
-
+        <% if back_link.present? %>
+          <a class="govuk-back-link" href="<%= back_link %>">Back</a>
+        <% end %>
         <%= yield %>
       </main>
     </div>
     <%= render template: 'metadata_presenter/footer/footer' %>
-    <%= javascript_pack_tag 'runner_application' %>
-    <%= javascript_pack_tag 'govuk' %>
   </body>
 </html>

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

@@ -3,14 +3,19 @@
   component.items,
   :id,
   :name,
+  selected: component.value,
   label: { text: input_title },
   hint:  {
       data: { "fb-default-text" => default_text('hint') },
       text: component.hint
     },
-  class: "govuk-!-width-two-thirds"
+  class: "govuk-!-width-two-thirds fb-autocomplete",
+  options: {
+    include_blank: true
+  }
 %>
 
 <% if editable? %>
   <%= render partial: '/partials/editable_autocomplete', locals: { component: component } %>
 <% end %>
+

data/default_metadata/component/autocomplete.json

@@ -7,6 +7,7 @@
   "name": "component-name",
   "legend": "Question",
   "validation": {
-    "required": true
+    "required": true,
+    "autocomplete": true
   }
 }

data/default_metadata/string/error.autocomplete.json

@@ -0,0 +1,6 @@
+{
+  "_id": "error.autocomplete",
+  "_type": "string.error",
+  "description": "Autocomplete item is not on the list",
+  "value": "Select an option from the list"
+}

data/fixtures/countries.json

@@ -0,0 +1,7 @@
+{
+  "4dc23b9c-9757-4526-813d-b43efbe07dad": [
+    { "text": "Afghanistan", "value": "AF"},
+    { "text": "Albania", "value": "AL"},
+    { "text": "Australia", "value": "AU"}
+  ]
+}

data/fixtures/version.json

@@ -595,7 +595,8 @@
           },
           "legend": "Countries",
           "validation": {
-            "required": true
+            "required": true,
+            "autocomplete": true
           }
         }
       ],

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.17.11'.freeze
+  VERSION = '2.17.14'.freeze
 end

data/schemas/component/autocomplete.json

@@ -4,14 +4,12 @@
   "title": "Autocomplete",
   "description": "Let users select one option from an auto-completing list",
   "type": "object",
-  "allOf": [
-    {
-      "$ref": "definition.select"
-    }
-  ],
   "properties": {
     "_type": {
       "const": "autocomplete"
+    },
+    "items": {
+      "$ref": "definition.select"
     }
   }
 }

data/schemas/definition/select.json

@@ -2,15 +2,9 @@
   "$id": "http://gov.uk/schema/v1.0.0/definition/select",
   "_name": "definition.select",
   "title": "Select component definition",
-  "properties": {
-    "items": {
-      "title": "Items",
-      "description": "Items that users can select",
-      "type": "array",
-      "items": {
-        "$ref": "definition.select_item"
-      }
-    }
+  "type": "array",
+  "items": {
+    "$ref": "definition.select_item"
   },
   "required": [
     "items"

data/schemas/definition/select_item.json

@@ -17,12 +17,8 @@
       "type": "string"
     }
   },
-  "allOf": [
-    {
-      "$ref": "definition.component"
-    }
-  ],
   "required": [
+    "text",
     "value"
   ],
   "category": [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.17.11
+  version: 2.17.14
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -299,6 +299,7 @@ files:
 - app/operators/metadata_presenter/operator.rb
 - app/presenters/metadata_presenter/page_answers_presenter.rb
 - app/validators/metadata_presenter/accept_validator.rb
+- app/validators/metadata_presenter/autocomplete_validator.rb
 - app/validators/metadata_presenter/base_validator.rb
 - app/validators/metadata_presenter/date_after_validator.rb
 - app/validators/metadata_presenter/date_before_validator.rb
@@ -390,6 +391,7 @@ files:
 - default_metadata/page/start.json
 - default_metadata/service/base.json
 - default_metadata/string/error.accept.json
+- default_metadata/string/error.autocomplete.json
 - default_metadata/string/error.date.json
 - default_metadata/string/error.date_after.json
 - default_metadata/string/error.date_before.json
@@ -435,6 +437,7 @@ files:
 - fixtures/branching_8.png
 - fixtures/branching_9.json
 - fixtures/branching_9.png
+- fixtures/countries.json
 - fixtures/exit_only_service.json
 - fixtures/invalid_content_page.json
 - fixtures/no_component_page.json