Rename NodeStoreMap to FolderNodeMap

Author: msmolens

src/treetop/BookmarksManager.test.ts

@@ -9,7 +9,7 @@ import * as Treetop from './types';
  */
 export class BookmarksManager {
   constructor(
-    private readonly nodeStoreMap: Treetop.NodeStoreMap,
+    private readonly folderNodeMap: Treetop.FolderNodeMap,
     private readonly builtInFolderInfo: Treetop.BuiltInFolderInfo,
   ) {}
 
@@ -39,7 +39,7 @@ export class BookmarksManager {
       const node = nodes.pop()!;
 
       if (isFolder(node)) {
-        this.buildNodeStore(node);
+        this.buildFolderNode(node);
         nodes.push(...node.children!);
       }
     }
@@ -90,16 +90,16 @@ export class BookmarksManager {
   /**
    * Create and record a node store for the specified bookmark node.
    */
-  private buildNodeStore(node: chrome.bookmarks.BookmarkTreeNode): void {
+  private buildFolderNode(node: chrome.bookmarks.BookmarkTreeNode): void {
     const newNode = this.convertNode(node);
-    const nodeStore = writable(newNode);
-    this.nodeStoreMap.set(node.id, nodeStore);
+    const folderNode = writable(newNode);
+    this.folderNodeMap.set(node.id, folderNode);
   }
 
   /**
    * Update the node store for the specified bookmark ID.
    */
-  private async updateNodeStore(nodeId: string): Promise<void> {
+  private async updateFolderNode(nodeId: string): Promise<void> {
     const [node] = await chrome.bookmarks.get(nodeId);
 
     if (!isFolder(node)) {
@@ -109,8 +109,8 @@ export class BookmarksManager {
     node.children = await chrome.bookmarks.getChildren(node.id);
 
     const newNode = this.convertNode(node);
-    const nodeStore = this.nodeStoreMap.get(nodeId)!;
-    nodeStore.set(newNode);
+    const folderNode = this.folderNodeMap.get(nodeId)!;
+    folderNode.set(newNode);
   }
 
   /**
@@ -124,11 +124,11 @@ export class BookmarksManager {
       // Add node store for the new folder
       const [node] = await chrome.bookmarks.get(id);
       node.children = await chrome.bookmarks.getChildren(id);
-      this.buildNodeStore(node);
+      this.buildFolderNode(node);
     }
 
     // Update parent node of the new bookmark
-    await this.updateNodeStore(bookmark.parentId!);
+    await this.updateFolderNode(bookmark.parentId!);
   }
 
   /**
@@ -144,13 +144,13 @@ export class BookmarksManager {
     const removedNodeIds = [];
 
     if (isFolder(removeInfo.node)) {
-      const nodeStore = this.nodeStoreMap.get(id)!;
-      const nodes: [Treetop.FolderNode] = [get(nodeStore)];
+      const folderNode = this.folderNodeMap.get(id)!;
+      const nodes: [Treetop.FolderNode] = [get(folderNode)];
 
       // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
       while (nodes.length) {
         const node = nodes.pop()!;
-        this.nodeStoreMap.delete(node.id);
+        this.folderNodeMap.delete(node.id);
         removedNodeIds.push(node.id);
 
         // Store removed bookmark IDs
@@ -161,8 +161,8 @@ export class BookmarksManager {
         }
 
         // Enqueue child folders for removal
-        for (const childNodeStore of this.nodeStoreMap.values()) {
-          const currentNode: Treetop.FolderNode = get(childNodeStore);
+        for (const childFolderNode of this.folderNodeMap.values()) {
+          const currentNode: Treetop.FolderNode = get(childFolderNode);
           if (currentNode.parentId === node.id) {
             nodes.push(currentNode);
           }
@@ -173,7 +173,7 @@ export class BookmarksManager {
     }
 
     // Update parent node of the deleted bookmark
-    await this.updateNodeStore(removeInfo.parentId);
+    await this.updateFolderNode(removeInfo.parentId);
 
     return removedNodeIds;
   }
@@ -185,13 +185,13 @@ export class BookmarksManager {
     id: string,
     _changeInfo: Treetop.BookmarkChangeInfo,
   ): Promise<void> {
-    if (this.nodeStoreMap.has(id)) {
+    if (this.folderNodeMap.has(id)) {
       // Folder changed. Update its node.
-      await this.updateNodeStore(id);
+      await this.updateFolderNode(id);
     } else {
       // Bookmark changed. Update the parent folder node.
       const [node] = await chrome.bookmarks.get(id);
-      await this.updateNodeStore(node.parentId!);
+      await this.updateFolderNode(node.parentId!);
     }
   }
 
@@ -207,11 +207,11 @@ export class BookmarksManager {
     const oldParentId = moveInfo.oldParentId;
 
     // Update parent folder
-    await this.updateNodeStore(parentId);
+    await this.updateFolderNode(parentId);
 
     // Update old parent folder
     if (parentId !== oldParentId) {
-      await this.updateNodeStore(oldParentId);
+      await this.updateFolderNode(oldParentId);
     }
   }
 }

src/treetop/BookmarksManager.ts

@@ -25,7 +25,7 @@ const randomStringContaining = (str: string) => {
   )}`;
 };
 
-let nodeStoreMap: Treetop.NodeStoreMap;
+let folderNodeMap: Treetop.FolderNodeMap;
 let filterSet: Treetop.FilterSet;
 let filterManager: FilterManager;
 let folderNode1: Treetop.FolderNode;
@@ -36,9 +36,9 @@ let folderNode5: Treetop.FolderNode;
 let folderNode6: Treetop.FolderNode;
 
 beforeEach(() => {
-  nodeStoreMap = new Map() as Treetop.NodeStoreMap;
+  folderNodeMap = new Map() as Treetop.FolderNodeMap;
   filterSet = new SvelteSet();
-  filterManager = new FilterManager(filterSet, nodeStoreMap);
+  filterManager = new FilterManager(filterSet, folderNodeMap);
 
   // Create node tree:
   // folderNode1
@@ -114,12 +114,12 @@ beforeEach(() => {
   });
   folderNode5.children.push(folderNode6);
 
-  nodeStoreMap.set(folderNode1.id, writable(folderNode1));
-  nodeStoreMap.set(folderNode2.id, writable(folderNode2));
-  nodeStoreMap.set(folderNode3.id, writable(folderNode3));
-  nodeStoreMap.set(folderNode4.id, writable(folderNode4));
-  nodeStoreMap.set(folderNode5.id, writable(folderNode5));
-  nodeStoreMap.set(folderNode6.id, writable(folderNode6));
+  folderNodeMap.set(folderNode1.id, writable(folderNode1));
+  folderNodeMap.set(folderNode2.id, writable(folderNode2));
+  folderNodeMap.set(folderNode3.id, writable(folderNode3));
+  folderNodeMap.set(folderNode4.id, writable(folderNode4));
+  folderNodeMap.set(folderNode5.id, writable(folderNode5));
+  folderNodeMap.set(folderNode6.id, writable(folderNode6));
 });
 
 describe('setFilter', () => {

src/treetop/FilterManager.test.ts

@@ -17,7 +17,7 @@ export class FilterManager {
 
   constructor(
     private readonly filterSet: Treetop.FilterSet,
-    private readonly nodeStoreMap: Treetop.NodeStoreMap,
+    private readonly folderNodeMap: Treetop.FolderNodeMap,
   ) {}
 
   /**
@@ -29,11 +29,11 @@ export class FilterManager {
     // Pass 1:
     // Add bookmarks that match the filter string to the FilterSet.
     // Additionally, add their immediate parent folders to the FilterSet.
-    for (const nodeStore of this.nodeStoreMap.values()) {
+    for (const folderNode of this.folderNodeMap.values()) {
       let addedChild = false;
 
-      const folderNode: Treetop.FolderNode = get(nodeStore);
-      for (const child of folderNode.children) {
+      const node: Treetop.FolderNode = get(folderNode);
+      for (const child of node.children) {
         if (child.type === Treetop.NodeType.Bookmark) {
           if (
             this.matchesFilter(child.title) ||
@@ -46,19 +46,19 @@ export class FilterManager {
       }
 
       if (addedChild) {
-        this.filterSet.add(folderNode.id);
+        this.filterSet.add(node.id);
       }
     }
 
     // Pass 2
     // For each folder in the FilterSet, add the folders on the path to the root
     // folder.
-    for (const nodeStore of this.nodeStoreMap.values()) {
-      const node: Treetop.FolderNode = get(nodeStore);
+    for (const folderNode of this.folderNodeMap.values()) {
+      const node: Treetop.FolderNode = get(folderNode);
       if (this.filterSet.has(node.id)) {
         let curNode = node;
         while (curNode.parentId) {
-          curNode = get(this.nodeStoreMap.get(curNode.parentId)!);
+          curNode = get(this.folderNodeMap.get(curNode.parentId)!);
           this.filterSet.add(curNode.id);
         }
       }
@@ -102,7 +102,7 @@ export class FilterManager {
     // Add the folders on the path to the root folder to the FilterSet
     let parentId = bookmark.parentId;
     while (parentId) {
-      const node = get(this.nodeStoreMap.get(parentId)!);
+      const node = get(this.folderNodeMap.get(parentId)!);
       this.filterSet.add(node.id);
       parentId = node.parentId;
     }

src/treetop/FilterManager.ts

@@ -15,11 +15,11 @@
 
   const builtInFolderInfo: Treetop.BuiltInFolderInfo =
     getContext('builtInFolderInfo');
-  const nodeStoreMap: Treetop.NodeStoreMap = getContext('nodeStoreMap');
+  const folderNodeMap = getContext<Treetop.FolderNodeMap>('folderNodeMap');
   const filterActive = getContext<() => boolean>('filterActive');
   const filterSet = getContext<Treetop.FilterSet>('filterSet');
 
-  let node: Writable<Treetop.FolderNode> = nodeStoreMap.get(nodeId)!;
+  let node: Writable<Treetop.FolderNode> = folderNodeMap.get(nodeId)!;
 
   // Nodes for the folder heading.
   // For the root folder, get the folder nodes from bookmarks root to the selected root.
@@ -33,8 +33,8 @@
     const nodes = [node];
 
     while (node.parentId) {
-      const nodeStore = nodeStoreMap.get(node.parentId)!;
-      node = get(nodeStore);
+      const folderNode = folderNodeMap.get(node.parentId)!;
+      node = get(folderNode);
       nodes.unshift(node);
     }
 

src/treetop/Folder.svelte

@@ -17,7 +17,7 @@ import {
 
 // Folder component requirements
 let builtInFolderInfo: Treetop.BuiltInFolderInfo;
-let nodeStoreMap: Treetop.NodeStoreMap;
+let folderNodeMap: Treetop.FolderNodeMap;
 let currentFilterActive: boolean;
 const filterActive = () => currentFilterActive;
 let filterSet: Treetop.FilterSet;
@@ -40,7 +40,7 @@ const setup = () => {
     },
     Context: {
       builtInFolderInfo,
-      nodeStoreMap,
+      folderNodeMap,
       lastVisitTimeMap,
       filterActive,
       filterSet,
@@ -111,7 +111,7 @@ beforeEach(() => {
     rootNodeId: 'bookmarks-root-id',
     builtInFolderIds: ['bookmarks-toolbar-id', 'other-bookmarks-id'],
   };
-  nodeStoreMap = new Map() as Treetop.NodeStoreMap;
+  folderNodeMap = new Map() as Treetop.FolderNodeMap;
   lastVisitTimeMap = new Map() as Treetop.LastVisitTimeMap;
   currentFilterActive = false;
   filterSet = new SvelteSet();
@@ -129,7 +129,7 @@ describe('rooted at bookmarks root', () => {
       // rootNode
       rootNode = createFolderNode({ id: builtInFolderInfo.rootNodeId! });
 
-      nodeStoreMap.set(rootNode.id, writable(rootNode));
+      folderNodeMap.set(rootNode.id, writable(rootNode));
 
       nodeId = rootNode.id;
 
@@ -174,7 +174,7 @@ describe('rooted at bookmarks root', () => {
         title: '',
       });
 
-      nodeStoreMap.set(rootNode.id, writable(rootNode));
+      folderNodeMap.set(rootNode.id, writable(rootNode));
 
       nodeId = rootNode.id;
 
@@ -219,8 +219,8 @@ describe('rooted at bookmarks root', () => {
       folderNode.parentId = rootNode.id;
       rootNode.children.push(folderNode);
 
-      nodeStoreMap.set(rootNode.id, writable(rootNode));
-      nodeStoreMap.set(folderNode.id, writable(folderNode));
+      folderNodeMap.set(rootNode.id, writable(rootNode));
+      folderNodeMap.set(folderNode.id, writable(folderNode));
 
       nodeId = rootNode.id;
 
@@ -287,9 +287,9 @@ describe('rooted at bookmarks root', () => {
       folderNode2.children.push(createBookmarkNode());
       folderNode1.children.push(folderNode2);
 
-      nodeStoreMap.set(rootNode.id, writable(rootNode));
-      nodeStoreMap.set(folderNode1.id, writable(folderNode1));
-      nodeStoreMap.set(folderNode2.id, writable(folderNode2));
+      folderNodeMap.set(rootNode.id, writable(rootNode));
+      folderNodeMap.set(folderNode1.id, writable(folderNode1));
+      folderNodeMap.set(folderNode2.id, writable(folderNode2));
 
       nodeId = rootNode.id;
 
@@ -399,9 +399,9 @@ describe('rooted at bookmarks root', () => {
       folderNode2.children.push(createBookmarkNode());
       rootNode.children.push(folderNode2);
 
-      nodeStoreMap.set(rootNode.id, writable(rootNode));
-      nodeStoreMap.set(folderNode1.id, writable(folderNode1));
-      nodeStoreMap.set(folderNode2.id, writable(folderNode2));
+      folderNodeMap.set(rootNode.id, writable(rootNode));
+      folderNodeMap.set(folderNode1.id, writable(folderNode1));
+      folderNodeMap.set(folderNode2.id, writable(folderNode2));
 
       nodeId = rootNode.id;
 
@@ -506,10 +506,10 @@ describe('rooted at subfolder', () => {
     folderNode3.children.push(createBookmarkNode());
     folderNode2.children.push(folderNode3);
 
-    nodeStoreMap.set(rootNode.id, writable(rootNode));
-    nodeStoreMap.set(folderNode1.id, writable(folderNode1));
-    nodeStoreMap.set(folderNode2.id, writable(folderNode2));
-    nodeStoreMap.set(folderNode3.id, writable(folderNode3));
+    folderNodeMap.set(rootNode.id, writable(rootNode));
+    folderNodeMap.set(folderNode1.id, writable(folderNode1));
+    folderNodeMap.set(folderNode2.id, writable(folderNode2));
+    folderNodeMap.set(folderNode3.id, writable(folderNode3));
 
     nodeId = folderNode2.id;
 
@@ -664,10 +664,10 @@ describe('filter active', () => {
     folderNode3.children.push(bookmarkNode6);
     folderNode2.children.push(folderNode3);
 
-    nodeStoreMap.set(rootNode.id, writable(rootNode));
-    nodeStoreMap.set(folderNode1.id, writable(folderNode1));
-    nodeStoreMap.set(folderNode2.id, writable(folderNode2));
-    nodeStoreMap.set(folderNode3.id, writable(folderNode3));
+    folderNodeMap.set(rootNode.id, writable(rootNode));
+    folderNodeMap.set(folderNode1.id, writable(folderNode1));
+    folderNodeMap.set(folderNode2.id, writable(folderNode2));
+    folderNodeMap.set(folderNode3.id, writable(folderNode3));
 
     // Enable filter
     currentFilterActive = true;