Skip to content

Fix: selections inside FILTER_SKIP wrappers must preserve offsets #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fondoger wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix: selections inside FILTER_SKIP wrappers must preserve offsets #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion epubcfi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,11 @@ const partsToNode = (node, parts, filter) => {
}

const nodeToParts = (node, offset, filter) => {
const { parentNode, id } = node
let { id, parentNode } = node
while (filter && parentNode
&& parentNode !== node.ownerDocument.documentElement
&& filter(parentNode) === NodeFilter.FILTER_SKIP)
parentNode = parentNode.parentNode
const indexed = indexChildNodes(parentNode, filter)
const index = indexed.findIndex(x =>
Array.isArray(x) ? x.some(x => x === node) : x === node)
Expand Down
44 changes: 44 additions & 0 deletions tests/epubcfi-tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,50 @@ const XHTML = str => parser.parseFromString(str, 'application/xhtml+xml')
test(page3, filter)
}

{
// regression: selections inside FILTER_SKIP wrappers must preserve offsets
// https://github.com/johnfactotum/foliate-js/issues/100
const page = XHTML(`<html xmlns="http://www.w3.org/1999/xhtml">
<head></head>
<body>
<p id="test-skip-1">Hello, World</p>
<p id="test-skip-2"><span class="SKIP">H</span>e<span class="SKIP">ll</span>o, World</p>
</body>
</html>`)
const filter = node => node.nodeType === 1 && node.classList?.contains('SKIP')
? NodeFilter.FILTER_SKIP
: NodeFilter.FILTER_ACCEPT

// cfi1
const para1 = page.getElementById('test-skip-1')
const text1 = para1.firstChild
const range1 = page.createRange()
range1.setStart(text1, 3)
range1.setEnd(text1, 8)
const cfi1 = CFI.fromRange(range1, filter)

const expected1 = 'epubcfi(/4/2[test-skip-1],/1:3,/1:8)'
console.assert(cfi1 === expected1, `expected ${expected1}, got ${cfi1}`)


// cfi2
const para2 = page.getElementById('test-skip-2')
const skips = para2.querySelectorAll('.SKIP')
const tail2 = para2.lastChild
const range2 = page.createRange()
range2.setStart(skips[1].firstChild, 1)
range2.setEnd(tail2, 4)
const cfi2 = CFI.fromRange(range2, filter)

const expected2 = 'epubcfi(/4/4[test-skip-2],/1:3,/1:8)'
console.assert(cfi2 === expected2, `expected ${expected2}, got ${cfi2}`)

const rebuilt = CFI.toRange(page, CFI.parse('/4/4[test-skip-2],/1:3,/1:8'), filter)
console.assert(rebuilt.toString() === 'lo, W', `expected lo, W, got ${rebuilt}`)
const roundtrip = CFI.fromRange(rebuilt, filter)
console.assert(roundtrip === expected2, `expected ${expected2}, got ${roundtrip}`)
}

{
// special characters in ID assertions
const opf = XML(`<?xml version="1.0"?>
Expand Down