SPB Git

Repository Public MIT

ExportTests.swift 8.5 KB 155 lines swift

1// ORIX Calc2// File: Packages/ORIXFeatureWorkspace/Tests/ORIXFeatureWorkspaceTests/ExportTests.swift3// Description: Every export produces well-formed output — PDF read back with PDFKit, CSV parsed, PNG decoded, native file round trip.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation8import Testing9import UniformTypeIdentifiers10import ORIXExpression11import ORIXUI12import ORIXWorkspace13@testable import ORIXFeatureWorkspace14#if canImport(UIKit)15import PDFKit16import UIKit17#endif1819/// A small RFC 4180 reader, independent of the exporter.20func parseCSV(_ text: String) -> [[String]] {21    var rows: [[String]] = [], row: [String] = [], field = "", quoted = false22    var i = text.startIndex23    while i < text.endIndex {24        let c = text[i]25        if quoted {26            if c == "\"" {27                let next = text.index(after: i)28                if next < text.endIndex, text[next] == "\"" { field.append("\""); i = next } else { quoted = false }29            } else { field.append(c) }30        } else if c == "\"" { quoted = true }31        else if c == "," { row.append(field); field = "" }32        else if c == "\r\n" || c == "\n" { row.append(field); rows.append(row); row = []; field = "" }33        else { field.append(c) }34        i = text.index(after: i)35    }36    if !field.isEmpty || !row.isEmpty { row.append(field); rows.append(row) }37    return rows38}3940@MainActor @Suite struct ExportTests {41    func demoSheet() -> SheetModel { SheetModel(document: WorkspaceTemplate.capitalBudgeting.document(title: "Project NPV"), app: makeApp()) }4243    @Test func textFormatsComeFromTheExporter() throws {44        let sheet = demoSheet()45        let exporter = WorkspaceExporter(engine: sheet.engine, format: sheet.numberFormat)46        #expect(String(decoding: try WorkspaceExport.data(.text, sheet: sheet), as: UTF8.self) == exporter.plainText())47        #expect(String(decoding: try WorkspaceExport.data(.markdown, sheet: sheet), as: UTF8.self) == exporter.markdown())48        #expect(String(decoding: try WorkspaceExport.data(.latex, sheet: sheet), as: UTF8.self) == exporter.latex())49        let text = exporter.plainText()50        #expect(text.hasPrefix("Project NPV\n") && text.contains("Assumptions"))51        #expect(exporter.markdown().hasPrefix("# Project NPV\n"))52        let latex = exporter.latex()53        #expect(latex.contains("\\begin{document}") && latex.hasSuffix("\\end{document}\n"))54        #expect(ExportContent.assumptions(from: text).count == 4)55        #expect(ExportContent.assumptions(from: text).first == "Angle mode: \(sheet.settings.angleMode.rawValue)")56    }5758    @Test func csvParses() throws {59        let sheet = demoSheet()60        sheet.addCell(.text)61        sheet.setSource(try #require(sheet.cells.last).id, "A note with a comma, a \"quote\"\nand a second line")62        let rows = parseCSV(String(decoding: try WorkspaceExport.data(.csv, sheet: sheet), as: UTF8.self))63        #expect(rows.first == ["Kind", "Name", "Expression", "Value", "Unit", "Exact", "Notes"])64        #expect(rows.allSatisfy { $0.count == 7 })65        let npvRow = try #require(rows.first { $0[1] == "NPV" })66        // the canonical value of an exact result is a fraction: read it as numerator / denominator67        let parts = npvRow[3].split(separator: "/").compactMap { Double($0) }68        #expect(parts.count == 2 && close(parts[0] / parts[1], npv(0.08)), "\(npvRow[3])")69        #expect(npvRow[4] == "$" && npvRow[5] == "yes")70        #expect(rows.filter { $0[0] == "table" }.count == 11)71        #expect(rows.contains { $0[0] == "note" && $0[2] == "A note with a comma, a \"quote\"\nand a second line" })72        #expect(rows.filter { $0[0] == "assumption" }.count == 4)73    }7475    @Test func nativeFileRoundTrips() throws {76        let sheet = demoSheet()77        let data = try WorkspaceExport.data(.native, sheet: sheet)78        let back = try WorkspaceFile.decode(data)79        #expect(back.id == sheet.id && back.cells == sheet.cells && back.title == sheet.title && back.settings == sheet.settings)80        #expect(close(value(SheetModel(document: back, app: makeApp()), "NPV"), npv(0.08)))81    }8283    @Test func filesAreWrittenWithProperNamesAndTypes() throws {84        let sheet = demoSheet()85        sheet.setTitle("Q3: plan / budget?")86        var seen = Set<String>()87        for kind in WorkspaceExportKind.allCases {88            let url = try WorkspaceExport.write(kind, sheet: sheet)89            #expect(url.lastPathComponent == "Q3- plan - budget-.\(kind.fileExtension)")90            #expect(url.path.hasPrefix(FileManager.default.temporaryDirectory.path))91            let size = try #require(try FileManager.default.attributesOfItem(atPath: url.path)[.size] as? Int)92            #expect(size > 0, "\(kind) wrote an empty file")93            #expect(UTType(filenameExtension: kind.fileExtension) != nil)94            seen.insert(kind.fileExtension)95        }96        #expect(seen == ["pdf", "csv", "txt", "md", "tex", "png", "orixcalc"])97        #expect(WorkspaceExportKind.pdf.contentType == .pdf && WorkspaceExportKind.image.contentType == .png && WorkspaceExportKind.csv.contentType == .commaSeparatedText)98        #expect(WorkspaceExport.fileName("  ...  ", .pdf) == "Workspace.pdf")99        let table = try #require(sheet.cells.first { $0.kind == .table })100        let csv = try WorkspaceExport.writeTableCSV(table.id, sheet: sheet)101        let rows = parseCSV(try String(contentsOf: csv, encoding: .utf8))102        #expect(csv.pathExtension == "csv" && rows.count == 12 && rows[0] == ["r", "ProjectValue(r)"])103        #expect(close(Double(rows[5][1]), npv(0.08)))104    }105106    #if canImport(UIKit)107    @Test func pdfIsTypesetTextAndReadsBack() throws {108        let sheet = demoSheet()109        let data = try WorkspaceExport.data(.pdf, sheet: sheet)110        #expect(String(decoding: data.prefix(4), as: UTF8.self) == "%PDF")111        let pdf = try #require(PDFDocument(data: data))112        #expect(pdf.pageCount >= 1)113        let text = try #require(pdf.string)114        #expect(text.contains("Project NPV"))115        #expect(text.contains("Investment = 100000") && text.contains("Assumptions") && text.contains("Angle mode"))116        #expect(text.contains(sheet.valueText(try #require(sheet.cellDefining("NPV")).id)!), "the NPV value is real text in the PDF")117        #expect(text.contains("Page 1 of \(pdf.pageCount)"))118        #expect(pdf.documentAttributes?[PDFDocumentAttribute.titleAttribute] as? String == "Project NPV")119    }120121    @Test func pdfPaginatesLongSheets() throws {122        let sheet = demoSheet()123        let table = try #require(sheet.cells.first { $0.kind == .table })124        sheet.updateTable(table.id, TableSpec(expression: "ProjectValue(r)", variable: "r", start: 0, step: 0.001, count: 300))125        let pdf = try #require(PDFDocument(data: try WorkspaceExport.data(.pdf, sheet: sheet)))126        #expect(pdf.pageCount >= 5, "300 rows need several pages, got \(pdf.pageCount)")127        let all = try #require(pdf.string)128        #expect(all.contains("Assumptions") && all.contains("Page \(pdf.pageCount) of \(pdf.pageCount)"))129        let last = try #require(sheet.result(table.id)?.table?.last)130        #expect(all.contains(sheet.format(last.x)), "the last table row made it into the document")131        let page = try #require(pdf.page(at: 0)).bounds(for: .mediaBox)132        #expect(page.size == WorkspacePDF.pageSize || abs(page.width - WorkspacePDF.pageSize.width) < 1)133    }134135    @Test func pdfShowsErrorsAndWarnings() throws {136        let sheet = SheetModel(document: WorkspaceDocument(title: "Errors", cells: [.formula("a = 1/0"), .formula("b = a + 1"), .text("# Heading"), .text("A note.")]), app: makeApp())137        let text = try #require(PDFDocument(data: try WorkspaceExport.data(.pdf, sheet: sheet))?.string)138        #expect(text.contains("Error: Division by zero") && text.contains("Heading") && text.contains("A note."))139    }140141    @Test func imageIsAPNGOfThePrintLayout() throws {142        let sheet = demoSheet()143        let data = try WorkspaceExport.data(.image, sheet: sheet)144        #expect(Array(data.prefix(8)) == [0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A])145        let image = try #require(UIImage(data: data))146        #expect(image.size.width == WorkspaceImage.width * 2 && image.size.height > 1200)147        try? FileManager.default.createDirectory(atPath: shotsDirectory, withIntermediateDirectories: true)148        try data.write(to: URL(fileURLWithPath: shotsDirectory + "/export-image.png"))149        try WorkspaceExport.data(.pdf, sheet: sheet).write(to: URL(fileURLWithPath: shotsDirectory + "/export.pdf"))150    }151    #endif152}153154let shotsDirectory = "/tmp/orix-workspace-shots"155
Files main
Menu

Theme