metadata_presenter 2.15.6 → 2.15.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 317f9738775d4f54ec39b2a26022a7d10849ea62f9dbe11a5d3438f934fe68a6
-  data.tar.gz: a06c2f83f04f48dfce34b257bbade85f4ebc1600b277391583689a2e8989dbfd
+  metadata.gz: 53b941c0d91360e25ea0fbe443046805d760416cc4c345813fe44ade9dca178e
+  data.tar.gz: 4c7e831b1cad1f8d8587e30196cb99d980463addd0b7451f54511cfe7e688603
 SHA512:
-  metadata.gz: ffd0e8343e0cdc239992f13703f180bfb9ca0a956e777ffb035ad59bdd302453aae62d3f67d8107cb9fc22d54a5d81b7a661d102a9e556fad6daf3933adf9d20
-  data.tar.gz: 2c4e98e7c2890061e4e3a9f34a7b337e22fdf3c2aceda4da7d52b7f46818098d72f02ac4080b381cda115bd4c63295ad110a86c41025a9fb0f94b330130e8e10
+  metadata.gz: a6188728e5ee91a652462c9abea6ff0900c2393549a8544f4c7ec5b72d7723d99ee69b2a6cb1bd0d9027756175966cc561bce28e3100d50a1fa93a349a3d6f7c
+  data.tar.gz: b861587b148d28738d7ffe62bf83aad31305b6962fba31f4bea910d8b0023cc61e2ea3ccece69c323f72deee065e7437530658328e98acef3569b0d663a4f539

data/app/models/metadata_presenter/branch_destinations.rb

@@ -14,5 +14,9 @@ module MetadataPresenter
       end
       destination_uuids.flatten.push(branch.default_next)
     end
+
+    def has_or_conditionals?(branch)
+      branch.conditionals.any? { |c| c.type == 'or' }
+    end
   end
 end

data/app/models/metadata_presenter/column_number.rb

@@ -25,18 +25,35 @@ module MetadataPresenter
 
     def column_number
       @column_number ||= begin
-        return latest_column if cya_or_confirmation_page?
+        return last_column if confirmation_page?
+        return latest_column if checkanswers_page?
 
         existing_column || new_column
       end
     end
 
+    def confirmation_page?
+      service.confirmation_page&.uuid == uuid
+    end
+
+    def checkanswers_page?
+      service.checkanswers_page&.uuid == uuid
+    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)
+    def last_column
+      checkanswers_column.present? ? checkanswers_column + 1 : latest_column
+    end
+
+    def checkanswers_column
+      @checkanswers_column ||= begin
+        return if service.checkanswers_page.blank?
+
+        coordinates.uuid_column(service.checkanswers_page&.uuid)
+      end
     end
 
     def existing_column

data/app/models/metadata_presenter/coordinates.rb

@@ -39,7 +39,7 @@ module MetadataPresenter
     end
 
     def set_branch_spacers_column(branch_uuid, column)
-      branch_spacers[branch_uuid].each do |_, position|
+      branch_spacers[branch_uuid].each do |position|
         position[:column] = column
       end
     end
@@ -50,7 +50,7 @@ module MetadataPresenter
     # 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|
+      branch_spacers[branch_uuid].each.with_index(starting_row) do |position, row|
         position[:row] = row
       end
     end
@@ -68,11 +68,15 @@ module MetadataPresenter
     # 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
+        hash[branch.uuid] = initial_spacer(branch)
+      end
+    end
+
+    def initial_spacer(branch)
+      destinations = exiting_destinations_from_branch(branch).map do |uuid|
+        { uuid: uuid, row: nil, column: nil }
       end
+      has_or_conditionals?(branch) ? destinations.uniq : destinations
     end
   end
 end

data/app/models/metadata_presenter/grid.rb

@@ -41,7 +41,7 @@ module MetadataPresenter
       set_row_numbers
       add_by_coordinates
       insert_expression_spacers
-      trim_pointers unless main_flow.empty?
+      trim_pointers unless main_flow.empty? # only used by detached grids
       trim_spacers
       insert_warning if main_flow.empty?
 
@@ -222,9 +222,42 @@ module MetadataPresenter
       service.flow_object(uuid)
     end
 
