draft implementation of product vertices + product pages

Author: tayloraswift

Sources/SwiftinitPages/CanonicalVersion.Target.swift

@@ -8,6 +8,7 @@ extension CanonicalVersion
         case article(URI?)
         case culture(URI?)
         case decl(URI?)
+        case product(URI?)
         case foreign(URI?)
         case global
     }
@@ -21,6 +22,7 @@ extension CanonicalVersion.Target
         case .article:          "An"
         case .culture:          "A"
         case .decl:             "A"
+        case .product:          "A"
         case .foreign:          "An"
         case .global:           "A"
         }
@@ -32,6 +34,7 @@ extension CanonicalVersion.Target
         case .article:          "article"
         case .culture:          "module"
         case .decl:             "symbol"
+        case .product:          "package product"
         case .foreign:          "extension overlay"
         case .global:           "package"
         }
@@ -43,6 +46,7 @@ extension CanonicalVersion.Target
         case .article:          "name"
         case .culture:          "name"
         case .decl:             "signature"
+        case .product:          "name"
         case .foreign:          "base declaration"
         case .global:           "identity"
         }
@@ -55,6 +59,7 @@ extension CanonicalVersion.Target
         case .article(let uri): uri
         case .culture(let uri): uri
         case .decl(let uri):    uri
+        case .product(let uri): uri
         case .foreign(let uri): uri
         case .global:           nil
         }

Sources/SwiftinitPages/CanonicalVersion.swift

@@ -73,6 +73,9 @@ extension CanonicalVersion
             case .file:
                 return nil
 
+            case .product(let vertex):
+                target = .product(Swiftinit.Docs[volumeOfLatest, vertex.shoot])
+
             case .foreign(let vertex):
                 target = .foreign(Swiftinit.Docs[volumeOfLatest, vertex.shoot])
 
@@ -88,6 +91,7 @@ extension CanonicalVersion
             case .culture?:     target = .culture(nil)
             case .decl?:        target = .decl(nil)
             case .file?, nil:   return   nil
+            case .product?:     target = .product(nil)
             case .foreign?:     target = .foreign(nil)
             case .global?:      target = .global
             }
@@ -109,6 +113,7 @@ extension CanonicalVersion
         case .article(let uri): uri
         case .culture(let uri): uri
         case .decl(let uri):    uri
+        case .product(let uri): uri
         case .foreign(let uri): uri
         case .global:           self.volume
         }

Sources/SwiftinitPages/Contexts/IdentifiablePageContext.Cache.swift

@@ -32,7 +32,7 @@ extension IdentifiablePageContext.Cache where ID:VersionedPageIdentifier
                 return target
             }
             else if
-                let volume:Unidoc.VolumeMetadata = self.volumes[scalar.zone],
+                let volume:Unidoc.VolumeMetadata = self.volumes[scalar.edition],
                 let uri:URI = uri(volume)
             {
                 let target:String = "\(uri)"
@@ -110,6 +110,7 @@ extension IdentifiablePageContext.Cache where ID:VersionedPageIdentifier
                     case .culture(let vertex):  Swiftinit.Docs[$0, vertex.shoot]
                     case .decl(let vertex):     Swiftinit.Docs[$0, vertex.shoot]
                     case .file:                 nil
+                    case .product(let vertex):  Swiftinit.Docs[$0, vertex.shoot]
                     case .foreign(let vertex):  Swiftinit.Docs[$0, vertex.shoot]
                     case .global:               Swiftinit.Docs[$0]
                     }

Sources/SwiftinitPages/Contexts/IdentifiablePageContext.swift

