metadata_presenter 2.13.0 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92db6bbc2b6ecefe9836a96c3014b94cc43c48a2fb4e82152f71bea00d6b3bc4
-  data.tar.gz: f9a2d946f0bf343f4a20f943f2aed35d3fce8ddbc42cf28997b10f10bfa3f9ba
+  metadata.gz: c872a270c9f0dcdaeda241c5f0d2a09d7b01f4f13334d191801f13b6026bca1d
+  data.tar.gz: 7da6c96aec0df8801aef5cf1e4d82ae39cfefd417fa47d26cb239a1c3ccd08b9
 SHA512:
-  metadata.gz: 4b94a4afee1f43a692360645775bb5555c3c722f93a5c1f2c0cb865af90e43448d5eb1bab458eb022c49d76a39348497f2946ca925afdf11fd8ed5f8749ef0f4
-  data.tar.gz: 10ad22eada3869215e8d7ef9e00dc578468d142b7c3d151c9ba8590ad001101570e317f1b7b1f2dd5343572608ba4e1464383f8c57acbb317aa160cd2ab85157
+  metadata.gz: 24ee1c3b678200fce8eded2be159ea94cc27efed191e542ae0874f141896b5fdea8e6f7355547df367a39319aa6673f6ab22079c3dcb245d87202d33117d8819
+  data.tar.gz: d1a4b738bff3e02a61e6e76a3d5c90c32540e084c36faa874e98d8715c1db5cfe0a016023684a5f2e18a7a377acd4b24b6bfcef7a36869b15bde759bb176d13a

data/app/models/metadata_presenter/column_number.rb

@@ -1,18 +1,43 @@
 module MetadataPresenter
   class ColumnNumber
-    def initialize(uuid:, coordinates:, new_column:)
+    def initialize(uuid:, coordinates:, new_column:, service:)
       @uuid = uuid
       @coordinates = coordinates
       @new_column = new_column
+      @service = service
     end
 
     def number
-      [existing_column, new_column].compact.max
+      if service.flow_object(uuid).branch?
+        # Even though we are associating the column number to a specific flow object
+        # in the Coordinates model we do not use column_number + 1 as we are
+        # updating the position for the Spacers that exist for a branch which
+        # are always in the same column as the branch object itself.
+        coordinates.set_branch_spacers_column(uuid, column_number)
+      end
+
+      column_number
     end
 
     private
 
-    attr_reader :uuid, :coordinates, :new_column
+    attr_reader :uuid, :coordinates, :new_column, :service
+
+    def column_number
+      @column_number ||= begin
+        return latest_column if cya_or_confirmation_page?
+
+        existing_column || new_column
+      end
+    end
+
+    def latest_column
+      [existing_column, new_column].compact.max
+    end
+
+    def cya_or_confirmation_page?
+      [service.checkanswers_page&.uuid, service.confirmation_page&.uuid].include?(uuid)
+    end
 
     def existing_column
       @coordinates.uuid_column(uuid)

data/app/models/metadata_presenter/coordinates.rb

@@ -1,11 +1,14 @@
 module MetadataPresenter
   class Coordinates
-    def initialize(flow)
-      @flow = flow
+    include BranchDestinations
+
+    def initialize(service)
+      @service = service
       @positions = setup_positions
+      @branch_spacers = setup_branch_spacers
     end
 
-    attr_reader :positions
+    attr_reader :positions, :branch_spacers
 
     def set_column(uuid, number)
       positions[uuid][:column] = number
@@ -31,21 +34,45 @@ module MetadataPresenter
       end
     end
 
-    def position(uuid)
-      positions[uuid]
-    end
-
     def positions_in_column(column_number)
       positions.select { |_, position| position[:column] == column_number }
     end
 
+    def set_branch_spacers_column(branch_uuid, column)
+      branch_spacers[branch_uuid].each do |_, position|
+        position[:column] = column
+      end
+    end
+
+    # The first conditional will always attempt to draw an arrow on the same row
+    # as the branch object.
+    # Each following conditional needs to have a spacers in order for the frontend
+    # to draw an arrow therefore we increment the row number from the branches
+    # calculated starting row
+    def set_branch_spacers_row(branch_uuid, starting_row)
+      branch_spacers[branch_uuid].each.with_index(starting_row) do |(_, position), row|
+        position[:row] = row
+      end
+    end
+
     private
 
-    attr_reader :flow
-    attr_writer :positions
+    attr_reader :service
+    attr_writer :positions, :branch_spacers
 
     def setup_positions
