metadata_presenter 2.6.1 → 2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f8ec576a9274943e0bc1bd36901b909e408073718c64e6310ac31035227aa69
-  data.tar.gz: 42be1d66e898e46e79f9292034da70e12d3e2abdd62d98787dc12c9391b34205
+  metadata.gz: 48503ea21820959e21824490a615c78e27fd5b7eece419141b8105a0e91f4ad6
+  data.tar.gz: ad0c43095f40f524e6cec36e339a0deadc490f50d0686324cb9666827fa979ca
 SHA512:
-  metadata.gz: 54081e0c1702f9c69fd136714bf24c455a089b1b37675721aecd3ebe7c5c548ca5973c91a1d6ef8c5d8a7987ef5fa22d448cf61f4ed72fe8cd3f7b78cacf8241
-  data.tar.gz: 5baa5506512d0d40ead58378c7ed288400f3a210304ecc89943d26e72b046dc4d1181913d7029936f41b14942a2e95f46fa49538d250b7f8d3977958278bafa2
+  metadata.gz: 35b20dc2f7539ae53d0360845513bb0c0859281c54c4dd21542a650636a5fb545132322e325bdc4511e176d60c629f78b46d1cd4a4fc6791c2fe573c9beb9316
+  data.tar.gz: 482185c1044b0013f3875255c4a94482de1882adbecb749352f4cb797c9d5a762ede00f4d3c4348c4d8c124ee5f36ddbd85fc7905ea53765965c0cafe69ff3fb

data/app/models/metadata_presenter/grid.rb

@@ -1,10 +1,23 @@
 module MetadataPresenter
   class Spacer < OpenStruct
+    def type
+      'flow.spacer'
+    end
+  end
+
+  class Pointer < OpenStruct
+    def type
+      'flow.pointer'
+    end
   end
 
   class Grid
-    def initialize(service)
+    attr_reader :start_from
+
+    def initialize(service, start_from: nil, main_flow: [])
       @service = service
+      @start_from = start_from
+      @main_flow = main_flow
       @ordered = []
       @routes = []
       @traversed = []
@@ -21,9 +34,10 @@ module MetadataPresenter
       add_rows
       add_by_coordinates
       insert_expression_spacers
+      trim_pointers unless main_flow.empty?
       trim_spacers
 
-      @ordered
+      @ordered = @ordered.reject(&:empty?)
     end
 
     def ordered_flow
@@ -32,12 +46,20 @@ module MetadataPresenter
     end
 
     def ordered_pages
-      ordered_flow.reject(&:branch?)
+      @ordered_pages ||= ordered_flow.reject(&:branch?)
+    end
+
+    def flow_uuids
+      ordered_flow.map(&:uuid)
+    end
+
+    def page_uuids
+      ordered_pages.map(&:uuid)
     end
 
     private
 
-    attr_reader :service
+    attr_reader :service, :main_flow
     attr_accessor :ordered, :traversed, :routes, :coordinates
 
     def setup_coordinates
@@ -48,21 +70,30 @@ module MetadataPresenter
       @route_from_start ||=
         MetadataPresenter::Route.new(
           service: service,
-          traverse_from: service.start_page.uuid
+          traverse_from: start_from || service.start_page.uuid
         )
     end
 
     def make_grid
       traverse_all_routes
 
-      rows = @routes.map(&:row).max
-      columns = @routes.map { |r| r.column + r.flow_uuids.count }.max
-      columns.times.map { rows.times.map { MetadataPresenter::Spacer.new } }
+      max_potential_columns.times.map do
+        max_potential_rows.times.map { MetadataPresenter::Spacer.new }
+      end
+    end
+
+    def max_potential_rows
+      @max_potential_rows ||= @routes.map(&:row).max + 1
+    end
+
+    def max_potential_columns
+      @routes.map { |r| r.column + r.flow_uuids.count }.max + 1
     end
 
     def traverse_all_routes
-      # Always traverse the route that begins from the start page first and get
-      # the potential routes from any branching points that exist.
+      # Always traverse the route from the start_from uuid. Defaulting to the
+      # start page of the form unless otherwise specified.
+      # Get all the potential routes from any branching points that exist.
       route_from_start.traverse
       @routes.append(route_from_start)
       traversed_routes = route_from_start.routes
