Merge pull request #12 from tayloraswift/package-db

Package db

Author: tayloraswift

Package.resolved

@@ -55,7 +55,7 @@ let package:Package = .init(
 
         .library(name: "Unidoc", targets: ["Unidoc"]),
         .library(name: "UnidocAnalysis", targets: ["UnidocAnalysis"]),
-        .library(name: "UnidocDatabase", targets: ["UnidocDatabase"]),
+        .library(name: "UnidocDB", targets: ["UnidocDB"]),
         .library(name: "UnidocDiagnostics", targets: ["UnidocDiagnostics"]),
         .library(name: "UnidocLinker", targets: ["UnidocLinker"]),
         .library(name: "UnidocPages", targets: ["UnidocPages"]),
@@ -73,7 +73,7 @@ let package:Package = .init(
         .package(url: "https://github.com/tayloraswift/swift-grammar", .upToNextMinor(
             from: "0.3.2")),
         .package(url: "https://github.com/tayloraswift/swift-mongodb", .upToNextMinor(
-           from: "0.7.2")),
+            from: "0.8.1")),
 
         .package(url: "https://github.com/swift-server/swift-backtrace", .upToNextMinor(
             from: "1.3.4")),
@@ -372,7 +372,7 @@ let package:Package = .init(
                 .target(name: "UnidocSelectors"),
             ]),
 
