Add custom package collection link to custom collections page

Author: finestructure

Sources/App/Controllers/PackageCollectionController.swift

@@ -20,16 +20,34 @@ enum PackageCollectionController {
     static func generate(req: Request) async throws -> SignedCollection {
         AppMetrics.packageCollectionGetTotal?.inc()
 
-        guard let owner = req.parameters.get("owner") else { throw Abort(.notFound) }
+        guard let collectionType = getCollectionType(req: req) else {
+            throw Abort(.notFound)
+        }
 
         do {
-            return try await SignedCollection.generate(
-                db: req.db,
-                filterBy: .author(owner),
-                authorName: "\(owner) via the Swift Package Index"
-            )
+            switch collectionType {
+                case let .author(owner):
+                    return try await SignedCollection.generate(
+                        db: req.db,
+                        filterBy: .author(owner),
+                        authorName: "\(owner) via the Swift Package Index"
+                    )
+                case let .custom(name):
+                    fatalError("FIXME")
+            }
         } catch PackageCollection.Error.noResults {
             throw Abort(.notFound)
         }
     }
+
+    enum CollectionType {
+        case author(String)
+        case custom(String)
+    }
+
+    static func getCollectionType(req: Request) -> CollectionType? {
+        if let owner = req.parameters.get("owner") { return .author(owner) }
+        if let name = req.parameters.get("name") { return .custom(name) }
+        return nil
+    }
 }

Sources/App/Core/Extensions/String+ext.swift

@@ -58,6 +58,10 @@ extension String {
     var pathEncoded: Self {
         replacingOccurrences(of: "/", with: "-")
     }
+
+    var urlPathEncoded: Self {
+        addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? self
+    }
 }
 
 

Sources/App/Core/SiteURL.swift