@@ -166,7 +166,7 @@ extension IdentifiablePageContext where ID:VersionedPageIdentifier
     func link(file:Unidoc.Scalar, line:Int? = nil) -> Swiftinit.SourceLink?
     {
         if  let origin:Unidoc.PackageMetadata.Repo.Origin = self.repo?.origin,
-            let refname:String = self.volumes[file.zone]?.refname,
+            let refname:String = self.volumes[file.edition]?.refname,
             let file:Unidoc.Vertex.File = self.vertices[file]?.file,
             let blob:String = origin.blob(refname: refname, file: file.symbol)
         {

Sources/SwiftinitPages/Sections/AutomaticHeading.swift

@@ -8,9 +8,11 @@ enum AutomaticHeading
     case packageDependencies
     case platformRequirements
     case snapshotInformation
+    case allProducts
     case allModules
 
     case miscellaneous
+    case otherProducts
     case otherModules
     case otherMembers
 
@@ -40,9 +42,11 @@ extension AutomaticHeading:Identifiable
         case .packageDependencies:      "ss:package-dependencies"
         case .platformRequirements:     "ss:platform-requirements"
         case .snapshotInformation:      "ss:snapshot-information"
+        case .allProducts:              "ss:all-products"
         case .allModules:               "ss:all-modules"
 
         case .miscellaneous:            "ss:misc"
+        case .otherProducts:            "ss:other-products"
         case .otherModules:             "ss:other-modules"
         case .otherMembers:             "ss:other-members"
 
@@ -73,9 +77,11 @@ extension AutomaticHeading:CustomStringConvertible
         case .packageDependencies:      "Package Dependencies"
         case .platformRequirements:     "Platform Requirements"
         case .snapshotInformation:      "Snapshot Information"
+        case .allProducts:              "Products"
         case .allModules:               "Modules"
 
         case .miscellaneous:            "Miscellaneous"
+        case .otherProducts:            "Other Products"
         case .otherModules:             "Other Modules"
         case .otherMembers:             "Other Members in Extension"
 

Sources/SwiftinitPages/Sections/GroupList.Card.swift

@@ -64,6 +64,15 @@ extension GroupList.Card:HyperTextOutputStreamable
                 $0 ?= self.overview
             }
 
+        case .product(let vertex):
+            html[.li, { $0.class = "product" }]
+            {
+                $0[link: self.target] = vertex.symbol
+
+                //  Should always be nil right now, but eventually we want to support this.
+                $0 ?= self.overview
+            }
+
         case .file, .foreign, .global:
             //  unimplemented
             break

Sources/SwiftinitPages/Sections/GroupSections.swift

@@ -61,7 +61,7 @@ extension GroupSections
         bias:Unidoc.Scalar? = nil,
         mode:Mode? = nil)
     {
-        let container:Unidoc.Scalar?
+        let container:Unidoc.Group.ID?
         let generics:Generics
         if  let vertex:Unidoc.Vertex.Decl = copy vertex
         {
@@ -100,7 +100,7 @@ extension GroupSections
                     continue
                 }
 
-                let partisanship:Partisanship = self.context.volumes.secondary[group.id.zone]
+                let partisanship:Partisanship = self.context.volumes.secondary[group.id.edition]
                     .map
                 {
                     .third($0.symbol.package)
@@ -113,9 +113,7 @@ extension GroupSections
 
                 extensions.append((group, partisanship, genericness))
 
-            case .automatic(let group):
-                //  Guess what kind of autogroup this is by looking at the bit pattern of
-                //  the first member of the group.
+            case .polygon(let group):
                 guard
                 let first:Unidoc.Scalar = group.members.first,
                 let plane:SymbolGraph.Plane = .of(first.citizen)
@@ -127,17 +125,20 @@ extension GroupSections
                 if  first == self.context.id,
                     group.members.count == 1
                 {
-                    //  This is an automatic group that contains this page only.
+                    //  This is a polygon that contains this page only.
                     continue
                 }
 
+                //  Guess what kind of polygon this is by looking at the bit pattern of its
+                //  first vertex.
                 let heading:AutomaticHeading
-
                 switch (plane, self.mode)
                 {
+                case (.product, .meta): heading = .allProducts
+                case (.product, _):     heading = .otherProducts
                 case (.module, .meta):  heading = .allModules
                 case (.module, _):      heading = .otherModules
-                case (_, _):            heading = .miscellaneous
+                default:                heading = .miscellaneous
                 }
 
                 self.other.append((heading, group.members))
@@ -181,11 +182,11 @@ extension GroupSections
     func heading(for extension:Unidoc.Group.Extension) -> ExtensionHeading
     {
         let display:String
-        switch (self.bias, self.bias?.zone)
+        switch (self.bias, self.bias?.edition)
         {
-        case (`extension`.culture?, _): display = "Citizens in "
-        case (_, `extension`.id.zone?): display = "Available in "
-        case (_,                    _): display = "Extension in "
+        case (`extension`.culture?, _):     display = "Citizens in "
+        case (_, `extension`.id.edition?):  display = "Available in "
+        case (_,                    _):     display = "Extension in "
         }
 
         return .init(self.context,

Sources/SwiftinitPages/Surfaces/Vertices/Swiftinit.Docs (ext).swift

@@ -64,6 +64,17 @@ extension Swiftinit.Docs:Swiftinit.VolumeRoot
         case .file:
             throw Unidoc.VertexTypeError.file
 
+        case .product(let vertex):
+            let groups:GroupSections = .init(context.page,
+                organizing: consume groups,
+                bias: vertex.id,
+                mode: nil)
+            let page:Product = .init(context.page,
+                canonical: context.canonical,
+                vertex: vertex,
+                groups: groups)
+            resource = page.resource(format: context.format)
+
         case .foreign(let vertex):
             let groups:GroupSections = .init(context.page,
                 organizing: consume groups,

Sources/SwiftinitPages/Surfaces/Vertices/Swiftinit.Docs.Foreign.swift

@@ -65,7 +65,7 @@ extension Swiftinit.Docs.Foreign:Swiftinit.ApplicationPage
 }
 extension Swiftinit.Docs.Foreign:Swiftinit.VersionedPage
 {
-    var sidebar:Swiftinit.Sidebar<Swiftinit.Docs>? { .package(volume: self.context.volume) }
+    var sidebar:Swiftinit.Sidebar<Swiftinit.Docs>? { .package(volume: self.volume) }
 
     func main(_ main:inout HTML.ContentEncoder, format:Swiftinit.RenderFormat)
     {
@@ -84,7 +84,7 @@ extension Swiftinit.Docs.Foreign:Swiftinit.VersionedPage
         }
 
         let extendee:HTML.Link<String>? = self.context.link(decl: self.vertex.extendee)
-        if  let other:Unidoc.VolumeMetadata = self.context.volumes[self.vertex.extendee.zone]
+        if  let other:Unidoc.VolumeMetadata = self.context.volumes[self.vertex.extendee.edition]
         {
             main[.section, { $0.class = "notice extendee" }]
             {

Sources/SwiftinitPages/Surfaces/Vertices/Swiftinit.Docs.Product.swift

@@ -0,0 +1,58 @@
+import HTML
+import SwiftinitRender
+import UnidocRecords
+import URI
+
+extension Swiftinit.Docs
+{
+    struct Product
+    {
+        let context:IdentifiablePageContext<Unidoc.Scalar>
+
+        let canonical:CanonicalVersion?
+
+        private
+        let vertex:Unidoc.Vertex.Product
+        private
+        let groups:GroupSections
+
+        init(_ context:IdentifiablePageContext<Unidoc.Scalar>,
+            canonical:CanonicalVersion?,
+            vertex:Unidoc.Vertex.Product,
+            groups:GroupSections)
+        {
+            self.context = context
+            self.canonical = canonical
+            self.vertex = vertex
+            self.groups = groups
+        }
+    }
+}
+extension Swiftinit.Docs.Product:Swiftinit.RenderablePage
+{
+    var title:String { "\(self.vertex.symbol) · \(self.volume.title) Products" }
+
+    var description:String?
+    {
+        """
+        \(self.vertex.symbol) is a product available in the package \(self.volume.title)").
+        """
+    }
+}
+extension Swiftinit.Docs.Product:Swiftinit.StaticPage
+{
+    var location:URI { Swiftinit.Docs[self.volume, self.vertex.shoot] }
+}
+extension Swiftinit.Docs.Product:Swiftinit.ApplicationPage
+{
+    typealias Navigator = HTML.Logo
+}
+extension Swiftinit.Docs.Product:Swiftinit.VersionedPage
+{
+    var sidebar:Swiftinit.Sidebar<Swiftinit.Docs>? { .package(volume: self.volume) }
+
+    func main(_ main:inout HTML.ContentEncoder, format:Swiftinit.RenderFormat)
+    {
+        //  TODO: unimplemented
+    }
+}