metadata_presenter 2.7.2 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48503ea21820959e21824490a615c78e27fd5b7eece419141b8105a0e91f4ad6
-  data.tar.gz: ad0c43095f40f524e6cec36e339a0deadc490f50d0686324cb9666827fa979ca
+  metadata.gz: 6cca8a3428e516ba176e5a898a1d1a76cd57fa836041f0c3fc492a8cd394e88a
+  data.tar.gz: 9940b709ccce5e211444fe6b7cf84dfeed78f1c13591c9291b797a3eca4ac609
 SHA512:
-  metadata.gz: 35b20dc2f7539ae53d0360845513bb0c0859281c54c4dd21542a650636a5fb545132322e325bdc4511e176d60c629f78b46d1cd4a4fc6791c2fe573c9beb9316
-  data.tar.gz: 482185c1044b0013f3875255c4a94482de1882adbecb749352f4cb797c9d5a762ede00f4d3c4348c4d8c124ee5f36ddbd85fc7905ea53765965c0cafe69ff3fb
+  metadata.gz: 1b9c3ae006ca76d0386db74a2fb39d106884dc0cd285457c05be6f3d3f75e2a30cc79511112d3881c532ba7e6e3c087e5e83e4116a708cf3cd81b4ea345de813
+  data.tar.gz: 659da027fb5c27df2c007dfd961bfce0148879aec3833f72c53f4d195080bde041b29c53260c397430e5425383a2c7a364e1ed8fd4d22bbabdb33417ecb896ed

data/app/models/metadata_presenter/branch_destinations.rb

@@ -0,0 +1,18 @@
+module MetadataPresenter
+  module BranchDestinations
+    # 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 { |_| conditional.next }
+        else
+          conditional.next
+        end
+      end
+      destination_uuids.flatten.push(branch.default_next)
+    end
+  end
+end

data/app/models/metadata_presenter/column_number.rb

@@ -0,0 +1,25 @@
+module MetadataPresenter
+  class ColumnNumber
+    def initialize(uuid:, coordinates:, new_column:)
+      @uuid = uuid
+      @coordinates = coordinates
+      @new_column = new_column
+    end
+
+    def number
+      use_new_column? ? new_column : existing_column
+    end
+
+    private
+
+    attr_reader :uuid, :coordinates, :new_column
+
+    def use_new_column?
+      existing_column.nil? || new_column > existing_column
+    end
+
+    def existing_column
+      @existing_column ||= @coordinates.uuid_column(uuid)
+    end
+  end
+end

data/app/models/metadata_presenter/coordinates.rb

@@ -0,0 +1,59 @@
+module MetadataPresenter
+  class Coordinates
+    def initialize(flow)
+      @flow = flow
+      @positions = setup_positions
+    end
+
+    attr_reader :positions
+
+    def set_column(uuid, number)
+      positions[uuid][:column] = number
+    end
+
+    def set_row(uuid, number)
+      positions[uuid][:row] = number
+    end
+
+    def uuid_column(uuid)
+      positions[uuid][:column]
+    end
+
+    def uuid_row(uuid)
+      positions[uuid][:row]
+    end
+
+    def uuid_at_position(column, row)
+      positions.find do |uuid, position|
+        if position[:column] == column && position[:row] == row
+          return uuid
+        end
+      end
+    end
+
+    def position(uuid)
+      positions[uuid]
+    end
+
+    def occupied?(column, row, new_object_uuid)
+      positions.any? do |uuid, position|
+        position[:column] == column &&
+          position[:row] == row &&
+          new_object_uuid != uuid
+      end
+    end
+
+    def positions_in_column(column_number)
+      positions.select { |_, position| position[:column] == column_number }
+    end
+
+    private
+
+    attr_reader :flow
+    attr_writer :positions
+
+    def setup_positions
+      flow.keys.index_with { |_uuid| { row: nil, column: nil } }
+    end
+  end
+end

data/app/models/metadata_presenter/grid.rb

@@ -12,6 +12,7 @@ module MetadataPresenter
   end
 
   class Grid
+    include BranchDestinations
     attr_reader :start_from
 
     def initialize(service, start_from: nil, main_flow: [])
@@ -21,7 +22,7 @@ module MetadataPresenter
       @ordered = []
       @routes = []
       @traversed = []
-      @coordinates = setup_coordinates
+      @coordinates = MetadataPresenter::Coordinates.new(service.flow)
     end
 
     ROW_ZERO = 0
@@ -30,8 +31,8 @@ module MetadataPresenter
       return @ordered unless @ordered.empty?
 
       @ordered = make_grid
-      add_columns
-      add_rows
+      set_column_numbers
+      set_row_numbers
       add_by_coordinates
       insert_expression_spacers
       trim_pointers unless main_flow.empty?
