Added package collections to the keyword result pages

Author: luis-gustavo

Sources/App/Controllers/PackageCollectionController.swift

@@ -32,6 +32,15 @@ enum PackageCollectionController {
                         filterBy: .author(owner),
                         authorName: "\(owner) via the Swift Package Index"
                     )
+                case let .keyword(keyword):
+                    return try await SignedCollection.generate(
+                        db: req.db,
+                        filterBy: .keyword(keyword),
+                        authorName: "Swift Package Index",
+                        collectionName: keyword,
+                        keywords: [keyword],
+                        overview: "A custom package collection generated by the Swift Package Index"
+                    )
                 case let .custom(key):
                     let collection = try await CustomCollection.find(on: req.db, key: key)
                         .unwrap(or: Abort(.notFound))
@@ -50,11 +59,13 @@ enum PackageCollectionController {
 
     enum CollectionType {
         case author(String)
+        case keyword(String)
         case custom(String)
     }
 
     static func getCollectionType(req: Request) -> CollectionType? {
         if let owner = req.parameters.get("owner") { return .author(owner) }
+        if let keyword = req.parameters.get("keyword") { return .keyword(keyword) }
         if let key = req.parameters.get("key") { return .custom(key) }
         return nil
     }

Sources/App/Core/PackageCollection+VersionResult.swift

@@ -55,6 +55,8 @@ extension PackageCollection.VersionResult {
         switch filter {
             case let .author(owner):
                 query.filter(Repository.self, \Repository.$owner, .custom("ilike"), owner)
+            case let .keyword(keyword):
+                query.filter(Repository.self, \Repository.$keywords, .custom("@>"), [keyword])
             case let .customCollection(key):
                 query
                     .join(CustomCollectionPackage.self, on: \Package.$id == \CustomCollectionPackage.$package.$id)

Sources/App/Core/PackageCollection+generate.swift

@@ -34,6 +34,7 @@ extension PackageCollection {
     enum Filter {
         case urls([String])
         case author(String)
+        case keyword(String)
         case customCollection(String)
     }
 
@@ -98,6 +99,10 @@ extension PackageCollection {
                 return owner
             case (.author, .some(let label)):
                 return label
+            case (.keyword(let keyword), .none):
+                return keyword
+            case (.keyword, .some(let label)):
+                return label
             case (.customCollection(let name), .none):
                 return name
             case (.customCollection, .some(let label)):

Sources/App/Core/PackageCollection+signing.swift

@@ -32,13 +32,13 @@ extension SignedCollection {
                          keywords: [String]? = nil,
                          overview: String? = nil,
                          revision: Int? = nil) async throws -> SignedCollection {
-        let collection  = try await PackageCollection.generate(db: db,
-                                                               filterBy: filter,
-                                                               authorName: authorName,
-                                                               collectionName: collectionName,
-                                                               keywords: keywords,
-                                                               overview: overview,
-                                                               revision: revision)
+        let collection = try await PackageCollection.generate(db: db,
+                                                              filterBy: filter,
+                                                              authorName: authorName,
+                                                              collectionName: collectionName,
+                                                              keywords: keywords,
+                                                              overview: overview,
+                                                              revision: revision)
         return try await sign(collection: collection)
     }
 

Sources/App/Core/SiteURL.swift

@@ -122,6 +122,7 @@ enum SiteURL: Resourceable, Sendable {
     case javascripts(String)
     case keywords(_ keyword: Parameter<String>)
     case package(_ owner: Parameter<String>, _ repository: Parameter<String>, PackagePathComponents?)
+    case packageCollectionKeyword(_ keyword: Parameter<String>)
     case packageCollectionAuthor(_ owner: Parameter<String>)
     case packageCollectionCustom(_ key: Parameter<String>)
     case packageCollections
@@ -211,6 +212,12 @@ enum SiteURL: Resourceable, Sendable {
         case .package:
             fatalError("invalid path: \(self)")
 
+        case let .packageCollectionKeyword(.value(keyword)):
+            return "keywords/\(keyword)/collection.json"
+
+        case .packageCollectionKeyword(.key):
+            fatalError("invalid path: \(self)")
+
         case let .packageCollectionAuthor(.value(owner)):
             return "\(owner)/collection.json"
 
@@ -324,6 +331,12 @@ enum SiteURL: Resourceable, Sendable {
         case .package:
             fatalError("pathComponents must not be called with a value parameter")
 
+        case .packageCollectionKeyword(.key):
+            return ["keywords", ":keyword", "collection.json"]
+
+        case .packageCollectionKeyword(.value):
+            fatalError("pathComponents must not be called with a value parameter")
+
         case .packageCollectionAuthor(.key):
             return [":owner", "collection.json"]
 

Sources/App/Views/Keyword/KeywordShow+View.swift

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

Sources/App/routes.swift

@@ -92,6 +92,8 @@ func routes(_ app: Application) throws {
                 use: PackageCollectionController.generate).excludeFromOpenAPI()
         app.get(SiteURL.packageCollectionCustom(.key).pathComponents,
                 use: PackageCollectionController.generate).excludeFromOpenAPI()
+        app.get(SiteURL.packageCollectionKeyword(.key).pathComponents,
+                use: PackageCollectionController.generate).excludeFromOpenAPI()
     }
 
     do {  // author page

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

@@ -83,6 +83,13 @@ <h1>
     <main>
       <div class="inner">
         <h2 class="trimmed">Packages for keyword “networking”</h2>
+        <p>These packages are available as a package collection, 
+          <a href="/package-collections">usable in Xcode or SwiftPM</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/keywords/networking/collection.json" readonly/>
+        </form>
+        <hr class="minor"/>
         <ul id="package-list">
           <li>
             <a href="https://example.com/owner/name.git">