From 5bd78b80687a92818497df7d443f7bac252a1067 Mon Sep 17 00:00:00 2001
From: Anthony LC <anthony.le-courric@mail.numerique.gouv.fr>
Date: Tue, 17 Sep 2024 14:53:31 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=9A(frontend)=20rename=20feature=20sum?=
 =?UTF-8?q?mary=20to=20table=20of=20content?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

We rename the feature summary to table of content
to better reflect the feature purpose.
---
 ...mary.spec.ts => doc-table-content.spec.ts} | 11 +++++++---
 .../docs/doc-editor/components/DocEditor.tsx  |  4 ++--
 .../docs/doc-header/components/DocToolBox.tsx |  6 +++---
 .../docs/doc-summary/components/index.ts      |  1 -
 .../features/docs/doc-summary/stores/index.ts |  1 -
 .../doc-summary/stores/useDocSummaryStore.tsx | 13 ------------
 .../components/Heading.tsx                    |  0
 .../components/TableContent.tsx}              | 21 ++++++++++---------
 .../doc-table-content/components/index.ts     |  1 +
 .../index.ts                                  |  0
 .../docs/doc-table-content/stores/index.ts    |  1 +
 .../stores/useDocTableContentStore.tsx        | 15 +++++++++++++
 12 files changed, 41 insertions(+), 33 deletions(-)
 rename src/frontend/apps/e2e/__tests__/app-impress/{doc-summary.spec.ts => doc-table-content.spec.ts} (92%)
 delete mode 100644 src/frontend/apps/impress/src/features/docs/doc-summary/components/index.ts
 delete mode 100644 src/frontend/apps/impress/src/features/docs/doc-summary/stores/index.ts
 delete mode 100644 src/frontend/apps/impress/src/features/docs/doc-summary/stores/useDocSummaryStore.tsx
 rename src/frontend/apps/impress/src/features/docs/{doc-summary => doc-table-content}/components/Heading.tsx (100%)
 rename src/frontend/apps/impress/src/features/docs/{doc-summary/components/Summary.tsx => doc-table-content/components/TableContent.tsx} (89%)
 create mode 100644 src/frontend/apps/impress/src/features/docs/doc-table-content/components/index.ts
 rename src/frontend/apps/impress/src/features/docs/{doc-summary => doc-table-content}/index.ts (100%)
 create mode 100644 src/frontend/apps/impress/src/features/docs/doc-table-content/stores/index.ts
 create mode 100644 src/frontend/apps/impress/src/features/docs/doc-table-content/stores/useDocTableContentStore.tsx

diff --git a/src/frontend/apps/e2e/__tests__/app-impress/doc-summary.spec.ts b/src/frontend/apps/e2e/__tests__/app-impress/doc-table-content.spec.ts
similarity index 92%
rename from src/frontend/apps/e2e/__tests__/app-impress/doc-summary.spec.ts
rename to src/frontend/apps/e2e/__tests__/app-impress/doc-table-content.spec.ts
index a2f6c33a..3cf87a98 100644
--- a/src/frontend/apps/e2e/__tests__/app-impress/doc-summary.spec.ts
+++ b/src/frontend/apps/e2e/__tests__/app-impress/doc-table-content.spec.ts
@@ -6,9 +6,14 @@ test.beforeEach(async ({ page }) => {
   await page.goto('/');
 });
 
