turn PackageBuildStatus into a type and JSON coding model

Author: tayloraswift

Package.swift

@@ -56,6 +56,7 @@ let package:Package = .init(
 
         .library(name: "Unidoc", targets: ["Unidoc"]),
         .library(name: "UnidocAnalysis", targets: ["UnidocAnalysis"]),
+        .library(name: "UnidocAutomation", targets: ["UnidocAutomation"]),
         .library(name: "UnidocDB", targets: ["UnidocDB"]),
         .library(name: "UnidocDiagnostics", targets: ["UnidocDiagnostics"]),
         .library(name: "UnidocLinker", targets: ["UnidocLinker"]),
@@ -65,6 +66,7 @@ let package:Package = .init(
         .library(name: "UnidocSelectors", targets: ["UnidocSelectors"]),
         .library(name: "URI", targets: ["URI"]),
 
+        .executable(name: "UnidocBuild", targets: ["UnidocBuild"]),
         .executable(name: "UnidocServer", targets: ["UnidocServer"]),
     ],
     dependencies:
@@ -381,6 +383,11 @@ let package:Package = .init(
                 .target(name: "UnidocSelectors"),
             ]),
 
+        .target(name: "UnidocAutomation", dependencies:
+            [
+                .target(name: "JSON"),
+            ]),
+
         .target(name: "UnidocDB", dependencies:
             [
                 .target(name: "GitHubAPI"),
@@ -409,6 +416,7 @@ let package:Package = .init(
                 .target(name: "GitHubAPI"),
                 .target(name: "HTTP"),
                 .target(name: "MarkdownRendering"),
+                .target(name: "UnidocAutomation"),
                 .target(name: "UnidocQueries"),
                 .target(name: "URI"),
             ]),
@@ -452,6 +460,13 @@ let package:Package = .init(
                 .target(name: "SymbolGraphBuilder"),
             ]),
 