-        .target(name: "UnidocDatabase", dependencies:
+        .target(name: "UnidocDB", dependencies:
             [
                 .target(name: "GitHubIntegration"),
                 .target(name: "UnidocAnalysis"),
@@ -407,7 +407,7 @@ let package:Package = .init(
 
         .target(name: "UnidocQueries", dependencies:
             [
-                .target(name: "UnidocDatabase"),
+                .target(name: "UnidocDB"),
                 .target(name: "UnidocSelectors"),
             ]),
 
@@ -423,6 +423,11 @@ let package:Package = .init(
                 .target(name: "URI"),
             ]),
 
+        .target(name: "UnixTime", dependencies:
+            [
+                .product(name: "BSON", package: "swift-mongodb"),
+            ]),
+
         .target(name: "URI", dependencies:
             [
                 .product(name: "Grammar", package: "swift-grammar"),
@@ -557,9 +562,10 @@ let package:Package = .init(
                 .product(name: "BSONTesting", package: "swift-mongodb"),
             ]),
 
-        .executableTarget(name: "UnidocDatabaseTests", dependencies:
+        .executableTarget(name: "UnidocDBTests", dependencies:
             [
-                .target(name: "UnidocDatabase"),
+                .target(name: "UnidocDB"),
+                .target(name: "GitHubClient"),
                 .target(name: "SymbolGraphBuilder"),
                 .target(name: "SymbolGraphTesting"),
                 .product(name: "MongoTesting", package: "swift-mongodb"),

Package.swift

@@ -1,6 +1,6 @@
 <div align="center">
 
-<strong><em><code>unidoc</code></em></strong><br><small><code>0.1.5</code></small>
+<strong><em><code>unidoc</code></em></strong><br><small><code>0.2.0</code></small>
 
 [![ci build status](https://github.com/kelvin13/swift-unidoc/actions/workflows/build.yml/badge.svg)](https://github.com/kelvin13/swift-unidoc/actions/workflows/build.yml)
 

README.md

@@ -105,16 +105,10 @@ extension GitHubClient
 }
 extension GitHubClient<GitHubAPI>
 {
-    public
-    func user(with token:String) async throws -> GitHubAPI.User
-    {
-        try await self.get(from: "/user", with: token)
-    }
-
     @inlinable public
     func get<Response>(_:Response.Type = Response.self,
         from endpoint:String,
-        with token:String? = nil) async throws -> Response where Response:JSONObjectDecodable
+        with token:String? = nil) async throws -> Response where Response:JSONDecodable
     {
         var request:HPACKHeaders =
         [

Sources/GitHubClient/GitHubClient.swift

@@ -0,0 +1,38 @@
+import JSON
+
+extension GitHubAPI.Repo
+{
+    @frozen public
+    struct License:Identifiable, Equatable, Sendable
+    {
+        /// The SPDX identifier of the license.
+        public
+        var id:String
+        /// The full name of the license.
+        public
+        var name:String
+
+        @inlinable public
+        init(id:String, name:String)
+        {
+            self.id = id
+            self.name = name
+        }
+    }
+}
+extension GitHubAPI.Repo.License:JSONObjectDecodable
+{
+    public
+    enum CodingKey:String
+    {
+        case id = "spdx_id"
+        case name
+    }
+
+    public
+    init(json:JSON.ObjectDecoder<CodingKey>) throws
+    {
+        self.init(id: try json[.id].decode(),
+            name: try json[.name].decode())
+    }
+}

Sources/GitHubIntegration/GitHubAPI.Repo.License.swift

@@ -0,0 +1,41 @@
+import JSON
+
+extension GitHubAPI.Repo
+{
+    @frozen public
+    struct Owner:Identifiable, Equatable, Sendable
+    {
+        public
+        let id:Int32
+        public
+        var login:String
+        public
+        var node:String
+
+        @inlinable public
+        init(id:Int32, login:String, node:String)
+        {
+            self.id = id
+            self.login = login
+            self.node = node
+        }
+    }
+}
+extension GitHubAPI.Repo.Owner:JSONObjectDecodable
+{
+    public
+    enum CodingKey:String
+    {
+        case id
+        case login
+        case node = "node_id"
+    }
+
+    public
+    init(json:JSON.ObjectDecoder<CodingKey>) throws
+    {
+        self.init(id: try json[.id].decode(),
+            login: try json[.login].decode(),
+            node: try json[.node].decode())
+    }
+}

Sources/GitHubIntegration/GitHubAPI.Repo.Owner.swift

@@ -0,0 +1,162 @@
+import JSON
+
+extension GitHubAPI
+{
+    @frozen public
+    struct Repo:Identifiable, Equatable, Sendable
+    {
+        public
+        let id:Int32
+        public
+        var owner:Owner
+        public
+        var name:String
+        public
+        var node:String
+
+        /// The repo’s license, if GitHub was able to detect it.
+        public
+        var license:License?
+        /// The repo’s topic tags.
+        public
+        var topics:[String]
+        /// The name of the repo’s default branch.
+        public
+        var master:String
+
+        /// The number of subscribers this repo has.
+        public
+        var watchers:Int
+        /// The number of forks this repo has.
+        public
+        var forks:Int
+        /// The number of stargazers this repo has.
+        public
+        var stars:Int
+        /// The approximate size of the repo, in kilobytes.
+        public
+        var size:Int
+
+        /// Indicates if the repo is archived.
+        public
+        var archived:Bool
+        /// Indicates if the repo is disabled.
+        public
+        var disabled:Bool
+        /// Indicates if the repo is a fork.
+        public
+        var fork:Bool
+
+        /// The repo’s homepage URL, if set.
+        public
+        var homepage:String?
+        /// The repo’s description, if set.
+        public
+        var about:String?
+
+        /// When the repository was first created.
+        public
+        var created:String
+        /// When the repository itself (as opposed to its content) was last updated.
+        /// This is usually different from ``pushed``.
+        public
+        var updated:String
+        /// When the repository content (as opposed to its metadata) was last pushed to.
+        /// This is usually different from ``updated``.
+        public
+        var pushed:String
+
+        @inlinable public
+        init(id:Int32,
+            owner:Owner,
+            name:String,
+            node:String,
+            license:License? = nil,
+            topics:[String] = [],
+            master:String,
+            watchers:Int,
+            forks:Int,
+            stars:Int,
+            size:Int,
+            archived:Bool,
+            disabled:Bool,
+            fork:Bool,
+            homepage:String? = nil,
+            about:String? = nil,
+            created:String,
+            updated:String,
+            pushed:String)
+        {
+            self.id = id
+            self.owner = owner
+            self.name = name
+            self.node = node
+            self.license = license
+            self.topics = topics
+            self.master = master
+            self.watchers = watchers
+            self.forks = forks
+            self.stars = stars
+            self.size = size
+            self.archived = archived
+            self.disabled = disabled
+            self.fork = fork
+            self.homepage = homepage
+            self.about = about
+            self.created = created
+            self.updated = updated
+            self.pushed = pushed
+        }
+    }
+}
+extension GitHubAPI.Repo:JSONObjectDecodable
+{
+    public
+    enum CodingKey:String
+    {
+        case id
+        case owner
+        case name
+        case node = "node_id"
+        case license
+        case topics
+        case master = "default_branch"
+        // not `watchers_count`, which is just stargazers
+        case watchers = "subscribers_count"
+        case forks = "forks_count"
+        case stars = "stargazers_count"
+        case size = "size"
+        case archived = "archived"
+        case disabled = "disabled"
+        case fork = "fork"
+        case homepage = "homepage"
+        case about = "description"
+        case created = "created_at"
+        case updated = "updated_at"
+        case pushed = "pushed_at"
+    }
+
+    public
+    init(json:JSON.ObjectDecoder<CodingKey>) throws
+    {
+        self.init(id: try json[.id].decode(),
+            owner: try json[.owner].decode(),
+            name: try json[.name].decode(),
+            node: try json[.node].decode(),
+            license: try json[.license]?.decode(),
+            topics: try json[.topics]?.decode() ?? [],
+            master: try json[.master].decode(),
+            watchers: try json[.watchers].decode(),
+            forks: try json[.forks].decode(),
+            stars: try json[.stars].decode(),
+            size: try json[.size].decode(),
+            archived: try json[.archived].decode(),
+            disabled: try json[.disabled].decode(),
+            fork: try json[.fork].decode(),
+            homepage: try json[.homepage]?.decode(as: String.self) { $0.isEmpty ? nil : $0 },
+            about: try json[.about]?.decode(as: String.self) { $0.isEmpty ? nil : $0 },
+            created: try json[.created].decode(),
+            updated: try json[.updated].decode(),
+            pushed: try json[.pushed].decode())
+    }
+}

Sources/GitHubIntegration/GitHubAPI.Repo.swift

@@ -0,0 +1,27 @@
+import JSON
+import SHA1
+
+extension GitHubAPI.Tag
+{
+    struct Commit
+    {
+        let sha:SHA1
+
+        init(sha:SHA1)
+        {
+            self.sha = sha
+        }
+    }
+}
+extension GitHubAPI.Tag.Commit:JSONObjectDecodable
+{
+    enum CodingKey:String
+    {
+        case sha
+    }
+
+    init(json:JSON.ObjectDecoder<CodingKey>) throws
+    {
+        self.init(sha: try json[.sha].decode())
+    }
+}