metadata_presenter 2.17.7 → 2.17.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f720779f83e51414951678449c9ada6b5dfa9a01dedbd6abc7cfd07d22888e5d
-  data.tar.gz: '0783ad47052d5bed54f003a6ddf664cefe0e4a198d8cf700909d6ab73e0b1169'
+  metadata.gz: 5a6e2dbe0fe23a5e22e74627e7b52a805e4cf84ea3023a8fb73deec9bcd87f1f
+  data.tar.gz: 16cd90ea4a6a64a8ddfe9c45a92df39338c2a25594db418a0671b3b6716d48ed
 SHA512:
-  metadata.gz: 6fd29385c175133302917639ac3715298690402f2ea5169d00a3e40227de5b6da481ecb3ead7b2d5510bdf3b3686f6badea422156f99565fa08d56b4ecdf92b6
-  data.tar.gz: c77e5b6d4130c8dc5e157e60d9dd13c2210e9edd04c2d198004024975efb899081dce7ad349b4b145b543d6edee80bb0a6b160bde041fe085f5677a56b75d167
+  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,18 +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
-
-## Flow diagrams
-
-You can generate flow diagrams calling a rake task:
-
-```
-  brew install graphviz
-  SERVICE_METADATA="some-form-metadata" rails metadata:flow
-```
-
-This will generate an image with the flow for that metadata. Open that image
-and profit!

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -41,15 +41,22 @@ module MetadataPresenter
     helper_method :analytics_cookie_name
 
     def allow_analytics?
-      no_analytics_cookie? || cookies[analytics_cookie_name] == 'accepted'
+      cookies[analytics_cookie_name] == 'accepted'
     end
     helper_method :allow_analytics?
 
     def show_cookie_banner?
-      no_analytics_cookie? && analytics_tags_present?
+      no_analytics_cookie?
     end
     helper_method :show_cookie_banner?
 
+    def analytics_tags_present?
+      Rails.application.config.supported_analytics.values.flatten.any? do |analytic|
+        ENV[analytic].present?
+      end
+    end
+    helper_method :analytics_tags_present?
+
     private
 
     def not_found
@@ -60,12 +67,6 @@ module MetadataPresenter
       redirect_to File.join(request.script_name, url)
     end
 
-    def analytics_tags_present?
-      Rails.application.config.supported_analytics.values.flatten.any? do |analytic|
-        ENV[analytic].present?
-      end
-    end
-
     def no_analytics_cookie?
       cookies[analytics_cookie_name].blank?
     end

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/app/views/layouts/metadata_presenter/application.html.erb

@@ -38,8 +38,7 @@
       </main>
     </div>
     <%= render template: 'metadata_presenter/footer/footer' %>
-
-    <%= javascript_pack_tag 'application' %>
+    <%= javascript_pack_tag 'runner_application' %>
     <%= javascript_pack_tag 'govuk' %>
   </body>
 </html>

data/app/views/metadata_presenter/analytics/_ga4.html.erb

@@ -1,16 +1,8 @@
-<!-- Google Analytics 4 -->
+<!-- Form Owner Google Analytics 4 -->
 <% if Rails.application.config.respond_to?(:global_ga4) %>
-<script>
-  gtag('config', '<%= measurement_id %>');
-</script>
-<% else %>
-<script async src="https://www.googletagmanager.com/gtag/js?id=<%= measurement_id %>"></script>
-<script>
-  window.dataLayer = window.dataLayer || [];
-  function gtag(){dataLayer.push(arguments);}
-  gtag('js', new Date());
-
-  gtag('config', '<%= measurement_id %>');
-</script>
+  <%# Global Google Analytics (GA4) should be included before this point so we only need a config setting %>
+  <script>
+    gtag('config', '<%= measurement_id %>');
+  </script>
 <% end %>
-<!-- End Google Analytics 4 -->
+<!-- End Form Owner Google Analytics 4 -->

data/app/views/metadata_presenter/analytics/_global_analytics.html.erb

@@ -1,10 +1,9 @@
 <!-- Global MoJ Forms site tag (gtag.js) - Google Analytics 4 -->
-<script async src="https://www.googletagmanager.com/gtag/js?id=<%= measurement_id %>"></script>
+<script async src="https://www.googletagmanager.com/gtag/js?id=#{global_measurement_id}"></script>
 <script>
   window.dataLayer = window.dataLayer || [];
   function gtag(){dataLayer.push(arguments);}
   gtag('js', new Date());
-
-  gtag('config', '<%= measurement_id %>');
+  gtag('config', '<%= global_measurement_id %>');
 </script>
 <!-- End Global MoJ Forms site tag (gtag.js) - Google Analytics 4 -->

data/app/views/metadata_presenter/analytics/_gtm.html.erb

@@ -1,7 +1,7 @@
-<!-- Google Tag Manager -->
+<!-- Google Tag Manager for Form Owner -->
 <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
 })(window,document,'script','dataLayer','<%= measurement_id %>');</script>
-<!-- End Google Tag Manager -->
+<!-- End Google Tag Manager for Form Owner -->

data/app/views/metadata_presenter/analytics/_ua.html.erb

