Merge pull request #2 from MFB-Technologies-Inc/feature/system-FilePath

Begin migration to use System.FilePath for implementation

.devcontainer/devcontainer.json

@@ -1,6 +1,6 @@
 {
 	"name": "PathKit",
-    "image": "swift:5.8",
+    "image": "swift:5.9",
     "features": {
         "ghcr.io/devcontainers/features/common-utils:2": {
             "installZsh": "false",

.github/workflows/ci.yml

@@ -30,8 +30,8 @@ jobs:
     environment: default
     strategy:
       matrix:
-        xcode: ['14.3.1', '15.2']
-        # Swift: 5.8.1  , 5.9.2
+        xcode: ['15.2']
+        # Swift: 5.9.2
     steps:
       - uses: actions/checkout@v3
       - name: Select Xcode ${{ matrix.xcode }}

Package.resolved

@@ -0,0 +1,14 @@
+{
+  "pins" : [
+    {
+      "identity" : "swift-system",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-system.git",
+      "state" : {
+        "revision" : "025bcb1165deab2e20d4eaba79967ce73013f496",
+        "version" : "1.2.1"
+      }
+    }
+  ],
+  "version" : 2
+}

Package.swift

@@ -1,9 +1,9 @@
-// swift-tools-version:5.8
+// swift-tools-version:5.9
 import PackageDescription
 
 let package = Package(
     name: "PathKit",
-    platforms: [.iOS(.v12), .macOS(.v10_13), .watchOS(.v4), .tvOS(.v12), .macCatalyst(.v13)],
+    platforms: [.iOS(.v15), .macOS(.v12), .watchOS(.v8), .tvOS(.v15), .macCatalyst(.v15), .visionOS(.v1)],
     products: [
         .library(name: "PathKit", targets: ["PathKit"]),
     ],
@@ -22,6 +22,15 @@ let package = Package(
     ]
 )
 
+#if !canImport(System)
+    package.dependencies += [.package(url: "https://github.com/apple/swift-system.git", from: "1.2.1")]
+    for target in package.targets {
+        if target.name == "PathKit" {
+            target.dependencies += [Target.Dependency.product(name: "SystemPackage", package: "swift-system")]
+        }
+    }
+#endif
+
 extension [SwiftSetting] {
     static let swiftSix: [SwiftSetting] = [
         .enableUpcomingFeature("BareSlashRegexLiterals"),

Sources/PathKit/Operators.swift

@@ -31,17 +31,17 @@ func + (lhs: String, rhs: String) -> Path {
         // Absolute paths replace relative paths
         return Path(rhs)
     } else {
-        var lSlice = NSString(string: lhs).pathComponents.fullSlice
-        var rSlice = NSString(string: rhs).pathComponents.fullSlice
+        var lSlice = ArraySlice(NSString(string: lhs).pathComponents)
+        var rSlice = ArraySlice(NSString(string: rhs).pathComponents)
 
         // Get rid of trailing "/" at the left side
         if lSlice.count > 1, lSlice.last == Path.separator {
             lSlice.removeLast()
         }
 
         // Advance after the first relevant "."
-        lSlice = lSlice.filter { $0 != "." }.fullSlice
-        rSlice = rSlice.filter { $0 != "." }.fullSlice
+        lSlice = lSlice.filter { $0 != "." }
+        rSlice = rSlice.filter { $0 != "." }
 
         // Eats up trailing components of the left and leading ".." of the right side
         while lSlice.last != "..", !lSlice.isEmpty, rSlice.first == ".." {

Sources/PathKit/Path+Components.swift

@@ -19,7 +19,7 @@ extension Path {
     /// - Returns: the last path component
     ///
     public var lastComponent: String {
-        NSString(string: path).lastPathComponent
+        filePath.lastComponent?.string ?? ""
     }
 
     /// The last path component without file extension
@@ -29,7 +29,7 @@ extension Path {
     /// - Returns: the last path component without file extension
     ///
     public var lastComponentWithoutExtension: String {
-        NSString(string: lastComponent).deletingPathExtension
+        filePath.stem ?? ""
     }
 
     /// Splits the string representation on the directory separator.
@@ -38,19 +38,18 @@ extension Path {
     /// - Returns: all path components
     ///
     public var components: [String] {
-        NSString(string: path).pathComponents
+        if let root = filePath.root {
+            CollectionOfOne(root.string) + filePath.components.map(\.string)
+        } else {
+            filePath.components.map(\.string)
+        }
     }
 
     /// The file extension behind the last dot of the last component.
     ///
     /// - Returns: the file extension
     ///
     public var `extension`: String? {
-        let pathExtension = NSString(string: path).pathExtension
-        if pathExtension.isEmpty {
-            return nil
-        }
-
-        return pathExtension
+        filePath.extension
     }
 }

Sources/PathKit/Path+FileInfo.swift

@@ -59,7 +59,7 @@ extension Path {
     ///
     public var isSymlink: Bool {
         do {
-            try Path.fileManager.destinationOfSymbolicLink(atPath: path)
+            _ = try Path.fileManager.destinationOfSymbolicLink(atPath: path)
             return true
         } catch {
             return false

Sources/PathKit/Path+PathInfo.swift

@@ -19,15 +19,15 @@ extension Path {
     /// - Returns: `true` iff the path begins with a slash
     ///
     public var isAbsolute: Bool {
-        path.hasPrefix(Path.separator)
+        filePath.isAbsolute
     }
 
     /// Test whether a path is relative.
     ///
     /// - Returns: `true` iff a path is relative (not absolute)
     ///
     public var isRelative: Bool {
-        !isAbsolute
+        filePath.isRelative
     }
 
     /// Concatenates relative paths to the current directory and derives the normalized path

Sources/PathKit/Path.swift

@@ -12,21 +12,41 @@
 // LICENSE file in the root directory of this source tree.
 
 import Foundation
+#if canImport(System)
+    import System
+#else
+    import SystemPackage
+
+    extension FilePath: @unchecked Sendable {}
+#endif
 
 /// Represents a filesystem path.
 public struct Path: Sendable {
     /// The character used by the OS to separate two path elements
     public static let separator = "/"
 
+    /// The underlying `FilePath` representation
+    public let filePath: FilePath
+
     /// The underlying string representation
-    let path: String
+    var path: String { filePath.string }
 
     static let fileManager = FileManager.default
 
     let fileSystemInfo: any FileSystemInfo
 
     // MARK: Init
 
+    init(filePath: FilePath, fileSystemInfo: any FileSystemInfo) {
+        self.filePath = filePath
+        self.fileSystemInfo = fileSystemInfo
+    }
+
+    /// Create a Path from a `System.FilePath`
+    public init(filePath: FilePath) {
+        self.init(filePath: filePath, fileSystemInfo: DefaultFileSystemInfo())
+    }
+
     public init() {
         self.init("")
     }
@@ -37,8 +57,7 @@ public struct Path: Sendable {
     }
 
     init(_ path: String, fileSystemInfo: any FileSystemInfo) {
-        self.path = path
-        self.fileSystemInfo = fileSystemInfo
+        self.init(filePath: FilePath(path), fileSystemInfo: fileSystemInfo)
     }
 
     init(fileSystemInfo: any FileSystemInfo) {
@@ -79,24 +98,27 @@ extension Path: ExpressibleByStringLiteral {
 
 extension Path: CustomStringConvertible {
     public var description: String {
-        path
+        filePath.description
+    }
+}
+
+extension Path: CustomDebugStringConvertible {
+    public var debugDescription: String {
+        filePath.debugDescription
     }
 }
 
 extension Path: Equatable {
     /// Determines if two paths are identical
-    ///
-    /// - Note: The comparison is string-based. Be aware that two different paths (foo.txt and
-    ///   ./foo.txt) can refer to the same file.
-    ///
     public static func == (lhs: Path, rhs: Path) -> Bool {
-        lhs.path == rhs.path
+        lhs.filePath == rhs.filePath
     }
 }
 
 extension Path: Hashable {
     public func hash(into hasher: inout Hasher) {
-        hasher.combine(path.hashValue)
+        hasher.combine(filePath.hashValue)
+        hasher.combine(ObjectIdentifier(Self.self))
     }
 }