metadata_presenter 2.11.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cca8a3428e516ba176e5a898a1d1a76cd57fa836041f0c3fc492a8cd394e88a
-  data.tar.gz: 9940b709ccce5e211444fe6b7cf84dfeed78f1c13591c9291b797a3eca4ac609
+  metadata.gz: 42603519130d7f5029066830adc145fe8800465f38493f5acfe37943623210b9
+  data.tar.gz: 9cb6b248e8246c2b0145f6d746043680494fd7292a36d2e18dff619cf55af8dc
 SHA512:
-  metadata.gz: 1b9c3ae006ca76d0386db74a2fb39d106884dc0cd285457c05be6f3d3f75e2a30cc79511112d3881c532ba7e6e3c087e5e83e4116a708cf3cd81b4ea345de813
-  data.tar.gz: 659da027fb5c27df2c007dfd961bfce0148879aec3833f72c53f4d195080bde041b29c53260c397430e5425383a2c7a364e1ed8fd4d22bbabdb33417ecb896ed
+  metadata.gz: 354e08330a417e94180c4686e058eac97155e2b62440faabdf1e10b17d469d2e7b93a0fd155d5d3eeb71549f2fc6725c78e048ac442c5a5b6dfeaae3f81c09e9
+  data.tar.gz: 22011caef879554eb407f7bbda3726b5255178eb51b15e095c3409ec84f97df6ed565382f51651801f0ee9686b895ffc1db92ee9f4e715baa957e4378b88eee9

data/app/models/metadata_presenter/column_number.rb

@@ -1,25 +1,42 @@
 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?
+        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,43 @@ 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.map { { row: nil, column: nil } }
+      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,48 +11,56 @@ 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].compact.max
+      end
+    end
+
     def existing_row
       @existing_row ||= coordinates.uuid_row(uuid)
     end
 
+    def potential_row
+      return if branches_in_column.empty?
+
+      row_numbers = branches_in_column.map do |uuid, _|
+        coordinates.branch_spacers[uuid].map { |position| position[:row] }
+      end
+      row_numbers.flatten.max + 1
+    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
+    def branches_in_column
+      @branches_in_column ||= coordinates.positions_in_column(uuid_column).select do |key, position|
+        next if uuid == key || position[:row].blank?
 
-    # Takes into account the 'or' type of conditionals which requires an
-    # additional spacer
-    def number_of_destinations
-      exiting_destinations_from_branch(object_above).count
+        service.flow_object(key).branch?
+      end
     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.

data/app/models/metadata_presenter/service.rb

@@ -38,7 +38,7 @@ class MetadataPresenter::Service < MetadataPresenter::Metadata
   end
 
   def service_slug
-    service_name.parameterize
+    service_name.gsub(/['’]/, '').parameterize
   end
 
   def find_page_by_url(url)
@@ -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",