refactor naming for implementation clarity

facebook · Oct 8, 2018 · ce549c0 · ce549c0
1 parent 39d8d87
commit ce549c0
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/v1/lib/server/__tests__/utils.test.js b/v1/lib/server/__tests__/utils.test.js
@@ -90,26 +90,26 @@ describe('server utils', () => {
   });
 
   describe('validateSidebar', () => {
-    test('should throw an error for invalid pages', () => {
+    test('should throw an error for invalid sidebarMetadatas', () => {
       const metadata = {
         id: 'doc1',
         sidebar: 'docs',
         next_id: 'doc2',
         next: 'doc2',
       };
 
-      const pages = {
+      const sidebarMetadatas = {
         doc1: {},
       };
 
       expect(() => {
-        utils.validateSidebar(metadata, pages);
+        utils.validateSidebar(metadata, sidebarMetadatas);
       }).toThrow(
         `Improper sidebars.json file, document with id 'doc2' not found. Make sure that documents with the ids specified in sidebars.json exist and that no ids are repeated.`,
       );
     });
 
-    test('should throw an error for invalid version pages', () => {
+    test('should throw an error for invalid version sidebarMetadatas', () => {
       const metadata = {
         id: 'doc1',
         version: 'foo',
@@ -118,12 +118,12 @@ describe('server utils', () => {
         next: 'doc2',
       };
 
-      const pages = {
+      const sidebarMetadatas = {
         doc1: {},
       };
 
       expect(() => {
-        utils.validateSidebar(metadata, pages);
+        utils.validateSidebar(metadata, sidebarMetadatas);
       }).toThrow(
         `Improper sidebars file for version foo, document with id 'doc2' not found. Make sure that all documents with ids specified in this version's sidebar file exist and that no ids are repeated.`,
       );
@@ -137,13 +137,13 @@ describe('server utils', () => {
         next: 'doc2',
       };
 
-      const pages = {
+      const sidebarMetadatas = {
         doc1: {},
         doc2: {},
       };
 
       expect(() => {
-        utils.validateSidebar(metadata, pages);
+        utils.validateSidebar(metadata, sidebarMetadatas);
       }).not.toThrow();
     });
   });

diff --git a/v1/lib/server/readCategories.js b/v1/lib/server/readCategories.js
@@ -20,14 +20,14 @@ function readCategories(sidebar, allMetadata, languages) {
     const language = enabledLanguages[k];
     const metadatas = [];
     const categories = [];
-    const pages = {};
+    const sidebarMetadatas = {};
 
-    // Get the metadata for the current sidebar
+    // Get all related metadata for the current sidebar
     Object.keys(allMetadata).forEach(id => {
       const metadata = allMetadata[id];
       if (metadata.sidebar === sidebar && metadata.language === language) {
         metadatas.push(metadata);
-        pages[metadata.id] = metadata;
+        sidebarMetadatas[metadata.id] = metadata;
       }
     });
 
@@ -59,8 +59,8 @@ function readCategories(sidebar, allMetadata, languages) {
       const category = metadata.category;
       const subCategory = metadata.sub_category;
 
-      // Validate pages in the sidebar
-      validateSidebar(metadata, pages);
+      // Validate sidebarMetadatas in the sidebar
+      validateSidebar(metadata, sidebarMetadatas);
 
       if (!indexedCategories[category]) {
         indexedCategories[category] = [];

diff --git a/v1/lib/server/utils.js b/v1/lib/server/utils.js
@@ -67,9 +67,9 @@ function autoPrefixCss(cssContent) {
 }
 
 // Validate the docs in the sidebar are valid
-function validateSidebar(metadata, pages) {
+function validateSidebar(metadata, sidebarMetadatas) {
   if (metadata.next) {
-    if (!pages[metadata.next]) {
+    if (!sidebarMetadatas[metadata.next]) {
       throw new Error(
         metadata.version
           ? `Improper sidebars file for version ${