Merge pull request #19 from tayloraswift/tag-api

Merge PackageDB into UnidocDB

Author: tayloraswift

README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-<strong><em><code>unidoc</code></em></strong><br><small><code>0.2.4</code></small>
+<strong><em><code>unidoc</code></em></strong><br><small><code>0.2.5</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)
 

Sources/UnidocAnalysis/Volume (ext).swift

@@ -10,18 +10,18 @@ extension Volume
     func siteMap() -> SiteMap<PackageIdentifier>
     {
         var lines:[UInt8] = []
-        for master:Volume.Master in self.vertices
+        for vertex:Vertex in self.vertices
         {
-            switch master
+            switch vertex
             {
-            case .culture(let master):
-                master.shoot.serialize(into: &lines) ; lines.append(0x0A)
+            case .culture(let vertex):
+                vertex.shoot.serialize(into: &lines) ; lines.append(0x0A)
 
-            case .article(let master):
-                master.shoot.serialize(into: &lines) ; lines.append(0x0A)
+            case .article(let vertex):
+                vertex.shoot.serialize(into: &lines) ; lines.append(0x0A)
 
-            case .decl(let master):
-                master.shoot.serialize(into: &lines) ; lines.append(0x0A)
+            case .decl(let vertex):
+                vertex.shoot.serialize(into: &lines) ; lines.append(0x0A)
 
             case .file, .meta:
                 continue
@@ -37,27 +37,27 @@ extension Volume
         var procs:[Unidoc.Scalar: [Shoot]] = [:]
         var types:Types = .init()
 
-        for master:Master in self.vertices
+        for vertex:Vertex in self.vertices
         {
-            switch master
+            switch vertex
             {
-            case .culture(let master):
-                modules[master.id] = master.module.id
+            case .culture(let vertex):
+                modules[vertex.id] = vertex.module.id
 
-            case .article(let master):
-                types[master.culture, master.id] = .init(shoot: master.shoot)
+            case .article(let vertex):
+                types[vertex.culture, vertex.id] = .init(shoot: vertex.shoot)
 
-            case .decl(let master):
-                switch master.phylum
+            case .decl(let vertex):
+                switch vertex.phylum
                 {
                 case .actor, .class, .struct, .enum, .protocol, .macro(.attached):
-                    types[master.culture, master.id] = .init(
-                        shoot: master.shoot,
-                        scope: master.scope.last)
+                    types[vertex.culture, vertex.id] = .init(
+                        shoot: vertex.shoot,
+                        scope: vertex.scope.last)
 
                 case .func(nil), .var(nil), .macro(.freestanding):
                     //  Global procedures show up in search, but not in the type tree.
-                    procs[master.culture, default: []].append(master.shoot)
+                    procs[vertex.culture, default: []].append(vertex.shoot)
 
                 case _:
                     continue

Sources/UnidocDB/DatabaseCollation.swift

@@ -0,0 +1,8 @@
+import MongoDB
+
+public
+protocol DatabaseCollation
+{
+    static
+    var spec:Mongo.Collation { get }
+}

Sources/UnidocDB/DatabaseCollection.swift

@@ -63,6 +63,15 @@ extension DatabaseCollection
 
         print("note: recreated \(response.indexesAfter - 1) indexes in \(Self.name)")
     }
+
+    /// Drops the collection and reinitializes it by calling ``setup(with:)``.
+    func replace(with session:Mongo.Session) async throws
+    {
+        try await session.run(
+            command: Mongo.Drop.init(Self.name),
+            against: self.database)
+        try await self.setup(with: session)
+    }
 }
 extension DatabaseCollection
 {
@@ -380,14 +389,3 @@ extension DatabaseCollection<Unidoc.Scalar>
         let _:Mongo.Deletions = try response.deletions()
     }
 }
-extension DatabaseCollection
-{
-    /// Drops the collection and reinitializes it by calling ``setup(with:)``.
-    func replace(with session:Mongo.Session) async throws
-    {
-        try await session.run(
-            command: Mongo.Drop.init(Self.name),
-            against: self.database)
-        try await self.setup(with: session)
-    }
-}

Sources/UnidocDB/DatabaseModel.swift

@@ -4,22 +4,11 @@ import MongoQL
 public
 protocol DatabaseModel:Identifiable<Mongo.Database>, Equatable, Sendable
 {
-    static
-    var collation:Mongo.Collation { get }
-
     init(id:Mongo.Database)
 
     func setup(with session:Mongo.Session) async throws
 }
 extension DatabaseModel
-{
-    @inlinable public static
-    var collation:Mongo.Collation
-    {
-        .init(locale: "simple", normalization: true) // normalize unicode on insert
-    }
-}
-extension DatabaseModel
 {
     public static
     func setup(as id:Mongo.Database, in pool:__owned Mongo.SessionPool) async -> Self

Sources/UnidocDB/DatabaseQuery.swift

@@ -2,9 +2,9 @@ import BSONDecoding
 import MongoDB
 
 public
-protocol DatabaseQuery<Database, Output>:Sendable
+protocol DatabaseQuery<Collation, Output>:Sendable
 {
-    associatedtype Database:DatabaseModel
+    associatedtype Collation:DatabaseCollation
     associatedtype Output:BSONDocumentDecodable
 
     func build(pipeline:inout Mongo.Pipeline)
@@ -19,7 +19,7 @@ extension DatabaseQuery
     {
         .init(self.origin, pipeline: .init(with: self.build(pipeline:)))
         {
-            $0[.collation] = Database.collation
+            $0[.collation] = Collation.spec
             $0[.hint] = self.hint
         }
     }