metadata_presenter 2.9.0 → 2.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2456166b18ccc3e41ec5387fc88a53643c6ae377caf938c5f30c14684ba5f7aa
-  data.tar.gz: 15503786a56b715ba5001288e3f75bb98a06eeafc0629eba3eb4b7d1df420c3c
+  metadata.gz: 8a349beb4173c1f6361b321a95e36a407c5f5361153403cae2fbd15ffb7b8840
+  data.tar.gz: 8e06745f55b04f1074a5da27b77e4f9cb720b95bfb328672c14cca059e4a3003
 SHA512:
-  metadata.gz: 542588576d0a629d453e7172340bdb5a6e4b5db091f9a48f7f8e058eec3a143cedc22d1da744580078636d17902302ef100d0e7acaa54eeff3ad82ff792f44c7
-  data.tar.gz: 271167513a3fda4ec24f93e0b07137902c30fd6fbac05fc7fe3683422fb0fdbd8a4c6a34fd0fe5fbf797543a855fca236160e63233beae0b4fd902b8ff553d05
+  metadata.gz: 01f7f93e1b0d7a058ff856cb27ce07ec816b060e2b2299cec55be298aa046809a9e9ba82f9f770205b4fe647a8d3e046e1a0b10afad0a78fc5190e52aa28fc5f
+  data.tar.gz: 5cb518f2fb78f26ae06d447d0d1a7a7f2b84de9b4f24057079464bdcd77945c36430c4718c49d1bc2a04ec48ab1cfb422fbfc02c952a516ca83d7cae3e29a2ff

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

@@ -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,10 +181,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
 
@@ -173,6 +196,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)
@@ -202,12 +230,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 +248,25 @@ 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
-      end
-      destination_uuids.flatten
+    def insert_spacer(column, row)
+      @ordered[column].insert(row, MetadataPresenter::Spacer.new)
     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)