metadata_presenter 2.10.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e03698bc80c7779212a57aaa9bbca97b5567025b950a6a6b7170fb635745e3e0
-  data.tar.gz: 7c3eca3a9da18aa6001791d2c5def0abacbf95b8b9baeb2be8920df804734bdd
+  metadata.gz: 92db6bbc2b6ecefe9836a96c3014b94cc43c48a2fb4e82152f71bea00d6b3bc4
+  data.tar.gz: f9a2d946f0bf343f4a20f943f2aed35d3fce8ddbc42cf28997b10f10bfa3f9ba
 SHA512:
-  metadata.gz: a6dedb4d4413eab6222933b8096bf45c6fef7db7d51853e1a46ecaf51f4b718362bbe00776f5adfc3b3687dcf10fb6660b289d9dc930768dadfa5dc1bfbda1b9
-  data.tar.gz: c822f36b904e46fd6075979dd3acca19ed1e91ddcf73a5adf93ca4ad261e2da5e5507866fe890641c116ecb4695e25b16281fd5aa54304b7328b50b5a4d55b34
+  metadata.gz: 4b94a4afee1f43a692360645775bb5555c3c722f93a5c1f2c0cb865af90e43448d5eb1bab458eb022c49d76a39348497f2946ca925afdf11fd8ed5f8749ef0f4
+  data.tar.gz: 10ad22eada3869215e8d7ef9e00dc578468d142b7c3d151c9ba8590ad001101570e317f1b7b1f2dd5343572608ba4e1464383f8c57acbb317aa160cd2ab85157

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,21 @@
+module MetadataPresenter
+  class ColumnNumber
+    def initialize(uuid:, coordinates:, new_column:)
+      @uuid = uuid
+      @coordinates = coordinates
+      @new_column = new_column
+    end
+
+    def number
+      [existing_column, new_column].compact.max
+    end
+
+    private
+
+    attr_reader :uuid, :coordinates, :new_column
+
+    def existing_column
+      @coordinates.uuid_column(uuid)
+    end
+  end
+end

data/app/models/metadata_presenter/coordinates.rb

@@ -0,0 +1,51 @@
+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 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

@@ -11,7 +11,14 @@ module MetadataPresenter
     end
   end
 
+  class Warning < OpenStruct
+    def type
+      'flow.warning'
+    end
+  end
+
   class Grid
+    include BranchDestinations
     attr_reader :start_from
 
     def initialize(service, start_from: nil, main_flow: [])
@@ -21,7 +28,7 @@ module MetadataPresenter
       @ordered = []
       @routes = []
       @traversed = []
-      @coordinates = setup_coordinates
+      @coordinates = MetadataPresenter::Coordinates.new(service.flow)
     end
 
     ROW_ZERO = 0
@@ -30,19 +37,20 @@ 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?
       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 { |obj| obj.is_a?(MetadataPresenter::Spacer) || obj.is_a?(MetadataPresenter::Warning) }
     end
 
     def ordered_pages
@@ -62,10 +70,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 +87,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,29 +130,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|
-        next if @traversed.include?(route.traverse_from)
+        next if @traversed.include?(route.traverse_from) && appears_later_in_flow?(route)
 
+        current_row = route.row
         route.flow_uuids.each do |uuid|
-          @coordinates[uuid][:row] = route.row if @coordinates[uuid][:row].nil?
+          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) 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
@@ -161,10 +188,14 @@ 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)
+        column = position[:column]
+        row = position[:row]
+        insert_spacer(column, row) if occupied?(column, row, uuid)
+        @ordered[column][row] = get_flow_object(uuid)
       end
     end
 
@@ -172,6 +203,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)
@@ -219,37 +255,70 @@ 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_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
+        next if coordinates.uuid_column(branch.uuid).nil?
 
-          uuids.push(uuid) unless uuids.include?(uuid)
+        previous_uuid = ''
+        next_column = coordinates.uuid_column(branch.uuid) + 1
+        exiting_destinations_from_branch(branch).each_with_index do |uuid, row|
+          insert_spacer(next_column, row) if uuid == previous_uuid
+          previous_uuid = 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
+    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.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
-      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,82 @@
+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?
+
+      [current_row, existing_row, potential_row].compact.max
+    end
+
+    private
+
+    attr_reader :uuid, :route, :current_row, :coordinates, :service
+
+    def existing_row
+      @existing_row ||= coordinates.uuid_row(uuid)
+    end
+
+    def potential_row
+      return unless object_above.branch? && uuid != object_above.uuid
+
+      coordinates.uuid_row(object_above.uuid) + number_of_destinations
+    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)
+        )
+    end
+
+    def row_number_for_object_above
+      column_objects.map { |_, p| p[:row] if p[:row] < current_row }.compact.max.to_i
+    end
+
+    def column_objects
+      objects_in_column = coordinates.positions_in_column(uuid_column).reject do |u, p|
+        u == uuid || p[:row].nil?
+      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
+    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.
+    # 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/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