@@ -121,7 +121,8 @@ enum SiteURL: Resourceable, Sendable {
     case javascripts(String)
     case keywords(_ keyword: Parameter<String>)
     case package(_ owner: Parameter<String>, _ repository: Parameter<String>, PackagePathComponents?)
-    case packageCollection(_ owner: Parameter<String>)
+    case packageCollectionAuthor(_ owner: Parameter<String>)
+    case packageCollectionCustom(_ name: Parameter<String>)
     case packageCollections
     case privacy
     case readyForSwift6
@@ -171,7 +172,7 @@ enum SiteURL: Resourceable, Sendable {
                 return "build-monitor"
 
             case let .collections(.value(name)):
-                return "collections/\(name)"
+                return "collections/\(name.urlPathEncoded)"
 
             case .collections(.key):
                 fatalError("path must not be called with a name parameter")
@@ -208,10 +209,16 @@ enum SiteURL: Resourceable, Sendable {
             case .package:
                 fatalError("invalid path: \(self)")
 
-            case let .packageCollection(.value(owner)):
+            case let .packageCollectionAuthor(.value(owner)):
                 return "\(owner)/collection.json"
 
-            case .packageCollection(.key):
+            case .packageCollectionAuthor(.key):
+                fatalError("invalid path: \(self)")
+
+            case let .packageCollectionCustom(.value(name)):
+                return "collections/\(name.urlPathEncoded)/collection.json"
+
+            case .packageCollectionCustom(.key):
                 fatalError("invalid path: \(self)")
 
             case .packageCollections:
@@ -311,10 +318,16 @@ enum SiteURL: Resourceable, Sendable {
             case .package:
                 fatalError("pathComponents must not be called with a value parameter")
 
-            case .packageCollection(.key):
+            case .packageCollectionAuthor(.key):
                 return [":owner", "collection.json"]
 
-            case .packageCollection(.value):
+            case .packageCollectionAuthor(.value):
+                fatalError("pathComponents must not be called with a value parameter")
+
+            case .packageCollectionCustom(.key):
+                return ["collections", ":name", "collection.json"]
+
+            case .packageCollectionCustom(.value):
                 fatalError("pathComponents must not be called with a value parameter")
 
             case .images, .javascripts, .stylesheets:

Sources/App/Views/Author/AuthorShow+View.swift

@@ -59,7 +59,7 @@ enum AuthorShow {
                 ),
                 .copyableInputForm(buttonName: "Copy Package Collection URL",
                                    eventName: "Copy Package Collection URL Button",
-                                   valueToCopy: SiteURL.packageCollection(.value(model.owner)).absoluteURL()),
+                                   valueToCopy: SiteURL.packageCollectionAuthor(.value(model.owner)).absoluteURL()),
                 .hr(.class("minor")),
                 .ul(
                     .id("package-list"),

Sources/App/Views/CustomCollection/CustomCollectionShow+View.swift

@@ -48,6 +48,18 @@ enum CustomCollectionShow {
                     .class("trimmed"),
                     .text("Packages for collection “\(model.name)”")
                 ),
+                .p(
+                    .text("These packages are available as a package collection, "),
+                    .a(
+                        .href(SiteURL.packageCollections.relativeURL()),
+                        "usable in Xcode 13 or the Swift Package Manager 5.5"
+                    ),
+                    .text(".")
+                ),
+                .copyableInputForm(buttonName: "Copy Package Collection URL",
+                                   eventName: "Copy Package Collection URL Button",
+                                   valueToCopy: SiteURL.packageCollectionCustom(.value(model.name)).absoluteURL()),
+                .hr(.class("minor")),
                 .ul(
                     .id("package-list"),
                     .group(

Sources/App/routes.swift

@@ -84,8 +84,10 @@ func routes(_ app: Application) throws {
         }
     }
 
-    do {  // package collection page
-        app.get(SiteURL.packageCollection(.key).pathComponents,
+    do {  // package collection pages
+        app.get(SiteURL.packageCollectionAuthor(.key).pathComponents,
+                use: PackageCollectionController.generate).excludeFromOpenAPI()
+        app.get(SiteURL.packageCollectionCustom(.key).pathComponents,
                 use: PackageCollectionController.generate).excludeFromOpenAPI()
     }
 

Tests/AppTests/SiteURLTests.swift

@@ -140,9 +140,9 @@ class SiteURLTests: XCTestCase {
     }
 
     func test_packageCollectionURL() throws {
-        XCTAssertEqual(SiteURL.packageCollection(.value("foo")).path,
+        XCTAssertEqual(SiteURL.packageCollectionAuthor(.value("foo")).path,
                        "foo/collection.json")
-        XCTAssertEqual(SiteURL.packageCollection(.key).pathComponents
+        XCTAssertEqual(SiteURL.packageCollectionAuthor(.key).pathComponents
                         .map(\.description),
                        [":owner", "collection.json"])
     }

Tests/AppTests/__Snapshots__/WebpageSnapshotTests/test_CustomCollectionShow.1.html

@@ -83,6 +83,13 @@ <h1>
     <main>
       <div class="inner">
         <h2 class="trimmed">Packages for collection “Some Collection”</h2>
+        <p>These packages are available as a package collection, 
+          <a href="/package-collections">usable in Xcode 13 or the Swift Package Manager 5.5</a>.
+        </p>
+        <form class="copyable-input">
+          <input type="text" data-button-name="Copy Package Collection URL" data-event-name="Copy Package Collection URL Button" value="http://localhost:8080/collections/Some%20Collection/collection.json" readonly/>
+        </form>
+        <hr class="minor"/>
         <ul id="package-list">
           <li>
             <a href="https://example.com/owner/name.git">

Tests/AppTests/__Snapshots__/WebpageSnapshotTests/test_PackageShowView_customCollection.1.html

@@ -169,7 +169,7 @@ <h4>When working with a Swift Package Manager manifest:</h4>
                 <li class="plugins">No plugins</li>
                 <li class="macros">2 macros</li>
                 <li class="custom-collections">
-                  <a href="/collections/Custom Collection">Custom Collection</a>
+                  <a href="/collections/Custom%20Collection">Custom Collection</a>
                 </li>
               </ul>
             </section>