SPB Git

Repository Public

KitTests.swift 18.3 KB 354 lines swift

1import Foundation2import Testing3import SheetCore4import SheetCharts5import SheetUI6import Statistics7@testable import AnalysisKit89@MainActor func makeSession(_ rows: [[String]], sheets: [String] = ["Data"]) -> WorkbookSession {10    let session = WorkbookSession(workbook: Workbook(sheetNames: sheets), locale: Locale(identifier: "en_US"))11    session.perform("Fill") { e in12        for (r, row) in rows.enumerated() { for (c, text) in row.enumerated() where !text.isEmpty {13            try? e.setInput(sheet: 0, row: r, col: c, text, parser: session.parser)14        } }15    }16    session.engine.clearUndoHistory()17    return session18}1920/// Every cell of every sheet as text (value, formula flag, style), to compare workbook states.21func snapshot(_ wb: Workbook) -> [String] {22    var out = [String]()23    for s in wb.sheets {24        var cells = [String]()25        s.cells.forEachAll { r, c, cell in26            if cell.hasContent || cell.style != 0 { cells.append("\(r),\(c)=\(cell.computed)|\(cell.formula != nil)|\(wb.styles[cell.style].hashValue)") }27        }28        out.append(s.name + ":" + cells.sorted().joined(separator: ";") + "|objects=\(s.meta.objects.count)|widths=\(s.meta.colWidths.count)")29    }30    return out31}3233@MainActor @Suite struct DataFrameTests {34    let session = makeSession([35        ["Height", "Weight", "Group", ""],36        ["1.5", "60", "a", ""],37        ["", "72.5", "b", ""],38        ["text", "=B2+B3", "a", ""],39        ["1.9", "=1/0", "", ""],40    ])4142    @Test func readsHeadersNumbersAndMissingValues() throws {43        let area = try #require(RangeReader.resolve("A1:C5", workbook: session.workbook, sheet: 0))44        let f = try #require(RangeReader.read(engine: session.engine, area: area, hasHeader: true))45        #expect(f.names == ["Height", "Weight", "Group"])46        #expect(f.rowCount == 4)47        #expect(f.firstDataRow == 1)48        let h = f.columns[0]49        #expect(h.numericCount == 2 && h.textCount == 1 && h.blankCount == 1 && h.missingCount == 2)50        #expect(h.numbers[0] == 1.5 && h.numbers[1].isNaN && h.numbers[2].isNaN && h.numbers[3] == 1.9)51        #expect(h.present == [1.5, 1.9])52        let w = f.columns[1]53        #expect(w.numbers[2] == 132.5)            // formula value54        #expect(w.numbers[3].isNaN)               // error value is missing55        #expect(w.isNumeric && !f.columns[2].isNumeric)56        #expect(f.columns[2].labels == ["a", "b", "a", ""])57        #expect(f.label == "Data!A1:C5")58    }5960    @Test func withoutHeaderUsesColumnLetters() throws {61        let area = try #require(RangeReader.resolve("A2:B5", workbook: session.workbook, sheet: 0))62        let f = try #require(RangeReader.read(engine: session.engine, area: area, hasHeader: false))63        #expect(f.names == ["A", "B"])64        #expect(f.rowCount == 4 && f.firstDataRow == 1)65    }6667    @Test func wholeColumnsAreClippedToTheUsedRange() throws {68        let area = try #require(RangeReader.resolve("A:B", workbook: session.workbook, sheet: 0))69        let f = try #require(RangeReader.read(engine: session.engine, area: area, hasHeader: true))70        #expect(f.range == RangeRef(a1: "A1:B5"))71        #expect(RangeReader.guessHeader(workbook: session.workbook, area: area))72    }7374    @Test func invalidReferencesAreRejected() {75        #expect(RangeReader.resolve("not a range", workbook: session.workbook, sheet: 0) == nil)76        #expect(RangeReader.resolve("", workbook: session.workbook, sheet: 0) == nil)77        #expect(RangeReader.cells("B2, C3:C4", workbook: session.workbook, sheet: 0)?.map(\.cell.a1) == ["B2", "C3", "C4"])78        #expect(RangeReader.cells("B2, ???", workbook: session.workbook, sheet: 0) == nil)79        #expect(RangeReader.cells("Z99", workbook: session.workbook, sheet: 0)?.first?.cell == CellRef(a1: "Z99"))80    }8182    @Test func listwiseDeletionAndExpansion() throws {83        let (rows, cols) = DataFrame.listwise([[1, .nan, 3, 4], [10, 20, .nan, 40]])84        #expect(rows == [0, 3])85        #expect(cols == [[1, 4], [10, 40]])86        let area = try #require(RangeReader.resolve("A1:C5", workbook: session.workbook, sheet: 0))87        let f = try #require(RangeReader.read(engine: session.engine, area: area, hasHeader: true))88        #expect(f.expand([7, 8], rows: [0, 3]) == [.number(7), .blank, .blank, .number(8)])89    }9091    @Test func columnDefaultsFollowTheRange() throws {92        let tool = ToolDescriptor(id: "t", title: "T", group: "G", systemImage: "sum", summary: "", fields: [93            .range("data", "Data"), .column("y", "Y"), .columns("x", "X"), .column("g", "Group", numeric: false, optional: true),94        ]) { _ in ToolResult(title: "T", blocks: []) }95        var v = FormValues(defaults: tool.fields)96        session.select(RangeRef(a1: "B3")!)97        ToolInputResolver.preset(tool, values: &v, session: session)98        #expect(v.range("data") == RangeValue(text: "A1:C5", hasHeader: true))99        #expect(v.columnIndex("y") == 0)100        #expect(v.columnIndices("x") == [1])101        #expect(v.columnIndex("g") == nil)102        let input = try ToolInputResolver.resolve(tool, values: v, session: session)103        #expect(try input.column("y").name == "Height")104        #expect(try input.columns("x").map(\.name) == ["Weight"])105        #expect(input.optionalColumn("g") == nil)106        v.set("data", range: "nope")107        #expect(throws: ToolError.self) { try ToolInputResolver.resolve(tool, values: v, session: session) }108    }109}110111@Suite struct FormattingTests {112    let en = Locale(identifier: "en_US"), fr = Locale(identifier: "fr_CA")113114    @Test func numbersUseTheLocale() {115        #expect(Fmt.number(1234.5678, locale: en) == "1,234.57")116        #expect(Fmt.number(0.123456, locale: en) == "0.1235")117        #expect(Fmt.number(0.5, locale: fr) == "0,5000")118        #expect(Fmt.number(12, locale: en) == "12")119        #expect(Fmt.number(.nan) == "—")120        #expect(Fmt.fixed(-0.00001, 2, locale: en) == "-0.00" || Fmt.fixed(-0.00001, 2, locale: en) == "0.00")121    }122123    @Test func pValues() {124        #expect(Fmt.p(0.00003, locale: en) == "< 0.0001")125        #expect(Fmt.p(0.0421, locale: en) == "0.0421")126        #expect(Fmt.p(0.0421, locale: fr) == "0,0421")127        #expect(Fmt.p(.nan) == "—")128    }129130    @Test func formatCodes() {131        #expect(CellFormat.auto.code(for: 12) == "0")132        #expect(CellFormat.auto.code(for: 0.25) == "0.0000")133        #expect(CellFormat.auto.code(for: 12345.6) == "#,##0.00")134        #expect(CellFormat.percent(2).code(for: 0.1) == "0.00%")135        #expect(CellFormat.pValue.code(for: 0.01) == "0.0000")136        #expect(CellFormat.money.code(for: 1) == "#,##0.00")137        #expect(CellFormat.fixed(2).code(for: 5000) == "#,##0.00")138    }139140    @Test func autoFormatIsConsistentInsideAColumn() {141        let t = ReportTable(rows: [[.text("Stat"), .text("A"), .text("B")], [.text("Mean"), .number(16), .number(16.9)], [.text("n"), .number(120), .number(118)]],142                            rowFormats: [2: .integer])143        let d = t.displayRows(locale: en)144        #expect(d[1] == ["Mean", "16.0000", "16.9000"])145        #expect(d[2] == ["n", "120", "118"])146    }147148    @Test func numberLists() {149        #expect(FormValues.numberList("0.05, 0.06; 7%", locale: en) == [0.05, 0.06, 0.07])150        #expect(FormValues.numberList("0,05; 0,06", locale: fr) == [0.05, 0.06])151        #expect(FormValues.numberList("a, b", locale: en) == nil)152        #expect(FormValues.numberList("", locale: en) == nil)153    }154155    @Test func decisionsAreWordedCarefully() {156        let reject = Interpret.decision(p: 0.012, alpha: 0.05, locale: en)157        let keep = Interpret.decision(p: 0.4, alpha: 0.05, locale: en)158        #expect(reject.contains("reject the null hypothesis") && !reject.contains("fail"))159        #expect(keep.contains("fail to reject the null hypothesis"))160        #expect(!keep.lowercased().contains("accept"))161    }162}163164@MainActor @Suite struct ReportWriterTests {165    func sampleResult() -> ToolResult {166        var table = ReportTable(title: "Coefficients", rows: [167            [.text("Term"), .text("Estimate"), .text("p-value")],168            [.text("Intercept"), .number(1.25), .number(0.00001)],169            [.text("Slope"), .number(2000.5), .number(0.2)],170        ], columnFormats: [2: .pValue])171        table.note = "A note"172        let chart = ChartBlock(title: "Fit", spec: ChartKit.lines([.init("y", [1, 2, 4], x: [10, 20, 30], lower: [0, 1, 3], upper: [2, 3, 5])], xTitle: "x", yTitle: "y"), summary: "A line.")173        return ToolResult(title: "Regression", subtitle: "Data!A1:B5", blocks: [174            .metrics([Metric("R²", 0.9123, .fixed(4)), Metric("Method", text: "OLS")]),175            .table(table), .interpretation("Reject."), .chart(chart),176        ], sheetName: "Reg/Report")177    }178179    @Test func writesAFormattedReportOnANewSheetAsOneUndoStep() throws {180        let session = makeSession([["x", "y"], ["1", "2"]])181        let before = snapshot(session.workbook)182        let o = ReportWriter.write(sampleResult(), to: .newSheet, includeCharts: true, session: session)183        let wb = session.workbook184        #expect(wb.sheets.count == 2 && o.sheet == 1)185        #expect(wb.sheets[1].name == "Reg Report")               // forbidden characters replaced186        let sh = wb.sheets[1]187        #expect(sh.value(0, 0) == .text("Regression"))188        #expect(wb.styles[sh.styleID(0, 0)].bold)189        #expect(sh.value(1, 0) == .text("Data!A1:B5"))190        #expect(sh.value(3, 0) == .text("R²") && sh.value(3, 1) == .number(0.9123))191        #expect(wb.styles[sh.styleID(3, 1)].numberFormat == "0.0000")192        #expect(sh.value(4, 1) == .text("OLS"))193        #expect(sh.value(6, 0) == .text("Coefficients"))194        // header row: bold with a bottom rule195        #expect(sh.value(7, 1) == .text("Estimate"))196        let header = wb.styles[sh.styleID(7, 1)]197        #expect(header.bold && header.borders.bottom != nil && header.hAlign == .right)198        #expect(sh.value(8, 1) == .number(1.25) && wb.styles[sh.styleID(8, 1)].numberFormat == "0.0000")199        #expect(wb.styles[sh.styleID(9, 1)].numberFormat == "#,##0.00")200        #expect(wb.styles[sh.styleID(8, 2)].numberFormat == "0.0000")201        #expect(sh.value(10, 0) == .text("A note") && wb.styles[sh.styleID(10, 0)].italic)202        #expect(sh.value(12, 0) == .text("Reject."))203        // chart: data block written and object bound to it204        #expect(o.chartCount == 1 && sh.meta.objects.count == 1)205        let spec = try #require(ChartSpec(sheetObject: sh.meta.objects[0]))206        guard case .range(let name, let rg)? = spec.series[0].values else { Issue.record("values not bound"); return }207        #expect(name == "Reg Report" && rg.rows == 3)208        #expect(sh.value(rg.r0, rg.c0) == .number(1) && sh.value(rg.r1, rg.c0) == .number(4))209        guard case .range(_, let xr)? = spec.series[0].x, case .range? = spec.series[0].lower, case .range? = spec.series[0].upper else { Issue.record("x / band not bound"); return }210        #expect(sh.value(xr.r1, xr.c0) == .number(30))211        #expect(sh.meta.colWidths[0] == 230)212        // one undo restores everything213        #expect(session.engine.canUndo)214        session.undo()215        #expect(snapshot(session.workbook) == before)216        #expect(session.workbook.sheets.count == 1)217        #expect(!session.engine.canUndo)218        session.redo()219        #expect(session.workbook.sheets.count == 2 && session.workbook.sheets[1].value(0, 0) == .text("Regression"))220    }221222    @Test func writesAtACellWithoutChartsAndUndoRestores() {223        let session = makeSession([["x", "y"], ["1", "2"]])224        let before = snapshot(session.workbook)225        let o = ReportWriter.write(sampleResult(), to: .cell(CellAddress(sheet: 0, cell: CellRef(a1: "D3")!)), includeCharts: false, session: session)226        let sh = session.workbook.sheets[0]227        #expect(o.sheet == 0 && o.range.topLeft == CellRef(a1: "D3"))228        #expect(sh.value(2, 3) == .text("Regression"))229        #expect(sh.value(0, 0) == .text("x"))                    // existing data untouched230        #expect(sh.meta.objects.isEmpty && o.chartCount == 0)231        session.undo()232        #expect(snapshot(session.workbook) == before)233    }234235    @Test func uniqueSheetNames() {236        let wb = Workbook(sheetNames: ["Summary", "Summary 2"])237        #expect(ReportWriter.uniqueSheetName("Summary", in: wb) == "Summary 3")238        #expect(ReportWriter.uniqueSheetName("A very long report name that exceeds the limit", in: wb).count <= 31)239        #expect(ReportWriter.uniqueSheetName("[x]", in: wb) == "x")240    }241242    @Test func appendsColumnsNextToTheData() throws {243        let session = makeSession([["x", "y", "", "busy"], ["1", "2"], ["3", "4"], ["5", "6"]])244        let area = try #require(RangeReader.resolve("A1:B4", workbook: session.workbook, sheet: 0))245        let frame = try #require(RangeReader.read(engine: session.engine, area: area, hasHeader: true))246        let before = snapshot(session.workbook)247        let rg = ReportWriter.appendColumns(session: session, label: "Residuals", frame: frame, names: ["Fitted", "Residual"],248                                            columns: [[.number(1), .blank, .number(3)], [.number(0.1), .blank, .number(0.3)]])249        // column C is free but D is not: the block goes to E:F250        #expect(rg == RangeRef(a1: "E1:F4"))251        let sh = session.workbook.sheets[0]252        #expect(sh.value(0, 4) == .text("Fitted") && sh.value(0, 5) == .text("Residual"))253        #expect(sh.value(1, 4) == .number(1) && sh.value(2, 4).isBlank && sh.value(3, 5) == .number(0.3))254        #expect(session.engine.undoLabel == "Residuals")255        session.undo()256        #expect(snapshot(session.workbook) == before)257    }258}259260@MainActor @Suite struct ToolRunnerTests {261    func tools(slow: Bool = false) -> [ToolDescriptor] {262        [ToolDescriptor(id: "mean", title: "Mean", group: "G", systemImage: "sum", summary: "", fields: [.range("data", "Data"), .column("x", "X")]) { input in263            if slow {264                for i in 0..<400 { input.progress(Double(i) / 400); try input.checkCancelled(); Thread.sleep(forTimeInterval: 0.005) }265            }266            let x = try input.column("x").present267            return ToolResult(title: "Mean", blocks: [.metrics([Metric("Mean", Descriptive.mean(x))])])268        }]269    }270271    @Test func runsOffTheMainActorAndWritesTheReport() async throws {272        let session = makeSession([["v"], ["2"], ["4"], ["9"]])273        let model = ToolSessionModel(studio: "s", tools: tools())274        session.select(RangeRef(a1: "A1:A4")!)275        model.prepare("mean", session: session)276        let state = await model.run("mean", session: session)277        guard case .done(let result) = state, case .metrics(let m)? = result.blocks.first else { Issue.record("no result: \(state)"); return }278        #expect(m[0].value == .number(5))279        let count = session.engine.changeCount280        model.writeReport("mean", session: session)281        #expect(session.workbook.sheets.count == 2)282        #expect(session.workbook.sheets[1].value(2, 1) == .number(5))283        #expect(session.engine.changeCount > count)284        #expect(model.status?.contains("Mean") == true)285    }286287    @Test func reportsInvalidInputWithoutRunning() async {288        let session = makeSession([["v"], ["2"]])289        let model = ToolSessionModel(studio: "s", tools: tools())290        var v = model.formValues("mean"); v.set("data", range: ""); model.setValues(v, for: "mean")291        let state = await model.run("mean", session: session)292        guard case .failed = state else { Issue.record("expected a failure"); return }293        #expect(!session.engine.canUndo)294    }295296    @Test func cancellationLeavesTheWorkbookUntouched() async {297        let session = makeSession([["v"], ["2"], ["4"]])298        let model = ToolSessionModel(studio: "s", tools: tools(slow: true))299        session.select(RangeRef(a1: "A1:A3")!)300        model.prepare("mean", session: session)301        let before = snapshot(session.workbook)302        let changes = session.engine.changeCount303        async let outcome = model.run("mean", session: session)304        try? await Task.sleep(nanoseconds: 150_000_000)305        #expect(model.isRunning)306        model.cancel()307        guard case .cancelled = await outcome else { Issue.record("expected cancellation"); return }308        #expect(snapshot(session.workbook) == before && session.engine.changeCount == changes && !model.isRunning)309    }310311    @Test func modelSnapshotIsIsolatedFromTheLiveWorkbook() throws {312        let session = makeSession([["10", "=A1*2"]])313        var tool = tools()[0]314        tool.fields = []315        tool.needsModel = true316        let input = try ToolInputResolver.resolve(tool, values: FormValues(), session: session)317        let model = try input.requireModel()318        model.set(sheet: 0, row: 0, col: 0, .value(.number(50)))319        model.recalculate()320        #expect(model.workbook.sheets[0].value(0, 1) == .number(100))321        #expect(session.workbook.sheets[0].value(0, 1) == .number(20))322        #expect(!session.engine.canUndo)323    }324}325326@Suite struct ChartKitTests {327    @Test func specsCarryLiteralDataAndRender() throws {328        let specs = [329            ChartKit.histogram([1, 2, 2, 3, 3, 3, 4], xTitle: "x", yTitle: "n"),330            ChartKit.binned(edges: [0, 1, 2], counts: [3, 4], xTitle: "x", yTitle: "n"),331            ChartKit.lines([.init("a", [1, 2, 3])], xTitle: "t", yTitle: "y"),332            ChartKit.scatter([("s", [1, 2, 3], [2, 4, 5])], xTitle: "x", yTitle: "y", horizontal: [0]),333            ChartKit.columns(categories: ["1", "2"], series: [("acf", [0.5, -0.2])], xTitle: "lag", yTitle: "r", bounds: 0.3),334            ChartKit.tornado(inputs: ["a", "b"], deltaLow: [-5, -2], deltaHigh: [4, 3], lowName: "low", highName: "high", valueTitle: "Δ"),335            ChartKit.bars(categories: ["a", "b"], values: [3, 1], xTitle: "v"),336        ]337        for spec in specs {338            let png = ChartRenderer.pngData(spec, source: LiteralDataSource(), size: CGSize(width: 420, height: 260), scale: 1)339            #expect((png?.count ?? 0) > 1000)340            #expect(try ChartSpec.decoded(from: spec.encoded()) == spec)341        }342        let qq = ChartKit.normalQQ([3, 1, 2])343        #expect(qq.ordered == [1, 2, 3] && qq.theoretical.count == 3 && abs(qq.theoretical[1]) < 1e-12)344    }345}346347@Suite struct LocalizationTests {348    @Test func catalogHasCanadianFrench() throws {349        let fr = try #require(AnalysisLocalization.localized(kitBundle, "fr-CA"))350        #expect(fr.localizedString(forKey: "Run", value: "Run", table: nil) == "Exécuter")351        #expect(fr.localizedString(forKey: "p-value", value: nil, table: nil) == "Valeur p")352    }353}354
Files main
Menu

Theme