prehistoric-systems/omnivore
1
0
Fork 0
mirror of https://github.com/omnivore-app/omnivore.git synced 2026-03-11 08:54:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add some new test cases for SSML generation

Browse source
This commit is contained in:
Jackson Harper 2022-08-30 11:30:50 +08:00
parent 8bc950ba87
commit c85e6370b1
3 changed files with 129 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
packages/text-to-speech/src/htmlToSsml.ts
View file

@ -49,8 +49,9 @@ function parseDomTree(pageNode: Element) {
visitedNodeList.shift()
visitedNodeList.forEach((node, index) => {
// start from index 1, index 0 reserved for anchor unknown.
node.setAttribute('data-omnivore-anchor-idx', (index + 1).toString())
// We start at index 2, because the frontend starts one node above us
// on the #readability-content element that wraps the entire content.
node.setAttribute('data-omnivore-anchor-idx', (index + 2).toString())
})
return visitedNodeList
}
@ -161,12 +162,14 @@ export const htmlToSsml = (html: string, options: SSMLOptions): SSMLItem[] => {
console.log('creating ssml with options', options)
const dom = parseHTML(html)
const body = dom.document.querySelector('#readability-page-1')
const body = dom.document.querySelector('#readability-content')
if (!body) {
throw new Error('Unable to parse HTML document')
}
const parsedNodes = parseDomTree(body)
Array.from(parsedNodes).map((n) => console.log(n.nodeName, n.getAttribute('data-omnivore-anchor-idx'), n.getAttribute('class')))
if (parsedNodes.length < 1) {
throw new Error('No HTML nodes found')
}

128
packages/text-to-speech/test/htmlToSsml.test.ts
View file

@ -16,9 +16,11 @@ describe('htmlToSsml', () => {
describe('a simple html file', () => {
it('should convert Html to SSML', async () => {
const ssml = htmlToSsml(`
<div class="page" id="readability-page-1">
<div id="readability-content">
<div id="readability-page-1">
<p data-omnivore-anchor-idx="1">this is some text</p>
</div>
</div>
`, TEST_OPTIONS
)
const text = ssml[0].textItems.join('').trim()
@ -28,31 +30,127 @@ describe('htmlToSsml', () => {
})
})
describe('a file with nested elements', () => {
it('should convert Html to SSML', async () => {
it('should collapse spans into the parent paragraph', async () => {
const ssml = htmlToSsml(`
<div class="page" id="readability-page-1">
<p>
this is in the first paragraph
<span>this is in the second span</span>
this is also in the first paragraph
</p>
</div>
<div id="readability-content">
<div class="page" id="readability-page-1">
<p>
this is in the first paragraph
<span>this is in the second span</span>
this is also in the first paragraph
</p>
</div>
</div>
`, TEST_OPTIONS
)
const text = ssml[0].textItems.join('').trim()
expect(text).to.equal(
`<p><bookmark mark="1" /> this is in the first paragraph <bookmark mark="2" />this is in the second span<bookmark mark="1" /> this is also in the first paragraph </p>`.trim()
`<p><bookmark mark="2" /> this is in the first paragraph <bookmark mark="3" />this is in the second span<bookmark mark="2" /> this is also in the first paragraph </p>`.trim()
)
})
it('should extract child paragraphs to the top level', async () => {
const ssml = htmlToSsml(`
<div id="readability-content">
<div>
<p>
this is in the first paragraph
<p>this is in the second paragraph</p>
this is also in the first paragraph
</p>
</div>
</div>
`, TEST_OPTIONS
)
const text = ssml[0].textItems.join('').trim()
expect(text).to.equal(
`<p><bookmark mark="2" />this is in the first paragraph <p>
<p><bookmark mark="3" />this is in the second paragraph </p>
<p><bookmark mark="2" /> this is also in the first paragraph </p>`.trim()
)
})
it('should hoist paragraphs in spans to the top level', async () => {
const ssml = htmlToSsml(`
<div id="readability-content">
<div>
<p>
this is in the first paragraph
<p>this is in the second paragraph</p>
this is also in the first paragraph
</p>
</div>
</div>
`, TEST_OPTIONS
)
const text = ssml[0].textItems.join('').trim()
expect(text).to.equal(
`TBD`.trim()
)
})
it('should hoist lists to the top level', async () => {
const ssml = htmlToSsml(`
<div id="readability-content">
<div>
<p>
this is in the first paragraph
<ul><li>this is the first item in a list</li></ul>
this is also in the first paragraph
</p>
</div>
</div>
`, TEST_OPTIONS
)
const text = ssml[0].textItems.join('').trim()
expect(text).to.equal(
`TBD`.trim()
)
})
it('should hoist headers to the top level', async () => {
const ssml = htmlToSsml(`
<div id="readability-content">
<div>
<p>
this is in the first paragraph
<h1>this is a header</h1>
this is also in the first paragraph
</p>
</div>
</div>
`, TEST_OPTIONS
)
const text = ssml[0].textItems.join('').trim()
expect(text).to.equal(
`TBD`.trim()
)
})
it('should hoist blockquotes to the top level', async () => {
const ssml = htmlToSsml(`
<div id="readability-content">
<div>
<p>
this is in the first paragraph
<blockquote>this is a blockquote</blockquote>
this is also in the first paragraph
</p>
</div>
</div>
`, TEST_OPTIONS
)
const text = ssml[0].textItems.join('').trim()
expect(text).to.equal(
`TBD`.trim()
)
})
})
describe('a file with blockquotes', () => {
it('should convert Html to SSML with complimentary voices', async () => {
const ssml = htmlToSsml(`
<div class="page" id="readability-page-1">
<p>first</p>
<blockquote>second</blockquote>
<p>third</p>
</div>
<div id="readability-content">
<div class="page" id="readability-page-1">
<p>first</p>
<blockquote>second</blockquote>
<p>third</p>
</div>
</div>
`, TEST_OPTIONS
)
const first = ssml[0].textItems.join('').trim()

10
yarn.lock
View file

@ -8178,6 +8178,11 @@
dependencies:
source-map "^0.6.1"
"@types/underscore@^1.11.4":
version "1.11.4"
resolved "https://registry.yarnpkg.com/@types/underscore/-/underscore-1.11.4.tgz#62e393f8bc4bd8a06154d110c7d042a93751def3"
integrity sha512-uO4CD2ELOjw8tasUrAhvnn2W4A0ZECOvMjCivJr4gA9pGgjv+qxKWY9GLTMVEK8ej85BxQOocUyE7hImmSQYcg==
"@types/unist@*", "@types/unist@^2.0.0", "@types/unist@^2.0.2", "@types/unist@^2.0.3":
version "2.0.6"
resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.6.tgz#250a7b16c3b91f672a24552ec64678eeb1d3a08d"
@ -24313,6 +24318,11 @@ undefsafe@^2.0.5:
resolved "https://registry.yarnpkg.com/undefsafe/-/undefsafe-2.0.5.tgz#38733b9327bdcd226db889fb723a6efd162e6e2c"
integrity sha512-WxONCrssBM8TSPRqN5EmsjVrsv4A8X12J4ArBiiayv3DyyG3ZlIg6yysuuSYdZsVz3TKcTg2fd//Ujd4CHV1iA==
underscore@^1.13.4:
version "1.13.4"
resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.13.4.tgz#7886b46bbdf07f768e0052f1828e1dcab40c0dee"
integrity sha512-BQFnUDuAQ4Yf/cYY5LNrK9NCJFKriaRbD9uR1fTeXnBeoa97W0i41qkZfGO9pSo8I5KzjAcSY2XYtdf0oKd7KQ==
undici@^4.9.3:
version "4.14.1"
resolved "https://registry.yarnpkg.com/undici/-/undici-4.14.1.tgz#7633b143a8a10d6d63335e00511d071e8d52a1d9"