Implemented the PrepareURIPathUseCase use case type in the library target.

2025-09-23 15:19:16 +02:00
parent 0d76afb738
commit 2f701ce95e
3 changed files with 283 additions and 0 deletions
@@ -0,0 +1,154 @@
+// ===----------------------------------------------------------------------===
+//
+// This source file is part of the Hummingbird DocC Middleware open source project
+//
+// Copyright (c) 2025 Röck+Cöde VoF. and the Hummingbird DocC Middleware project authors
+// Licensed under the EUPL 1.2 or later.
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of Hummingbird DocC Middleware project authors
+//
+// ===----------------------------------------------------------------------===
+
+import Testing
+
+@testable import struct DocCMiddleware.PrepareURIPathUseCase
+
+@Suite("Prepare URI Path Use Case", .tags(.useCase))
+struct PrepareURIPathUseCaseTests {
+    
+    // MARK: Use case tests
+
+#if swift(>=6.2)
+    @Test(arguments: zip(
+        Input.prepareURIPaths,
+        Output.prepareURIPaths
+    ))
+    func `extract data with URI root not suffixed with forward slash`(
+        uri uriPath: String,
+        expects result: PrepareURIPathUseCase.PreparedURIPaths?
+    ) throws {
+        try assertData(
+            uriRoot: .uriRoot,
+            uriPath: uriPath,
+            expects: result
+        )
+    }
+    
+    @Test(arguments: zip(
+        Input.prepareURIPathsSlashed,
+        Output.prepareURIPaths
+    ))
+    func `extract data with URI root suffixed with forward slash`(
+        uri uriPath: String,
+        expects result: PrepareURIPathUseCase.PreparedURIPaths?
+    ) throws {
+        try assertData(
+            uriRoot: .uriRootSlashed,
+            uriPath: uriPath,
+            expects: result
+        )
+    }
+#else
+    @Test("extract data with URI root not suffixed with forward slash", arguments: zip(
+        Input.prepareURIPaths,
+        Output.prepareURIPaths
+    ))
+    func dataWithURIRootNotSuffixedWithForwardSlash(
+        uri uriPath: String,
+        expects result: PrepareURIPathUseCase.PreparedURIPaths?
+    ) throws {
+        try assertData(
+            uriRoot: .uriRoot,
+            uriPath: uriPath,
+            expects: result
+        )
+    }
+    
+    @Test("extract data with URI root suffixed with forward slash", arguments: zip(
+        Input.prepareURIPathsSlashed,
+        Output.prepareURIPaths
+    ))
+    func dataWithURIRootSuffixedWithForwardSlash(
+        uri uriPath: String,
+        expects result: PrepareURIPathUseCase.PreparedURIPaths?
+    ) throws {
+        try assertData(
+            uriRoot: .uriRootSlashed,
+            uriPath: uriPath,
+            expects: result
+        )
+    }
+#endif
+
+}
+
+// MARK: - Assertions
+
+private extension PrepareURIPathUseCaseTests {
+    
+    // MARK: Functions
+    
+    /// Asserts the data returned by the ``PrepareURIPathUseCase`` use case based on the given `uriRoot` and `uriPath` URI paths plus
+    /// an expected result.
+    /// - Parameters:
+    ///   - uriRoot: A URI path to initialize the use case with.
+    ///   - uriPath: A URI path to use with the use case.
+    ///   - result: An expected result coming out of the use case.
+    func assertData(
+        uriRoot: String,
+        uriPath: String,
+        expects result: PrepareURIPathUseCase.PreparedURIPaths?
+    ) throws {
+        // GIVEN
+        let useCase = PrepareURIPathUseCase(uriRoot: uriRoot)
+
+        // WHEN
+        let output = useCase(uriPath)
+
+        // THEN
+        if !uriPath.contains(uriRoot) {
+            #expect(output == nil)
+        } else {
+            #expect(output != nil)
+            
+            let data = try #require(output)
+            
+            #expect(data.archiveName == result?.archiveName)
+            #expect(data.archivePath == result?.archivePath)
+            #expect(data.resourcePath == result?.resourcePath)
+        }
+    }
+    
+}
+
+// MARK: - Constants
+
+private extension Input {
+    /// A list of URI paths to match against the root URI path not suffixed with a forward slash.
+    static let prepareURIPaths: [String] = [.uriOffset, .uriRoot, .uriOther]
+    /// A list of URI paths to match against the root URI path suffixed with a forward slash.
+    static let prepareURIPathsSlashed: [String] = [.uriOffsetSlashed, .uriRootSlashed, .uriOther]
+}
+
+private extension Output {
+    /// A list of expected outputs for the URI path samples, regardless their match against suffixed or not suffixed root URI paths.
+    static let prepareURIPaths: [PrepareURIPathUseCase.PreparedURIPaths?] = [
+        ("somearchive", "/SomeArchive.doccarchive", "/SomeArchive/some/content/path"),
+        (.empty, .empty, .forwardSlash),
+        nil
+    ]
+}
+
+private extension String {
+    /// A root URI path to initialize the use case with.
+    static let uriRoot: Self = "/some/path"
+    /// A root URI path suffixed with a forward slash to initialize the use case with.
+    static let uriRootSlashed: Self = "/some/path/"
+    /// A URI path prefixed with a root URI path not suffixed with a forward slash.
+    static let uriOffset: Self = .uriRoot + "/SomeArchive/some/content/path"
+    /// A URI path prefixed with a root URI path suffixed with a forward slash.
+    static let uriOffsetSlashed: Self = .uriRootSlashed + "SomeArchive/some/content/path"
+    /// A URI path not related to any root URI path.
+    static let uriOther: Self = "/some/other/path"
+}