+    def trim_pointers
+      update_branch_destination_pointers
+      trim_to_first_pointer
+      update_coordinates
+      replace_pointers
+    end
+
+    # Since a detached grid is built in the same way as the main flow grid, objects
+    # that appear later in the flow are left in their latest position. However
+    # for detached grids we want to show a Pointer to that object. This only
+    # happens for branch destinations so in those instances we need to replace
+    # the Spacers with Pointers.
+    def update_branch_destination_pointers
+      @ordered.each_with_index do |column, column_number|
+        next_column = column_number + 1
+
+        column.each do |flow_object|
+          next unless flow_object.branch?
+
+          coordinates.branch_spacers[flow_object.uuid].map do |destination|
+            if replace_with_pointer?(next_column, destination[:row], destination[:uuid])
+              @ordered[next_column][destination[:row]] = MetadataPresenter::Pointer.new(uuid: destination[:uuid])
+            end
+          end
+        end
+      end
+    end
+
+    def replace_with_pointer?(column_number, row_number, destination_uuid)
+      @ordered[column_number][row_number].is_a?(MetadataPresenter::Spacer) &&
+        main_flow.include?(destination_uuid)
+    end
+
     # A row should end at the first Pointer object it finds.
     # Therefore replace any Pointers after the first one with Spacers.
-    def trim_pointers
+    def trim_to_first_pointer
       max_potential_rows.times do |row|
         first_index_of = first_pointer(row)
         next unless first_index_of
@@ -237,8 +270,70 @@ module MetadataPresenter
     end
 
     def first_pointer(row)
-      row_objects = @ordered.map { |column| column[row] }
-      row_objects.find_index { |obj| obj.is_a?(MetadataPresenter::Pointer) }
+      row_objects(row).find_index { |obj| obj.is_a?(MetadataPresenter::Pointer) }
+    end
+
+    def row_objects(row)
+      @ordered.map { |column| column[row] }
+    end
+
+    # It's a shame to have to do this.
+    # Once the Pointers have been trimmed back the original positions for each
+    # object will no longer be correct so we need to update them.
+    # We only really need to do this because we replace Pointers with Spacers
+    # later on.
+    def update_coordinates
+      @ordered.each_with_index do |column, column_number|
+        column.each_with_index do |flow_object, row_number|
+          next if flow_object.is_a?(MetadataPresenter::Spacer)
+
+          @coordinates.set_column(flow_object.uuid, column_number)
+          @coordinates.set_row(flow_object.uuid, row_number)
+        end
+      end
+    end
+
+    def replace_pointers
+      @ordered.each_with_index do |column, column_number|
+        next if column_number.zero?
+
+        column.each_with_index do |flow_object, row_number|
+          next if flow_object.is_a?(MetadataPresenter::Spacer)
+
+          previous_column = column_number - 1
+          if replace_with_spacer?(previous_column, column_number, row_number, flow_object.uuid)
+            @ordered[column_number][row_number] = MetadataPresenter::Spacer.new
+          end
+        end
+      end
+    end
+
+    def replace_with_spacer?(previous_column, current_column, row_number, uuid)
+      no_flow_objects?(previous_column, row_number, uuid) ||
+        at_different_position?(current_column, row_number, uuid)
+    end
+
+    # Unless the destination is the Pointer for a branch in the directly preceeding
+    # column, we want to swap Pointers for Spacers if there are no Flow objects
+    # in that row.
+    def no_flow_objects?(previous_column, row_number, uuid)
+      !branch_destination?(uuid, previous_column) &&
+        row_objects(row_number).none?(MetadataPresenter::Flow)
+    end
+
+    # The object already exists elsewhere in the flow so we can replace the Pointer
+    # and let the frontend draw an arrow to that position.
+    def at_different_position?(column_number, row_number, uuid)
+      @coordinates.uuid_column(uuid) != column_number &&
+        @coordinates.uuid_row(uuid) != row_number
+    end
+
+    def branch_destination?(uuid, column_number)
+      @ordered[column_number].any? do |flow_object|
+        next unless flow_object.branch?
+
+        flow_object.all_destination_uuids.include?(uuid)
+      end
     end
 
     # Find the very last MetadataPresenter::Flow object in every column and
@@ -254,17 +349,20 @@ module MetadataPresenter
     end
 
     def only_spacers?(trimmed_column)
-      trimmed_column.all? { |item| item.is_a?(MetadataPresenter::Spacer) }
+      trimmed_column.all?(MetadataPresenter::Spacer)
     end
 
     # Each branch has a certain number of exits that require their own line
     # 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.
+    # This is done for the column directly after a branching point
     def insert_expression_spacers
       service.branches.each do |branch|
         next if coordinates.uuid_column(branch.uuid).nil?
 
+        next unless has_or_conditionals?(branch)
+
         previous_uuid = ''
         next_column = coordinates.uuid_column(branch.uuid) + 1
         exiting_destinations_from_branch(branch).each_with_index do |uuid, row|

data/app/models/metadata_presenter/row_number.rb

@@ -42,7 +42,7 @@ module MetadataPresenter
       return if branches_in_column.empty?
 
       row_numbers = branches_in_column.map do |branch_uuid, _|
