From e1c3a12d07a28053ac7222a0e5f0a8d6f960e354 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 15:30:02 +0200 Subject: [PATCH 01/12] Redesign the Document Merge dialog box --- novelwriter/core/__init__.py | 2 + novelwriter/core/doctools.py | 102 +++++++++++++++++ novelwriter/dialogs/docmerge.py | 189 +++++++++++++------------------- novelwriter/gui/custom.py | 14 +-- novelwriter/gui/projtree.py | 62 +++++++++-- 5 files changed, 238 insertions(+), 131 deletions(-) create mode 100644 novelwriter/core/doctools.py diff --git a/novelwriter/core/__init__.py b/novelwriter/core/__init__.py index c91ca941..90b103f8 100644 --- a/novelwriter/core/__init__.py +++ b/novelwriter/core/__init__.py @@ -19,6 +19,7 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . """ +from novelwriter.core.doctools import DocMerger from novelwriter.core.document import NWDoc from novelwriter.core.index import countWords from novelwriter.core.project import NWProject @@ -28,6 +29,7 @@ from novelwriter.core.toodt import ToOdt from novelwriter.core.tomd import ToMarkdown __all__ = [ + "DocMerger", "countWords", "NWDoc", "NWProject", diff --git a/novelwriter/core/doctools.py b/novelwriter/core/doctools.py new file mode 100644 index 00000000..b85d1c19 --- /dev/null +++ b/novelwriter/core/doctools.py @@ -0,0 +1,102 @@ +""" +novelWriter – Project Document Tools +==================================== +A collection of tools to create and manipulate documents + +File History: +Created: 2022-10-02 [2.0b1] + +This file is a part of novelWriter +Copyright 2018–2022, Veronica Berglyd Olsen + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +""" + +import logging + +logger = logging.getLogger(__name__) + +# logger.verbose("GuiDocMerge merge button clicked") + +# finalOrder = [] +# for i in range(self.listBox.count()): +# finalOrder.append(self.listBox.item(i).data(Qt.UserRole)) + +# if len(finalOrder) == 0: +# self.mainGui.makeAlert(self.tr( +# "No source documents found. Nothing to do." +# ), nwAlert.ERROR) +# return False + +# theText = "" +# for tHandle in finalOrder: +# inDoc = NWDoc(self.theProject, tHandle) +# docText = inDoc.readDocument() +# docErr = inDoc.getError() +# if docText is None and docErr: +# self.mainGui.makeAlert([ +# self.tr("Failed to open document file."), docErr +# ], nwAlert.ERROR) +# if docText: +# theText += docText.rstrip("\n")+"\n\n" + +# if self.sourceItem is None: +# self.mainGui.makeAlert(self.tr( +# "No source folder selected. Nothing to do." +# ), nwAlert.ERROR) +# return False + +# srcItem = self.theProject.tree[self.sourceItem] +# if srcItem is None: +# self.mainGui.makeAlert(self.tr("Internal error."), nwAlert.ERROR) +# return False + +# nHandle = self.theProject.newFile(srcItem.itemName, srcItem.itemParent) +# newItem = self.theProject.tree[nHandle] +# newItem.setStatus(srcItem.itemStatus) +# newItem.setImport(srcItem.itemImport) + +# outDoc = NWDoc(self.theProject, nHandle) +# if not outDoc.writeDocument(theText): +# self.mainGui.makeAlert([ +# self.tr("Could not save document."), outDoc.getError() +# ], nwAlert.ERROR) +# return False + +# self.mainGui.projView.revealNewTreeItem(nHandle) +# self.mainGui.openDocument(nHandle, doScroll=True) + +# self._doClose() + + +class DocMerger: + + def __init__(self, theProject): + + self.theProject = theProject + + self._targetDoc = None + + return + + def setTargetDoc(self, tHandle): + return + + def createNewDoc(self, docLabel, pHandle, itemLayout): + return + + def appendDoc(self, tHandle): + return + +# END Class DocMerger diff --git a/novelwriter/dialogs/docmerge.py b/novelwriter/dialogs/docmerge.py index 22a6eb6b..2d248200 100644 --- a/novelwriter/dialogs/docmerge.py +++ b/novelwriter/dialogs/docmerge.py @@ -1,10 +1,11 @@ """ -novelWriter – GUI Doc Merge Tool -================================ -GUI class for merging multiple documents to one document +novelWriter – GUI Doc Merge Dialog +================================== +Custom dialog class for merging documents. File History: -Created: 2020-01-23 [0.4.3] +Created: 2020-01-23 [0.4.3] +Rewritten: 2022-10-06 [2.0b1] This file is a part of novelWriter Copyright 2018–2022, Veronica Berglyd Olsen @@ -26,169 +27,131 @@ along with this program. If not, see . import logging import novelwriter -from PyQt5.QtCore import Qt +from PyQt5.QtCore import Qt, QSize from PyQt5.QtWidgets import ( QDialog, QVBoxLayout, QLabel, QListWidget, QAbstractItemView, - QListWidgetItem, QDialogButtonBox + QListWidgetItem, QDialogButtonBox, QGridLayout ) -from novelwriter.core import NWDoc -from novelwriter.enum import nwAlert, nwItemType -from novelwriter.gui.custom import QHelpLabel +from novelwriter.gui.custom import QHelpLabel, QSwitch logger = logging.getLogger(__name__) class GuiDocMerge(QDialog): - def __init__(self, mainGui): - QDialog.__init__(self, mainGui) + def __init__(self, mainGui, sHandle, itemList): + super().__init__(parent=mainGui) logger.debug("Initialising GuiDocMerge ...") self.setObjectName("GuiDocMerge") self.mainConf = novelwriter.CONFIG self.mainGui = mainGui + self.mainTheme = mainGui.mainTheme self.theProject = mainGui.theProject - self.sourceItem = None - self.outerBox = QVBoxLayout() + self._data = {} + self.setWindowTitle(self.tr("Merge Documents")) self.headLabel = QLabel("{0}".format(self.tr("Documents to Merge"))) - self.helpLabel = QHelpLabel( - self.tr("Drag and drop items to change the order."), self.mainGui.mainTheme.helpText - ) + self.helpLabel = QHelpLabel(self.tr( + "Drag and drop items to change the order, or uncheck to exclude." + ), self.mainTheme.helpText) + + iPx = self.mainTheme.baseIconSize + hSp = self.mainConf.pxInt(12) + vSp = self.mainConf.pxInt(8) + bSp = self.mainConf.pxInt(12) self.listBox = QListWidget() - self.listBox.setDragDropMode(QAbstractItemView.InternalMove) + self.listBox.setIconSize(QSize(iPx, iPx)) self.listBox.setMinimumWidth(self.mainConf.pxInt(400)) self.listBox.setMinimumHeight(self.mainConf.pxInt(180)) + self.listBox.setSelectionBehavior(QAbstractItemView.SelectRows) + self.listBox.setSelectionMode(QAbstractItemView.SingleSelection) + self.listBox.setDragDropMode(QAbstractItemView.InternalMove) + # Merge Options + self.trashLabel = QLabel(self.tr("Move merged items to Trash")) + self.trashSwitch = QSwitch() + + self.optBox = QGridLayout() + self.optBox.addWidget(self.trashLabel, 0, 0) + self.optBox.addWidget(self.trashSwitch, 0, 1) + self.optBox.setHorizontalSpacing(hSp) + self.optBox.setColumnStretch(2, 1) + + # Buttons self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel) - self.buttonBox.accepted.connect(self._doMerge) - self.buttonBox.rejected.connect(self._doClose) + self.buttonBox.accepted.connect(self.accept) + self.buttonBox.rejected.connect(self.reject) + # Assemble + self.outerBox = QVBoxLayout() self.outerBox.setSpacing(0) self.outerBox.addWidget(self.headLabel) self.outerBox.addWidget(self.helpLabel) - self.outerBox.addSpacing(self.mainConf.pxInt(8)) + self.outerBox.addSpacing(vSp) self.outerBox.addWidget(self.listBox) - self.outerBox.addSpacing(self.mainConf.pxInt(12)) + self.outerBox.addSpacing(vSp) + self.outerBox.addLayout(self.optBox) + self.outerBox.addSpacing(bSp) self.outerBox.addWidget(self.buttonBox) self.setLayout(self.outerBox) - self.rejected.connect(self._doClose) - - self._populateList() + # Load Content + self._loadContent(sHandle, itemList) logger.debug("GuiDocMerge initialisation complete") return - ## - # Buttons - ## - - def _doMerge(self): - """Perform the merge of the files in the selected folder, and - create a new file in the same parent folder. The old files are - not removed in the merge process, and must be deleted manually. + def getData(self): + """Return the user's choices. """ - logger.verbose("GuiDocMerge merge button clicked") - - finalOrder = [] + finalItems = [] for i in range(self.listBox.count()): - finalOrder.append(self.listBox.item(i).data(Qt.UserRole)) + item = self.listBox.item(i) + if item.checkState() == Qt.Checked: + finalItems.append(item.data(Qt.UserRole)) - if len(finalOrder) == 0: - self.mainGui.makeAlert(self.tr( - "No source documents found. Nothing to do." - ), nwAlert.ERROR) - return False + self._data["moveToTrash"] = self.trashSwitch.isChecked() + self._data["finalItems"] = finalItems - theText = "" - for tHandle in finalOrder: - inDoc = NWDoc(self.theProject, tHandle) - docText = inDoc.readDocument() - docErr = inDoc.getError() - if docText is None and docErr: - self.mainGui.makeAlert([ - self.tr("Failed to open document file."), docErr - ], nwAlert.ERROR) - if docText: - theText += docText.rstrip("\n")+"\n\n" - - if self.sourceItem is None: - self.mainGui.makeAlert(self.tr( - "No source folder selected. Nothing to do." - ), nwAlert.ERROR) - return False - - srcItem = self.theProject.tree[self.sourceItem] - if srcItem is None: - self.mainGui.makeAlert(self.tr("Internal error."), nwAlert.ERROR) - return False - - nHandle = self.theProject.newFile(srcItem.itemName, srcItem.itemParent) - newItem = self.theProject.tree[nHandle] - newItem.setStatus(srcItem.itemStatus) - newItem.setImport(srcItem.itemImport) - - outDoc = NWDoc(self.theProject, nHandle) - if not outDoc.writeDocument(theText): - self.mainGui.makeAlert([ - self.tr("Could not save document."), outDoc.getError() - ], nwAlert.ERROR) - return False - - self.mainGui.projView.revealNewTreeItem(nHandle) - self.mainGui.openDocument(nHandle, doScroll=True) - - self._doClose() - - return True - - def _doClose(self): - """Close the dialog window without doing anything. - """ - self.close() - return + return self._data ## # Internal Functions ## - def _populateList(self): - """Get the item selected in the tree, check that it is a folder, - and try to find all files associated with it. The valid files - are then added to the list view in order. The list itself can be - reordered by the user. + def _loadContent(self, sHandle, itemList): + """Load content from a given list of items. """ - tHandle = self.mainGui.projView.getSelectedHandle() - self.sourceItem = tHandle - if tHandle is None: - return False + self._data = {} + self._data["sHandle"] = sHandle + self._data["origItems"] = itemList - nwItem = self.theProject.tree[tHandle] - if nwItem is None: - return False - - if nwItem.itemType is not nwItemType.FOLDER: - self.mainGui.makeAlert(self.tr( - "Element selected in the project tree must be a folder." - ), nwAlert.ERROR) - return False - - for sHandle in self.mainGui.projView.getTreeFromHandle(tHandle): - newItem = QListWidgetItem() - nwItem = self.theProject.tree[sHandle] - if not nwItem.isFileType(): + self.listBox.clear() + for tHandle in itemList: + nwItem = self.theProject.tree[tHandle] + if nwItem is None or not nwItem.isFileType(): continue + + hLevel = self.theProject.index.getHandleHeaderLevel(tHandle) + itemIcon = self.mainTheme.getItemIcon( + nwItem.itemType, nwItem.itemClass, nwItem.itemLayout, hLevel + ) + + newItem = QListWidgetItem() + newItem.setIcon(itemIcon) newItem.setText(nwItem.itemName) - newItem.setData(Qt.UserRole, sHandle) + newItem.setData(Qt.UserRole, tHandle) + newItem.setCheckState(Qt.Checked) + self.listBox.addItem(newItem) - return True + return # END Class GuiDocMerge diff --git a/novelwriter/gui/custom.py b/novelwriter/gui/custom.py index e571a5a1..2949ff6a 100644 --- a/novelwriter/gui/custom.py +++ b/novelwriter/gui/custom.py @@ -202,7 +202,7 @@ class QConfigLayout(QGridLayout): class QHelpLabel(QLabel): def __init__(self, theText, textCol, fontSize=0.9): - QLabel.__init__(self, theText) + super().__init__(theText) if isinstance(textCol, QColor): qCol = textCol @@ -377,7 +377,7 @@ class QSwitch(QAbstractButton): class PagedDialog(QDialog): def __init__(self, parent=None): - QDialog.__init__(self, parent=parent) + super().__init__(parent=parent) self._tabBar = VerticalTabBar(self) self._tabBar.setExpanding(False) @@ -410,13 +410,13 @@ class PagedDialog(QDialog): return def addTab(self, widget, label): - """Forwards the adding of tabs to the QTabWidget. + """Forward the adding of tabs to the QTabWidget. """ self._tabBox.addTab(widget, label) return def addControls(self, buttonBar): - """Adds a button bar to the dialog. + """Add a button bar to the dialog. """ self._buttonBox.addWidget(buttonBar) return @@ -427,14 +427,14 @@ class PagedDialog(QDialog): class VerticalTabBar(QTabBar): def __init__(self, parent=None): - QTabBar.__init__(self, parent=parent) + super().__init__(parent=parent) self._mW = novelwriter.CONFIG.pxInt(150) return def tabSizeHint(self, index): - """Returns a transposed size hint for the rotated bar. + """Return a transposed size hint for the rotated bar. """ - tSize = QTabBar.tabSizeHint(self, index) + tSize = super().tabSizeHint(index) tSize.transpose() tSize.setWidth(min(tSize.width(), self._mW)) return tSize diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index e8fa541d..e841375a 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -34,15 +34,15 @@ from time import time from PyQt5.QtGui import QPalette from PyQt5.QtCore import Qt, QSize, pyqtSignal, pyqtSlot from PyQt5.QtWidgets import ( - QAbstractItemView, QFrame, QHBoxLayout, QHeaderView, QLabel, + QAbstractItemView, QFrame, QHBoxLayout, QHeaderView, QLabel, QDialog, QMenu, QShortcut, QSizePolicy, QToolButton, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget ) from novelwriter.core import NWDoc from novelwriter.enum import nwDocMode, nwItemType, nwItemClass, nwItemLayout, nwAlert +from novelwriter.dialogs import GuiDocMerge, GuiEditLabel from novelwriter.constants import nwHeaders, trConst, nwLabels -from novelwriter.dialogs.editlabel import GuiEditLabel logger = logging.getLogger(__name__) @@ -334,7 +334,7 @@ class GuiProjectTree(QTreeWidget): self.mainConf = novelwriter.CONFIG self.projView = projView self.mainGui = projView.mainGui - self.mainTheme = projView.mainGui.mainTheme + self.mainTheme = projView.mainGui.mainTheme self.theProject = projView.mainGui.theProject # Internal Variables @@ -382,9 +382,8 @@ class GuiProjectTree(QTreeWidget): trRoot = self.invisibleRootItem() trRoot.setFlags(trRoot.flags() ^ Qt.ItemIsDropEnabled) - # Set Multiple Selection by CTRL - # Disabled for now, until the merge files option has been added - # self.setSelectionMode(QAbstractItemView.ExtendedSelection) + # Set selection options + self.setSelectionMode(QAbstractItemView.SingleSelection) self.setSelectionBehavior(QAbstractItemView.SelectRows) # Connect signals @@ -1077,16 +1076,21 @@ class GuiProjectTree(QTreeWidget): lambda n, key=key: self._changeItemImport(tHandle, key) ) + # Transform Item + # ============== + + mTrans = ctxMenu.addMenu(self.tr("Transform")) + if isFile and tItem.documentAllowed(): if tItem.isNoteLayout(): - ctxMenu.addAction( + mTrans.addAction( self.tr("Convert to {0}").format( trConst(nwLabels.LAYOUT_NAME[nwItemLayout.DOCUMENT]) ), lambda: self._changeItemLayout(tHandle, nwItemLayout.DOCUMENT) ) else: - ctxMenu.addAction( + mTrans.addAction( self.tr("Convert to {0}").format( trConst(nwLabels.LAYOUT_NAME[nwItemLayout.NOTE]) ), @@ -1094,19 +1098,37 @@ class GuiProjectTree(QTreeWidget): ) elif isFolder: if tItem.documentAllowed(): - ctxMenu.addAction( + mTrans.addAction( self.tr("Convert to {0}").format( trConst(nwLabels.LAYOUT_NAME[nwItemLayout.DOCUMENT]) ), lambda: self._covertFolderToFile(tHandle, nwItemLayout.DOCUMENT) ) - ctxMenu.addAction( + mTrans.addAction( self.tr("Convert to {0}").format( trConst(nwLabels.LAYOUT_NAME[nwItemLayout.NOTE]) ), lambda: self._covertFolderToFile(tHandle, nwItemLayout.NOTE) ) + if hasChild: + if isFile: + mTrans.addAction( + self.tr("Merge Child Documents"), + lambda: self._mergeDocuments(tHandle, isFile) + ) + else: + mTrans.addAction( + self.tr("Combine Documents in Folder"), + lambda: self._mergeDocuments(tHandle, isFile) + ) + + if isFile: + mTrans.addAction( + self.tr("Split Document by Header"), + lambda: self._splitDocument(tHandle) + ) + ctxMenu.addSeparator() # Expand/Collapse @@ -1355,6 +1377,24 @@ class GuiProjectTree(QTreeWidget): logger.info("Folder conversion cancelled") return + def _mergeDocuments(self, tHandle, isFile): + """Merge an item's child documents into a single document. + """ + logger.info("Request to merge items under handle '%s'", tHandle) + itemList = self.getTreeFromHandle(tHandle) + itemList.remove(tHandle) + + dlgMerge = GuiDocMerge(self.mainGui, tHandle, itemList) + dlgMerge.exec_() + + if dlgMerge.result() == QDialog.Accepted: + print(dlgMerge.getData()) + + return + + def _splitDocument(self, tHandle): + return + def _scanChildren(self, theList, tItem, tIndex): """This is a recursive function returning all items in a tree starting at a given QTreeWidgetItem. @@ -1380,7 +1420,7 @@ class GuiProjectTree(QTreeWidget): """ tHandle = nwItem.itemHandle pHandle = nwItem.itemParent - newItem = QTreeWidgetItem([""]*4) + newItem = QTreeWidgetItem() newItem.setText(self.C_NAME, "") newItem.setText(self.C_COUNT, "0") From 0f3d598f8d23d6003f496d9c57ca9060f8ee7670 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 17:19:01 +0200 Subject: [PATCH 02/12] Implement nre doc merge functionality in tree --- novelwriter/core/doctools.py | 129 ++++++++++++++++++-------------- novelwriter/core/item.py | 6 +- novelwriter/dialogs/docmerge.py | 16 ++++ novelwriter/gui/projtree.py | 75 ++++++++++++++++--- 4 files changed, 156 insertions(+), 70 deletions(-) diff --git a/novelwriter/core/doctools.py b/novelwriter/core/doctools.py index b85d1c19..75a4c3b7 100644 --- a/novelwriter/core/doctools.py +++ b/novelwriter/core/doctools.py @@ -25,60 +25,10 @@ along with this program. If not, see . import logging +from novelwriter.core.document import NWDoc + logger = logging.getLogger(__name__) -# logger.verbose("GuiDocMerge merge button clicked") - -# finalOrder = [] -# for i in range(self.listBox.count()): -# finalOrder.append(self.listBox.item(i).data(Qt.UserRole)) - -# if len(finalOrder) == 0: -# self.mainGui.makeAlert(self.tr( -# "No source documents found. Nothing to do." -# ), nwAlert.ERROR) -# return False - -# theText = "" -# for tHandle in finalOrder: -# inDoc = NWDoc(self.theProject, tHandle) -# docText = inDoc.readDocument() -# docErr = inDoc.getError() -# if docText is None and docErr: -# self.mainGui.makeAlert([ -# self.tr("Failed to open document file."), docErr -# ], nwAlert.ERROR) -# if docText: -# theText += docText.rstrip("\n")+"\n\n" - -# if self.sourceItem is None: -# self.mainGui.makeAlert(self.tr( -# "No source folder selected. Nothing to do." -# ), nwAlert.ERROR) -# return False - -# srcItem = self.theProject.tree[self.sourceItem] -# if srcItem is None: -# self.mainGui.makeAlert(self.tr("Internal error."), nwAlert.ERROR) -# return False - -# nHandle = self.theProject.newFile(srcItem.itemName, srcItem.itemParent) -# newItem = self.theProject.tree[nHandle] -# newItem.setStatus(srcItem.itemStatus) -# newItem.setImport(srcItem.itemImport) - -# outDoc = NWDoc(self.theProject, nHandle) -# if not outDoc.writeDocument(theText): -# self.mainGui.makeAlert([ -# self.tr("Could not save document."), outDoc.getError() -# ], nwAlert.ERROR) -# return False - -# self.mainGui.projView.revealNewTreeItem(nHandle) -# self.mainGui.openDocument(nHandle, doScroll=True) - -# self._doClose() - class DocMerger: @@ -86,17 +36,84 @@ class DocMerger: self.theProject = theProject + self._error = "" self._targetDoc = None + self._targetText = [] return + ## + # Methods + ## + + def getError(self): + """Return any collected errors. + """ + return self._error + def setTargetDoc(self, tHandle): + """Set the target document for the merging. Calling this + function resets the class. + """ + self._targetDoc = tHandle + self._targetText = [] return - def createNewDoc(self, docLabel, pHandle, itemLayout): - return + def newTargetDoc(self, srcHandle, docLabel): + """Create a barnd new target document based on a source handle + and a new doc label. Calling this function resets the class. + """ + srcItem = self.theProject.tree[srcHandle] + if srcItem is None: + return None - def appendDoc(self, tHandle): - return + newHandle = self.theProject.newFile(docLabel, srcItem.itemParent) + newItem = self.theProject.tree[newHandle] + newItem.setLayout(srcItem.itemLayout) + newItem.setStatus(srcItem.itemStatus) + newItem.setImport(srcItem.itemImport) + + self._targetDoc = newHandle + self._targetText = [] + + return newHandle + + def appendText(self, srcHandle, addComment, cmtPrefix): + """Append text from an existing document to the text buffer. + """ + srcItem = self.theProject.tree[srcHandle] + if srcItem is None: + return False + + inDoc = NWDoc(self.theProject, srcHandle) + docText = (inDoc.readDocument() or "").rstrip("\n") + + if addComment: + docInfo = srcItem.describeMe("H0") + docSt, _ = srcItem.getImportStatus(incIcon=False) + cmtLine = f"% {cmtPrefix} {docInfo}: {srcItem.itemName} [{docSt}]\n\n" + docText = cmtLine + docText + + self._targetText.append(docText) + + return True + + def writeTargetDoc(self): + """Write the accumulated text into the designated target + document, appending any existing text. + """ + if self._targetDoc is None: + return False + + outDoc = NWDoc(self.theProject, self._targetDoc) + docText = (outDoc.readDocument() or "").rstrip("\n") + if docText: + self._targetText.insert(0, docText) + + status = outDoc.writeDocument("\n\n".join(self._targetText)) + if not status: + self._error = outDoc.getError() + + return status # END Class DocMerger diff --git a/novelwriter/core/item.py b/novelwriter/core/item.py index 95418079..3f463a1b 100644 --- a/novelwriter/core/item.py +++ b/novelwriter/core/item.py @@ -292,16 +292,16 @@ class NWItem(): return trConst(nwLabels.ITEM_DESCRIPTION.get(descKey, "")) - def getImportStatus(self): + def getImportStatus(self, incIcon=True): """Return the relevant importance or status label and icon for the current item based on its class. """ if self.isNovelLike(): stName = self.theProject.statusItems.name(self._status) - stIcon = self.theProject.statusItems.icon(self._status) + stIcon = self.theProject.statusItems.icon(self._status) if incIcon else None else: stName = self.theProject.importItems.name(self._import) - stIcon = self.theProject.importItems.icon(self._import) + stIcon = self.theProject.importItems.icon(self._import) if incIcon else None return stName, stIcon ## diff --git a/novelwriter/dialogs/docmerge.py b/novelwriter/dialogs/docmerge.py index 2d248200..89149ab8 100644 --- a/novelwriter/dialogs/docmerge.py +++ b/novelwriter/dialogs/docmerge.py @@ -88,6 +88,9 @@ class GuiDocMerge(QDialog): self.buttonBox.accepted.connect(self.accept) self.buttonBox.rejected.connect(self.reject) + self.resetButton = self.buttonBox.addButton(QDialogButtonBox.Reset) + self.resetButton.clicked.connect(self._resetList) + # Assemble self.outerBox = QVBoxLayout() self.outerBox.setSpacing(0) @@ -122,6 +125,19 @@ class GuiDocMerge(QDialog): return self._data + ## + # Slots + ## + + def _resetList(self): + """Reset the content of the list box to its original state. + """ + logger.debug("Resetting list box content") + sHandle = self._data.get("sHandle", None) + itemList = self._data.get("origItems", []) + self._loadContent(sHandle, itemList) + return + ## # Internal Functions ## diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index e841375a..a32e0b48 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -39,7 +39,7 @@ from PyQt5.QtWidgets import ( QVBoxLayout, QWidget ) -from novelwriter.core import NWDoc +from novelwriter.core import NWDoc, DocMerger from novelwriter.enum import nwDocMode, nwItemType, nwItemClass, nwItemLayout, nwAlert from novelwriter.dialogs import GuiDocMerge, GuiEditLabel from novelwriter.constants import nwHeaders, trConst, nwLabels @@ -770,10 +770,14 @@ class GuiProjectTree(QTreeWidget): else: # The item is not already in the trash folder, so we # move it there. - msgYes = self.mainGui.askQuestion( - self.tr("Delete"), - self.tr("Move '{0}' to Trash?").format(nwItemS.itemName), - ) + if not alreadyAsked: + msgYes = self.mainGui.askQuestion( + self.tr("Delete"), + self.tr("Move '{0}' to Trash?").format(nwItemS.itemName), + ) + else: + msgYes = True + if msgYes: logger.debug("Moving item '%s' to trash", tHandle) @@ -1114,13 +1118,17 @@ class GuiProjectTree(QTreeWidget): if hasChild: if isFile: mTrans.addAction( - self.tr("Merge Child Documents"), - lambda: self._mergeDocuments(tHandle, isFile) + self.tr("Merge Child Items into Self"), + lambda: self._mergeDocuments(tHandle, False) + ) + mTrans.addAction( + self.tr("Merge Child Items into New"), + lambda: self._mergeDocuments(tHandle, True) ) else: mTrans.addAction( self.tr("Combine Documents in Folder"), - lambda: self._mergeDocuments(tHandle, isFile) + lambda: self._mergeDocuments(tHandle, True) ) if isFile: @@ -1377,18 +1385,63 @@ class GuiProjectTree(QTreeWidget): logger.info("Folder conversion cancelled") return - def _mergeDocuments(self, tHandle, isFile): + def _mergeDocuments(self, tHandle, newFile): """Merge an item's child documents into a single document. """ logger.info("Request to merge items under handle '%s'", tHandle) itemList = self.getTreeFromHandle(tHandle) - itemList.remove(tHandle) + + tItem = self.theProject.tree[tHandle] + if tItem is None: + return + + if not newFile: + itemList.remove(tHandle) dlgMerge = GuiDocMerge(self.mainGui, tHandle, itemList) dlgMerge.exec_() if dlgMerge.result() == QDialog.Accepted: - print(dlgMerge.getData()) + # Save the open document first, in case it's part of this + self.mainGui.saveDocument() + + # Set up the merge job + mrgData = dlgMerge.getData() + docMerger = DocMerger(self.theProject) + mLabel = self.tr("Merged") + + if newFile: + docLabel = f"[{mLabel}] {tItem.itemName}" + mHandle = docMerger.newTargetDoc(tHandle, docLabel) + elif tItem.isFileType(): + docMerger.setTargetDoc(tHandle) + mHandle = tHandle + else: + return + + for sHandle in mrgData.get("finalItems", []): + docMerger.appendText(sHandle, True, mLabel) + + if not docMerger.writeTargetDoc(): + self.mainGui.makeAlert([ + self.tr("Could not save document."), docMerger.getError() + ], nwAlert.ERROR) + return + + if newFile: + self.mainGui.projView.revealNewTreeItem(mHandle, tHandle) + + self.theProject.index.reIndexHandle(mHandle) + self.mainGui.openDocument(mHandle, doScroll=True) + + if mrgData.get("moveToTrash", False): + for sHandle in reversed(mrgData.get("finalItems", [])): + trItem = self._getTreeItem(sHandle) + if isinstance(trItem, QTreeWidgetItem) and trItem.childCount() == 0: + self.deleteItem(sHandle, alreadyAsked=True, bulkAction=True) + self._alertTreeChange(sHandle, flush=False) + + self._alertTreeChange(mHandle, flush=True) return From 2bda53e9713da6bf608a56df8210b99a0712c90f Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 19:21:05 +0200 Subject: [PATCH 03/12] Split up the project tree deleteItem function --- novelwriter/core/project.py | 17 ++ novelwriter/gui/mainmenu.py | 2 +- novelwriter/gui/projtree.py | 249 +++++++++++++++-------------- tests/test_gui/test_gui_guimain.py | 4 +- 4 files changed, 149 insertions(+), 123 deletions(-) diff --git a/novelwriter/core/project.py b/novelwriter/core/project.py index 1dffd1aa..a6f88a7e 100644 --- a/novelwriter/core/project.py +++ b/novelwriter/core/project.py @@ -202,6 +202,23 @@ class NWProject(): return True + def removeItem(self, tHandle): + """Remove an item from the project. This will delete both the + project entry and a document file if it exists. + """ + if self._projTree.checkType(tHandle, nwItemType.FILE): + delDoc = NWDoc(self, tHandle) + if not delDoc.deleteDocument(): + self.mainGui.makeAlert([ + self.tr("Could not delete document file."), delDoc.getError() + ], nwAlert.ERROR) + return False + + self._projIndex.deleteHandle(tHandle) + del self._projTree[tHandle] + + return True + def trashFolder(self): """Add the special trash root folder to the project. """ diff --git a/novelwriter/gui/mainmenu.py b/novelwriter/gui/mainmenu.py index 59af7691..b756327e 100644 --- a/novelwriter/gui/mainmenu.py +++ b/novelwriter/gui/mainmenu.py @@ -171,7 +171,7 @@ class GuiMainMenu(QMenuBar): # Project > Delete self.aDeleteItem = QAction(self.tr("Delete Item"), self) self.aDeleteItem.setShortcut("Ctrl+Shift+Del") - self.aDeleteItem.triggered.connect(lambda: self.mainGui.projView.deleteItem(None)) + self.aDeleteItem.triggered.connect(lambda: self.mainGui.projView.requestDeleteItem(None)) self.projMenu.addAction(self.aDeleteItem) # Project > Empty Trash diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index a32e0b48..6ecf6699 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -39,7 +39,7 @@ from PyQt5.QtWidgets import ( QVBoxLayout, QWidget ) -from novelwriter.core import NWDoc, DocMerger +from novelwriter.core import DocMerger from novelwriter.enum import nwDocMode, nwItemType, nwItemClass, nwItemLayout, nwAlert from novelwriter.dialogs import GuiDocMerge, GuiEditLabel from novelwriter.constants import nwHeaders, trConst, nwLabels @@ -106,7 +106,7 @@ class GuiProjectView(QWidget): self.renameTreeItem = self.projTree.renameTreeItem self.getTreeFromHandle = self.projTree.getTreeFromHandle self.emptyTrash = self.projTree.emptyTrash - self.deleteItem = self.projTree.deleteItem + self.requestDeleteItem = self.projTree.requestDeleteItem self.setTreeItemValues = self.projTree.setTreeItemValues self.propagateCount = self.projTree.propagateCount self.getSelectedHandle = self.projTree.getSelectedHandle @@ -627,6 +627,42 @@ class GuiProjectTree(QTreeWidget): theList = self._scanChildren(theList, theItem, 0) return theList + def requestDeleteItem(self, tHandle=None): + """Request an item deleted from the project tree. This function + can be called on any item, and will check whether to attempt a + permanent deletion or moving the item to Trash. + """ + if not self.mainGui.hasProject: + logger.error("No project open") + return False + + if not self.hasFocus(): + logger.info("Delete action blocked due to no widget focus") + return False + + if tHandle is None: + tHandle = self.getSelectedHandle() + + if tHandle is None: + logger.error("There is no item to delete") + return False + + trashHandle = self.theProject.tree.trashRoot() + if tHandle == trashHandle: + logger.error("Cannot delete the Trash folder") + return False + + nwItem = self.theProject.tree[tHandle] + if nwItem is None: + return False + + if self.theProject.tree.isTrash(tHandle) or nwItem.isRootType(): + self.permanentlyDeleteItem(tHandle) + else: + self.moveItemToTrash(tHandle) + + return True + def emptyTrash(self): """Permanently delete all documents in the Trash folder. This function only asks for confirmation once, and calls the regular @@ -667,35 +703,17 @@ class GuiProjectTree(QTreeWidget): for tHandle in reversed(self.getTreeFromHandle(trashHandle)): if tHandle == trashHandle: continue - self.deleteItem(tHandle, alreadyAsked=True, bulkAction=True) + self.permanentlyDeleteItem(tHandle, askFirst=False, flush=False) if nTrash > 0: self._alertTreeChange(trashHandle, flush=True) return True - def deleteItem(self, tHandle=None, alreadyAsked=False, bulkAction=False): - """Delete an item from the project tree. As a first step, files are - moved to the Trash folder. Permanent deletion is a second step. This - second step also deletes the item from the project object as well as - delete the files on disk. Root folders are deleted if they're empty - only, and the deletion is always permanent. + def moveItemToTrash(self, tHandle, askFirst=True, flush=True): + """Move an item to Trash. Root folders cannot be moved to Trash, + so such a request is cancelled. """ - if not self.mainGui.hasProject: - logger.error("No project open") - return False - - if not self.hasFocus() and not bulkAction: - logger.info("Delete action blocked due to no widget focus") - return False - - if tHandle is None: - tHandle = self.getSelectedHandle() - - if tHandle is None: - logger.error("There is no item to delete") - return False - trItemS = self._getTreeItem(tHandle) nwItemS = self.theProject.tree[tHandle] @@ -703,91 +721,99 @@ class GuiProjectTree(QTreeWidget): logger.error("Could not find tree item for deletion") return False + if self.theProject.tree.isTrash(tHandle): + logger.error("Item is already in the Trash folder") + return False + + if nwItemS.isRootType(): + logger.error("Root folders cannot be moved to Trash") + return False + + logger.debug("User requested file or folder '%s' move to Trash", tHandle) + + trItemP = trItemS.parent() + trItemT = self._addTrashRoot() + if trItemP is None or trItemT is None: + logger.error("Could not delete item") + return False + + if askFirst: + msgYes = self.mainGui.askQuestion( + self.tr("Delete"), + self.tr("Move '{0}' to Trash?").format(nwItemS.itemName), + ) + if not msgYes: + logger.info("Action cancelled by user") + return False + wCount = self._getItemWordCount(tHandle) - autoFlush = not bulkAction + self.propagateCount(tHandle, 0) + + tIndex = trItemP.indexOfChild(trItemS) + trItemC = trItemP.takeChild(tIndex) + trItemT.addChild(trItemC) + + self._postItemMove(tHandle, wCount) + self._recordLastMove(trItemS, trItemP, tIndex) + self._alertTreeChange(tHandle, flush=flush) + + logger.debug("Moved item '%s' to Trash", tHandle) + + return True + + def permanentlyDeleteItem(self, tHandle, askFirst=True, flush=False): + """Permanently delete a tree item from the project and the map. + Root items are handled a little different than other items. + """ + trItemS = self._getTreeItem(tHandle) + nwItemS = self.theProject.tree[tHandle] + if trItemS is None or nwItemS is None: + logger.error("Could not find tree item for deletion") + return False + if nwItemS.isRootType(): # Only an empty ROOT folder can be deleted - logger.debug("User requested a root folder '%s' deleted", tHandle) - tIndex = self.indexOfTopLevelItem(trItemS) - if trItemS.childCount() == 0: - self.takeTopLevelItem(tIndex) - self._deleteTreeItem(tHandle) - self._alertTreeChange(tHandle, flush=True) - else: + if trItemS.childCount() > 0: self.mainGui.makeAlert(self.tr( - "Cannot delete root folder. It is not empty. " - "Recursive deletion is not supported. " - "Please delete the content first." + "Root folders can only be deleted when they are empty." ), nwAlert.ERROR) return False - elif nwItemS.isFolderType() and trItemS.childCount() == 0: - # An empty FOLDER is just deleted without any further checks - logger.debug("User requested an empty folder '%s' deleted", tHandle) + logger.debug("Permanently deleting root folder '%s'", tHandle) + + tIndex = self.indexOfTopLevelItem(trItemS) + self.takeTopLevelItem(tIndex) + self.theProject.removeItem(tHandle) + self._treeMap.pop(tHandle, None) + self._alertTreeChange(tHandle, flush=True) + + else: + if askFirst: + msgYes = self.mainGui.askQuestion( + self.tr("Delete"), + self.tr("Permanently delete '{0}'?").format(nwItemS.itemName) + ) + if not msgYes: + logger.info("Action cancelled by user") + return False + + logger.debug("Permanently deleting item '%s'", tHandle) + + self.propagateCount(tHandle, 0) + itemList = self.getTreeFromHandle(tHandle) + trItemP = trItemS.parent() tIndex = trItemP.indexOfChild(trItemS) trItemP.takeChild(tIndex) - self._deleteTreeItem(tHandle) - self._alertTreeChange(tHandle, flush=autoFlush) - else: - # A populated FOLDER or a FILE requires confirmtation - logger.debug("User requested a file or folder '%s' deleted", tHandle) - trItemP = trItemS.parent() - trItemT = self._addTrashRoot() - if trItemP is None or trItemT is None: - logger.error("Could not delete item") - return False + for dHandle in reversed(itemList): + if self.mainGui.docEditor.docHandle() == dHandle: + self.mainGui.closeDocument() + self.theProject.removeItem(tHandle) + self._treeMap.pop(tHandle, None) - if self.theProject.tree.isTrash(tHandle): - # If the file is in the trash folder already, as the - # user if they want to permanently delete the file. - doPermanent = False - if not alreadyAsked: - msgYes = self.mainGui.askQuestion( - self.tr("Delete"), - self.tr("Permanently delete '{0}'?").format(nwItemS.itemName) - ) - if msgYes: - doPermanent = True - else: - doPermanent = True - - if doPermanent: - logger.debug("Permanently deleting item with handle '%s'", tHandle) - - self.propagateCount(tHandle, 0) - tIndex = trItemP.indexOfChild(trItemS) - trItemC = trItemP.takeChild(tIndex) - for dHandle in reversed(self.getTreeFromHandle(tHandle)): - if self.mainGui.docEditor.docHandle() == dHandle: - self.mainGui.closeDocument() - self._deleteTreeItem(dHandle) - - self._alertTreeChange(tHandle, flush=autoFlush) - self.projView.wordCountsChanged.emit() - - else: - # The item is not already in the trash folder, so we - # move it there. - if not alreadyAsked: - msgYes = self.mainGui.askQuestion( - self.tr("Delete"), - self.tr("Move '{0}' to Trash?").format(nwItemS.itemName), - ) - else: - msgYes = True - - if msgYes: - logger.debug("Moving item '%s' to trash", tHandle) - - self.propagateCount(tHandle, 0) - tIndex = trItemP.indexOfChild(trItemS) - trItemC = trItemP.takeChild(tIndex) - trItemT.addChild(trItemC) - self._postItemMove(tHandle, wCount) - self._recordLastMove(trItemS, trItemP, tIndex) - self._alertTreeChange(tHandle, flush=autoFlush) + self._alertTreeChange(tHandle, flush=flush) + self.projView.wordCountsChanged.emit() return True @@ -1158,11 +1184,11 @@ class GuiProjectTree(QTreeWidget): if tItem.itemClass == nwItemClass.TRASH or isRoot or (isFolder and not hasChild): ctxMenu.addAction( - self.tr("Delete Permanently"), lambda: self.deleteItem(tHandle) + self.tr("Delete Permanently"), lambda: self.permanentlyDeleteItem(tHandle) ) else: ctxMenu.addAction( - self.tr("Move to Trash"), lambda: self.deleteItem(tHandle) + self.tr("Move to Trash"), lambda: self.moveItemToTrash(tHandle) ) ctxMenu.exec_(self.viewport().mapToGlobal(clickPos)) @@ -1285,23 +1311,6 @@ class GuiProjectTree(QTreeWidget): """ return self._treeMap.get(tHandle, None) - def _deleteTreeItem(self, tHandle): - """Permanently delete a tree item from the project and the map. - """ - if self.theProject.tree.checkType(tHandle, nwItemType.FILE): - delDoc = NWDoc(self.theProject, tHandle) - if not delDoc.deleteDocument(): - self.mainGui.makeAlert([ - self.tr("Could not delete document file."), delDoc.getError() - ], nwAlert.ERROR) - return False - - self.theProject.index.deleteHandle(tHandle) - del self.theProject.tree[tHandle] - self._treeMap.pop(tHandle, None) - - return True - def _toggleItemExported(self, tHandle): """Toggle the exported status of an item. """ @@ -1438,10 +1447,10 @@ class GuiProjectTree(QTreeWidget): for sHandle in reversed(mrgData.get("finalItems", [])): trItem = self._getTreeItem(sHandle) if isinstance(trItem, QTreeWidgetItem) and trItem.childCount() == 0: - self.deleteItem(sHandle, alreadyAsked=True, bulkAction=True) - self._alertTreeChange(sHandle, flush=False) + self.moveItemToTrash(sHandle, askFirst=False, flush=False) self._alertTreeChange(mHandle, flush=True) + self.projView.wordCountsChanged.emit() return @@ -1548,10 +1557,10 @@ class GuiProjectTree(QTreeWidget): if tHandle is None: return - tItem = self.theProject.tree[tHandle] - if tItem is None: + if tHandle not in self.theProject.tree: return + tItem = self.theProject.tree[tHandle] if tItem.isRootType(): self.projView.rootFolderChanged.emit(tHandle) diff --git a/tests/test_gui/test_gui_guimain.py b/tests/test_gui/test_gui_guimain.py index fd1218a0..f18e3050 100644 --- a/tests/test_gui/test_gui_guimain.py +++ b/tests/test_gui/test_gui_guimain.py @@ -504,9 +504,9 @@ def testGuiMain_Editing(qtbot, monkeypatch, nwGUI, fncProj, refDir, outDir, mock assert nwGUI.projView.projTree.newTreeItem(nwItemType.FILE, None) newHandle = nwGUI.projView.getSelectedHandle() assert nwGUI.theProject.tree["0000000000020"] is not None - assert nwGUI.projView.deleteItem() + assert nwGUI.projView.requestDeleteItem() assert nwGUI.projView.setSelectedHandle(newHandle) - assert nwGUI.projView.deleteItem() + assert nwGUI.projView.requestDeleteItem() assert nwGUI.theProject.tree["0000000000024"] is not None # Trash assert nwGUI.saveProject() From 0859c145810cac056df8699bca7e370071d8a319 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 19:23:55 +0200 Subject: [PATCH 04/12] Remove the old merge document menu entry --- novelwriter/gui/mainmenu.py | 5 ----- novelwriter/guimain.py | 16 ++-------------- tests/test_gui/test_gui_guimain.py | 1 - 3 files changed, 2 insertions(+), 20 deletions(-) diff --git a/novelwriter/gui/mainmenu.py b/novelwriter/gui/mainmenu.py index b756327e..7877d44a 100644 --- a/novelwriter/gui/mainmenu.py +++ b/novelwriter/gui/mainmenu.py @@ -244,11 +244,6 @@ class GuiMainMenu(QMenuBar): self.aImportFile.triggered.connect(lambda: self.mainGui.importDocument()) self.docuMenu.addAction(self.aImportFile) - # Document > Merge Documents - self.aMergeDocs = QAction(self.tr("Merge Folder to Document"), self) - self.aMergeDocs.triggered.connect(lambda: self.mainGui.mergeDocuments()) - self.docuMenu.addAction(self.aMergeDocs) - # Document > Split Document self.aSplitDoc = QAction(self.tr("Split Document to Folder"), self) self.aSplitDoc.triggered.connect(lambda: self.mainGui.splitDocument()) diff --git a/novelwriter/guimain.py b/novelwriter/guimain.py index bad8c904..7b165676 100644 --- a/novelwriter/guimain.py +++ b/novelwriter/guimain.py @@ -44,8 +44,8 @@ from novelwriter.gui import ( GuiViewsBar ) from novelwriter.dialogs import ( - GuiAbout, GuiDocMerge, GuiDocSplit, GuiPreferences, GuiProjectDetails, - GuiProjectLoad, GuiProjectSettings, GuiUpdates, GuiWordList + GuiAbout, GuiDocSplit, GuiPreferences, GuiProjectDetails, GuiProjectLoad, + GuiProjectSettings, GuiUpdates, GuiWordList ) from novelwriter.tools import ( GuiBuildNovel, GuiLipsum, GuiProjectWizard, GuiWritingStats @@ -745,18 +745,6 @@ class GuiMain(QMainWindow): return True - def mergeDocuments(self): - """Merge multiple documents to one single new document. - """ - if not self.hasProject: - logger.error("No project open") - return False - - dlgMerge = GuiDocMerge(self) - dlgMerge.exec_() - - return True - def splitDocument(self): """Split a single document into multiple documents. """ diff --git a/tests/test_gui/test_gui_guimain.py b/tests/test_gui/test_gui_guimain.py index f18e3050..5c75c406 100644 --- a/tests/test_gui/test_gui_guimain.py +++ b/tests/test_gui/test_gui_guimain.py @@ -54,7 +54,6 @@ def testGuiMain_ProjectBlocker(monkeypatch, nwGUI): assert nwGUI.saveDocument() is False assert nwGUI.viewDocument(None) is False assert nwGUI.importDocument() is False - assert nwGUI.mergeDocuments() is False assert nwGUI.splitDocument() is False assert nwGUI.openSelectedItem() is False assert nwGUI.editItemLabel() is False From 23b73dd936bd57ad2bfd1bb709e2f4d951b3cf03 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 20:49:25 +0200 Subject: [PATCH 05/12] Update tests for project tree deleting items --- novelwriter/gui/projtree.py | 11 +- tests/test_gui/test_gui_projtree.py | 475 +++++++++++++++++----------- 2 files changed, 297 insertions(+), 189 deletions(-) diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index 6ecf6699..b47e6bc4 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -602,7 +602,7 @@ class GuiProjectTree(QTreeWidget): self.setTreeItemValues(tHandle) self._alertTreeChange(tHandle, flush=False) - return + return True def saveTreeOrder(self): """Build a list of the items in the project tree and send them @@ -657,11 +657,11 @@ class GuiProjectTree(QTreeWidget): return False if self.theProject.tree.isTrash(tHandle) or nwItem.isRootType(): - self.permanentlyDeleteItem(tHandle) + status = self.permanentlyDeleteItem(tHandle) else: - self.moveItemToTrash(tHandle) + status = self.moveItemToTrash(tHandle) - return True + return status def emptyTrash(self): """Permanently delete all documents in the Trash folder. This @@ -697,6 +697,7 @@ class GuiProjectTree(QTreeWidget): self.tr("Permanently delete {0} file(s) from Trash?").format(nTrash) ) if not msgYes: + logger.info("Action cancelled by user") return False logger.verbose("Deleting %d file(s) from Trash", nTrash) @@ -761,7 +762,7 @@ class GuiProjectTree(QTreeWidget): return True - def permanentlyDeleteItem(self, tHandle, askFirst=True, flush=False): + def permanentlyDeleteItem(self, tHandle, askFirst=True, flush=True): """Permanently delete a tree item from the project and the map. Root items are handled a little different than other items. """ diff --git a/tests/test_gui/test_gui_projtree.py b/tests/test_gui/test_gui_projtree.py index 21ce22df..e46418b9 100644 --- a/tests/test_gui/test_gui_projtree.py +++ b/tests/test_gui/test_gui_projtree.py @@ -19,8 +19,8 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . """ -import pytest import os +import pytest from tools import buildTestProject @@ -42,113 +42,127 @@ def testGuiProjTree_NewItems(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd) monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes) monkeypatch.setattr(GuiEditLabel, "getLabel", lambda *a, text: (text, True)) - nwTree = nwGUI.projView + projView = nwGUI.projView + projTree = nwGUI.projView.projTree + theProject = nwGUI.theProject # Try to add item with no project - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is False + assert projView.projTree.newTreeItem(nwItemType.FILE) is False # Create a project prjDir = os.path.join(fncDir, "project") buildTestProject(nwGUI, prjDir) # No itemType set - nwTree.projTree.clearSelection() - assert nwTree.projTree.newTreeItem(None) is False + projView.projTree.clearSelection() + assert projView.projTree.newTreeItem(None) is False # Root Items # ========== # No class set - assert nwTree.projTree.newTreeItem(nwItemType.ROOT) is False + assert projView.projTree.newTreeItem(nwItemType.ROOT) is False # Create root item - assert nwTree.projTree.newTreeItem(nwItemType.ROOT, nwItemClass.WORLD) is True - assert "0000000000010" in nwGUI.theProject.tree + assert projView.projTree.newTreeItem(nwItemType.ROOT, nwItemClass.WORLD) is True + assert "0000000000010" in theProject.tree # File/Folder Items # ================= # No location selected for new item - nwTree.projTree.clearSelection() + projView.projTree.clearSelection() caplog.clear() - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is False - assert nwTree.projTree.newTreeItem(nwItemType.FOLDER) is False + assert projView.projTree.newTreeItem(nwItemType.FILE) is False + assert projView.projTree.newTreeItem(nwItemType.FOLDER) is False assert "Did not find anywhere" in caplog.text # Create new folder as child of Novel folder - nwTree.setSelectedHandle("0000000000008") - assert nwTree.projTree.newTreeItem(nwItemType.FOLDER) is True - assert nwGUI.theProject.tree["0000000000011"].itemParent == "0000000000008" - assert nwGUI.theProject.tree["0000000000011"].itemRoot == "0000000000008" - assert nwGUI.theProject.tree["0000000000011"].itemClass == nwItemClass.NOVEL + projView.setSelectedHandle("0000000000008") + assert projView.projTree.newTreeItem(nwItemType.FOLDER) is True + assert theProject.tree["0000000000011"].itemParent == "0000000000008" + assert theProject.tree["0000000000011"].itemRoot == "0000000000008" + assert theProject.tree["0000000000011"].itemClass == nwItemClass.NOVEL # Add a new file in the new folder - nwTree.setSelectedHandle("0000000000011") - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - assert nwGUI.theProject.tree["0000000000012"].itemParent == "0000000000011" - assert nwGUI.theProject.tree["0000000000012"].itemRoot == "0000000000008" - assert nwGUI.theProject.tree["0000000000012"].itemClass == nwItemClass.NOVEL + projView.setSelectedHandle("0000000000011") + assert projView.projTree.newTreeItem(nwItemType.FILE) is True + assert theProject.tree["0000000000012"].itemParent == "0000000000011" + assert theProject.tree["0000000000012"].itemRoot == "0000000000008" + assert theProject.tree["0000000000012"].itemClass == nwItemClass.NOVEL # Add a new chapter next to the other new file - nwTree.setSelectedHandle("0000000000012") - assert nwTree.projTree.newTreeItem(nwItemType.FILE, hLevel=2) is True - assert nwGUI.theProject.tree["0000000000013"].itemParent == "0000000000011" - assert nwGUI.theProject.tree["0000000000013"].itemRoot == "0000000000008" - assert nwGUI.theProject.tree["0000000000013"].itemClass == nwItemClass.NOVEL + projView.setSelectedHandle("0000000000012") + assert projView.projTree.newTreeItem(nwItemType.FILE, hLevel=2) is True + assert theProject.tree["0000000000013"].itemParent == "0000000000011" + assert theProject.tree["0000000000013"].itemRoot == "0000000000008" + assert theProject.tree["0000000000013"].itemClass == nwItemClass.NOVEL assert nwGUI.openDocument("0000000000013") assert nwGUI.docEditor.getText() == "## New Chapter\n\n" # Add a new scene next to the other new file - nwTree.setSelectedHandle("0000000000012") - assert nwTree.projTree.newTreeItem(nwItemType.FILE, hLevel=3) is True - assert nwGUI.theProject.tree["0000000000014"].itemParent == "0000000000011" - assert nwGUI.theProject.tree["0000000000014"].itemRoot == "0000000000008" - assert nwGUI.theProject.tree["0000000000014"].itemClass == nwItemClass.NOVEL + projView.setSelectedHandle("0000000000012") + assert projView.projTree.newTreeItem(nwItemType.FILE, hLevel=3) is True + assert theProject.tree["0000000000014"].itemParent == "0000000000011" + assert theProject.tree["0000000000014"].itemRoot == "0000000000008" + assert theProject.tree["0000000000014"].itemClass == nwItemClass.NOVEL assert nwGUI.openDocument("0000000000014") assert nwGUI.docEditor.getText() == "### New Scene\n\n" # Add a new file to the characters folder - nwTree.setSelectedHandle("000000000000a") - assert nwTree.projTree.newTreeItem(nwItemType.FILE, hLevel=1, isNote=True) is True - assert nwGUI.theProject.tree["0000000000015"].itemParent == "000000000000a" - assert nwGUI.theProject.tree["0000000000015"].itemRoot == "000000000000a" - assert nwGUI.theProject.tree["0000000000015"].itemClass == nwItemClass.CHARACTER + projView.setSelectedHandle("000000000000a") + assert projView.projTree.newTreeItem(nwItemType.FILE, hLevel=1, isNote=True) is True + assert theProject.tree["0000000000015"].itemParent == "000000000000a" + assert theProject.tree["0000000000015"].itemRoot == "000000000000a" + assert theProject.tree["0000000000015"].itemClass == nwItemClass.CHARACTER assert nwGUI.openDocument("0000000000015") assert nwGUI.docEditor.getText() == "# New Note\n\n" # Make sure the sibling folder bug trap works - nwTree.setSelectedHandle("0000000000013") - nwGUI.theProject.tree["0000000000013"].setParent(None) # This should not happen + projView.setSelectedHandle("0000000000013") + theProject.tree["0000000000013"].setParent(None) # This should not happen caplog.clear() - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is False + assert projView.projTree.newTreeItem(nwItemType.FILE) is False assert "Internal error" in caplog.text - nwGUI.theProject.tree["0000000000013"].setParent("0000000000011") + theProject.tree["0000000000013"].setParent("0000000000011") # Cancel during creation with monkeypatch.context() as mp: mp.setattr(GuiEditLabel, "getLabel", lambda *a, **k: ("", False)) - nwTree.setSelectedHandle("0000000000013") - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is False + projView.setSelectedHandle("0000000000013") + assert projView.projTree.newTreeItem(nwItemType.FILE) is False # Get the trash folder - nwTree.projTree._addTrashRoot() - trashHandle = nwGUI.theProject.trashFolder() - nwTree.setSelectedHandle(trashHandle) - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is False + projView.projTree._addTrashRoot() + trashHandle = theProject.trashFolder() + projView.setSelectedHandle(trashHandle) + assert projView.projTree.newTreeItem(nwItemType.FILE) is False assert "Cannot add new files or folders to the Trash folder" in caplog.text + # Rename Item + # =========== + + # Rename plot folder + with monkeypatch.context() as mp: + mp.setattr(GuiEditLabel, "getLabel", lambda *a, **k: ("Stuff", True)) + projTree.renameTreeItem("0000000000009") is True + assert theProject.tree["0000000000009"].itemName == "Stuff" + + # Rename invalid folder + projTree.renameTreeItem("0000000000000") is False + # Other Checks # ============ # Also check error handling in reveal function - assert nwTree.revealNewTreeItem("abc") is False + assert projView.revealNewTreeItem("abc") is False # Add an item that cannot be displayed in the tree - nHandle = nwGUI.theProject.newFile("Test", None) - assert nwTree.revealNewTreeItem(nHandle) is False + nHandle = theProject.newFile("Test", None) + assert projView.revealNewTreeItem(nHandle) is False # Clean up - # qtbot.stopForInteraction() + # qtbot.stop() nwGUI.closeProject() # END Test testGuiProjTree_NewItems @@ -270,8 +284,8 @@ def testGuiProjTree_MoveItems(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): @pytest.mark.gui -def testGuiProjTree_DeleteItems(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd): - """Test adding and removing items from the project tree. +def testGuiProjTree_RequestDeleteItem(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd): + """Test external requests for removing items from project tree. """ # Block message box monkeypatch.setattr(QMessageBox, "warning", lambda *a: QMessageBox.Yes) @@ -280,181 +294,274 @@ def testGuiProjTree_DeleteItems(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockR monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes) monkeypatch.setattr(GuiEditLabel, "getLabel", lambda *a, text: (text, True)) - nwTree = nwGUI.projView + nwView = nwGUI.projView # Try to run with no project - assert nwTree.emptyTrash() is False - assert nwTree.deleteItem() is False + assert nwView.requestDeleteItem() is False # Create a project prjDir = os.path.join(fncDir, "project") buildTestProject(nwGUI, prjDir) # Try emptying the trash already now, when there is no trash folder - assert nwTree.emptyTrash() is False + assert nwView.emptyTrash() is False # Add some files - nwTree.setSelectedHandle("000000000000d") - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - assert nwTree.getTreeFromHandle("000000000000d") == [ + nwView.setSelectedHandle("000000000000d") + assert nwView.projTree.newTreeItem(nwItemType.FILE) is True + assert nwView.projTree.newTreeItem(nwItemType.FILE) is True + assert nwView.projTree.newTreeItem(nwItemType.FILE) is True + assert nwView.getTreeFromHandle("000000000000d") == [ "000000000000d", "000000000000e", "000000000000f", "0000000000010", "0000000000011", "0000000000012", ] # Delete item without focus -> blocked monkeypatch.setattr(GuiProjectTree, "hasFocus", lambda *a: False) - nwTree.setSelectedHandle("0000000000012") - assert nwTree.deleteItem() is False + nwView.setSelectedHandle("0000000000012") + assert nwView.requestDeleteItem() is False monkeypatch.setattr(GuiProjectTree, "hasFocus", lambda *a: True) # No selection made - nwTree.projTree.clearSelection() + nwView.projTree.clearSelection() caplog.clear() - assert nwTree.deleteItem() is False + assert nwView.requestDeleteItem() is False assert "no item to delete" in caplog.text # Not a valid handle - nwTree.projTree.clearSelection() + nwView.projTree.clearSelection() caplog.clear() - assert nwTree.deleteItem("0000000000000") is False - assert "Could not find tree item" in caplog.text + assert nwView.requestDeleteItem("0000000000000") is False + assert "No tree item with handle '0000000000000'" in caplog.text - # Delete Folder/Root - # ================== + # Delete Root Folders + # =================== - # Deleting non-empty folders is blocked - assert nwTree.deleteItem("0000000000008") is False # Novel Root - assert nwTree.deleteItem("000000000000a") is True # Character Root + assert nwView.requestDeleteItem("0000000000008") is False # Novel Root is blocked + assert nwView.requestDeleteItem("000000000000a") is True # Character Root # Delete File # =========== # Block adding trash folder - funcPointer = nwTree.projTree._addTrashRoot - nwTree.projTree._addTrashRoot = lambda *a: None - assert nwTree.deleteItem("0000000000012") is False - nwTree.projTree._addTrashRoot = funcPointer + funcPointer = nwView.projTree._addTrashRoot + nwView.projTree._addTrashRoot = lambda *a: None + assert nwView.requestDeleteItem("0000000000012") is False + nwView.projTree._addTrashRoot = funcPointer # Delete last two documents, which also adds the trash folder - assert nwTree.deleteItem("0000000000012") is True - assert nwTree.deleteItem("0000000000011") is True - assert nwTree.getTreeFromHandle("000000000000d") == [ + assert nwView.requestDeleteItem("0000000000012") is True + assert nwView.requestDeleteItem("0000000000011") is True + assert nwView.getTreeFromHandle("000000000000d") == [ "000000000000d", "000000000000e", "000000000000f", "0000000000010" ] trashHandle = nwGUI.theProject.tree.trashRoot() - assert nwTree.getTreeFromHandle(trashHandle) == [ + assert nwView.getTreeFromHandle(trashHandle) == [ trashHandle, "0000000000012", "0000000000011" ] - # Delete the first file again (permanent), and ask for permission - # Also open the document in the editor, which should trigger a close - assert os.path.isfile(os.path.join(prjDir, "content", "0000000000012.nwd")) - assert "0000000000012" in nwGUI.theProject.tree - assert nwGUI.docEditor.docHandle() is None - assert nwGUI.openDocument("0000000000012") is True - assert nwGUI.docEditor.docHandle() == "0000000000012" - assert nwTree.deleteItem("0000000000012") is True - assert nwGUI.docEditor.docHandle() is None - assert not os.path.isfile(os.path.join(prjDir, "content", "0000000000012.nwd")) - assert "0000000000012" not in nwGUI.theProject.tree - assert nwTree.getTreeFromHandle(trashHandle) == [ - trashHandle, "0000000000011" - ] + # Try to delete the trash folder + caplog.clear() + assert nwView.requestDeleteItem("0000000000013") is False + assert "Cannot delete the Trash folder" in caplog.text - # Delete the second file, and skip asking for permission - assert os.path.isfile(os.path.join(prjDir, "content", "0000000000011.nwd")) - assert "0000000000011" in nwGUI.theProject.tree - assert nwTree.deleteItem("0000000000011", alreadyAsked=True) is True - assert not os.path.isfile(os.path.join(prjDir, "content", "0000000000011.nwd")) - assert "0000000000011" not in nwGUI.theProject.tree - assert nwTree.getTreeFromHandle(trashHandle) == [trashHandle] - - # Delete Folder - # ============= - - trashHandle = nwGUI.theProject.tree.trashRoot() - - # Add a folder with two files - nwTree.setSelectedHandle("0000000000009") - assert nwTree.projTree.newTreeItem(nwItemType.FOLDER) is True - nwTree.setSelectedHandle("0000000000014") - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - assert os.path.isfile(os.path.join(fncDir, "project", "content", "0000000000015.nwd")) - assert os.path.isfile(os.path.join(fncDir, "project", "content", "0000000000016.nwd")) - - # Delete the folder, which moves everything to Trash - assert nwTree.getTreeFromHandle("0000000000014") == [ - "0000000000014", "0000000000015", "0000000000016" - ] - assert nwTree.deleteItem("0000000000014") is True - assert nwTree.getTreeFromHandle(trashHandle) == [ - trashHandle, "0000000000014", "0000000000015", "0000000000016" - ] - assert os.path.isfile(os.path.join(fncDir, "project", "content", "0000000000015.nwd")) - assert os.path.isfile(os.path.join(fncDir, "project", "content", "0000000000016.nwd")) - - # Delete again, which should delete folder and all files - assert nwTree.deleteItem("0000000000014") is True - assert nwTree.getTreeFromHandle(trashHandle) == [trashHandle] - assert not os.path.isfile(os.path.join(fncDir, "project", "content", "0000000000015.nwd")) - assert not os.path.isfile(os.path.join(fncDir, "project", "content", "0000000000016.nwd")) - - # Add an empty folder, which can be deleted with no further restrictions - nwTree.setSelectedHandle("0000000000009") - assert nwTree.projTree.newTreeItem(nwItemType.FOLDER) is True - assert nwTree.getTreeFromHandle("0000000000009") == ["0000000000009", "0000000000017"] - - nwTree.setSelectedHandle("0000000000017") - assert nwTree.deleteItem("0000000000017") is True - assert nwTree.getTreeFromHandle("0000000000009") == ["0000000000009"] - - # Empty Trash - # =========== - - # Try to empty trash that is already empty - assert nwTree.getTreeFromHandle(trashHandle) == [trashHandle] - assert nwTree.emptyTrash() is False - - # Move the two remaining scene documents to trash - assert nwTree.deleteItem("000000000000f") is True - assert nwTree.deleteItem("0000000000010") is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e" - ] - assert nwTree.getTreeFromHandle(trashHandle) == [ - trashHandle, "000000000000f", "0000000000010" - ] - - # Empty trash, but select no on question - with monkeypatch.context() as mp: - mp.setattr(QMessageBox, "question", lambda *a: QMessageBox.No) - assert nwTree.emptyTrash() is False - - # Empty the trash proper - assert nwTree.emptyTrash() is True - assert nwTree.getTreeFromHandle(trashHandle) == [trashHandle] - - # Try to delete a file, but block the underlying deletion of the file on disk - assert os.path.isfile(os.path.join(fncDir, "project", "content", "000000000000e.nwd")) - with monkeypatch.context() as mp: - mp.setattr("novelwriter.core.document.NWDoc.deleteDocument", lambda *a: False) - assert nwTree.deleteItem("000000000000e") is True - assert nwTree.deleteItem("000000000000e") is True - assert os.path.isfile(os.path.join(fncDir, "project", "content", "000000000000e.nwd")) - - # Delete proper - assert nwTree.projTree._deleteTreeItem("000000000000e") is True - assert not os.path.isfile(os.path.join(fncDir, "project", "content", "000000000000e.nwd")) - - # Clean up - # qtbot.stopForInteraction() nwGUI.closeProject() -# END Test testGuiProjTree_DeleteItems +# END Test testGuiProjTree_RequestDeleteItem + + +@pytest.mark.gui +def testGuiProjTree_MoveItemToTrash(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd): + """Test moving items to Trash. + """ + # Block message box + monkeypatch.setattr(QMessageBox, "warning", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "critical", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(GuiEditLabel, "getLabel", lambda *a, text: (text, True)) + + theProject = nwGUI.theProject + projTree = nwGUI.projView.projTree + + # Create a project + prjDir = os.path.join(fncDir, "project") + buildTestProject(nwGUI, prjDir) + + hInvalid = "0000000000000" + hNovelRoot = "0000000000008" + hTitlePage = "000000000000c" + + # Invalid item + caplog.clear() + assert projTree.moveItemToTrash(hInvalid) is False + assert "Could not find tree item for deletion" in caplog.text + + # Root folders cannot be moved to Trash + caplog.clear() + assert projTree.moveItemToTrash(hNovelRoot) is False + assert "Root folders cannot be moved to Trash" in caplog.text + + # Block adding trash folder + funcPointer = projTree._addTrashRoot + projTree._addTrashRoot = lambda *a: None + + caplog.clear() + assert projTree.moveItemToTrash(hTitlePage) is False + assert theProject.tree.isTrash(hTitlePage) is False + assert "Could not delete item" in caplog.text + + projTree._addTrashRoot = funcPointer + + # User cancels action + with monkeypatch.context() as mp: + mp.setattr(QMessageBox, "question", lambda *a: QMessageBox.No) + assert projTree.moveItemToTrash(hTitlePage) is False + assert theProject.tree.isTrash(hTitlePage) is False + + # Move a document to Trash + assert projTree.moveItemToTrash(hTitlePage) is True + assert theProject.tree.isTrash(hTitlePage) is True + + # Cannot be moved again + caplog.clear() + assert projTree.moveItemToTrash(hTitlePage) is False + assert "Item is already in the Trash folder" in caplog.text + + nwGUI.closeProject() + +# END Test testGuiProjTree_MoveItemToTrash + + +@pytest.mark.gui +def testGuiProjTree_PermanentlyDeleteItem(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd): + """Test permanently deleting items. + """ + # Block message box + monkeypatch.setattr(QMessageBox, "warning", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "critical", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(GuiEditLabel, "getLabel", lambda *a, text: (text, True)) + + theProject = nwGUI.theProject + projTree = nwGUI.projView.projTree + + # Create a project + prjDir = os.path.join(fncDir, "project") + buildTestProject(nwGUI, prjDir) + + hInvalid = "0000000000000" + hNovelRoot = "0000000000008" + hPlotRoot = "0000000000009" + hTitlePage = "000000000000c" + hChapterDir = "000000000000d" + hChapterDoc = "000000000000e" + hSceneDoc = "000000000000f" + + # Invalid item + caplog.clear() + assert projTree.permanentlyDeleteItem(hInvalid) is False + assert "Could not find tree item for deletion" in caplog.text + + # Not deleting root item in use + caplog.clear() + assert projTree.permanentlyDeleteItem(hNovelRoot) is False + assert "Root folders can only be deleted when they are empty" in caplog.text + assert hNovelRoot in theProject.tree + + # Deleting unused root item is allowed + caplog.clear() + assert projTree.permanentlyDeleteItem(hPlotRoot) is True + assert hPlotRoot not in theProject.tree + + # User cancels action + with monkeypatch.context() as mp: + mp.setattr(QMessageBox, "question", lambda *a: QMessageBox.No) + assert projTree.permanentlyDeleteItem(hTitlePage) is False + assert hTitlePage in theProject.tree + + # Deleting file is OK, and if it is open, it should close + assert nwGUI.openDocument(hTitlePage) is True + assert nwGUI.docEditor.docHandle() == hTitlePage + assert projTree.permanentlyDeleteItem(hTitlePage) is True + assert hTitlePage not in theProject.tree + assert nwGUI.docEditor.docHandle() is None + + # Deleting folder + files recursiely is ok + assert projTree.permanentlyDeleteItem(hChapterDir) is True + assert hChapterDir not in theProject.tree + assert hChapterDoc not in theProject.tree + assert hSceneDoc not in theProject.tree + + nwGUI.closeProject() + +# END Test testGuiProjTree_PermanentlyDeleteItem + + +@pytest.mark.gui +def testGuiProjTree_EmptyTrash(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd): + """Test emptying Trash. + """ + # Block message box + monkeypatch.setattr(QMessageBox, "warning", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "critical", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(GuiEditLabel, "getLabel", lambda *a, text: (text, True)) + + theProject = nwGUI.theProject + projTree = nwGUI.projView.projTree + + # No project open + caplog.clear() + assert projTree.emptyTrash() is False + assert "No project open" in caplog.text + + # Create a project + prjDir = os.path.join(fncDir, "project") + buildTestProject(nwGUI, prjDir) + + hTitlePage = "000000000000c" + hChapterDir = "000000000000d" + hChapterDoc = "000000000000e" + hSceneDoc = "000000000000f" + + # No Trash folder + assert projTree.emptyTrash() is False + + # Move some documents to Trash + assert projTree.moveItemToTrash(hTitlePage) is True + assert projTree.moveItemToTrash(hChapterDir) is True + + assert theProject.tree.isTrash(hTitlePage) is True + assert theProject.tree.isTrash(hChapterDir) is True + assert theProject.tree.isTrash(hChapterDoc) is True + assert theProject.tree.isTrash(hSceneDoc) is True + + # User cancels + with monkeypatch.context() as mp: + mp.setattr(QMessageBox, "question", lambda *a: QMessageBox.No) + assert projTree.emptyTrash() is False + assert hTitlePage in theProject.tree + assert hChapterDir in theProject.tree + assert hChapterDoc in theProject.tree + assert hSceneDoc in theProject.tree + + # Run again to empty all items + assert projTree.emptyTrash() is True + assert hTitlePage not in theProject.tree + assert hChapterDir not in theProject.tree + assert hChapterDoc not in theProject.tree + assert hSceneDoc not in theProject.tree + + # Running Emtpy Trash again is cancelled due to empty folder + assert projTree.emptyTrash() is False + + nwGUI.closeProject() + +# END Test testGuiProjTree_EmptyTrash @pytest.mark.gui From d9a59bccdad92f06442deb68151108ff419c5618 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 21:30:21 +0200 Subject: [PATCH 06/12] Don't allow merging root folders --- novelwriter/gui/projtree.py | 94 +++++++++++++++++-------------------- 1 file changed, 42 insertions(+), 52 deletions(-) diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index b47e6bc4..93478c7a 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -1110,67 +1110,55 @@ class GuiProjectTree(QTreeWidget): # Transform Item # ============== - mTrans = ctxMenu.addMenu(self.tr("Transform")) + if not isRoot: + mTrans = ctxMenu.addMenu(self.tr("Transform")) - if isFile and tItem.documentAllowed(): - if tItem.isNoteLayout(): + trDoc = trConst(nwLabels.LAYOUT_NAME[nwItemLayout.DOCUMENT]) + trNote = trConst(nwLabels.LAYOUT_NAME[nwItemLayout.NOTE]) + + isDocFile = tItem.isDocumentLayout() and isFile + isNoteFile = tItem.isNoteLayout() and isFile + + if (isNoteFile or isFolder) and tItem.documentAllowed(): mTrans.addAction( - self.tr("Convert to {0}").format( - trConst(nwLabels.LAYOUT_NAME[nwItemLayout.DOCUMENT]) - ), + self.tr("Convert to {0}").format(trDoc), lambda: self._changeItemLayout(tHandle, nwItemLayout.DOCUMENT) ) - else: + + if isDocFile or isFolder: mTrans.addAction( - self.tr("Convert to {0}").format( - trConst(nwLabels.LAYOUT_NAME[nwItemLayout.NOTE]) - ), + self.tr("Convert to {0}").format(trNote), lambda: self._changeItemLayout(tHandle, nwItemLayout.NOTE) ) - elif isFolder: - if tItem.documentAllowed(): - mTrans.addAction( - self.tr("Convert to {0}").format( - trConst(nwLabels.LAYOUT_NAME[nwItemLayout.DOCUMENT]) - ), - lambda: self._covertFolderToFile(tHandle, nwItemLayout.DOCUMENT) - ) - mTrans.addAction( - self.tr("Convert to {0}").format( - trConst(nwLabels.LAYOUT_NAME[nwItemLayout.NOTE]) - ), - lambda: self._covertFolderToFile(tHandle, nwItemLayout.NOTE) - ) - if hasChild: + if hasChild: + if isFile: + mTrans.addAction( + self.tr("Merge Child Items into Self"), + lambda: self._mergeDocuments(tHandle, False) + ) + mTrans.addAction( + self.tr("Merge Child Items into New"), + lambda: self._mergeDocuments(tHandle, True) + ) + elif isFolder: + mTrans.addAction( + self.tr("Combine Documents in Folder"), + lambda: self._mergeDocuments(tHandle, True) + ) + if isFile: mTrans.addAction( - self.tr("Merge Child Items into Self"), - lambda: self._mergeDocuments(tHandle, False) - ) - mTrans.addAction( - self.tr("Merge Child Items into New"), - lambda: self._mergeDocuments(tHandle, True) - ) - else: - mTrans.addAction( - self.tr("Combine Documents in Folder"), - lambda: self._mergeDocuments(tHandle, True) + self.tr("Split Document by Header"), + lambda: self._splitDocument(tHandle) ) - if isFile: - mTrans.addAction( - self.tr("Split Document by Header"), - lambda: self._splitDocument(tHandle) - ) + # Expand/Collapse/Delete + # ====================== ctxMenu.addSeparator() - # Expand/Collapse - # =============== - if hasChild: - ctxMenu.addSeparator() ctxMenu.addAction( self.tr("Expand All"), lambda: self.setExpandedFromHandle(tHandle, True) @@ -1180,9 +1168,6 @@ class GuiProjectTree(QTreeWidget): lambda: self.setExpandedFromHandle(tHandle, False) ) - # Delete Item - # =========== - if tItem.itemClass == nwItemClass.TRASH or isRoot or (isFolder and not hasChild): ctxMenu.addAction( self.tr("Delete Permanently"), lambda: self.permanentlyDeleteItem(tHandle) @@ -1192,6 +1177,7 @@ class GuiProjectTree(QTreeWidget): self.tr("Move to Trash"), lambda: self.moveItemToTrash(tHandle) ) + # Show Context Menu ctxMenu.exec_(self.viewport().mapToGlobal(clickPos)) return True @@ -1403,7 +1389,11 @@ class GuiProjectTree(QTreeWidget): tItem = self.theProject.tree[tHandle] if tItem is None: - return + return False + + if tItem.isRootType(): + logger.error("Cannot merge root item") + return False if not newFile: itemList.remove(tHandle) @@ -1427,7 +1417,7 @@ class GuiProjectTree(QTreeWidget): docMerger.setTargetDoc(tHandle) mHandle = tHandle else: - return + return False for sHandle in mrgData.get("finalItems", []): docMerger.appendText(sHandle, True, mLabel) @@ -1436,7 +1426,7 @@ class GuiProjectTree(QTreeWidget): self.mainGui.makeAlert([ self.tr("Could not save document."), docMerger.getError() ], nwAlert.ERROR) - return + return False if newFile: self.mainGui.projView.revealNewTreeItem(mHandle, tHandle) @@ -1453,7 +1443,7 @@ class GuiProjectTree(QTreeWidget): self._alertTreeChange(mHandle, flush=True) self.projView.wordCountsChanged.emit() - return + return True def _splitDocument(self, tHandle): return From 02dc7f5fe0b7f0aac41988ab29a1fffc145b939f Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 21:40:50 +0200 Subject: [PATCH 07/12] Make a few more improvements to doc merge --- novelwriter/gui/projtree.py | 56 ++++++++++++++++++++++--------------- 1 file changed, 34 insertions(+), 22 deletions(-) diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index 93478c7a..ac257b93 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -1116,8 +1116,8 @@ class GuiProjectTree(QTreeWidget): trDoc = trConst(nwLabels.LAYOUT_NAME[nwItemLayout.DOCUMENT]) trNote = trConst(nwLabels.LAYOUT_NAME[nwItemLayout.NOTE]) - isDocFile = tItem.isDocumentLayout() and isFile - isNoteFile = tItem.isNoteLayout() and isFile + isDocFile = isFile and tItem.isDocumentLayout() + isNoteFile = isFile and tItem.isNoteLayout() if (isNoteFile or isFolder) and tItem.documentAllowed(): mTrans.addAction( @@ -1131,21 +1131,21 @@ class GuiProjectTree(QTreeWidget): lambda: self._changeItemLayout(tHandle, nwItemLayout.NOTE) ) - if hasChild: - if isFile: - mTrans.addAction( - self.tr("Merge Child Items into Self"), - lambda: self._mergeDocuments(tHandle, False) - ) - mTrans.addAction( - self.tr("Merge Child Items into New"), - lambda: self._mergeDocuments(tHandle, True) - ) - elif isFolder: - mTrans.addAction( - self.tr("Combine Documents in Folder"), - lambda: self._mergeDocuments(tHandle, True) - ) + if hasChild and isFile: + mTrans.addAction( + self.tr("Merge Child Items into Self"), + lambda: self._mergeDocuments(tHandle, False) + ) + mTrans.addAction( + self.tr("Merge Child Items into New"), + lambda: self._mergeDocuments(tHandle, True) + ) + + if hasChild and isFolder: + mTrans.addAction( + self.tr("Combine Documents in Folder"), + lambda: self._mergeDocuments(tHandle, True) + ) if isFile: mTrans.addAction( @@ -1401,12 +1401,20 @@ class GuiProjectTree(QTreeWidget): dlgMerge = GuiDocMerge(self.mainGui, tHandle, itemList) dlgMerge.exec_() - if dlgMerge.result() == QDialog.Accepted: - # Save the open document first, in case it's part of this + if dlgMerge.result() != QDialog.Accepted: + + mrgData = dlgMerge.getData() + mrgList = mrgData.get("finalItems", []) + if not mrgList: + self.mainGui.makeAlert([ + self.tr("No documents selected for merging.") + ], nwAlert.INFO) + return False + + # Save the open document first, in case it's part of merge self.mainGui.saveDocument() - # Set up the merge job - mrgData = dlgMerge.getData() + # Create merge object, and append docs docMerger = DocMerger(self.theProject) mLabel = self.tr("Merged") @@ -1419,7 +1427,7 @@ class GuiProjectTree(QTreeWidget): else: return False - for sHandle in mrgData.get("finalItems", []): + for sHandle in mrgList: docMerger.appendText(sHandle, True, mLabel) if not docMerger.writeTargetDoc(): @@ -1443,6 +1451,10 @@ class GuiProjectTree(QTreeWidget): self._alertTreeChange(mHandle, flush=True) self.projView.wordCountsChanged.emit() + else: + logger.info("Action cancelled by user") + return False + return True def _splitDocument(self, tHandle): From 428dce3e6ed2649938be1b8bc48674a350f827a9 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 9 Oct 2022 22:47:36 +0200 Subject: [PATCH 08/12] Fix doc merge dialog test --- tests/test_dialogs/test_dlg_docmerge.py | 168 ++++++------------------ 1 file changed, 43 insertions(+), 125 deletions(-) diff --git a/tests/test_dialogs/test_dlg_docmerge.py b/tests/test_dialogs/test_dlg_docmerge.py index 4e3138f6..3291e23f 100644 --- a/tests/test_dialogs/test_dlg_docmerge.py +++ b/tests/test_dialogs/test_dlg_docmerge.py @@ -19,17 +19,14 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . """ -import os import pytest -from mock import causeOSError -from tools import getGuiItem, readFile, writeFile, buildTestProject +from tools import buildTestProject -from PyQt5.QtWidgets import QAction, QMessageBox +from PyQt5.QtCore import Qt +from PyQt5.QtWidgets import QMessageBox -from novelwriter.enum import nwItemType, nwWidget -from novelwriter.dialogs import GuiDocMerge, GuiEditLabel -from novelwriter.core.tree import NWTree +from novelwriter.dialogs import GuiDocMerge @pytest.mark.gui @@ -39,142 +36,63 @@ def testDlgMerge_Main(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): # Block message box monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes) monkeypatch.setattr(QMessageBox, "critical", lambda *a: QMessageBox.Ok) - monkeypatch.setattr(GuiEditLabel, "getLabel", lambda *a, text: (text, True)) # Create a new project buildTestProject(nwGUI, fncProj) - # Handles for new objects - hNovelRoot = "0000000000008" + hInvalid = "0000000000000" hChapterDir = "000000000000d" - hChapterOne = "000000000000e" - hSceneOne = "000000000000f" - hSceneTwo = "0000000000010" - hSceneThree = "0000000000011" - hSceneFour = "0000000000012" - hMergedDoc = "0000000000023" + hChapterDoc = "000000000000e" + hSceneDoc = "000000000000f" - # Add Project Content - nwGUI.switchFocus(nwWidget.TREE) - nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem(hChapterDir).setSelected(True) - nwGUI.projView.projTree.newTreeItem(nwItemType.FILE) - nwGUI.projView.projTree.newTreeItem(nwItemType.FILE) - nwGUI.projView.projTree.newTreeItem(nwItemType.FILE) - - assert nwGUI.saveProject() is True - assert nwGUI.closeProject() is True - - tChapterOne = "## Chapter One\n\n% Chapter one comment\n" - tSceneOne = "### Scene One\n\nThere once was a man from Nantucket" - tSceneTwo = "### Scene Two\n\nWho kept all his cash in a bucket." - tSceneThree = "### Scene Three\n\n\tBut his daughter, named Nan, \n\tRan away with a man" - tSceneFour = "### Scene Four\n\nAnd as for the bucket, Nantucket." - - contentDir = os.path.join(fncProj, "content") - writeFile(os.path.join(contentDir, hChapterOne+".nwd"), tChapterOne) - writeFile(os.path.join(contentDir, hSceneOne+".nwd"), tSceneOne) - writeFile(os.path.join(contentDir, hSceneTwo+".nwd"), tSceneTwo) - writeFile(os.path.join(contentDir, hSceneThree+".nwd"), tSceneThree) - writeFile(os.path.join(contentDir, hSceneFour+".nwd"), tSceneFour) - - assert nwGUI.openProject(fncProj) is True - - # Open the Merge tool - nwGUI.switchFocus(nwWidget.TREE) - nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem(hChapterDir).setSelected(True) - - monkeypatch.setattr(GuiDocMerge, "exec_", lambda *a: None) - nwGUI.mainMenu.aMergeDocs.activate(QAction.Trigger) - qtbot.waitUntil(lambda: getGuiItem("GuiDocMerge") is not None, timeout=1000) - - nwMerge = getGuiItem("GuiDocMerge") - assert isinstance(nwMerge, GuiDocMerge) + # Check that the dialog kan handle invalid items + nwMerge = GuiDocMerge(nwGUI, hInvalid, [hInvalid]) + qtbot.addWidget(nwMerge) nwMerge.show() - qtbot.wait(50) - - # Populate List - # ============= - - nwMerge.listBox.clear() assert nwMerge.listBox.count() == 0 + nwMerge.reject() - # No item selected - nwGUI.projView.projTree.clearSelection() - assert nwMerge._populateList() is False - assert nwMerge.listBox.count() == 0 + # Load items from chapter dir + nwMerge = GuiDocMerge(nwGUI, hChapterDir, [hChapterDir, hChapterDoc, hSceneDoc]) + qtbot.addWidget(nwMerge) + nwMerge.show() - # Non-existing item - with monkeypatch.context() as mp: - mp.setattr(NWTree, "__getitem__", lambda *a: None) - nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem(hChapterDir).setSelected(True) - assert nwMerge._populateList() is False - assert nwMerge.listBox.count() == 0 + assert nwMerge.listBox.count() == 2 - # Select a non-folder - nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem(hChapterOne).setSelected(True) - assert nwMerge._populateList() is False - assert nwMerge.listBox.count() == 0 + itemOne = nwMerge.listBox.item(0) + itemTwo = nwMerge.listBox.item(1) - # Select the chapter folder - nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem(hChapterDir).setSelected(True) - assert nwMerge._populateList() is True - assert nwMerge.listBox.count() == 5 + assert itemOne.data(Qt.UserRole) == hChapterDoc + assert itemTwo.data(Qt.UserRole) == hSceneDoc - # Merge Documents - # =============== + assert itemOne.checkState() == Qt.Checked + assert itemTwo.checkState() == Qt.Checked - # First, a successful merge - with monkeypatch.context() as mp: - mp.setattr(GuiDocMerge, "_doClose", lambda *a: None) - assert nwMerge._doMerge() is True - assert nwGUI.saveProject() is True - mergedFile = os.path.join(contentDir, hMergedDoc+".nwd") - assert os.path.isfile(mergedFile) - assert readFile(mergedFile) == ( - "%%%%~name: New Chapter\n" - "%%%%~path: %s/%s\n" - "%%%%~kind: NOVEL/DOCUMENT\n" - "%s\n\n" - "%s\n\n" - "%s\n\n" - "%s\n\n" - "%s\n\n" - ) % ( - hNovelRoot, - hMergedDoc, - tChapterOne.strip(), - tSceneOne.strip(), - tSceneTwo.strip(), - tSceneThree.strip(), - tSceneFour.strip(), - ) + data = nwMerge.getData() + assert data["sHandle"] == hChapterDir + assert data["origItems"] == [hChapterDir, hChapterDoc, hSceneDoc] + assert data["moveToTrash"] is False + assert data["finalItems"] == [hChapterDoc, hSceneDoc] - # OS error - with monkeypatch.context() as mp: - mp.setattr("builtins.open", causeOSError) - assert nwMerge._doMerge() is False + # Uncheck second item and toggle trash switch + itemTwo.setCheckState(Qt.Unchecked) + nwMerge.trashSwitch.setChecked(True) - # Can't find the source item - with monkeypatch.context() as mp: - mp.setattr(NWTree, "__getitem__", lambda *a: None) - assert nwMerge._doMerge() is False + data = nwMerge.getData() + assert data["sHandle"] == hChapterDir + assert data["origItems"] == [hChapterDir, hChapterDoc, hSceneDoc] + assert data["moveToTrash"] is True + assert data["finalItems"] == [hChapterDoc] - # No source handle set - nwMerge.sourceItem = None - assert nwMerge._doMerge() is False + # Restore default values + nwMerge._resetList() - # No documents to merge - nwMerge.listBox.clear() - assert nwMerge._doMerge() is False + data = nwMerge.getData() + assert data["sHandle"] == hChapterDir + assert data["origItems"] == [hChapterDir, hChapterDoc, hSceneDoc] + assert data["moveToTrash"] is True + assert data["finalItems"] == [hChapterDoc, hSceneDoc] - # Close up - nwMerge._doClose() - - # qtbot.stopForInteraction() + # qtbot.stop() # END Test testDlgMerge_Main From 747a1a212c00413e919a602f7bacb10827f38684 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Mon, 10 Oct 2022 15:48:45 +0200 Subject: [PATCH 09/12] Make some minor improvements to code and tests --- novelwriter/dialogs/docmerge.py | 4 +- novelwriter/gui/outline.py | 2 +- novelwriter/gui/projtree.py | 2 +- tests/test_dialogs/test_dlg_docmerge.py | 33 ++-- tests/test_gui/test_gui_guimain.py | 38 ++--- tests/test_gui/test_gui_mainmenu.py | 8 +- tests/test_gui/test_gui_noveltree.py | 18 +-- tests/test_gui/test_gui_projtree.py | 206 +++++++++++------------- tests/test_gui/test_gui_statusbar.py | 4 +- tests/test_tools/test_tools_lipsum.py | 4 +- tests/tools.py | 16 ++ 11 files changed, 162 insertions(+), 173 deletions(-) diff --git a/novelwriter/dialogs/docmerge.py b/novelwriter/dialogs/docmerge.py index 89149ab8..7113fc0f 100644 --- a/novelwriter/dialogs/docmerge.py +++ b/novelwriter/dialogs/docmerge.py @@ -29,8 +29,8 @@ import novelwriter from PyQt5.QtCore import Qt, QSize from PyQt5.QtWidgets import ( - QDialog, QVBoxLayout, QLabel, QListWidget, QAbstractItemView, - QListWidgetItem, QDialogButtonBox, QGridLayout + QAbstractItemView, QDialog, QDialogButtonBox, QGridLayout, QLabel, + QListWidget, QListWidgetItem, QVBoxLayout, ) from novelwriter.gui.custom import QHelpLabel, QSwitch diff --git a/novelwriter/gui/outline.py b/novelwriter/gui/outline.py index e8514c15..b5e67b2e 100644 --- a/novelwriter/gui/outline.py +++ b/novelwriter/gui/outline.py @@ -1048,7 +1048,7 @@ class GuiOutlineDetails(QScrollArea): self.titleLabel.setText("%s" % self.tr("Title")) self.titleValue.setText(novIdx.title) - itemStatus, _ = nwItem.getImportStatus() + itemStatus, _ = nwItem.getImportStatus(incIcon=False) self.fileValue.setText(nwItem.itemName) self.itemValue.setText(itemStatus) diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index ac257b93..15a2417c 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -34,7 +34,7 @@ from time import time from PyQt5.QtGui import QPalette from PyQt5.QtCore import Qt, QSize, pyqtSignal, pyqtSlot from PyQt5.QtWidgets import ( - QAbstractItemView, QFrame, QHBoxLayout, QHeaderView, QLabel, QDialog, + QAbstractItemView, QDialog, QFrame, QHBoxLayout, QHeaderView, QLabel, QMenu, QShortcut, QSizePolicy, QToolButton, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget ) diff --git a/tests/test_dialogs/test_dlg_docmerge.py b/tests/test_dialogs/test_dlg_docmerge.py index 3291e23f..70acf961 100644 --- a/tests/test_dialogs/test_dlg_docmerge.py +++ b/tests/test_dialogs/test_dlg_docmerge.py @@ -21,7 +21,7 @@ along with this program. If not, see . import pytest -from tools import buildTestProject +from tools import buildTestProject, C from PyQt5.QtCore import Qt from PyQt5.QtWidgets import QMessageBox @@ -40,20 +40,15 @@ def testDlgMerge_Main(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): # Create a new project buildTestProject(nwGUI, fncProj) - hInvalid = "0000000000000" - hChapterDir = "000000000000d" - hChapterDoc = "000000000000e" - hSceneDoc = "000000000000f" - # Check that the dialog kan handle invalid items - nwMerge = GuiDocMerge(nwGUI, hInvalid, [hInvalid]) + nwMerge = GuiDocMerge(nwGUI, C.hInvalid, [C.hInvalid]) qtbot.addWidget(nwMerge) nwMerge.show() assert nwMerge.listBox.count() == 0 nwMerge.reject() # Load items from chapter dir - nwMerge = GuiDocMerge(nwGUI, hChapterDir, [hChapterDir, hChapterDoc, hSceneDoc]) + nwMerge = GuiDocMerge(nwGUI, C.hChapterDir, [C.hChapterDir, C.hChapterDoc, C.hSceneDoc]) qtbot.addWidget(nwMerge) nwMerge.show() @@ -62,36 +57,36 @@ def testDlgMerge_Main(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): itemOne = nwMerge.listBox.item(0) itemTwo = nwMerge.listBox.item(1) - assert itemOne.data(Qt.UserRole) == hChapterDoc - assert itemTwo.data(Qt.UserRole) == hSceneDoc + assert itemOne.data(Qt.UserRole) == C.hChapterDoc + assert itemTwo.data(Qt.UserRole) == C.hSceneDoc assert itemOne.checkState() == Qt.Checked assert itemTwo.checkState() == Qt.Checked data = nwMerge.getData() - assert data["sHandle"] == hChapterDir - assert data["origItems"] == [hChapterDir, hChapterDoc, hSceneDoc] + assert data["sHandle"] == C.hChapterDir + assert data["origItems"] == [C.hChapterDir, C.hChapterDoc, C.hSceneDoc] assert data["moveToTrash"] is False - assert data["finalItems"] == [hChapterDoc, hSceneDoc] + assert data["finalItems"] == [C.hChapterDoc, C.hSceneDoc] # Uncheck second item and toggle trash switch itemTwo.setCheckState(Qt.Unchecked) nwMerge.trashSwitch.setChecked(True) data = nwMerge.getData() - assert data["sHandle"] == hChapterDir - assert data["origItems"] == [hChapterDir, hChapterDoc, hSceneDoc] + assert data["sHandle"] == C.hChapterDir + assert data["origItems"] == [C.hChapterDir, C.hChapterDoc, C.hSceneDoc] assert data["moveToTrash"] is True - assert data["finalItems"] == [hChapterDoc] + assert data["finalItems"] == [C.hChapterDoc] # Restore default values nwMerge._resetList() data = nwMerge.getData() - assert data["sHandle"] == hChapterDir - assert data["origItems"] == [hChapterDir, hChapterDoc, hSceneDoc] + assert data["sHandle"] == C.hChapterDir + assert data["origItems"] == [C.hChapterDir, C.hChapterDoc, C.hSceneDoc] assert data["moveToTrash"] is True - assert data["finalItems"] == [hChapterDoc, hSceneDoc] + assert data["finalItems"] == [C.hChapterDoc, C.hSceneDoc] # qtbot.stop() diff --git a/tests/test_gui/test_gui_guimain.py b/tests/test_gui/test_gui_guimain.py index 5c75c406..76651260 100644 --- a/tests/test_gui/test_gui_guimain.py +++ b/tests/test_gui/test_gui_guimain.py @@ -23,7 +23,7 @@ import os import pytest from shutil import copyfile -from tools import cmpFiles, buildTestProject, XML_IGNORE, writeFile +from tools import C, cmpFiles, buildTestProject, XML_IGNORE, writeFile from PyQt5.QtCore import Qt from PyQt5.QtWidgets import QMessageBox, QInputDialog @@ -216,14 +216,14 @@ def testGuiMain_Editing(qtbot, monkeypatch, nwGUI, fncProj, refDir, outDir, mock assert nwGUI.theProject.spellCheck is False # Check that tree items have been created - assert nwGUI.projView.projTree._getTreeItem("0000000000008") is not None - assert nwGUI.projView.projTree._getTreeItem("0000000000009") is not None - assert nwGUI.projView.projTree._getTreeItem("000000000000a") is not None - assert nwGUI.projView.projTree._getTreeItem("000000000000b") is not None - assert nwGUI.projView.projTree._getTreeItem("000000000000c") is not None - assert nwGUI.projView.projTree._getTreeItem("000000000000d") is not None - assert nwGUI.projView.projTree._getTreeItem("000000000000e") is not None - assert nwGUI.projView.projTree._getTreeItem("000000000000f") is not None + assert nwGUI.projView.projTree._getTreeItem(C.hNovelRoot) is not None + assert nwGUI.projView.projTree._getTreeItem(C.hPlotRoot) is not None + assert nwGUI.projView.projTree._getTreeItem(C.hCharRoot) is not None + assert nwGUI.projView.projTree._getTreeItem(C.hWorldRoot) is not None + assert nwGUI.projView.projTree._getTreeItem(C.hTitlePage) is not None + assert nwGUI.projView.projTree._getTreeItem(C.hChapterDir) is not None + assert nwGUI.projView.projTree._getTreeItem(C.hChapterDoc) is not None + assert nwGUI.projView.projTree._getTreeItem(C.hSceneDoc) is not None nwGUI.mainMenu.aSpellCheck.setChecked(True) assert nwGUI.mainMenu._toggleSpellCheck() @@ -237,7 +237,7 @@ def testGuiMain_Editing(qtbot, monkeypatch, nwGUI, fncProj, refDir, outDir, mock # Add a Character File nwGUI.switchFocus(nwWidget.TREE) nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem("000000000000a").setSelected(True) + nwGUI.projView.projTree._getTreeItem(C.hCharRoot).setSelected(True) nwGUI.projView.projTree.newTreeItem(nwItemType.FILE, None, isNote=True) assert nwGUI.openSelectedItem() @@ -259,7 +259,7 @@ def testGuiMain_Editing(qtbot, monkeypatch, nwGUI, fncProj, refDir, outDir, mock # Add a Plot File nwGUI.switchFocus(nwWidget.TREE) nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem("0000000000009").setSelected(True) + nwGUI.projView.projTree._getTreeItem(C.hPlotRoot).setSelected(True) nwGUI.projView.projTree.newTreeItem(nwItemType.FILE, None, isNote=True) assert nwGUI.openSelectedItem() @@ -281,7 +281,7 @@ def testGuiMain_Editing(qtbot, monkeypatch, nwGUI, fncProj, refDir, outDir, mock # Add a World File nwGUI.switchFocus(nwWidget.TREE) nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem("000000000000b").setSelected(True) + nwGUI.projView.projTree._getTreeItem(C.hWorldRoot).setSelected(True) nwGUI.projView.projTree.newTreeItem(nwItemType.FILE, None, isNote=True) assert nwGUI.openSelectedItem() @@ -312,9 +312,9 @@ def testGuiMain_Editing(qtbot, monkeypatch, nwGUI, fncProj, refDir, outDir, mock # Select the 'New Scene' file nwGUI.switchFocus(nwWidget.TREE) nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem("0000000000008").setExpanded(True) - nwGUI.projView.projTree._getTreeItem("000000000000d").setExpanded(True) - nwGUI.projView.projTree._getTreeItem("000000000000f").setSelected(True) + nwGUI.projView.projTree._getTreeItem(C.hNovelRoot).setExpanded(True) + nwGUI.projView.projTree._getTreeItem(C.hChapterDir).setExpanded(True) + nwGUI.projView.projTree._getTreeItem(C.hSceneDoc).setSelected(True) assert nwGUI.openSelectedItem() # Type something into the document @@ -492,8 +492,8 @@ def testGuiMain_Editing(qtbot, monkeypatch, nwGUI, fncProj, refDir, outDir, mock # Open and view the edited document nwGUI.switchFocus(nwWidget.VIEWER) - assert nwGUI.openDocument("000000000000f") - assert nwGUI.viewDocument("000000000000f") + assert nwGUI.openDocument(C.hSceneDoc) + assert nwGUI.viewDocument(C.hSceneDoc) qtbot.wait(stepDelay) assert nwGUI.saveProject() assert nwGUI.closeDocViewer() @@ -561,8 +561,8 @@ def testGuiMain_FocusFullMode(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): assert nwGUI.toggleFocusMode() is False # Open a file in editor and viewer - assert nwGUI.openDocument("000000000000f") - assert nwGUI.viewDocument("000000000000f") + assert nwGUI.openDocument(C.hSceneDoc) + assert nwGUI.viewDocument(C.hSceneDoc) # Enable focus mode assert nwGUI.toggleFocusMode() is True diff --git a/tests/test_gui/test_gui_mainmenu.py b/tests/test_gui/test_gui_mainmenu.py index f579a1a0..0097b65b 100644 --- a/tests/test_gui/test_gui_mainmenu.py +++ b/tests/test_gui/test_gui_mainmenu.py @@ -26,7 +26,7 @@ from PyQt5.QtCore import Qt from PyQt5.QtGui import QTextCursor, QTextBlock from PyQt5.QtWidgets import QAction, QFileDialog, QMessageBox -from tools import writeFile, buildTestProject +from tools import C, writeFile, buildTestProject from novelwriter.gui.doceditor import GuiDocEditor from novelwriter.enum import nwDocAction, nwDocInsert @@ -467,8 +467,8 @@ def testGuiMenu_Insert(qtbot, monkeypatch, nwGUI, fncDir, fncProj, mockRnd): buildTestProject(nwGUI, fncProj) - assert nwGUI.projView.projTree._getTreeItem("000000000000f") is not None - assert nwGUI.openDocument("000000000000f") is True + assert nwGUI.projView.projTree._getTreeItem(C.hSceneDoc) is not None + assert nwGUI.openDocument(C.hSceneDoc) is True nwGUI.docEditor.clear() # Test Faulty Inserts @@ -677,7 +677,7 @@ def testGuiMenu_Insert(qtbot, monkeypatch, nwGUI, fncDir, fncProj, mockRnd): assert not nwGUI.importDocument() # Open the document from before, and add some text to it - nwGUI.openDocument("000000000000f") + nwGUI.openDocument(C.hSceneDoc) nwGUI.docEditor.setText("Bar") assert nwGUI.docEditor.getText() == "Bar" diff --git a/tests/test_gui/test_gui_noveltree.py b/tests/test_gui/test_gui_noveltree.py index f8f18875..fcbacdb2 100644 --- a/tests/test_gui/test_gui_noveltree.py +++ b/tests/test_gui/test_gui_noveltree.py @@ -22,7 +22,7 @@ along with this program. If not, see . import os import pytest -from tools import buildTestProject, writeFile +from tools import C, buildTestProject, writeFile from PyQt5.QtGui import QFocusEvent from PyQt5.QtCore import Qt, QEvent @@ -46,7 +46,7 @@ def testGuiNovelTree_TreeItems(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): nwGUI.switchFocus(nwWidget.TREE) nwGUI.projView.projTree.clearSelection() - nwGUI.projView.projTree._getTreeItem("000000000000a").setSelected(True) + nwGUI.projView.projTree._getTreeItem(C.hCharRoot).setSelected(True) nwGUI.projView.projTree.newTreeItem(nwItemType.FILE) writeFile( @@ -94,7 +94,7 @@ def testGuiNovelTree_TreeItems(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): assert not topItem.isSelected() topItem.setSelected(True) assert novelTree.selectedItems()[0] == topItem - assert novelView.getSelectedHandle() == ("000000000000c", 0) + assert novelView.getSelectedHandle() == (C.hTitlePage, 0) # Refresh using the slot for the butoom novelBar._refreshNovelTree() @@ -119,7 +119,7 @@ def testGuiNovelTree_TreeItems(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): assert scItem.isSelected() assert nwGUI.docEditor.docHandle() is None novelTree._treeDoubleClick(scItem, 0) - assert nwGUI.docEditor.docHandle() == "000000000000f" + assert nwGUI.docEditor.docHandle() == C.hSceneDoc # Open item with middle mouse button scItem.setSelected(True) @@ -136,7 +136,7 @@ def testGuiNovelTree_TreeItems(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): scItem.setData(novelTree.C_TITLE, novelTree.D_HANDLE, oldData) qtbot.mouseClick(vPort, Qt.MiddleButton, pos=scRect.center(), delay=10) - assert nwGUI.docViewer.docHandle() == "000000000000f" + assert nwGUI.docViewer.docHandle() == C.hSceneDoc # Last Column # =========== @@ -144,26 +144,26 @@ def testGuiNovelTree_TreeItems(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): novelBar.setLastColType(NovelTreeColumn.HIDDEN) assert novelTree.isColumnHidden(novelTree.C_EXTRA) is True assert novelTree.lastColType == NovelTreeColumn.HIDDEN - assert novelTree._getLastColumnText("000000000000f", "T000001") == ("", "") + assert novelTree._getLastColumnText(C.hSceneDoc, "T000001") == ("", "") novelBar.setLastColType(NovelTreeColumn.POV) assert novelTree.isColumnHidden(novelTree.C_EXTRA) is False assert novelTree.lastColType == NovelTreeColumn.POV - assert novelTree._getLastColumnText("000000000000f", "T000001") == ( + assert novelTree._getLastColumnText(C.hSceneDoc, "T000001") == ( "Jane", "Point of View: Jane" ) novelBar.setLastColType(NovelTreeColumn.FOCUS) assert novelTree.isColumnHidden(novelTree.C_EXTRA) is False assert novelTree.lastColType == NovelTreeColumn.FOCUS - assert novelTree._getLastColumnText("000000000000f", "T000001") == ( + assert novelTree._getLastColumnText(C.hSceneDoc, "T000001") == ( "Jane", "Focus: Jane" ) novelBar.setLastColType(NovelTreeColumn.PLOT) assert novelTree.isColumnHidden(novelTree.C_EXTRA) is False assert novelTree.lastColType == NovelTreeColumn.PLOT - assert novelTree._getLastColumnText("000000000000f", "T000001") == ( + assert novelTree._getLastColumnText(C.hSceneDoc, "T000001") == ( "", "Plot: " ) diff --git a/tests/test_gui/test_gui_projtree.py b/tests/test_gui/test_gui_projtree.py index e46418b9..f4bfa1c8 100644 --- a/tests/test_gui/test_gui_projtree.py +++ b/tests/test_gui/test_gui_projtree.py @@ -22,7 +22,7 @@ along with this program. If not, see . import os import pytest -from tools import buildTestProject +from tools import C, buildTestProject from PyQt5.QtWidgets import QMessageBox, QMenu @@ -78,24 +78,24 @@ def testGuiProjTree_NewItems(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd) assert "Did not find anywhere" in caplog.text # Create new folder as child of Novel folder - projView.setSelectedHandle("0000000000008") + projView.setSelectedHandle(C.hNovelRoot) assert projView.projTree.newTreeItem(nwItemType.FOLDER) is True - assert theProject.tree["0000000000011"].itemParent == "0000000000008" - assert theProject.tree["0000000000011"].itemRoot == "0000000000008" + assert theProject.tree["0000000000011"].itemParent == C.hNovelRoot + assert theProject.tree["0000000000011"].itemRoot == C.hNovelRoot assert theProject.tree["0000000000011"].itemClass == nwItemClass.NOVEL # Add a new file in the new folder projView.setSelectedHandle("0000000000011") assert projView.projTree.newTreeItem(nwItemType.FILE) is True assert theProject.tree["0000000000012"].itemParent == "0000000000011" - assert theProject.tree["0000000000012"].itemRoot == "0000000000008" + assert theProject.tree["0000000000012"].itemRoot == C.hNovelRoot assert theProject.tree["0000000000012"].itemClass == nwItemClass.NOVEL # Add a new chapter next to the other new file projView.setSelectedHandle("0000000000012") assert projView.projTree.newTreeItem(nwItemType.FILE, hLevel=2) is True assert theProject.tree["0000000000013"].itemParent == "0000000000011" - assert theProject.tree["0000000000013"].itemRoot == "0000000000008" + assert theProject.tree["0000000000013"].itemRoot == C.hNovelRoot assert theProject.tree["0000000000013"].itemClass == nwItemClass.NOVEL assert nwGUI.openDocument("0000000000013") assert nwGUI.docEditor.getText() == "## New Chapter\n\n" @@ -104,16 +104,16 @@ def testGuiProjTree_NewItems(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd) projView.setSelectedHandle("0000000000012") assert projView.projTree.newTreeItem(nwItemType.FILE, hLevel=3) is True assert theProject.tree["0000000000014"].itemParent == "0000000000011" - assert theProject.tree["0000000000014"].itemRoot == "0000000000008" + assert theProject.tree["0000000000014"].itemRoot == C.hNovelRoot assert theProject.tree["0000000000014"].itemClass == nwItemClass.NOVEL assert nwGUI.openDocument("0000000000014") assert nwGUI.docEditor.getText() == "### New Scene\n\n" # Add a new file to the characters folder - projView.setSelectedHandle("000000000000a") + projView.setSelectedHandle(C.hCharRoot) assert projView.projTree.newTreeItem(nwItemType.FILE, hLevel=1, isNote=True) is True - assert theProject.tree["0000000000015"].itemParent == "000000000000a" - assert theProject.tree["0000000000015"].itemRoot == "000000000000a" + assert theProject.tree["0000000000015"].itemParent == C.hCharRoot + assert theProject.tree["0000000000015"].itemRoot == C.hCharRoot assert theProject.tree["0000000000015"].itemClass == nwItemClass.CHARACTER assert nwGUI.openDocument("0000000000015") assert nwGUI.docEditor.getText() == "# New Note\n\n" @@ -145,8 +145,8 @@ def testGuiProjTree_NewItems(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRnd) # Rename plot folder with monkeypatch.context() as mp: mp.setattr(GuiEditLabel, "getLabel", lambda *a, **k: ("Stuff", True)) - projTree.renameTreeItem("0000000000009") is True - assert theProject.tree["0000000000009"].itemName == "Stuff" + projTree.renameTreeItem(C.hPlotRoot) is True + assert theProject.tree[C.hPlotRoot].itemName == "Stuff" # Rename invalid folder projTree.renameTreeItem("0000000000000") is False @@ -192,12 +192,12 @@ def testGuiProjTree_MoveItems(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): # ============== # Add some files - nwTree.setSelectedHandle("000000000000d") + nwTree.setSelectedHandle(C.hChapterDir) assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000011", "0000000000012", ] @@ -206,75 +206,75 @@ def testGuiProjTree_MoveItems(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): assert nwTree.projTree.moveTreeItem(1) is False # Move second item up twice (should give same result) - nwTree.setSelectedHandle("000000000000f") + nwTree.setSelectedHandle(C.hSceneDoc) assert nwTree.projTree.moveTreeItem(-1) is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000f", "000000000000e", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hSceneDoc, C.hChapterDoc, "0000000000010", "0000000000011", "0000000000012", ] assert nwTree.projTree.moveTreeItem(-1) is False - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000f", "000000000000e", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hSceneDoc, C.hChapterDoc, "0000000000010", "0000000000011", "0000000000012", ] # Restore assert nwTree.projTree.moveTreeItem(1) is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000011", "0000000000012", ] # Move fifth item down twice (should give same result) nwTree.setSelectedHandle("0000000000011") assert nwTree.projTree.moveTreeItem(1) is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000012", "0000000000011", ] assert nwTree.projTree.moveTreeItem(1) is False - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000012", "0000000000011", ] # Restore assert nwTree.projTree.moveTreeItem(-1) is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000011", "0000000000012", ] # Move down again, and restore via undo nwTree.setSelectedHandle("0000000000011") assert nwTree.projTree.moveTreeItem(1) is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000012", "0000000000011", ] assert nwTree.projTree.undoLastMove() is True - assert nwTree.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwTree.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000011", "0000000000012", ] # Root Folder # =========== - nwTree.setSelectedHandle("0000000000008") - assert nwGUI.theProject.tree._treeOrder.index("0000000000008") == 0 + nwTree.setSelectedHandle(C.hNovelRoot) + assert nwGUI.theProject.tree._treeOrder.index(C.hNovelRoot) == 0 # Move novel folder up assert nwTree.projTree.moveTreeItem(-1) is False - assert nwGUI.theProject.tree._treeOrder.index("0000000000008") == 0 + assert nwGUI.theProject.tree._treeOrder.index(C.hNovelRoot) == 0 # Move novel folder down assert nwTree.projTree.moveTreeItem(1) is True - assert nwGUI.theProject.tree._treeOrder.index("0000000000008") == 1 + assert nwGUI.theProject.tree._treeOrder.index(C.hNovelRoot) == 1 # Move novel folder up again assert nwTree.projTree.moveTreeItem(-1) is True - assert nwGUI.theProject.tree._treeOrder.index("0000000000008") == 0 + assert nwGUI.theProject.tree._treeOrder.index(C.hNovelRoot) == 0 # Clean up # qtbot.stopForInteraction() @@ -307,12 +307,12 @@ def testGuiProjTree_RequestDeleteItem(qtbot, caplog, monkeypatch, nwGUI, fncDir, assert nwView.emptyTrash() is False # Add some files - nwView.setSelectedHandle("000000000000d") + nwView.setSelectedHandle(C.hChapterDir) assert nwView.projTree.newTreeItem(nwItemType.FILE) is True assert nwView.projTree.newTreeItem(nwItemType.FILE) is True assert nwView.projTree.newTreeItem(nwItemType.FILE) is True - assert nwView.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwView.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010", "0000000000011", "0000000000012", ] @@ -337,8 +337,8 @@ def testGuiProjTree_RequestDeleteItem(qtbot, caplog, monkeypatch, nwGUI, fncDir, # Delete Root Folders # =================== - assert nwView.requestDeleteItem("0000000000008") is False # Novel Root is blocked - assert nwView.requestDeleteItem("000000000000a") is True # Character Root + assert nwView.requestDeleteItem(C.hNovelRoot) is False # Novel Root is blocked + assert nwView.requestDeleteItem(C.hCharRoot) is True # Character Root # Delete File # =========== @@ -352,8 +352,8 @@ def testGuiProjTree_RequestDeleteItem(qtbot, caplog, monkeypatch, nwGUI, fncDir, # Delete last two documents, which also adds the trash folder assert nwView.requestDeleteItem("0000000000012") is True assert nwView.requestDeleteItem("0000000000011") is True - assert nwView.getTreeFromHandle("000000000000d") == [ - "000000000000d", "000000000000e", "000000000000f", + assert nwView.getTreeFromHandle(C.hChapterDir) == [ + C.hChapterDir, C.hChapterDoc, C.hSceneDoc, "0000000000010" ] trashHandle = nwGUI.theProject.tree.trashRoot() @@ -389,18 +389,14 @@ def testGuiProjTree_MoveItemToTrash(qtbot, caplog, monkeypatch, nwGUI, fncDir, m prjDir = os.path.join(fncDir, "project") buildTestProject(nwGUI, prjDir) - hInvalid = "0000000000000" - hNovelRoot = "0000000000008" - hTitlePage = "000000000000c" - # Invalid item caplog.clear() - assert projTree.moveItemToTrash(hInvalid) is False + assert projTree.moveItemToTrash(C.hInvalid) is False assert "Could not find tree item for deletion" in caplog.text # Root folders cannot be moved to Trash caplog.clear() - assert projTree.moveItemToTrash(hNovelRoot) is False + assert projTree.moveItemToTrash(C.hNovelRoot) is False assert "Root folders cannot be moved to Trash" in caplog.text # Block adding trash folder @@ -408,8 +404,8 @@ def testGuiProjTree_MoveItemToTrash(qtbot, caplog, monkeypatch, nwGUI, fncDir, m projTree._addTrashRoot = lambda *a: None caplog.clear() - assert projTree.moveItemToTrash(hTitlePage) is False - assert theProject.tree.isTrash(hTitlePage) is False + assert projTree.moveItemToTrash(C.hTitlePage) is False + assert theProject.tree.isTrash(C.hTitlePage) is False assert "Could not delete item" in caplog.text projTree._addTrashRoot = funcPointer @@ -417,16 +413,16 @@ def testGuiProjTree_MoveItemToTrash(qtbot, caplog, monkeypatch, nwGUI, fncDir, m # User cancels action with monkeypatch.context() as mp: mp.setattr(QMessageBox, "question", lambda *a: QMessageBox.No) - assert projTree.moveItemToTrash(hTitlePage) is False - assert theProject.tree.isTrash(hTitlePage) is False + assert projTree.moveItemToTrash(C.hTitlePage) is False + assert theProject.tree.isTrash(C.hTitlePage) is False # Move a document to Trash - assert projTree.moveItemToTrash(hTitlePage) is True - assert theProject.tree.isTrash(hTitlePage) is True + assert projTree.moveItemToTrash(C.hTitlePage) is True + assert theProject.tree.isTrash(C.hTitlePage) is True # Cannot be moved again caplog.clear() - assert projTree.moveItemToTrash(hTitlePage) is False + assert projTree.moveItemToTrash(C.hTitlePage) is False assert "Item is already in the Trash folder" in caplog.text nwGUI.closeProject() @@ -452,48 +448,40 @@ def testGuiProjTree_PermanentlyDeleteItem(qtbot, caplog, monkeypatch, nwGUI, fnc prjDir = os.path.join(fncDir, "project") buildTestProject(nwGUI, prjDir) - hInvalid = "0000000000000" - hNovelRoot = "0000000000008" - hPlotRoot = "0000000000009" - hTitlePage = "000000000000c" - hChapterDir = "000000000000d" - hChapterDoc = "000000000000e" - hSceneDoc = "000000000000f" - # Invalid item caplog.clear() - assert projTree.permanentlyDeleteItem(hInvalid) is False + assert projTree.permanentlyDeleteItem(C.hInvalid) is False assert "Could not find tree item for deletion" in caplog.text # Not deleting root item in use caplog.clear() - assert projTree.permanentlyDeleteItem(hNovelRoot) is False + assert projTree.permanentlyDeleteItem(C.hNovelRoot) is False assert "Root folders can only be deleted when they are empty" in caplog.text - assert hNovelRoot in theProject.tree + assert C.hNovelRoot in theProject.tree # Deleting unused root item is allowed caplog.clear() - assert projTree.permanentlyDeleteItem(hPlotRoot) is True - assert hPlotRoot not in theProject.tree + assert projTree.permanentlyDeleteItem(C.hPlotRoot) is True + assert C.hPlotRoot not in theProject.tree # User cancels action with monkeypatch.context() as mp: mp.setattr(QMessageBox, "question", lambda *a: QMessageBox.No) - assert projTree.permanentlyDeleteItem(hTitlePage) is False - assert hTitlePage in theProject.tree + assert projTree.permanentlyDeleteItem(C.hTitlePage) is False + assert C.hTitlePage in theProject.tree # Deleting file is OK, and if it is open, it should close - assert nwGUI.openDocument(hTitlePage) is True - assert nwGUI.docEditor.docHandle() == hTitlePage - assert projTree.permanentlyDeleteItem(hTitlePage) is True - assert hTitlePage not in theProject.tree + assert nwGUI.openDocument(C.hTitlePage) is True + assert nwGUI.docEditor.docHandle() == C.hTitlePage + assert projTree.permanentlyDeleteItem(C.hTitlePage) is True + assert C.hTitlePage not in theProject.tree assert nwGUI.docEditor.docHandle() is None # Deleting folder + files recursiely is ok - assert projTree.permanentlyDeleteItem(hChapterDir) is True - assert hChapterDir not in theProject.tree - assert hChapterDoc not in theProject.tree - assert hSceneDoc not in theProject.tree + assert projTree.permanentlyDeleteItem(C.hChapterDir) is True + assert C.hChapterDir not in theProject.tree + assert C.hChapterDoc not in theProject.tree + assert C.hSceneDoc not in theProject.tree nwGUI.closeProject() @@ -523,38 +511,33 @@ def testGuiProjTree_EmptyTrash(qtbot, caplog, monkeypatch, nwGUI, fncDir, mockRn prjDir = os.path.join(fncDir, "project") buildTestProject(nwGUI, prjDir) - hTitlePage = "000000000000c" - hChapterDir = "000000000000d" - hChapterDoc = "000000000000e" - hSceneDoc = "000000000000f" - # No Trash folder assert projTree.emptyTrash() is False # Move some documents to Trash - assert projTree.moveItemToTrash(hTitlePage) is True - assert projTree.moveItemToTrash(hChapterDir) is True + assert projTree.moveItemToTrash(C.hTitlePage) is True + assert projTree.moveItemToTrash(C.hChapterDir) is True - assert theProject.tree.isTrash(hTitlePage) is True - assert theProject.tree.isTrash(hChapterDir) is True - assert theProject.tree.isTrash(hChapterDoc) is True - assert theProject.tree.isTrash(hSceneDoc) is True + assert theProject.tree.isTrash(C.hTitlePage) is True + assert theProject.tree.isTrash(C.hChapterDir) is True + assert theProject.tree.isTrash(C.hChapterDoc) is True + assert theProject.tree.isTrash(C.hSceneDoc) is True # User cancels with monkeypatch.context() as mp: mp.setattr(QMessageBox, "question", lambda *a: QMessageBox.No) assert projTree.emptyTrash() is False - assert hTitlePage in theProject.tree - assert hChapterDir in theProject.tree - assert hChapterDoc in theProject.tree - assert hSceneDoc in theProject.tree + assert C.hTitlePage in theProject.tree + assert C.hChapterDir in theProject.tree + assert C.hChapterDoc in theProject.tree + assert C.hSceneDoc in theProject.tree # Run again to empty all items assert projTree.emptyTrash() is True - assert hTitlePage not in theProject.tree - assert hChapterDir not in theProject.tree - assert hChapterDoc not in theProject.tree - assert hSceneDoc not in theProject.tree + assert C.hTitlePage not in theProject.tree + assert C.hChapterDir not in theProject.tree + assert C.hChapterDoc not in theProject.tree + assert C.hSceneDoc not in theProject.tree # Running Emtpy Trash again is cancelled due to empty folder assert projTree.emptyTrash() is False @@ -584,13 +567,8 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): buildTestProject(nwGUI, prjDir) # Handles for new objects - hNovelRoot = "0000000000008" - hTitlePage = "000000000000c" - hChapterDir = "000000000000d" - hChapterFile = "000000000000e" - hCharRoot = "000000000000a" - hCharNote = "0000000000011" - hNovelNote = "0000000000012" + hCharNote = "0000000000011" + hNovelNote = "0000000000012" projTree = nwGUI.projView.projTree projTree.setExpandedFromHandle(None, True) @@ -598,9 +576,9 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): projTree._addTrashRoot() hTrashRoot = projTree.theProject.tree.trashRoot() - projTree.setSelectedHandle(hCharRoot) + projTree.setSelectedHandle(C.hCharRoot) projTree.newTreeItem(nwItemType.FILE) - projTree.setSelectedHandle(hNovelRoot) + projTree.setSelectedHandle(C.hNovelRoot) projTree.newTreeItem(nwItemType.FILE, isNote=True) def itemPos(tHandle): @@ -611,16 +589,16 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): # Generate the possible menu combinarions assert projTree._openContextMenu(itemPos(hTrashRoot)) is True - assert projTree._openContextMenu(itemPos(hNovelRoot)) is True + assert projTree._openContextMenu(itemPos(C.hNovelRoot)) is True assert projTree._openContextMenu(itemPos(hNovelNote)) is True - assert projTree._openContextMenu(itemPos(hTitlePage)) is True - assert projTree._openContextMenu(itemPos(hChapterDir)) is True - assert projTree._openContextMenu(itemPos(hChapterFile)) is True - assert projTree._openContextMenu(itemPos(hCharRoot)) is True + assert projTree._openContextMenu(itemPos(C.hTitlePage)) is True + assert projTree._openContextMenu(itemPos(C.hChapterDir)) is True + assert projTree._openContextMenu(itemPos(C.hChapterDoc)) is True + assert projTree._openContextMenu(itemPos(C.hCharRoot)) is True assert projTree._openContextMenu(itemPos(hCharNote)) is True # Check the keyboard shortcut handler as well - projTree.setSelectedHandle(hNovelRoot) + projTree.setSelectedHandle(C.hNovelRoot) assert projTree.openContextOnSelected() is True projTree.clearSelection() assert projTree.openContextOnSelected() is False diff --git a/tests/test_gui/test_gui_statusbar.py b/tests/test_gui/test_gui_statusbar.py index 0c6b1e81..18f969f6 100644 --- a/tests/test_gui/test_gui_statusbar.py +++ b/tests/test_gui/test_gui_statusbar.py @@ -22,7 +22,7 @@ along with this program. If not, see . import time import pytest -from tools import buildTestProject +from tools import C, buildTestProject from PyQt5.QtWidgets import QMessageBox @@ -37,7 +37,7 @@ def testGuiStatusBar_Main(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes) buildTestProject(nwGUI, fncProj) - cHandle = nwGUI.theProject.newFile("A Note", "000000000000a") + cHandle = nwGUI.theProject.newFile("A Note", C.hCharRoot) newDoc = NWDoc(nwGUI.theProject, cHandle) newDoc.writeDocument("# A Note\n\n") nwGUI.projView.revealNewTreeItem(cHandle) diff --git a/tests/test_tools/test_tools_lipsum.py b/tests/test_tools/test_tools_lipsum.py index 629deb56..de70a428 100644 --- a/tests/test_tools/test_tools_lipsum.py +++ b/tests/test_tools/test_tools_lipsum.py @@ -21,7 +21,7 @@ along with this program. If not, see . import pytest -from tools import getGuiItem, buildTestProject +from tools import C, getGuiItem, buildTestProject from PyQt5.QtWidgets import QAction, QMessageBox @@ -41,7 +41,7 @@ def testToolLipsum_Main(qtbot, monkeypatch, nwGUI, fncProj, mockRnd): # Create a new project buildTestProject(nwGUI, fncProj) - assert nwGUI.openDocument("000000000000f") is True + assert nwGUI.openDocument(C.hSceneDoc) is True assert len(nwGUI.docEditor.getText()) == 15 # Open the tool diff --git a/tests/tools.py b/tests/tools.py index fcdd3817..5c126707 100644 --- a/tests/tools.py +++ b/tests/tools.py @@ -28,6 +28,22 @@ from PyQt5.QtWidgets import qApp XML_IGNORE = (" Date: Mon, 10 Oct 2022 16:35:13 +0200 Subject: [PATCH 10/12] Add test coverage of doc tools --- novelwriter/core/doctools.py | 2 +- novelwriter/core/project.py | 4 +- tests/conftest.py | 18 ++- .../coreDocTools_DocMerger_0000000000010.nwd | 33 +++++ .../coreDocTools_DocMerger_0000000000014.nwd | 35 +++++ tests/test_core/test_core_doctools.py | 120 ++++++++++++++++++ tests/test_core/test_core_project.py | 2 +- 7 files changed, 204 insertions(+), 10 deletions(-) create mode 100644 tests/reference/coreDocTools_DocMerger_0000000000010.nwd create mode 100644 tests/reference/coreDocTools_DocMerger_0000000000014.nwd create mode 100644 tests/test_core/test_core_doctools.py diff --git a/novelwriter/core/doctools.py b/novelwriter/core/doctools.py index 75a4c3b7..f6716590 100644 --- a/novelwriter/core/doctools.py +++ b/novelwriter/core/doctools.py @@ -110,7 +110,7 @@ class DocMerger: if docText: self._targetText.insert(0, docText) - status = outDoc.writeDocument("\n\n".join(self._targetText)) + status = outDoc.writeDocument("\n\n".join(self._targetText) + "\n\n") if not status: self._error = outDoc.getError() diff --git a/novelwriter/core/project.py b/novelwriter/core/project.py index a6f88a7e..475300fd 100644 --- a/novelwriter/core/project.py +++ b/novelwriter/core/project.py @@ -176,7 +176,7 @@ class NWProject(): self._projTree.updateItemData(newItem.itemHandle) return newItem.itemHandle - def writeNewFile(self, tHandle, hLevel, isDocument): + def writeNewFile(self, tHandle, hLevel, isDocument, addText=""): """Write content to a new document after it is created. This will not run if the file exists and is not empty. """ @@ -191,7 +191,7 @@ class NWProject(): return False hshText = "#"*minmax(hLevel, 1, 4) - newText = f"{hshText} {tItem.itemName}\n\n" + newText = f"{hshText} {tItem.itemName}\n\n{addText}" if tItem.isNovelLike() and isDocument: tItem.setLayout(nwItemLayout.DOCUMENT) else: diff --git a/tests/conftest.py b/tests/conftest.py index 769f855c..40725923 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -190,14 +190,20 @@ def mockRnd(monkeypatch): from 0. This one will generate status/importance flags and handles in a predictable sequence. """ - def rnd(n): - for x in range(n): - yield x + class MockRnd: - gen = rnd(1000) - monkeypatch.setattr("random.getrandbits", lambda *a: next(gen)) + def __init__(self): + self.reset() - return + def _rnd(self, n): + for x in range(n): + yield x + + def reset(self): + gen = self._rnd(1000) + monkeypatch.setattr("random.getrandbits", lambda *a: next(gen)) + + return MockRnd() ## diff --git a/tests/reference/coreDocTools_DocMerger_0000000000010.nwd b/tests/reference/coreDocTools_DocMerger_0000000000010.nwd new file mode 100644 index 00000000..6dac570d --- /dev/null +++ b/tests/reference/coreDocTools_DocMerger_0000000000010.nwd @@ -0,0 +1,33 @@ +%%~name: Chapter 1 +%%~path: 0000000000008/0000000000010 +%%~kind: NOVEL/DOCUMENT +## Chapter 1 + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc maximus justo non dictum commodo. Curabitur lacinia tempor orci vel luctus. Phasellus porta metus eu massa luctus, eget euismod risus rhoncus. Vestibulum sed arcu nisi. Maecenas pretium facilisis velit, vel semper lacus aliquam sit amet. Vestibulum vulputate neque ligula, rhoncus blandit turpis consequat id. Mauris sagittis vehicula imperdiet. Duis sed nunc pretium, ornare purus vel, sodales augue. Maecenas a suscipit risus. Quisque volutpat justo eleifend est ullamcorper fermentum. Donec ullamcorper et tortor a laoreet. Nam id risus nisi. Vivamus non imperdiet erat, sit amet imperdiet felis. Mauris vitae neque et est aliquam scelerisque non non ipsum. + +Nullam laoreet lorem nec malesuada vehicula. Vivamus tempus sodales lectus sed viverra. Aenean lacinia sollicitudin quam, quis tempus eros suscipit id. Duis sed rutrum nisi, ut pulvinar magna. Nam et cursus tortor. Phasellus ac odio tellus. Nullam in iaculis ipsum. Vivamus ante sem, ultricies sed varius quis, tristique nec tellus. Nullam eu urna vitae lacus hendrerit gravida. Quisque pulvinar erat ex, id efficitur velit sodales vitae. Proin vestibulum, sapien eget mattis euismod, tortor quam viverra risus, at congue mauris tortor eu nunc. Mauris pellentesque elit leo, quis eleifend sem placerat a. Vivamus iaculis dui eget tellus volutpat, ac varius nisi facilisis. + +% Merge Novel Document: Scene 1.1 [New] + +### Scene 1.1 + +Nullam laoreet lorem nec malesuada vehicula. Vivamus tempus sodales lectus sed viverra. Aenean lacinia sollicitudin quam, quis tempus eros suscipit id. Duis sed rutrum nisi, ut pulvinar magna. Nam et cursus tortor. Phasellus ac odio tellus. Nullam in iaculis ipsum. Vivamus ante sem, ultricies sed varius quis, tristique nec tellus. Nullam eu urna vitae lacus hendrerit gravida. Quisque pulvinar erat ex, id efficitur velit sodales vitae. Proin vestibulum, sapien eget mattis euismod, tortor quam viverra risus, at congue mauris tortor eu nunc. Mauris pellentesque elit leo, quis eleifend sem placerat a. Vivamus iaculis dui eget tellus volutpat, ac varius nisi facilisis. + +Nullam a nisl magna. Praesent commodo nec diam aliquet vestibulum. In sapien velit, sodales feugiat porta ut, rhoncus a elit. Quisque egestas nisi eu eros laoreet, quis facilisis est pretium. Nullam bibendum sed tellus nec lobortis. Duis elit massa, volutpat a lacinia a, ullamcorper in dui. Suspendisse ac laoreet dui. Curabitur elementum, tortor elementum ultricies laoreet, nunc massa vulputate augue, vitae tincidunt nunc enim eget nisl. + +% Merge Novel Document: Scene 1.2 [New] + +### Scene 1.2 + +Nullam a nisl magna. Praesent commodo nec diam aliquet vestibulum. In sapien velit, sodales feugiat porta ut, rhoncus a elit. Quisque egestas nisi eu eros laoreet, quis facilisis est pretium. Nullam bibendum sed tellus nec lobortis. Duis elit massa, volutpat a lacinia a, ullamcorper in dui. Suspendisse ac laoreet dui. Curabitur elementum, tortor elementum ultricies laoreet, nunc massa vulputate augue, vitae tincidunt nunc enim eget nisl. + +Pellentesque nibh urna, volutpat et feugiat porta, rutrum sed lectus. Aliquam eget risus id orci tincidunt condimentum et sit amet purus. Curabitur tincidunt odio vel ante feugiat feugiat. Proin nunc lorem, molestie a sapien et, varius elementum nunc. Donec non fermentum nisl. In et massa placerat, faucibus felis eu, congue nisi. Proin sed tortor non lorem mattis cursus. Vestibulum magna neque, bibendum vel nibh et, tincidunt rhoncus nisi. Duis pulvinar mi a quam rutrum maximus. Nunc sollicitudin, urna in cursus facilisis, augue neque imperdiet metus, ac finibus lorem ante id nulla. Sed maximus eleifend justo id feugiat. Cras eget diam vel est blandit tempor nec a leo. Mauris risus est, fringilla in aliquam a, sagittis vel enim. Nullam sodales id erat placerat lobortis. + +% Merge Novel Document: Scene 1.3 [New] + +### Scene 1.3 + +Pellentesque nibh urna, volutpat et feugiat porta, rutrum sed lectus. Aliquam eget risus id orci tincidunt condimentum et sit amet purus. Curabitur tincidunt odio vel ante feugiat feugiat. Proin nunc lorem, molestie a sapien et, varius elementum nunc. Donec non fermentum nisl. In et massa placerat, faucibus felis eu, congue nisi. Proin sed tortor non lorem mattis cursus. Vestibulum magna neque, bibendum vel nibh et, tincidunt rhoncus nisi. Duis pulvinar mi a quam rutrum maximus. Nunc sollicitudin, urna in cursus facilisis, augue neque imperdiet metus, ac finibus lorem ante id nulla. Sed maximus eleifend justo id feugiat. Cras eget diam vel est blandit tempor nec a leo. Mauris risus est, fringilla in aliquam a, sagittis vel enim. Nullam sodales id erat placerat lobortis. + +Integer ac gravida quam. Quisque eleifend nisl nec pretium tincidunt. Quisque sollicitudin nisi in hendrerit scelerisque. Sed ornare nisl lacus, sit amet consectetur lectus egestas et. Vivamus nec arcu lorem. Donec rhoncus, purus a porta accumsan, nunc lectus iaculis libero, et fringilla tellus augue et velit. Integer varius felis scelerisque, vulputate tellus eu, laoreet justo. Suspendisse sit amet sem vehicula, auctor odio sed, aliquet enim. In ac tortor sed tortor fringilla elementum. Nulla non odio at magna vulputate scelerisque. Nam elementum diam eu rutrum scelerisque. Sed fermentum, felis quis vulputate fermentum, libero metus sollicitudin est, in faucibus purus nulla non dolor. Ut vitae felis porta, feugiat nunc et, bibendum neque. Nullam nec lorem nec metus ullamcorper malesuada ut a nisl. Etiam eget tristique dui. Nulla sed mi finibus, venenatis tellus non, maximus enim. + diff --git a/tests/reference/coreDocTools_DocMerger_0000000000014.nwd b/tests/reference/coreDocTools_DocMerger_0000000000014.nwd new file mode 100644 index 00000000..6a0d3548 --- /dev/null +++ b/tests/reference/coreDocTools_DocMerger_0000000000014.nwd @@ -0,0 +1,35 @@ +%%~name: All of Chapter 1 +%%~path: 0000000000008/0000000000014 +%%~kind: NOVEL/DOCUMENT +% Merge Novel Document: Chapter 1 [New] + +## Chapter 1 + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc maximus justo non dictum commodo. Curabitur lacinia tempor orci vel luctus. Phasellus porta metus eu massa luctus, eget euismod risus rhoncus. Vestibulum sed arcu nisi. Maecenas pretium facilisis velit, vel semper lacus aliquam sit amet. Vestibulum vulputate neque ligula, rhoncus blandit turpis consequat id. Mauris sagittis vehicula imperdiet. Duis sed nunc pretium, ornare purus vel, sodales augue. Maecenas a suscipit risus. Quisque volutpat justo eleifend est ullamcorper fermentum. Donec ullamcorper et tortor a laoreet. Nam id risus nisi. Vivamus non imperdiet erat, sit amet imperdiet felis. Mauris vitae neque et est aliquam scelerisque non non ipsum. + +Nullam laoreet lorem nec malesuada vehicula. Vivamus tempus sodales lectus sed viverra. Aenean lacinia sollicitudin quam, quis tempus eros suscipit id. Duis sed rutrum nisi, ut pulvinar magna. Nam et cursus tortor. Phasellus ac odio tellus. Nullam in iaculis ipsum. Vivamus ante sem, ultricies sed varius quis, tristique nec tellus. Nullam eu urna vitae lacus hendrerit gravida. Quisque pulvinar erat ex, id efficitur velit sodales vitae. Proin vestibulum, sapien eget mattis euismod, tortor quam viverra risus, at congue mauris tortor eu nunc. Mauris pellentesque elit leo, quis eleifend sem placerat a. Vivamus iaculis dui eget tellus volutpat, ac varius nisi facilisis. + +% Merge Novel Document: Scene 1.1 [New] + +### Scene 1.1 + +Nullam laoreet lorem nec malesuada vehicula. Vivamus tempus sodales lectus sed viverra. Aenean lacinia sollicitudin quam, quis tempus eros suscipit id. Duis sed rutrum nisi, ut pulvinar magna. Nam et cursus tortor. Phasellus ac odio tellus. Nullam in iaculis ipsum. Vivamus ante sem, ultricies sed varius quis, tristique nec tellus. Nullam eu urna vitae lacus hendrerit gravida. Quisque pulvinar erat ex, id efficitur velit sodales vitae. Proin vestibulum, sapien eget mattis euismod, tortor quam viverra risus, at congue mauris tortor eu nunc. Mauris pellentesque elit leo, quis eleifend sem placerat a. Vivamus iaculis dui eget tellus volutpat, ac varius nisi facilisis. + +Nullam a nisl magna. Praesent commodo nec diam aliquet vestibulum. In sapien velit, sodales feugiat porta ut, rhoncus a elit. Quisque egestas nisi eu eros laoreet, quis facilisis est pretium. Nullam bibendum sed tellus nec lobortis. Duis elit massa, volutpat a lacinia a, ullamcorper in dui. Suspendisse ac laoreet dui. Curabitur elementum, tortor elementum ultricies laoreet, nunc massa vulputate augue, vitae tincidunt nunc enim eget nisl. + +% Merge Novel Document: Scene 1.2 [New] + +### Scene 1.2 + +Nullam a nisl magna. Praesent commodo nec diam aliquet vestibulum. In sapien velit, sodales feugiat porta ut, rhoncus a elit. Quisque egestas nisi eu eros laoreet, quis facilisis est pretium. Nullam bibendum sed tellus nec lobortis. Duis elit massa, volutpat a lacinia a, ullamcorper in dui. Suspendisse ac laoreet dui. Curabitur elementum, tortor elementum ultricies laoreet, nunc massa vulputate augue, vitae tincidunt nunc enim eget nisl. + +Pellentesque nibh urna, volutpat et feugiat porta, rutrum sed lectus. Aliquam eget risus id orci tincidunt condimentum et sit amet purus. Curabitur tincidunt odio vel ante feugiat feugiat. Proin nunc lorem, molestie a sapien et, varius elementum nunc. Donec non fermentum nisl. In et massa placerat, faucibus felis eu, congue nisi. Proin sed tortor non lorem mattis cursus. Vestibulum magna neque, bibendum vel nibh et, tincidunt rhoncus nisi. Duis pulvinar mi a quam rutrum maximus. Nunc sollicitudin, urna in cursus facilisis, augue neque imperdiet metus, ac finibus lorem ante id nulla. Sed maximus eleifend justo id feugiat. Cras eget diam vel est blandit tempor nec a leo. Mauris risus est, fringilla in aliquam a, sagittis vel enim. Nullam sodales id erat placerat lobortis. + +% Merge Novel Document: Scene 1.3 [New] + +### Scene 1.3 + +Pellentesque nibh urna, volutpat et feugiat porta, rutrum sed lectus. Aliquam eget risus id orci tincidunt condimentum et sit amet purus. Curabitur tincidunt odio vel ante feugiat feugiat. Proin nunc lorem, molestie a sapien et, varius elementum nunc. Donec non fermentum nisl. In et massa placerat, faucibus felis eu, congue nisi. Proin sed tortor non lorem mattis cursus. Vestibulum magna neque, bibendum vel nibh et, tincidunt rhoncus nisi. Duis pulvinar mi a quam rutrum maximus. Nunc sollicitudin, urna in cursus facilisis, augue neque imperdiet metus, ac finibus lorem ante id nulla. Sed maximus eleifend justo id feugiat. Cras eget diam vel est blandit tempor nec a leo. Mauris risus est, fringilla in aliquam a, sagittis vel enim. Nullam sodales id erat placerat lobortis. + +Integer ac gravida quam. Quisque eleifend nisl nec pretium tincidunt. Quisque sollicitudin nisi in hendrerit scelerisque. Sed ornare nisl lacus, sit amet consectetur lectus egestas et. Vivamus nec arcu lorem. Donec rhoncus, purus a porta accumsan, nunc lectus iaculis libero, et fringilla tellus augue et velit. Integer varius felis scelerisque, vulputate tellus eu, laoreet justo. Suspendisse sit amet sem vehicula, auctor odio sed, aliquet enim. In ac tortor sed tortor fringilla elementum. Nulla non odio at magna vulputate scelerisque. Nam elementum diam eu rutrum scelerisque. Sed fermentum, felis quis vulputate fermentum, libero metus sollicitudin est, in faucibus purus nulla non dolor. Ut vitae felis porta, feugiat nunc et, bibendum neque. Nullam nec lorem nec metus ullamcorper malesuada ut a nisl. Etiam eget tristique dui. Nulla sed mi finibus, venenatis tellus non, maximus enim. + diff --git a/tests/test_core/test_core_doctools.py b/tests/test_core/test_core_doctools.py new file mode 100644 index 00000000..0d93fcb9 --- /dev/null +++ b/tests/test_core/test_core_doctools.py @@ -0,0 +1,120 @@ +""" +novelWriter – Project Document Tools Tester +=========================================== + +This file is a part of novelWriter +Copyright 2018–2022, Veronica Berglyd Olsen + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +""" + +import os +import pytest + +from shutil import copyfile + +from mock import causeOSError +from tools import C, buildTestProject, cmpFiles + +from novelwriter.core.project import NWProject +from novelwriter.core.doctools import DocMerger + + +@pytest.mark.core +def testCoreDocTools_DocMerger(monkeypatch, mockGUI, fncDir, outDir, refDir, mockRnd, ipsumText): + """Test the DocMerger utility. + """ + theProject = NWProject(mockGUI) + mockRnd.reset() + buildTestProject(theProject, fncDir) + + # Create File to Merge + # ==================== + + hChapter1 = theProject.newFile("Chapter 1", C.hNovelRoot) + hSceneOne11 = theProject.newFile("Scene 1.1", hChapter1) + hSceneOne12 = theProject.newFile("Scene 1.2", hChapter1) + hSceneOne13 = theProject.newFile("Scene 1.3", hChapter1) + + docText1 = "\n\n".join(ipsumText[0:2]) + "\n\n" + docText2 = "\n\n".join(ipsumText[1:3]) + "\n\n" + docText3 = "\n\n".join(ipsumText[2:4]) + "\n\n" + docText4 = "\n\n".join(ipsumText[3:5]) + "\n\n" + + theProject.writeNewFile(hChapter1, 2, True, docText1) + theProject.writeNewFile(hSceneOne11, 3, True, docText2) + theProject.writeNewFile(hSceneOne12, 3, True, docText3) + theProject.writeNewFile(hSceneOne13, 3, True, docText4) + + # Basic Checks + # ============ + + docMerger = DocMerger(theProject) + + # No writing without a target set + assert docMerger.writeTargetDoc() is False + + # Cannot append invalid handle + assert docMerger.appendText(C.hInvalid, True, "Merge") is False + + # Cannot create new target from invalid handle + assert docMerger.newTargetDoc(C.hInvalid, "Test") is None + + # Merge to New + # ============ + + saveFile = os.path.join(fncDir, "content", "0000000000014.nwd") + testFile = os.path.join(outDir, "coreDocTools_DocMerger_0000000000014.nwd") + compFile = os.path.join(refDir, "coreDocTools_DocMerger_0000000000014.nwd") + + assert docMerger.newTargetDoc(hChapter1, "All of Chapter 1") == "0000000000014" + + assert docMerger.appendText(hChapter1, True, "Merge") is True + assert docMerger.appendText(hSceneOne11, True, "Merge") is True + assert docMerger.appendText(hSceneOne12, True, "Merge") is True + assert docMerger.appendText(hSceneOne13, True, "Merge") is True + + # Block writing and check error handling + with monkeypatch.context() as mp: + mp.setattr("builtins.open", causeOSError) + assert docMerger.writeTargetDoc() is False + assert not os.path.isfile(saveFile) + assert docMerger.getError() != "" + + # Write properly, and compare + assert docMerger.writeTargetDoc() is True + copyfile(saveFile, testFile) + assert cmpFiles(testFile, compFile) + + # Merge into Existing + # =================== + + saveFile = os.path.join(fncDir, "content", "0000000000010.nwd") + testFile = os.path.join(outDir, "coreDocTools_DocMerger_0000000000010.nwd") + compFile = os.path.join(refDir, "coreDocTools_DocMerger_0000000000010.nwd") + + docMerger.setTargetDoc(hChapter1) + + assert docMerger.appendText(hSceneOne11, True, "Merge") is True + assert docMerger.appendText(hSceneOne12, True, "Merge") is True + assert docMerger.appendText(hSceneOne13, True, "Merge") is True + + assert docMerger.writeTargetDoc() is True + copyfile(saveFile, testFile) + assert cmpFiles(testFile, compFile) + + # Just for debugging + docMerger.writeTargetDoc() + +# END Test testCoreDocTools_DocMerger diff --git a/tests/test_core/test_core_project.py b/tests/test_core/test_core_project.py index 3be812e1..5ea25676 100644 --- a/tests/test_core/test_core_project.py +++ b/tests/test_core/test_core_project.py @@ -22,9 +22,9 @@ along with this program. If not, see . import os import pytest +from lxml import etree from shutil import copyfile from zipfile import ZipFile -from lxml import etree from tools import cmpFiles, writeFile, readFile, buildTestProject, XML_IGNORE from mock import causeOSError From 07c93bcb7d8afb1178b271c573a7f00aab3948bb Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Tue, 11 Oct 2022 21:20:03 +0200 Subject: [PATCH 11/12] Update test coverage --- novelwriter/gui/projtree.py | 12 +- tests/test_gui/test_gui_projtree.py | 243 ++++++++++++++++++++++++++-- 2 files changed, 232 insertions(+), 23 deletions(-) diff --git a/novelwriter/gui/projtree.py b/novelwriter/gui/projtree.py index 15a2417c..4195997c 100644 --- a/novelwriter/gui/projtree.py +++ b/novelwriter/gui/projtree.py @@ -915,7 +915,9 @@ class GuiProjectTree(QTreeWidget): dstItem = self._lastMove.get("parent", None) dstIndex = self._lastMove.get("index", None) - if srcItem is None or dstItem is None or dstIndex is None: + srcOK = isinstance(srcItem, QTreeWidgetItem) + dstOk = isinstance(dstItem, QTreeWidgetItem) + if not srcOK or not dstOk or dstIndex is None: logger.verbose("No tree move to undo") return False @@ -1011,7 +1013,7 @@ class GuiProjectTree(QTreeWidget): return @pyqtSlot("QTreeWidgetItem*", int) - def _treeDoubleClick(self, tItem, colNo): + def _treeDoubleClick(self, trItem, colNo): """Capture a double-click event and either request the document for editing if it is a file, or expand/close the node it is not. """ @@ -1026,9 +1028,7 @@ class GuiProjectTree(QTreeWidget): if tItem.isFileType(): self.projView.openDocumentRequest.emit(tHandle, nwDocMode.EDIT, -1, "") else: - trItem = self._getTreeItem(tHandle) - if trItem is not None: - trItem.setExpanded(not trItem.isExpanded()) + trItem.setExpanded(not trItem.isExpanded()) return @@ -1401,7 +1401,7 @@ class GuiProjectTree(QTreeWidget): dlgMerge = GuiDocMerge(self.mainGui, tHandle, itemList) dlgMerge.exec_() - if dlgMerge.result() != QDialog.Accepted: + if dlgMerge.result() == QDialog.Accepted: mrgData = dlgMerge.getData() mrgList = mrgData.get("finalItems", []) diff --git a/tests/test_gui/test_gui_projtree.py b/tests/test_gui/test_gui_projtree.py index f4bfa1c8..8e683742 100644 --- a/tests/test_gui/test_gui_projtree.py +++ b/tests/test_gui/test_gui_projtree.py @@ -22,12 +22,15 @@ along with this program. If not, see . import os import pytest +from mock import causeOSError from tools import C, buildTestProject -from PyQt5.QtWidgets import QMessageBox, QMenu +from PyQt5.QtCore import Qt +from PyQt5.QtWidgets import QMessageBox, QMenu, QTreeWidgetItem, QDialog from novelwriter.enum import nwItemLayout, nwItemType, nwItemClass -from novelwriter.dialogs import GuiEditLabel +from novelwriter.core import NWDoc +from novelwriter.dialogs import GuiEditLabel, GuiDocMerge from novelwriter.gui.projtree import GuiProjectTree @@ -560,16 +563,18 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): monkeypatch.setattr(GuiEditLabel, "getLabel", lambda *a, text: (text, True)) monkeypatch.setattr(QMenu, "exec_", lambda *a: None) - nwTree = nwGUI.projView - # Create a project prjDir = os.path.join(fncDir, "project") buildTestProject(nwGUI, prjDir) # Handles for new objects - hCharNote = "0000000000011" - hNovelNote = "0000000000012" + hCharNote = "0000000000011" + hNovelNote = "0000000000012" + hSubNote = "0000000000013" + hNewFolderOne = "0000000000014" + hNewFolderTwo = "0000000000016" + projView = nwGUI.projView projTree = nwGUI.projView.projTree projTree.setExpandedFromHandle(None, True) @@ -581,6 +586,10 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): projTree.setSelectedHandle(C.hNovelRoot) projTree.newTreeItem(nwItemType.FILE, isNote=True) + nwGUI.theProject.newFile("SubNote", hNovelNote) + projTree.revealNewTreeItem(hSubNote) + assert nwGUI.theProject.tree[hSubNote].itemParent == hNovelNote + def itemPos(tHandle): return projTree.visualItemRect(projTree._getTreeItem(tHandle)).center() @@ -596,6 +605,7 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): assert projTree._openContextMenu(itemPos(C.hChapterDoc)) is True assert projTree._openContextMenu(itemPos(C.hCharRoot)) is True assert projTree._openContextMenu(itemPos(hCharNote)) is True + assert projTree._openContextMenu(itemPos(hNovelNote)) is True # Check the keyboard shortcut handler as well projTree.setSelectedHandle(C.hNovelRoot) @@ -633,18 +643,15 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): # Convert Folders to Documents # ============================ - hNewFolderOne = "0000000000013" - hNewFolderTwo = "0000000000015" + projView.setSelectedHandle(hNovelNote) + assert projView.projTree.newTreeItem(nwItemType.FOLDER) is True + projView.setSelectedHandle(hNewFolderOne) + assert projView.projTree.newTreeItem(nwItemType.FILE) is True - nwTree.setSelectedHandle(hNovelNote) - assert nwTree.projTree.newTreeItem(nwItemType.FOLDER) is True - nwTree.setSelectedHandle(hNewFolderOne) - assert nwTree.projTree.newTreeItem(nwItemType.FILE) is True - - nwTree.setSelectedHandle(hNovelNote) - assert nwTree.projTree.newTreeItem(nwItemType.FOLDER) is True - nwTree.setSelectedHandle(hNewFolderTwo) - assert nwTree.projTree.newTreeItem(nwItemType.FILE, isNote=True) is True + projView.setSelectedHandle(hNovelNote) + assert projView.projTree.newTreeItem(nwItemType.FOLDER) is True + projView.setSelectedHandle(hNewFolderTwo) + assert projView.projTree.newTreeItem(nwItemType.FILE, isNote=True) is True # Click no on the dialog with monkeypatch.context() as mp: @@ -665,3 +672,205 @@ def testGuiProjTree_ContextMenu(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): # qtbot.stop() # END Test testGuiProjTree_ContextMenu + + +@pytest.mark.gui +def testGuiProjTree_MergeDocument(qtbot, monkeypatch, nwGUI, fncDir, mockRnd, ipsumText): + """Test the merge document function. + """ + mergeData = {} + + # Block message box + monkeypatch.setattr(QMessageBox, "warning", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "critical", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes) + + monkeypatch.setattr(GuiDocMerge, "__init__", lambda *a: None) + monkeypatch.setattr(GuiDocMerge, "exec_", lambda *a: None) + monkeypatch.setattr(GuiDocMerge, "result", lambda *a: QDialog.Accepted) + monkeypatch.setattr(GuiDocMerge, "getData", lambda *a: mergeData) + + # Create a project + prjDir = os.path.join(fncDir, "project") + buildTestProject(nwGUI, prjDir) + + theProject = nwGUI.theProject + projTree = nwGUI.projView.projTree + + mergedDoc1 = "0000000000014" + + # Create File to Merge + hChapter1 = theProject.newFile("Chapter 1", C.hNovelRoot) + hSceneOne11 = theProject.newFile("Scene 1.1", hChapter1) + hSceneOne12 = theProject.newFile("Scene 1.2", hChapter1) + hSceneOne13 = theProject.newFile("Scene 1.3", hChapter1) + + docText1 = "\n\n".join(ipsumText[0:2]) + "\n\n" + docText2 = "\n\n".join(ipsumText[1:3]) + "\n\n" + docText3 = "\n\n".join(ipsumText[2:4]) + "\n\n" + docText4 = "\n\n".join(ipsumText[3:5]) + "\n\n" + + lenText1 = len(docText1) + lenText2 = len(docText2) + lenText3 = len(docText3) + lenText4 = len(docText4) + lenAll = lenText1 + lenText2 + lenText3 + lenText4 + + theProject.writeNewFile(hChapter1, 2, True, docText1) + theProject.writeNewFile(hSceneOne11, 3, True, docText2) + theProject.writeNewFile(hSceneOne12, 3, True, docText3) + theProject.writeNewFile(hSceneOne13, 3, True, docText4) + + projTree.revealNewTreeItem(hChapter1) + projTree.revealNewTreeItem(hSceneOne11) + projTree.revealNewTreeItem(hSceneOne12) + projTree.revealNewTreeItem(hSceneOne13) + + # Invalid file handle + assert projTree._mergeDocuments(C.hInvalid, False) is False + + # Cannot merge root item + assert projTree._mergeDocuments(C.hNovelRoot, False) is False + + # Merge to new file, but there is now merge data + mergeData.clear() + assert projTree._mergeDocuments(hChapter1, True) is False + + # Merge to New Doc + # ================ + + # Set merge job for new documents + mergeData["finalItems"] = [hChapter1, hSceneOne11, hSceneOne12, hSceneOne13] + mergeData["moveToTrash"] = False + + # User cancels merge + with monkeypatch.context() as mp: + mp.setattr(GuiDocMerge, "result", lambda *a: QDialog.Rejected) + assert projTree._mergeDocuments(hChapter1, True) is False + + # The merge goes through + assert projTree._mergeDocuments(hChapter1, True) is True + assert len(NWDoc(theProject, mergedDoc1).readDocument()) > lenAll + + # Merge to Existing Doc + # ===================== + + # Set merge job for parent document + mergeData["finalItems"] = [hSceneOne11, hSceneOne12, hSceneOne13] + mergeData["moveToTrash"] = False + + # Merging to a folder is not allowed + assert projTree._mergeDocuments(C.hChapterDir, False) is False + + # Block writing and check error handling + with monkeypatch.context() as mp: + mp.setattr("builtins.open", causeOSError) + assert projTree._mergeDocuments(hChapter1, False) is False + + # Successful merge, and move to trash + mergeData["moveToTrash"] = True + assert len(NWDoc(theProject, hChapter1).readDocument()) < lenAll + assert projTree._mergeDocuments(hChapter1, False) is True + assert len(NWDoc(theProject, hChapter1).readDocument()) > lenAll + + assert theProject.tree.isTrash(hSceneOne11) + assert theProject.tree.isTrash(hSceneOne12) + assert theProject.tree.isTrash(hSceneOne13) + + # qtbot.stop() + +# END Test testGuiProjTree_MergeDocument + + +@pytest.mark.gui +def testGuiProjTree_Other(qtbot, monkeypatch, nwGUI, fncDir, mockRnd): + """Test various parts of the project tree class not covered by + other tests. + """ + # Block message box + monkeypatch.setattr(QMessageBox, "warning", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "critical", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes) + monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes) + + # Create a project + prjDir = os.path.join(fncDir, "project") + buildTestProject(nwGUI, prjDir) + + projView = nwGUI.projView + projTree = nwGUI.projView.projTree + + # Method: initSettings + # ==================== + + # Test that the scrollbar setting works + nwGUI.mainConf.hideVScroll = True + nwGUI.mainConf.hideHScroll = True + projView.initSettings() + assert projTree.verticalScrollBarPolicy() == Qt.ScrollBarAlwaysOff + assert projTree.horizontalScrollBarPolicy() == Qt.ScrollBarAlwaysOff + + nwGUI.mainConf.hideVScroll = False + nwGUI.mainConf.hideHScroll = False + projView.initSettings() + assert projTree.verticalScrollBarPolicy() == Qt.ScrollBarAsNeeded + assert projTree.horizontalScrollBarPolicy() == Qt.ScrollBarAsNeeded + + # Method: revealNewTreeItem + # ========================= + + # Send invalid handle + assert projTree.revealNewTreeItem(C.hInvalid) is False + + # Try to add an oprhaned file to the tree + nHandle = nwGUI.theProject.newFile("Test", C.hNovelRoot) + nwGUI.theProject.tree[nHandle].setParent(None) + assert projTree.revealNewTreeItem(nHandle) is False + + # Method: undoLastMove + # ==================== + + # Nothing to move + assert projTree.undoLastMove() is False + + projTree._lastMove["item"] = QTreeWidgetItem() + projTree._lastMove["parent"] = QTreeWidgetItem() + projTree._lastMove["index"] = 0 + assert projTree.undoLastMove() is False + + projTree._lastMove["item"] = projTree._treeMap[C.hTitlePage] + projTree._lastMove["parent"] = QTreeWidgetItem() + projTree._lastMove["index"] = 0 + assert projTree.undoLastMove() is False + + # Slot: _treeDoubleClick + # ====================== + + # Try to open a file with nothings selected + projTree.clearSelection() + projTree._treeDoubleClick(QTreeWidgetItem(), 0) + assert nwGUI.docEditor.docHandle() is None + + # When the item cannot be found + projTree._getTreeItem(C.hTitlePage).setSelected(True) + with monkeypatch.context() as mp: + mp.setattr("novelwriter.core.tree.NWTree.__getitem__", lambda *a: None) + projTree._treeDoubleClick(QTreeWidgetItem(), 0) + assert nwGUI.docEditor.docHandle() is None + + # Successfully open a file + projTree._treeDoubleClick(projTree._getTreeItem(C.hTitlePage), 0) + assert nwGUI.docEditor.docHandle() == C.hTitlePage + projTree._getTreeItem(C.hTitlePage).setSelected(False) + + # A non-file item should be expanded instead + projTree._getTreeItem(C.hNovelRoot).setExpanded(False) + projTree._getTreeItem(C.hNovelRoot).setSelected(True) + projTree._treeDoubleClick(projTree._getTreeItem(C.hNovelRoot), 1) + assert nwGUI.docEditor.docHandle() == C.hTitlePage + assert projTree._getTreeItem(C.hNovelRoot).isExpanded() is True + + # qtbot.stop() + +# END Test testGuiProjTree_Other From 417758a29a9bffdef4a9d73cd53a1c7a75b75676 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Tue, 11 Oct 2022 21:48:40 +0200 Subject: [PATCH 12/12] Add coverage of new function in project class --- .../coreProject_NewFileFolder_nwProject.nwx | 68 +++++++------- .../coreProject_NewRoot_nwProject.nwx | 82 ++++++++--------- tests/test_core/test_core_project.py | 90 ++++++++++++++----- 3 files changed, 142 insertions(+), 98 deletions(-) diff --git a/tests/reference/coreProject_NewFileFolder_nwProject.nwx b/tests/reference/coreProject_NewFileFolder_nwProject.nwx index b8df1c93..c0ec400a 100644 --- a/tests/reference/coreProject_NewFileFolder_nwProject.nwx +++ b/tests/reference/coreProject_NewFileFolder_nwProject.nwx @@ -1,5 +1,5 @@ - + New Project New Novel @@ -17,9 +17,9 @@ None None None - 2 + 4 1 - 1 + 3 %title% @@ -29,62 +29,62 @@
- New - Note - Draft - Finished + New + Note + Draft + Finished - New - Minor - Major - Main + New + Minor + Major + Main - + - Novel + Novel - + - Plot + Plot - + - Characters + Characters - + - World + World - + - Title Page + Title Page - + - New Chapter + New Chapter - + - New Chapter + New Chapter - + - New Scene + New Scene - + - Stuff + Stuff - + - Hello + Hello - - - Jane + + + Jane diff --git a/tests/reference/coreProject_NewRoot_nwProject.nwx b/tests/reference/coreProject_NewRoot_nwProject.nwx index 9102601d..3e372adb 100644 --- a/tests/reference/coreProject_NewRoot_nwProject.nwx +++ b/tests/reference/coreProject_NewRoot_nwProject.nwx @@ -1,5 +1,5 @@ - + New Project New Novel @@ -29,82 +29,82 @@
- New - Note - Draft - Finished + New + Note + Draft + Finished - New - Minor - Major - Main + New + Minor + Major + Main - + - Novel + Novel - + - Plot + Plot - + - Characters + Characters - + - World + World - + - Title Page + Title Page - + - New Chapter + New Chapter - + - New Chapter + New Chapter - + - New Scene + New Scene - + - Novel + Novel - + - Plot + Plot - + - Characters + Characters - + - Locations + Locations - + - Timeline + Timeline - + - Objects + Objects - + - Custom + Custom - + - Custom + Custom diff --git a/tests/test_core/test_core_project.py b/tests/test_core/test_core_project.py index 5ea25676..5a95295b 100644 --- a/tests/test_core/test_core_project.py +++ b/tests/test_core/test_core_project.py @@ -26,7 +26,7 @@ from lxml import etree from shutil import copyfile from zipfile import ZipFile -from tools import cmpFiles, writeFile, readFile, buildTestProject, XML_IGNORE +from tools import cmpFiles, writeFile, readFile, buildTestProject, XML_IGNORE, C from mock import causeOSError from novelwriter.enum import nwItemClass, nwItemType, nwItemLayout @@ -256,6 +256,7 @@ def testCoreProject_NewRoot(fncDir, outDir, refDir, mockGUI, mockRnd): compFile = os.path.join(refDir, "coreProject_NewRoot_nwProject.nwx") theProject = NWProject(mockGUI) + mockRnd.reset() buildTestProject(theProject, fncDir) assert theProject.setProjectPath(fncDir) is True @@ -263,14 +264,14 @@ def testCoreProject_NewRoot(fncDir, outDir, refDir, mockGUI, mockRnd): assert theProject.closeProject() is True assert theProject.openProject(projFile) is True - assert isinstance(theProject.newRoot(nwItemClass.NOVEL), str) - assert isinstance(theProject.newRoot(nwItemClass.PLOT), str) - assert isinstance(theProject.newRoot(nwItemClass.CHARACTER), str) - assert isinstance(theProject.newRoot(nwItemClass.WORLD), str) - assert isinstance(theProject.newRoot(nwItemClass.TIMELINE), str) - assert isinstance(theProject.newRoot(nwItemClass.OBJECT), str) - assert isinstance(theProject.newRoot(nwItemClass.CUSTOM), str) - assert isinstance(theProject.newRoot(nwItemClass.CUSTOM), str) + assert theProject.newRoot(nwItemClass.NOVEL) == "0000000000020" + assert theProject.newRoot(nwItemClass.PLOT) == "0000000000021" + assert theProject.newRoot(nwItemClass.CHARACTER) == "0000000000022" + assert theProject.newRoot(nwItemClass.WORLD) == "0000000000023" + assert theProject.newRoot(nwItemClass.TIMELINE) == "0000000000024" + assert theProject.newRoot(nwItemClass.OBJECT) == "0000000000025" + assert theProject.newRoot(nwItemClass.CUSTOM) == "0000000000026" + assert theProject.newRoot(nwItemClass.CUSTOM) == "0000000000027" assert theProject.projChanged is True assert theProject.saveProject() is True @@ -280,11 +281,30 @@ def testCoreProject_NewRoot(fncDir, outDir, refDir, mockGUI, mockRnd): assert cmpFiles(testFile, compFile, ignoreStart=XML_IGNORE) assert theProject.projChanged is False + # Delete the new items + assert theProject.removeItem("0000000000020") is True + assert theProject.removeItem("0000000000021") is True + assert theProject.removeItem("0000000000022") is True + assert theProject.removeItem("0000000000023") is True + assert theProject.removeItem("0000000000024") is True + assert theProject.removeItem("0000000000025") is True + assert theProject.removeItem("0000000000026") is True + assert theProject.removeItem("0000000000027") is True + + assert "0000000000020" not in theProject.tree + assert "0000000000021" not in theProject.tree + assert "0000000000022" not in theProject.tree + assert "0000000000023" not in theProject.tree + assert "0000000000024" not in theProject.tree + assert "0000000000025" not in theProject.tree + assert "0000000000026" not in theProject.tree + assert "0000000000027" not in theProject.tree + # END Test testCoreProject_NewRoot @pytest.mark.core -def testCoreProject_NewFileFolder(fncDir, outDir, refDir, mockGUI, mockRnd): +def testCoreProject_NewFileFolder(monkeypatch, fncDir, outDir, refDir, mockGUI, mockRnd): """Check that new files can be added to the project. """ projFile = os.path.join(fncDir, "nwProject.nwx") @@ -292,6 +312,7 @@ def testCoreProject_NewFileFolder(fncDir, outDir, refDir, mockGUI, mockRnd): compFile = os.path.join(refDir, "coreProject_NewFileFolder_nwProject.nwx") theProject = NWProject(mockGUI) + mockRnd.reset() buildTestProject(theProject, fncDir) assert theProject.setProjectPath(fncDir) is True @@ -304,35 +325,58 @@ def testCoreProject_NewFileFolder(fncDir, outDir, refDir, mockGUI, mockRnd): assert theProject.newFile("New File", "1234567890abc") is None # Add files properly - assert theProject.newFolder("Stuff", "0000000000015") == "0000000000028" - assert theProject.newFile("Hello", "0000000000015") == "0000000000029" - assert theProject.newFile("Jane", "0000000000012") == "000000000002a" + assert theProject.newFolder("Stuff", C.hNovelRoot) == "0000000000020" + assert theProject.newFile("Hello", "0000000000020") == "0000000000021" + assert theProject.newFile("Jane", C.hCharRoot) == "0000000000022" - assert "0000000000028" in theProject.tree - assert "0000000000029" in theProject.tree - assert "000000000002a" in theProject.tree + assert "0000000000020" in theProject.tree + assert "0000000000021" in theProject.tree + assert "0000000000022" in theProject.tree # Write to file, failed assert theProject.writeNewFile("blabla", 1, True) is False # Not a handle - assert theProject.writeNewFile("0000000000028", 1, True) is False # Not a file - assert theProject.writeNewFile("0000000000014", 1, True) is False # Already has content + assert theProject.writeNewFile("0000000000020", 1, True) is False # Not a file + assert theProject.writeNewFile(C.hTitlePage, 1, True) is False # Already has content # Write to file, success - assert theProject.writeNewFile("0000000000029", 2, True) is True - assert NWDoc(theProject, "0000000000029").readDocument() == "## Hello\n\n" + assert theProject.writeNewFile("0000000000021", 2, True) is True + assert NWDoc(theProject, "0000000000021").readDocument() == "## Hello\n\n" - assert theProject.writeNewFile("000000000002a", 1, False) is True - assert NWDoc(theProject, "000000000002a").readDocument() == "# Jane\n\n" + # Write to file with additional text, success + assert theProject.writeNewFile("0000000000022", 1, False, "Hi Jane\n\n") is True + assert NWDoc(theProject, "0000000000022").readDocument() == "# Jane\n\nHi Jane\n\n" # Save, close and check assert theProject.projChanged is True assert theProject.saveProject() is True - assert theProject.closeProject() is True copyfile(projFile, testFile) assert cmpFiles(testFile, compFile, ignoreStart=XML_IGNORE) assert theProject.projChanged is False + # Delete new file, but block access + with monkeypatch.context() as mp: + mp.setattr("os.unlink", causeOSError) + assert theProject.removeItem("0000000000021") is False + assert "0000000000021" in theProject.tree + + # Delete new files and folders + assert os.path.isfile(os.path.join(fncDir, "content", "0000000000022.nwd")) + assert os.path.isfile(os.path.join(fncDir, "content", "0000000000021.nwd")) + + assert theProject.removeItem("0000000000022") is True + assert theProject.removeItem("0000000000021") is True + assert theProject.removeItem("0000000000020") is True + + assert not os.path.isfile(os.path.join(fncDir, "content", "0000000000022.nwd")) + assert not os.path.isfile(os.path.join(fncDir, "content", "0000000000021.nwd")) + + assert "0000000000020" not in theProject.tree + assert "0000000000021" not in theProject.tree + assert "0000000000022" not in theProject.tree + + assert theProject.closeProject() is True + # END Test testCoreProject_NewFileFolder