From a786cfe09b2086db53f2ca366c87ccc075de8895 Mon Sep 17 00:00:00 2001
From: Jon Robson <jdlrobson@gmail.com>
Date: Fri, 9 Dec 2022 15:32:43 -0800
Subject: [PATCH] Templates: Reorganize pinned containers

The UnpinnedContainer and PinnedContainer are versions of the
same component but with different states. Recognize them by
organizing them in the same subfolder. Update all existing usages.

Bug: T317900
Change-Id: I2c25937190997764fa23e0b581be5538ba4d06de
---
 includes/templates/ColumnEnd.mustache              |  4 ++--
 includes/templates/PageTitlebar.mustache           |  4 ++--
 includes/templates/PageToolbar.mustache            |  4 ++--
 .../Close.mustache                                 |  0
 .../Pinned}/Open.mustache                          |  0
 .../Unpinned}/Open.mustache                        |  0
 includes/templates/StickyHeader.mustache           |  4 ++--
 .../templates/TableOfContentsContainer.mustache    |  4 ++--
 .../templates/UnpinnedContainer/Close.mustache     |  1 -
 tests/jest/userLinksData.js                        | 14 ++++++--------
 10 files changed, 16 insertions(+), 19 deletions(-)
 rename includes/templates/{PinnedContainer => PinnableContainer}/Close.mustache (100%)
 rename includes/templates/{PinnedContainer => PinnableContainer/Pinned}/Open.mustache (100%)
 rename includes/templates/{UnpinnedContainer => PinnableContainer/Unpinned}/Open.mustache (100%)
 delete mode 100644 includes/templates/UnpinnedContainer/Close.mustache