-        coordinates.branch_spacers[branch_uuid].map { |_, position| position[:row] }
+        coordinates.branch_spacers[branch_uuid].map { |position| position[:row] }
       end
       row_numbers.flatten.max + 1
     end
@@ -54,7 +54,7 @@ module MetadataPresenter
     def branch_spacer_row
       return if spacers_for_current_object.empty?
 
-      spacers_for_current_object.map { |position| position[:row] }.max
+      spacers_for_current_object.flatten.map { |position| position[:row] }.max
     end
 
     def first_row?
@@ -84,7 +84,7 @@ module MetadataPresenter
         end
 
         current_object_spacers = spacer_positions.map do |branch_uuid, _|
-          coordinates.branch_spacers[branch_uuid][uuid]
+          coordinates.branch_spacers[branch_uuid].select { |branch_spacer| branch_spacer[:uuid] == uuid }
         end
         current_object_spacers.compact
       end

data/fixtures/branching_10.json

@@ -120,7 +120,7 @@
     },
     "79c18654-7ecb-43f9-bd7f-0b09eb9c075e": {
       "next": {
-        "default": "da2576f9-7ddd-4316-b24b-103708139214"
+        "default": "1314e473-9096-4434-8526-03a7b4b7b132"
       },
       "_type": "flow.page"
     },
@@ -219,28 +219,15 @@
       "next": {
         "default": "7742dfcc-db2e-480b-9071-294fbe1769a2",
         "conditionals": [
-          {
-            "next": "1314e473-9096-4434-8526-03a7b4b7b132",
-            "_type": "if",
-            "_uuid": "0bdc8fde-be62-4945-8496-854e867a665d",
-            "expressions": [
-              {
-                "page": "4e54ed97-d0df-462e-9a88-fd0f23ea62f5",
-                "field": "3b56e4a0-a850-4e50-a394-95a895465e26",
-                "operator": "is",
-                "component": "3c2c14a4-75db-459a-b11e-34e1972a45f2"
-              }
-            ]
-          },
           {
             "next": "da2576f9-7ddd-4316-b24b-103708139214",
             "_type": "if",
-            "_uuid": "4ad9f7e9-5444-41d8-b7f8-17d2108ed27a",
+            "_uuid": "cd28e391-bdc6-47ce-8a07-24a4642432dc",
             "expressions": [
               {
                 "page": "4e54ed97-d0df-462e-9a88-fd0f23ea62f5",
-                "field": "951ca999-8616-4626-adb2-d604f27262a5",
-                "operator": "is",
+                "field": "3b56e4a0-a850-4e50-a394-95a895465e26",
+                "operator": "is_answered",
                 "component": "3c2c14a4-75db-459a-b11e-34e1972a45f2"
               }
             ]
@@ -358,8 +345,8 @@
       "before_you_start": "###Before you start\r\nYou can also register by post.\r\n\r\nThe online service is also available in Welsh (Cymraeg).\r\n\r\nYou cannot register for this service if you’re in the UK illegally."
     },
     {
-      "_id": "page.thisisareallylongnamethatshouldcauseavisualissue",
-      "url": "thisisareallylongnamethatshouldcauseavisualissue",
+      "_id": "page.page-a",
+      "url": "page-a",
       "body": "Body section",
       "lede": "",
       "_type": "page.singlequestion",
@@ -367,9 +354,9 @@
       "heading": "",
       "components": [
         {
-          "_id": "thisisareallylongnamethatshouldcauseavisualissue_text_1",
+          "_id": "page-a_text_1",
           "hint": "",
-          "name": "thisisareallylongnamethatshouldcauseavisualissue_text_1",
+          "name": "page-a_text_1",
           "_type": "text",
           "_uuid": "bcedde64-8996-4911-9426-fafaf91008e0",
           "label": "Page A",
@@ -405,7 +392,7 @@
               "name": "page-b_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "4fb4f5ac-8337-48f6-87ee-2062f4ce1b4d",
-              "label": "Option 1",
+              "label": "Page B Option 1",
               "value": "value-1",
               "errors": {
               },
@@ -421,7 +408,7 @@
               "name": "page-b_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "c074548d-22a7-4339-9bfe-383741b04c79",
-              "label": "Option 2",
+              "label": "Page B Option 2",
               "value": "value-2",
               "errors": {
               },
@@ -437,7 +424,7 @@
               "name": "page-b_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "4132af6c-bd4d-4734-956b-05ec414c6dcc",
-              "label": "Option 3",
+              "label": "Page B Option 3",
               "value": "value-3",
               "errors": {
               },
@@ -559,7 +546,7 @@
               "name": "page-f_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "56febb54-3b06-417a-98b7-51c19e10631b",
-              "label": "Option A",
+              "label": "Page F Option A",
               "value": "value-1",
               "errors": {
               },
@@ -575,7 +562,7 @@
               "name": "page-f_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "e495f6b3-a7e6-405e-85a3-cba4119f0507",
-              "label": "Option B",
+              "label": "Page F Option B",
               "value": "value-2",
               "errors": {
               },
@@ -591,7 +578,7 @@
               "name": "page-f_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "b5e9d16c-0699-4f16-9c75-906b22599e20",
-              "label": "Option C",
+              "label": "Page F Option C",
               "value": "value-3",
               "errors": {
               },
@@ -607,7 +594,7 @@
               "name": "page-f_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "89856dbf-7412-45c7-b5e1-dcaf8e810cdd",
-              "label": "Option D",
+              "label": "Page F Option D",
               "value": "value-4",
               "errors": {
               },
@@ -781,7 +768,7 @@
               "name": "page-i_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "98f181fb-530e-4002-8204-3b89b37fefad",
-              "label": "Option 1",
+              "label": "Page I Option 1",
               "value": "value-1",
               "errors": {
               },
@@ -797,7 +784,7 @@
               "name": "page-i_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "99249f5e-c238-46b9-b447-03272c284a40",
-              "label": "Option 2",
+              "label": "Page I Option 2",
               "value": "value-2",
               "errors": {
               },
@@ -813,7 +800,7 @@
               "name": "page-i_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "66823323-7df7-4a44-9d3b-0397af465dce",
-              "label": "Option 3",
+              "label": "Page I Option 3",
               "value": "value-3",
               "errors": {
               },
@@ -857,7 +844,7 @@
               "name": "page-j_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "3b56e4a0-a850-4e50-a394-95a895465e26",
-              "label": "Option 1",
+              "label": "Page J Option 1",
               "value": "value-1",
               "errors": {
               },
@@ -873,7 +860,7 @@
               "name": "page-j_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "951ca999-8616-4626-adb2-d604f27262a5",
-              "label": "Option 2",
+              "label": "Page J Option 2",
               "value": "value-2",
               "errors": {
               },
@@ -889,7 +876,7 @@
               "name": "page-j_checkboxes_1",
               "_type": "checkbox",
               "_uuid": "478152c5-73d1-4359-bc15-01e069fe2490",
-              "label": "Option 3",
+              "label": "Page J Option 3",
               "value": "value-3",
               "errors": {
               },
@@ -902,10 +889,10 @@
           ],
           "errors": {
           },
-          "legend": "Page J",
+          "legend": "Page J (Optional)",
           "collection": "components",
           "validation": {
-            "required": true
+            "required": false
           }
         }
       ],
@@ -1198,10 +1185,10 @@
     }
   ],
   "locale": "en",