-      flow.keys.index_with { |_uuid| { row: nil, column: nil } }
+      service.flow.keys.index_with { |_uuid| { row: nil, column: nil } }
+    end
+
+    # This also takes into account the 'OR' expressions which
+    # need an additional line for an arrow.
+    def setup_branch_spacers
+      service.branches.each.with_object({}) do |branch, hash|
+        destinations = exiting_destinations_from_branch(branch)
+        hash[branch.uuid] = destinations.index_with do |_uuid|
+          { row: nil, column: nil }
+        end
+      end
     end
   end
 end

data/app/models/metadata_presenter/grid.rb

@@ -19,7 +19,7 @@ module MetadataPresenter
 
   class Grid
     include BranchDestinations
-    attr_reader :start_from
+    attr_reader :service, :start_from
 
     def initialize(service, start_from: nil, main_flow: [])
       @service = service
@@ -28,7 +28,7 @@ module MetadataPresenter
       @ordered = []
       @routes = []
       @traversed = []
-      @coordinates = MetadataPresenter::Coordinates.new(service.flow)
+      @coordinates = MetadataPresenter::Coordinates.new(service)
     end
 
     ROW_ZERO = 0
@@ -50,7 +50,9 @@ module MetadataPresenter
 
     def ordered_flow
       @ordered_flow ||=
-        build.flatten.reject { |obj| obj.is_a?(MetadataPresenter::Spacer) || obj.is_a?(MetadataPresenter::Warning) }
+        build.flatten.reject do |obj|
+          obj.is_a?(MetadataPresenter::Spacer) || obj.is_a?(MetadataPresenter::Warning)
+        end
     end
 
     def ordered_pages
@@ -65,9 +67,13 @@ module MetadataPresenter
       ordered_pages.map(&:uuid)
     end
 
+    def show_warning?
+      checkanswers_warning.show_warning? || confirmation_warning.show_warning?
+    end
+
     private
 
-    attr_reader :service, :main_flow
+    attr_reader :main_flow
     attr_accessor :ordered, :traversed, :routes, :coordinates
 
     def route_from_start
@@ -136,7 +142,8 @@ module MetadataPresenter
           column_number = MetadataPresenter::ColumnNumber.new(
             uuid: uuid,
             new_column: new_column,
-            coordinates: @coordinates
+            coordinates: @coordinates,
+            service: service
           ).number
           @coordinates.set_column(uuid, column_number)
         end
@@ -189,7 +196,7 @@ module MetadataPresenter
 
     def add_by_coordinates
       service.flow.each_key do |uuid|
-        position = coordinates.position(uuid)
+        position = coordinates.positions[uuid]
         next if detached?(position)
 
         column = position[:column]
@@ -251,8 +258,9 @@ module MetadataPresenter
     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.
+    # and arrow. When there are 'OR' conditions we need to insert additional
+    # 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|
         next if coordinates.uuid_column(branch.uuid).nil?
@@ -273,46 +281,21 @@ module MetadataPresenter
     # Include a warning if a service does not have a CYA or Confirmation page in the
     # main flow. The warning should always be in the first row, last column.
     def insert_warning
-      if cya_and_confirmation_pages_not_in_service? ||
-          cya_and_confirmation_pages_detached?
-        @ordered.append([MetadataPresenter::Warning.new])
-      end
-    end
-
-    def cya_and_confirmation_pages_not_in_service?
-      (checkanswers_not_in_service? && confirmation_not_in_service?) ||
-        checkanswers_not_in_service? ||
-        confirmation_not_in_service?
+      @ordered.append([MetadataPresenter::Warning.new]) if show_warning?
     end
 
-    def checkanswers_not_in_service?
-      service.checkanswers_page.blank?
+    def checkanswers_warning
+      MetadataPresenter::PageWarning.new(
+        page: service.checkanswers_page,
+        main_flow_uuids: flow_uuids
+      )
     end
 
-    def confirmation_not_in_service?
-      service.confirmation_page.blank?
-    end
-
-    def cya_and_confirmation_pages_detached?
-      (checkanswers_detached? && confirmation_detached?) ||
-        checkanswers_detached? ||
-        confirmation_detached?
-    end
-
-    def checkanswers_detached?
-      if service.checkanswers_page.present?
-        uuid = service.checkanswers_page.uuid
-        position = coordinates.position(uuid)
-        detached?(position)
-      end
-    end
-
-    def confirmation_detached?
-      if service.confirmation_page.present?
-        uuid = service.confirmation_page.uuid
-        position = coordinates.position(uuid)
-        detached?(position)
-      end
+    def confirmation_warning
+      MetadataPresenter::PageWarning.new(
+        page: service.confirmation_page,
+        main_flow_uuids: flow_uuids
+      )
     end
 
     # Any destinations exiting the branch that have not already been traversed.