@@ -1,4 +1,4 @@
-<!-- Google Universal Analytics -->
+<!-- Google Universal Analytics for Form Owner -->
 <script>
   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
@@ -8,4 +8,4 @@
   ga('create', '<%= measurement_id %>', 'auto');
   ga('send', 'pageview');
 </script>
-<!-- End Google Universal Analytics -->
+<!-- End Google Universal Analytics for Form Owner -->

data/app/views/metadata_presenter/analytics/analytics.html.erb

@@ -1,7 +1,11 @@
+<%# MoJ Forms Google Analytic Reporting %>
 <% if Rails.application.config.respond_to?(:global_ga4) %>
-  <%= render partial: 'metadata_presenter/analytics/global_analytics', locals: { measurement_id: Rails.application.config.global_ga4 } %>
+  <%= render partial: 'metadata_presenter/analytics/global_analytics', locals: { global_measurement_id: Rails.application.config.global_ga4 } %>
 <% end %>
 
-<% Rails.application.config.supported_analytics.each do |provider, analytics| %>
-  <%= render partial: "metadata_presenter/analytics/#{provider}", locals: { analytics: analytics } %>
+<%# Analytic reporting set by form owners %>
+<% if analytics_tags_present? %>
+  <% Rails.application.config.supported_analytics.each do |provider, analytics| %>
+    <%= render partial: "metadata_presenter/analytics/#{provider}", locals: { analytics: analytics } %>
+  <% end %>
 <% end %>

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

@@ -11,4 +11,6 @@
   class: "govuk-!-width-two-thirds"
 %>
 
-<button type="button" class="fb-govuk-button fb-govuk-button-inverted"><%=t('actions.upload_options')%></button>
+<% if editable? %>
+  <%= render partial: '/partials/editable_autocomplete', locals: { component: component } %>
+<% 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/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.7'.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.7
+  version: 2.17.10
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -128,20 +128,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-graphviz
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -276,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
@@ -458,7 +445,6 @@ files:
 - lib/metadata_presenter/engine.rb
 - lib/metadata_presenter/test_helpers.rb
 - lib/metadata_presenter/version.rb
-- lib/tasks/metadata_presenter_tasks.rake
 - schemas/component/autocomplete.json
 - schemas/component/checkboxes.json
 - schemas/component/content.json

data/lib/tasks/metadata_presenter_tasks.rake

@@ -1,89 +0,0 @@
-require 'metadata_presenter/test_helpers'
-
-namespace :metadata do
-  include MetadataPresenter::TestHelpers
-
-  desc 'Represent the flow objects in human readable form'
-  task flow: :environment do
-    require 'ruby-graphviz'
-    metadata = ENV['SERVICE_METADATA'] || metadata_fixture('branching')
-    service = MetadataPresenter::Service.new(metadata)
-
-    graph = MetadataPresenter::Graph.new(service)
-
-    graph.draw.generate_image
-    puts "Generated file #{graph.filename}"
-    system("open #{graph.filename}")
-  end
-end
-
-module MetadataPresenter
-  class Graph
-    attr_reader :service, :filename, :nodes
-
-    delegate :metadata, :start_page, :find_page_by_uuid, :service_slug, to: :service
-
-    def initialize(service)
-      @service = service
-      @graphviz = GraphViz.new(:G, type: :digraph)
-      @filename = Rails.root.join('tmp', "#{service_slug}.png")
-      @nodes = {}
-    end
-
-    def draw
-      draw_nodes
-      draw_edges
-
-      self
-    end
-
-    def generate_image
-      @graphviz.output(png: filename)
-    end
-
-    private
-
-    def draw_nodes
-      flow.each do |id, _value|
-        flow_object = service.flow_object(id)
-
-        if flow_object.branch?
-          full_description = flow_object.conditionals.map.each_with_index do |conditional, _index|
-            conditional.expressions.map { |expression|
-              expression.service = service
-
-              "#{expression.expression_component.humanised_title} #{expression.operator} #{expression.field_label}"
-            }.join(" #{conditional.type} ")
-          end
-          nodes[id] = @graphviz.add_nodes(full_description.flatten.join(' / '))
-        else
-          current_page = find_page_by_uuid(id)
-          nodes[id] = @graphviz.add_nodes(current_page.url)
-        end
-      end
-    end
-
-    def draw_edges
-      flow.each do |id, _value|
-        flow_object = service.flow_object(id)
-        current_node = nodes[id]
-        node_next = nodes[flow_object.default_next]
-
-        if flow_object.branch?
-          @graphviz.add_edges(current_node, node_next, label: 'Conditions are not met', labelfontsize: 8) if node_next
-
-          flow_object.group_by_page.each do |page_uuid, _conditionals|
-            conditionals_node = nodes[page_uuid]
-            @graphviz.add_edges(current_node, conditionals_node, label: 'Conditions are met', labelfontsize: 8) if conditionals_node
-          end
-        elsif node_next
-          @graphviz.add_edges(current_node, node_next)
-        end
-      end
-    end
-
-    def flow
-      service.flow
-    end
-  end
-end