metadata_presenter 2.12.0 → 2.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 120ed63601d40a759fe3176e0555341c7cc7220cc1bac5a87cf58d5989d670fa
-  data.tar.gz: 84e748f9388d3208ade3db02f37f662e8ab4e7fca1aef8488411dd05dabe6a93
+  metadata.gz: b7184f97740de68d7fb003316d4d2bc5a822ccdfa13749c858b638b64b7f59e6
+  data.tar.gz: 6d540b23868160de18de5c3ef87c5a9ef2f7ecc279ed72e4e2c9ab5bb3c0369d
 SHA512:
-  metadata.gz: 2bd170ba65c91f723ada48baff42bd90228cbf22f5aaa56eb158203b3f497037635bdeaf8e17f760556ad6bf55fb6ed922727c2bae9914e6f9e81cad54d708da
-  data.tar.gz: 8045ff1fe8a8366bedc081a4864687e7da1f56119ca71285f03bb3457787c9644513e8f54195b5fc6feb8cdbb3fc6d899bbf86b683109f910235e81a01288a05
+  metadata.gz: 10c4c37e567f4b1c58546627c480ceda59a1c65bdafeacf65014c044a380a03a7f22f40180674054f5614adc742fd95aca4624b6d8a1af3ac2158b96a0ebbac0
+  data.tar.gz: 3eb7004878552017ce8c9e180675330d824461234ad410f11384b788eeb5ab46a480526020a7edf4efd6ece8d1f7588d0cfd2ed3561fe9270d2c936717072b4b

data/app/models/metadata_presenter/column_number.rb

@@ -1,25 +1,46 @@
 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
-      use_new_column? ? new_column : existing_column
+      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 use_new_column?
-      existing_column.nil? || new_column > existing_column
+    def cya_or_confirmation_page?
+      [service.checkanswers_page&.uuid, service.confirmation_page&.uuid].include?(uuid)
     end
 
     def existing_column
-      @existing_column ||= @coordinates.uuid_column(uuid)
+      @coordinates.uuid_column(uuid)
     end
   end
 end

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,29 +34,45 @@ module MetadataPresenter
       end
     end
 
-    def position(uuid)
-      positions[uuid]
+    def positions_in_column(column_number)
+      positions.select { |_, position| position[:column] == column_number }
     end
 
-    def occupied?(column, row, new_object_uuid)
-      positions.any? do |uuid, position|
-        position[:column] == column &&
-          position[:row] == row &&
-          new_object_uuid != uuid
+    def set_branch_spacers_column(branch_uuid, column)
+      branch_spacers[branch_uuid].each do |_, position|
+        position[:column] = column
       end
     end
 
-    def positions_in_column(column_number)
-      positions.select { |_, position| position[:column] == column_number }
+    # 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

@@ -11,6 +11,12 @@ module MetadataPresenter
     end
   end
 
+  class Warning < OpenStruct
+    def type
+      'flow.warning'
+    end
+  end
+
   class Grid
     include BranchDestinations
     attr_reader :start_from
@@ -22,7 +28,7 @@ module MetadataPresenter
       @ordered = []
       @routes = []
       @traversed = []
-      @coordinates = MetadataPresenter::Coordinates.new(service.flow)
+      @coordinates = MetadataPresenter::Coordinates.new(service)
     end
 
     ROW_ZERO = 0
@@ -37,13 +43,16 @@ module MetadataPresenter
       insert_expression_spacers
       trim_pointers unless main_flow.empty?
       trim_spacers
+      insert_warning if main_flow.empty?
 
       @ordered = @ordered.reject(&:empty?)
     end
 
     def ordered_flow
       @ordered_flow ||=
-        build.flatten.reject { |obj| obj.is_a?(MetadataPresenter::Spacer) }
+        build.flatten.reject do |obj|
+          obj.is_a?(MetadataPresenter::Spacer) || obj.is_a?(MetadataPresenter::Warning)
+        end
     end
 
     def ordered_pages
@@ -129,7 +138,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
@@ -182,10 +192,13 @@ module MetadataPresenter
 
     def add_by_coordinates
       service.flow.each_key do |uuid|
-        position = coordinates.position(uuid)
+        position = coordinates.positions[uuid]
         next if detached?(position)
 
-        @ordered[position[:column]][position[:row]] = get_flow_object(uuid)
+        column = position[:column]
+        row = position[:row]
+        insert_spacer(column, row) if occupied?(column, row, uuid)
+        @ordered[column][row] = get_flow_object(uuid)
       end
     end
 
@@ -193,6 +206,11 @@ module MetadataPresenter
       position[:row].nil? || position[:column].nil?
     end
 
+    def occupied?(column, row, uuid)
+      object = @ordered[column][row]
+      object.is_a?(MetadataPresenter::Flow) && object.uuid != uuid
+    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)
@@ -236,8 +254,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?
@@ -245,14 +264,61 @@ module MetadataPresenter
         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
+          insert_spacer(next_column, row) if uuid == previous_uuid
           previous_uuid = uuid
         end
       end
     end
 
+    def insert_spacer(column, row)
+      @ordered[column].insert(row, MetadataPresenter::Spacer.new)
+    end
+
+    # 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?
+    end
+
+    def checkanswers_not_in_service?
+      service.checkanswers_page.blank?
+    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.positions[uuid]
+        detached?(position)
+      end
+    end
+
+    def confirmation_detached?
+      if service.confirmation_page.present?
+        uuid = service.confirmation_page.uuid
+        position = coordinates.positions[uuid]
+        detached?(position)
+      end
+    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

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,46 +11,87 @@ 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 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
+      if service.flow_object(uuid).branch?
+        coordinates.set_branch_spacers_row(uuid, calculated_row)
       end
+
+      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 if branches_in_column.empty?
+
+      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_above))
+    def branches_in_column
+      @branches_in_column ||= branches(uuid_column)
     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 branches_in_previous_column
+      @branches_in_previous_column ||= branches(uuid_column - 1)
     end
 
-    def uuid_column
-      @uuid_column ||= coordinates.uuid_column(uuid)
+    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
     end
 
-    def row_above
-      @row_above ||= route.row - 1
+    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
+      @uuid_column ||= coordinates.uuid_column(uuid)
     end
 
     # If an object has already been positioned on row 0 then leave it there.

data/app/models/metadata_presenter/service.rb

@@ -60,6 +60,12 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
     end
   end
 
+  def checkanswers_page
+    @checkanswers_page ||= pages.find do |page|
+      page.type == 'page.checkanswers'
+    end
+  end
+
   def meta
     MetadataPresenter::Meta.new(configuration['meta'])
   end

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",