✨ Add support for route modifiers.

connor-ricks · connor-ricks · commit c16e1838e9bf · 2024-09-12T23:26:49.000-04:00
diff --git a/README.md b/README.md
@@ -6,7 +6,6 @@ Build Vapor routes using a declarative syntax langauge similar to how you would
 
 - [Confirmed] Add README usage docs.
 - [Confirmed] Implement Websocket support
-- [Confirmed] Implement RouteModifier support
 - [Maybe] Implement EnvironmentObject style support.
 - [Maybe] Implement Service support 
 
diff --git a/Sources/VaporRouteBuilder/RouteComponents/Groups/Group+Middleware.swift b/Sources/VaporRouteBuilder/RouteComponents/Groups/Group+Middleware.swift
@@ -23,7 +23,7 @@
 import Vapor
 
 extension Group {
-    /// Creates a group of content under a path.
+    /// Groups content under the provided middleware.
     ///
     /// See ``Group.init(middleware:content:)`` for more info.
     public struct Middleware<Middlewares: Collection<any Vapor.Middleware>>: RouteComponent {
diff --git a/Sources/VaporRouteBuilder/RouteComponents/Groups/Group+Path.swift b/Sources/VaporRouteBuilder/RouteComponents/Groups/Group+Path.swift
@@ -23,7 +23,7 @@
 import Vapor
 
 extension Group {
-    /// Creates a group of content under a path.
+    /// Groups content under a provided path.
     ///
     /// See ``Group.init(path:content:)`` for more info.
     public struct Path<Path: Collection<PathComponent>>: RouteComponent {
diff --git a/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/DELETE.swift b/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/DELETE.swift
@@ -44,7 +44,7 @@ public struct DELETE: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: ResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) where Path.Element == PathComponent {
@@ -59,7 +59,7 @@ public struct DELETE: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: AsyncResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) where Path.Element == PathComponent {
@@ -74,7 +74,7 @@ public struct DELETE: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: ResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) {
@@ -89,7 +89,7 @@ public struct DELETE: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: AsyncResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) {
diff --git a/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/GET.swift b/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/GET.swift
@@ -44,7 +44,7 @@ public struct GET: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: ResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) where Path.Element == PathComponent {
@@ -59,7 +59,7 @@ public struct GET: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: AsyncResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) where Path.Element == PathComponent {
@@ -74,7 +74,7 @@ public struct GET: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: ResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) {
@@ -89,7 +89,7 @@ public struct GET: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: AsyncResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) {
diff --git a/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/PATCH.swift b/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/PATCH.swift
@@ -44,7 +44,7 @@ public struct PATCH: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: ResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) where Path.Element == PathComponent {
@@ -59,7 +59,7 @@ public struct PATCH: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: AsyncResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) where Path.Element == PathComponent {
@@ -74,7 +74,7 @@ public struct PATCH: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: ResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) {
@@ -89,7 +89,7 @@ public struct PATCH: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: AsyncResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) {
diff --git a/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/POST.swift b/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/POST.swift
@@ -44,7 +44,7 @@ public struct POST: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: ResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) where Path.Element == PathComponent {
@@ -59,7 +59,7 @@ public struct POST: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: AsyncResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) where Path.Element == PathComponent {
@@ -74,7 +74,7 @@ public struct POST: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: ResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) {
@@ -89,7 +89,7 @@ public struct POST: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: AsyncResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) {
diff --git a/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/PUT.swift b/Sources/VaporRouteBuilder/RouteComponents/HTTPMethods/PUT.swift
@@ -44,7 +44,7 @@ public struct PUT: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: ResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) where Path.Element == PathComponent {
@@ -59,7 +59,7 @@ public struct PUT: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Path: Collection, Response: AsyncResponseEncodable>(
-        path: Path,
+        _ path: Path,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) where Path.Element == PathComponent {
@@ -74,7 +74,7 @@ public struct PUT: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: ResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) throws -> Response
     ) {
@@ -89,7 +89,7 @@ public struct PUT: RouteComponent {
     ///   - use: The closure handler for incoming requests.
     @inlinable
     public init<Response: AsyncResponseEncodable>(
-        path: PathComponent...,
+        _ path: PathComponent...,
         strategy: HTTPBodyStreamStrategy = .collect,
         use: @Sendable @escaping (Request) async throws -> Response
     ) {
diff --git a/Sources/VaporRouteBuilder/RouteModifier.swift b/Sources/VaporRouteBuilder/RouteModifier.swift
@@ -20,50 +20,51 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-// import SwiftUI
-//
-// public protocol MyViewModifier<Body> {
-//    associatedtype Body: View
-//
-//    @ViewBuilder
-//    func body(content: Content) -> Body
-//
-//    typealias Content = ProxyView<Self>
-// }
-//
-// public struct ProxyView<Value> {
-//    let content: AnyView
-//    init(_ content: some View) { self.content = AnyView(content) }
-// }
-//
-// struct TestModifier: MyViewModifier {
-//    func body(content: Content) -> some View {
-//        VStack {
-//            content.content
-//        }
-//    }
-// }
+import Vapor
 
-// import Vapor
-//
-// public protocol MyViewModifier<Body> {
-//    associatedtype Body: RouteComponent
-//
-//    @RouteBuilder
-//    func body(content: Content) -> Body
-//
-//    typealias Content = ProxyView<Self>
-// }
-//
-// public struct ProxyView<Value> {
-//    let content: AnyRouteComponent
-//    init(_ content: some RouteComponent) { self.content = AnyRouteComponent(content) }
-// }
-//
-// struct TestModifier: MyViewModifier {
-//    func body(content: Content) -> some RouteComponent {
-//        Group {
-//            content.content
-//        }
-//    }
-// }
+// MARK: - RouteModifier
+
+/// A modifier that you apply to a route component or another route modifier, producing a different version of the original value.
+///
+/// Adopt the `RouteModifier` protocol when you want to create a reusable modifier that you can apply to any route component.
+public protocol RouteModifier<Body> {
+    associatedtype Body: RouteComponent
+
+    @RouteBuilder
+    func body(content: RouteContent) -> Body
+
+    typealias RouteContent = RouteModifierContent<Self>
+}
+
+// MARK: - RouteModifierContent
+
+public struct RouteModifierContent<Value>: RouteComponent {
+
+    // MARK: Properties
+
+    @usableFromInline
+    let content: AnyRouteComponent
+
+    // MARK: Initializers
+
+    @inlinable
+    init(_ content: some RouteComponent) {
+        self.content = AnyRouteComponent(content)
+    }
+
+    // MARK: Body
+
+    public var body: some RouteComponent {
+        content
+    }
+}
+
+// MARK: - RouteComponent + Modifier
+
+extension RouteComponent {
+    /// Applies a modifier to a route component and returns a new route component.
+    @inlinable
+    public func modifier<Modifier: RouteModifier>(_ modifier: Modifier) -> some RouteComponent {
+        modifier.body(content: RouteModifierContent(self))
+    }
+}
diff --git a/Sources/VaporRouteBuilder/RouteModifiers/RouteComponent+Middleware.swift b/Sources/VaporRouteBuilder/RouteModifiers/RouteComponent+Middleware.swift
@@ -0,0 +1,52 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Connor Ricks
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import Vapor
+
+// MARK: - MiddlewareModifier
+
+/// A route modifier that wraps its content in the provided middleware.
+private struct MiddlewareModifier: RouteModifier {
+
+    // MARK: Properties
+
+    /// The middleware to add to the content.
+    let middleware: [Middleware]
+
+    // MARK: Body
+
+    func body(content: RouteContent) -> some RouteComponent {
+        Group(middleware: middleware) {
+            content
+        }
+    }
+}
+
+// MARK: - RouteComponent + Middleware
+
+extension RouteComponent {
+    /// Modifies the route component by wrapping it in the provided `Middleware`.
+    public func middleware(_ middleware: any Middleware...) -> some RouteComponent {
+        modifier(MiddlewareModifier(middleware: middleware))
+    }
+}
diff --git a/Tests/VaporRouteBuilderTests/RouteComponents/HTTPMethodTests.swift b/Tests/VaporRouteBuilderTests/RouteComponents/HTTPMethodTests.swift
@@ -27,23 +27,23 @@ import XCTVapor
 
 @Suite("HTTPMethodTests Tests") struct HTTPMethodTests {
     @Test func test() async throws {
-        let get = GET(path: "A") { _ in "" }.body as! Route
+        let get = GET("A") { _ in "" }.body as! Route
         #expect(get.method == .GET)
         #expect(get.path == ["A"])
 
-        let post = POST(path: "A") { _ in "" }.body as! Route
+        let post = POST("A") { _ in "" }.body as! Route
         #expect(post.method == .POST)
         #expect(post.path == ["A"])
 
-        let patch = PATCH(path: "A") { _ in "" }.body as! Route
+        let patch = PATCH("A") { _ in "" }.body as! Route
         #expect(patch.method == .PATCH)
         #expect(patch.path == ["A"])
 
-        let put = PUT(path: "A") { _ in "" }.body as! Route
+        let put = PUT("A") { _ in "" }.body as! Route
         #expect(put.method == .PUT)
         #expect(put.path == ["A"])
 
-        let delete = DELETE(path: "A") { _ in "" }.body as! Route
+        let delete = DELETE("A") { _ in "" }.body as! Route
         #expect(delete.method == .DELETE)
         #expect(delete.path == ["A"])
     }
diff --git a/Tests/VaporRouteBuilderTests/RouteModifierTests.swift b/Tests/VaporRouteBuilderTests/RouteModifierTests.swift
diff --git a/Tests/VaporRouteBuilderTests/RouteModifiers/RouteComponent+MiddlewareTests.swift b/Tests/VaporRouteBuilderTests/RouteModifiers/RouteComponent+MiddlewareTests.swift
