From 923e36ab21f4866dd5087d1f9443cb3e1c43d2c4 Mon Sep 17 00:00:00 2001
From: Stan Lo <stan001212@gmail.com>
Date: Thu, 15 Aug 2024 14:30:58 +0100
Subject: [PATCH] [ruby/rdoc] Fix sidebar scroll again and add missing footer
 back (https://github.com/ruby/rdoc/pull/1154)

* Add missing footers

In #1152 the footer partial was only added to the index.rhtml file.
This commit adds the footer partial to the other template files.

* Remove unnecessary middle divs in nav

* Simplify sidebar's overflow settings

Because sidebar needs to be scrollable, its overflow should default to auto.
Currently it's set to hidden and force individual elements to set overflow auto,
which overcomplicates things.

https://github.com/ruby/rdoc/commit/b8c2bcd8db
---
 lib/rdoc/generator/template/darkfish/class.rhtml  | 13 ++++++-------
 lib/rdoc/generator/template/darkfish/css/rdoc.css |  9 ++-------
 lib/rdoc/generator/template/darkfish/index.rhtml  |  7 ++-----
 lib/rdoc/generator/template/darkfish/page.rhtml   |  5 ++---
 .../template/darkfish/servlet_not_found.rhtml     | 15 ++++++++-------
 .../template/darkfish/servlet_root.rhtml          |  3 ++-
 .../template/darkfish/table_of_contents.rhtml     |  2 ++
 test/rdoc/test_rdoc_generator_darkfish.rb         |  2 +-
 8 files changed, 25 insertions(+), 31 deletions(-)

diff --git a/lib/rdoc/generator/template/darkfish/class.rhtml b/lib/rdoc/generator/template/darkfish/class.rhtml
index 915b2f9c9f..6c64ba6c98 100644
--- a/lib/rdoc/generator/template/darkfish/class.rhtml
+++ b/lib/rdoc/generator/template/darkfish/class.rhtml
@@ -8,14 +8,13 @@
   </div>
 
   <%= render '_sidebar_table_of_contents.rhtml' %>
+  <%= render '_sidebar_sections.rhtml' %>
+  <%= render '_sidebar_parent.rhtml' %>
+  <%= render '_sidebar_includes.rhtml' %>
+  <%= render '_sidebar_extends.rhtml' %>
+  <%= render '_sidebar_methods.rhtml' %>
 
-  <div id="class-metadata">
-    <%= render '_sidebar_sections.rhtml' %>
-    <%= render '_sidebar_parent.rhtml' %>
-    <%= render '_sidebar_includes.rhtml' %>
-    <%= render '_sidebar_extends.rhtml' %>
-    <%= render '_sidebar_methods.rhtml' %>
-  </div>
+  <%= render '_footer.rhtml' %>
 </nav>
 
 <main role="main" aria-labelledby="<%=h klass.aref %>">
diff --git a/lib/rdoc/generator/template/darkfish/css/rdoc.css b/lib/rdoc/generator/template/darkfish/css/rdoc.css
index 877e9bf0a9..35e70f9e39 100644
--- a/lib/rdoc/generator/template/darkfish/css/rdoc.css
+++ b/lib/rdoc/generator/template/darkfish/css/rdoc.css
@@ -212,7 +212,7 @@ nav {
   position: fixed;
   top: 0;
   bottom: 0;
-  overflow: hidden;
+  overflow: auto;
   z-index: 10;
 
   /* Layout */
@@ -228,11 +228,6 @@ nav[hidden] {
   display: none;
 }
 
-nav #project-metadata {
-  overflow: auto; /* Make the content scrollable */
-  flex: 1; /* Take up remaining space */
-}
-
 nav footer {
   padding: 1em;
   border-top: 1px solid #ccc;
@@ -286,7 +281,7 @@ nav .nav-section {
   margin-top: 2em;
   border-top: 2px solid #aaa;
   font-size: 90%;
-  overflow: hidden;
+  flex: 1;
 }
 
 nav h2 {
diff --git a/lib/rdoc/generator/template/darkfish/index.rhtml b/lib/rdoc/generator/template/darkfish/index.rhtml
index daaa0b5c54..a5c0dd54da 100644
--- a/lib/rdoc/generator/template/darkfish/index.rhtml
+++ b/lib/rdoc/generator/template/darkfish/index.rhtml
@@ -4,14 +4,11 @@
 <nav id="navigation" role="navigation">
   <div id="project-navigation">
     <%= render '_sidebar_navigation.rhtml' %>
-
     <%= render '_sidebar_search.rhtml' %>
   </div>
 
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-    <%= render '_sidebar_classes.rhtml' %>
-  </div>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
 
   <%= render '_footer.rhtml' %>
 </nav>
diff --git a/lib/rdoc/generator/template/darkfish/page.rhtml b/lib/rdoc/generator/template/darkfish/page.rhtml
index 90b9e4ee3b..fb33eba6fd 100644
--- a/lib/rdoc/generator/template/darkfish/page.rhtml
+++ b/lib/rdoc/generator/template/darkfish/page.rhtml
@@ -8,10 +8,9 @@
   </div>
 
   <%= render '_sidebar_table_of_contents.rhtml' %>
+  <%= render '_sidebar_pages.rhtml' %>
 
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-  </div>
+  <%= render '_footer.rhtml' %>
 </nav>
 
 <main role="main" aria-label="Page <%=h file.full_name%>">
diff --git a/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml b/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
index b30e64eec5..098b589add 100644
--- a/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
+++ b/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
@@ -2,14 +2,15 @@
 <%= render '_sidebar_toggle.rhtml' %>
 
 <nav id="navigation" role="navigation">
-  <%= render '_sidebar_navigation.rhtml' %>
-
-  <%= render '_sidebar_search.rhtml' %>
-
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-    <%= render '_sidebar_classes.rhtml' %>
+  <div id="project-navigation">
+    <%= render '_sidebar_navigation.rhtml' %>
+    <%= render '_sidebar_search.rhtml' %>
   </div>
+
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+
+  <%= render '_footer.rhtml' %>
 </nav>
 
 <main role="main">
diff --git a/lib/rdoc/generator/template/darkfish/servlet_root.rhtml b/lib/rdoc/generator/template/darkfish/servlet_root.rhtml
index 859ce2930b..373e0006d9 100644
--- a/lib/rdoc/generator/template/darkfish/servlet_root.rhtml
+++ b/lib/rdoc/generator/template/darkfish/servlet_root.rhtml
@@ -12,7 +12,8 @@
     <%= render '_sidebar_search.rhtml' %>
   </div>
 
-<%= render '_sidebar_installed.rhtml' %>
+  <%= render '_sidebar_installed.rhtml' %>
+  <%= render '_footer.rhtml' %>
 </nav>
 
 <main role="main">
diff --git a/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml b/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
index 5869873775..2cd2207836 100644
--- a/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
+++ b/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
@@ -7,6 +7,8 @@
 
     <%= render '_sidebar_search.rhtml' %>
   </div>
+
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main">
 <h1 class="class"><%= h @title %></h1>
diff --git a/test/rdoc/test_rdoc_generator_darkfish.rb b/test/rdoc/test_rdoc_generator_darkfish.rb
index 96319bb4f7..899e697de6 100644
--- a/test/rdoc/test_rdoc_generator_darkfish.rb
+++ b/test/rdoc/test_rdoc_generator_darkfish.rb
@@ -115,7 +115,7 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     assert_match(%r[Klass/Inner\.html".*>Inner<], summary)
 
     klass = File.binread('Klass.html')
-    klassnav = klass[%r[<div class="nav-section">.*<div id="class-metadata">]m]
+    klassnav = klass[%r[<div class="nav-section">.*]m]
     assert_match(
       %r[<li>\s*<details open>\s*<summary>\s*<a href=\S+>Heading 1</a>\s*</summary>\s*<ul]m,
       klassnav