metadata_presenter 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3e99fe731812a98c2a9d2f6cefcade21ccd233f24118cd23440aa4d726b49c1
-  data.tar.gz: 98496d517a2cdbf8da121d9d15469c9f017065921ca81b8133d895cec9bc9cff
+  metadata.gz: 5bd3891b62938a67dd025d49a96098778ad66221bf62cb2351002906e78aa4b4
+  data.tar.gz: 9dba99d36da50beea7a209d27f3371e4e814776d86d609436ac500c6d91cbd14
 SHA512:
-  metadata.gz: f3735753a806e4b199b6420ed46469a06a856fa2140a3c893f91e187a8ae2a8068f5d54118ddefddabfd72db15ca04b9d532e9eb63019aa5d5611497ce322aee
-  data.tar.gz: 5322246015561fc511b8fb1dc2072fec440df0fce1ca34555a3893b6a43b281b59d896a0941e3d69ea0f0114ea90408fc702b2bcd7a8080ade9934dc09bdd3ad
+  metadata.gz: c8c2dde3ca3e374e0f50eebc881a64fe676f4d6fa0156ab73e26e79e0c9a19292c4c21d55665171441c52af3c56a6472783365df050246ba7e583da89db112ce
+  data.tar.gz: c114dddbf37af9e800c9eb6c4601d6f250175efd1b35f9159a728edb0c3239357f6f35b281bd1280792101d669885e6f48218ffdeca876edbfbf5af5f0f9051e

data/app/models/metadata_presenter/grid.rb

@@ -0,0 +1,203 @@
+module MetadataPresenter
+  class Spacer < OpenStruct
+  end
+
+  class Grid
+    def initialize(service)
+      @service = service
+      @ordered = []
+      @routes = []
+      @traversed = []
+      @coordinates = setup_coordinates
+    end
+
+    ROW_ZERO = 0
+
+    def build
+      @ordered = make_grid
+      add_columns
+      add_rows
+      add_by_coordinates
+      trim_spacers
+      insert_expression_spacers
+
+      @ordered
+    end
+
+    def ordered_flow
+      @ordered_flow ||= begin
+        flow = @ordered.empty? ? build.flatten : @ordered.flatten
+        flow.reject { |obj| obj.is_a?(MetadataPresenter::Spacer) }
+      end
+    end
+
+    def ordered_pages
+      ordered_flow.reject(&:branch?)
+    end
+
+    private
+
+    attr_reader :service
+    attr_accessor :ordered, :traversed, :routes, :coordinates
+
+    def setup_coordinates
+      service.flow.keys.index_with { |_uuid| { row: nil, column: nil } }
+    end
+
+    def route_from_start
+      @route_from_start ||=
+        MetadataPresenter::Route.new(
+          service: service,
+          traverse_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 } }
+    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.
+      route_from_start.traverse
+      @routes.append(route_from_start)
+      traversed_routes = route_from_start.routes
+
+      index = 0
+      until traversed_routes.empty?
+        if index > total_potential_routes
+          ActiveSupport::Notifications.instrument(
+            'exceeded_total_potential_routes',
+            message: 'Exceeded total number of potential routes'
+          )
+          break
+        end
+
+        route = traversed_routes.shift
+        @routes.append(route)
+
+        # Every route exiting a branching point needs to be traversed and any
+        # additional routes from other branching points collected and then also
+        # traversed.
+        route.traverse
+        traversed_routes |= route.routes
+
+        index += 1
+      end
+    end
+
+    def add_columns
+      @routes.each do |route|
+        route.flow_uuids.each.with_index(route.column) do |uuid, column|
+          column_number = @coordinates[uuid][:column]
+          if column_number.nil? || column > column_number
+            @coordinates[uuid][:column] = column
+          end
+        end
+      end
+    end
+
+    def add_rows
+      @routes.each do |route|
+        route.flow_uuids.each do |uuid|
+          next if @traversed.include?(uuid)
+
+          @coordinates[uuid][:row] = route.row if @coordinates[uuid][:row].nil?
+
+          update_route_rows(route, uuid)
+          @traversed.push(uuid)
+        end
+      end
+    end
+
+    # Each Route object has a starting row. Each Route object has no knowledge
+    # of other potential routes and pages/branches that may or may not exist in
+    # them. The starting row may need to change dependent upon what has been
+    # traversed in other routes.
+    def update_route_rows(route, uuid)
+      flow_object = service.flow_object(uuid)
+      if flow_object.branch? && route.row > ROW_ZERO
+        destinations = routes_exiting_branch(flow_object)
+        destinations.each.with_index(route.row) do |destination_uuid, row|
+          @routes.each do |r|
+            r.row = row if r.traverse_from == destination_uuid
+          end
+        end
+      end
+    end
+
+    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?
+
+        flow_object = service.flow_object(uuid)
+        @ordered[position[:column]][position[:row]] = flow_object
+      end
+    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]
+      end
+    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.
+    def insert_expression_spacers
+      service.branches.each do |branch|
+        position = @coordinates[branch.uuid]
+        next if position[:row].nil? || position[:column].nil? # detached branch
+
+        next_column = position[:column] + 1
+        uuids = []
+        exiting_destinations_from_branch(branch).each.with_index(position[:row]) do |uuid, row|
+          if uuids.include?(uuid)
+            @ordered[next_column].insert(row, MetadataPresenter::Spacer.new)
+          end
+
+          uuids.push(uuid) unless uuids.include?(uuid)
+        end
+      end
+    end
+
+    # The frontend requires that expressions of type 'or' get there own line and
+    # arrow. 'and' expression types continue to be grouped together.
+    # Return the UUIDs of the destinations exiting a branch and allow duplicates
+    # if the expression type is an 'or'.
+    def exiting_destinations_from_branch(branch)
+      destination_uuids = branch.conditionals.map do |conditional|
+        if conditional.type == 'or'
+          conditional.expressions.map(&:next)
+        else
+          conditional.next
+        end
+      end
+      destination_uuids.flatten
+    end
+
+    # Any destinations exiting the branch that have not already been traversed.
+    def routes_exiting_branch(branch)
+      branch.all_destination_uuids.reject { |uuid| @traversed.include?(uuid) }
+    end
+
+    # Deliberately not including the default next for each branch as when row
+    # zero is created it takes the first available conditional for each branch.
+    # The remaining are then used to create route objects. Therefore the total
+    # number of remaining routes will be the same as the total of all the branch
+    # conditionals.
+    # Add 1 additional route as that represents the route_from_start.
+    def total_potential_routes
+      @total_potential_routes ||=
+        service.branches.sum { |branch| branch.conditionals.size } + 1
+    end
+  end
+end

