Veronica K. B. Olsen
408 lines
15 KiB
Python
408 lines
15 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""novelWriter Project Class Tester
|
|
"""
|
|
|
|
import pytest
|
|
|
|
from nw.core.project import NWProject
|
|
from nw.core.index import NWIndex
|
|
from nw.constants import nwItemClass, nwItemLayout
|
|
|
|
@pytest.mark.project
|
|
def testIndexScanThis(nwMinimal, nwDummy):
|
|
"""Test the tag scanner function scanThis.
|
|
"""
|
|
theProject = NWProject(nwDummy)
|
|
theProject.projTree.setSeed(42)
|
|
assert theProject.openProject(nwMinimal)
|
|
|
|
theIndex = NWIndex(theProject, nwDummy)
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("tag: this, and this")
|
|
assert not isValid
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("@")
|
|
assert not isValid
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("@:")
|
|
assert not isValid
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis(" @a: b")
|
|
assert not isValid
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("@a:")
|
|
assert isValid
|
|
assert str(theBits) == "['@a']"
|
|
assert str(thePos) == "[0]"
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("@a:b")
|
|
assert isValid
|
|
assert str(theBits) == "['@a', 'b']"
|
|
assert str(thePos) == "[0, 3]"
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("@a:b,c,d")
|
|
assert isValid
|
|
assert str(theBits) == "['@a', 'b', 'c', 'd']"
|
|
assert str(thePos) == "[0, 3, 5, 7]"
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("@a : b , c , d")
|
|
assert isValid
|
|
assert str(theBits) == "['@a', 'b', 'c', 'd']"
|
|
assert str(thePos) == "[0, 5, 9, 13]"
|
|
|
|
isValid, theBits, thePos = theIndex.scanThis("@tag: this, and this")
|
|
assert isValid
|
|
assert str(theBits) == "['@tag', 'this', 'and this']"
|
|
assert str(thePos) == "[0, 6, 12]"
|
|
|
|
assert theProject.closeProject()
|
|
|
|
@pytest.mark.project
|
|
def testIndexCheckThese(nwMinimal, nwDummy):
|
|
"""Test the tag checker function checkThese.
|
|
"""
|
|
theProject = NWProject(nwDummy)
|
|
theProject.projTree.setSeed(42)
|
|
assert theProject.openProject(nwMinimal)
|
|
|
|
theIndex = NWIndex(theProject, nwDummy)
|
|
nHandle = theProject.newFile("Hello", nwItemClass.NOVEL, "a508bb932959c")
|
|
cHandle = theProject.newFile("Jane", nwItemClass.CHARACTER, "afb3043c7b2b3")
|
|
nItem = theProject.projTree[nHandle]
|
|
cItem = theProject.projTree[cHandle]
|
|
|
|
assert theIndex.scanText(cHandle, (
|
|
"# Jane Smith\n"
|
|
"@tag: Jane"
|
|
))
|
|
assert theIndex.scanText(nHandle, (
|
|
"# Hello World!\n"
|
|
"@pov: Jane"
|
|
))
|
|
assert str(theIndex.tagIndex) == "{'Jane': [2, '%s', 'CHARACTER', 'T000001']}" % cHandle
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["title"] == "Hello World!"
|
|
|
|
assert str(theIndex.checkThese(["@tag", "Jane"], cItem)) == "[True, True]"
|
|
assert str(theIndex.checkThese(["@tag", "John"], cItem)) == "[True, True]"
|
|
assert str(theIndex.checkThese(["@tag", "Jane"], nItem)) == "[True, False]"
|
|
assert str(theIndex.checkThese(["@tag", "John"], nItem)) == "[True, True]"
|
|
assert str(theIndex.checkThese(["@pov", "John"], nItem)) == "[True, False]"
|
|
assert str(theIndex.checkThese(["@pov", "Jane"], nItem)) == "[True, True]"
|
|
assert str(theIndex.checkThese(["@ pov", "Jane"], nItem)) == "[False, False]"
|
|
assert str(theIndex.checkThese(["@what", "Jane"], nItem)) == "[False, False]"
|
|
|
|
assert theProject.closeProject()
|
|
|
|
@pytest.mark.project
|
|
def testIndexScanText(nwMinimal, nwDummy):
|
|
"""Check the index data extraction functions.
|
|
"""
|
|
theProject = NWProject(nwDummy)
|
|
theProject.projTree.setSeed(42)
|
|
assert theProject.openProject(nwMinimal)
|
|
|
|
theIndex = NWIndex(theProject, nwDummy)
|
|
|
|
# Some items for fail to scan tests
|
|
dHandle = theProject.newFolder("Folder", nwItemClass.NOVEL, "a508bb932959c")
|
|
xHandle = theProject.newFile("No Layout", nwItemClass.NOVEL, "a508bb932959c")
|
|
xItem = theProject.projTree[xHandle]
|
|
xItem.setLayout(nwItemLayout.NO_LAYOUT)
|
|
|
|
# Check invalid data
|
|
assert not theIndex.scanText(None, "Hello World!")
|
|
assert not theIndex.scanText(dHandle, "Hello World!")
|
|
assert not theIndex.scanText(xHandle, "Hello World!")
|
|
|
|
xItem.setLayout(nwItemLayout.SCENE)
|
|
xItem.setParent(None)
|
|
assert not theIndex.scanText(xHandle, "Hello World!")
|
|
|
|
# Create the trash folder
|
|
tHandle = theProject.trashFolder()
|
|
assert theProject.projTree[tHandle] is not None
|
|
xItem.setParent(tHandle)
|
|
assert not theIndex.scanText(xHandle, "Hello World!")
|
|
|
|
# Create the archive root
|
|
aHandle = theProject.newRoot("Outtakes", nwItemClass.ARCHIVE)
|
|
assert theProject.projTree[aHandle] is not None
|
|
xItem.setParent(aHandle)
|
|
assert not theIndex.scanText(xHandle, "Hello World!")
|
|
|
|
# Make some usable items
|
|
nHandle = theProject.newFile("Hello", nwItemClass.NOVEL, "a508bb932959c")
|
|
cHandle = theProject.newFile("Jane", nwItemClass.CHARACTER, "afb3043c7b2b3")
|
|
sHandle = theProject.newFile("Scene", nwItemClass.NOVEL, "a508bb932959c")
|
|
|
|
# Index correct text
|
|
assert theIndex.scanText(cHandle, (
|
|
"# Jane Smith\n"
|
|
"@tag: Jane\n"
|
|
))
|
|
assert theIndex.scanText(nHandle, (
|
|
"# Hello World!\n"
|
|
"@pov: Jane\n"
|
|
"@char: Jane\n\n"
|
|
"% this is a comment\n\n"
|
|
"This is a story about Jane Smith.\n\n"
|
|
"Well, not really.\n"
|
|
))
|
|
assert str(theIndex.tagIndex) == "{'Jane': [2, '%s', 'CHARACTER', 'T000001']}" % cHandle
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["title"] == "Hello World!"
|
|
|
|
# Check that title sections are indexed properly
|
|
assert theIndex.scanText(nHandle, (
|
|
"# Title One\n\n"
|
|
"% synopsis: Synopsis One.\n\n"
|
|
"Paragraph One.\n\n"
|
|
"## Title Two\n\n"
|
|
"% synopsis: Synopsis Two.\n\n"
|
|
"Paragraph Two.\n\n"
|
|
"### Title Three\n\n"
|
|
"% synopsis: Synopsis Three.\n\n"
|
|
"Paragraph Three.\n\n"
|
|
"#### Title Four\n\n"
|
|
"% synopsis: Synopsis Four.\n\n"
|
|
"Paragraph Four.\n\n"
|
|
"##### Title Five\n\n" # Not interpreted as a title, the hashes is counted as a word
|
|
"Paragraph Five.\n\n"
|
|
))
|
|
assert theIndex.refIndex[nHandle].get("T000000", None) is not None # Always there
|
|
assert theIndex.refIndex[nHandle].get("T000001", None) is not None # Heading 1
|
|
assert theIndex.refIndex[nHandle].get("T000002", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000003", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000004", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000005", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000006", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000007", None) is not None # Heading 2
|
|
assert theIndex.refIndex[nHandle].get("T000008", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000009", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000010", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000011", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000012", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000013", None) is not None # Heading 3
|
|
assert theIndex.refIndex[nHandle].get("T000014", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000015", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000016", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000017", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000018", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000019", None) is not None # Heading 4
|
|
assert theIndex.refIndex[nHandle].get("T000020", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000021", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000022", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000023", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000024", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000025", None) is None
|
|
assert theIndex.refIndex[nHandle].get("T000026", None) is None
|
|
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["level"] == "H1"
|
|
assert theIndex.novelIndex[nHandle]["T000007"]["level"] == "H2"
|
|
assert theIndex.novelIndex[nHandle]["T000013"]["level"] == "H3"
|
|
assert theIndex.novelIndex[nHandle]["T000019"]["level"] == "H4"
|
|
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["title"] == "Title One"
|
|
assert theIndex.novelIndex[nHandle]["T000007"]["title"] == "Title Two"
|
|
assert theIndex.novelIndex[nHandle]["T000013"]["title"] == "Title Three"
|
|
assert theIndex.novelIndex[nHandle]["T000019"]["title"] == "Title Four"
|
|
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["layout"] == "SCENE"
|
|
assert theIndex.novelIndex[nHandle]["T000007"]["layout"] == "SCENE"
|
|
assert theIndex.novelIndex[nHandle]["T000013"]["layout"] == "SCENE"
|
|
assert theIndex.novelIndex[nHandle]["T000019"]["layout"] == "SCENE"
|
|
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["synopsis"] == "Synopsis One."
|
|
assert theIndex.novelIndex[nHandle]["T000007"]["synopsis"] == "Synopsis Two."
|
|
assert theIndex.novelIndex[nHandle]["T000013"]["synopsis"] == "Synopsis Three."
|
|
assert theIndex.novelIndex[nHandle]["T000019"]["synopsis"] == "Synopsis Four."
|
|
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["cCount"] == 23
|
|
assert theIndex.novelIndex[nHandle]["T000007"]["cCount"] == 23
|
|
assert theIndex.novelIndex[nHandle]["T000013"]["cCount"] == 27
|
|
assert theIndex.novelIndex[nHandle]["T000019"]["cCount"] == 56
|
|
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["wCount"] == 4
|
|
assert theIndex.novelIndex[nHandle]["T000007"]["wCount"] == 4
|
|
assert theIndex.novelIndex[nHandle]["T000013"]["wCount"] == 4
|
|
assert theIndex.novelIndex[nHandle]["T000019"]["wCount"] == 9
|
|
|
|
assert theIndex.novelIndex[nHandle]["T000001"]["pCount"] == 1
|
|
assert theIndex.novelIndex[nHandle]["T000007"]["pCount"] == 1
|
|
assert theIndex.novelIndex[nHandle]["T000013"]["pCount"] == 1
|
|
assert theIndex.novelIndex[nHandle]["T000019"]["pCount"] == 3
|
|
|
|
assert theIndex.scanText(cHandle, (
|
|
"# Title One\n\n"
|
|
"@tag: One\n\n"
|
|
"% synopsis: Synopsis One.\n\n"
|
|
"Paragraph One.\n\n"
|
|
))
|
|
assert theIndex.refIndex[cHandle].get("T000000", None) is not None
|
|
assert theIndex.refIndex[cHandle].get("T000001", None) is not None
|
|
assert theIndex.refIndex[cHandle].get("T000002", None) is None
|
|
assert theIndex.refIndex[cHandle].get("T000003", None) is None
|
|
assert theIndex.refIndex[cHandle].get("T000004", None) is None
|
|
assert theIndex.refIndex[cHandle].get("T000005", None) is None
|
|
assert theIndex.refIndex[cHandle].get("T000006", None) is None
|
|
assert theIndex.refIndex[cHandle].get("T000007", None) is None
|
|
|
|
assert theIndex.noteIndex[cHandle]["T000001"]["level"] == "H1"
|
|
assert theIndex.noteIndex[cHandle]["T000001"]["title"] == "Title One"
|
|
assert theIndex.noteIndex[cHandle]["T000001"]["layout"] == "NOTE"
|
|
assert theIndex.noteIndex[cHandle]["T000001"]["synopsis"] == "Synopsis One."
|
|
assert theIndex.noteIndex[cHandle]["T000001"]["cCount"] == 23
|
|
assert theIndex.noteIndex[cHandle]["T000001"]["wCount"] == 4
|
|
assert theIndex.noteIndex[cHandle]["T000001"]["pCount"] == 1
|
|
|
|
assert theIndex.scanText(sHandle, (
|
|
"# Title One\n\n"
|
|
"@pov: One\n\n" # Valid
|
|
"@char: Two\n\n" # Invalid tag
|
|
"@:\n\n" # Invalid line
|
|
"% synopsis: Synopsis One.\n\n"
|
|
"Paragraph One.\n\n"
|
|
))
|
|
assert str(theIndex.refIndex[sHandle]["T000001"]["tags"]) == (
|
|
"[[3, '@pov', 'One'], [5, '@char', 'Two']]"
|
|
)
|
|
|
|
assert theProject.closeProject()
|
|
|
|
@pytest.mark.project
|
|
def testIndexExtractData(nwMinimal, nwDummy):
|
|
"""Check the index data extraction functions.
|
|
"""
|
|
theProject = NWProject(nwDummy)
|
|
theProject.projTree.setSeed(42)
|
|
assert theProject.openProject(nwMinimal)
|
|
|
|
theIndex = NWIndex(theProject, nwDummy)
|
|
nHandle = theProject.newFile("Hello", nwItemClass.NOVEL, "a508bb932959c")
|
|
cHandle = theProject.newFile("Jane", nwItemClass.CHARACTER, "afb3043c7b2b3")
|
|
|
|
assert theIndex.scanText(cHandle, (
|
|
"# Jane Smith\n"
|
|
"@tag: Jane\n"
|
|
))
|
|
assert theIndex.scanText(nHandle, (
|
|
"# Hello World!\n"
|
|
"@pov: Jane\n"
|
|
"@char: Jane\n\n"
|
|
"% this is a comment\n\n"
|
|
"This is a story about Jane Smith.\n\n"
|
|
"Well, not really.\n"
|
|
))
|
|
|
|
# The novel structure should contain the pointer to the novel file header
|
|
assert str(theIndex.getNovelStructure()) == "['%s:T000001']" % nHandle
|
|
|
|
# The novel file should have the correct counts
|
|
cC, wC, pC = theIndex.getCounts(nHandle)
|
|
assert cC == 62 # Characters in text and title only
|
|
assert wC == 12 # Words in text and title only
|
|
assert pC == 2 # Paragraphs in text only
|
|
|
|
##
|
|
# getReferences
|
|
##
|
|
|
|
# Look up an ivalid handle
|
|
theRefs = theIndex.getReferences("Not a handle")
|
|
assert theRefs["@pov"] == []
|
|
assert theRefs["@char"] == []
|
|
|
|
# The novel file should now refer to Jane as @pov and @char
|
|
theRefs = theIndex.getReferences(nHandle)
|
|
assert str(theRefs["@pov"]) == "['Jane']"
|
|
assert str(theRefs["@char"]) == "['Jane']"
|
|
|
|
##
|
|
# getBackReferenceList
|
|
##
|
|
|
|
# None handle should return an empty dict
|
|
assert theIndex.getBackReferenceList(None) == {}
|
|
|
|
# The character file should have a record of the reference from the novel file
|
|
theRefs = theIndex.getBackReferenceList(cHandle)
|
|
assert str(theRefs) == "{'%s': 'T000001'}" % nHandle
|
|
|
|
##
|
|
# getTagSource
|
|
##
|
|
|
|
assert theIndex.getTagSource("Jane") == (cHandle, 2, "T000001")
|
|
assert theIndex.getTagSource("John") == (None, 0, "T000000")
|
|
|
|
##
|
|
# getCounts for whole text and sections
|
|
##
|
|
|
|
# Get section counts for a novel file
|
|
assert theIndex.scanText(nHandle, (
|
|
"# Hello World!\n"
|
|
"@pov: Jane\n"
|
|
"@char: Jane\n\n"
|
|
"% this is a comment\n\n"
|
|
"This is a story about Jane Smith.\n\n"
|
|
"Well, not really.\n\n"
|
|
"# Hello World!\n"
|
|
"@pov: Jane\n"
|
|
"@char: Jane\n\n"
|
|
"% this is a comment\n\n"
|
|
"This is a story about Jane Smith.\n\n"
|
|
"Well, not really.\n"
|
|
))
|
|
# Whole document
|
|
cC, wC, pC = theIndex.getCounts(nHandle)
|
|
assert cC == 124
|
|
assert wC == 24
|
|
assert pC == 4
|
|
|
|
# First part
|
|
cC, wC, pC = theIndex.getCounts(nHandle, "T000001")
|
|
assert cC == 62
|
|
assert wC == 12
|
|
assert pC == 2
|
|
|
|
# First part
|
|
cC, wC, pC = theIndex.getCounts(nHandle, "T000011")
|
|
assert cC == 62
|
|
assert wC == 12
|
|
assert pC == 2
|
|
|
|
# Get section counts for a note file
|
|
assert theIndex.scanText(cHandle, (
|
|
"# Hello World!\n"
|
|
"@pov: Jane\n"
|
|
"@char: Jane\n\n"
|
|
"% this is a comment\n\n"
|
|
"This is a story about Jane Smith.\n\n"
|
|
"Well, not really.\n\n"
|
|
"# Hello World!\n"
|
|
"@pov: Jane\n"
|
|
"@char: Jane\n\n"
|
|
"% this is a comment\n\n"
|
|
"This is a story about Jane Smith.\n\n"
|
|
"Well, not really.\n"
|
|
))
|
|
# Whole document
|
|
cC, wC, pC = theIndex.getCounts(cHandle)
|
|
assert cC == 124
|
|
assert wC == 24
|
|
assert pC == 4
|
|
|
|
# First part
|
|
cC, wC, pC = theIndex.getCounts(cHandle, "T000001")
|
|
assert cC == 62
|
|
assert wC == 12
|
|
assert pC == 2
|
|
|
|
# First part
|
|
cC, wC, pC = theIndex.getCounts(cHandle, "T000011")
|
|
assert cC == 62
|
|
assert wC == 12
|
|
assert pC == 2
|
|
|
|
assert theProject.closeProject()
|