Compare commits
36 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dac007e907 | ||
|
|
b6b4a74a26 | ||
|
|
b76db41ca4 | ||
|
|
8d5d67b81b | ||
|
|
21ddc7dc3a | ||
|
|
f324b4a562 | ||
|
|
0e061f9cc8 | ||
|
|
7e774b6cf5 | ||
|
|
8b371fa5d2 | ||
|
|
02fd579f19 | ||
|
|
e915bc0cfb | ||
|
|
f4c2c75aa1 | ||
|
|
dc7affa28c | ||
|
|
476cdc1461 | ||
|
|
a644208c62 | ||
|
|
d7a9819350 | ||
|
|
24a54c2ee0 | ||
|
|
3735ed4476 | ||
|
|
2880aa556b | ||
|
|
a125a871f5 | ||
|
|
d79844cf2b | ||
|
|
d0648411ea | ||
|
|
e74cc63271 | ||
|
|
28f84d3961 | ||
|
|
db184a13a3 | ||
|
|
b65d167937 | ||
|
|
9a770ca576 | ||
|
|
b7c189e6af | ||
|
|
2758f0f698 | ||
|
|
e68ad25cc0 | ||
|
|
c9d300a7b6 | ||
|
|
ed4b773870 | ||
|
|
097e020735 | ||
|
|
be49fb9e49 | ||
|
|
164cd2b413 | ||
|
|
709c3fb99d |
13
.github/jazzy.yml
vendored
Normal file
13
.github/jazzy.yml
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
module: Path
|
||||
custom_categories:
|
||||
- name: Path
|
||||
children:
|
||||
- Path
|
||||
- /(_:_:)
|
||||
xcodebuild_arguments:
|
||||
- UseModernBuildSystem=NO
|
||||
output:
|
||||
../output
|
||||
# output directory is relative to config file… ugh
|
||||
exclude:
|
||||
- Sources/Path+StringConvertibles.swift
|
||||
89
.travis.yml
89
.travis.yml
@@ -15,17 +15,26 @@ xcode_scheme: Path.swift-Package
|
||||
|
||||
jobs:
|
||||
include:
|
||||
- script: swift test --parallel
|
||||
name: macOS / Swift 4.2.1
|
||||
- name: macOS / Swift 4.0.3
|
||||
script: swift test --parallel -Xswiftc -swift-version -Xswiftc 4
|
||||
|
||||
- name: macOS / Swift 4.2.1
|
||||
script: swift test --parallel
|
||||
|
||||
- name: macOS / Swift 5.0
|
||||
osx_image: xcode10.2
|
||||
script: swift test --parallel
|
||||
|
||||
- &xcodebuild
|
||||
before_install: swift package generate-xcodeproj --enable-code-coverage
|
||||
xcode_destination: platform=iOS Simulator,OS=latest,name=iPhone XS
|
||||
name: iOS / Swift 4.2.1
|
||||
after_success: bash <(curl -s https://codecov.io/bash)
|
||||
|
||||
- <<: *xcodebuild
|
||||
xcode_destination: platform=tvOS Simulator,OS=latest,name=Apple TV
|
||||
name: tvOS / Swift 4.2.1
|
||||
|
||||
- <<: *xcodebuild
|
||||
name: watchOS / Swift 4.2.1
|
||||
script: |
|
||||
@@ -48,39 +57,23 @@ jobs:
|
||||
script: swift test --parallel
|
||||
|
||||
- <<: *linux
|
||||
env: SWIFT_VERSION='5.0-DEVELOPMENT-SNAPSHOT-2019-01-22-a'
|
||||
name: Linux / Swift 5.0.0-dev (2019-01-22)
|
||||
env: SWIFT_VERSION='5.0'
|
||||
name: Linux / Swift 5.0.0
|
||||
|
||||
- stage: pretest
|
||||
name: Check Linux tests are sync’d
|
||||
install: swift test --generate-linuxmain
|
||||
script: git diff --exit-code
|
||||
osx_image: xcode10.2
|
||||
|
||||
- stage: deploy
|
||||
name: Jazzy
|
||||
before_install: |
|
||||
cat <<\ \ EOF> .jazzy.yaml
|
||||
module: Path
|
||||
module_version: TRAVIS_TAG
|
||||
custom_categories:
|
||||
- name: Path
|
||||
children:
|
||||
- Path
|
||||
- /(_:_:)
|
||||
xcodebuild_arguments:
|
||||
- UseModernBuildSystem=NO
|
||||
output: output
|
||||
github_url: https://github.com/mxcl/Path.swift
|
||||
exclude:
|
||||
- Sources/Path+StringConvertibles.swift
|
||||
EOF
|
||||
sed -i '' "s/TRAVIS_TAG/$TRAVIS_TAG/" .jazzy.yaml
|
||||
# ^^ this weirdness because Travis multiline YAML is broken and inserts
|
||||
# two spaces in front of the output which means we need a prefixed
|
||||
# delimiter which also weirdly stops bash from doing variable substitution
|
||||
install: gem install jazzy
|
||||
before_script: swift package generate-xcodeproj
|
||||
script: jazzy
|
||||
script: |
|
||||
jazzy --config .github/jazzy.yml \
|
||||
--module-version $TRAVIS_TAG \
|
||||
--github_url "https://github.com/$TRAVIS_REPO_SLUG"
|
||||
deploy:
|
||||
provider: pages
|
||||
skip-cleanup: true
|
||||
@@ -90,43 +83,11 @@ jobs:
|
||||
tags: true
|
||||
|
||||
- name: CocoaPods
|
||||
before_install: export TRAVIS_REPO_NAME=${TRAVIS_REPO_SLUG#*/}
|
||||
install: gem install cocoapods
|
||||
before_script: |
|
||||
export DESCRIPTION=$(swift - <<\ \ EOF
|
||||
import Foundation
|
||||
struct Response: Decodable { let description: String }
|
||||
let token = ProcessInfo.processInfo.environment["GITHUB_TOKEN"]!
|
||||
let slug = ProcessInfo.processInfo.environment["TRAVIS_REPO_SLUG"]!
|
||||
let url = URL(string: "https://api.github.com/repos/\(slug)")!
|
||||
var rq = URLRequest(url: url)
|
||||
rq.setValue("token \(token)", forHTTPHeaderField: "Authorization")
|
||||
let semaphore = DispatchSemaphore(value: 0)
|
||||
var data: Data!
|
||||
URLSession.shared.dataTask(with: rq) { d, _, _ in
|
||||
data = d
|
||||
semaphore.signal()
|
||||
}.resume()
|
||||
semaphore.wait()
|
||||
let rsp = try JSONDecoder().decode(Response.self, from: data)
|
||||
print(rsp.description, terminator: "")
|
||||
EOF)
|
||||
cat <<\ \ EOF> $TRAVIS_REPO_NAME.podspec
|
||||
Pod::Spec.new do |s|
|
||||
s.name = ENV['TRAVIS_REPO_NAME']
|
||||
s.version = ENV['TRAVIS_TAG']
|
||||
s.summary = ENV['DESCRIPTION']
|
||||
s.homepage = "https://github.com/#{ENV['TRAVIS_REPO_SLUG']}"
|
||||
s.license = { type: 'Unlicense', file: 'LICENSE.md' }
|
||||
s.author = { mxcl: 'mxcl@me.com' }
|
||||
s.source = { git: "https://github.com/#{ENV['TRAVIS_REPO_SLUG']}.git", tag: s.version }
|
||||
s.social_media_url = 'https://twitter.com/mxcl'
|
||||
s.osx.deployment_target = '10.10'
|
||||
s.ios.deployment_target = '8.0'
|
||||
s.tvos.deployment_target = '10.0'
|
||||
s.watchos.deployment_target = '3.0'
|
||||
s.source_files = 'Sources/*'
|
||||
s.swift_version = '4.2'
|
||||
end
|
||||
EOF
|
||||
osx_image: xcode10.2
|
||||
install: |
|
||||
brew install mxcl/made/swift-sh
|
||||
curl -O https://raw.githubusercontent.com/mxcl/ops/master/deploy
|
||||
chmod u+x deploy
|
||||
before_script: ./deploy generate-podspec
|
||||
script: pod trunk push
|
||||
after_success: ./deploy publish-release
|
||||
|
||||
@@ -9,5 +9,6 @@ let package = Package(
|
||||
targets: [
|
||||
.target(name: "Path", path: "Sources"),
|
||||
.testTarget(name: "PathTests", dependencies: ["Path"]),
|
||||
]
|
||||
],
|
||||
swiftLanguageVersions: [.v4, .v4_2, .version("5")]
|
||||
)
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
// swift-tools-version:5.0
|
||||
import PackageDescription
|
||||
|
||||
let pkg = Package(
|
||||
name: "Path.swift",
|
||||
products: [
|
||||
.library(name: "Path", targets: ["Path"]),
|
||||
],
|
||||
targets: [
|
||||
.target(name: "Path", path: "Sources"),
|
||||
.testTarget(name: "PathTests", dependencies: ["Path"]),
|
||||
]
|
||||
)
|
||||
|
||||
pkg.platforms = [
|
||||
.macOS(.v10_10), .iOS(.v8), .tvOS(.v10), .watchOS(.v3)
|
||||
]
|
||||
pkg.swiftLanguageVersions = [
|
||||
.v4_2, .v5
|
||||
]
|
||||
86
README.md
86
README.md
@@ -53,7 +53,7 @@ help me continue my work, I appreciate it x
|
||||
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
|
||||
</a>
|
||||
|
||||
[Other donation/tipping options](http://mxcl.github.io/donate/)
|
||||
[Other donation/tipping options](http://mxcl.dev/#donate)
|
||||
|
||||
# Handbook
|
||||
|
||||
@@ -178,6 +178,11 @@ check the POSIX permissions of the file first, before returning the result of
|
||||
`isExecutableFile`. `Path.swift` has done the leg-work for you so you can get on
|
||||
with your work without worries.
|
||||
|
||||
There is also some magic going on in Foundation’s filesystem APIs, which we look
|
||||
for and ensure our API is deterministic, eg. [this test].
|
||||
|
||||
[this test]: https://github.com/mxcl/Path.swift/blob/master/Tests/PathTests/PathTests.swift#L539-L554
|
||||
|
||||
# `Path.swift` is properly cross-platform
|
||||
|
||||
`FileManager` on Linux is full of holes. We have found the holes and worked
|
||||
@@ -199,6 +204,10 @@ Path.home/"b/c" // => /Users/mxcl/b/c
|
||||
// joining with absolute paths omits prefixed slash
|
||||
Path.home/"/b" // => /Users/mxcl/b
|
||||
|
||||
// joining with .. or . works as expected
|
||||
Path.home.foo.bar.join("..") // => /Users/mxcl/foo
|
||||
Path.home.foo.bar.join(".") // => /Users/mxcl/foo/bar
|
||||
|
||||
// of course, feel free to join variables:
|
||||
let b = "b"
|
||||
let c = "c"
|
||||
@@ -211,8 +220,24 @@ Path.root/"~/b" // => /~/b
|
||||
// but is here
|
||||
Path("~/foo")! // => /Users/mxcl/foo
|
||||
|
||||
// this does not work though
|
||||
// this works provided the user `Guest` exists
|
||||
Path("~Guest") // => /Users/Guest
|
||||
|
||||
// but if the user does not exist
|
||||
Path("~foo") // => nil
|
||||
|
||||
// paths with .. or . are resolved
|
||||
Path("/foo/bar/../baz") // => /foo/baz
|
||||
|
||||
// symlinks are not resolved
|
||||
Path.root.bar.symlink(as: "foo")
|
||||
Path("foo") // => /foo
|
||||
Path.foo // => /foo
|
||||
|
||||
// unless you do it explicitly
|
||||
try Path.foo.readlink() // => /bar
|
||||
// `readlink` only resolves the *final* path component,
|
||||
// thus use `realpath` if there are multiple symlinks
|
||||
```
|
||||
|
||||
*Path.swift* has the general policy that if the desired end result preexists,
|
||||
@@ -220,37 +245,84 @@ then it’s a noop:
|
||||
|
||||
* If you try to delete a file, but the file doesn't exist, we do nothing.
|
||||
* If you try to make a directory and it already exists, we do nothing.
|
||||
* If you call `readlink` on a non-symlink, we return `self`
|
||||
|
||||
However notably if you try to copy or move a file with specifying `overwrite`
|
||||
and the file already exists at the destination and is identical, we don’t check
|
||||
for that as the check was deemed too expensive to be worthwhile.
|
||||
|
||||
## Symbolic links
|
||||
|
||||
* Two paths may represent the same *resolved* path yet not be equal due to
|
||||
symlinks in such cases you should use `realpath` on both first if an
|
||||
equality check is required.
|
||||
* There are several symlink paths on Mac that are typically automatically
|
||||
resolved by Foundation, eg. `/private`, we attempt to do the same for
|
||||
functions that you would expect it (notably `realpath`), we *do* the same for
|
||||
`Path.init`, but *do not* if you are joining a path that ends up being one of
|
||||
these paths, (eg. `Path.root.join("var/private')`).
|
||||
|
||||
If a `Path` is a symlink but the destination of the link does not exist `exists`
|
||||
returns `false`. This seems to be the correct thing to do since symlinks are
|
||||
meant to be an abstraction for filesystems. To instead verify that there is
|
||||
no filesystem entry there at all check if `kind` is `nil`.
|
||||
|
||||
|
||||
## We do not provide change directory functionality
|
||||
|
||||
Changing directory is dangerous, you should *always* try to avoid it and thus
|
||||
we don’t even provide the method. If you are executing a sub-process then
|
||||
use `Process.currentDirectoryURL`.
|
||||
|
||||
If you must then use `FileManager.changeCurrentDirectory`.
|
||||
|
||||
# I thought I should only use `URL`s?
|
||||
|
||||
Apple recommend this because they provide a magic translation for
|
||||
[file-references embodied by URLs][file-refs], which gives you URLs like so:
|
||||
|
||||
file:///.file/id=6571367.15106761
|
||||
|
||||
Therefore, if you are not using this feature you are fine. If you have URLs the correct
|
||||
way to get a `Path` is:
|
||||
|
||||
```swift
|
||||
if let path = Path(url: url) {
|
||||
/*…*/
|
||||
}
|
||||
```
|
||||
|
||||
Our initializer calls `path` on the URL which resolves any reference to an
|
||||
actual filesystem path, however we also check the URL has a `file` scheme first.
|
||||
|
||||
[file-refs]: https://developer.apple.com/documentation/foundation/nsurl/1408631-filereferenceurl
|
||||
|
||||
# Installation
|
||||
|
||||
SwiftPM:
|
||||
|
||||
```swift
|
||||
package.append(.package(url: "https://github.com/mxcl/Path.swift.git", from: "0.5.0"))
|
||||
package.append(.package(url: "https://github.com/mxcl/Path.swift.git", from: "0.13.0"))
|
||||
```
|
||||
|
||||
CocoaPods:
|
||||
|
||||
```ruby
|
||||
pod 'Path.swift', '~> 0.5'
|
||||
pod 'Path.swift', '~> 0.13'
|
||||
```
|
||||
|
||||
Carthage:
|
||||
|
||||
> Waiting on: [@Carthage#1945](https://github.com/Carthage/Carthage/pull/1945).
|
||||
|
||||
## Please note
|
||||
## Pre‐1.0 status
|
||||
|
||||
We are pre 1.0, thus we can change the API as we like, and we will (to the
|
||||
pursuit of getting it *right*)! We will tag 1.0 as soon as possible.
|
||||
|
||||
### Get push notifications for new releases
|
||||
|
||||
https://codebasesaga.com/canopy/
|
||||
https://mxcl.dev/canopy/
|
||||
|
||||
# Alternatives
|
||||
|
||||
@@ -262,7 +334,7 @@ https://codebasesaga.com/canopy/
|
||||
|
||||
[badge-platforms]: https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20iOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey.svg
|
||||
[badge-languages]: https://img.shields.io/badge/swift-4.2%20%7C%205.0-orange.svg
|
||||
[docs]: https://mxcl.github.io/Path.swift/Structs/Path.html
|
||||
[docs]: https://mxcl.dev/Path.swift/Structs/Path.html
|
||||
[badge-jazzy]: https://raw.githubusercontent.com/mxcl/Path.swift/gh-pages/badge.svg?sanitize=true
|
||||
[badge-codecov]: https://codecov.io/gh/mxcl/Path.swift/branch/master/graph/badge.svg
|
||||
[badge-ci]: https://travis-ci.com/mxcl/Path.swift.svg
|
||||
|
||||
@@ -34,6 +34,11 @@ public extension Bundle {
|
||||
var path: Path {
|
||||
return Path(string: bundlePath)
|
||||
}
|
||||
|
||||
/// Returns the executable for this bundle, if there is one, not all bundles have one hence `Optional`.
|
||||
var executable: Path? {
|
||||
return executablePath.flatMap(Path.init)
|
||||
}
|
||||
}
|
||||
|
||||
/// Extensions on `String` that work with `Path` rather than `String` or `URL`
|
||||
|
||||
@@ -83,4 +83,22 @@ public extension Path {
|
||||
#endif
|
||||
return self
|
||||
}
|
||||
|
||||
enum Kind {
|
||||
case file, symlink, directory
|
||||
}
|
||||
|
||||
var kind: Kind? {
|
||||
var buf = stat()
|
||||
guard lstat(string, &buf) == 0 else {
|
||||
return nil
|
||||
}
|
||||
if buf.st_mode & S_IFMT == S_IFLNK {
|
||||
return .symlink
|
||||
} else if buf.st_mode & S_IFMT == S_IFDIR {
|
||||
return .directory
|
||||
} else {
|
||||
return .file
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,11 +25,11 @@ public extension Path {
|
||||
*/
|
||||
@discardableResult
|
||||
func copy(to: Path, overwrite: Bool = false) throws -> Path {
|
||||
if overwrite, to.isFile, isFile {
|
||||
if overwrite, let tokind = to.kind, tokind != .directory, kind != .directory {
|
||||
try FileManager.default.removeItem(at: to.url)
|
||||
}
|
||||
#if os(Linux) && !swift(>=5.1) // check if fixed
|
||||
if !overwrite, to.isFile {
|
||||
if !overwrite, to.kind != nil {
|
||||
throw CocoaError.error(.fileWriteFileExists)
|
||||
}
|
||||
#endif
|
||||
@@ -61,15 +61,15 @@ public extension Path {
|
||||
*/
|
||||
@discardableResult
|
||||
func copy(into: Path, overwrite: Bool = false) throws -> Path {
|
||||
if !into.exists {
|
||||
if into.kind == nil {
|
||||
try into.mkdir(.p)
|
||||
}
|
||||
let rv = into/basename()
|
||||
if overwrite, rv.isFile {
|
||||
try rv.delete()
|
||||
if overwrite, let kind = rv.kind, kind != .directory {
|
||||
try FileManager.default.removeItem(at: rv.url)
|
||||
}
|
||||
#if os(Linux) && !swift(>=5.1) // check if fixed
|
||||
if !overwrite, rv.isFile {
|
||||
if !overwrite, rv.kind != nil {
|
||||
throw CocoaError.error(.fileWriteFileExists)
|
||||
}
|
||||
#endif
|
||||
@@ -95,7 +95,7 @@ public extension Path {
|
||||
*/
|
||||
@discardableResult
|
||||
func move(to: Path, overwrite: Bool = false) throws -> Path {
|
||||
if overwrite, to.isFile {
|
||||
if overwrite, let kind = to.kind, kind != .directory {
|
||||
try FileManager.default.removeItem(at: to.url)
|
||||
}
|
||||
try FileManager.default.moveItem(at: url, to: to.url)
|
||||
@@ -119,17 +119,21 @@ public extension Path {
|
||||
*/
|
||||
@discardableResult
|
||||
func move(into: Path, overwrite: Bool = false) throws -> Path {
|
||||
if !into.exists {
|
||||
switch into.kind {
|
||||
case nil:
|
||||
try into.mkdir(.p)
|
||||
} else if !into.isDirectory {
|
||||
fallthrough
|
||||
case .directory?:
|
||||
let rv = into/basename()
|
||||
if overwrite, let rvkind = rv.kind, rvkind != .directory {
|
||||
try FileManager.default.removeItem(at: rv.url)
|
||||
}
|
||||
try FileManager.default.moveItem(at: url, to: rv.url)
|
||||
return rv
|
||||
case .file?, .symlink?:
|
||||
throw CocoaError.error(.fileWriteFileExists)
|
||||
}
|
||||
let rv = into/basename()
|
||||
if overwrite, rv.isFile {
|
||||
try FileManager.default.removeItem(at: rv.url)
|
||||
}
|
||||
try FileManager.default.moveItem(at: url, to: rv.url)
|
||||
return rv
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -138,11 +142,12 @@ public extension Path {
|
||||
∵ *Path.swift* doesn’t error if desired end result preexists.
|
||||
- Note: On UNIX will this function will succeed if the parent directory is writable and the current user has permission.
|
||||
- Note: This function will fail if the file or directory is “locked”
|
||||
- Note: If entry is a symlink, deletes the symlink.
|
||||
- SeeAlso: `lock()`
|
||||
*/
|
||||
@inlinable
|
||||
func delete() throws {
|
||||
if exists {
|
||||
if kind != nil {
|
||||
try FileManager.default.removeItem(at: url)
|
||||
}
|
||||
}
|
||||
@@ -154,7 +159,7 @@ public extension Path {
|
||||
@inlinable
|
||||
@discardableResult
|
||||
func touch() throws -> Path {
|
||||
if !exists {
|
||||
if kind == nil {
|
||||
guard FileManager.default.createFile(atPath: string, contents: nil) else {
|
||||
throw CocoaError.error(.fileWriteUnknown)
|
||||
}
|
||||
@@ -211,6 +216,35 @@ public extension Path {
|
||||
try FileManager.default.moveItem(atPath: string, toPath: newpath.string)
|
||||
return newpath
|
||||
}
|
||||
|
||||
/**
|
||||
Creates a symlink of this file at `as`.
|
||||
- Note: If `self` does not exist, is **not** an error.
|
||||
*/
|
||||
@discardableResult
|
||||
func symlink(as: Path) throws -> Path {
|
||||
try FileManager.default.createSymbolicLink(atPath: `as`.string, withDestinationPath: string)
|
||||
return `as`
|
||||
}
|
||||
|
||||
/**
|
||||
Creates a symlink of this file with the same filename in the `into` directory.
|
||||
- Note: If into does not exist, creates the directory with intermediate directories if necessary.
|
||||
*/
|
||||
@discardableResult
|
||||
func symlink(into dir: Path) throws -> Path {
|
||||
switch dir.kind {
|
||||
case nil, .symlink?:
|
||||
try dir.mkdir(.p)
|
||||
fallthrough
|
||||
case .directory?:
|
||||
let dst = dir/basename()
|
||||
try FileManager.default.createSymbolicLink(atPath: dst.string, withDestinationPath: string)
|
||||
return dst
|
||||
case .file?:
|
||||
throw CocoaError.error(.fileWriteFileExists)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Options for `Path.mkdir(_:)`
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import class Foundation.NSString
|
||||
|
||||
extension Path: CustomStringConvertible {
|
||||
/// Returns `Path.string`
|
||||
public var description: String {
|
||||
|
||||
@@ -2,13 +2,16 @@ import Foundation
|
||||
#if os(Linux)
|
||||
import func Glibc.access
|
||||
#else
|
||||
import func Darwin.access
|
||||
import Darwin
|
||||
#endif
|
||||
|
||||
public extension Path {
|
||||
//MARK: Filesystem Properties
|
||||
|
||||
/// Returns true if the path represents an actual filesystem entry.
|
||||
/**
|
||||
- Returns: `true` if the path represents an actual filesystem entry.
|
||||
- Note: If `self` is a symlink the return value represents the destination.
|
||||
*/
|
||||
var exists: Bool {
|
||||
return FileManager.default.fileExists(atPath: string)
|
||||
}
|
||||
@@ -55,4 +58,11 @@ public extension Path {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns `true` if the file is a symbolic-link (symlink).
|
||||
var isSymlink: Bool {
|
||||
var sbuf = stat()
|
||||
lstat(string, &sbuf)
|
||||
return (sbuf.st_mode & S_IFMT) == S_IFLNK
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
import Foundation
|
||||
#if !os(Linux)
|
||||
import func Darwin.realpath
|
||||
let _realpath = Darwin.realpath
|
||||
#else
|
||||
import func Glibc.realpath
|
||||
let _realpath = Glibc.realpath
|
||||
#endif
|
||||
|
||||
/**
|
||||
A `Path` represents an absolute path on a filesystem.
|
||||
@@ -32,19 +39,96 @@ import Foundation
|
||||
public struct Path: Equatable, Hashable, Comparable {
|
||||
|
||||
init(string: String) {
|
||||
assert(string.first == "/")
|
||||
assert(string.last != "/" || string == "/")
|
||||
assert(string.split(separator: "/").contains("..") == false)
|
||||
self.string = string
|
||||
}
|
||||
|
||||
/// Returns `nil` unless fed an absolute path.
|
||||
public init?(_ description: String) {
|
||||
guard description.starts(with: "/") || description.starts(with: "~/") else { return nil }
|
||||
self.init(string: (description as NSString).standardizingPath)
|
||||
/**
|
||||
Creates a new absolute, standardized path.
|
||||
- Note: Resolves any .. or . components.
|
||||
- Note: Removes multiple subsequent and trailing occurences of `/`.
|
||||
- Note: Does *not* resolve any symlinks.
|
||||
- Note: On macOS, removes an initial component of “/private/var/automount”, “/var/automount”, or “/private” from the path, if the result still indicates an existing file or directory (checked by consulting the file system).
|
||||
- Returns: The path or `nil` if fed a relative path or a `~foo` string where there is no user `foo`.
|
||||
*/
|
||||
public init?<S: StringProtocol>(_ description: S) {
|
||||
var pathComponents = description.split(separator: "/")
|
||||
switch description.first {
|
||||
case "/":
|
||||
#if os(macOS)
|
||||
func ifExists(withPrefix prefix: String, removeFirst n: Int) {
|
||||
assert(prefix.split(separator: "/").count == n)
|
||||
|
||||
if description.hasPrefix(prefix), FileManager.default.fileExists(atPath: String(description)) {
|
||||
pathComponents.removeFirst(n)
|
||||
}
|
||||
}
|
||||
|
||||
ifExists(withPrefix: "/private/var/automount", removeFirst: 3)
|
||||
ifExists(withPrefix: "/var/automount", removeFirst: 2)
|
||||
ifExists(withPrefix: "/private", removeFirst: 1)
|
||||
#endif
|
||||
self.string = join_(prefix: "/", pathComponents: pathComponents)
|
||||
|
||||
case "~":
|
||||
if description == "~" {
|
||||
self = Path.home
|
||||
return
|
||||
}
|
||||
let tilded: String
|
||||
if description.hasPrefix("~/") {
|
||||
tilded = Path.home.string
|
||||
} else {
|
||||
let username = String(pathComponents[0].dropFirst())
|
||||
#if os(macOS) || os(Linux)
|
||||
if #available(OSX 10.12, *) {
|
||||
guard let url = FileManager.default.homeDirectory(forUser: username) else { return nil }
|
||||
assert(url.scheme == "file")
|
||||
tilded = url.path
|
||||
} else {
|
||||
guard let dir = NSHomeDirectoryForUser(username) else { return nil }
|
||||
tilded = dir
|
||||
}
|
||||
#else
|
||||
return nil // there are no usernames on iOS, etc.
|
||||
#endif
|
||||
}
|
||||
pathComponents.remove(at: 0)
|
||||
self.string = join_(prefix: tilded, pathComponents: pathComponents)
|
||||
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
Creates a new absolute, standardized path from the provided file-scheme URL.
|
||||
- Note: If the URL is not a file URL, returns `nil`.
|
||||
*/
|
||||
public init?(url: URL) {
|
||||
guard url.scheme == "file" else { return nil }
|
||||
self.init(url.path)
|
||||
//NOTE: URL cannot be a file-reference url, unlike NSURL, so this always works
|
||||
}
|
||||
|
||||
/**
|
||||
Creates a new absolute, standardized path from the provided file-scheme URL.
|
||||
- Note: If the URL is not a file URL, returns `nil`.
|
||||
- Note: If the URL is a file reference URL, converts it to a POSIX path first.
|
||||
*/
|
||||
public init?(url: NSURL) {
|
||||
guard url.scheme == "file", let path = url.path else { return nil }
|
||||
self.init(string: path)
|
||||
// ^^ works even if the url is a file-reference url
|
||||
}
|
||||
|
||||
/// :nodoc:
|
||||
public subscript(dynamicMember pathComponent: String) -> Path {
|
||||
let str = (string as NSString).appendingPathComponent(pathComponent)
|
||||
return Path(string: str)
|
||||
public subscript(dynamicMember addendum: String) -> Path {
|
||||
//NOTE it’s possible for the string to be anything if we are invoked via
|
||||
// explicit subscript thus we use our fully sanitized `join` function
|
||||
return Path(string: join_(prefix: string, appending: addendum))
|
||||
}
|
||||
|
||||
//MARK: Properties
|
||||
@@ -57,6 +141,21 @@ public struct Path: Equatable, Hashable, Comparable {
|
||||
return URL(fileURLWithPath: string)
|
||||
}
|
||||
|
||||
/**
|
||||
Returns a file-reference URL.
|
||||
- Note: Only NSURL can be a file-reference-URL, hence we return NSURL.
|
||||
- SeeAlso: https://developer.apple.com/documentation/foundation/nsurl/1408631-filereferenceurl
|
||||
- Important: On Linux returns an file scheme NSURL for this path string.
|
||||
*/
|
||||
public var fileReferenceURL: NSURL? {
|
||||
#if !os(Linux)
|
||||
// https://bugs.swift.org/browse/SR-2728
|
||||
return (url as NSURL).perform(#selector(NSURL.fileReferenceURL))?.takeUnretainedValue() as? NSURL
|
||||
#else
|
||||
return NSURL(fileURLWithPath: string)
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
Returns the parent directory for this path.
|
||||
|
||||
@@ -66,23 +165,49 @@ public struct Path: Equatable, Hashable, Comparable {
|
||||
- Note: always returns a valid path, `Path.root.parent` *is* `Path.root`.
|
||||
*/
|
||||
public var parent: Path {
|
||||
return Path(string: (string as NSString).deletingLastPathComponent)
|
||||
let index = string.lastIndex(of: "/")!
|
||||
let substr = string[string.indices.startIndex..<index]
|
||||
return Path(string: String(substr))
|
||||
}
|
||||
|
||||
/**
|
||||
Returns the filename extension of this path.
|
||||
- Remark: Implemented via `NSString.pathExtension`.
|
||||
- Remark: If there is no extension returns "".
|
||||
- Remark: If the filename ends with any number of ".", returns "".
|
||||
- Note: We special case eg. `foo.tar.gz`.
|
||||
*/
|
||||
@inlinable
|
||||
public var `extension`: String {
|
||||
if string.hasSuffix(".tar.gz") {
|
||||
//FIXME efficiency
|
||||
switch true {
|
||||
case string.hasSuffix(".tar.gz"):
|
||||
return "tar.gz"
|
||||
} else {
|
||||
return (string as NSString).pathExtension
|
||||
case string.hasSuffix(".tar.bz"):
|
||||
return "tar.bz"
|
||||
case string.hasSuffix(".tar.bz2"):
|
||||
return "tar.bz2"
|
||||
case string.hasSuffix(".tar.xz"):
|
||||
return "tar.xz"
|
||||
default:
|
||||
let slash = string.lastIndex(of: "/")!
|
||||
if let dot = string.lastIndex(of: "."), slash < dot {
|
||||
let foo = string.index(after: dot)
|
||||
return String(string[foo...])
|
||||
} else {
|
||||
return ""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
Splits the string representation on the directory separator.
|
||||
- Important: The first element is always "/" to be consistent with `NSString.pathComponents`.
|
||||
*/
|
||||
@inlinable
|
||||
public var components: [String] {
|
||||
return ["/"] + string.split(separator: "/").map(String.init)
|
||||
}
|
||||
|
||||
//MARK: Pathing
|
||||
|
||||
/**
|
||||
@@ -93,14 +218,15 @@ public struct Path: Equatable, Hashable, Comparable {
|
||||
Path.root.join("a").join("b") // => /a/b
|
||||
Path.root.join("a").join("/b") // => /a/b
|
||||
|
||||
- Note: `..` and `.` components are interpreted.
|
||||
- Note: pathComponent *may* be multiple components.
|
||||
- Note: symlinks are *not* resolved.
|
||||
- Parameter pathComponent: The string to join with this path.
|
||||
- Returns: A new joined path.
|
||||
- SeeAlso: `Path./(_:_:)`
|
||||
*/
|
||||
public func join<S>(_ pathComponent: S) -> Path where S: StringProtocol {
|
||||
//TODO standardizingPath does more than we want really (eg tilde expansion)
|
||||
let str = (string as NSString).appendingPathComponent(String(pathComponent))
|
||||
return Path(string: (str as NSString).standardizingPath)
|
||||
public func join<S>(_ addendum: S) -> Path where S: StringProtocol {
|
||||
return Path(string: join_(prefix: string, appending: addendum))
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -111,6 +237,9 @@ public struct Path: Equatable, Hashable, Comparable {
|
||||
Path.root/"a"/"b" // => /a/b
|
||||
Path.root/"a"/"/b" // => /a/b
|
||||
|
||||
- Note: `..` and `.` components are interpreted.
|
||||
- Note: pathComponent *may* be multiple components.
|
||||
- Note: symlinks are *not* resolved.
|
||||
- Parameter lhs: The base path to join with `rhs`.
|
||||
- Parameter rhs: The string to join with this `lhs`.
|
||||
- Returns: A new joined path.
|
||||
@@ -168,17 +297,71 @@ public struct Path: Equatable, Hashable, Comparable {
|
||||
- Parameter dropExtension: If `true` returns the basename without its file extension.
|
||||
*/
|
||||
public func basename(dropExtension: Bool = false) -> String {
|
||||
let str = string as NSString
|
||||
if !dropExtension {
|
||||
return str.lastPathComponent
|
||||
} else {
|
||||
let ext = str.pathExtension
|
||||
if !ext.isEmpty {
|
||||
return String(str.lastPathComponent.dropLast(ext.count + 1))
|
||||
var lastPathComponent: Substring {
|
||||
let slash = string.lastIndex(of: "/")!
|
||||
let index = string.index(after: slash)
|
||||
return string[index...]
|
||||
}
|
||||
var go: Substring {
|
||||
if !dropExtension {
|
||||
return lastPathComponent
|
||||
} else {
|
||||
return str.lastPathComponent
|
||||
let ext = self.extension
|
||||
if !ext.isEmpty {
|
||||
return lastPathComponent.dropLast(ext.count + 1)
|
||||
} else {
|
||||
return lastPathComponent
|
||||
}
|
||||
}
|
||||
}
|
||||
return String(go)
|
||||
}
|
||||
|
||||
/**
|
||||
If the path represents an actual entry that is a symlink, returns the symlink’s
|
||||
absolute destination.
|
||||
|
||||
- Important: This is not exhaustive, the resulting path may still contain
|
||||
symlink.
|
||||
- Important: The path will only be different if the last path component is a
|
||||
symlink, any symlinks in prior components are not resolved.
|
||||
- Note: If file exists but isn’t a symlink, returns `self`.
|
||||
- Note: If symlink destination does not exist, is **not** an error.
|
||||
*/
|
||||
public func readlink() throws -> Path {
|
||||
do {
|
||||
let rv = try FileManager.default.destinationOfSymbolicLink(atPath: string)
|
||||
return Path(rv) ?? parent/rv
|
||||
} catch CocoaError.fileReadUnknown {
|
||||
// file is not symlink, return `self`
|
||||
assert(exists)
|
||||
return self
|
||||
} catch {
|
||||
#if os(Linux)
|
||||
// ugh: Swift on Linux
|
||||
let nsError = error as NSError
|
||||
if nsError.domain == NSCocoaErrorDomain, nsError.code == CocoaError.fileReadUnknown.rawValue, exists {
|
||||
return self
|
||||
}
|
||||
#endif
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
/// Recursively resolves symlinks in this path.
|
||||
public func realpath() throws -> Path {
|
||||
guard let rv = _realpath(string, nil) else { throw CocoaError.error(.fileNoSuchFile) }
|
||||
defer { free(rv) }
|
||||
guard let rvv = String(validatingUTF8: rv) else { throw CocoaError.error(.fileReadUnknownStringEncoding) }
|
||||
|
||||
// “Removing an initial component of “/private/var/automount”, “/var/automount”,
|
||||
// or “/private” from the path, if the result still indicates an existing file or
|
||||
// directory (checked by consulting the file system).”
|
||||
// ^^ we do this to not conflict with the results that other Apple APIs give
|
||||
// which is necessary if we are to have equality checks work reliably
|
||||
let rvvv = (rvv as NSString).standardizingPath
|
||||
|
||||
return Path(string: rvvv)
|
||||
}
|
||||
|
||||
/// Returns the locale-aware sort order for the two paths.
|
||||
@@ -188,3 +371,38 @@ public struct Path: Equatable, Hashable, Comparable {
|
||||
return lhs.string.compare(rhs.string, locale: .current) == .orderedAscending
|
||||
}
|
||||
}
|
||||
|
||||
@inline(__always)
|
||||
private func join_<S>(prefix: String, appending: S) -> String where S: StringProtocol {
|
||||
return join_(prefix: prefix, pathComponents: appending.split(separator: "/"))
|
||||
}
|
||||
|
||||
private func join_<S>(prefix: String, pathComponents: S) -> String where S: Sequence, S.Element: StringProtocol {
|
||||
assert(prefix.first == "/")
|
||||
|
||||
var rv = prefix
|
||||
for component in pathComponents {
|
||||
|
||||
assert(!component.contains("/"))
|
||||
|
||||
switch component {
|
||||
case "..":
|
||||
let start = rv.indices.startIndex
|
||||
let index = rv.lastIndex(of: "/")!
|
||||
if start == index {
|
||||
rv = "/"
|
||||
} else {
|
||||
rv = String(rv[start..<index])
|
||||
}
|
||||
case ".":
|
||||
break
|
||||
default:
|
||||
if rv == "/" {
|
||||
rv = "/\(component)"
|
||||
} else {
|
||||
rv = "\(rv)/\(component)"
|
||||
}
|
||||
}
|
||||
}
|
||||
return rv
|
||||
}
|
||||
|
||||
@@ -9,6 +9,10 @@ class PathTests: XCTestCase {
|
||||
XCTAssertEqual((Path.root/"///bar").string, "/bar")
|
||||
XCTAssertEqual((Path.root/"foo///bar////").string, "/foo/bar")
|
||||
XCTAssertEqual((Path.root/"foo"/"/bar").string, "/foo/bar")
|
||||
|
||||
XCTAssertEqual(Path.root.foo.bar.join(".."), Path.root.foo)
|
||||
XCTAssertEqual(Path.root.foo.bar.join("."), Path.root.foo.bar)
|
||||
XCTAssertEqual(Path.root.foo.bar.join("../baz"), Path.root.foo.baz)
|
||||
}
|
||||
|
||||
func testEnumeration() throws {
|
||||
@@ -65,9 +69,18 @@ class PathTests: XCTestCase {
|
||||
XCTAssertEqual((Path.root/"tmp/foo/bar").relative(to: .root/"tmp/baz"), "../foo/bar")
|
||||
}
|
||||
|
||||
func testExists() {
|
||||
func testExists() throws {
|
||||
XCTAssert(Path.root.exists)
|
||||
XCTAssert((Path.root/"bin").exists)
|
||||
|
||||
try Path.mktemp { tmpdir in
|
||||
XCTAssertTrue(tmpdir.exists)
|
||||
XCTAssertFalse(try tmpdir.bar.symlink(as: tmpdir.foo).exists)
|
||||
XCTAssertTrue(tmpdir.foo.kind == .symlink)
|
||||
XCTAssertTrue(try tmpdir.bar.touch().symlink(as: tmpdir.baz).exists)
|
||||
XCTAssertTrue(tmpdir.bar.kind == .file)
|
||||
XCTAssertTrue(tmpdir.kind == .directory)
|
||||
}
|
||||
}
|
||||
|
||||
func testIsDirectory() {
|
||||
@@ -76,15 +89,19 @@ class PathTests: XCTestCase {
|
||||
}
|
||||
|
||||
func testExtension() {
|
||||
XCTAssertEqual(Path.root.join("a.swift").extension, "swift")
|
||||
XCTAssertEqual(Path.root.join("a").extension, "")
|
||||
XCTAssertEqual(Path.root.join("a.").extension, "")
|
||||
XCTAssertEqual(Path.root.join("a..").extension, "")
|
||||
XCTAssertEqual(Path.root.join("a..swift").extension, "swift")
|
||||
XCTAssertEqual(Path.root.join("a..swift.").extension, "")
|
||||
XCTAssertEqual(Path.root.join("a.tar.gz").extension, "tar.gz")
|
||||
XCTAssertEqual(Path.root.join("a..tar.gz").extension, "tar.gz")
|
||||
XCTAssertEqual(Path.root.join("a..tar..gz").extension, "gz")
|
||||
for prefix in [Path.root, Path.root.foo, Path.root.foo.bar] {
|
||||
XCTAssertEqual(prefix.join("a.swift").extension, "swift")
|
||||
XCTAssertEqual(prefix.join("a").extension, "")
|
||||
XCTAssertEqual(prefix.join("a.").extension, "")
|
||||
XCTAssertEqual(prefix.join("a..").extension, "")
|
||||
XCTAssertEqual(prefix.join("a..swift").extension, "swift")
|
||||
XCTAssertEqual(prefix.join("a..swift.").extension, "")
|
||||
XCTAssertEqual(prefix.join("a.tar.gz").extension, "tar.gz")
|
||||
XCTAssertEqual(prefix.join("a.tar.bz2").extension, "tar.bz2")
|
||||
XCTAssertEqual(prefix.join("a.tar.xz").extension, "tar.xz")
|
||||
XCTAssertEqual(prefix.join("a..tar.bz").extension, "tar.bz")
|
||||
XCTAssertEqual(prefix.join("a..tar..xz").extension, "xz")
|
||||
}
|
||||
}
|
||||
|
||||
func testMktemp() throws {
|
||||
@@ -107,28 +124,32 @@ class PathTests: XCTestCase {
|
||||
}
|
||||
|
||||
func testBasename() {
|
||||
XCTAssertEqual(Path.root.join("foo.bar").basename(dropExtension: true), "foo")
|
||||
XCTAssertEqual(Path.root.join("foo").basename(dropExtension: true), "foo")
|
||||
XCTAssertEqual(Path.root.join("foo.").basename(dropExtension: true), "foo.")
|
||||
XCTAssertEqual(Path.root.join("foo.bar.baz").basename(dropExtension: true), "foo.bar")
|
||||
for prefix in [Path.root, Path.root.foo, Path.root.foo.bar] {
|
||||
XCTAssertEqual(prefix.join("foo.bar").basename(dropExtension: true), "foo")
|
||||
XCTAssertEqual(prefix.join("foo").basename(dropExtension: true), "foo")
|
||||
XCTAssertEqual(prefix.join("foo.").basename(dropExtension: true), "foo.")
|
||||
XCTAssertEqual(prefix.join("foo.bar.baz").basename(dropExtension: true), "foo.bar")
|
||||
}
|
||||
}
|
||||
|
||||
func testCodable() throws {
|
||||
let input = [Path.root/"bar"]
|
||||
let input = [Path.root.foo, Path.root.foo.bar, Path.root]
|
||||
XCTAssertEqual(try JSONDecoder().decode([Path].self, from: try JSONEncoder().encode(input)), input)
|
||||
}
|
||||
|
||||
func testRelativePathCodable() throws {
|
||||
let root = Path.root/"bar"
|
||||
let root = Path.root.foo
|
||||
let input = [
|
||||
root/"foo"
|
||||
Path.root,
|
||||
root,
|
||||
root.bar
|
||||
]
|
||||
|
||||
let encoder = JSONEncoder()
|
||||
encoder.userInfo[.relativePath] = root
|
||||
let data = try encoder.encode(input)
|
||||
|
||||
XCTAssertEqual(try JSONSerialization.jsonObject(with: data) as? [String], ["foo"])
|
||||
XCTAssertEqual(try JSONSerialization.jsonObject(with: data) as? [String], ["..", "", "bar"])
|
||||
|
||||
let decoder = JSONDecoder()
|
||||
XCTAssertThrowsError(try decoder.decode([Path].self, from: data))
|
||||
@@ -148,8 +169,16 @@ class PathTests: XCTestCase {
|
||||
XCTAssertEqual(prefix/b/c, Path("/Users/mxcl/b/c"))
|
||||
XCTAssertEqual(Path.root/"~b", Path("/~b"))
|
||||
XCTAssertEqual(Path.root/"~/b", Path("/~/b"))
|
||||
|
||||
XCTAssertEqual(Path("~/foo"), Path.home/"foo")
|
||||
XCTAssertEqual(Path("~"), Path.home)
|
||||
XCTAssertEqual(Path("~/"), Path.home)
|
||||
XCTAssertEqual(Path("~///"), Path.home)
|
||||
XCTAssertEqual(Path("/~///"), Path.root/"~")
|
||||
XCTAssertNil(Path("~foo"))
|
||||
XCTAssertNil(Path("~foo/bar"))
|
||||
|
||||
XCTAssertEqual(Path("~\(NSUserName())"), Path.home)
|
||||
|
||||
XCTAssertEqual(Path.root/"a/foo"/"../bar", Path.root/"a/bar")
|
||||
XCTAssertEqual(Path.root/"a/foo"/"/../bar", Path.root/"a/bar")
|
||||
@@ -162,6 +191,9 @@ class PathTests: XCTestCase {
|
||||
|
||||
let a = Path.home.foo
|
||||
XCTAssertEqual(a.Documents, Path.home/"foo/Documents")
|
||||
|
||||
// verify use of the dynamic-member-subscript works according to our rules
|
||||
XCTAssertEqual(Path.home[dynamicMember: "../~foo"].string, "\(Path.home.parent.string)/~foo")
|
||||
}
|
||||
|
||||
func testCopyTo() throws {
|
||||
@@ -172,6 +204,14 @@ class PathTests: XCTestCase {
|
||||
XCTAssertThrowsError(try root.foo.copy(to: root.bar))
|
||||
try root.foo.copy(to: root.bar, overwrite: true)
|
||||
}
|
||||
|
||||
// test copy errors if directory exists at destination, even with overwrite
|
||||
try Path.mktemp { root in
|
||||
try root.foo.touch()
|
||||
XCTAssert(root.foo.isFile)
|
||||
XCTAssertThrowsError(try root.foo.copy(to: root.bar.mkdir()))
|
||||
XCTAssertThrowsError(try root.foo.copy(to: root.bar, overwrite: true))
|
||||
}
|
||||
}
|
||||
|
||||
func testCopyInto() throws {
|
||||
@@ -204,6 +244,14 @@ class PathTests: XCTestCase {
|
||||
XCTAssertThrowsError(try tmpdir.foo.touch().move(to: tmpdir.bar))
|
||||
try tmpdir.foo.move(to: tmpdir.bar, overwrite: true)
|
||||
}
|
||||
|
||||
// test move errors if directory exists at destination, even with overwrite
|
||||
try Path.mktemp { root in
|
||||
try root.foo.touch()
|
||||
XCTAssert(root.foo.isFile)
|
||||
XCTAssertThrowsError(try root.foo.move(to: root.bar.mkdir()))
|
||||
XCTAssertThrowsError(try root.foo.move(to: root.bar, overwrite: true))
|
||||
}
|
||||
}
|
||||
|
||||
func testMoveInto() throws {
|
||||
@@ -340,6 +388,21 @@ class PathTests: XCTestCase {
|
||||
#if !os(Linux)
|
||||
XCTAssertThrowsError(try tmpdir.bar3.touch().lock().delete())
|
||||
#endif
|
||||
|
||||
// regression test: can delete a symlink that points to a non-existent file
|
||||
let bar5 = try tmpdir.bar4.symlink(as: tmpdir.bar5)
|
||||
XCTAssertEqual(bar5.kind, .symlink)
|
||||
XCTAssertFalse(bar5.exists)
|
||||
XCTAssertNoThrow(try bar5.delete())
|
||||
XCTAssertEqual(bar5.kind, nil)
|
||||
|
||||
// test that deleting a symlink *only* deletes the symlink
|
||||
let bar7 = try tmpdir.bar6.touch().symlink(as: tmpdir.bar7)
|
||||
XCTAssertEqual(bar7.kind, .symlink)
|
||||
XCTAssertTrue(bar7.exists)
|
||||
XCTAssertNoThrow(try bar7.delete())
|
||||
XCTAssertEqual(bar7.kind, nil)
|
||||
XCTAssertEqual(tmpdir.bar6.kind, .file)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -364,6 +427,7 @@ class PathTests: XCTestCase {
|
||||
XCTAssertEqual(bndl.privateFrameworks, tmpdir.Frameworks)
|
||||
XCTAssertEqual(bndl.resources, tmpdir)
|
||||
XCTAssertNil(bndl.path(forResource: "foo", ofType: "bar"))
|
||||
XCTAssertNil(bndl.executable)
|
||||
|
||||
#if os(macOS)
|
||||
XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.Contents.Frameworks)
|
||||
@@ -424,4 +488,154 @@ class PathTests: XCTestCase {
|
||||
XCTAssertThrowsError(try tmpdir.bar.touch())
|
||||
}
|
||||
}
|
||||
|
||||
func testSymlinkFunctions() throws {
|
||||
try Path.mktemp { tmpdir in
|
||||
let foo = try tmpdir.foo.touch()
|
||||
let bar = try foo.symlink(as: tmpdir.bar)
|
||||
XCTAssert(bar.isSymlink)
|
||||
XCTAssertEqual(try bar.readlink(), foo)
|
||||
}
|
||||
|
||||
try Path.mktemp { tmpdir in
|
||||
let foo1 = try tmpdir.foo.touch()
|
||||
let foo2 = try foo1.symlink(into: tmpdir.bar)
|
||||
XCTAssert(foo2.isSymlink)
|
||||
XCTAssert(tmpdir.bar.isDirectory)
|
||||
XCTAssertEqual(try foo2.readlink(), foo1)
|
||||
|
||||
// cannot symlink into when `into` is an existing entry that is not a directory
|
||||
let baz = try tmpdir.baz.touch()
|
||||
XCTAssertThrowsError(try foo1.symlink(into: baz))
|
||||
}
|
||||
|
||||
try Path.mktemp { tmpdir in
|
||||
let foo = try tmpdir.foo.touch()
|
||||
let bar = try tmpdir.bar.mkdir()
|
||||
XCTAssertThrowsError(try foo.symlink(as: bar))
|
||||
XCTAssert(try foo.symlink(as: bar.foo).isSymlink)
|
||||
}
|
||||
}
|
||||
|
||||
func testReadlinkOnRelativeSymlink() throws {
|
||||
//TODO how to test on iOS etc.?
|
||||
#if os(macOS) || os(Linux)
|
||||
try Path.mktemp { tmpdir in
|
||||
let foo = try tmpdir.foo.mkdir()
|
||||
let bar = try tmpdir.bar.touch()
|
||||
|
||||
let task = Process()
|
||||
task.currentDirectoryPath = foo.string
|
||||
task.launchPath = "/bin/ln"
|
||||
task.arguments = ["-s", "../bar", "baz"]
|
||||
task.launch()
|
||||
task.waitUntilExit()
|
||||
XCTAssertEqual(task.terminationStatus, 0)
|
||||
|
||||
XCTAssert(tmpdir.foo.baz.isSymlink)
|
||||
|
||||
XCTAssertEqual(try FileManager.default.destinationOfSymbolicLink(atPath: tmpdir.foo.baz.string), "../bar")
|
||||
|
||||
XCTAssertEqual(try tmpdir.foo.baz.readlink(), bar)
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
func testReadlinkOnFileReturnsSelf() throws {
|
||||
try Path.mktemp { tmpdir in
|
||||
XCTAssertEqual(try tmpdir.foo.touch(), tmpdir.foo)
|
||||
XCTAssertEqual(try tmpdir.foo.readlink(), tmpdir.foo)
|
||||
}
|
||||
}
|
||||
|
||||
func testReadlinkOnNonExistantFileThrows() throws {
|
||||
try Path.mktemp { tmpdir in
|
||||
XCTAssertThrowsError(try tmpdir.bar.readlink())
|
||||
}
|
||||
}
|
||||
|
||||
func testReadlinkWhereLinkDestinationDoesNotExist() throws {
|
||||
try Path.mktemp { tmpdir in
|
||||
let bar = try tmpdir.foo.symlink(as: tmpdir.bar)
|
||||
XCTAssertEqual(try bar.readlink(), tmpdir.foo)
|
||||
}
|
||||
}
|
||||
|
||||
func testNoUndesiredSymlinkResolution() throws {
|
||||
|
||||
// this test because NSString.standardizingPath will resolve symlinks
|
||||
// if the path you give it contains .. and the result is an actual entry
|
||||
|
||||
try Path.mktemp { tmpdir in
|
||||
let foo = try tmpdir.foo.mkdir()
|
||||
try foo.bar.mkdir().fuz.touch()
|
||||
let baz = try foo.symlink(as: tmpdir.baz)
|
||||
XCTAssert(baz.isSymlink)
|
||||
XCTAssert(baz.bar.isDirectory)
|
||||
XCTAssertEqual(baz.bar.join("..").string, "\(tmpdir)/baz")
|
||||
|
||||
XCTAssertEqual(Path("\(tmpdir)/baz/bar/..")?.string, "\(tmpdir)/baz")
|
||||
}
|
||||
}
|
||||
|
||||
func testRealpath() throws {
|
||||
try Path.mktemp { tmpdir in
|
||||
let b = try tmpdir.a.b.mkdir(.p)
|
||||
let c = try tmpdir.a.c.touch()
|
||||
let e = try c.symlink(as: b.e)
|
||||
let f = try e.symlink(as: tmpdir.f)
|
||||
XCTAssertEqual(try f.readlink(), e)
|
||||
XCTAssertEqual(try f.realpath(), c)
|
||||
}
|
||||
|
||||
try Path.mktemp { tmpdir in
|
||||
XCTAssertThrowsError(try tmpdir.foo.realpath())
|
||||
}
|
||||
}
|
||||
|
||||
func testFileReference() throws {
|
||||
let ref = Path.home.fileReferenceURL
|
||||
#if !os(Linux)
|
||||
XCTAssertTrue(ref?.isFileReferenceURL() ?? false)
|
||||
#endif
|
||||
XCTAssertEqual(ref?.path, Path.home.string)
|
||||
}
|
||||
|
||||
func testURLInitializer() throws {
|
||||
XCTAssertEqual(Path(url: Path.home.url), Path.home)
|
||||
XCTAssertEqual(Path.home.fileReferenceURL.flatMap(Path.init), Path.home)
|
||||
XCTAssertNil(Path(url: URL(string: "https://foo.com")!))
|
||||
XCTAssertNil(Path(url: NSURL(string: "https://foo.com")!))
|
||||
}
|
||||
|
||||
func testInitializerForRelativePath() throws {
|
||||
XCTAssertNil(Path("foo"))
|
||||
XCTAssertNil(Path("../foo"))
|
||||
XCTAssertNil(Path("./foo"))
|
||||
}
|
||||
|
||||
func testPathComponents() throws {
|
||||
XCTAssertEqual(Path.root.foo.bar.components, ["/", "foo", "bar"])
|
||||
XCTAssertEqual(Path.root.components, ["/"])
|
||||
}
|
||||
|
||||
func testFlatMap() throws {
|
||||
// testing compile works
|
||||
let foo: String? = "/a"
|
||||
_ = foo.flatMap(Path.init)
|
||||
let bar: Substring? = "/a"
|
||||
_ = bar.flatMap(Path.init)
|
||||
let baz: String.SubSequence? = "/a/b:1".split(separator: ":").first
|
||||
_ = baz.flatMap(Path.init)
|
||||
}
|
||||
|
||||
func testKind() throws {
|
||||
try Path.mktemp { tmpdir in
|
||||
let foo = try tmpdir.foo.touch()
|
||||
let bar = try foo.symlink(as: tmpdir.bar)
|
||||
XCTAssertEqual(tmpdir.kind, .directory)
|
||||
XCTAssertEqual(foo.kind, .file)
|
||||
XCTAssertEqual(bar.kind, .symlink)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,11 @@
|
||||
#if !canImport(ObjectiveC)
|
||||
import XCTest
|
||||
|
||||
extension PathTests {
|
||||
static let __allTests = [
|
||||
// DO NOT MODIFY: This is autogenerated, use:
|
||||
// `swift test --generate-linuxmain`
|
||||
// to regenerate.
|
||||
static let __allTests__PathTests = [
|
||||
("testBasename", testBasename),
|
||||
("testBundleExtensions", testBundleExtensions),
|
||||
("testCodable", testCodable),
|
||||
@@ -17,14 +21,25 @@ extension PathTests {
|
||||
("testExists", testExists),
|
||||
("testExtension", testExtension),
|
||||
("testFileHandleExtensions", testFileHandleExtensions),
|
||||
("testFileReference", testFileReference),
|
||||
("testFilesystemAttributes", testFilesystemAttributes),
|
||||
("testFlatMap", testFlatMap),
|
||||
("testInitializerForRelativePath", testInitializerForRelativePath),
|
||||
("testIsDirectory", testIsDirectory),
|
||||
("testJoin", testJoin),
|
||||
("testKind", testKind),
|
||||
("testLock", testLock),
|
||||
("testMkpathIfExists", testMkpathIfExists),
|
||||
("testMktemp", testMktemp),
|
||||
("testMoveInto", testMoveInto),
|
||||
("testMoveTo", testMoveTo),
|
||||
("testNoUndesiredSymlinkResolution", testNoUndesiredSymlinkResolution),
|
||||
("testPathComponents", testPathComponents),
|
||||
("testReadlinkOnFileReturnsSelf", testReadlinkOnFileReturnsSelf),
|
||||
("testReadlinkOnNonExistantFileThrows", testReadlinkOnNonExistantFileThrows),
|
||||
("testReadlinkOnRelativeSymlink", testReadlinkOnRelativeSymlink),
|
||||
("testReadlinkWhereLinkDestinationDoesNotExist", testReadlinkWhereLinkDestinationDoesNotExist),
|
||||
("testRealpath", testRealpath),
|
||||
("testRelativeCodable", testRelativeCodable),
|
||||
("testRelativePathCodable", testRelativePathCodable),
|
||||
("testRelativeTo", testRelativeTo),
|
||||
@@ -32,15 +47,16 @@ extension PathTests {
|
||||
("testSort", testSort),
|
||||
("testStringConvertibles", testStringConvertibles),
|
||||
("testStringExtensions", testStringExtensions),
|
||||
("testSymlinkFunctions", testSymlinkFunctions),
|
||||
("testTimes", testTimes),
|
||||
("testTouchThrowsIfCannotWrite", testTouchThrowsIfCannotWrite),
|
||||
("testURLInitializer", testURLInitializer),
|
||||
]
|
||||
}
|
||||
|
||||
#if !os(macOS)
|
||||
public func __allTests() -> [XCTestCaseEntry] {
|
||||
return [
|
||||
testCase(PathTests.__allTests),
|
||||
testCase(PathTests.__allTests__PathTests),
|
||||
]
|
||||
}
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user