data/app/models/metadata_presenter/route.rb

@@ -0,0 +1,76 @@
+module MetadataPresenter
+  class Route
+    attr_reader :traverse_from
+    attr_accessor :flow_uuids, :routes, :row, :column
+
+    def initialize(service:, traverse_from:, row: 0, column: 0)
+      @service = service
+      @traverse_from = traverse_from
+      @row = row
+      @column = column
+      @routes = []
+      @flow_uuids = []
+    end
+
+    def traverse
+      @flow_uuid = traverse_from
+
+      index = column
+      until @flow_uuid.blank?
+        if index > service.flow.size
+          ActiveSupport::Notifications.instrument(
+            'exceeded_total_flow_objects',
+            message: 'Exceeded total number of flow objects'
+          )
+          break
+        end
+
+        @flow_uuids.push(@flow_uuid) unless @flow_uuids.include?(@flow_uuid)
+        flow_object = service.flow_object(@flow_uuid)
+
+        if flow_object.branch?
+          destinations = destination_uuids(flow_object)
+          # Take the first conditional destination and follow that until the end
+          # of the route.
+          @flow_uuid = destinations.shift
+
+          # The remaining conditional destinations and the branch's default next
+          # (otherwise) will be the starting point for a new Route object to be
+          # traversed.
+          # The default behaviour is that the next destination will be on the row
+          # below this current route's row. This can be changed under certain
+          # conditions in the Grid model.
+          # Each of the destinations need to be placed in the column after the
+          # current column.
+          row_number = row + 1
+          column_number = index + 1
+          destinations.each do |uuid|
+            @routes.push(
+              MetadataPresenter::Route.new(
+                service: service,
+                traverse_from: uuid,
+                row: row_number,
+                column: column_number
+              )
+            )
+            row_number += 1
+          end
+        else
+          @flow_uuid = flow_object.default_next
+        end
+
+        index += 1
+      end
+
+      @flow_uuids
+    end
+
+    private
+
+    attr_reader :service
+
+    def destination_uuids(flow_object)
+      flow_object.conditionals.map(&:next).push(flow_object.default_next)
+    end
+  end
+end

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.4.2'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/lib/metadata_presenter.rb

@@ -2,3 +2,4 @@ require 'metadata_presenter/engine'
 require 'govuk_design_system_formbuilder'
 require 'json-schema'
 require 'kramdown'
+require 'active_support/notifications'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -283,6 +283,7 @@ files:
 - app/models/metadata_presenter/expression.rb
 - app/models/metadata_presenter/file_uploader.rb
 - app/models/metadata_presenter/flow.rb
+- app/models/metadata_presenter/grid.rb
 - app/models/metadata_presenter/item.rb
 - app/models/metadata_presenter/meta.rb
 - app/models/metadata_presenter/meta_item.rb
@@ -292,6 +293,7 @@ files:
 - app/models/metadata_presenter/page.rb
 - app/models/metadata_presenter/page_answers.rb
 - app/models/metadata_presenter/previous_page.rb
+- app/models/metadata_presenter/route.rb
 - app/models/metadata_presenter/service.rb
 - app/models/metadata_presenter/traversed_pages.rb
 - app/models/metadata_presenter/uploaded_file.rb