Repository Public MIT
1// ORIX Calc2// File: Packages/ORIXFeatureWorkspace/Tests/ORIXFeatureWorkspaceTests/SheetModelTests.swift3// Description: Tests of the open-sheet model — reactive edits and highlights, live parameters, structure edits, undo/redo, inline editing.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation8import SwiftUI9import Testing10import ORIXExpression11import ORIXUI12import ORIXWorkspace13@testable import ORIXFeatureWorkspace1415/// The canonical NPV example of the engine's own tests.16func npvDocument() -> WorkspaceDocument {17 WorkspaceDocument(title: "Project NPV", cells: [18 .text("Capital budgeting example"),19 .formula("Investment = 100000", unit: "$"),20 .parameter("DiscountRate", value: 0.08, range: 0...0.3, step: 0.005),21 .formula("CashFlow1 = 25000", unit: "$"),22 .formula("CashFlow2 = 30000", unit: "$"),23 .formula("CashFlow3 = 40000", unit: "$"),24 .formula("NPV = -Investment + CashFlow1/(1+DiscountRate) + CashFlow2/(1+DiscountRate)^2 + CashFlow3/(1+DiscountRate)^3", unit: "$"),25 .formula("Unrelated = 2 + 2"),26 .formula("Decision = if(NPV > 0, 1, 0)"),27 ])28}29@MainActor func names(_ sheet: SheetModel, _ ids: [UUID]) -> [String] { ids.compactMap { id in sheet.cell(id).map(sheet.label) } }30func npv(_ r: Double, _ c3: Double = 40000) -> Double { -100000 + 25000 / (1 + r) + 30000 / pow(1 + r, 2) + c3 / pow(1 + r, 3) }3132@MainActor @Suite struct SheetReactivityTests {33 @Test func editingACellUpdatesDependentsAndReportsTheHighlightedSet() throws {34 let sheet = SheetModel(document: npvDocument(), app: makeApp())35 let cf3 = try #require(sheet.cellDefining("CashFlow3"))36 sheet.setSource(cf3.id, "CashFlow3 = 80000")37 #expect(close(value(sheet, "NPV"), npv(0.08, 80000)))38 #expect(value(sheet, "Decision") == 1)39 #expect(names(sheet, sheet.lastHighlight) == ["CashFlow3", "NPV", "Decision"])40 #expect(sheet.highlighted == Set(sheet.lastHighlight))41 #expect(sheet.highlighted == Set(sheet.engine.lastRecalculated))42 #expect(sheet.canUndo && sheet.revision == 1)43 }4445 @Test func highlightClearsAfterItsDuration() async throws {46 let sheet = SheetModel(document: npvDocument(), app: makeApp())47 sheet.highlightDuration = .milliseconds(40)48 sheet.setSource(try #require(sheet.cellDefining("CashFlow1")).id, "CashFlow1 = 26000")49 #expect(!sheet.highlighted.isEmpty)50 for _ in 0..<200 where !sheet.highlighted.isEmpty { try await Task.sleep(for: .milliseconds(25)) }51 #expect(sheet.highlighted.isEmpty)52 #expect(names(sheet, sheet.lastHighlight) == ["CashFlow1", "NPV", "Decision"])53 }5455 @Test func sliderRecalculatesOnlyDependentsAndIsOneUndoStep() throws {56 let sheet = SheetModel(document: npvDocument(), app: makeApp())57 let rate = try #require(sheet.cells.first { $0.parameter?.name == "DiscountRate" })58 let unrelated = try #require(sheet.cellDefining("Unrelated"))59 let original = sheet.document60 for k in 1...40 {61 let r = 0.08 + Double(k) * 0.00562 sheet.setParameterValue(rate.id, r, continuous: true)63 #expect(close(value(sheet, "NPV"), npv(sheet.cell(rate.id)!.parameter!.value)))64 #expect(names(sheet, sheet.lastHighlight) == ["DiscountRate", "NPV", "Decision"])65 #expect(!sheet.highlighted.contains(unrelated.id))66 }67 #expect(sheet.undoDepth == 1, "a whole drag is one undo step")68 sheet.endContinuousEdit()69 sheet.setParameterValue(rate.id, 0, continuous: true)70 #expect(sheet.undoDepth == 2)71 #expect(value(sheet, "NPV") == -5000)72 sheet.undo(); sheet.undo()73 #expect(sheet.document == original)74 // out-of-range values are clamped by the slider path, and widen the range through the exact field75 sheet.setParameterValue(rate.id, 5)76 #expect(sheet.cell(rate.id)?.parameter?.value == 0.3)77 sheet.setParameterExact(rate.id, 0.5)78 #expect(sheet.cell(rate.id)?.parameter?.value == 0.5 && sheet.cell(rate.id)?.parameter?.maximum == 0.5)79 #expect(close(value(sheet, "NPV"), npv(0.5)))80 }8182 @Test func oneHundredDependentsStayFastWhileDragging() throws {83 var cells: [WorkspaceCell] = [.parameter("k", value: 1, range: 0...10, step: 0.01)]84 for i in 0..<100 { cells.append(.formula("v\(i) = k * \(i + 1) + sqrt(k + \(i))")) }85 for i in 0..<50 { cells.append(.formula("u\(i) = \(i) * 3")) }86 let sheet = SheetModel(document: WorkspaceDocument(cells: cells), app: makeApp())87 let k = sheet.cells[0].id88 let ticks = 10089 // baseline: the engine alone, same sequence90 var engine = WorkspaceEngine(document: WorkspaceDocument(cells: cells))91 let engineStart = ContinuousClock.now92 for t in 1...ticks { engine.setParameter(cells[0].id, value: Double(t) * 0.1) }93 let enginePerTick = (ContinuousClock.now - engineStart) / ticks94 let start = ContinuousClock.now95 for t in 1...ticks { sheet.setParameterValue(k, Double(t) * 0.1, continuous: true) }96 let perTick = (ContinuousClock.now - start) / ticks97 print("WORKSPACE-PERF engine alone: \(enginePerTick) per tick")98 #expect(sheet.lastHighlight.count == 101, "the parameter and its 100 dependents, not the 50 unrelated cells")99 #expect(close(value(sheet, "v99"), 10 * 100 + (10.0 + 99).squareRoot()))100 #expect(sheet.undoDepth == 1)101 print("WORKSPACE-PERF 100 dependents: \(perTick) per slider tick")102 // The model must add next to nothing to the engine's own incremental recalculation (measured: about 38 ms per tick in a103 // Debug build and 7 ms in Release on the simulator, almost all of it inside WorkspaceEngine.setParameter).104 #expect(perTick < enginePerTick * 2 + .milliseconds(5), "model \(perTick) vs engine \(enginePerTick)")105 #if !DEBUG106 #expect(perTick < .milliseconds(16), "one tick must fit in a frame; measured \(perTick)")107 #endif108 }109110 @Test func errorsAreExplained() throws {111 let sheet = SheetModel(document: WorkspaceDocument(cells: [.formula("a = b + 1"), .formula("b = a + 1"), .formula("c = 1/0"), .formula("d = c + 1")]), app: makeApp())112 #expect(sheet.result(sheet.cells[0].id)?.error?.description == "Circular reference: a → b → a")113 #expect(sheet.result(sheet.cells[3].id)?.error?.description == "Depends on “c”, which has an error")114 #expect(sheet.accessibilityDescription(sheet.cells[2]) == "c, error: Division by zero")115 }116117 @Test func nativesOfTheAppAreAvailableInCells() {118 let app = makeApp()119 app.registerNatives([NativeFunction(name: "triple", arity: 1...1, summary: "3x") { $0[0] * 3 }])120 let sheet = SheetModel(document: WorkspaceDocument(cells: [.formula("y = triple(7)")]), app: app)121 #expect(value(sheet, "y") == 21)122 sheet.setSource(sheet.cells[0].id, "y = triple(8)")123 sheet.undo(); sheet.redo()124 #expect(value(sheet, "y") == 24, "natives survive undo and redo")125 }126127 @Test func descriptionsForReadingAndVoiceOver() throws {128 let sheet = SheetModel(document: npvDocument(), app: makeApp())129 let npvCell = try #require(sheet.cellDefining("NPV"))130 let spoken = sheet.accessibilityDescription(npvCell)131 #expect(spoken.hasPrefix("NPV equals −19") && spoken.hasSuffix("dollars, exact, verified"), "\(spoken)")132 #expect(sheet.dependencySummary(npvCell.id) == "Uses: Investment, DiscountRate, CashFlow1, CashFlow2, CashFlow3 · Used by: Decision")133 #expect(sheet.dependencySummary(try #require(sheet.cellDefining("Unrelated")).id) == "")134 #expect(sheet.usedBy(try #require(sheet.cellDefining("Investment")).id).map(sheet.label) == ["NPV"])135 #expect(sheet.dependents(of: try #require(sheet.cellDefining("Investment")).id).map(sheet.label) == ["NPV", "Decision"])136 // readable mathematics only when it adds something137 #expect(sheet.readableFormula(try #require(sheet.cellDefining("Investment"))) == nil)138 #expect(sheet.readableFormula(npvCell) == nil, "superscripts and spacing alone are not a meaningful difference")139 let id = sheet.addCell(.formula)140 sheet.setSource(id, "Radius = sqrt(2) * pi")141 #expect(sheet.readableFormula(try #require(sheet.cell(id))) == "Radius = √(2) · π")142 #expect(SheetModel.plainMath("a · (1 + r)² − b ÷ c¹²") == "a*(1+r)^2-b/c^12")143 #expect(sheet.expressionText(try #require(sheet.cellDefining("Unrelated"))) == "2 + 2")144 #expect(SheetModel.headingText("# Title") == "Title" && SheetModel.headingText("Plain") == nil)145 }146}147148@MainActor @Suite struct SheetStructureTests {149 @Test func addCellsOfEveryKind() throws {150 let sheet = SheetModel(document: WorkspaceDocument(cells: [.formula("a = 2")]), app: makeApp())151 for kind in CellKind.allCases {152 let id = sheet.addCell(kind)153 #expect(sheet.selection == id && sheet.scrollTarget == id && sheet.lastHighlight == [id])154 #expect(sheet.result(id)?.error == nil, "\(kind) default content must be valid")155 }156 #expect(sheet.cells.map(\.kind) == [.formula, .formula, .parameter, .table, .graph, .text])157 // insertion goes right after the given anchor158 let first = sheet.cells[0].id159 let inserted = sheet.addCell(.formula, after: first)160 #expect(sheet.index(of: inserted) == 1)161 // parameters get distinct names162 let p2 = sheet.addCell(.parameter)163 #expect(sheet.cell(p2)?.parameter?.name == "Parameter2")164 #expect(sheet.result(p2)?.error == nil)165 #expect(sheet.result(sheet.cells.first { $0.kind == .table }!.id)?.table?.count == 11)166 }167168 @Test func duplicateRenamesDefinitions() throws {169 let sheet = SheetModel(document: npvDocument(), app: makeApp())170 let cf1 = try #require(sheet.cellDefining("CashFlow1"))171 let copy = try #require(sheet.duplicate(cf1.id))172 #expect(sheet.index(of: copy) == sheet.index(of: cf1.id)! + 1)173 #expect(sheet.cell(copy)?.source == "CashFlow4 = 25000" && sheet.cell(copy)?.unit == "$")174 #expect(sheet.result(copy)?.error == nil && sheet.result(copy)?.value?.doubleValue == 25000)175 let rate = try #require(sheet.cells.first { $0.kind == .parameter })176 let rateCopy = try #require(sheet.duplicate(rate.id))177 #expect(sheet.cell(rateCopy)?.parameter?.name == "DiscountRate2")178 let note = try #require(sheet.duplicate(sheet.cells[0].id))179 #expect(sheet.cell(note)?.source == "Capital budgeting example")180 #expect(sheet.cells.allSatisfy { sheet.result($0.id)?.error == nil })181 }182183 @Test func deleteReportsDependentsAndMoveReorders() throws {184 let sheet = SheetModel(document: npvDocument(), app: makeApp())185 let investment = try #require(sheet.cellDefining("Investment"))186 sheet.selection = investment.id187 sheet.remove(investment.id)188 #expect(sheet.cellDefining("Investment") == nil && sheet.selection == nil && sheet.cells.count == 8)189 #expect(names(sheet, sheet.lastHighlight) == ["NPV", "Decision"])190 #expect(sheet.result(try #require(sheet.cellDefining("NPV")).id)?.error == .unknownVariable("Investment"))191 sheet.undo()192 #expect(close(value(sheet, "NPV"), npv(0.08)))193194 let order = sheet.cells.map(\.id)195 sheet.moveDown(order[0])196 #expect(sheet.cells.map(\.id) == [order[1], order[0]] + order[2...])197 sheet.moveUp(order[0])198 #expect(sheet.cells.map(\.id) == order)199 sheet.move(from: IndexSet(integer: 8), to: 0)200 #expect(sheet.cells.first?.id == order[8])201 #expect(!sheet.canMove(order[8], by: -1) && sheet.canMove(order[8], by: 1))202 #expect(close(value(sheet, "NPV"), npv(0.08)), "order does not change values")203 }204205 @Test func settingsUnitsGroupsAndSpecs() throws {206 let sheet = SheetModel(document: WorkspaceDocument(cells: [.formula("s = sin(90)"), .parameter("p", value: 5, range: 0...10, step: 1),207 .table(TableSpec(expression: "p * x")), .graph(GraphSpec(expressions: ["p * x"]))]), app: makeApp())208 var settings = sheet.settings209 settings.angleMode = .degrees210 sheet.setSettings(settings)211 #expect(value(sheet, "s") == 1)212 sheet.setUnit(sheet.cells[0].id, "m"); sheet.setGroup(sheet.cells[0].id, "Inputs"); sheet.setTitle(" Renamed ")213 #expect(sheet.cells[0].unit == "m" && sheet.cells[0].group == "Inputs" && sheet.title == "Renamed")214 let p = sheet.cells[1]215 sheet.updateParameter(p.id, ParameterSpec(name: "q", value: 50, minimum: 20, maximum: 10, step: -1))216 #expect(sheet.cell(p.id)?.parameter == ParameterSpec(name: "q", value: 20, minimum: 10, maximum: 20, step: 0), "range is put in order and the value kept inside")217 #expect(sheet.result(sheet.cells[2].id)?.error == .unknownVariable("p"))218 sheet.updateTable(sheet.cells[2].id, TableSpec(expression: "q * x", variable: " ", start: 1, step: 2, count: 3))219 #expect(sheet.result(sheet.cells[2].id)?.table?.map(\.y) == [20, 60, 100])220 #expect(sheet.tableCSV(sheet.cells[2].id) == "x,q * x\r\n1,20\r\n3,60\r\n5,100\r\n")221 sheet.updateGraph(sheet.cells[3].id, GraphSpec(expressions: ["q * x", "x^2"], variable: "x", xMin: 5, xMax: -5))222 #expect(sheet.cells[3].graph?.xMin == -5 && sheet.cells[3].graph?.xMax == 5)223 #expect(sheet.result(sheet.cells[3].id)?.dependencies == ["q"])224 #expect(sheet.undoDepth == 7)225 }226}227228@MainActor @Suite struct SheetUndoTests {229 @Test func undoAndRedoRestoreDocumentsExactly() throws {230 let sheet = SheetModel(document: npvDocument(), app: makeApp())231 var states = [sheet.document]232 func record(_ change: () -> Void) { change(); states.append(sheet.document) }233 let rate = sheet.cells[2].id234 record { sheet.setSource(sheet.cells[1].id, "Investment = 90000") }235 record { sheet.setParameterValue(rate, 0.1) }236 record { sheet.addCell(.table) }237 record { sheet.duplicate(sheet.cells[3].id) }238 record { sheet.move(from: IndexSet(integer: 0), to: 4) }239 record { sheet.remove(sheet.cells[5].id) }240 record { sheet.setTitle("Edited") }241 record { var s = sheet.settings; s.complexEnabled = true; sheet.setSettings(s) }242 record { sheet.setUnit(sheet.cells[0].id, "CAD") }243 #expect(sheet.undoDepth == states.count - 1)244 for expected in states.dropLast().reversed() {245 sheet.undo()246 #expect(sheet.document == expected)247 }248 #expect(!sheet.canUndo && sheet.redoDepth == states.count - 1)249 #expect(close(value(sheet, "NPV"), npv(0.08)), "results are recomputed for the restored document")250 for expected in states.dropFirst() {251 sheet.redo()252 #expect(sheet.document == expected)253 }254 #expect(!sheet.canRedo)255 // a new edit after an undo discards the redo branch256 sheet.undo()257 sheet.setSource(sheet.cells[1].id, "z = 1")258 #expect(!sheet.canRedo)259 }260261 @Test func depthIsAtLeastFifty() {262 let sheet = SheetModel(document: WorkspaceDocument(cells: [.formula("a = 0")]), app: makeApp())263 let original = sheet.document264 for i in 1...60 { sheet.setSource(sheet.cells[0].id, "a = \(i)") }265 #expect(sheet.undoDepth == 60)266 for _ in 1...60 { sheet.undo() }267 #expect(sheet.document == original)268 for i in 1...150 { sheet.setSource(sheet.cells[0].id, "a = \(i)") }269 #expect(sheet.undoDepth == SheetModel.undoLimit)270 }271272 @Test func unchangedEditsDoNotCreateUndoSteps() {273 let sheet = SheetModel(document: npvDocument(), app: makeApp())274 sheet.setSource(sheet.cells[1].id, "Investment = 100000")275 sheet.setUnit(sheet.cells[1].id, "$")276 sheet.setTitle("Project NPV")277 sheet.setSettings(sheet.settings)278 sheet.setParameterValue(sheet.cells[2].id, 0.08)279 #expect(!sheet.canUndo && sheet.revision == 0)280 }281}282283@MainActor @Suite struct SheetEditingTests {284 @Test func draftCommitAndHistory() throws {285 let app = makeApp()286 let sheet = SheetModel(document: npvDocument(), app: app)287 var changes = 0288 sheet.onChange = { changes += 1 }289 let cf2 = try #require(sheet.cellDefining("CashFlow2"))290 #expect(sheet.draft(cf2.id) == "CashFlow2 = 30000")291 sheet.beginEditing(cf2.id)292 #expect(sheet.selection == cf2.id)293 sheet.setDraft(cf2.id, "CashFlow2 = 35000")294 #expect(sheet.draft(cf2.id) == "CashFlow2 = 35000" && sheet.cell(cf2.id)?.source == "CashFlow2 = 30000", "the document changes on commit, not on every keystroke")295 sheet.commitEditing()296 #expect(sheet.editingID == nil && sheet.cell(cf2.id)?.source == "CashFlow2 = 35000" && changes == 1)297 #expect(app.history.first?.input == "CashFlow2 = 35000" && app.history.first?.mode == .workspace && app.history.first?.display == "35\(app.numberFormat.groupingSeparator)000 $")298 // committing an unchanged draft does nothing299 sheet.beginEditing(cf2.id); sheet.commitEditing()300 #expect(changes == 1 && app.history.count == 1)301 // starting another cell commits the first; cancel discards302 sheet.setDraft(cf2.id, "CashFlow2 = 36000")303 let cf1 = try #require(sheet.cellDefining("CashFlow1"))304 sheet.beginEditing(cf1.id)305 #expect(sheet.cell(cf2.id)?.source == "CashFlow2 = 36000")306 sheet.setDraft(cf1.id, "garbage ((")307 sheet.cancelEditing()308 #expect(sheet.cell(cf1.id)?.source == "CashFlow1 = 25000")309 }310311 @Test func insertTokensAtTheCaret() throws {312 let sheet = SheetModel(document: npvDocument(), app: makeApp())313 let id = sheet.addCell(.formula)314 sheet.insertToken("ignored") // not editing: nothing happens315 sheet.beginEditing(id)316 sheet.insertToken("Total")317 sheet.insertToken(" = ")318 sheet.insertToken("CashFlow1")319 sheet.insertToken(" × ")320 sheet.insertToken("π")321 #expect(sheet.editingText == "Total = CashFlow1 × π")322 // with a caret in the middle, the token goes there and the caret moves after it323 let caret = sheet.editingText.index(sheet.editingText.startIndex, offsetBy: 8)324 sheet.editingSelection = TextSelection(insertionPoint: caret)325 sheet.insertToken("2 × ")326 #expect(sheet.editingText == "Total = 2 × CashFlow1 × π")327 sheet.insertToken("(")328 #expect(sheet.editingText == "Total = 2 × (CashFlow1 × π")329 sheet.editingSelection = nil330 sheet.insertToken(")")331 sheet.commitEditing()332 #expect(close(value(sheet, "Total"), 2 * 25000 * Double.pi))333 }334335 @Test func demoSheetsDoNotWriteHistory() throws {336 let app = makeApp()337 let sheet = SheetModel(document: npvDocument(), app: app, isDemo: true)338 sheet.beginEditing(sheet.cells[1].id)339 sheet.setDraft(sheet.cells[1].id, "Investment = 1")340 sheet.commitEditing()341 #expect(value(sheet, "Investment") == 1 && app.history.isEmpty)342 }343}344