javier
1382f33ae6
This PR contains the work done to: * Implemented a basic `Hummingbird` application in which to integrate the `HummingbirdDocC` library. * Added the *ArgumentParser* package dependency to the `Package.swift` file; * Added a new *sample* target to the `Package.swift` file; * Added library and documentation tasks to the `Makefile` file. Reviewed-on: #4 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
52 lines
1.7 KiB
Swift
52 lines
1.7 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// 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 struct HummingbirdCore.URI
|
|
|
|
/// A use case that checks whether a given URI against a set of conditions, to determine whether the URI could be used by the middleware or not.
|
|
struct CheckURIUseCase {
|
|
|
|
// MARK: Properties
|
|
|
|
/// A root path that prefixes the documentation resource.
|
|
private let uriRoot: String
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Initializes this use case.
|
|
///
|
|
/// > important: It is assumed that the `uriRoot` parameter is not empty and that it is prefixed by the `/` character.
|
|
///
|
|
/// - Parameter uriRoot: A root path that prefixes the documentation resource.
|
|
init(uriRoot: String) {
|
|
self.uriRoot = uriRoot
|
|
}
|
|
|
|
// MARK: Functions
|
|
|
|
/// Checks whether a provided URI against a set of conditions, so it could be used by the middleware.
|
|
/// - Parameter uri: A URI to check.
|
|
/// - Returns: A non-encoded URI, which is ready to be used by the middleware.
|
|
func callAsFunction(_ uri: URI) -> String? {
|
|
guard
|
|
let uriPath = uri.path.removingPercentEncoding,
|
|
uriPath.hasPrefix(uriRoot),
|
|
!uriPath.contains(.Path.previousFolder)
|
|
else {
|
|
return nil
|
|
}
|
|
|
|
return uriPath
|
|
}
|
|
|
|
}
|