@@ -132,23 +163,58 @@ module MetadataPresenter
 
     def add_by_coordinates
       @coordinates.each do |uuid, position|
-        # If row and column are nil then the object is detached
-        next if position[:row].nil? || position[:column].nil?
+        next if detached?(position)
 
-        flow_object = service.flow_object(uuid)
-        @ordered[position[:column]][position[:row]] = flow_object
+        @ordered[position[:column]][position[:row]] = get_flow_object(uuid)
       end
     end
 
+    def detached?(position)
+      position[:row].nil? || position[:column].nil?
+    end
+
+    def get_flow_object(uuid)
+      # main_flow is always empty if the Grid is _actually_ building the main flow
+      return MetadataPresenter::Pointer.new(uuid: uuid) if main_flow.include?(uuid)
+
+      service.flow_object(uuid)
+    end
+
+    # A row should end at the first Pointer object it finds.
+    # Therefore replace any Pointers after the first one with Spacers.
+    def trim_pointers
+      max_potential_rows.times do |row|
+        first_index_of = first_pointer(row)
+        next unless first_index_of
+
+        next_column = first_index_of + 1
+        @ordered.drop(next_column).each do |column|
+          column[row] = MetadataPresenter::Spacer.new
+        end
+      end
+    end
+
+    def first_pointer(row)
+      row_objects = @ordered.map { |column| column[row] }
+      row_objects.find_index { |obj| obj.is_a?(MetadataPresenter::Pointer) }
+    end
+
     # Find the very last MetadataPresenter::Flow object in every column and
     # remove any Spacer objects after that.
     def trim_spacers
       @ordered.each_with_index do |column, index|
-        last_index_of = column.rindex { |item| item.is_a?(MetadataPresenter::Flow) }
-        @ordered[index] = @ordered[index][0..last_index_of]
+        last_index_of = column.rindex { |item| !item.is_a?(MetadataPresenter::Spacer) }
+        trimmed_column = @ordered[index][0..last_index_of]
+
+        # We do not need any columns that only contain Spacer objects
+        @ordered[index] = only_spacers?(trimmed_column) ? [] : trimmed_column
       end
     end
 
+    def only_spacers?(trimmed_column)
+      trimmed_column.all? { |item| item.is_a?(MetadataPresenter::Spacer) }
+    end
+
     # Each branch has a certain number of exits that require their own line
     # and arrow. Insert any spacers into the necessary row in the column after
     # the one the branch is located in.

data/app/models/metadata_presenter/page.rb

@@ -20,6 +20,11 @@ module MetadataPresenter
       page.multiplequestions
       page.exit
     ].freeze
+    END_OF_ROUTE_PAGES = %w[
+      page.checkanswers
+      page.confirmation
+      page.exit
+    ].freeze
 
     def editable_attributes
       to_h.reject { |k, _| k.in?(NOT_EDITABLE) }
@@ -91,6 +96,10 @@ module MetadataPresenter
       components.first.humanised_title
     end
 
+    def end_of_route?
+      type.in?(END_OF_ROUTE_PAGES)
+    end
+
     private
 
     def heading?

data/app/models/metadata_presenter/service.rb

@@ -13,6 +13,14 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
     flow_objects.select { |flow| flow.type == 'flow.branch' }
   end
 
+  def expressions
+    conditionals.map(&:expressions).flatten
+  end
+
+  def conditionals
+    branches.map(&:conditionals).flatten
+  end
+
   def flow_object(uuid)
     MetadataPresenter::Flow.new(uuid, metadata.flow[uuid])
   rescue StandardError

data/fixtures/exit_only_service.json

