Compare commits
13 Commits
0.16.2
...
1.0.0-alph
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
af091cc1f0 | ||
|
|
e5188bf93b | ||
|
|
462a62920f | ||
|
|
45b0b59a94 | ||
|
|
62073d584b | ||
|
|
621d1b0160 | ||
|
|
d2bb2a1fdc | ||
|
|
38e98ee7fd | ||
|
|
dac007e907 | ||
|
|
b6b4a74a26 | ||
|
|
b76db41ca4 | ||
|
|
8d5d67b81b | ||
|
|
21ddc7dc3a |
168
.github/deploy
vendored
168
.github/deploy
vendored
@@ -1,168 +0,0 @@
|
|||||||
#!/usr/bin/swift sh
|
|
||||||
import func Darwin.fputs
|
|
||||||
import var Darwin.stderr
|
|
||||||
import PMKFoundation // PromiseKit/Foundation ~> 3.3
|
|
||||||
import LegibleError // @mxcl ~> 1.0
|
|
||||||
import Foundation
|
|
||||||
import PromiseKit // @mxcl ~> 6.8
|
|
||||||
import Path // mxcl/Path.swift ~> 0.15
|
|
||||||
|
|
||||||
let env = ProcessInfo.processInfo.environment
|
|
||||||
let token = env["GITHUB_TOKEN"] ?? env["GITHUB_ACCESS_TOKEN"]!
|
|
||||||
let slug = env["TRAVIS_REPO_SLUG"]!
|
|
||||||
let tag = env["TRAVIS_TAG"]!
|
|
||||||
|
|
||||||
func fatal(message: String) -> Never {
|
|
||||||
fputs("error: \(message)\n", stderr)
|
|
||||||
exit(1)
|
|
||||||
}
|
|
||||||
func fatal(error: Error) -> Never {
|
|
||||||
fatal(message: "\(error.legibleLocalizedDescription)\n\n\(error.legibleDescription)")
|
|
||||||
}
|
|
||||||
|
|
||||||
struct Repo: Decodable {
|
|
||||||
let description: String
|
|
||||||
let license: License
|
|
||||||
struct License: Decodable {
|
|
||||||
let spdx_id: String
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
struct Package: Decodable {
|
|
||||||
let swiftLanguageVersions: [String]
|
|
||||||
let targets: [Target]
|
|
||||||
struct Target: Decodable {
|
|
||||||
let path: String?
|
|
||||||
let type: Kind
|
|
||||||
enum Kind: String, Decodable {
|
|
||||||
case regular
|
|
||||||
case test
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
extension URLRequest {
|
|
||||||
init(github path: String) {
|
|
||||||
let url = URL(string: "https://api.github.com\(path)")!
|
|
||||||
self.init(url: url)
|
|
||||||
setValue("token \(token)", forHTTPHeaderField: "Authorization")
|
|
||||||
setValue("application/json", forHTTPHeaderField: "Content-Type")
|
|
||||||
setValue("application/json", forHTTPHeaderField: "Accept")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func description() -> Promise<Repo> {
|
|
||||||
let rq = URLRequest(github: "/repos/\(slug)")
|
|
||||||
return firstly {
|
|
||||||
URLSession.shared.dataTask(.promise, with: rq).validate()
|
|
||||||
}.map { data, _ in
|
|
||||||
try JSONDecoder().decode(Repo.self, from: data)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
struct User: Decodable {
|
|
||||||
let name: String
|
|
||||||
let email: String
|
|
||||||
}
|
|
||||||
|
|
||||||
func email() -> Promise<User> {
|
|
||||||
let rq = URLRequest(github: "/user")
|
|
||||||
return firstly {
|
|
||||||
URLSession.shared.dataTask(.promise, with: rq).validate()
|
|
||||||
}.map { data, _ in
|
|
||||||
try JSONDecoder().decode(User.self, from: data)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func dumpPackage() -> Promise<Package> {
|
|
||||||
let task = Process()
|
|
||||||
task.launchPath = "/usr/bin/swift"
|
|
||||||
task.arguments = ["package", "dump-package"]
|
|
||||||
return firstly {
|
|
||||||
task.launch(.promise)
|
|
||||||
}.map { out, _ in
|
|
||||||
out.fileHandleForReading.readDataToEndOfFile()
|
|
||||||
}.map { data in
|
|
||||||
try JSONDecoder().decode(Package.self, from: data)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var defaultSwiftVersion: String {
|
|
||||||
let task = Process()
|
|
||||||
task.launchPath = "/usr/bin/swift"
|
|
||||||
task.arguments = ["--version"]
|
|
||||||
|
|
||||||
func extract(input: String) -> String {
|
|
||||||
let range = input.range(of: #"Apple Swift version \d+\.\d+"#, options: .regularExpression)!
|
|
||||||
return String(input[range].split(separator: " ").last!)
|
|
||||||
}
|
|
||||||
|
|
||||||
return try! firstly {
|
|
||||||
task.launch(.promise)
|
|
||||||
}.compactMap { out, _ in
|
|
||||||
String(data: out.fileHandleForReading.readDataToEndOfFile(), encoding: .utf8)
|
|
||||||
}.map { out in
|
|
||||||
extract(input: out)
|
|
||||||
}.wait()
|
|
||||||
}
|
|
||||||
|
|
||||||
func podspec(repo: Repo, user: User, pkg: Package) -> (Substring, String) {
|
|
||||||
let (owner, name) = { ($0[0], $0[1]) }(slug.split(separator: "/"))
|
|
||||||
let swiftVersion = pkg.swiftLanguageVersions.min() ?? defaultSwiftVersion
|
|
||||||
let targets = pkg.targets.filter{ $0.type == .regular }
|
|
||||||
guard targets.count == 1 else { fatal(message: "Too many targets for this script!") }
|
|
||||||
guard let sources = targets[0].path else { fatal(message: "Target has no path!") }
|
|
||||||
return (name, """
|
|
||||||
Pod::Spec.new do |s|
|
|
||||||
s.name = '\(name)'
|
|
||||||
s.author = { '\(user.name)': '\(user.email)' }
|
|
||||||
s.source = { git: "https://github.com/\(slug).git", tag: '\(tag)' }
|
|
||||||
s.version = '\(tag)'
|
|
||||||
s.summary = '\(repo.description)'
|
|
||||||
s.license = '\(repo.license.spdx_id)'
|
|
||||||
s.homepage = "https://github.com/\(slug)"
|
|
||||||
s.social_media_url = 'https://twitter.com/\(owner)'
|
|
||||||
s.osx.deployment_target = '10.10'
|
|
||||||
s.ios.deployment_target = '8.0'
|
|
||||||
s.tvos.deployment_target = '9.0'
|
|
||||||
s.watchos.deployment_target = '2.0'
|
|
||||||
s.source_files = '\(sources)/*.swift'
|
|
||||||
s.swift_version = '\(swiftVersion)'
|
|
||||||
end
|
|
||||||
""")
|
|
||||||
}
|
|
||||||
|
|
||||||
func publishRelease() throws -> Promise<Void> {
|
|
||||||
struct Input: Encodable {
|
|
||||||
let tag_name = tag
|
|
||||||
let name = tag
|
|
||||||
let body = ""
|
|
||||||
}
|
|
||||||
|
|
||||||
var rq = URLRequest(github: "/repos/\(slug)/releases")
|
|
||||||
rq.httpMethod = "POST"
|
|
||||||
rq.httpBody = try JSONEncoder().encode(Input())
|
|
||||||
return URLSession.shared.dataTask(.promise, with: rq).validate().asVoid()
|
|
||||||
}
|
|
||||||
|
|
||||||
switch CommandLine.arguments[1] {
|
|
||||||
case "generate-podspec":
|
|
||||||
firstly {
|
|
||||||
when(fulfilled: description(), email(), dumpPackage())
|
|
||||||
}.map(podspec).done { name, podspec in
|
|
||||||
try podspec.write(toFile: "\(name).podspec", atomically: false, encoding: .utf8)
|
|
||||||
exit(0)
|
|
||||||
}.catch {
|
|
||||||
fatal(error: $0)
|
|
||||||
}
|
|
||||||
case "publish-release":
|
|
||||||
try publishRelease().done {
|
|
||||||
exit(0)
|
|
||||||
}.catch {
|
|
||||||
fatal(error: $0)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
fatal(message: "invalid usage")
|
|
||||||
}
|
|
||||||
|
|
||||||
RunLoop.main.run()
|
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -3,3 +3,4 @@
|
|||||||
/*.xcodeproj
|
/*.xcodeproj
|
||||||
/build
|
/build
|
||||||
/docs
|
/docs
|
||||||
|
/.swiftpm
|
||||||
|
|||||||
31
.travis.yml
31
.travis.yml
@@ -1,11 +1,11 @@
|
|||||||
# only run for: merge commits, releases and pull-requests
|
# only run for: merge commits, releases and pull-requests
|
||||||
if: type != push OR branch = master OR branch =~ /^\d+\.\d+(\.\d+)?(-\S*)?$/
|
if: type != push OR branch = master OR branch =~ /^\d+\.\d+\.\d+(-.*)?$/
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- name: pretest
|
- name: pretest
|
||||||
- name: test
|
- name: test
|
||||||
- name: deploy
|
- name: deploy
|
||||||
if: branch =~ ^\d+\.\d+\.\d+$
|
if: branch =~ /^\d+\.\d+\.\d+(-.*)?$/
|
||||||
|
|
||||||
os: osx
|
os: osx
|
||||||
language: swift
|
language: swift
|
||||||
@@ -25,6 +25,10 @@ jobs:
|
|||||||
osx_image: xcode10.2
|
osx_image: xcode10.2
|
||||||
script: swift test --parallel
|
script: swift test --parallel
|
||||||
|
|
||||||
|
- name: macOS / Swift 5.1
|
||||||
|
osx_image: xcode11
|
||||||
|
script: swift test --parallel
|
||||||
|
|
||||||
- &xcodebuild
|
- &xcodebuild
|
||||||
before_install: swift package generate-xcodeproj --enable-code-coverage
|
before_install: swift package generate-xcodeproj --enable-code-coverage
|
||||||
xcode_destination: platform=iOS Simulator,OS=latest,name=iPhone XS
|
xcode_destination: platform=iOS Simulator,OS=latest,name=iPhone XS
|
||||||
@@ -47,18 +51,21 @@ jobs:
|
|||||||
after_success: false
|
after_success: false
|
||||||
|
|
||||||
- &linux
|
- &linux
|
||||||
env: SWIFT_VERSION=4.2.1
|
env: SWIFT_VERSION=4.2.4
|
||||||
os: linux
|
os: linux
|
||||||
name: Linux / Swift 4.2.1
|
name: Linux / Swift 4.2.4
|
||||||
language: generic
|
language: generic
|
||||||
dist: trusty
|
|
||||||
sudo: false
|
sudo: false
|
||||||
install: eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
|
install: eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
|
||||||
script: swift test --parallel
|
script: swift test --parallel
|
||||||
|
|
||||||
- <<: *linux
|
- <<: *linux
|
||||||
env: SWIFT_VERSION='5.0-DEVELOPMENT-SNAPSHOT-2019-01-22-a'
|
env: SWIFT_VERSION='5.0.2'
|
||||||
name: Linux / Swift 5.0.0-dev+2019.01.22
|
name: Linux / Swift 5.0.2
|
||||||
|
|
||||||
|
- <<: *linux
|
||||||
|
env: SWIFT_VERSION=5.1-DEVELOPMENT-SNAPSHOT-2019-07-03-a
|
||||||
|
name: Linux / Swift 5.1 (2019-07-03)
|
||||||
|
|
||||||
- stage: pretest
|
- stage: pretest
|
||||||
name: Check Linux tests are sync’d
|
name: Check Linux tests are sync’d
|
||||||
@@ -68,6 +75,7 @@ jobs:
|
|||||||
|
|
||||||
- stage: deploy
|
- stage: deploy
|
||||||
name: Jazzy
|
name: Jazzy
|
||||||
|
osx_image: xcode10.2
|
||||||
install: gem install jazzy
|
install: gem install jazzy
|
||||||
before_script: swift package generate-xcodeproj
|
before_script: swift package generate-xcodeproj
|
||||||
script: |
|
script: |
|
||||||
@@ -84,7 +92,10 @@ jobs:
|
|||||||
|
|
||||||
- name: CocoaPods
|
- name: CocoaPods
|
||||||
osx_image: xcode10.2
|
osx_image: xcode10.2
|
||||||
install: brew install mxcl/made/swift-sh
|
install: |
|
||||||
before_script: .github/deploy generate-podspec
|
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
|
script: pod trunk push
|
||||||
after_success: .github/deploy publish-release
|
after_success: ./deploy publish-release
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
// swift-tools-version:4.2
|
// swift-tools-version:4.2
|
||||||
import PackageDescription
|
import PackageDescription
|
||||||
|
|
||||||
let pkg = Package(
|
let package = Package(
|
||||||
name: "Path.swift",
|
name: "Path.swift",
|
||||||
products: [
|
products: [
|
||||||
.library(name: "Path", targets: ["Path"]),
|
.library(name: "Path", targets: ["Path"]),
|
||||||
|
|||||||
63
README.md
63
README.md
@@ -32,7 +32,7 @@ let foo = try Path.root.join("foo").copy(into: Path.root.join("bar").mkdir())
|
|||||||
print(foo) // => /bar/foo
|
print(foo) // => /bar/foo
|
||||||
print(foo.isFile) // => true
|
print(foo.isFile) // => true
|
||||||
|
|
||||||
// we support dynamic members (_use_sparingly_):
|
// we support dynamic-member-syntax when joining named static members, eg:
|
||||||
let prefs = Path.home.Library.Preferences // => /Users/mxcl/Library/Preferences
|
let prefs = Path.home.Library.Preferences // => /Users/mxcl/Library/Preferences
|
||||||
|
|
||||||
// a practical example: installing a helper executable
|
// a practical example: installing a helper executable
|
||||||
@@ -107,10 +107,11 @@ We support `@dynamicMemberLookup`:
|
|||||||
let ls = Path.root.usr.bin.ls // => /usr/bin/ls
|
let ls = Path.root.usr.bin.ls // => /usr/bin/ls
|
||||||
```
|
```
|
||||||
|
|
||||||
This is less commonly useful than you would think, hence our documentation
|
We only provide this for “starting” function, eg. `Path.home` or `Bundle.path`.
|
||||||
does not use it. Usually you are joining variables or other `String` arguments
|
This is because we found in practice it was easy to write incorrect code, since
|
||||||
or trying to describe files (and files usually have extensions). However when
|
everything would compile if we allowed arbituary variables to take *any* named
|
||||||
you need it, it’s *lovely*.
|
property as valid syntax. What we have is what you want most of the time but
|
||||||
|
much less dangerous.
|
||||||
|
|
||||||
## Initializing from user-input
|
## Initializing from user-input
|
||||||
|
|
||||||
@@ -146,27 +147,61 @@ try Bundle.main.resources.join("foo").copy(to: .home)
|
|||||||
## Directory listings
|
## Directory listings
|
||||||
|
|
||||||
We provide `ls()`, called because it behaves like the Terminal `ls` function,
|
We provide `ls()`, called because it behaves like the Terminal `ls` function,
|
||||||
the name thus implies its behavior, ie. that it is not recursive.
|
the name thus implies its behavior, ie. that it is not recursive and doesn’t
|
||||||
|
list hidden files.
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
for entry in Path.home.ls() {
|
for path in Path.home.ls() {
|
||||||
print(entry.path)
|
|
||||||
print(entry.kind) // .directory or .file
|
|
||||||
}
|
|
||||||
|
|
||||||
for entry in Path.home.ls() where entry.kind == .file {
|
|
||||||
//…
|
//…
|
||||||
}
|
}
|
||||||
|
|
||||||
for entry in Path.home.ls() where entry.path.mtime > yesterday {
|
for path in Path.home.ls() where path.isFile {
|
||||||
|
//…
|
||||||
|
}
|
||||||
|
|
||||||
|
for path in Path.home.ls() where path.mtime > yesterday {
|
||||||
//…
|
//…
|
||||||
}
|
}
|
||||||
|
|
||||||
let dirs = Path.home.ls().directories
|
let dirs = Path.home.ls().directories
|
||||||
|
// ^^ directories that *exist*
|
||||||
|
|
||||||
let files = Path.home.ls().files
|
let files = Path.home.ls().files
|
||||||
|
// ^^ files that both *exist* and are *not* directories
|
||||||
|
|
||||||
let swiftFiles = Path.home.ls().files(withExtension: "swift")
|
let swiftFiles = Path.home.ls().files.filter{ $0.extension == "swift" }
|
||||||
|
```
|
||||||
|
|
||||||
|
We provide `find()` for recursive listing:
|
||||||
|
|
||||||
|
```swift
|
||||||
|
Path.home.find().execute { path in
|
||||||
|
//…
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Which is configurable:
|
||||||
|
|
||||||
|
```swift
|
||||||
|
Path.home.find().maxDepth(1).extension("swift").kind(.file) { path in
|
||||||
|
//…
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
And can be controlled:
|
||||||
|
|
||||||
|
```swift
|
||||||
|
Path.home.find().execute { path in
|
||||||
|
guard foo else { return .skip }
|
||||||
|
guard bar else { return .abort }
|
||||||
|
return .continue
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Or just get all paths at once:
|
||||||
|
|
||||||
|
```swift
|
||||||
|
let paths = Path.home.find().execute()
|
||||||
```
|
```
|
||||||
|
|
||||||
# `Path.swift` is robust
|
# `Path.swift` is robust
|
||||||
|
|||||||
@@ -13,31 +13,31 @@ public extension Bundle {
|
|||||||
Returns the path for the shared-frameworks directory in this bundle.
|
Returns the path for the shared-frameworks directory in this bundle.
|
||||||
- Note: This is typically `ShareFrameworks`
|
- Note: This is typically `ShareFrameworks`
|
||||||
*/
|
*/
|
||||||
var sharedFrameworks: Path {
|
var sharedFrameworks: DynamicPath {
|
||||||
return sharedFrameworksPath.flatMap(Path.init) ?? defaultSharedFrameworksPath
|
return sharedFrameworksPath.flatMap(DynamicPath.init) ?? defaultSharedFrameworksPath
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Returns the path for the private-frameworks directory in this bundle.
|
Returns the path for the private-frameworks directory in this bundle.
|
||||||
- Note: This is typically `Frameworks`
|
- Note: This is typically `Frameworks`
|
||||||
*/
|
*/
|
||||||
var privateFrameworks: Path {
|
var privateFrameworks: DynamicPath {
|
||||||
return privateFrameworksPath.flatMap(Path.init) ?? defaultSharedFrameworksPath
|
return privateFrameworksPath.flatMap(DynamicPath.init) ?? defaultSharedFrameworksPath
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the path for the resources directory in this bundle.
|
/// Returns the path for the resources directory in this bundle.
|
||||||
var resources: Path {
|
var resources: DynamicPath {
|
||||||
return resourcePath.flatMap(Path.init) ?? defaultResourcesPath
|
return resourcePath.flatMap(DynamicPath.init) ?? defaultResourcesPath
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the path for this bundle.
|
/// Returns the path for this bundle.
|
||||||
var path: Path {
|
var path: DynamicPath {
|
||||||
return Path(string: bundlePath)
|
return DynamicPath(string: bundlePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the executable for this bundle, if there is one, not all bundles have one hence `Optional`.
|
/// Returns the executable for this bundle, if there is one, not all bundles have one hence `Optional`.
|
||||||
var executable: Path? {
|
var executable: DynamicPath? {
|
||||||
return executablePath.flatMap(Path.init)
|
return executablePath.flatMap(DynamicPath.init)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -45,14 +45,14 @@ public extension Bundle {
|
|||||||
public extension String {
|
public extension String {
|
||||||
/// Initializes this `String` with the contents of the provided path.
|
/// Initializes this `String` with the contents of the provided path.
|
||||||
@inlinable
|
@inlinable
|
||||||
init(contentsOf path: Path) throws {
|
init<P: Pathish>(contentsOf path: P) throws {
|
||||||
try self.init(contentsOfFile: path.string)
|
try self.init(contentsOfFile: path.string)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// - Returns: `to` to allow chaining
|
/// - Returns: `to` to allow chaining
|
||||||
@inlinable
|
@inlinable
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func write(to: Path, atomically: Bool = false, encoding: String.Encoding = .utf8) throws -> Path {
|
func write<P: Pathish>(to: P, atomically: Bool = false, encoding: String.Encoding = .utf8) throws -> P {
|
||||||
try write(toFile: to.string, atomically: atomically, encoding: encoding)
|
try write(toFile: to.string, atomically: atomically, encoding: encoding)
|
||||||
return to
|
return to
|
||||||
}
|
}
|
||||||
@@ -62,14 +62,14 @@ public extension String {
|
|||||||
public extension Data {
|
public extension Data {
|
||||||
/// Initializes this `Data` with the contents of the provided path.
|
/// Initializes this `Data` with the contents of the provided path.
|
||||||
@inlinable
|
@inlinable
|
||||||
init(contentsOf path: Path) throws {
|
init<P: Pathish>(contentsOf path: P) throws {
|
||||||
try self.init(contentsOf: path.url)
|
try self.init(contentsOf: path.url)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// - Returns: `to` to allow chaining
|
/// - Returns: `to` to allow chaining
|
||||||
@inlinable
|
@inlinable
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func write(to: Path, atomically: Bool = false) throws -> Path {
|
func write<P: Pathish>(to: P, atomically: Bool = false) throws -> P {
|
||||||
let opts: NSData.WritingOptions
|
let opts: NSData.WritingOptions
|
||||||
if atomically {
|
if atomically {
|
||||||
#if !os(Linux)
|
#if !os(Linux)
|
||||||
@@ -89,39 +89,39 @@ public extension Data {
|
|||||||
public extension FileHandle {
|
public extension FileHandle {
|
||||||
/// Initializes this `FileHandle` for reading at the location of the provided path.
|
/// Initializes this `FileHandle` for reading at the location of the provided path.
|
||||||
@inlinable
|
@inlinable
|
||||||
convenience init(forReadingAt path: Path) throws {
|
convenience init<P: Pathish>(forReadingAt path: P) throws {
|
||||||
try self.init(forReadingFrom: path.url)
|
try self.init(forReadingFrom: path.url)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Initializes this `FileHandle` for writing at the location of the provided path.
|
/// Initializes this `FileHandle` for writing at the location of the provided path.
|
||||||
@inlinable
|
@inlinable
|
||||||
convenience init(forWritingAt path: Path) throws {
|
convenience init<P: Pathish>(forWritingAt path: P) throws {
|
||||||
try self.init(forWritingTo: path.url)
|
try self.init(forWritingTo: path.url)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Initializes this `FileHandle` for reading and writing at the location of the provided path.
|
/// Initializes this `FileHandle` for reading and writing at the location of the provided path.
|
||||||
@inlinable
|
@inlinable
|
||||||
convenience init(forUpdatingAt path: Path) throws {
|
convenience init<P: Pathish>(forUpdatingAt path: P) throws {
|
||||||
try self.init(forUpdating: path.url)
|
try self.init(forUpdating: path.url)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
internal extension Bundle {
|
internal extension Bundle {
|
||||||
var defaultSharedFrameworksPath: Path {
|
var defaultSharedFrameworksPath: DynamicPath {
|
||||||
#if os(macOS)
|
#if os(macOS)
|
||||||
return path.join("Contents/Frameworks")
|
return path.Contents.Frameworks
|
||||||
#elseif os(Linux)
|
#elseif os(Linux)
|
||||||
return path.join("lib")
|
return path.lib
|
||||||
#else
|
#else
|
||||||
return path.join("Frameworks")
|
return path.Frameworks
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
var defaultResourcesPath: Path {
|
var defaultResourcesPath: DynamicPath {
|
||||||
#if os(macOS)
|
#if os(macOS)
|
||||||
return path.join("Contents/Resources")
|
return path.Contents.Resources
|
||||||
#elseif os(Linux)
|
#elseif os(Linux)
|
||||||
return path.join("share")
|
return path.share
|
||||||
#else
|
#else
|
||||||
return path
|
return path
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
public extension Path {
|
public extension Pathish {
|
||||||
//MARK: Filesystem Attributes
|
//MARK: Filesystem Attributes
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -38,7 +38,7 @@ public extension Path {
|
|||||||
@discardableResult
|
@discardableResult
|
||||||
func chmod(_ octal: Int) throws -> Path {
|
func chmod(_ octal: Int) throws -> Path {
|
||||||
try FileManager.default.setAttributes([.posixPermissions: octal], ofItemAtPath: string)
|
try FileManager.default.setAttributes([.posixPermissions: octal], ofItemAtPath: string)
|
||||||
return self
|
return Path(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -57,7 +57,7 @@ public extension Path {
|
|||||||
try FileManager.default.setAttributes(attrs, ofItemAtPath: string)
|
try FileManager.default.setAttributes(attrs, ofItemAtPath: string)
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
return self
|
return Path(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -73,7 +73,7 @@ public extension Path {
|
|||||||
do {
|
do {
|
||||||
attrs = try FileManager.default.attributesOfItem(atPath: string)
|
attrs = try FileManager.default.attributesOfItem(atPath: string)
|
||||||
} catch CocoaError.fileReadNoSuchFile {
|
} catch CocoaError.fileReadNoSuchFile {
|
||||||
return self
|
return Path(self)
|
||||||
}
|
}
|
||||||
let b = attrs[.immutable] as? Bool ?? false
|
let b = attrs[.immutable] as? Bool ?? false
|
||||||
if b {
|
if b {
|
||||||
@@ -81,14 +81,10 @@ public extension Path {
|
|||||||
try FileManager.default.setAttributes(attrs, ofItemAtPath: string)
|
try FileManager.default.setAttributes(attrs, ofItemAtPath: string)
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
return self
|
return Path(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
enum Kind {
|
var kind: Path.Kind? {
|
||||||
case file, symlink, directory
|
|
||||||
}
|
|
||||||
|
|
||||||
var kind: Kind? {
|
|
||||||
var buf = stat()
|
var buf = stat()
|
||||||
guard lstat(string, &buf) == 0 else {
|
guard lstat(string, &buf) == 0 else {
|
||||||
return nil
|
return nil
|
||||||
@@ -102,3 +98,9 @@ public extension Path {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public extension Path {
|
||||||
|
enum Kind {
|
||||||
|
case file, symlink, directory
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -30,11 +30,12 @@ extension Path: Codable {
|
|||||||
let value = try decoder.singleValueContainer().decode(String.self)
|
let value = try decoder.singleValueContainer().decode(String.self)
|
||||||
if value.hasPrefix("/") {
|
if value.hasPrefix("/") {
|
||||||
string = value
|
string = value
|
||||||
} else {
|
} else if let root = decoder.userInfo[.relativePath] as? Path {
|
||||||
guard let root = decoder.userInfo[.relativePath] as? Path else {
|
|
||||||
throw DecodingError.dataCorrupted(.init(codingPath: [], debugDescription: "Path cannot decode a relative path if `userInfo[.relativePath]` not set to a Path object."))
|
|
||||||
}
|
|
||||||
string = (root/value).string
|
string = (root/value).string
|
||||||
|
} else if let root = decoder.userInfo[.relativePath] as? DynamicPath {
|
||||||
|
string = (root/value).string
|
||||||
|
} else {
|
||||||
|
throw DecodingError.dataCorrupted(.init(codingPath: [], debugDescription: "Path cannot decode a relative path if `userInfo[.relativePath]` not set to a Path object."))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -44,6 +45,8 @@ extension Path: Codable {
|
|||||||
var container = encoder.singleValueContainer()
|
var container = encoder.singleValueContainer()
|
||||||
if let root = encoder.userInfo[.relativePath] as? Path {
|
if let root = encoder.userInfo[.relativePath] as? Path {
|
||||||
try container.encode(relative(to: root))
|
try container.encode(relative(to: root))
|
||||||
|
} else if let root = encoder.userInfo[.relativePath] as? DynamicPath {
|
||||||
|
try container.encode(relative(to: root))
|
||||||
} else {
|
} else {
|
||||||
try container.encode(string)
|
try container.encode(string)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,17 +4,17 @@ extension Path {
|
|||||||
//MARK: Common Directories
|
//MARK: Common Directories
|
||||||
|
|
||||||
/// Returns a `Path` containing `FileManager.default.currentDirectoryPath`.
|
/// Returns a `Path` containing `FileManager.default.currentDirectoryPath`.
|
||||||
public static var cwd: Path {
|
public static var cwd: DynamicPath {
|
||||||
return Path(string: FileManager.default.currentDirectoryPath)
|
return .init(string: FileManager.default.currentDirectoryPath)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a `Path` representing the root path.
|
/// Returns a `Path` representing the root path.
|
||||||
public static var root: Path {
|
public static var root: DynamicPath {
|
||||||
return Path(string: "/")
|
return .init(string: "/")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a `Path` representing the user’s home directory
|
/// Returns a `Path` representing the user’s home directory
|
||||||
public static var home: Path {
|
public static var home: DynamicPath {
|
||||||
let string: String
|
let string: String
|
||||||
#if os(macOS)
|
#if os(macOS)
|
||||||
if #available(OSX 10.12, *) {
|
if #available(OSX 10.12, *) {
|
||||||
@@ -25,30 +25,30 @@ extension Path {
|
|||||||
#else
|
#else
|
||||||
string = NSHomeDirectory()
|
string = NSHomeDirectory()
|
||||||
#endif
|
#endif
|
||||||
return Path(string: string)
|
return .init(string: string)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Helper to allow search path and domain mask to be passed in.
|
/// Helper to allow search path and domain mask to be passed in.
|
||||||
private static func path(for searchPath: FileManager.SearchPathDirectory) -> Path {
|
private static func path(for searchPath: FileManager.SearchPathDirectory) -> DynamicPath {
|
||||||
#if os(Linux)
|
#if os(Linux)
|
||||||
// the urls(for:in:) function is not implemented on Linux
|
// the urls(for:in:) function is not implemented on Linux
|
||||||
//TODO strictly we should first try to use the provided binary tool
|
//TODO strictly we should first try to use the provided binary tool
|
||||||
|
|
||||||
let foo = { ProcessInfo.processInfo.environment[$0].flatMap(Path.init) ?? $1 }
|
let foo = { ProcessInfo.processInfo.environment[$0].flatMap(Path.init).map(DynamicPath.init) ?? $1 }
|
||||||
|
|
||||||
switch searchPath {
|
switch searchPath {
|
||||||
case .documentDirectory:
|
case .documentDirectory:
|
||||||
return Path.home/"Documents"
|
return Path.home.Documents
|
||||||
case .applicationSupportDirectory:
|
case .applicationSupportDirectory:
|
||||||
return foo("XDG_DATA_HOME", Path.home/".local/share")
|
return foo("XDG_DATA_HOME", Path.home[dynamicMember: ".local/share"])
|
||||||
case .cachesDirectory:
|
case .cachesDirectory:
|
||||||
return foo("XDG_CACHE_HOME", Path.home/".cache")
|
return foo("XDG_CACHE_HOME", Path.home[dynamicMember: ".cache"])
|
||||||
default:
|
default:
|
||||||
fatalError()
|
fatalError()
|
||||||
}
|
}
|
||||||
#else
|
#else
|
||||||
guard let pathString = FileManager.default.urls(for: searchPath, in: .userDomainMask).first?.path else { return defaultUrl(for: searchPath) }
|
guard let pathString = FileManager.default.urls(for: searchPath, in: .userDomainMask).first?.path else { return defaultUrl(for: searchPath) }
|
||||||
return Path(string: pathString)
|
return DynamicPath(string: pathString)
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -57,7 +57,7 @@ extension Path {
|
|||||||
- Note: There is no standard location for documents on Linux, thus we return `~/Documents`.
|
- Note: There is no standard location for documents on Linux, thus we return `~/Documents`.
|
||||||
- Note: You should create a subdirectory before creating any files.
|
- Note: You should create a subdirectory before creating any files.
|
||||||
*/
|
*/
|
||||||
public static var documents: Path {
|
public static var documents: DynamicPath {
|
||||||
return path(for: .documentDirectory)
|
return path(for: .documentDirectory)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ extension Path {
|
|||||||
- Note: On Linux this is `XDG_CACHE_HOME`.
|
- Note: On Linux this is `XDG_CACHE_HOME`.
|
||||||
- Note: You should create a subdirectory before creating any files.
|
- Note: You should create a subdirectory before creating any files.
|
||||||
*/
|
*/
|
||||||
public static var caches: Path {
|
public static var caches: DynamicPath {
|
||||||
return path(for: .cachesDirectory)
|
return path(for: .cachesDirectory)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,20 +75,20 @@ extension Path {
|
|||||||
- Note: On Linux is `XDG_DATA_HOME`.
|
- Note: On Linux is `XDG_DATA_HOME`.
|
||||||
- Note: You should create a subdirectory before creating any files.
|
- Note: You should create a subdirectory before creating any files.
|
||||||
*/
|
*/
|
||||||
public static var applicationSupport: Path {
|
public static var applicationSupport: DynamicPath {
|
||||||
return path(for: .applicationSupportDirectory)
|
return path(for: .applicationSupportDirectory)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#if !os(Linux)
|
#if !os(Linux)
|
||||||
func defaultUrl(for searchPath: FileManager.SearchPathDirectory) -> Path {
|
func defaultUrl(for searchPath: FileManager.SearchPathDirectory) -> DynamicPath {
|
||||||
switch searchPath {
|
switch searchPath {
|
||||||
case .documentDirectory:
|
case .documentDirectory:
|
||||||
return Path.home/"Documents"
|
return Path.home.Documents
|
||||||
case .applicationSupportDirectory:
|
case .applicationSupportDirectory:
|
||||||
return Path.home/"Library/Application Support"
|
return Path.home.Library[dynamicMember: "Application Support"]
|
||||||
case .cachesDirectory:
|
case .cachesDirectory:
|
||||||
return Path.home/"Library/Caches"
|
return Path.home.Library.Caches
|
||||||
default:
|
default:
|
||||||
fatalError()
|
fatalError()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import Foundation
|
|||||||
import Glibc
|
import Glibc
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
public extension Path {
|
public extension Pathish {
|
||||||
//MARK: File Management
|
//MARK: File Management
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -24,17 +24,17 @@ public extension Path {
|
|||||||
- SeeAlso: `copy(into:overwrite:)`
|
- SeeAlso: `copy(into:overwrite:)`
|
||||||
*/
|
*/
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func copy(to: Path, overwrite: Bool = false) throws -> Path {
|
func copy<P: Pathish>(to: P, overwrite: Bool = false) throws -> Path {
|
||||||
if overwrite, let tokind = to.kind, tokind != .directory, kind != .directory {
|
if overwrite, let tokind = to.kind, tokind != .directory, kind != .directory {
|
||||||
try FileManager.default.removeItem(at: to.url)
|
try FileManager.default.removeItem(at: to.url)
|
||||||
}
|
}
|
||||||
#if os(Linux) && !swift(>=5.1) // check if fixed
|
#if os(Linux) && !swift(>=5.2) // check if fixed
|
||||||
if !overwrite, to.kind != nil {
|
if !overwrite, to.kind != nil {
|
||||||
throw CocoaError.error(.fileWriteFileExists)
|
throw CocoaError.error(.fileWriteFileExists)
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
try FileManager.default.copyItem(atPath: string, toPath: to.string)
|
try FileManager.default.copyItem(atPath: string, toPath: to.string)
|
||||||
return to
|
return Path(to)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -60,7 +60,7 @@ public extension Path {
|
|||||||
- SeeAlso: `copy(to:overwrite:)`
|
- SeeAlso: `copy(to:overwrite:)`
|
||||||
*/
|
*/
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func copy(into: Path, overwrite: Bool = false) throws -> Path {
|
func copy<P: Pathish>(into: P, overwrite: Bool = false) throws -> Path {
|
||||||
if into.kind == nil {
|
if into.kind == nil {
|
||||||
try into.mkdir(.p)
|
try into.mkdir(.p)
|
||||||
}
|
}
|
||||||
@@ -68,7 +68,7 @@ public extension Path {
|
|||||||
if overwrite, let kind = rv.kind, kind != .directory {
|
if overwrite, let kind = rv.kind, kind != .directory {
|
||||||
try FileManager.default.removeItem(at: rv.url)
|
try FileManager.default.removeItem(at: rv.url)
|
||||||
}
|
}
|
||||||
#if os(Linux) && !swift(>=5.1) // check if fixed
|
#if os(Linux) && !swift(>=5.2) // check if fixed
|
||||||
if !overwrite, rv.kind != nil {
|
if !overwrite, rv.kind != nil {
|
||||||
throw CocoaError.error(.fileWriteFileExists)
|
throw CocoaError.error(.fileWriteFileExists)
|
||||||
}
|
}
|
||||||
@@ -94,12 +94,12 @@ public extension Path {
|
|||||||
- SeeAlso: `move(into:overwrite:)`
|
- SeeAlso: `move(into:overwrite:)`
|
||||||
*/
|
*/
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func move(to: Path, overwrite: Bool = false) throws -> Path {
|
func move<P: Pathish>(to: P, overwrite: Bool = false) throws -> Path {
|
||||||
if overwrite, let kind = to.kind, kind != .directory {
|
if overwrite, let kind = to.kind, kind != .directory {
|
||||||
try FileManager.default.removeItem(at: to.url)
|
try FileManager.default.removeItem(at: to.url)
|
||||||
}
|
}
|
||||||
try FileManager.default.moveItem(at: url, to: to.url)
|
try FileManager.default.moveItem(at: url, to: to.url)
|
||||||
return to
|
return Path(to)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -118,7 +118,7 @@ public extension Path {
|
|||||||
- SeeAlso: `move(to:overwrite:)`
|
- SeeAlso: `move(to:overwrite:)`
|
||||||
*/
|
*/
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func move(into: Path, overwrite: Bool = false) throws -> Path {
|
func move<P: Pathish>(into: P, overwrite: Bool = false) throws -> Path {
|
||||||
switch into.kind {
|
switch into.kind {
|
||||||
case nil:
|
case nil:
|
||||||
try into.mkdir(.p)
|
try into.mkdir(.p)
|
||||||
@@ -154,7 +154,7 @@ public extension Path {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Creates an empty file at this path or if the file exists, updates its modification time.
|
Creates an empty file at this path or if the file exists, updates its modification time.
|
||||||
- Returns: `self` to allow chaining.
|
- Returns: A copy of `self` to allow chaining.
|
||||||
*/
|
*/
|
||||||
@inlinable
|
@inlinable
|
||||||
@discardableResult
|
@discardableResult
|
||||||
@@ -172,7 +172,7 @@ public extension Path {
|
|||||||
try FileManager.default.setAttributes([.modificationDate: Date()], ofItemAtPath: string)
|
try FileManager.default.setAttributes([.modificationDate: Date()], ofItemAtPath: string)
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
return self
|
return Path(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -180,7 +180,7 @@ public extension Path {
|
|||||||
- Parameter options: Specify `mkdir(.p)` to create intermediary directories.
|
- Parameter options: Specify `mkdir(.p)` to create intermediary directories.
|
||||||
- Note: We do not error if the directory already exists (even without `.p`)
|
- Note: We do not error if the directory already exists (even without `.p`)
|
||||||
because *Path.swift* noops if the desired end result preexists.
|
because *Path.swift* noops if the desired end result preexists.
|
||||||
- Returns: `self` to allow chaining.
|
- Returns: A copy of `self` to allow chaining.
|
||||||
*/
|
*/
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func mkdir(_ options: MakeDirectoryOptions? = nil) throws -> Path {
|
func mkdir(_ options: MakeDirectoryOptions? = nil) throws -> Path {
|
||||||
@@ -199,7 +199,7 @@ public extension Path {
|
|||||||
throw error
|
throw error
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
return self
|
return Path(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -222,9 +222,9 @@ public extension Path {
|
|||||||
- Note: If `self` does not exist, is **not** an error.
|
- Note: If `self` does not exist, is **not** an error.
|
||||||
*/
|
*/
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func symlink(as: Path) throws -> Path {
|
func symlink<P: Pathish>(as: P) throws -> Path {
|
||||||
try FileManager.default.createSymbolicLink(atPath: `as`.string, withDestinationPath: string)
|
try FileManager.default.createSymbolicLink(atPath: `as`.string, withDestinationPath: string)
|
||||||
return `as`
|
return Path(`as`)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -232,7 +232,7 @@ public extension Path {
|
|||||||
- Note: If into does not exist, creates the directory with intermediate directories if necessary.
|
- Note: If into does not exist, creates the directory with intermediate directories if necessary.
|
||||||
*/
|
*/
|
||||||
@discardableResult
|
@discardableResult
|
||||||
func symlink(into dir: Path) throws -> Path {
|
func symlink<P: Pathish>(into dir: P) throws -> Path {
|
||||||
switch dir.kind {
|
switch dir.kind {
|
||||||
case nil, .symlink?:
|
case nil, .symlink?:
|
||||||
try dir.mkdir(.p)
|
try dir.mkdir(.p)
|
||||||
|
|||||||
@@ -11,3 +11,17 @@ extension Path: CustomDebugStringConvertible {
|
|||||||
return "Path(\(string))"
|
return "Path(\(string))"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
extension DynamicPath: CustomStringConvertible {
|
||||||
|
/// Returns `Path.string`
|
||||||
|
public var description: String {
|
||||||
|
return string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
extension DynamicPath: CustomDebugStringConvertible {
|
||||||
|
/// Returns eg. `Path(string: "/foo")`
|
||||||
|
public var debugDescription: String {
|
||||||
|
return "Path(\(string))"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,67 +1,135 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
/**
|
public extension Path {
|
||||||
A file entry from a directory listing.
|
class Finder {
|
||||||
- SeeAlso: `ls()`
|
fileprivate init(path: Path) {
|
||||||
*/
|
self.path = path
|
||||||
public struct Entry {
|
|
||||||
/// The kind of this directory entry.
|
|
||||||
public enum Kind {
|
|
||||||
/// The path is a file.
|
|
||||||
case file
|
|
||||||
/// The path is a directory.
|
|
||||||
case directory
|
|
||||||
}
|
}
|
||||||
/// The kind of this entry.
|
|
||||||
public let kind: Kind
|
|
||||||
/// The path of this entry.
|
|
||||||
public let path: Path
|
public let path: Path
|
||||||
|
fileprivate(set) public var maxDepth: Int? = nil
|
||||||
|
fileprivate(set) public var kinds: Set<Path.Kind>?
|
||||||
|
fileprivate(set) public var extensions: Set<String>?
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public extension Path {
|
public extension Path.Finder {
|
||||||
|
/// Multiple calls will configure the Finder for the final depth call only.
|
||||||
|
func maxDepth(_ maxDepth: Int) -> Path.Finder {
|
||||||
|
#if os(Linux) && !swift(>=5.0)
|
||||||
|
fputs("warning: maxDepth not implemented for Swift < 5\n", stderr)
|
||||||
|
#endif
|
||||||
|
self.maxDepth = maxDepth
|
||||||
|
return self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Multiple calls will configure the Finder with multiple kinds.
|
||||||
|
func kind(_ kind: Path.Kind) -> Path.Finder {
|
||||||
|
kinds = kinds ?? []
|
||||||
|
kinds!.insert(kind)
|
||||||
|
return self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Multiple calls will configure the Finder with for multiple extensions
|
||||||
|
func `extension`(_ ext: String) -> Path.Finder {
|
||||||
|
extensions = extensions ?? []
|
||||||
|
extensions!.insert(ext)
|
||||||
|
return self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Enumerate and return all results, note that this may take a while since we are recursive.
|
||||||
|
func execute() -> [Path] {
|
||||||
|
var rv: [Path] = []
|
||||||
|
execute{ rv.append($0); return .continue }
|
||||||
|
return rv
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The return type for `Path.Finder`
|
||||||
|
enum ControlFlow {
|
||||||
|
/// Stop enumerating this directory, return to the parent.
|
||||||
|
case skip
|
||||||
|
/// Stop enumerating all together.
|
||||||
|
case abort
|
||||||
|
/// Keep going.
|
||||||
|
case `continue`
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Enumerate, one file at a time.
|
||||||
|
func execute(_ closure: (Path) throws -> ControlFlow) rethrows {
|
||||||
|
guard let finder = FileManager.default.enumerator(atPath: path.string) else {
|
||||||
|
fputs("warning: could not enumerate: \(path)\n", stderr)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
while let relativePath = finder.nextObject() as? String {
|
||||||
|
#if !os(Linux) || swift(>=5.0)
|
||||||
|
if let maxDepth = maxDepth, finder.level > maxDepth {
|
||||||
|
finder.skipDescendants()
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
let path = self.path/relativePath
|
||||||
|
if path == self.path { continue }
|
||||||
|
if let kinds = kinds, let kind = path.kind, !kinds.contains(kind) { continue }
|
||||||
|
if let exts = extensions, !exts.contains(path.extension) { continue }
|
||||||
|
|
||||||
|
switch try closure(path) {
|
||||||
|
case .skip:
|
||||||
|
finder.skipDescendants()
|
||||||
|
case .abort:
|
||||||
|
return
|
||||||
|
case .continue:
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public extension Pathish {
|
||||||
//MARK: Directory Listings
|
//MARK: Directory Listings
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Same as the `ls -a` command ∴ output is ”shallow” and unsorted.
|
Same as the `ls` command ∴ output is ”shallow” and unsorted.
|
||||||
- Parameter includeHiddenFiles: If `true`, hidden files are included in the results. Defaults to `true`.
|
- Note: as per `ls`, by default we do *not* return hidden files. Specify `.a` for hidden files.
|
||||||
- Important: `includeHiddenFiles` does not work on Linux
|
- Parameter options: Configure the listing.
|
||||||
|
- Important: On Linux the listing is always `ls -a`
|
||||||
*/
|
*/
|
||||||
func ls(includeHiddenFiles: Bool = true) throws -> [Entry] {
|
func ls(_ options: ListDirectoryOptions? = nil) -> [Path] {
|
||||||
var opts = FileManager.DirectoryEnumerationOptions()
|
guard let urls = try? FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil) else {
|
||||||
#if !os(Linux)
|
fputs("warning: could not list: \(self)\n", stderr)
|
||||||
if !includeHiddenFiles {
|
return []
|
||||||
opts.insert(.skipsHiddenFiles)
|
|
||||||
}
|
}
|
||||||
#endif
|
return urls.compactMap { url in
|
||||||
let paths = try FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil, options: opts)
|
|
||||||
func convert(url: URL) -> Entry? {
|
|
||||||
guard let path = Path(url.path) else { return nil }
|
guard let path = Path(url.path) else { return nil }
|
||||||
return Entry(kind: path.isDirectory ? .directory : .file, path: path)
|
if options != .a, path.basename().hasPrefix(".") { return nil }
|
||||||
|
// ^^ we don’t use the Foundation `skipHiddenFiles` because it considers weird things hidden and we are mirroring `ls`
|
||||||
|
return path
|
||||||
}
|
}
|
||||||
return paths.compactMap(convert)
|
}
|
||||||
|
|
||||||
|
func find() -> Path.Finder {
|
||||||
|
return .init(path: Path(self))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Convenience functions for the array return value of `Path.ls()`
|
/// Convenience functions for the arraies of `Path`
|
||||||
public extension Array where Element == Entry {
|
public extension Array where Element == Path {
|
||||||
/// Filters the list of entries to be a list of Paths that are directories.
|
/// Filters the list of entries to be a list of Paths that are directories. Symlinks to directories are not returned.
|
||||||
var directories: [Path] {
|
var directories: [Path] {
|
||||||
return compactMap {
|
return filter {
|
||||||
$0.kind == .directory ? $0.path : nil
|
$0.isDirectory
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Filters the list of entries to be a list of Paths that are files.
|
/// Filters the list of entries to be a list of Paths that exist and are *not* directories. Thus expect symlinks, etc.
|
||||||
|
/// - Note: symlinks that point to files that do not exist are *not* returned.
|
||||||
var files: [Path] {
|
var files: [Path] {
|
||||||
return compactMap {
|
return filter {
|
||||||
$0.kind == .file ? $0.path : nil
|
$0.exists && !$0.isDirectory
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Filters the list of entries to be a list of Paths that are files with the specified extension.
|
|
||||||
func files(withExtension ext: String) -> [Path] {
|
|
||||||
return compactMap {
|
|
||||||
$0.kind == .file && $0.path.extension == ext ? $0.path : nil
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Options for `Path.mkdir(_:)`
|
||||||
|
public enum ListDirectoryOptions {
|
||||||
|
/// Creates intermediary directories; works the same as `mkdir -p`.
|
||||||
|
case a
|
||||||
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import func Glibc.access
|
|||||||
import Darwin
|
import Darwin
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
public extension Path {
|
public extension Pathish {
|
||||||
//MARK: Filesystem Properties
|
//MARK: Filesystem Properties
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -32,11 +32,15 @@ let _realpath = Glibc.realpath
|
|||||||
|
|
||||||
let p1 = Path.root.usr.bin.ls // => /usr/bin/ls
|
let p1 = Path.root.usr.bin.ls // => /usr/bin/ls
|
||||||
|
|
||||||
|
However we only provide this support off of the static members like `root` due
|
||||||
|
to the anti-pattern where Path.swift suddenly feels like Javascript otherwise.
|
||||||
|
|
||||||
- Note: A `Path` does not necessarily represent an actual filesystem entry.
|
- Note: A `Path` does not necessarily represent an actual filesystem entry.
|
||||||
*/
|
*/
|
||||||
|
public struct Path: Pathish {
|
||||||
|
|
||||||
@dynamicMemberLookup
|
/// The normalized string representation of the underlying filesystem path
|
||||||
public struct Path: Equatable, Hashable, Comparable {
|
public let string: String
|
||||||
|
|
||||||
init(string: String) {
|
init(string: String) {
|
||||||
assert(string.first == "/")
|
assert(string.first == "/")
|
||||||
@@ -70,11 +74,11 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
ifExists(withPrefix: "/var/automount", removeFirst: 2)
|
ifExists(withPrefix: "/var/automount", removeFirst: 2)
|
||||||
ifExists(withPrefix: "/private", removeFirst: 1)
|
ifExists(withPrefix: "/private", removeFirst: 1)
|
||||||
#endif
|
#endif
|
||||||
self.string = join_(prefix: "/", pathComponents: pathComponents)
|
string = join_(prefix: "/", pathComponents: pathComponents)
|
||||||
|
|
||||||
case "~":
|
case "~":
|
||||||
if description == "~" {
|
if description == "~" {
|
||||||
self = Path.home
|
string = Path.home.string
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
let tilded: String
|
let tilded: String
|
||||||
@@ -96,7 +100,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
pathComponents.remove(at: 0)
|
pathComponents.remove(at: 0)
|
||||||
self.string = join_(prefix: tilded, pathComponents: pathComponents)
|
string = join_(prefix: tilded, pathComponents: pathComponents)
|
||||||
|
|
||||||
default:
|
default:
|
||||||
return nil
|
return nil
|
||||||
@@ -124,20 +128,15 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
// ^^ works even if the url is a file-reference url
|
// ^^ works even if the url is a file-reference url
|
||||||
}
|
}
|
||||||
|
|
||||||
/// :nodoc:
|
/// Converts anything that is `Pathish` to a `Path`
|
||||||
public subscript(dynamicMember addendum: String) -> Path {
|
public init<P: Pathish>(_ path: P) {
|
||||||
//NOTE it’s possible for the string to be anything if we are invoked via
|
string = path.string
|
||||||
// explicit subscript thus we use our fully sanitized `join` function
|
|
||||||
return Path(string: join_(prefix: string, appending: addendum))
|
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
//MARK: Properties
|
public extension Pathish {
|
||||||
|
|
||||||
/// The underlying filesystem path
|
|
||||||
public let string: String
|
|
||||||
|
|
||||||
/// Returns a `URL` representing this file path.
|
/// Returns a `URL` representing this file path.
|
||||||
public var url: URL {
|
var url: URL {
|
||||||
return URL(fileURLWithPath: string)
|
return URL(fileURLWithPath: string)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -147,7 +146,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
- SeeAlso: https://developer.apple.com/documentation/foundation/nsurl/1408631-filereferenceurl
|
- SeeAlso: https://developer.apple.com/documentation/foundation/nsurl/1408631-filereferenceurl
|
||||||
- Important: On Linux returns an file scheme NSURL for this path string.
|
- Important: On Linux returns an file scheme NSURL for this path string.
|
||||||
*/
|
*/
|
||||||
public var fileReferenceURL: NSURL? {
|
var fileReferenceURL: NSURL? {
|
||||||
#if !os(Linux)
|
#if !os(Linux)
|
||||||
// https://bugs.swift.org/browse/SR-2728
|
// https://bugs.swift.org/browse/SR-2728
|
||||||
return (url as NSURL).perform(#selector(NSURL.fileReferenceURL))?.takeUnretainedValue() as? NSURL
|
return (url as NSURL).perform(#selector(NSURL.fileReferenceURL))?.takeUnretainedValue() as? NSURL
|
||||||
@@ -164,7 +163,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
|
|
||||||
- Note: always returns a valid path, `Path.root.parent` *is* `Path.root`.
|
- Note: always returns a valid path, `Path.root.parent` *is* `Path.root`.
|
||||||
*/
|
*/
|
||||||
public var parent: Path {
|
var parent: Path {
|
||||||
let index = string.lastIndex(of: "/")!
|
let index = string.lastIndex(of: "/")!
|
||||||
let substr = string[string.indices.startIndex..<index]
|
let substr = string[string.indices.startIndex..<index]
|
||||||
return Path(string: String(substr))
|
return Path(string: String(substr))
|
||||||
@@ -177,7 +176,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
- Note: We special case eg. `foo.tar.gz`.
|
- Note: We special case eg. `foo.tar.gz`.
|
||||||
*/
|
*/
|
||||||
@inlinable
|
@inlinable
|
||||||
public var `extension`: String {
|
var `extension`: String {
|
||||||
//FIXME efficiency
|
//FIXME efficiency
|
||||||
switch true {
|
switch true {
|
||||||
case string.hasSuffix(".tar.gz"):
|
case string.hasSuffix(".tar.gz"):
|
||||||
@@ -204,7 +203,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
- Important: The first element is always "/" to be consistent with `NSString.pathComponents`.
|
- Important: The first element is always "/" to be consistent with `NSString.pathComponents`.
|
||||||
*/
|
*/
|
||||||
@inlinable
|
@inlinable
|
||||||
public var components: [String] {
|
var components: [String] {
|
||||||
return ["/"] + string.split(separator: "/").map(String.init)
|
return ["/"] + string.split(separator: "/").map(String.init)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -225,7 +224,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
- Returns: A new joined path.
|
- Returns: A new joined path.
|
||||||
- SeeAlso: `Path./(_:_:)`
|
- SeeAlso: `Path./(_:_:)`
|
||||||
*/
|
*/
|
||||||
public func join<S>(_ addendum: S) -> Path where S: StringProtocol {
|
func join<S>(_ addendum: S) -> Path where S: StringProtocol {
|
||||||
return Path(string: join_(prefix: string, appending: addendum))
|
return Path(string: join_(prefix: string, appending: addendum))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -246,7 +245,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
- SeeAlso: `join(_:)`
|
- SeeAlso: `join(_:)`
|
||||||
*/
|
*/
|
||||||
@inlinable
|
@inlinable
|
||||||
public static func /<S>(lhs: Path, rhs: S) -> Path where S: StringProtocol {
|
static func /<S>(lhs: Self, rhs: S) -> Path where S: StringProtocol {
|
||||||
return lhs.join(rhs)
|
return lhs.join(rhs)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -257,7 +256,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
- Parameter base: The base to which we calculate the relative path.
|
- Parameter base: The base to which we calculate the relative path.
|
||||||
- ToDo: Another variant that returns `nil` if result would start with `..`
|
- ToDo: Another variant that returns `nil` if result would start with `..`
|
||||||
*/
|
*/
|
||||||
public func relative(to base: Path) -> String {
|
func relative<P: Pathish>(to base: P) -> String {
|
||||||
// Split the two paths into their components.
|
// Split the two paths into their components.
|
||||||
// FIXME: The is needs to be optimized to avoid unncessary copying.
|
// FIXME: The is needs to be optimized to avoid unncessary copying.
|
||||||
let pathComps = (string as NSString).pathComponents
|
let pathComps = (string as NSString).pathComponents
|
||||||
@@ -296,7 +295,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
- Returns: A string that is the filename’s basename.
|
- Returns: A string that is the filename’s basename.
|
||||||
- Parameter dropExtension: If `true` returns the basename without its file extension.
|
- Parameter dropExtension: If `true` returns the basename without its file extension.
|
||||||
*/
|
*/
|
||||||
public func basename(dropExtension: Bool = false) -> String {
|
func basename(dropExtension: Bool = false) -> String {
|
||||||
var lastPathComponent: Substring {
|
var lastPathComponent: Substring {
|
||||||
let slash = string.lastIndex(of: "/")!
|
let slash = string.lastIndex(of: "/")!
|
||||||
let index = string.index(after: slash)
|
let index = string.index(after: slash)
|
||||||
@@ -321,27 +320,25 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
If the path represents an actual entry that is a symlink, returns the symlink’s
|
If the path represents an actual entry that is a symlink, returns the symlink’s
|
||||||
absolute destination.
|
absolute destination.
|
||||||
|
|
||||||
- Important: This is not exhaustive, the resulting path may still contain
|
- Important: This is not exhaustive, the resulting path may still contain a symlink.
|
||||||
symlink.
|
- Important: The path will only be different if the last path component is a symlink, any symlinks in prior components are not resolved.
|
||||||
- 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 file exists but isn’t a symlink, returns `self`.
|
||||||
- Note: If symlink destination does not exist, is **not** an error.
|
- Note: If symlink destination does not exist, is **not** an error.
|
||||||
*/
|
*/
|
||||||
public func readlink() throws -> Path {
|
func readlink() throws -> Path {
|
||||||
do {
|
do {
|
||||||
let rv = try FileManager.default.destinationOfSymbolicLink(atPath: string)
|
let rv = try FileManager.default.destinationOfSymbolicLink(atPath: string)
|
||||||
return Path(rv) ?? parent/rv
|
return Path(rv) ?? parent/rv
|
||||||
} catch CocoaError.fileReadUnknown {
|
} catch CocoaError.fileReadUnknown {
|
||||||
// file is not symlink, return `self`
|
// file is not symlink, return `self`
|
||||||
assert(exists)
|
assert(exists)
|
||||||
return self
|
return Path(string: string)
|
||||||
} catch {
|
} catch {
|
||||||
#if os(Linux)
|
#if os(Linux)
|
||||||
// ugh: Swift on Linux
|
// ugh: Swift on Linux
|
||||||
let nsError = error as NSError
|
let nsError = error as NSError
|
||||||
if nsError.domain == NSCocoaErrorDomain, nsError.code == CocoaError.fileReadUnknown.rawValue, exists {
|
if nsError.domain == NSCocoaErrorDomain, nsError.code == CocoaError.fileReadUnknown.rawValue, exists {
|
||||||
return self
|
return Path(self)
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
throw error
|
throw error
|
||||||
@@ -349,7 +346,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Recursively resolves symlinks in this path.
|
/// Recursively resolves symlinks in this path.
|
||||||
public func realpath() throws -> Path {
|
func realpath() throws -> Path {
|
||||||
guard let rv = _realpath(string, nil) else { throw CocoaError.error(.fileNoSuchFile) }
|
guard let rv = _realpath(string, nil) else { throw CocoaError.error(.fileNoSuchFile) }
|
||||||
defer { free(rv) }
|
defer { free(rv) }
|
||||||
guard let rvv = String(validatingUTF8: rv) else { throw CocoaError.error(.fileReadUnknownStringEncoding) }
|
guard let rvv = String(validatingUTF8: rv) else { throw CocoaError.error(.fileReadUnknownStringEncoding) }
|
||||||
@@ -367,7 +364,7 @@ public struct Path: Equatable, Hashable, Comparable {
|
|||||||
/// Returns the locale-aware sort order for the two paths.
|
/// Returns the locale-aware sort order for the two paths.
|
||||||
/// :nodoc:
|
/// :nodoc:
|
||||||
@inlinable
|
@inlinable
|
||||||
public static func <(lhs: Path, rhs: Path) -> Bool {
|
static func <(lhs: Self, rhs: Self) -> Bool {
|
||||||
return lhs.string.compare(rhs.string, locale: .current) == .orderedAscending
|
return lhs.string.compare(rhs.string, locale: .current) == .orderedAscending
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -406,3 +403,27 @@ private func join_<S>(prefix: String, pathComponents: S) -> String where S: Sequ
|
|||||||
}
|
}
|
||||||
return rv
|
return rv
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A path that supports arbituary dot notation, eg. Path.root.usr.bin
|
||||||
|
@dynamicMemberLookup
|
||||||
|
public struct DynamicPath: Pathish {
|
||||||
|
/// The normalized string representation of the underlying filesystem path
|
||||||
|
public let string: String
|
||||||
|
|
||||||
|
init(string: String) {
|
||||||
|
assert(string.hasPrefix("/"))
|
||||||
|
self.string = string
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Converts a `Path` to a `DynamicPath`
|
||||||
|
public init(_ path: Path) {
|
||||||
|
string = path.string
|
||||||
|
}
|
||||||
|
|
||||||
|
/// :nodoc:
|
||||||
|
public subscript(dynamicMember addendum: String) -> DynamicPath {
|
||||||
|
//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 DynamicPath(string: join_(prefix: string, appending: addendum))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
13
Sources/Pathish.swift
Normal file
13
Sources/Pathish.swift
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
|
||||||
|
/// A type that represents a filesystem path, if you conform your type
|
||||||
|
/// to `Pathish` it is your responsibility to ensure the string is correctly normalized
|
||||||
|
public protocol Pathish: Hashable, Comparable {
|
||||||
|
/// The normalized string representation of the underlying filesystem path
|
||||||
|
var string: String { get }
|
||||||
|
}
|
||||||
|
|
||||||
|
public extension Pathish {
|
||||||
|
static func ==<P: Pathish> (lhs: Self, rhs: P) -> Bool {
|
||||||
|
return lhs.string == rhs.string
|
||||||
|
}
|
||||||
|
}
|
||||||
70
Tests/PathTests/PathTests+ls().swift
Normal file
70
Tests/PathTests/PathTests+ls().swift
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
import XCTest
|
||||||
|
import Path
|
||||||
|
|
||||||
|
extension PathTests {
|
||||||
|
func testFindMaxDepth0() throws {
|
||||||
|
#if !os(Linux) || swift(>=5)
|
||||||
|
try Path.mktemp { tmpdir in
|
||||||
|
try tmpdir.a.touch()
|
||||||
|
try tmpdir.b.touch()
|
||||||
|
try tmpdir.c.mkdir().join("e").touch()
|
||||||
|
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().maxDepth(0).execute()),
|
||||||
|
Set([tmpdir.a, tmpdir.b, tmpdir.c].map(Path.init)))
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
func testFindMaxDepth1() throws {
|
||||||
|
#if !os(Linux) || swift(>=5)
|
||||||
|
try Path.mktemp { tmpdir in
|
||||||
|
try tmpdir.a.touch()
|
||||||
|
try tmpdir.b.mkdir().join("c").touch()
|
||||||
|
try tmpdir.b.d.mkdir().join("e").touch()
|
||||||
|
|
||||||
|
#if !os(Linux)
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().maxDepth(1).execute()),
|
||||||
|
Set([tmpdir.a, tmpdir.b, tmpdir.b.c].map(Path.init)))
|
||||||
|
#else
|
||||||
|
// Linux behavior is different :-/
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().maxDepth(1).execute()),
|
||||||
|
Set([tmpdir.a, tmpdir.b, tmpdir.b.d, tmpdir.b.c].map(Path.init)))
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
func testFindExtension() throws {
|
||||||
|
try Path.mktemp { tmpdir in
|
||||||
|
try tmpdir.join("foo.json").touch()
|
||||||
|
try tmpdir.join("bar.txt").touch()
|
||||||
|
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().extension("json").execute()),
|
||||||
|
[tmpdir.join("foo.json")])
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().extension("txt").extension("json").execute()),
|
||||||
|
[tmpdir.join("foo.json"), tmpdir.join("bar.txt")])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testFindKinds() throws {
|
||||||
|
try Path.mktemp { tmpdir in
|
||||||
|
try tmpdir.foo.mkdir()
|
||||||
|
try tmpdir.bar.touch()
|
||||||
|
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().kind(.file).execute()),
|
||||||
|
[tmpdir.join("bar")])
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().kind(.directory).execute()),
|
||||||
|
[tmpdir.join("foo")])
|
||||||
|
XCTAssertEqual(
|
||||||
|
Set(tmpdir.find().kind(.file).kind(.directory).execute()),
|
||||||
|
Set(["foo", "bar"].map(tmpdir.join)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,6 @@
|
|||||||
@testable import Path
|
@testable import Path
|
||||||
|
import func XCTest.XCTAssertEqual
|
||||||
|
import Foundation
|
||||||
import XCTest
|
import XCTest
|
||||||
|
|
||||||
class PathTests: XCTestCase {
|
class PathTests: XCTestCase {
|
||||||
@@ -18,32 +20,31 @@ class PathTests: XCTestCase {
|
|||||||
func testEnumeration() throws {
|
func testEnumeration() throws {
|
||||||
let tmpdir_ = try TemporaryDirectory()
|
let tmpdir_ = try TemporaryDirectory()
|
||||||
let tmpdir = tmpdir_.path
|
let tmpdir = tmpdir_.path
|
||||||
try tmpdir.a.mkdir().c.touch()
|
try tmpdir.join("a").mkdir().join("c").touch()
|
||||||
try tmpdir.join("b.swift").touch()
|
try tmpdir.join("b.swift").touch()
|
||||||
try tmpdir.c.touch()
|
try tmpdir.join("c").touch()
|
||||||
try tmpdir.join(".d").mkdir().e.touch()
|
try tmpdir.join(".d").mkdir().join("e").touch()
|
||||||
|
|
||||||
var paths = Set<String>()
|
var paths = Set<String>()
|
||||||
let lsrv = try tmpdir.ls()
|
let lsrv = tmpdir.ls(.a)
|
||||||
var dirs = 0
|
var dirs = 0
|
||||||
for entry in lsrv {
|
for path in lsrv {
|
||||||
if entry.kind == .directory {
|
if path.isDirectory {
|
||||||
dirs += 1
|
dirs += 1
|
||||||
}
|
}
|
||||||
paths.insert(entry.path.basename())
|
paths.insert(path.basename())
|
||||||
}
|
}
|
||||||
XCTAssertEqual(dirs, 2)
|
XCTAssertEqual(dirs, 2)
|
||||||
XCTAssertEqual(dirs, lsrv.directories.count)
|
XCTAssertEqual(dirs, lsrv.directories.count)
|
||||||
XCTAssertEqual(["a", ".d"], Set(lsrv.directories.map{ $0.relative(to: tmpdir) }))
|
XCTAssertEqual(["a", ".d"], Set(lsrv.directories.map{ $0.relative(to: tmpdir) }))
|
||||||
XCTAssertEqual(["b.swift", "c"], Set(lsrv.files.map{ $0.relative(to: tmpdir) }))
|
XCTAssertEqual(["b.swift", "c"], Set(lsrv.files.map{ $0.relative(to: tmpdir) }))
|
||||||
XCTAssertEqual(["b.swift"], Set(lsrv.files(withExtension: "swift").map{ $0.relative(to: tmpdir) }))
|
XCTAssertEqual(["b.swift"], Set(lsrv.files.filter{ $0.extension == "swift" }.map{ $0.relative(to: tmpdir) }))
|
||||||
XCTAssertEqual(["c"], Set(lsrv.files(withExtension: "").map{ $0.relative(to: tmpdir) }))
|
XCTAssertEqual(["c"], Set(lsrv.files.filter{ $0.extension == "" }.map{ $0.relative(to: tmpdir) }))
|
||||||
XCTAssertEqual(paths, ["a", "b.swift", "c", ".d"])
|
XCTAssertEqual(paths, ["a", "b.swift", "c", ".d"])
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func testEnumerationSkippingHiddenFiles() throws {
|
func testEnumerationSkippingHiddenFiles() throws {
|
||||||
#if !os(Linux)
|
|
||||||
let tmpdir_ = try TemporaryDirectory()
|
let tmpdir_ = try TemporaryDirectory()
|
||||||
let tmpdir = tmpdir_.path
|
let tmpdir = tmpdir_.path
|
||||||
try tmpdir.join("a").mkdir().join("c").touch()
|
try tmpdir.join("a").mkdir().join("c").touch()
|
||||||
@@ -53,20 +54,19 @@ class PathTests: XCTestCase {
|
|||||||
|
|
||||||
var paths = Set<String>()
|
var paths = Set<String>()
|
||||||
var dirs = 0
|
var dirs = 0
|
||||||
for entry in try tmpdir.ls(includeHiddenFiles: false) {
|
for path in tmpdir.ls() {
|
||||||
if entry.kind == .directory {
|
if path.isDirectory {
|
||||||
dirs += 1
|
dirs += 1
|
||||||
}
|
}
|
||||||
paths.insert(entry.path.basename())
|
paths.insert(path.basename())
|
||||||
}
|
}
|
||||||
XCTAssertEqual(dirs, 1)
|
XCTAssertEqual(dirs, 1)
|
||||||
XCTAssertEqual(paths, ["a", "b", "c"])
|
XCTAssertEqual(paths, ["a", "b", "c"])
|
||||||
#endif
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func testRelativeTo() {
|
func testRelativeTo() {
|
||||||
XCTAssertEqual((Path.root/"tmp/foo").relative(to: .root/"tmp"), "foo")
|
XCTAssertEqual((Path.root.tmp.foo).relative(to: Path.root/"tmp"), "foo")
|
||||||
XCTAssertEqual((Path.root/"tmp/foo/bar").relative(to: .root/"tmp/baz"), "../foo/bar")
|
XCTAssertEqual((Path.root.tmp.foo.bar).relative(to: Path.root/"tmp/baz"), "../foo/bar")
|
||||||
}
|
}
|
||||||
|
|
||||||
func testExists() throws {
|
func testExists() throws {
|
||||||
@@ -105,7 +105,7 @@ class PathTests: XCTestCase {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func testMktemp() throws {
|
func testMktemp() throws {
|
||||||
var path: Path!
|
var path: DynamicPath!
|
||||||
try Path.mktemp {
|
try Path.mktemp {
|
||||||
path = $0
|
path = $0
|
||||||
XCTAssert(path.isDirectory)
|
XCTAssert(path.isDirectory)
|
||||||
@@ -133,7 +133,7 @@ class PathTests: XCTestCase {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func testCodable() throws {
|
func testCodable() throws {
|
||||||
let input = [Path.root.foo, Path.root.foo.bar, Path.root]
|
let input = [Path.root.foo, Path.root.foo.bar, Path.root].map(Path.init)
|
||||||
XCTAssertEqual(try JSONDecoder().decode([Path].self, from: try JSONEncoder().encode(input)), input)
|
XCTAssertEqual(try JSONDecoder().decode([Path].self, from: try JSONEncoder().encode(input)), input)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -143,7 +143,7 @@ class PathTests: XCTestCase {
|
|||||||
Path.root,
|
Path.root,
|
||||||
root,
|
root,
|
||||||
root.bar
|
root.bar
|
||||||
]
|
].map(Path.init)
|
||||||
|
|
||||||
let encoder = JSONEncoder()
|
let encoder = JSONEncoder()
|
||||||
encoder.userInfo[.relativePath] = root
|
encoder.userInfo[.relativePath] = root
|
||||||
@@ -204,7 +204,9 @@ class PathTests: XCTestCase {
|
|||||||
XCTAssertThrowsError(try root.foo.copy(to: root.bar))
|
XCTAssertThrowsError(try root.foo.copy(to: root.bar))
|
||||||
try root.foo.copy(to: root.bar, overwrite: true)
|
try root.foo.copy(to: root.bar, overwrite: true)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testCopyToExistingDirectoryFails() throws {
|
||||||
// test copy errors if directory exists at destination, even with overwrite
|
// test copy errors if directory exists at destination, even with overwrite
|
||||||
try Path.mktemp { root in
|
try Path.mktemp { root in
|
||||||
try root.foo.touch()
|
try root.foo.touch()
|
||||||
@@ -407,7 +409,7 @@ class PathTests: XCTestCase {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func testRelativeCodable() throws {
|
func testRelativeCodable() throws {
|
||||||
let path = Path.home.foo
|
let path = Path(Path.home.foo)
|
||||||
let encoder = JSONEncoder()
|
let encoder = JSONEncoder()
|
||||||
encoder.userInfo[.relativePath] = Path.home
|
encoder.userInfo[.relativePath] = Path.home
|
||||||
let data = try encoder.encode([path])
|
let data = try encoder.encode([path])
|
||||||
@@ -415,13 +417,15 @@ class PathTests: XCTestCase {
|
|||||||
decoder.userInfo[.relativePath] = Path.home
|
decoder.userInfo[.relativePath] = Path.home
|
||||||
XCTAssertEqual(try decoder.decode([Path].self, from: data), [path])
|
XCTAssertEqual(try decoder.decode([Path].self, from: data), [path])
|
||||||
decoder.userInfo[.relativePath] = Path.documents
|
decoder.userInfo[.relativePath] = Path.documents
|
||||||
XCTAssertEqual(try decoder.decode([Path].self, from: data), [Path.documents.foo])
|
XCTAssertEqual(try decoder.decode([Path].self, from: data), [Path(Path.documents.foo)])
|
||||||
XCTAssertThrowsError(try JSONDecoder().decode([Path].self, from: data))
|
XCTAssertThrowsError(try JSONDecoder().decode([Path].self, from: data))
|
||||||
}
|
}
|
||||||
|
|
||||||
func testBundleExtensions() throws {
|
func testBundleExtensions() throws {
|
||||||
try Path.mktemp { tmpdir in
|
try Path.mktemp { tmpdir -> Void in
|
||||||
let bndl = Bundle(path: tmpdir.string)!
|
guard let bndl = Bundle(path: tmpdir.string) else {
|
||||||
|
return XCTFail("Couldn’t make Bundle for \(tmpdir)")
|
||||||
|
}
|
||||||
XCTAssertEqual(bndl.path, tmpdir)
|
XCTAssertEqual(bndl.path, tmpdir)
|
||||||
XCTAssertEqual(bndl.sharedFrameworks, tmpdir.SharedFrameworks)
|
XCTAssertEqual(bndl.sharedFrameworks, tmpdir.SharedFrameworks)
|
||||||
XCTAssertEqual(bndl.privateFrameworks, tmpdir.Frameworks)
|
XCTAssertEqual(bndl.privateFrameworks, tmpdir.Frameworks)
|
||||||
@@ -513,7 +517,7 @@ class PathTests: XCTestCase {
|
|||||||
let foo = try tmpdir.foo.touch()
|
let foo = try tmpdir.foo.touch()
|
||||||
let bar = try tmpdir.bar.mkdir()
|
let bar = try tmpdir.bar.mkdir()
|
||||||
XCTAssertThrowsError(try foo.symlink(as: bar))
|
XCTAssertThrowsError(try foo.symlink(as: bar))
|
||||||
XCTAssert(try foo.symlink(as: bar.foo).isSymlink)
|
XCTAssert(try foo.symlink(as: bar/"foo").isSymlink)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -568,8 +572,8 @@ class PathTests: XCTestCase {
|
|||||||
|
|
||||||
try Path.mktemp { tmpdir in
|
try Path.mktemp { tmpdir in
|
||||||
let foo = try tmpdir.foo.mkdir()
|
let foo = try tmpdir.foo.mkdir()
|
||||||
try foo.bar.mkdir().fuz.touch()
|
try foo.join("bar").mkdir().join("fuz").touch()
|
||||||
let baz = try foo.symlink(as: tmpdir.baz)
|
let baz = DynamicPath(try foo.symlink(as: tmpdir.baz))
|
||||||
XCTAssert(baz.isSymlink)
|
XCTAssert(baz.isSymlink)
|
||||||
XCTAssert(baz.bar.isDirectory)
|
XCTAssert(baz.bar.isDirectory)
|
||||||
XCTAssertEqual(baz.bar.join("..").string, "\(tmpdir)/baz")
|
XCTAssertEqual(baz.bar.join("..").string, "\(tmpdir)/baz")
|
||||||
@@ -582,7 +586,7 @@ class PathTests: XCTestCase {
|
|||||||
try Path.mktemp { tmpdir in
|
try Path.mktemp { tmpdir in
|
||||||
let b = try tmpdir.a.b.mkdir(.p)
|
let b = try tmpdir.a.b.mkdir(.p)
|
||||||
let c = try tmpdir.a.c.touch()
|
let c = try tmpdir.a.c.touch()
|
||||||
let e = try c.symlink(as: b.e)
|
let e = try c.symlink(as: b/"e")
|
||||||
let f = try e.symlink(as: tmpdir.f)
|
let f = try e.symlink(as: tmpdir.f)
|
||||||
XCTAssertEqual(try f.readlink(), e)
|
XCTAssertEqual(try f.readlink(), e)
|
||||||
XCTAssertEqual(try f.realpath(), c)
|
XCTAssertEqual(try f.realpath(), c)
|
||||||
@@ -639,3 +643,11 @@ class PathTests: XCTestCase {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private func XCTAssertEqual<P: Pathish, Q: Pathish>(_ p: P, _ q: Q, file: StaticString = #file, line: UInt = #line) {
|
||||||
|
XCTAssertEqual(p.string, q.string, file: file, line: line)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func XCTAssertEqual<P: Pathish, Q: Pathish>(_ p: P?, _ q: Q?, file: StaticString = #file, line: UInt = #line) {
|
||||||
|
XCTAssertEqual(p?.string, q?.string, file: file, line: line)
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import Foundation
|
|||||||
|
|
||||||
class TemporaryDirectory {
|
class TemporaryDirectory {
|
||||||
let url: URL
|
let url: URL
|
||||||
var path: Path { return Path(string: url.path) }
|
var path: DynamicPath { return DynamicPath(Path(string: url.path)) }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Creates a new temporary directory.
|
Creates a new temporary directory.
|
||||||
@@ -51,7 +51,7 @@ class TemporaryDirectory {
|
|||||||
}
|
}
|
||||||
|
|
||||||
extension Path {
|
extension Path {
|
||||||
static func mktemp<T>(body: (Path) throws -> T) throws -> T {
|
static func mktemp<T>(body: (DynamicPath) throws -> T) throws -> T {
|
||||||
let tmp = try TemporaryDirectory()
|
let tmp = try TemporaryDirectory()
|
||||||
return try body(tmp.path)
|
return try body(tmp.path)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ extension PathTests {
|
|||||||
("testConcatenation", testConcatenation),
|
("testConcatenation", testConcatenation),
|
||||||
("testCopyInto", testCopyInto),
|
("testCopyInto", testCopyInto),
|
||||||
("testCopyTo", testCopyTo),
|
("testCopyTo", testCopyTo),
|
||||||
|
("testCopyToExistingDirectoryFails", testCopyToExistingDirectoryFails),
|
||||||
("testDataExtensions", testDataExtensions),
|
("testDataExtensions", testDataExtensions),
|
||||||
("testDelete", testDelete),
|
("testDelete", testDelete),
|
||||||
("testDynamicMember", testDynamicMember),
|
("testDynamicMember", testDynamicMember),
|
||||||
@@ -23,6 +24,10 @@ extension PathTests {
|
|||||||
("testFileHandleExtensions", testFileHandleExtensions),
|
("testFileHandleExtensions", testFileHandleExtensions),
|
||||||
("testFileReference", testFileReference),
|
("testFileReference", testFileReference),
|
||||||
("testFilesystemAttributes", testFilesystemAttributes),
|
("testFilesystemAttributes", testFilesystemAttributes),
|
||||||
|
("testFindExtension", testFindExtension),
|
||||||
|
("testFindKinds", testFindKinds),
|
||||||
|
("testFindMaxDepth0", testFindMaxDepth0),
|
||||||
|
("testFindMaxDepth1", testFindMaxDepth1),
|
||||||
("testFlatMap", testFlatMap),
|
("testFlatMap", testFlatMap),
|
||||||
("testInitializerForRelativePath", testInitializerForRelativePath),
|
("testInitializerForRelativePath", testInitializerForRelativePath),
|
||||||
("testIsDirectory", testIsDirectory),
|
("testIsDirectory", testIsDirectory),
|
||||||
|
|||||||
Reference in New Issue
Block a user