data/app/models/metadata_presenter/page_warning.rb

@@ -0,0 +1,24 @@
+module MetadataPresenter
+  class PageWarning
+    def initialize(page:, main_flow_uuids:)
+      @page = page
+      @main_flow_uuids = main_flow_uuids
+    end
+
+    def show_warning?
+      missing? || detached?
+    end
+
+    def missing?
+      page.blank?
+    end
+
+    def detached?
+      main_flow_uuids.exclude?(page&.uuid)
+    end
+
+    private
+
+    attr_reader :page, :main_flow_uuids
+  end
+end

data/app/models/metadata_presenter/row_number.rb

@@ -1,7 +1,5 @@
 module MetadataPresenter
   class RowNumber
-    include BranchDestinations
-
     def initialize(uuid:, route:, current_row:, coordinates:, service:)
       @uuid = uuid
       @route = route
@@ -13,53 +11,83 @@ module MetadataPresenter
     ROW_ZERO = 0
 
     def number
-      return route.row if first_row? && existing_row.nil?
-
-      return ROW_ZERO if place_on_row_zero?
+      if service.flow_object(uuid).branch?
+        coordinates.set_branch_spacers_row(uuid, calculated_row)
+      end
 
-      [current_row, existing_row, potential_row].compact.max
+      calculated_row
     end
 
     private
 
     attr_reader :uuid, :route, :current_row, :coordinates, :service
 
+    def calculated_row
+      @calculated_row ||= begin
+        return route.row if first_row? && existing_row.nil?
+
+        return ROW_ZERO if place_on_row_zero?
+
+        existing_row || [current_row, potential_row, branch_spacer_row].compact.max
+      end
+    end
+
     def existing_row
       @existing_row ||= coordinates.uuid_row(uuid)
     end
 
+    # This looks for any branches in the current column and checks that there is
+    # enough space for the any branch conditionals before returning a row number.
     def potential_row
-      return unless object_above.branch? && uuid != object_above.uuid
+      return if branches_in_column.empty?
 
-      coordinates.uuid_row(object_above.uuid) + number_of_destinations
+      row_numbers = branches_in_column.map do |branch_uuid, _|
+        coordinates.branch_spacers[branch_uuid].map { |_, position| position[:row] }
+      end
+      row_numbers.flatten.max + 1
+    end
+
+    # This looks at the previous column and finds any branches that link to the
+    # current object. If any are found it checks for rows numbers that relate
+    # to the current objects UUID in the branch spacers hash and defaults to
+    # returning the highest row number.
+    def branch_spacer_row
+      return if spacers_for_current_object.empty?
+
+      spacers_for_current_object.map { |position| position[:row] }.max
     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_number_for_object_above)
-        )
+    def branches_in_column
+      @branches_in_column ||= branches(uuid_column)
     end
 
-    def row_number_for_object_above
-      column_objects.map { |_, p| p[:row] if p[:row] < current_row }.compact.max.to_i
+    def branches_in_previous_column
+      @branches_in_previous_column ||= branches(uuid_column - 1)
     end
 
-    def column_objects
-      objects_in_column = coordinates.positions_in_column(uuid_column).reject do |u, p|
-        u == uuid || p[:row].nil?
+    def branches(column_number)
+      coordinates.positions_in_column(column_number).select do |key, position|
+        next if uuid == key || position[:row].blank?
+
+        service.flow_object(key).branch?
       end
-      objects_in_column.sort_by { |_, p| p[:row] }
     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
+    def spacers_for_current_object
+      @spacers_for_current_object ||= begin
+        spacer_positions = branches_in_previous_column.select do |key, _|
+          coordinates.branch_spacers[key]
+        end
+
+        current_object_spacers = spacer_positions.map do |branch_uuid, _|
+          coordinates.branch_spacers[branch_uuid][uuid]
+        end
+        current_object_spacers.compact
+      end
     end
 
     def uuid_column

data/fixtures/branching_10.json

@@ -1202,7 +1202,7 @@
   "created_by": "30b04817-8997-43ac-8f34-2ad817a966ea",
   "service_id": "14959589-1731-404d-a4c4-c3e8d85ed22c",
   "version_id": "7279554f-2d0a-4eec-b168-a0156d980bd2",
-  "service_name": "Branching 10 ",
+  "service_name": "Branching Fixture 10 ",
   "configuration": {
     "meta": {
       "_id": "config.meta",