fillOdtElementTemplate now takes an array of nodes as argument for the situation of calling it on the middleContent of a block with several elements so they're evaluated together

scripts/odf/templating/fillOdtElementTemplate.js

@@ -14,7 +14,7 @@ class TemplateDOMBranch{
     /** @type {Node} */
     #leafNode
 
-    // ancestors with this.#ancestors[0] === this.#startNode and this.#ancestors.at(-1) === this.#leafNode
+    // ancestors with this.#ancestors[0] === this.#branchBaseNode and this.#ancestors.at(-1) === this.#leafNode
     /** @type {Node[]} */
     #ancestors
 
@@ -235,9 +235,12 @@ class TemplateBlock{
         }
         //console.log('[fillBlockContentTemplate] after startChild')
 
-        for(const content of this.#middleContent){
+        
-            fillOdtElementTemplate(content, compartement)
+        // if content consists of several parts of an {#each}{/each}
-        }
+        // when arriving to the {/each}, it will be alone (and imbalanced)
+        // and will trigger an error
+        fillOdtElementTemplate(Array.from(this.#middleContent), compartement)
+
         //console.log('[fillBlockContentTemplate] after middleContent')
 
         const endChild = this.endBranch.at(1)
@@ -554,14 +557,22 @@ function fillEachBlock(startNode, iterableExpression, itemExpression, endNode, c
 const IF = ifStartMarkerRegex.source
 const EACH = eachStartMarkerRegex.source
 
+/** @typedef {Element | DocumentFragment | Document} RootElementArgument */
+
+
 /**
  * 
- * @param {Element | DocumentFragment | Document} rootElement 
+ * @param {RootElementArgument | RootElementArgument[]} rootElements
  * @param {Compartment} compartment 
  * @returns {void}
  */
-export default function fillOdtElementTemplate(rootElement, compartment) {
+export default function fillOdtElementTemplate(rootElements, compartment) {
-    //console.log('[fillTemplatedOdtElement]', rootElement.nodeType, rootElement.nodeName, rootElement.textContent)
+    
+    if(!Array.isArray(rootElements)){
+        rootElements = [rootElements]
+    }
+
+    //console.log('[fillTemplatedOdtElement]', rootElements.length, rootElements[0].nodeType, rootElements[0].nodeName, rootElements[0].textContent)
     //console.log('[fillTemplatedOdtElement]', rootElement.documentElement && rootElement.documentElement.textContent)
 
     let currentlyOpenBlocks = []
@@ -585,187 +596,197 @@ export default function fillOdtElementTemplate(rootElement, compartment) {
     // Traverse "in document order"
 
 
-    // @ts-ignore
+    for(const rootElement of rootElements){
-    traverse(rootElement, currentNode => {
-        //console.log('currentlyOpenBlocks', currentlyOpenBlocks)
 
-        const insideAnOpenBlock = currentlyOpenBlocks.length >= 1
+        // @ts-ignore
+        traverse(rootElement, currentNode => {
+            //console.log('currentlyOpenBlocks', currentlyOpenBlocks)
 
-        if(currentNode.nodeType === Node.TEXT_NODE) {
+            const insideAnOpenBlock = currentlyOpenBlocks.length >= 1
-            const text = currentNode.textContent || ''
 
-            /**
+            if(currentNode.nodeType === Node.TEXT_NODE) {
-             * looking for {#each x as y}
+                const text = currentNode.textContent || ''
-             */
-            const eachStartMatch = text.match(eachStartMarkerRegex);
 
-            if(eachStartMatch) {
+                /**
-                //console.log('startMatch', startMatch)
+                 * looking for {#each x as y}
+                 */
+                const eachStartMatch = text.match(eachStartMarkerRegex);
 
-                currentlyOpenBlocks.push(EACH)
+                if(eachStartMatch) {
+                    //console.log('startMatch', startMatch)
 
-                if(insideAnOpenBlock) {
+                    currentlyOpenBlocks.push(EACH)
-                    // do nothing 
-                }
-                else {
-                    let [_, _iterableExpression, _itemExpression] = eachStartMatch
 
-                    eachBlockIterableExpression = _iterableExpression
+                    if(insideAnOpenBlock) {
-                    eachBlockItemExpression = _itemExpression
+                        // do nothing 
-                    eachOpeningMarkerNode = currentNode
+                    }
-                }
+                    else {
-            }
+                        let [_, _iterableExpression, _itemExpression] = eachStartMatch
-
+
-
+                        eachBlockIterableExpression = _iterableExpression
-            /**
+                        eachBlockItemExpression = _itemExpression
-             * Looking for {/each}
+                        eachOpeningMarkerNode = currentNode
-             */
-            const isEachClosingBlock = text.includes(eachClosingMarker)
-
-            if(isEachClosingBlock) {
-
-                //console.log('isEachClosingBlock', isEachClosingBlock)
-
-                if(!eachOpeningMarkerNode)
-                    throw new Error(`{/each} found without corresponding opening {#each x as y}`)
-
-                if(currentlyOpenBlocks.at(-1) !== EACH)
-                    throw new Error(`{/each} found while the last opened block was not an opening {#each x as y}`)
-
-                if(currentlyOpenBlocks.length === 1) {
-                    eachClosingMarkerNode = currentNode
-
-                    // found an {#each} and its corresponding {/each}
-                    // execute replacement loop
-                    fillEachBlock(eachOpeningMarkerNode, eachBlockIterableExpression, eachBlockItemExpression, eachClosingMarkerNode, compartment)
-
-                    eachOpeningMarkerNode = undefined
-                    eachBlockIterableExpression = undefined
-                    eachBlockItemExpression = undefined
-                    eachClosingMarkerNode = undefined
-                }
-                else {
-                    // ignore because it will be treated as part of the outer {#each}
-                }
-
-                currentlyOpenBlocks.pop()
-            }
-
-
-            /**
-             * Looking for {#if ...}
-             */
-            const ifStartMatch = text.match(ifStartMarkerRegex);
-
-            if(ifStartMatch) {
-                currentlyOpenBlocks.push(IF)
-
-                if(insideAnOpenBlock) {
-                    // do nothing because the marker is too deep
-                }
-                else {
-                    let [_, _ifBlockConditionExpression] = ifStartMatch
-
-                    ifBlockConditionExpression = _ifBlockConditionExpression
-                    ifOpeningMarkerNode = currentNode
-                }
-            }
-
-
-            /**
-             * Looking for {:else}
-             */
-            const hasElseMarker = text.includes(elseMarker);
-
-            if(hasElseMarker) {
-                if(!insideAnOpenBlock)
-                    throw new Error('{:else} without a corresponding {#if}')
-
-                if(currentlyOpenBlocks.length === 1) {
-                    if(currentlyOpenBlocks[0] === IF) {
-                        ifElseMarkerNode = currentNode
                     }
-                    else
-                        throw new Error('{:else} inside an {#each} but without a corresponding {#if}')
                 }
-                else {
-                    // do nothing because the marker is too deep
-                }
-            }
 
 
-            /**
+                /**
-             * Looking for {/if}
+                 * Looking for {/each}
-             */
+                 */
-            const ifClosingMarker = text.includes(closingIfMarker);
+                const isEachClosingBlock = text.includes(eachClosingMarker)
 
-            if(ifClosingMarker) {
+                if(isEachClosingBlock) {
-                if(!insideAnOpenBlock)
-                    throw new Error('{/if} without a corresponding {#if}')
 
-                if(currentlyOpenBlocks.length === 1) {
+                    //console.log('isEachClosingBlock', isEachClosingBlock)
-                    if(currentlyOpenBlocks[0] === IF) {
-                        ifClosingMarkerNode = currentNode
 
-                        // found an {#if} and its corresponding {/if}
+                    if(!eachOpeningMarkerNode){
+                        throw new Error(`{/each} found without corresponding opening {#each x as y}`)
+                    }
+
+                    if(currentlyOpenBlocks.at(-1) !== EACH)
+                        throw new Error(`{/each} found while the last opened block was not an opening {#each x as y}`)
+
+                    if(currentlyOpenBlocks.length === 1) {
+                        eachClosingMarkerNode = currentNode
+
+                        // found an {#each} and its corresponding {/each}
                         // execute replacement loop
-                        fillIfBlock(ifOpeningMarkerNode, ifElseMarkerNode, ifClosingMarkerNode, ifBlockConditionExpression, compartment)
+                        //console.log('start of fillEachBlock')
 
-                        ifOpeningMarkerNode = undefined
+                        fillEachBlock(eachOpeningMarkerNode, eachBlockIterableExpression, eachBlockItemExpression, eachClosingMarkerNode, compartment)
-                        ifElseMarkerNode = undefined
+
-                        ifClosingMarkerNode = undefined
+                        //console.log('end of fillEachBlock')
-                        ifBlockConditionExpression = undefined
+
+                        eachOpeningMarkerNode = undefined
+                        eachBlockIterableExpression = undefined
+                        eachBlockItemExpression = undefined
+                        eachClosingMarkerNode = undefined
+                    }
+                    else {
+                        // ignore because it will be treated as part of the outer {#each}
+                    }
+
+                    //console.log('popping currentlyOpenBlocks')
+                    currentlyOpenBlocks.pop()
+                }
+
+
+                /**
+                 * Looking for {#if ...}
+                 */
+                const ifStartMatch = text.match(ifStartMarkerRegex);
+
+                if(ifStartMatch) {
+                    currentlyOpenBlocks.push(IF)
+
+                    if(insideAnOpenBlock) {
+                        // do nothing because the marker is too deep
+                    }
+                    else {
+                        let [_, _ifBlockConditionExpression] = ifStartMatch
+
+                        ifBlockConditionExpression = _ifBlockConditionExpression
+                        ifOpeningMarkerNode = currentNode
+                    }
+                }
+
+
+                /**
+                 * Looking for {:else}
+                 */
+                const hasElseMarker = text.includes(elseMarker);
+
+                if(hasElseMarker) {
+                    if(!insideAnOpenBlock)
+                        throw new Error('{:else} without a corresponding {#if}')
+
+                    if(currentlyOpenBlocks.length === 1) {
+                        if(currentlyOpenBlocks[0] === IF) {
+                            ifElseMarkerNode = currentNode
+                        }
+                        else
+                            throw new Error('{:else} inside an {#each} but without a corresponding {#if}')
+                    }
+                    else {
+                        // do nothing because the marker is too deep
+                    }
+                }
+
+
+                /**
+                 * Looking for {/if}
+                 */
+                const ifClosingMarker = text.includes(closingIfMarker);
+
+                if(ifClosingMarker) {
+                    if(!insideAnOpenBlock)
+                        throw new Error('{/if} without a corresponding {#if}')
+
+                    if(currentlyOpenBlocks.length === 1) {
+                        if(currentlyOpenBlocks[0] === IF) {
+                            ifClosingMarkerNode = currentNode
+
+                            // found an {#if} and its corresponding {/if}
+                            // execute replacement loop
+                            fillIfBlock(ifOpeningMarkerNode, ifElseMarkerNode, ifClosingMarkerNode, ifBlockConditionExpression, compartment)
+
+                            ifOpeningMarkerNode = undefined
+                            ifElseMarkerNode = undefined
+                            ifClosingMarkerNode = undefined
+                            ifBlockConditionExpression = undefined
+                        }
+                        else
+                            throw new Error('{/if} inside an {#each} but without a corresponding {#if}')
+                    }
+                    else {
+                        // do nothing because the marker is too deep
+                    }
+
+                    currentlyOpenBlocks.pop()
+                }
+
+
+                /**
+                 * Looking for variables for substitutions
+                 */
+                if(!insideAnOpenBlock) {
+                    // @ts-ignore
+                    if(currentNode.data) {
+                        // @ts-ignore
+                        const placesToFill = findPlacesToFillInString(currentNode.data, compartment)
+
+                        if(placesToFill) {
+                            const newText = placesToFill.fill()
+                            // @ts-ignore
+                            const newTextNode = currentNode.ownerDocument?.createTextNode(newText)
+                            // @ts-ignore
+                            currentNode.parentNode?.replaceChild(newTextNode, currentNode)
+                        }
                     }
-                    else
-                        throw new Error('{/if} inside an {#each} but without a corresponding {#if}')
                 }
                 else {
-                    // do nothing because the marker is too deep
+                    // ignore because it will be treated as part of the outer {#each} block
                 }
-
-                currentlyOpenBlocks.pop()
             }
 
-
+            if(currentNode.nodeType === Node.ATTRIBUTE_NODE) {
-            /**
+                // Looking for variables for substitutions
-             * Looking for variables for substitutions
+                if(!insideAnOpenBlock) {
-             */
-            if(!insideAnOpenBlock) {
-                // @ts-ignore
-                if(currentNode.data) {
                     // @ts-ignore
-                    const placesToFill = findPlacesToFillInString(currentNode.data, compartment)
+                    if(currentNode.value) {
-
-                    if(placesToFill) {
-                        const newText = placesToFill.fill()
                         // @ts-ignore
-                        const newTextNode = currentNode.ownerDocument?.createTextNode(newText)
+                        const placesToFill = findPlacesToFillInString(currentNode.value, compartment)
-                        // @ts-ignore
+                        if(placesToFill) {
-                        currentNode.parentNode?.replaceChild(newTextNode, currentNode)
+                            // @ts-ignore
+                            currentNode.value = placesToFill.fill()
+                        }
                     }
                 }
-            }
+                else {
-            else {
+                    // ignore because it will be treated as part of the {#each} block
-                // ignore because it will be treated as part of the outer {#each} block
-            }
-        }
-
-        if(currentNode.nodeType === Node.ATTRIBUTE_NODE) {
-            // Looking for variables for substitutions
-            if(!insideAnOpenBlock) {
-                // @ts-ignore
-                if(currentNode.value) {
-                    // @ts-ignore
-                    const placesToFill = findPlacesToFillInString(currentNode.value, compartment)
-                    if(placesToFill) {
-                        // @ts-ignore
-                        currentNode.value = placesToFill.fill()
-                    }
                 }
             }
-            else {
+        })
-                // ignore because it will be treated as part of the {#each} block
+
-            }
+    }
-        }
-    })
 }

tests/fill-odt-template/each.js

@@ -6,7 +6,7 @@ import {getOdtTemplate} from '../../scripts/odf/odtTemplate-forNode.js'
 import {fillOdtTemplate, getOdtTextContent} from '../../exports.js'
 
 
-test.skip('basic template filling with {#each}', async t => {
+test('basic template filling with {#each}', async t => {
     const templatePath = join(import.meta.dirname, '../fixtures/enum-courses.odt')
     const templateContent = `🧺 La liste de courses incroyable 🧺
 
@@ -44,7 +44,7 @@ Pâtes à lasagne (fraîches !)
 });
 
 
-test.skip('Filling with {#each} and non-iterable value results in no error and empty result', async t => {
+test('Filling with {#each} and non-iterable value results in no error and empty result', async t => {
     const templatePath = join(import.meta.dirname, '../fixtures/enum-courses.odt')
     const templateContent = `🧺 La liste de courses incroyable 🧺
 
@@ -74,7 +74,7 @@ test.skip('Filling with {#each} and non-iterable value results in no error and e
 });
 
 
-test.skip('template filling with {#each} generating a list', async t => {
+test('template filling with {#each} generating a list', async t => {
     const templatePath = join(import.meta.dirname, '../fixtures/liste-courses.odt')
     const templateContent = `🧺 La liste de courses incroyable 🧺
 
@@ -111,7 +111,7 @@ test.skip('template filling with {#each} generating a list', async t => {
 });
 
 
-test.skip('template filling with 2 sequential {#each}', async t => {
+test('template filling with 2 sequential {#each}', async t => {
     const templatePath = join(import.meta.dirname, '../fixtures/liste-fruits-et-légumes.odt')
     const templateContent = `Liste de fruits et légumes
 
@@ -163,7 +163,7 @@ Poivron 🫑
 });
 
 
-test.skip('template filling with nested {#each}s', async t => {
+test('template filling with nested {#each}s', async t => {
     const templatePath = join(import.meta.dirname, '../fixtures/légumes-de-saison.odt')
     const templateContent = `Légumes de saison
 
@@ -248,7 +248,7 @@ Hiver
 });
 
 
-test.skip('template filling with text after {/each} in same text node', async t => {
+test('template filling with text after {/each} in same text node', async t => {
     const templatePath = join(import.meta.dirname, '../fixtures/text-after-closing-each.odt')
     const templateContent = `Légumes de saison
 
@@ -285,7 +285,7 @@ Blette,
 });
 
 
-test.skip('template filling of a table', async t => {
+test('template filling of a table', async t => {
     const templatePath = join(import.meta.dirname, '../fixtures/tableau-simple.odt')
     const templateContent = `Évolution énergie en kWh par personne en France
 
@@ -346,8 +346,8 @@ Année
 });
 
 
-test('Mysterious {#each} bug', async t => {
+test('nested each without common ancestor for inner each', async t => {
-    const templatePath = join(import.meta.dirname, '../fixtures/minimal-testcase-audrey.odt')
+    const templatePath = join(import.meta.dirname, '../fixtures/nested-each-without-common-ancestor-for-inner-each.odt')
     const templateContent = `{#each liste_espèces_par_impact as élément}
 {#each élément.liste_espèces as espèce}
 {/each}