+        .executableTarget(name: "UnidocBuild", dependencies:
+            [
+                .target(name: "HTTPClient"),
+                .target(name: "UnidocAutomation"),
+                .target(name: "SymbolGraphBuilder"),
+            ]),
+
         .executableTarget(name: "UnidocServer", dependencies:
             [
                 .target(name: "GitHubClient"),

Sources/JSONEncoding/JSONObjectEncodable.swift

@@ -0,0 +1,17 @@
+import JSONAST
+
+public
+protocol JSONObjectEncodable<CodingKey>:JSONEncodable
+{
+    associatedtype CodingKey:RawRepresentable<String> = JSON.Key
+
+    func encode(to json:inout JSON.ObjectEncoder<CodingKey>)
+}
+extension JSONObjectEncodable
+{
+    @inlinable public
+    func encode(to json:inout JSON)
+    {
+        self.encode(to: &json[as: JSON.ObjectEncoder<CodingKey>.self])
+    }
+}

Sources/UnidocAutomation/PackageBuildStatus.Edition.swift

@@ -0,0 +1,48 @@
+import JSON
+
+extension PackageBuildStatus
+{
+    @frozen public
+    struct Edition:Equatable, Sendable
+    {
+        public
+        let graphs:Int
+        public
+        let tag:String
+
+        @inlinable public
+        init(graphs:Int, tag:String)
+        {
+            self.graphs = graphs
+            self.tag = tag
+        }
+    }
+}
+extension PackageBuildStatus.Edition
+{
+    @frozen public
+    enum CodingKey:String
+    {
+        case graphs
+        case tag
+    }
+}
+extension PackageBuildStatus.Edition:JSONObjectEncodable
+{
+    public
+    func encode(to json:inout JSON.ObjectEncoder<CodingKey>)
+    {
+        json[.graphs] = self.graphs
+        json[.tag] = self.tag
+    }
+}
+extension PackageBuildStatus.Edition:JSONObjectDecodable
+{
+    public
+    init(json:JSON.ObjectDecoder<CodingKey>) throws
+    {
+        self.init(
+            graphs: try json[.graphs].decode(),
+            tag: try json[.tag].decode())
+    }
+}

Sources/UnidocAutomation/PackageBuildStatus.swift

@@ -0,0 +1,51 @@
+import JSON
+
+@frozen public
+struct PackageBuildStatus
+{
+    public
+    let repo:String
+
+    public
+    var release:Edition
+    public
+    var prerelease:Edition?
+
+    @inlinable public
+    init(repo:String, release:Edition, prerelease:Edition? = nil)
+    {
+        self.repo = repo
+        self.release = release
+        self.prerelease = prerelease
+    }
+}
+extension PackageBuildStatus
+{
+    @frozen public
+    enum CodingKey:String
+    {
+        case repo
+        case release
+        case prerelease
+    }
+}
+extension PackageBuildStatus:JSONObjectEncodable
+{
+    public
+    func encode(to json:inout JSON.ObjectEncoder<CodingKey>)
+    {
+        json[.repo] = self.repo
+        json[.release] = self.release
+        json[.prerelease] = self.prerelease
+    }
+}
+extension PackageBuildStatus:JSONObjectDecodable
+{
+    public
+    init(json:JSON.ObjectDecoder<CodingKey>) throws
+    {
+        self.init(repo: try json[.repo].decode(),
+            release: try json[.release].decode(),
+            prerelease: try json[.prerelease]?.decode())
+    }
+}

Sources/UnidocBuild/Main.swift

@@ -0,0 +1,23 @@
+import UnidocAutomation
+import UnidocDB
+import UnidocQueries
+
+extension PackageBuildStatus
+{
+    init?(from output:PackageEditionsQuery.Output)
+    {
+        guard
+        let repo:PackageRepo = output.record.repo,
+        let release:PackageEditionsQuery.Facet = output.releases.first,
+        let release:Edition = .init(from: release)
+        else
+        {
+            return nil
+        }
+
+        self.init(
+            repo: "https://\(repo.origin)",
+            release: release,
+            prerelease: output.prereleases.first.flatMap(Edition.init(from:)))
+    }
+}

Sources/UnidocPages/Responses/PackageBuildStatus (ext).swift

@@ -0,0 +1,10 @@
+import UnidocAutomation
+import UnidocQueries
+
+extension PackageBuildStatus.Edition
+{
+    init?(from output:PackageEditionsQuery.Facet)
+    {
+        self.init(graphs: output.graphs?.count ?? 0, tag: output.edition.name)
+    }
+}

Sources/UnidocPages/Responses/PackageBuildStatus.Edition (ext).swift

@@ -1,7 +1,7 @@
 import HTTP
 import JSON
 import Media
-import UnidocDB
+import UnidocAutomation
 import UnidocQueries
 import URI
 
@@ -13,39 +13,16 @@ extension PackageEditionsQuery.Output:ServerResponseFactory
         switch type
         {
         case .application(.json):
-            let json:JSON = .object
+            guard
+            let status:PackageBuildStatus = .init(from: self)
+            else
             {
-                guard
-                let repo:PackageRepo = self.record.repo,
-                let release:PackageEditionsQuery.Facet = self.releases.first
-                else
-                {
-                    return
-                }
-
-                $0["repo"] = "https://\(repo.origin)"
-
-                $0["release"]
-                {
-                    $0["graphs"] = release.graphs?.count ?? 0
-                    $0["tag"] = release.edition.name
-                }
-
-                guard
-                let prerelease:PackageEditionsQuery.Facet = self.prereleases.first,
-                    prerelease.edition.patch > release.edition.patch
-                else
-                {
-                    return
-                }
-
-                $0["prerelease"]
-                {
-                    $0["graphs"] = prerelease.graphs?.count ?? 0
-                    $0["tag"] = prerelease.edition.name
-                }
+                return .notFound(.init(content: .string(""),
+                    type: .text(.plain, charset: .utf8)))
             }
 
+            let json:JSON = .object(with: status.encode(to:))
+
             return .ok(.init(
                 content: .binary(json.utf8),
                 type: .application(.json, charset: .utf8)))