-test.describe('Doc Summary', () => {
-  test('it checks the doc summary', async ({ page, browserName }) => {
-    const [randomDoc] = await createDoc(page, 'doc-summary', browserName, 1);
+test.describe('Doc Table Content', () => {
+  test('it checks the doc table content', async ({ page, browserName }) => {
+    const [randomDoc] = await createDoc(
+      page,
+      'doc-table-content',
+      browserName,
+      1,
+    );
 
     await expect(page.locator('h2').getByText(randomDoc)).toBeVisible();
 
diff --git a/src/frontend/apps/impress/src/features/docs/doc-editor/components/DocEditor.tsx b/src/frontend/apps/impress/src/features/docs/doc-editor/components/DocEditor.tsx
index b379ba11..a5610d38 100644
--- a/src/frontend/apps/impress/src/features/docs/doc-editor/components/DocEditor.tsx
+++ b/src/frontend/apps/impress/src/features/docs/doc-editor/components/DocEditor.tsx
@@ -9,7 +9,7 @@ import { Panel } from '@/components/Panel';
 import { useCunninghamTheme } from '@/cunningham';
 import { DocHeader } from '@/features/docs/doc-header';
 import { Doc } from '@/features/docs/doc-management';
-import { Summary } from '@/features/docs/doc-summary';
+import { TableContent } from '@/features/docs/doc-table-content';
 import {
   VersionList,
   Versions,
@@ -70,7 +70,7 @@ export const DocEditor = ({ doc }: DocEditorProps) => {
             <VersionList doc={doc} />
           </Panel>
         )}
-        <Summary doc={doc} />
+        <TableContent doc={doc} />
       </Box>
     </>
   );
diff --git a/src/frontend/apps/impress/src/features/docs/doc-header/components/DocToolBox.tsx b/src/frontend/apps/impress/src/features/docs/doc-header/components/DocToolBox.tsx
index 2cd02d5a..a6412b73 100644
--- a/src/frontend/apps/impress/src/features/docs/doc-header/components/DocToolBox.tsx
+++ b/src/frontend/apps/impress/src/features/docs/doc-header/components/DocToolBox.tsx
@@ -9,7 +9,7 @@ import {
   ModalShare,
   ModalUpdateDoc,
 } from '@/features/docs/doc-management';
-import { useDocSummaryStore } from '@/features/docs/doc-summary';
+import { useDocTableContentStore } from '@/features/docs/doc-table-content';
 import { useDocVersionStore } from '@/features/docs/doc-versioning';
 
 import { ModalPDF } from './ModalExport';
@@ -26,7 +26,7 @@ export const DocToolBox = ({ doc }: DocToolBoxProps) => {
   const [isModalPDFOpen, setIsModalPDFOpen] = useState(false);
   const [isDropOpen, setIsDropOpen] = useState(false);
   const { setIsPanelVersionOpen } = useDocVersionStore();
-  const { setIsPanelSummaryOpen } = useDocSummaryStore();
+  const { setIsPanelTableContentOpen } = useDocTableContentStore();
 
   return (
     <Box
@@ -83,7 +83,7 @@ export const DocToolBox = ({ doc }: DocToolBoxProps) => {
           )}
           <Button
             onClick={() => {
-              setIsPanelSummaryOpen(true);
+              setIsPanelTableContentOpen(true);
               setIsPanelVersionOpen(false);
               setIsDropOpen(false);
             }}
diff --git a/src/frontend/apps/impress/src/features/docs/doc-summary/components/index.ts b/src/frontend/apps/impress/src/features/docs/doc-summary/components/index.ts
deleted file mode 100644
index c647fd2a..00000000
--- a/src/frontend/apps/impress/src/features/docs/doc-summary/components/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from './Summary';
diff --git a/src/frontend/apps/impress/src/features/docs/doc-summary/stores/index.ts b/src/frontend/apps/impress/src/features/docs/doc-summary/stores/index.ts
deleted file mode 100644
index 20acdd5c..00000000
--- a/src/frontend/apps/impress/src/features/docs/doc-summary/stores/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from './useDocSummaryStore';
diff --git a/src/frontend/apps/impress/src/features/docs/doc-summary/stores/useDocSummaryStore.tsx b/src/frontend/apps/impress/src/features/docs/doc-summary/stores/useDocSummaryStore.tsx
deleted file mode 100644
index 5c31831f..00000000
--- a/src/frontend/apps/impress/src/features/docs/doc-summary/stores/useDocSummaryStore.tsx
+++ /dev/null
@@ -1,13 +0,0 @@
-import { create } from 'zustand';
-
-export interface UseDocSummaryStore {
-  isPanelSummaryOpen: boolean;
-  setIsPanelSummaryOpen: (isOpen: boolean) => void;
-}
-
-export const useDocSummaryStore = create<UseDocSummaryStore>((set) => ({
-  isPanelSummaryOpen: false,
-  setIsPanelSummaryOpen: (isPanelSummaryOpen) => {
-    set(() => ({ isPanelSummaryOpen }));
-  },
-}));
diff --git a/src/frontend/apps/impress/src/features/docs/doc-summary/components/Heading.tsx b/src/frontend/apps/impress/src/features/docs/doc-table-content/components/Heading.tsx
similarity index 100%
rename from src/frontend/apps/impress/src/features/docs/doc-summary/components/Heading.tsx
rename to src/frontend/apps/impress/src/features/docs/doc-table-content/components/Heading.tsx
diff --git a/src/frontend/apps/impress/src/features/docs/doc-summary/components/Summary.tsx b/src/frontend/apps/impress/src/features/docs/doc-table-content/components/TableContent.tsx
similarity index 89%
rename from src/frontend/apps/impress/src/features/docs/doc-summary/components/Summary.tsx
rename to src/frontend/apps/impress/src/features/docs/doc-table-content/components/TableContent.tsx
index 65044049..cfb0e306 100644
--- a/src/frontend/apps/impress/src/features/docs/doc-summary/components/Summary.tsx
+++ b/src/frontend/apps/impress/src/features/docs/doc-table-content/components/TableContent.tsx
@@ -6,7 +6,7 @@ import { Panel } from '@/components/Panel';
 import { useDocStore } from '@/features/docs/doc-editor';
 import { Doc } from '@/features/docs/doc-management';
 
-import { useDocSummaryStore } from '../stores';
+import { useDocTableContentStore } from '../stores';
 
 import { Heading } from './Heading';
 
@@ -20,11 +20,11 @@ type HeadingBlock = {
   };
 };
 
-interface SummaryProps {
+interface TableContentProps {
   doc: Doc;
 }
 
-export const Summary = ({ doc }: SummaryProps) => {
+export const TableContent = ({ doc }: TableContentProps) => {
   const { docsStore } = useDocStore();
   const { t } = useTranslation();
 
@@ -38,11 +38,12 @@ export const Summary = ({ doc }: SummaryProps) => {
   );
 
   const [headings, setHeadings] = useState<HeadingBlock[]>();
-  const { setIsPanelSummaryOpen, isPanelSummaryOpen } = useDocSummaryStore();
+  const { setIsPanelTableContentOpen, isPanelTableContentOpen } =
+    useDocTableContentStore();
   const [hasBeenClose, setHasBeenClose] = useState(false);
   const setClosePanel = () => {
     setHasBeenClose(true);
-    setIsPanelSummaryOpen(false);
+    setIsPanelTableContentOpen(false);
   };
 
   const [headingIdHighlight, setHeadingIdHighlight] = useState<string>();
@@ -50,16 +51,16 @@ export const Summary = ({ doc }: SummaryProps) => {
   // Open the panel if there are more than 1 heading
   useEffect(() => {
     if (headings?.length && headings.length > 1 && !hasBeenClose) {
-      setIsPanelSummaryOpen(true);
+      setIsPanelTableContentOpen(true);
     }
-  }, [setIsPanelSummaryOpen, headings, hasBeenClose]);
+  }, [setIsPanelTableContentOpen, headings, hasBeenClose]);
 
   // Close the panel unmount
   useEffect(() => {
     return () => {
-      setIsPanelSummaryOpen(false);
+      setIsPanelTableContentOpen(false);
     };
-  }, [setIsPanelSummaryOpen]);
+  }, [setIsPanelTableContentOpen]);
 
   // To highlight the first heading in the viewport
   useEffect(() => {
@@ -112,7 +113,7 @@ export const Summary = ({ doc }: SummaryProps) => {
     setHeadings(headingFiltering());
   });
 
-  if (!isPanelSummaryOpen) {
+  if (!isPanelTableContentOpen) {
     return null;
   }
 
diff --git a/src/frontend/apps/impress/src/features/docs/doc-table-content/components/index.ts b/src/frontend/apps/impress/src/features/docs/doc-table-content/components/index.ts
new file mode 100644
index 00000000..323f1534
--- /dev/null
+++ b/src/frontend/apps/impress/src/features/docs/doc-table-content/components/index.ts
@@ -0,0 +1 @@
+export * from './TableContent';
diff --git a/src/frontend/apps/impress/src/features/docs/doc-summary/index.ts b/src/frontend/apps/impress/src/features/docs/doc-table-content/index.ts
similarity index 100%
rename from src/frontend/apps/impress/src/features/docs/doc-summary/index.ts
rename to src/frontend/apps/impress/src/features/docs/doc-table-content/index.ts
diff --git a/src/frontend/apps/impress/src/features/docs/doc-table-content/stores/index.ts b/src/frontend/apps/impress/src/features/docs/doc-table-content/stores/index.ts
new file mode 100644
index 00000000..f8846b72
--- /dev/null
+++ b/src/frontend/apps/impress/src/features/docs/doc-table-content/stores/index.ts
@@ -0,0 +1 @@
+export * from './useDocTableContentStore';
diff --git a/src/frontend/apps/impress/src/features/docs/doc-table-content/stores/useDocTableContentStore.tsx b/src/frontend/apps/impress/src/features/docs/doc-table-content/stores/useDocTableContentStore.tsx
new file mode 100644
index 00000000..1148880d
--- /dev/null
+++ b/src/frontend/apps/impress/src/features/docs/doc-table-content/stores/useDocTableContentStore.tsx
@@ -0,0 +1,15 @@
+import { create } from 'zustand';
+
+export interface UseDocTableContentStore {
+  isPanelTableContentOpen: boolean;
+  setIsPanelTableContentOpen: (isOpen: boolean) => void;
+}
+
+export const useDocTableContentStore = create<UseDocTableContentStore>(
+  (set) => ({
+    isPanelTableContentOpen: false,
+    setIsPanelTableContentOpen: (isPanelTableContentOpen) => {
+      set(() => ({ isPanelTableContentOpen }));
+    },
+  }),
+);