PostalPortal/odfjs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

passing test with {#each ...} and text before partially formatted

Browse Source
This commit is contained in:
David Bruant 2025-05-08 16:47:25 +02:00
parent 3793923c79
commit b859f62412
3 changed files with 125 additions and 244 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

342
scripts/odf/templating/prepareTemplateDOMTree.js
View File

@ -97,173 +97,64 @@ function getNodeTextPosition(node, containerTextNodes) {
/** @typedef {Node[]} DOMPath */ /** @typedef {Node[]} DOMPath */
/** /**
* get the path from ancestor to descendant * remove nodes between startNode and endNode
* but keep startNode and endNode
* *
* @param {Node} node * returns the common ancestor child in start branch
* @param {Node} ancestor * for the purpose for inserting something between startNode and endNode
* @returns {DOMPath} * with insertionPoint.parentNode.insertBefore(newBetweenContent, insertionPoint)
*/
function getPathToNode(node, ancestor) {
/** @type {DOMPath} */
const path = [];
let current = node;
while(current && current !== ancestor) {
path.unshift(current);
current = current.parentNode;
}
return path;
}
/**
* find the point where two paths diverge
* *
* @param {DOMPath} path1 * @param {Node} startNode
* @param {DOMPath} path2 * @param {Node} endNode
* @returns {Node | undefined} * @returns {Node}
*/ */
function findDivergingPoint(path1, path2) { function removeNodesBetween(startNode, endNode) {
for(let i = 0; i < Math.min(path1.length, path2.length); i++) { let nodesToRemove = new Set();
if(path1[i] !== path2[i]) {
return path1[i - 1] || undefined; // Return the last common node // find both ancestry branch
const startNodeAncestors = new Set(getAncestors(startNode))
const endNodeAncestors = new Set(getAncestors(endNode))
// find common ancestor
const commonAncestor = findCommonAncestor(startNode, endNode)
// remove everything "on the right" of start branch
let currentAncestor = startNode
let commonAncestorChildInEndNodeBranch
while(currentAncestor !== commonAncestor){
let siblingToRemove = currentAncestor.nextSibling
while(siblingToRemove && !endNodeAncestors.has(siblingToRemove)){
nodesToRemove.add(siblingToRemove)
siblingToRemove = siblingToRemove.nextSibling
} }
if(endNodeAncestors.has(siblingToRemove)){
commonAncestorChildInEndNodeBranch = siblingToRemove
}
currentAncestor = currentAncestor.parentNode;
} }
// One path is a prefix of the other // remove everything "on the left" of end branch
return path1[Math.min(path1.length, path2.length) - 1]; currentAncestor = endNode
}
/** while(currentAncestor !== commonAncestor){
* handle the case where start and end nodes have a direct relationship let siblingToRemove = currentAncestor.previousSibling
* @param {Text} startNode
* @param {Text} endNode while(siblingToRemove && !startNodeAncestors.has(siblingToRemove)){
* @param {number} posInStartNode nodesToRemove.add(siblingToRemove)
* @param {number} posInEndNode siblingToRemove = siblingToRemove.previousSibling
* @param {string} markerText
*/
function consolidateDirectRelationship(startNode, endNode, posInStartNode, posInEndNode, markerText) {
const startNodeParent = startNode.parentNode;
const endNodeParent = endNode.parentNode;
const document = startNode.ownerDocument;
console.log('consolidateDirectRelationship - startNodeParent === endNodeParent', startNodeParent === endNodeParent)
if(startNodeParent === endNodeParent) {
// Siblings case
let currentNode = startNode;
let nextSibling;
// Handle start node - split if needed to preserve text before marker
if(posInStartNode > 0) {
console.log('posInStartNode > 0', posInStartNode)
console.log('startNode', startNode.textContent)
// Split text node to preserve text before marker
const remainingNode = startNode.splitText(posInStartNode);
currentNode = remainingNode.previousSibling; // Now we'll work with the second part
remainingNode.parentNode?.removeChild(remainingNode)
console.log('remainingNode', remainingNode.textContent)
} }
// Create marker node currentAncestor = currentAncestor.parentNode;
const markerNode = document.createTextNode(markerText);
// Insert marker after current node
if(currentNode.nextSibling) {
startNodeParent.insertBefore(markerNode, currentNode.nextSibling);
} else {
startNodeParent.appendChild(markerNode);
}
// Remove nodes between start split and end node
currentNode = markerNode.nextSibling;
while(currentNode && currentNode !== endNode) {
nextSibling = currentNode.nextSibling;
startNodeParent.removeChild(currentNode);
currentNode = nextSibling;
}
// Handle end node - split if needed to preserve text after marker
if(posInEndNode < endNode.textContent.length) {
// Split to keep text after marker
endNode.splitText(posInEndNode);
// First part (up to the split point) should be removed
startNodeParent.removeChild(endNode);
} else {
// No text after marker, remove the entire end node
startNodeParent.removeChild(endNode);
}
} else {
// Handle nested case (one is ancestor of other)
// This is more complex and needs customized handling
// Simplified approach: replace everything with marker
// A more sophisticated approach would be needed for production
const isStartAncestorOfEnd = isAncestor(startNode, endNode);
if(isStartAncestorOfEnd) {
replaceWithMarker(startNode, markerText);
} else {
replaceWithMarker(endNode, markerText);
}
}
}
/**
* check if one node is ancestor of another
*
* @param {Node} potentialAncestor
* @param {Node} node
* @returns {boolean}
*/
function isAncestor(potentialAncestor, node) {
let current = node.parentNode;
while(current) {
if(current === potentialAncestor) return true;
current = current.parentNode;
}
return false;
}
/**
* replace a node with marker text
* @param {Node} node
* @param {string} markerText
*/
function replaceWithMarker(node, markerText) {
const document = node.ownerDocument;
const markerNode = document.createTextNode(markerText);
node.parentNode.replaceChild(markerNode, node);
}
/**
* remove nodes between two sibling branches
*
* @param {Node} startBranch
* @param {Node} endBranch
* @param {Node} commonAncestor
*/
function removeNodesBetween(startBranch, endBranch, commonAncestor) {
let removing = false;
let nodesToRemove = [];
for(let child = commonAncestor.firstChild; child; child = child.nextSibling) {
if(child === startBranch) {
removing = true;
continue; // Don't remove the start branch
}
if(removing) {
if(child === endBranch) {
break; // Stop when we reach end branch
}
nodesToRemove.push(child);
}
} }
// Remove all nodes marked for removal for(const node of nodesToRemove){
for(const nodeToRemove of nodesToRemove) { node.parentNode.removeChild(node)
commonAncestor.removeChild(nodeToRemove);
} }
return commonAncestorChildInEndNodeBranch
} }
/** /**
@ -292,6 +183,8 @@ function consolidateMarkers(document){
containerTextNodesInTreeOrder.push(/** @type {Text} */(node)) containerTextNodesInTreeOrder.push(/** @type {Text} */(node))
} }
}) })
console.log('containerTextNodesInTreeOrder', containerTextNodesInTreeOrder.map(n => n.textContent))
} }
refreshContainerTextNodes() refreshContainerTextNodes()
@ -310,9 +203,9 @@ function consolidateMarkers(document){
...findAllMatches(fullText, eachClosingMarker) ...findAllMatches(fullText, eachClosingMarker)
]; ];
console.log('positionedMarkers', positionedMarkers) if(positionedMarkers.length >= 1)
console.log('positionedMarkers', positionedMarkers)
// If no markers found, skip this container
while(consolidatedMarkers.length < positionedMarkers.length) { while(consolidatedMarkers.length < positionedMarkers.length) {
refreshContainerTextNodes() refreshContainerTextNodes()
@ -320,28 +213,25 @@ function consolidateMarkers(document){
for(const positionedMarker of positionedMarkers.slice(consolidatedMarkers.length)) { for(const positionedMarker of positionedMarkers.slice(consolidatedMarkers.length)) {
console.log('positionedMarker', positionedMarker) console.log('positionedMarker', positionedMarker)
let markerStart = -1;
let markerEnd = -1;
let currentPos = 0; let currentPos = 0;
let markerSpansNodes = false; let startNode;
let startNode = null; let endNode;
let endNode = null;
// Find which text node(s) contain this marker // Find which text node(s) contain this marker
for(const textNode of containerTextNodesInTreeOrder) { for(const textNode of containerTextNodesInTreeOrder) {
const nodeStart = currentPos; const nodeStart = currentPos;
const nodeEnd = nodeStart + textNode.textContent.length; const nodeEnd = nodeStart + textNode.textContent.length;
console.log('nodeStart, nodeEnd', nodeStart, nodeEnd)
// If start of marker is in this node // If start of marker is in this node
if(markerStart === -1 && positionedMarker.index >= nodeStart && positionedMarker.index < nodeEnd) { if(!startNode && positionedMarker.index >= nodeStart && positionedMarker.index < nodeEnd) {
markerStart = positionedMarker.index;
startNode = textNode; startNode = textNode;
} }
// If end of marker is in this node // If end of marker is in this node
if(markerStart !== -1 && positionedMarker.index + positionedMarker.marker.length > nodeStart && if(startNode && positionedMarker.index + positionedMarker.marker.length > nodeStart &&
positionedMarker.index + positionedMarker.marker.length <= nodeEnd) { positionedMarker.index + positionedMarker.marker.length <= nodeEnd) {
markerEnd = positionedMarker.index + positionedMarker.marker.length;
endNode = textNode; endNode = textNode;
break; break;
} }
@ -349,13 +239,15 @@ function consolidateMarkers(document){
currentPos = nodeEnd; currentPos = nodeEnd;
} }
/*if(!startNode){ console.log('startNode, endNode', startNode?.textContent, endNode?.textContent)
if(!startNode){
throw new Error(`Could not find startNode for marker '${positionedMarker.marker}'`) throw new Error(`Could not find startNode for marker '${positionedMarker.marker}'`)
}*/ }
/*if(!endNode){ if(!endNode){
throw new Error(`Could not find endNode for marker '${positionedMarker.marker}'`) throw new Error(`Could not find endNode for marker '${positionedMarker.marker}'`)
}*/ }
// Check if marker spans multiple nodes // Check if marker spans multiple nodes
if(startNode !== endNode) { if(startNode !== endNode) {
@ -371,86 +263,48 @@ function consolidateMarkers(document){
// Calculate the position within the end node // Calculate the position within the end node
let posInEndNode = (positionedMarker.index + positionedMarker.marker.length) - getNodeTextPosition(endNode, containerTextNodesInTreeOrder); let posInEndNode = (positionedMarker.index + positionedMarker.marker.length) - getNodeTextPosition(endNode, containerTextNodesInTreeOrder);
// Get the path from common ancestor to start and end nodes /** @type {Node} */
const pathToStart = getPathToNode(startNode, commonAncestor); let beforeStartNode = startNode
const pathToEnd = getPathToNode(endNode, commonAncestor);
// Find the diverging point in the paths // if there is before-text, split
const lowestCommonAncestorChild = findDivergingPoint(pathToStart, pathToEnd); if(posInStartNode > 0) {
// Text exists before the marker - preserve it
if(!lowestCommonAncestorChild) { // set newStartNode to a Text node containing only the marker beginning
// Direct parent-child relationship or other simple case const newStartNode = startNode.splitText(posInStartNode)
// Handle separately // startNode/beforeStartNode now contains only non-marker text
consolidateDirectRelationship(startNode, endNode, posInStartNode, posInEndNode, positionedMarker.marker);
} else {
// Complex case: we need to:
// 1. Preserve text before marker in startNode
// 2. Preserve text after marker in endNode
// 3. Replace everything in-between with marker text
// Get all nodes between the diverging branches (including the branches) // then, by definition of .splitText(posInStartNode):
const startBranch = pathToStart[pathToStart.indexOf(lowestCommonAncestorChild)]; posInStartNode = 0
const endBranch = pathToEnd[pathToEnd.indexOf(lowestCommonAncestorChild)];
// First, handle the start node - split if necessary // remove the marker beginning part from the tree (since the marker will be inserted in full later)
if(posInStartNode > 0) { newStartNode.parentNode?.removeChild(newStartNode)
// Text exists before the marker - preserve it
const textBeforeMarker = startNodeTextContent.substring(0, posInStartNode);
const parentOfStartNode = startNode.parentNode;
// Replace the start node with the text before marker
startNode.textContent = textBeforeMarker;
// Create a new node for the start of the marker
const startOfMarkerNode = document.createTextNode(positionedMarker.marker);
console.log('parentOfStartNode', parentOfStartNode)
// Insert after the modified start node
if(startNode.nextSibling) {
parentOfStartNode.insertBefore(startOfMarkerNode, startNode.nextSibling);
} else {
parentOfStartNode.appendChild(startOfMarkerNode);
}
} else {
// No text before marker, just replace the content
startNode.textContent = positionedMarker.marker;
}
// Handle the end node - split if necessary
if(posInEndNode < endNodeTextContent.length) {
// Text exists after the marker - preserve it
const textAfterMarker = endNodeTextContent.substring(posInEndNode);
const parentOfEndNode = endNode.parentNode;
// Replace the end node with just the text after marker
endNode.textContent = textAfterMarker;
// Create a new node for the end of the marker if needed
// Only needed if we haven't already added the full marker to the start node
if(posInStartNode > 0) {
const endOfMarkerNode = document.createTextNode(""); // Empty as marker is in start node
// Insert before the modified end node
parentOfEndNode.insertBefore(endOfMarkerNode, endNode);
}
} else {
// No text after marker
if(posInStartNode > 0) {
// If we preserved text before the marker, remove the end node
// as the marker is now fully in the start branch
endNode.parentNode.removeChild(endNode);
} else {
// Otherwise just replace the content
endNode.textContent = "";
}
}
// Now remove all nodes between start branch and end branch
// but not the branches themselves
removeNodesBetween(startBranch, endBranch, commonAncestor);
} }
/** @type {Node} */
let afterEndNode
// if there is after-text, split
if(posInEndNode < endNodeTextContent.length) {
// Text exists after the marker - preserve it
// set afterEndNode to a Text node containing only non-marker text
afterEndNode = endNode.splitText(posInEndNode);
// endNode now contains only the end of marker text
// then, by definition of .splitText(posInEndNode):
posInEndNode = endNodeTextContent.length
// remove the marker ending part from the tree (since the marker will be inserted in full later)
endNode.parentNode?.removeChild(endNode)
}
// then, replace all nodes between (new)startNode and (new)endNode with a single textNode in commonAncestor
const insertionPoint = removeNodesBetween(beforeStartNode, afterEndNode)
const markerTextNode = insertionPoint.ownerDocument.createTextNode(positionedMarker.marker)
insertionPoint.parentNode.insertBefore(markerTextNode, insertionPoint)
// After consolidation, break as the DOM structure has changed // After consolidation, break as the DOM structure has changed
// and containerTextNodesInTreeOrder needs to be refreshed // and containerTextNodesInTreeOrder needs to be refreshed
consolidatedMarkers.push(positionedMarker) consolidatedMarkers.push(positionedMarker)

27
tests/fill-odt-template/formatting.js
View File

@ -56,4 +56,31 @@ Les nombres : {#each nombres as n}{n} {/each} !!
Les nombres : 2 3 5 8  !! Les nombres : 2 3 5 8  !!
`) `)
});
test('template filling - {#each ...} and text before partially formatted', async t => {
const templatePath = join(import.meta.dirname, '../fixtures/formatting-liste-nombres-each-start-and-before-formatted.odt')
const templateContent = `Liste de nombres
Les nombres : {#each nombres as n}{n} {/each} !!
`
const data = {
nombres : [3,5,8, 13]
}
const odtTemplate = await getOdtTemplate(templatePath)
const templateTextContent = await getOdtTextContent(odtTemplate)
t.deepEqual(templateTextContent, templateContent, 'reconnaissance du template')
const odtResult = await fillOdtTemplate(odtTemplate, data)
const odtResultTextContent = await getOdtTextContent(odtResult)
t.deepEqual(odtResultTextContent, `Liste de nombres
Les nombres : 3 5 8 13  !!
`)
}); });

BIN
tests/fixtures/formatting-liste-nombres-each-start-and-before-formatted.odt vendored Normal file
View File

Binary file not shown.