Add: OPF file supports multiple series as sequence of : calibre:series and calibre:series_index; including tests

This commit is contained in:
Andrzej Bargański 2023-12-22 20:35:38 +01:00
parent 68d36522b1
commit cd7c4baaaf
3 changed files with 102 additions and 14 deletions

View File

@ -32,11 +32,8 @@ class OpfFileScanner {
bookMetadata.narrators = opfMetadata.narrators
}
} else if (key === 'series') {
if (opfMetadata.series) {
bookMetadata.series = [{
name: opfMetadata.series,
sequence: opfMetadata.sequence || null
}]
if (opfMetadata.series?.length) {
bookMetadata.series = opfMetadata.series
}
} else if (opfMetadata[key] && key !== 'sequence') {
bookMetadata[key] = opfMetadata[key]

View File

@ -100,13 +100,20 @@ function fetchLanguage(metadata) {
}
function fetchSeries(metadataMeta) {
if (!metadataMeta) return null
return fetchTagString(metadataMeta, "calibre:series")
if (!metadataMeta) return []
const result = []
for (let i = 0; i < metadataMeta.length; i++) {
if (metadataMeta[i].$.name === "calibre:series") {
const name = metadataMeta[i].$.content
let sequence = null
if (i + 1 < metadataMeta.length &&
metadataMeta[i + 1].$.name === "calibre:series_index" && metadataMeta[i + 1].$.content) {
sequence = metadataMeta[i + 1].$.content
}
function fetchVolumeNumber(metadataMeta) {
if (!metadataMeta) return null
return fetchTagString(metadataMeta, "calibre:series_index")
result.push({ name, sequence })
}
}
return result
}
function fetchNarrators(creators, metadata) {
@ -173,8 +180,7 @@ module.exports.parseOpfMetadataXML = async (xml) => {
description: fetchDescription(metadata),
genres: fetchGenres(metadata),
language: fetchLanguage(metadata),
series: fetchSeries(metadata.meta),
sequence: fetchVolumeNumber(metadata.meta),
series: fetchSeries(metadataMeta),
tags: fetchTags(metadata)
}
return data

View File

@ -0,0 +1,85 @@
const chai = require('chai')
const expect = chai.expect
const { parseOpfMetadataXML } = require('../../../../server/utils/parsers/parseOpfMetadata')
describe('parseOpfMetadata - test series', async () => {
it('test one serie', async() => {
const opf = `
<?xml version='1.0' encoding='UTF-8'?>
<package xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf" xml:lang="en" version="3.0" unique-identifier="bookid">
<metadata>
<meta name="calibre:series" content="Serie"/>
<meta name="calibre:series_index" content="1"/>
</metadata>
</package>
`
const parsedOpf = await parseOpfMetadataXML(opf)
expect(parsedOpf.series).to.deep.equal([{"name": "Serie","sequence": "1"}])
})
it('test more then 1 serie - in correct order', async() => {
const opf = `
<?xml version='1.0' encoding='UTF-8'?>
<package xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf" xml:lang="en" version="3.0" unique-identifier="bookid">
<metadata>
<meta name="calibre:series" content="Serie 1"/>
<meta name="calibre:series_index" content="1"/>
<meta name="calibre:series" content="Serie 2"/>
<meta name="calibre:series_index" content="2"/>
<meta name="calibre:series" content="Serie 3"/>
<meta name="calibre:series_index" content="3"/>
</metadata>
</package>
`
const parsedOpf = await parseOpfMetadataXML(opf)
expect(parsedOpf.series).to.deep.equal([
{"name": "Serie 1","sequence": "1"},
{"name": "Serie 2","sequence": "2"},
{"name": "Serie 3","sequence": "3"},
])
})
it('test messed order of series content and index', async() => {
const opf = `
<?xml version='1.0' encoding='UTF-8'?>
<package xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf" xml:lang="en" version="3.0" unique-identifier="bookid">
<metadata>
<meta name="calibre:series" content="Serie 1"/>
<meta name="calibre:series_index" content="1"/>
<meta name="calibre:series_index" content="2"/>
<meta name="calibre:series_index" content="3"/>
<meta name="calibre:series" content="Serie 3"/>
</metadata>
</package>
`
const parsedOpf = await parseOpfMetadataXML(opf)
expect(parsedOpf.series).to.deep.equal([
{"name": "Serie 1","sequence": "1"},
{"name": "Serie 3","sequence": null},
])
})
it('test different values of series content and index', async() => {
const opf = `
<?xml version='1.0' encoding='UTF-8'?>
<package xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf" xml:lang="en" version="3.0" unique-identifier="bookid">
<metadata>
<meta name="calibre:series" content="Serie 1"/>
<meta name="calibre:series_index"/>
<meta name="calibre:series" content="Serie 2"/>
<meta name="calibre:series_index" content="abc"/>
<meta name="calibre:series" content="Serie 3"/>
<meta name="calibre:series_index" content=""/>
</metadata>
</package>
`
const parsedOpf = await parseOpfMetadataXML(opf)
// console.log(JSON.stringify(parsedOpf, null, 4))
expect(parsedOpf.series).to.deep.equal([
{"name": "Serie 1", "sequence": null},
{"name": "Serie 2", "sequence": "abc"},
{"name": "Serie 3", "sequence": null},
])
})
})