@@ -0,0 +1,134 @@
+{
+  "_id": "service.base",
+  "_type": "service.base",
+  "service_id": "bf0d28cc-d3cf-4511-9589-b360ae34a908",
+  "service_name": "Exit only",
+  "created_by": "81de07c7-461a-4425-9a0f-9ba30294ddfb",
+  "configuration": {
+    "service": {
+      "_id": "config.service",
+      "_type": "config.service"
+    },
+    "meta": {
+      "_id": "config.meta",
+      "_type": "config.meta",
+      "items": [
+        {
+          "_id": "config.meta--link",
+          "_type": "link",
+          "href": "cookies",
+          "text": "Cookies"
+        },
+        {
+          "_id": "config.meta--link--2",
+          "_type": "link",
+          "href": "privacy",
+          "text": "Privacy"
+        },
+        {
+          "_id": "config.meta--link--3",
+          "_type": "link",
+          "href": "accessibility",
+          "text": "Accessibility"
+        }
+      ]
+    }
+  },
+  "flow": {
+    "82f5c5bb-a71c-425c-b29b-3fbac4ad0b87": {
+      "_type": "flow.page",
+      "next": {
+        "default": "db86a329-fa2d-4e36-8343-83bdf559cde0"
+      }
+    },
+    "db86a329-fa2d-4e36-8343-83bdf559cde0": {
+      "_type": "flow.page",
+      "next": {
+        "default": "ea36b7ab-9c05-4a19-8336-30936a681614"
+      }
+    },
+    "ea36b7ab-9c05-4a19-8336-30936a681614": {
+      "_type": "flow.page",
+      "next": {
+        "default": "905c3988-b803-4b01-bc38-e1d27cc6027c"
+      }
+    },
+    "905c3988-b803-4b01-bc38-e1d27cc6027c": {
+      "_type": "flow.page",
+      "next": {
+        "default": ""
+      }
+    }
+  },
+  "pages": [
+    {
+      "_id": "page.start",
+      "_type": "page.start",
+      "_uuid": "82f5c5bb-a71c-425c-b29b-3fbac4ad0b87",
+      "heading": "Service name goes here",
+      "lede": "This is your start page first paragraph. You can only have one paragraph here.",
+      "body": "Use this service to:\r\n\r\n* do something\r\n* update your name, address or other details\r\n* do something else\r\n\r\nRegistering takes around 5 minutes.",
+      "url": "/"
+    },
+    {
+      "_id": "page.knowhere",
+      "_type": "page.singlequestion",
+      "_uuid": "db86a329-fa2d-4e36-8343-83bdf559cde0",
+      "components": [
+        {
+          "_id": "page.knowhere--text.auto_knowhere__1",
+          "_type": "text",
+          "label": "Road to knowhere",
+          "name": "knowhere",
+          "validation": {
+            "required": true,
+            "max_length": 10,
+            "min_length": 2
+          }
+        }
+      ],
+      "heading": "Road to knowhere",
+      "url": "knowhere"
+    },
+    {
+      "_id": "page.ghost",
+      "_type": "page.singlequestion",
+      "_uuid": "ea36b7ab-9c05-4a19-8336-30936a681614",
+      "components": [
+        {
+          "_id": "page.ghost--text.auto_ghost__1",
+          "_type": "text",
+          "label": "Ghost town",
+          "name": "ghost",
+          "validation": {
+            "required": true,
+            "max_length": 100,
+            "min_length": 2
+          }
+        }
+      ],
+      "heading": "Ghost town",
+      "url": "ghost"
+    },
+    {
+      "_id": "page.goodbye",
+      "url": "page-goodbye",
+      "lede": "So long and thanks for all the fish",
+      "_type": "page.exit",
+      "_uuid": "905c3988-b803-4b01-bc38-e1d27cc6027c",
+      "heading": "Goodbye",
+      "components": [
+        {
+          "_id": "exit_content_1",
+          "name": "exit_content_1",
+          "_type": "content",
+          "_uuid": "3b9d2140-888c-4673-907d-5d885ea02143",
+          "content": "Goodbye!"
+        }
+      ],
+      "section_heading": "au revoir, auf wiedersehen"
+    }
+  ],
+  "standalone_pages": [],
+  "locale": "en"
+}

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.6.1'.freeze
+  VERSION = '2.7.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.2
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -398,6 +398,7 @@ files:
 - fixtures/branching_7.png
 - fixtures/branching_8.json
 - fixtures/branching_8.png
+- fixtures/exit_only_service.json
 - fixtures/invalid_content_page.json
 - fixtures/no_component_page.json
 - fixtures/non_finished_service.json