SPB Git

Repository Public

ReviewAndTableTests.swift 16.2 KB 365 lines swift

1// ORIX Docs2// File: Packages/ORIXDocsKit/Tests/DocModelTests/ReviewAndTableTests.swift3// Description: Change tracking (accept/reject invariants), comments, find and replace, and table operations and formulas.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Testing8import Foundation9@testable import DocModel1011func tracked(_ paragraphs: [String], author: String = "Reviewer") -> DocumentEditor {12    var doc = makeDoc(paragraphs)13    doc.settings.trackChanges = true14    return DocumentEditor(doc: doc, author: author)15}16func accepted(_ e: DocumentEditor) -> [String] { var d = e.doc; d.resolveChanges(accept: true); return texts(d) }17func rejected(_ e: DocumentEditor) -> [String] { var d = e.doc; d.resolveChanges(accept: false); return texts(d) }1819@Suite struct TrackChangesTests {20    @Test func insertionIsMarkedAndReversible() {21        var e = tracked(["Hello world"])22        e.selection = caret(0, 5)23        e.insertText(" big")24        let p = e.doc.body[0].paragraph!25        #expect(p.plainText == "Hello big world")26        #expect(p.runs.filter(\.isInserted).map(\.text) == [" big"])27        #expect(accepted(e) == ["Hello big world"] && rejected(e) == ["Hello world"])28    }2930    @Test func consecutiveKeystrokesFormOneChange() {31        var e = tracked(["ab"])32        e.selection = caret(0, 1)33        for ch in "xyz" { e.insertText(String(ch)) }34        #expect(e.doc.trackedChanges().count == 1)35        #expect(e.doc.trackedChanges()[0].text == "xyz")36    }3738    @Test func deletionKeepsTheTextMarked() {39        var e = tracked(["Hello big world"])40        e.selection = range(0, 5, 0, 9)41        e.deleteSelection()42        let p = e.doc.body[0].paragraph!43        #expect(p.plainText == "Hello big world" && p.visibleText == "Hello world")44        #expect(accepted(e) == ["Hello world"] && rejected(e) == ["Hello big world"])45    }4647    @Test func backspacesMergeIntoOneDeletionAndCaretMovesLeft() {48        var e = tracked(["abcdef"])49        e.selection = caret(0, 4)50        e.deleteBackward(); e.deleteBackward()51        #expect(e.selection == caret(0, 2))52        #expect(e.doc.trackedChanges().map(\.text) == ["cd"])53        e.selection = caret(0, 4)54        e.deleteForward()55        #expect(e.selection == caret(0, 5))56        #expect(e.doc.trackedChanges().map(\.text) == ["cde"])57    }5859    @Test func deletingYourOwnPendingInsertionRemovesItForGood() {60        var e = tracked(["ab"])61        e.selection = caret(0, 1)62        e.insertText("XY")63        e.deleteBackward()64        #expect(e.doc.body[0].paragraph!.plainText == "aXb")65        e.deleteBackward()66        #expect(!e.doc.hasTrackedChanges && texts(e.doc) == ["ab"])67    }6869    @Test func anotherReviewersInsertionIsMarkedDeletedNotRemoved() {70        var e = tracked(["ab"], author: "Alice")71        e.selection = caret(0, 1)72        e.insertText("X")73        e.author = "Bob"74        e.deleteBackward()75        #expect(e.doc.body[0].paragraph!.plainText == "aXb")76        #expect(e.doc.trackedChanges().map(\.author) == ["Bob"])77    }7879    @Test func typingOverASelectionRecordsBoth() {80        var e = tracked(["Hello world"])81        e.selection = range(0, 6, 0, 11)82        e.insertText("ORIX")83        #expect(e.doc.body[0].paragraph!.plainText == "Hello worldORIX")84        #expect(accepted(e) == ["Hello ORIX"] && rejected(e) == ["Hello world"])85    }8687    @Test func paragraphBreakIsTracked() {88        var e = tracked(["onetwo"])89        e.selection = caret(0, 3)90        e.insertParagraphBreak()91        #expect(texts(e.doc) == ["one", "two"])92        #expect(e.doc.trackedChanges().map(\.kind) == [.paragraphInserted])93        #expect(accepted(e) == ["one", "two"] && rejected(e) == ["onetwo"])94    }9596    @Test func joiningParagraphsIsTracked() {97        var e = tracked(["one", "two"])98        e.selection = caret(1, 0)99        e.deleteBackward()100        #expect(texts(e.doc) == ["one", "two"])101        #expect(accepted(e) == ["onetwo"] && rejected(e) == ["one", "two"])102    }103104    @Test func multiParagraphDeletion() {105        var e = tracked(["alpha", "beta", "gamma", "delta"])106        e.selection = range(0, 2, 2, 3)107        e.deleteSelection()108        #expect(texts(e.doc).count == 4)109        #expect(accepted(e) == ["alma", "delta"])110        #expect(rejected(e) == ["alpha", "beta", "gamma", "delta"])111    }112113    @Test func formattingChangeIsTrackedAndRejectRestores() {114        var e = tracked(["Hello world"])115        e.selection = range(0, 0, 0, 5)116        e.toggle(.bold)117        #expect(e.doc.trackedChanges().map(\.kind) == [.formatting])118        var d = e.doc; d.resolveChanges(accept: false)119        #expect(d.body[0].paragraph!.runs.count == 1 && d.body[0].paragraph!.runs[0].props.bold == nil)120        d = e.doc; d.resolveChanges(accept: true)121        #expect(d.body[0].paragraph!.runs[0].props.bold == true && !d.hasTrackedChanges)122    }123124    @Test func resolvingASingleChangeLeavesTheOthers() {125        var e = tracked(["Hello world"])126        e.selection = caret(0, 0); e.insertText("A ")127        e.selection = caret(0, 13); e.insertText(" Z")128        let changes = e.doc.trackedChanges()129        #expect(changes.count == 2)130        e.resolveChanges(accept: false, ids: [changes[0].revisionID])131        #expect(texts(e.doc) == ["Hello world Z"])132        #expect(e.doc.trackedChanges().count == 1)133    }134135    @Test func navigationSelectsChangesInOrder() {136        var e = tracked(["one two three"])137        e.selection = caret(0, 3); e.insertText("X")138        e.selection = caret(0, 8); e.insertText("Y")139        e.selection = caret(0, 0)140        let r7 = e.selectAdjacentChange(forward: true)141        #expect(r7?.text == "X")142        let r8 = e.selectAdjacentChange(forward: true)143        #expect(r8?.text == "Y")144        let r9 = e.selectAdjacentChange(forward: false)145        #expect(r9?.text == "X")146    }147148    @Test func randomisedEditsKeepAcceptRejectInvariant() {149        // Property: with tracking on, rejecting everything always restores the original text, whatever the edit sequence.150        var rng = SystemRandomNumberGenerator()151        for _ in 0..<60 {152            let original = ["The quick brown fox", "jumps over", "the lazy dog 🐕 déjà vu"]153            var e = tracked(original)154            var plain = DocumentEditor(doc: makeDoc(original))   // same edits, no tracking: the expected "accepted" result155            _ = plain156            var log: [String] = []157            for _ in 0..<12 {158                let b = e.doc.body159                let bi = Int.random(in: 0..<b.count, using: &rng)160                guard let p = b[bi].paragraph else { continue }161                let off = p.plainText.composedBoundary(atOrBefore: Int.random(in: 0...p.length, using: &rng))162                e.selection = caret(bi, off)163                let op = Int.random(in: 0..<5, using: &rng)164                log.append("op\(op)@\(bi):\(off)")165                switch op {166                case 0: e.insertText("ab")167                case 1: e.deleteBackward()168                case 2: e.deleteForward(.word)169                case 3: e.insertParagraphBreak()170                default:171                    let bj = Int.random(in: bi..<b.count, using: &rng)172                    if let q = b[bj].paragraph { e.selection.head = Position(block: bj, offset: q.plainText.composedBoundary(atOrBefore: Int.random(in: 0...q.length, using: &rng))) }173                    log.append("  to \(e.selection.head.path.block):\(e.selection.head.offset)")174                    e.deleteSelection()175                }176            }177            #expect(rejected(e) == original, "\(log.joined(separator: " "))")178            var d = e.doc; d.resolveChanges(accept: true)179            #expect(!d.hasTrackedChanges)180            plain = DocumentEditor(doc: d)181        }182    }183}184185@Suite struct CommentAndSearchTests {186    @Test func commentLifecycle() {187        var e = DocumentEditor(doc: makeDoc(["Hello brave world"]), selection: range(0, 6, 0, 11), author: "Ana")188        let id = e.addComment("Why brave?")!189        #expect(e.doc.commentAnchor(id)?.text == "brave")190        e.replyToComment(id, text: "Because.")191        e.setComment(id, resolved: true)192        #expect(e.doc.comments[0].replies.count == 1 && e.doc.comments[0].resolved && e.doc.comments[0].author == "Ana")193        e.selection = caret(0, 8)194        e.insertText("X")195        #expect(e.doc.commentAnchor(id)?.text == "brXave")   // text typed inside the range is covered196        e.removeComment(id)197        #expect(e.doc.comments.isEmpty && e.doc.body[0].paragraph!.runs.count == 1)198    }199200    @Test func deletingTheAnchoredTextRemovesTheComment() {201        var e = DocumentEditor(doc: makeDoc(["Hello brave world"]), selection: range(0, 6, 0, 11))202        e.addComment("note")203        e.selection = range(0, 5, 0, 12)204        e.deleteSelection()205        #expect(e.doc.comments.isEmpty)206    }207208    @Test func findVariants() {209        let doc = makeDoc(["Résumé of the resume; RESUME.", "presume nothing"])210        #expect(doc.findAll("resume").count == 4)211        #expect(doc.findAll("resume", options: FindOptions(wholeWord: true)).count == 3)212        #expect(doc.findAll("resume", options: FindOptions(caseSensitive: true, diacriticSensitive: true)).count == 2)213        #expect(doc.findAll("r[eé]sum[eé]", options: FindOptions(regularExpression: true)).count == 4)214        #expect(doc.findAll("(", options: FindOptions(regularExpression: true)).isEmpty)   // invalid pattern: no crash215    }216217    @Test func replaceAllKeepsFormattingAndCounts() {218        var doc = makeDoc([""])219        doc.body = [.paragraph(Paragraph(runs: [Run("cat ", props: CharProps(bold: true)), Run("cat cat")])), .paragraph(Paragraph("concat"))]220        var e = DocumentEditor(doc: doc)221        let r5 = e.replaceAll("cat", with: "lion", options: FindOptions(wholeWord: true))222        #expect(r5 == 3)223        #expect(texts(e.doc) == ["lion lion lion", "concat"])224        #expect(e.doc.body[0].paragraph!.runs[0].props.bold == true)225        let r6 = e.replaceAll("(l)ion", with: "$1ynx", options: FindOptions(regularExpression: true))226        #expect(r6 == 3)227        #expect(texts(e.doc)[0] == "lynx lynx lynx")228    }229230    @Test func replaceUnderTrackingIsReversible() {231        var e = tracked(["a cat sat"])232        e.replaceAll("cat", with: "dog")233        #expect(accepted(e) == ["a dog sat"] && rejected(e) == ["a cat sat"])234    }235}236237@Suite struct TableTests {238    func tableEditor(_ strings: [[String]]) -> DocumentEditor {239        var doc = makeDoc([""])240        doc.body = [.table(Table(strings: strings, width: 400)), .paragraph(Paragraph())]241        return DocumentEditor(doc: doc, selection: Selection(caret: Position(path: ParaPath(block: 0, cell: CellPath(row: 0, cell: 0)), offset: 0)))242    }243    func grid(_ e: DocumentEditor) -> [[String]] { e.doc.body[0].table!.rows.map { $0.cells.map(\.plainText) } }244    func at(_ r: Int, _ c: Int, _ o: Int = 0) -> Position { Position(path: ParaPath(block: 0, cell: CellPath(row: r, cell: c)), offset: o) }245246    @Test func typingInsideACell() {247        var e = tableEditor([["a", "b"], ["c", "d"]])248        e.selection = Selection(caret: at(1, 0, 1))249        e.insertText("!")250        e.insertParagraphBreak()251        e.insertText("x")252        #expect(grid(e) == [["a", "b"], ["c!\nx", "d"]])253    }254255    @Test func rowsAndColumns() {256        var e = tableEditor([["a", "b"], ["c", "d"]])257        e.insertRow(below: true)258        #expect(grid(e) == [["a", "b"], ["", ""], ["c", "d"]])259        e.selection = Selection(caret: at(0, 1))260        e.insertColumn(after: false)261        #expect(grid(e) == [["a", "", "b"], ["", "", ""], ["c", "", "d"]])262        #expect(abs(e.doc.body[0].table!.totalWidth - 400) < 0.001)263        e.selection = Selection(caret: at(1, 0))264        e.deleteRows()265        e.selection = Selection(caret: at(0, 1))266        e.deleteColumns()267        #expect(grid(e) == [["a", "b"], ["c", "d"]])268    }269270    @Test func deletingEveryRowRemovesTheTable() {271        var e = tableEditor([["a"]])272        e.deleteRows()273        #expect(e.doc.body.allSatisfy { $0.table == nil })274    }275276    @Test func mergeAndSplit() {277        var e = tableEditor([["a", "b", "c"], ["d", "e", "f"], ["g", "h", "i"]])278        e.selection = Selection(anchor: at(0, 0), head: at(1, 1, 1))279        let r1 = e.mergeCells()280        #expect(r1)281        var t = e.doc.body[0].table!282        #expect(t.rows[0].cells.count == 2 && t.rows[0].cells[0].colSpan == 2 && t.rows[0].cells[0].vMerge == .restart)283        #expect(t.rows[1].cells[0].vMerge == .continue && t.rows[0].cells[0].plainText == "a\nb\nd\ne")284        #expect(t.rows.allSatisfy { $0.cells.reduce(0) { $0 + $1.colSpan } == 3 })285        e.splitCell()286        t = e.doc.body[0].table!287        #expect(t.rows[0].cells.count == 3 && t.rows[1].cells[0].vMerge == .none)288        #expect(t.rows.allSatisfy { $0.cells.reduce(0) { $0 + $1.colSpan } == 3 || $0.cells.reduce(0) { $0 + $1.colSpan } == 3 })289    }290291    @Test func insertingAColumnThroughAMergedCellWidensIt() {292        var e = tableEditor([["a", "b"], ["c", "d"]])293        e.selection = Selection(anchor: at(0, 0), head: at(0, 1))294        e.mergeCells()295        e.selection = Selection(caret: at(1, 0))296        e.insertColumn(after: true)297        let t = e.doc.body[0].table!298        #expect(t.columnCount == 3 && t.rows[0].cells[0].colSpan == 3 && t.rows[1].cells.count == 3)299    }300301    @Test func tabMovesThroughCellsAndAddsARow() {302        var e = tableEditor([["a", "b"]])303        let r2 = e.moveToAdjacentCell(backward: false)304        #expect(r2)305        #expect(e.selection.head.path.cell == CellPath(row: 0, cell: 1))306        e.moveToAdjacentCell(backward: false)307        #expect(e.doc.body[0].table!.rows.count == 2 && e.selection.head.path.cell?.row == 1)308        e.selection = caret(1, 0)309        let r3 = e.moveToAdjacentCell(backward: false)310        #expect(!r3)311    }312313    @Test func cellSelectionDeleteClearsContent() {314        var e = tableEditor([["a", "b"], ["c", "d"]])315        e.selection = Selection(anchor: at(0, 0), head: at(1, 0, 1))316        e.deleteSelection()317        #expect(grid(e) == [["", "b"], ["", "d"]])318    }319320    @Test func sorting() {321        var e = tableEditor([["Name", "Qty"], ["pear", "12"], ["Apple", "100"], ["élan", "9"]])322        let r4 = e.sortRows(byGridColumn: 0, ascending: true, numeric: false)323        #expect(r4)324        #expect(grid(e).map { $0[0] } == ["Name", "Apple", "élan", "pear"])325        e.sortRows(byGridColumn: 1, ascending: false, numeric: true)326        #expect(grid(e).map { $0[1] } == ["Qty", "100", "12", "9"])327    }328329    @Test func formulas() {330        var e = tableEditor([["Item", "Qty", "Price", "Total"], ["A", "2", "10.50", ""], ["B", "3", "1,200.25", ""], ["Sum", "", "", ""]])331        e.selection = Selection(caret: at(1, 3)); e.setCellFormula("=B2*C2")332        e.selection = Selection(caret: at(2, 3)); e.setCellFormula("=B3*C3")333        e.selection = Selection(caret: at(3, 3)); e.setCellFormula("=SUM(ABOVE)")334        e.selection = Selection(caret: at(3, 1)); e.setCellFormula("=SUM(B2:B3)")335        e.selection = Selection(caret: at(3, 2)); e.setCellFormula("=AVERAGE(ABOVE)")336        let g = grid(e)337        #expect(g[1][3] == "21.00" && g[2][3] == "3600.75" && g[3][3] == "3621.75" && g[3][1] == "5" && g[3][2] == "605.38")338        // Editing an input and recalculating updates dependents.339        e.selection = Selection(anchor: at(1, 1), head: at(1, 1, 1)); e.insertText("4")340        e.recalculateTable()341        #expect(grid(e)[1][3] == "42.00" && grid(e)[3][3] == "3642.75")342        e.selection = Selection(caret: at(3, 0)); e.setCellFormula("=1/0")343        #expect(grid(e)[3][0] == "#ERR")344    }345346    @Test func numberParsing() {347        #expect(TableFormula.number(from: "1,234.50") == 1234.5)348        #expect(TableFormula.number(from: "1 234,50") == 1234.5)349        #expect(TableFormula.number(from: "(120)") == -120)350        #expect(TableFormula.number(from: "$45") == 45)351        #expect(TableFormula.number(from: "12,5") == 12.5)352        #expect(TableFormula.number(from: "1,000") == 1000)353        #expect(TableFormula.number(from: "abc") == nil)354        #expect(TableFormula.number(from: "−3") == -3)355    }356357    @Test func resizeColumnKeepsTheTableWidth() {358        var e = tableEditor([["a", "b"]])359        e.resizeColumn(block: 0, column: 0, width: 300)360        #expect(e.doc.body[0].table!.columnWidths == [300, 100])361        e.resizeColumn(block: 0, column: 0, width: 5000)362        #expect(e.doc.body[0].table!.columnWidths == [382, 18])363    }364}365
Files main
Menu

Theme