diff --git a/includes/templates/ColumnEnd.mustache b/includes/templates/ColumnEnd.mustache
index a7f1071b1..60c10089c 100644
--- a/includes/templates/ColumnEnd.mustache
+++ b/includes/templates/ColumnEnd.mustache
@@ -1,9 +1,9 @@
 <div class="vector-column-end">
 	<nav class="vector-page-tools-landmark" aria-label="{{msg-tooltip-p-cactions}}">
 		{{#data-page-tools}}
-		{{>PinnedContainer/Open}}
+		{{>PinnableContainer/Pinned/Open}}
 			{{#is-pinned}}{{>PageTools}}{{/is-pinned}}
-		{{>PinnedContainer/Close}}
+		{{>PinnableContainer/Close}}
 		{{/data-page-tools}}
 	</nav>
 </div>
diff --git a/includes/templates/PageTitlebar.mustache b/includes/templates/PageTitlebar.mustache
index 574338d43..02d879c39 100644
--- a/includes/templates/PageTitlebar.mustache
+++ b/includes/templates/PageTitlebar.mustache
@@ -20,8 +20,8 @@
 	{{! TOC is moved into this dropdown from the sidebar in stickyHeader.js. }}
 	{{#data-page-titlebar-toc}}
 	{{>Dropdown/Open}}
-		{{>UnpinnedContainer/Open}}
-		{{>UnpinnedContainer/Close}}
+		{{>PinnableContainer/Unpinned/Open}}
+		{{>PinnableContainer/Close}}
 	{{>Dropdown/Close}}
 	{{/data-page-titlebar-toc}}
 	{{/data-toc}}
diff --git a/includes/templates/PageToolbar.mustache b/includes/templates/PageToolbar.mustache
index 1045444d8..5eccf3952 100644
--- a/includes/templates/PageToolbar.mustache
+++ b/includes/templates/PageToolbar.mustache
@@ -15,9 +15,9 @@
 			<nav class="vector-page-tools-landmark" aria-label="{{msg-tooltip-p-cactions}}">
 				{{#is-page-tools-enabled}}{{#data-page-tools}}
 				{{>Dropdown/Open}}
-					{{>UnpinnedContainer/Open}}
+					{{>PinnableContainer/Unpinned/Open}}
 						{{^is-pinned}}{{>PageTools}}{{/is-pinned}}
-					{{>UnpinnedContainer/Close}}
+					{{>PinnableContainer/Close}}
 				{{>Dropdown/Close}}
 				{{/data-page-tools}}{{/is-page-tools-enabled}}
 				{{^is-page-tools-enabled}}{{#data-actions}}{{>LegacyMoreMenu}}{{/data-actions}}{{/is-page-tools-enabled}}
diff --git a/includes/templates/PinnedContainer/Close.mustache b/includes/templates/PinnableContainer/Close.mustache
similarity index 100%
rename from includes/templates/PinnedContainer/Close.mustache
rename to includes/templates/PinnableContainer/Close.mustache
diff --git a/includes/templates/PinnedContainer/Open.mustache b/includes/templates/PinnableContainer/Pinned/Open.mustache
similarity index 100%
rename from includes/templates/PinnedContainer/Open.mustache
rename to includes/templates/PinnableContainer/Pinned/Open.mustache
diff --git a/includes/templates/UnpinnedContainer/Open.mustache b/includes/templates/PinnableContainer/Unpinned/Open.mustache
similarity index 100%
rename from includes/templates/UnpinnedContainer/Open.mustache
rename to includes/templates/PinnableContainer/Unpinned/Open.mustache
diff --git a/includes/templates/StickyHeader.mustache b/includes/templates/StickyHeader.mustache
index f3cd75299..139cdde1e 100644
--- a/includes/templates/StickyHeader.mustache
+++ b/includes/templates/StickyHeader.mustache
@@ -23,8 +23,8 @@
 				{{! TOC is moved into this dropdown from the sidebar in stickyHeader.js. }}
 				{{#data-sticky-header-toc}}
 				{{>Dropdown/Open}}
-					{{>UnpinnedContainer/Open}}
-					{{>UnpinnedContainer/Close}}
+					{{>PinnableContainer/Unpinned/Open}}
+					{{>PinnableContainer/Close}}
 				{{>Dropdown/Close}}
 				{{/data-sticky-header-toc}}
 			</div>
diff --git a/includes/templates/TableOfContentsContainer.mustache b/includes/templates/TableOfContentsContainer.mustache
index 01e0e0634..c2c2fde99 100644
--- a/includes/templates/TableOfContentsContainer.mustache
+++ b/includes/templates/TableOfContentsContainer.mustache
@@ -1,8 +1,8 @@
 <div class="mw-table-of-contents-container">
 	{{! T313060 Additional container div needed to prevent the sticky element from being siblings with the footer }}
 	{{#data-toc}}
-	{{>PinnedContainer/Open}}
+	{{>PinnableContainer/Pinned/Open}}
 		{{#is-pinned}}{{>TableOfContents}}{{/is-pinned}}
-	{{>PinnedContainer/Close}}
+	{{>PinnableContainer/Close}}
 	{{/data-toc}}
 </div>
diff --git a/includes/templates/UnpinnedContainer/Close.mustache b/includes/templates/UnpinnedContainer/Close.mustache
deleted file mode 100644
index 04f5b8449..000000000
--- a/includes/templates/UnpinnedContainer/Close.mustache
+++ /dev/null
@@ -1 +0,0 @@
-</div>
diff --git a/tests/jest/userLinksData.js b/tests/jest/userLinksData.js
index 934cf7f31..89a79f997 100644
--- a/tests/jest/userLinksData.js
+++ b/tests/jest/userLinksData.js
@@ -4,10 +4,9 @@ const menuContents = fs.readFileSync( 'includes/templates/MenuContents.mustache'
 const userLinksTemplate = fs.readFileSync( 'includes/templates/UserLinks.mustache', 'utf8' );
 const dropdownOpenTemplate = fs.readFileSync( 'includes/templates/Dropdown/Open.mustache', 'utf8' );
 const dropdownCloseTemplate = fs.readFileSync( 'includes/templates/Dropdown/Close.mustache', 'utf8' );
-const pinnedContainerOpenTemplate = fs.readFileSync( 'includes/templates/PinnedContainer/Open.mustache', 'utf8' );
-const pinnedContainerCloseTemplate = fs.readFileSync( 'includes/templates/PinnedContainer/Close.mustache', 'utf8' );
-const unpinnedContainerOpenTemplate = fs.readFileSync( 'includes/templates/UnpinnedContainer/Open.mustache', 'utf8' );
-const unpinnedContainerCloseTemplate = fs.readFileSync( 'includes/templates/UnpinnedContainer/Close.mustache', 'utf8' );
+const pinnedContainerOpenTemplate = fs.readFileSync( 'includes/templates/PinnableContainer/Pinned/Open.mustache', 'utf8' );
+const pinnedContainerCloseTemplate = fs.readFileSync( 'includes/templates/PinnableContainer/Close.mustache', 'utf8' );
+const unpinnedContainerOpenTemplate = fs.readFileSync( 'includes/templates/PinnableContainer/Unpinned/Open.mustache', 'utf8' );
 const pinnableElementOpenTemplate = fs.readFileSync( 'includes/templates/PinnableElement/Open.mustache', 'utf8' );
 const pinnableElementCloseTemplate = fs.readFileSync( 'includes/templates/PinnableElement/Close.mustache', 'utf8' );
 const pinnableHeaderTemplate = fs.readFileSync( 'includes/templates/PinnableHeader.mustache', 'utf8' );
@@ -48,10 +47,9 @@ const templateData = {
 const dropdownPartials = {
 	'Dropdown/Open': dropdownOpenTemplate,
 	'Dropdown/Close': dropdownCloseTemplate,
-	'PinnedContainer/Open': pinnedContainerOpenTemplate,
-	'PinnedContainer/Close': pinnedContainerCloseTemplate,
-	'UnpinnedContainer/Open': unpinnedContainerOpenTemplate,
-	'UnpinnedContainer/Close': unpinnedContainerCloseTemplate,
+	'PinnableContainer/Pinned/Open': pinnedContainerOpenTemplate,
+	'PinnableContainer/Close': pinnedContainerCloseTemplate,
+	'PinnableContainer/Unpinned/Open': unpinnedContainerOpenTemplate,
 	'PinnableElement/Open': pinnableElementOpenTemplate,
 	'PinnableElement/Close': pinnableElementCloseTemplate,
 	PinnableHeader: pinnableHeaderTemplate,