Merge pull request #1 from connor-ricks/feature/route-modifiers

✨  Add support for route modifiers.

Author: connor-ricks

.swiftlint.yml

@@ -0,0 +1,127 @@
+# SwiftLint configuration file for the Storybook repository.
+# Run `swiftlint --fix` at the root of the repository to format all code.
+
+# MARK: - Settings
+
+#included:
+#    - *.swift
+excluded:
+    - "**/.build"
+
+# If true, SwiftLint will not fail if no lintable files are found.
+allow_zero_lintable_files: false
+
+# If true, SwiftLint will treat all warnings as errors.
+strict: true
+
+# If true, SwiftLint will check for updates after linting or analyzing.
+check_for_updates: true
+
+# reporter type (xcode, json, csv, checkstyle, codeclimate, junit, html, emoji, sonarqube, markdown, github-actions-logging, summary)
+reporter: "xcode"
+
+# MARK: - Rules
+
+disabled_rules:
+    - class_delegate_protocol
+    - cyclomatic_complexity
+    - discouraged_direct_init
+    - duplicate_enum_cases
+    - function_parameter_count
+    - inclusive_language
+    - large_tuple
+    - line_length
+    - multiple_closures_with_trailing_closure
+    - nesting
+    - non_optional_string_data_conversion
+    - notification_center_detachment
+    - shorthand_operator
+    - todo
+    - type_body_length
+    - type_name
+    - void_function_in_ternary
+
+opt_in_rules:
+    - closure_end_indentation
+    - closure_spacing
+    - collection_alignment
+    - comma_inheritance
+    - contains_over_filter_count
+    - contains_over_filter_is_empty
+    - contains_over_first_not_nil
+    - contains_over_range_nil_comparison
+    - convenience_type
+    - discarded_notification_center_observer
+    - discouraged_none_name
+    - discouraged_object_literal
+    - discouraged_optional_boolean
+    - discouraged_optional_collection
+    - empty_collection_literal
+    - empty_count
+    - empty_string
+    - explicit_init
+    - fatal_error_message
+    - file_name_no_space
+    - first_where
+    - identical_operands
+    - implicit_return
+    - indentation_width
+    - joined_default_parameter
+    - last_where
+    - legacy_multiple
+    - literal_expression_end_indentation
+    - lower_acl_than_parent
+    - modifier_order
+    - multiline_arguments
+    - multiline_arguments_brackets
+    - multiline_literal_brackets
+    - multiline_parameters
+    - multiline_parameters_brackets
+    - number_separator
+    - operator_usage_whitespace
+    - optional_enum_case_matching
+    - overridden_super_call
+    - override_in_extension
+    - prefer_self_type_over_type_of_self
+    - prefer_zero_over_explicit_init
+    - private_swiftui_state
+    - raw_value_for_camel_cased_codable_enum
+    - redundant_nil_coalescing
+    - return_value_from_void_function
+    - shorthand_optional_binding
+    - sorted_enum_cases
+    - sorted_first_last
+    - sorted_imports
+    - toggle_bool
+    - unhandled_throwing_task
+    - unneeded_parentheses_in_closure_argument
+    - unowned_variable_capture
+    - vertical_parameter_alignment_on_call
+    - vertical_whitespace_closing_braces
+    - yoda_condition
+
+analyzer_rules:
+    - unused_declaration
+    - unused_import
+
+# MARK: - Config
+
+file_length:
+    warning: 750
+    error: 1500
+    ignore_comment_only_lines: true
+force_cast:
+    severity: warning
+force_try:
+    severity: warning
+function_body_length:
+    warning: 100
+    error: 200
+identifier_name:
+    min_length: 0
+opening_brace:
+    - ignore_multiline_statement_conditions
+trailing_comma:
+    mandatory_comma: true
+unused_declaration:
+    severity: warning

Package.resolved

@@ -27,22 +27,46 @@ import PackageDescription
 let package = Package(
     name: "swift-vapor-route-builder",
     platforms: [
-        .macOS(.v15)
+        .macOS(.v10_15)
     ],
     products: [
         .library(name: "VaporRouteBuilder", targets: ["VaporRouteBuilder"])
     ],
     dependencies: [
-        .package(url: "https://github.com/vapor/vapor.git", from: "4.105.2")
+        .package(url: "https://github.com/vapor/vapor.git", from: "4.105.2"),
+        // TODO: <Connor> This can probably be removed once Swift 6 is officially released.
+        .package(url: "https://github.com/apple/swift-testing", from: "0.12.0"),
     ],
     targets: [
         .target(name: "VaporRouteBuilder", dependencies: [.product(name: "Vapor", package: "vapor")]),
         .testTarget(
             name: "VaporRouteBuilderTests",
             dependencies: [
                 "VaporRouteBuilder",
-                .product(name: "XCTVapor", package: "vapor")
+                .product(name: "XCTVapor", package: "vapor"),
             ]
-        )
+        ),
     ]
 )
+
+#if os(macOS) // Only add SwiftLint on supported platforms.
+package.dependencies.append(contentsOf: [
+    .package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", from: "0.56.2"),
+])
+#endif
+
+for target in package.targets where target.type != .system {
+    #if os(macOS) // Only add SwiftLint on supported platforms.
+    target.plugins = target.plugins ?? []
+    target.plugins?.append(contentsOf: [
+        .plugin(name: "SwiftLintBuildToolPlugin", package: "SwiftLintPlugins")
+    ])
+    #endif
+
+    if case .test = target.type {
+        target.dependencies.append(contentsOf: [
+            // TODO: <Connor> This can probably be removed once Swift 6 is officially released.
+            .product(name: "Testing", package: "swift-testing"),
+        ])
+    }
+}

Package.swift

@@ -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 
 

README.md

@@ -61,7 +61,6 @@ extension Route {
                 _ = try await request.eventLoop.flatSubmit {
                     request.body.collect(max: max?.value ?? request.application.routes.defaultMaxBodySize.value)
                 }.get()
-
             }
             return try await closure(request).encodeResponse(for: request)
         }

Sources/VaporRouteBuilder/Route+Convenience.swift

@@ -52,14 +52,14 @@ public enum RouteBuilder {
     public static func buildEither<TrueContent: RouteComponent, FalseContent: RouteComponent>(
         first content: TrueContent
     ) -> Conditional<TrueContent, FalseContent> {
-        return Conditional.first(content)
+        Conditional.first(content)
     }
 
     @inlinable
     static func buildEither<TrueContent: RouteComponent, FalseContent: RouteComponent>(
         second content: FalseContent
     ) -> Conditional<TrueContent, FalseContent> {
-        return Conditional.second(content)
+        Conditional.second(content)
     }
 
     // MARK: buildOptional

Sources/VaporRouteBuilder/RouteBuilder.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 {

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 a provided path.
     ///
     /// See ``Group.init(path:content:)`` for more info.
     public struct Path<Path: Collection<PathComponent>>: RouteComponent {

Sources/VaporRouteBuilder/RouteComponents/Groups/Group+Path.swift

@@ -205,7 +205,6 @@ public struct Group<Content: RouteComponent>: RouteComponent {
     public func boot(routes: any RoutesBuilder) throws {
         try content.boot(routes: routes)
     }
-
 }
 
 // MARK: - RouteComponents + Group

Sources/VaporRouteBuilder/RouteComponents/Groups/Group.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
     ) {