From 8b7e5ba293af55dcb503b21b819a7ca31d2afa85 Mon Sep 17 00:00:00 2001
From: David Heath <61065+heathd@users.noreply.github.com>
Date: Wed, 19 Jun 2024 18:50:10 +0100
Subject: [PATCH] Stable sort

try to avoid left menu jumping around
---
 .../table_of_contents/helpers.rb              | 29 ++++++++++++++-----
 1 file changed, 21 insertions(+), 8 deletions(-)

diff --git a/lib/govuk_tech_docs/table_of_contents/helpers.rb b/lib/govuk_tech_docs/table_of_contents/helpers.rb
index 8e0d34c8..60090703 100644
--- a/lib/govuk_tech_docs/table_of_contents/helpers.rb
+++ b/lib/govuk_tech_docs/table_of_contents/helpers.rb
@@ -18,12 +18,27 @@ def single_page_table_of_contents(html, url: "", max_level: nil)
         output
       end
 
+      # Items with a weight appear first, in weight order
+      #   if items have equal weight, they stay in the order they appeared (stable sort)
+      # Items without a weight appear after, sorted stably in the order that they are
+      # present in the resource list
+      def sort_resources_stably(resources)
+        resources
+          .each.with_index
+          .sort_by { |r, index| [r.data.weight ? 0 : 1, r.data.weight || 0, index] }
+          .map(&:first)
+          .to_a
+      end
+
+      def select_top_level_html_files(resources)
+        resources
+          .select { |r| r.path.end_with?(".html") && (r.parent.nil? || r.parent.url == "/") }
+      end
+
       def multi_page_table_of_contents(resources, current_page, config, current_page_html = nil)
-        # Only parse top level html files
-        # Sorted by weight frontmatter
-        resources = resources
-        .select { |r| r.path.end_with?(".html") && (r.parent.nil? || r.parent.url == "/") }
-        .sort_by { |r| [r.data.weight ? 0 : 1, r.data.weight || 0] }
+        resources = sort_resources_stably(
+          select_top_level_html_files(resources),
+        )
 
         render_page_tree(resources, current_page, config, current_page_html)
       end
@@ -40,9 +55,7 @@ def list_items_from_headings(html, url: "", max_level: nil)
       end
 
       def render_page_tree(resources, current_page, config, current_page_html)
-        # Sort by weight frontmatter
-        resources = resources
-        .sort_by { |r| [r.data.weight ? 0 : 1, r.data.weight || 0] }
+        resources = sort_resources_stably(resources)
 
         output = "<ul>\n"
         resources.each do |resource|