metadata_presenter 2.17.9 → 2.17.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f753356995076aa70b70538d34770ce68b03aa2fe866208cac8cd5b4ad861e9
-  data.tar.gz: 7ed63dece8665708989288145f64518c5a7c925c3c8e5ec55f5bc44487728b97
+  metadata.gz: 83d44483b1324f5bd4feb59767282ae2356c985bfd7afc50be63335dd1c57dbe
+  data.tar.gz: 64dd7c4d4cd9c2815e1fada71c2780f60203b2530b305b0edd82a85833cf5f0b
 SHA512:
-  metadata.gz: 0f8629f5c3a5cb9e4be7ac9fc7abf2868f45a7e44f10249fdcc8d47e7ee9ceb848c6e3cafa9683f02137fcddd78391e521f19a6a8e2f55dea5218f46da60d003
-  data.tar.gz: ad83b314cdaa5eb1d2f2babcbe2be7d358305fed7b474f194a73fb1c41829e4e578e4c8bdf8cd7ebcd8ca5d040372943aaa94ef76b8b673b6f3458a36216aadc
+  metadata.gz: 6da916e33426cfbd2868b09aa0a92c16a78fbee45cf33016a24844686dfc82a8dc076c80538c2e5ab723e9448fd5a0a1802e06bea94abfe311922a046c94d190
+  data.tar.gz: 5af616852e99ec845cf63daf3eb630f9a6b6e83229f58a763df29f787fc0e940e8b7fd7f928a048687324469c7abbe78e611bca513936de80cf3a2838d2b7d64

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

@@ -46,7 +46,7 @@ module MetadataPresenter
     helper_method :allow_analytics?
 
     def show_cookie_banner?
-      no_analytics_cookie?
+      (Rails.application.config.respond_to?(:global_ga4) || analytics_tags_present?) && no_analytics_cookie?
     end
     helper_method :show_cookie_banner?
 

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
+    { text: text, value: value }.to_json
+  end
+
+  def name
+    text
+  end
+end

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
@@ -20,16 +31,24 @@ 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
+    autocomplete? ? MetadataPresenter::AutocompleteItem : MetadataPresenter::Item
+  end
+
   SUPPORTS_BRANCHING = %w[radios checkboxes].freeze
 
   def supports_branching?
     type.in?(SUPPORTS_BRANCHING)
   end
 
+  def autocomplete?
+    type == 'autocomplete'
+  end
+
   def content?
     type == 'content'
   end

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?(&: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/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/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/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

@@ -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.12'.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.9
+  version: 2.17.12
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-07-29 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
@@ -434,6 +435,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