SPB Git

Repository Public

AutomationReports.swift 5.8 KB 102 lines swift

1// ORIX Docs2// File: Packages/ORIXDocsKit/Sources/DocAutomation/AutomationReports.swift3// Description: Headless document reports shared by the workflow engine, the command-line tool and the Shortcuts actions:4//              audit (with layout facts), statistics, and their JSON and plain-text forms.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import Foundation9import DocModel10import DocContainer11import DocAudit12import DocLayout13import DocReferences1415public enum AutomationReports {16    public static let toolVersion = "1.0.0"1718    // MARK: Audit1920    /// Audits a document the way the application does: with the facts of a real pagination and reference completeness checks.21    public static func audit(_ doc: DocumentModel, profile: AuditProfile = .standard) -> [AuditFinding] {22        let layout = Paginator.layout(doc, citations: CitationEngine(document: doc), options: PDFPublisher.layoutOptions)23        let facts = LayoutFacts(pageCount: layout.pageCount, pageOfBlock: layout.pageOfBlock.mapValues { $0 + 1 }, overflowingTableIDs: layout.overflowingTableIDs)24        return DocumentAuditor.audit(doc, layout: facts, options: profile.options, incompleteReference: { ReferenceChecks.missingFields($0) })25    }2627    struct FindingJSON: Codable {28        var id: String, check: String, severity: String, title: String, explanation: String, evidence: String, suggestion: String29        var page: Int?30        var excerpt: String?31    }32    struct AuditJSON: Codable {33        var tool: String, version: String, input: String, profile: String?34        var summary: AuditSummary35        var findings: [FindingJSON]36    }3738    private static func encoder() -> JSONEncoder {39        let e = JSONEncoder()40        e.outputFormatting = [.prettyPrinted, .sortedKeys, .withoutEscapingSlashes]41        e.dateEncodingStrategy = .iso860142        return e43    }4445    public static func auditJSON(_ findings: [AuditFinding], input: String, profile: AuditProfile? = nil) throws -> Data {46        let items = findings.map {47            FindingJSON(id: $0.id, check: $0.check.rawValue, severity: $0.severity.rawValue, title: $0.title, explanation: $0.explanation, evidence: $0.evidence,48                        suggestion: $0.suggestion, page: $0.location?.page, excerpt: ($0.location?.excerpt).flatMap { $0.isEmpty ? nil : $0 })49        }50        return try encoder().encode(AuditJSON(tool: "orixdocs", version: toolVersion, input: input, profile: profile?.rawValue, summary: AuditSummary(findings), findings: items))51    }5253    public static func auditText(_ findings: [AuditFinding], name: String) -> String {54        let s = AuditSummary(findings)55        var out = "\(name): \(s.errors) error\(s.errors == 1 ? "" : "s"), \(s.warnings) warning\(s.warnings == 1 ? "" : "s"), \(s.infos) note\(s.infos == 1 ? "" : "s")\n"56        for f in findings.sorted(by: { $0.severity > $1.severity }) {57            let page = f.location?.page.map { " (p. \($0))" } ?? ""58            out += "[\(f.severity.rawValue)] \(f.title)\(page)\n"59            if !f.evidence.isEmpty { out += "    \(f.evidence.replacingOccurrences(of: "\n", with: " "))\n" }60            if !f.suggestion.isEmpty { out += "    → \(f.suggestion)\n" }61        }62        return out63    }6465    // MARK: Statistics6667    public struct Statistics: Codable, Sendable, Hashable {68        public var words: Int, characters: Int, charactersNoSpaces: Int, paragraphs: Int, pages: Int69        public var tables: Int, images: Int, equations: Int, footnotes: Int70        public var headings: Int, comments: Int, trackedChanges: Int, citations: Int, references: Int71        /// At 230 words per minute, rounded up.72        public var readingMinutes: Int73        public var title: String, author: String, language: String74    }7576    public static func statistics(_ doc: DocumentModel) -> Statistics {77        let s = DocumentStatistics(doc)78        let numbering = Numbering(doc)79        let pages = Paginator.layout(doc, citations: CitationEngine(document: doc), options: PDFPublisher.layoutOptions).pageCount80        return Statistics(words: s.words, characters: s.characters, charactersNoSpaces: s.charactersNoSpaces, paragraphs: s.paragraphs, pages: pages,81                          tables: s.tables, images: s.images, equations: s.equations, footnotes: s.footnotes, headings: numbering.outline.count,82                          comments: doc.comments.count, trackedChanges: doc.trackedChanges().count, citations: numbering.citedKeys.count,83                          references: doc.bibliography.count, readingMinutes: s.words == 0 ? 0 : max(1, Int((Double(s.words) / 230).rounded(.up))),84                          title: doc.meta.title, author: doc.meta.author, language: doc.meta.language)85    }8687    struct StatisticsJSON: Codable { var tool: String, version: String, input: String; var statistics: Statistics }8889    public static func statisticsJSON(_ stats: Statistics, input: String) throws -> Data {90        try encoder().encode(StatisticsJSON(tool: "orixdocs", version: toolVersion, input: input, statistics: stats))91    }9293    public static func statisticsText(_ s: Statistics, name: String) -> String {94        let rows: [(String, String)] = [95            ("Pages", "\(s.pages)"), ("Words", "\(s.words)"), ("Characters", "\(s.characters)"), ("Characters (no spaces)", "\(s.charactersNoSpaces)"),96            ("Paragraphs", "\(s.paragraphs)"), ("Headings", "\(s.headings)"), ("Tables", "\(s.tables)"), ("Images", "\(s.images)"),97            ("Equations", "\(s.equations)"), ("Footnotes", "\(s.footnotes)"), ("Comments", "\(s.comments)"), ("Tracked changes", "\(s.trackedChanges)"),98            ("Cited sources", "\(s.citations)"), ("References", "\(s.references)"), ("Reading time", "\(s.readingMinutes) min"), ("Language", s.language)]99        return name + "\n" + rows.map { "  \($0.0.padding(toLength: 24, withPad: " ", startingAt: 0))\($0.1)" }.joined(separator: "\n") + "\n"100    }101}102
Files main
Menu

Theme