docEngine->callHierarchy: Remove redundant tree-branches

- `{{>p1}} {{>p1}}` will now only create one tree-node - Better cycle detection for this kind of template (e.g. templates that call themselves twice
bootprint · Jun 20, 2017 · 1ea2db7 · 1ea2db7
1 parent 2763196
commit 1ea2db7
Show file tree

Hide file tree

Showing 2 changed files with 121 additions and 5 deletions.
diff --git a/lib/partial-details.js b/lib/partial-details.js
@@ -49,7 +49,11 @@ function hierarchy (config) {
         type: 'template',
         path: template.path,
         comments: template.comments,
-        children: template.callsPartial.map((callee) => partialForCallTree(callee.name, partials))
+        children: template.callsPartial
+          .map((callee) => callee.name)
+          // Remove redundant names (only take the first one)
+          .filter((name, index, array) => array.indexOf(name) === index)
+          .map((name) => partialForCallTree(name, partials, {}))
       }
     })
   }
@@ -64,17 +68,20 @@ function hierarchy (config) {
  * @returns {{name: *, type: string, comment}}
  */
 function partialForCallTree (name, partials, visitedNodes) {
-  visitedNodes = visitedNodes || {}
+  const cycleFound = visitedNodes[name]
   try {
-    const cycleFound = visitedNodes[name]
     visitedNodes[name] = true
     const partial = partials[name]
     if (!partial) {
       throw new Error(`Missing partial "${name}"`)
     }
     let children
     if (!cycleFound) {
-      children = partial.callsPartial.map((callee) => partialForCallTree(callee.name, partials, visitedNodes))
+      children = partial.callsPartial
+        .map((callee) => callee.name)
+        // Remove redundant names (only take the first one)
+        .filter((name, index, array) => array.indexOf(name) === index)
+        .map((name) => partialForCallTree(name, partials, visitedNodes))
     }
     return {
       name,
@@ -85,7 +92,9 @@ function partialForCallTree (name, partials, visitedNodes) {
       cycleFound
     }
   } finally {
-    delete visitedNodes[name]
+    if (!cycleFound) {
+      delete visitedNodes[name]
+    }
   }
 }
 

diff --git a/test/partial-details-spec.js b/test/partial-details-spec.js
@@ -337,7 +337,114 @@ describe('partial-details:', function () {
                   'children': undefined
                 }]
               }]
+            }]
+          }
+        ]
+      })
+    })
+
+    it('should break cycles when a partial is called twice in the cycle', function () {
+      expect(hierarchy({
+        templates: {
+          'dir/a.txt': {
+            path: 'src/dir/a.txt.hbs',
+            contents: 'a {{>p1}} a'
+          }
+        },
+        partials: {
+          'p1': {
+            path: 'src/prt/p1.hbs',
+            contents: 'p1 {{>p1}} {{>p1}} p1'
+          }
+        }
+      })).to.deep.equal({
+        children: [
+          {
+            'name': 'dir/a.txt',
+            'path': 'src/dir/a.txt.hbs',
+            'type': 'template',
+            'comments': [],
+            'children': [{
+              'name': 'p1',
+              'path': 'src/prt/p1.hbs',
+              'type': 'partial',
+              'comments': [],
+              'cycleFound': undefined,
+              'children': [{
+                'name': 'p1',
+                'path': 'src/prt/p1.hbs',
+                'type': 'partial',
+                'comments': [],
+                'cycleFound': true,
+                'children': undefined
+              }]
+            }]
+          }
+        ]
+      })
+    })
 
+    it('should allow calling the same partial twice', function () {
+      expect(hierarchy({
+        templates: {
+          'dir/a.txt': {
+            path: 'src/dir/a.txt.hbs',
+            contents: 'a {{>p1}} {{>p1}} a'
+          }
+        },
+        partials: {
+          'p1': {
+            path: 'src/prt/p1.hbs',
+            contents: 'p1'
+          }
+        }
+      })).to.deep.equal({
+        children: [
+          {
+            'name': 'dir/a.txt',
+            'path': 'src/dir/a.txt.hbs',
+            'type': 'template',
+            'comments': [],
+            'children': [{
+              'name': 'p1',
+              'path': 'src/prt/p1.hbs',
+              'type': 'partial',
+              'comments': [],
+              'cycleFound': undefined,
+              'children': []
+            }]
+          }
+        ]
+      })
+    })
+    it('should allow calling the same partial twice', function () {
+      expect(hierarchy({
+        templates: {
+          'dir/a.txt': {
+            path: 'src/dir/a.txt.hbs',
+            contents: 'a {{>p1}} {{>p1}} a'
+          }
+        },
+        partials: {
+          'p1': {
+            path: 'src/prt/p1.hbs',
+            contents: 'p1'
+          }
+        }
+      })).to.deep.equal({
+        children: [
+          {
+            'name': 'dir/a.txt',
+            'path': 'src/dir/a.txt.hbs',
+            'type': 'template',
+            'comments': [],
+            'children': [{
+              'name': 'p1',
+              'path': 'src/prt/p1.hbs',
+              'type': 'partial',
+              'comments': [],
+              'cycleFound': undefined,
+              'children': []
             }]
           }
         ]