@@ -62,10 +63,6 @@ module MetadataPresenter
     attr_reader :service, :main_flow
     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(
@@ -83,7 +80,12 @@ module MetadataPresenter
     end
 
     def max_potential_rows
-      @max_potential_rows ||= @routes.map(&:row).max + 1
+      @max_potential_rows ||= begin
+        destinations_count = service.branches.map do |branch|
+          exiting_destinations_from_branch(branch).count
+        end
+        destinations_count.sum
+      end
     end
 
     def max_potential_columns
@@ -121,30 +123,47 @@ module MetadataPresenter
       end
     end
 
-    def add_columns
+    def set_column_numbers
       @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
+        route.flow_uuids.each.with_index(route.column) do |uuid, new_column|
+          column_number = MetadataPresenter::ColumnNumber.new(
+            uuid: uuid,
+            new_column: new_column,
+            coordinates: @coordinates
+          ).number
+          @coordinates.set_column(uuid, column_number)
         end
       end
     end
 
-    def add_rows
+    def set_row_numbers
       @routes.each do |route|
-        route.flow_uuids.each do |uuid|
-          next if @traversed.include?(uuid)
+        next if @traversed.include?(route.traverse_from) && appears_later_in_flow?(route)
 
-          @coordinates[uuid][:row] = route.row if @coordinates[uuid][:row].nil?
+        current_row = route.row
+        route.flow_uuids.each do |uuid|
+          row_number = MetadataPresenter::RowNumber.new(
+            uuid: uuid,
+            route: route,
+            current_row: current_row,
+            coordinates: @coordinates,
+            service: service
+          ).number
+          @coordinates.set_row(uuid, row_number)
 
           update_route_rows(route, uuid)
-          @traversed.push(uuid)
+          @traversed.push(uuid) unless @traversed.include?(uuid)
+          current_row = row_number
         end
       end
     end
 
+    # New routes can be linked to later. We need to also traverse these to see
+    # if anything should be moved to a different row.
+    def appears_later_in_flow?(route)
+      @coordinates.uuid_column(route.traverse_from) > route.column
+    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
@@ -162,7 +181,8 @@ module MetadataPresenter
     end
 
     def add_by_coordinates
-      @coordinates.each do |uuid, position|
+      service.flow.each_key do |uuid|
+        position = coordinates.position(uuid)
         next if detached?(position)
 
         @ordered[position[:column]][position[:row]] = get_flow_object(uuid)
@@ -202,12 +222,12 @@ module MetadataPresenter
     # 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|
+      @ordered.each_with_index do |column, column_number|
         last_index_of = column.rindex { |item| !item.is_a?(MetadataPresenter::Spacer) }
-        trimmed_column = @ordered[index][0..last_index_of]
+        trimmed_column = @ordered[column_number][0..last_index_of]
 
         # We do not need any columns that only contain Spacer objects
-        @ordered[index] = only_spacers?(trimmed_column) ? [] : trimmed_column
+        @ordered[column_number] = only_spacers?(trimmed_column) ? [] : trimmed_column
       end
     end
 
@@ -220,37 +240,23 @@ module MetadataPresenter
     # 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 if coordinates.uuid_column(branch.uuid).nil?
 
-        next_column = position[:column] + 1
-        uuids = []
-        exiting_destinations_from_branch(branch).each.with_index(position[:row]) do |uuid, row|
-          if uuids.include?(uuid)
+        previous_uuid = ''
+        next_column = coordinates.uuid_column(branch.uuid) + 1
+        exiting_destinations_from_branch(branch).each_with_index do |uuid, row|
+          if uuid == previous_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
+          previous_uuid = uuid
         end
       end
-      destination_uuids.flatten
     end
 
     # Any destinations exiting the branch that have not already been traversed.
+    # This removes any branch destinations that already exist on other rows. If
+    # that is the case then the arrow will flow towards whatever row that object
+    # is located.
     def routes_exiting_branch(branch)
       branch.all_destination_uuids.reject { |uuid| @traversed.include?(uuid) }
     end

data/app/models/metadata_presenter/row_number.rb

@@ -0,0 +1,71 @@
+module MetadataPresenter
+  class RowNumber
+    include BranchDestinations
+
+    def initialize(uuid:, route:, current_row:, coordinates:, service:)
+      @uuid = uuid
+      @route = route
+      @current_row = current_row
+      @coordinates = coordinates
+      @service = service
+    end
+
+    ROW_ZERO = 0
+
+    def number
+      return route.row if first_row? && existing_row.nil?
+
+      return ROW_ZERO if place_on_row_zero?
+
+      if object_above.branch? && uuid != object_above.uuid
+        coordinates.uuid_row(object_above.uuid) + number_of_destinations
+      else
+        existing_row.nil? ? current_row : [current_row, existing_row].max
+      end
+    end
+
+    private
+
+    attr_reader :uuid, :route, :current_row, :coordinates, :service
+
+    def existing_row
+      @existing_row ||= coordinates.uuid_row(uuid)
+    end
+
+    def first_row?
+      @first_row ||= route.row.zero?
+    end
+
+    def object_above
+      @object_above ||=
+        service.flow_object(coordinates.uuid_at_position(uuid_column, row_above))
+    end
+
+    # Takes into account the 'or' type of conditionals which requires an
+    # additional spacer
+    def number_of_destinations
+      exiting_destinations_from_branch(object_above).count
+    end
+
+    def uuid_column
+      @uuid_column ||= coordinates.uuid_column(uuid)
+    end
+
+    def row_above
+      @row_above ||= route.row - 1
+    end
+
+    # If an object has already been positioned on row 0 then leave it there.
+    # If the object is a checkanswers or confirmation type then always place it
+    # on row 0.
+    def place_on_row_zero?
+      cya_or_confirmation_page? || coordinates.uuid_row(uuid) == ROW_ZERO
+    end
+
+    def cya_or_confirmation_page?
+      %w[page.checkanswers page.confirmation].include?(
+        service.find_page_by_uuid(uuid)&.type
+      )
+    end
+  end
+end

data/default_metadata/flow/conditional.json

@@ -1,4 +1,5 @@
 {
+  "_uuid": "",
   "_type": "",
   "next": "",
   "expressions": []

data/fixtures/branching.json

@@ -27,6 +27,7 @@
         "default": "0b297048-aa4d-49b6-ac74-18e069118185",
         "conditionals": [
           {
+            "_uuid": "ecd60ac9-c3ea-47b1-8f79-c4e42df9a9dd",
             "_type": "if",
             "next": "e8708909-922e-4eaf-87a5-096f7a713fcb",
             "expressions": [
@@ -60,6 +61,7 @@
         "default": "05c3306c-0a39-42d2-9e0f-93fd49248f4e",
         "conditionals": [
           {
+            "_uuid": "51b4eda2-a08d-4ab3-a8cb-565091f39424",
             "_type": "if",
             "next": "d4342dfd-0d09-4a91-a0ea-d7fd67e706cc",
             "expressions": [
@@ -72,6 +74,7 @@
             ]
           },
           {
+            "_uuid": "0a799cea-f5a4-4b89-9ffe-78515b5cb1d7",
             "_type": "if",
             "next": "91e9f7c6-2f75-4b7d-9eb5-0cf352f7be66",
             "expressions": [
@@ -111,6 +114,7 @@
         "default": "ef2cafe3-37e2-4533-9b0c-09a970cd38d4",
         "conditionals": [
           {
+            "_uuid": "0d3410db-1d05-4a32-bafb-65b52408b89b",
             "_type": "if",
             "next": "8002df6e-29ab-4cdf-b520-1d7bb931a28f",
             "expressions": [
@@ -144,6 +148,7 @@
         "default": "0c022e95-0748-4dda-8ba5-12fd1d2f596b",
         "conditionals": [
           {
+            "_uuid": "88b97d53-1da7-4464-a0a5-633a9ffd3d3d",
             "_type": "if",
             "next": "b5efc09c-ece7-45ae-b0b3-8a7905e25040",
             "expressions": [
@@ -177,6 +182,7 @@
         "default": "dc7454f9-4186-48d7-b055-684d57bbcdc7",
         "conditionals": [
           {
+            "_uuid": "8a0c225f-b078-4728-a181-c3bdd343801c",
             "_type": "if",
             "next": "bc666714-c0a2-4674-afe5-faff2e20d847",
             "expressions": [
@@ -189,6 +195,7 @@
             ]
           },
           {
+            "_uuid": "7d1b29ac-f310-4246-bab9-957c9b2a20f2",
             "_type": "if",
             "next": "e2887f44-5e8d-4dc0-b1de-496ab6039430",
             "expressions": [
@@ -228,6 +235,7 @@
         "default": "48357db5-7c06-4e85-94b1-5e1c9d8f39eb",
         "conditionals": [
           {
+            "_uuid": "15e8076f-75ac-4310-89b3-d2b5962babd4",
             "_type": "or",
             "next": "2cc66e51-2c14-4023-86bf-ded49887cdb2",
             "expressions": [
@@ -246,6 +254,7 @@
             ]
           },
           {
+            "_uuid": "0811ac93-a73e-4a2d-a8f1-68cc8a52ca69",
             "_type": "and",
             "next": "f6c51f88-7be8-4cb7-bbfc-6c905727a051",
             "expressions": [
@@ -291,6 +300,7 @@
         "default": "941137d7-a1da-43fd-994a-98a4f9ea6d46",
         "conditionals": [
           {
+            "_uuid": "5ce78103-3935-4c57-9278-79bf2b8b93b1",
             "_type": "and",
             "next": "56e80942-d0a4-405a-85cd-bd1b100013d6",
             "expressions": [
@@ -315,6 +325,7 @@
             ]
           },
           {
+            "_uuid": "d45c65c7-a9b4-4128-8562-89bd4f0167ec",
             "_type": "or",
             "next": "6324cca4-7770-4765-89b9-1cdc41f49c8b",
             "expressions": [