metadata_presenter 2.17.9 → 2.17.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f753356995076aa70b70538d34770ce68b03aa2fe866208cac8cd5b4ad861e9
-  data.tar.gz: 7ed63dece8665708989288145f64518c5a7c925c3c8e5ec55f5bc44487728b97
+  metadata.gz: 5a6e2dbe0fe23a5e22e74627e7b52a805e4cf84ea3023a8fb73deec9bcd87f1f
+  data.tar.gz: 16cd90ea4a6a64a8ddfe9c45a92df39338c2a25594db418a0671b3b6716d48ed
 SHA512:
-  metadata.gz: 0f8629f5c3a5cb9e4be7ac9fc7abf2868f45a7e44f10249fdcc8d47e7ee9ceb848c6e3cafa9683f02137fcddd78391e521f19a6a8e2f55dea5218f46da60d003
-  data.tar.gz: ad83b314cdaa5eb1d2f2babcbe2be7d358305fed7b474f194a73fb1c41829e4e578e4c8bdf8cd7ebcd8ca5d040372943aaa94ef76b8b673b6f3458a36216aadc
+  metadata.gz: f173ec4fffdc2dc76f1defe9e726b5b00dbb5b6a1bff4e0d090fe4ba3d0c07d17b3bb2cd22b665cb0019637688e7c1b8c12a414806e41a8587daaf727bddc0f5
+  data.tar.gz: ff67ff698d108e681e631c514c82d716d9c5c000cfa30b03524f8aa34029b9d968b661bb167d69e1741401cb7b37dbafadcf1bb6ff62c3b202d4cfd305513d00

data/README.md

@@ -49,6 +49,7 @@ that you need to write the following methods in your controller:
 2. load_user_data
 3. editable?
 4. create_submission
+5. assign_autocomplete_items
 
 The user answers can be accessed via `params[:answers]`.
 
@@ -80,6 +81,8 @@ mountable app:
 The `create_submission` is related to process the submission in a backend
 service.
 
+The `autocomplete_items` takes the components on a page and retrieves any items for them that may exist. For the Editor it will make an API call, for the Runner it will look it up via an environment variable.
+
 ## Generate documentation
 
 Run `rake doc` and open the doc/index.html

data/app/controllers/metadata_presenter/pages_controller.rb

@@ -5,6 +5,11 @@ 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
+
         @page_answers = PageAnswers.new(@page, @user_data)
         render template: @page.template
       else

data/app/models/metadata_presenter/autocomplete_item.rb

@@ -0,0 +1,9 @@
+class MetadataPresenter::AutocompleteItem < MetadataPresenter::Metadata
+  def id
+    value
+  end
+
+  def name
+    text
+  end
+end

data/app/models/metadata_presenter/component.rb

@@ -20,10 +20,14 @@ class MetadataPresenter::Component < MetadataPresenter::Metadata
 
   def items
     Array(metadata.items).map do |item|
-      MetadataPresenter::Item.new(item, editor: editor?)
+      item_klass.new(item, editor: editor?)
     end
   end
 
+  def item_klass
+    type == 'autocomplete' ? MetadataPresenter::AutocompleteItem : MetadataPresenter::Item
+  end
+
   SUPPORTS_BRANCHING = %w[radios checkboxes].freeze
 
   def supports_branching?

data/app/models/metadata_presenter/page.rb

@@ -39,7 +39,8 @@ module MetadataPresenter
     end
 
     def components
-      to_components(metadata.components, collection: :components)
+      @components ||=
+        to_components(metadata.components, collection: :components)
     end
 
     def extra_components
@@ -104,6 +105,17 @@ module MetadataPresenter
       type == 'page.multiplequestions'
     end
 
+    def autocomplete_component_present?
+      components.any? { |component| component.type == 'autocomplete' }
+    end
+
+    def assign_autocomplete_items(items)
+      component_uuids = items.keys
+      components.each do |component|
+        component.items = items[component.uuid] if component.uuid.in?(component_uuids)
+      end
+    end
+
     private
 
     def heading?
@@ -111,7 +123,7 @@ module MetadataPresenter
     end
 
     def to_components(node_components, collection:)
-      node_components&.map do |component|
+      Array(node_components).map do |component|
         MetadataPresenter::Component.new(
           component.merge(collection: collection),
           editor: editor?

data/config/initializers/supported_components.rb

@@ -21,7 +21,7 @@ Rails.application.config.supported_components =
       content: %w(content)
     },
     singlequestion: {
-      input: %w(text textarea number date radios checkboxes email upload),
+      input: %w(text textarea number date radios checkboxes email upload autocomplete),
       content: %w()
      }
   })

data/fixtures/version.json

@@ -69,6 +69,12 @@
       }
     },
     "2ef7d11e-0307-49e9-9fe2-345dc528dd66": {
+      "_type": "flow.page",
+      "next": {
+        "default": "c7755991-436b-4495-afa6-803db58cefbc"
+      }
+    },
+    "c7755991-436b-4495-afa6-803db58cefbc": {
       "_type": "flow.page",
       "next": {
         "default": "e337070b-f636-49a3-a65c-f506675265f0"
@@ -568,6 +574,33 @@
         }
       ]
     },
+    {
+      "_id": "page.countries",
+      "url": "countries",
+      "body": "Body section",
+      "lede": "",
+      "_type": "page.singlequestion",
+      "_uuid": "c7755991-436b-4495-afa6-803db58cefbc",
+      "heading": "",
+      "components": [
+        {
+          "_id": "countries_autocomplete_1",
+          "hint": "",
+          "name": "countries_autocomplete_1",
+          "_type": "autocomplete",
+          "_uuid": "4dc23b9c-9757-4526-813d-b43efbe07dad",
+          "items": [
+          ],
+          "errors": {
+          },
+          "legend": "Countries",
+          "validation": {
+            "required": true
+          }
+        }
+      ],
+      "section_heading": ""
+    },
     {
       "_id": "page.check-answers",
       "url": "check-answers",

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.17.9'.freeze
+  VERSION = '2.17.10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.17.9
+  version: 2.17.10
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -262,6 +262,7 @@ files:
 - app/helpers/metadata_presenter/application_helper.rb
 - app/helpers/metadata_presenter/default_text.rb
 - app/jobs/metadata_presenter/application_job.rb
+- app/models/metadata_presenter/autocomplete_item.rb
 - app/models/metadata_presenter/branch_destinations.rb
 - app/models/metadata_presenter/column_number.rb
 - app/models/metadata_presenter/component.rb