-  "created_at": "2021-12-03T11:57:21Z",
-  "created_by": "30b04817-8997-43ac-8f34-2ad817a966ea",
-  "service_id": "14959589-1731-404d-a4c4-c3e8d85ed22c",
-  "version_id": "7279554f-2d0a-4eec-b168-a0156d980bd2",
+  "created_at": "2022-02-02T12:32:13Z",
+  "created_by": "b7eff904-9fec-4c48-b6ac-4572b490a040",
+  "service_id": "e68dca75-20b8-468e-9436-e97791a914c5",
+  "version_id": "195ea111-9d4c-4176-837d-0d751c37bbcd",
   "service_name": "Branching Fixture 10 ",
   "configuration": {
     "meta": {

data/fixtures/branching_9.json

@@ -281,8 +281,8 @@
       "before_you_start": "###Before you start\r\nYou can also register by post.\r\n\r\nThe online service is also available in Welsh (Cymraeg).\r\n\r\nYou cannot register for this service if you’re in the UK illegally."
     },
     {
-      "_id": "page.thisisareallylongnamethatshouldcauseavisualissue",
-      "url": "thisisareallylongnamethatshouldcauseavisualissue",
+      "_id": "page.page-a",
+      "url": "page-a",
       "body": "Body section",
       "lede": "",
       "_type": "page.singlequestion",
@@ -290,9 +290,9 @@
       "heading": "",
       "components": [
         {
-          "_id": "thisisareallylongnamethatshouldcauseavisualissue_text_1",
+          "_id": "page-a_text_1",
           "hint": "",
-          "name": "thisisareallylongnamethatshouldcauseavisualissue_text_1",
+          "name": "page-a_text_1",
           "_type": "text",
           "_uuid": "bcedde64-8996-4911-9426-fafaf91008e0",
           "label": "Page A",

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.15.6'.freeze
+  VERSION = '2.15.10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.15.6
+  version: 2.15.10
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder