Make treeData to flatData converter more general

Author: fritz-c

src/react-sortable-tree.js

@@ -9,7 +9,7 @@ import { AutoSizer, VirtualScroll } from 'react-virtualized';
 import TreeNode from './tree-node';
 import {
     walk,
-    getVisibleNodeInfoFlattened,
+    getFlatDataFromTree,
     changeNodeAtPath,
     removeNodeAtPath,
     addNodeUnderParentPath,
@@ -72,10 +72,7 @@ class ReactSortableTree extends Component {
 
         this.state = {
             draggingTreeData: null,
-            rows: getVisibleNodeInfoFlattened({
-                treeData: props.treeData,
-                getNodeKey: this.getNodeKey,
-            }),
+            rows: this.getRows(props.treeData),
         };
 
         this.startDrag = this.startDrag.bind(this);
@@ -93,10 +90,7 @@ class ReactSortableTree extends Component {
             // Calculate the rows to be shown from the new tree data
             this.setState({
                 draggingTreeData: null,
-                rows: getVisibleNodeInfoFlattened({
-                    treeData: nextProps.treeData,
-                    getNodeKey: this.getNodeKey,
-                }),
+                rows: this.getRows(nextProps.treeData),
             });
         }
     }
@@ -110,21 +104,23 @@ class ReactSortableTree extends Component {
 
         this.setState({
             draggingTreeData,
-            rows: getVisibleNodeInfoFlattened({
-                treeData: draggingTreeData,
-                getNodeKey: this.getNodeKey,
-            }),
+            rows: this.getRows(draggingTreeData),
+        });
+    }
+
+    getRows(treeData) {
+        return getFlatDataFromTree({
+            ignoreCollapsed: true,
+            getNodeKey: this.getNodeKey,
+            treeData,
         });
     }
 
     endDrag({ node, path }, dropResult) {
         if (!dropResult) {
             return this.setState({
                 draggingTreeData: null,
-                rows: getVisibleNodeInfoFlattened({
-                    treeData: this.props.treeData,
-                    getNodeKey: this.getNodeKey,
-                }),
+                rows: this.getRows(this.props.treeData),
             });
         }
 

src/utils/tree-data-utils.js

@@ -276,36 +276,6 @@ export function map({ treeData, getNodeKey, callback, ignoreCollapsed = false })
     }).node.children;
 }
 
-/**
- * Get visible node data flattened.
- *
- * @param {!Object[]} treeData - Tree data
- * @param {!function} getNodeKey - Function to get the key from the nodeData and tree index
- *
- * @return {{
- *      node: Object,
- *      path: []string|[]number,
- *      lowerSiblingCounts: []number
- *  }}[] nodes - The node array
- */
-export function getVisibleNodeInfoFlattened({ treeData, getNodeKey }) {
-    if (!treeData || treeData.length < 1) {
-        return [];
-    }
-
-    const flattened = [];
-    walk({
-        treeData,
-        getNodeKey,
-        ignoreCollapsed: true,
-        callback: ({ node, lowerSiblingCounts, path, treeIndex }) => {
-            flattened[treeIndex] = { node, lowerSiblingCounts, path };
-        },
-    });
-
-    return flattened;
-}
-
 /**
  * Replaces node at path with object, or callback-defined object
  *
@@ -460,6 +430,37 @@ export function addNodeUnderParentPath({
     });
 }
 
+/**
+ * Get tree data flattened.
+ *
+ * @param {!Object[]} treeData - Tree data
+ * @param {!function} getNodeKey - Function to get the key from the nodeData and tree index
+ * @param {boolean=} ignoreCollapsed - Ignore children of nodes without `expanded` set to `true`
+ *
+ * @return {{
+ *      node: Object,
+ *      path: []string|[]number,
+ *      lowerSiblingCounts: []number
+ *  }}[] nodes - The node array
+ */
+export function getFlatDataFromTree({ treeData, getNodeKey, ignoreCollapsed = false }) {
+    if (!treeData || treeData.length < 1) {
+        return [];
+    }
+
+    const flattened = [];
+    walk({
+        treeData,
+        getNodeKey,
+        ignoreCollapsed,
+        callback: ({ node, lowerSiblingCounts, path }) => {
+            flattened.push({ node, lowerSiblingCounts, path });
+        },
+    });
+
+    return flattened;
+}
+
 /**
  * Generate a tree structure from flat data.
  *
@@ -508,5 +509,3 @@ export function getTreeFromFlatData({
 
     return childrenToParents[rootKey].map(child => trav(child));
 }
-
-// Performs change to every node in the tree

src/utils/tree-data-utils.test.js

@@ -3,7 +3,7 @@ import {
     getVisibleNodeInfoAtIndex,
     changeNodeAtPath,
     getTreeFromFlatData,
-    getVisibleNodeInfoFlattened,
+    getFlatDataFromTree,
     walk,
     map,
 } from './tree-data-utils';
@@ -268,19 +268,24 @@ describe('getVisibleNodeInfoAtIndex', () => {
 });
 
 
-describe('getVisibleNodeInfoAtIndex', () => {
+describe('getFlatDataFromTree', () => {
     it('should handle empty data', () => {
-        expect(getVisibleNodeInfoFlattened({treeData: [], getNodeKey: keyFromTreeIndex})).toEqual([]);
-        expect(getVisibleNodeInfoFlattened({treeData: null, getNodeKey: keyFromTreeIndex})).toEqual([]);
-        expect(getVisibleNodeInfoFlattened({treeData: undefined, getNodeKey: keyFromTreeIndex})).toEqual([]);
+        expect(getFlatDataFromTree({treeData: [], getNodeKey: keyFromTreeIndex})).toEqual([]);
+        expect(getFlatDataFromTree({treeData: null, getNodeKey: keyFromTreeIndex})).toEqual([]);
+        expect(getFlatDataFromTree({treeData: undefined, getNodeKey: keyFromTreeIndex})).toEqual([]);
     });
 
     it('should handle flat data', () => {
-        expect(getVisibleNodeInfoFlattened({ treeData: [ { key: 0 } ], getNodeKey: keyFromTreeIndex })).toEqual([
+        expect(getFlatDataFromTree({
+            ignoreCollapsed: true,
+            getNodeKey: keyFromTreeIndex,
+            treeData: [ { key: 0 } ],
+        })).toEqual([
             { node: { key: 0 }, path: [0], lowerSiblingCounts: [ 0 ] },
         ]);
 
-        expect(getVisibleNodeInfoFlattened({
+        expect(getFlatDataFromTree({
+            ignoreCollapsed: true,
             treeData: [ { key: 0 }, { key: 1 } ],
             getNodeKey: keyFromTreeIndex
         })).toEqual([
@@ -312,7 +317,11 @@ describe('getVisibleNodeInfoAtIndex', () => {
             { key: 6 },
         ];
 
-        expect(getVisibleNodeInfoFlattened({ treeData, getNodeKey: keyFromTreeIndex })).toEqual([
+        expect(getFlatDataFromTree({
+            ignoreCollapsed: true,
+            getNodeKey: keyFromTreeIndex,
+            treeData,
+        })).toEqual([
             { node: treeData[0], path: [0], lowerSiblingCounts: [ 1 ] },
             { node: treeData[1], path: [1], lowerSiblingCounts: [ 0 ] }
         ]);
@@ -343,7 +352,11 @@ describe('getVisibleNodeInfoAtIndex', () => {
             { key: 6 },
         ];
 
-        expect(getVisibleNodeInfoFlattened({ treeData, getNodeKey: keyFromKey })).toEqual([
+        expect(getFlatDataFromTree({
+            ignoreCollapsed: true,
+            getNodeKey: keyFromKey,
+            treeData,
+        })).toEqual([
             { node: treeData[0],                         path: [0],       lowerSiblingCounts: [ 1 ] },
             { node: treeData[0].children[0],             path: [0, 1],    lowerSiblingCounts: [ 1, 1 ] },
             { node: treeData[0].children[1],             path: [0, 4],    lowerSiblingCounts: [ 1, 0 ] },
@@ -378,7 +391,11 @@ describe('getVisibleNodeInfoAtIndex', () => {
             { key: 6 },
         ];
 
-        expect(getVisibleNodeInfoFlattened({ treeData, getNodeKey: keyFromTreeIndex })).toEqual([
+        expect(getFlatDataFromTree({
+            ignoreCollapsed: true,
+            treeData,
+            getNodeKey: keyFromTreeIndex,
+        })).toEqual([
             { node: treeData[0],                         path: [0],       lowerSiblingCounts: [1] },
             { node: treeData[0].children[0],             path: [0, 1],    lowerSiblingCounts: [1, 1] },
             { node: treeData[0].children[0].children[0], path: [0, 1, 2], lowerSiblingCounts: [1, 1, 1] },