Compare commits

...

34 Commits
1.0.1 ... 1.4.0

Author SHA1 Message Date
Max Howell
9c6f807b0a Merge pull request #77 from ConfusedVorlon/find_hidden_modifier
Find hidden modifier
2021-07-30 12:28:04 -04:00
Rob Jonson
dad3d84040 don't implement hidden(false) for swift < 5
and provide a warning
2021-07-30 17:09:37 +01:00
Rob Jonson
5377bceb5f Update linux test list 2021-07-28 22:29:02 +01:00
Rob Jonson
f593437cf5 make find() configurable to ignore hidden files & directories 2021-07-28 15:12:09 +01:00
Rob Jonson
6e8a42f01d Fix assert error message 2021-07-28 15:06:20 +01:00
Max Howell
13d62c3068 Merge pull request #75 from mxcl/ci/macos-11
[ci] can has macos-11
2021-06-23 12:48:10 -04:00
Max Howell
99a0474b0f [ci] can has macos-11 2021-06-23 12:32:23 -04:00
Max Howell
82640e629d Merge pull request #74 from mxcl/ci/5.5
ci/5.5
2021-06-17 12:00:29 -04:00
Max Howell
f49e5c82c7 This seems more correct 2021-06-17 11:55:53 -04:00
Max Howell
287afe3783 Fix docs for ls(.a) 2021-06-17 11:55:52 -04:00
Max Howell
bb449ff412 Merge pull request #73 from mxcl/fixes/55
typealias PathStruct and add Swift 5.5 niceness
2021-06-16 11:11:18 -04:00
Max Howell
14f03abaad typealias PathStruct and add Swift 5.5 niceness
Fixes #55
2021-06-16 11:05:17 -04:00
Max Howell
ecbb3a60fe Merge pull request #71 from mxcl/ci/warnings-as-errors
[ci] warnings as errors
2021-06-07 10:45:37 -04:00
Max Howell
3af771f543 [ci] warnings as errors 2021-06-07 10:14:36 -04:00
Max Howell
0b68e5c011 Merge pull request #70 from mxcl/ci/mxcl/xcodebuild
use mxcl/xcodebuild
2021-06-05 13:45:31 -04:00
Max Howell
fec4ed25de use mxcl/xcodebuild 2021-06-05 10:55:16 -04:00
Max Howell
6e78d9317e Merge pull request #69 from mxcl/continuous-resilience
#continuous-resilience
2021-05-29 15:12:58 -04:00
Max Howell
3035c45808 #continuous-resilience 2021-05-29 15:10:17 -04:00
Max Howell
39f81ae258 Fix pods deploy 2021-05-28 16:23:47 -04:00
Max Howell
670dc1163f Merge pull request #68 from mxcl/ci/more 2021-05-28 16:05:44 -04:00
Max Howell
eb33ff8906 [ci] more; some fixes I found 2021-05-28 16:01:57 -04:00
Max Howell
f9cee2c75f Merge pull request #67
[ci] fix
2021-04-30 08:20:56 -04:00
Max Howell
7a974911d8 [ci] fix 2021-04-30 08:06:10 -04:00
Max Howell
891d70ec7c Specify Swift 5.1 syntax for targets 2020-08-30 16:27:17 -04:00
Max Howell
142d4bc111 Merge pull request #64 from mxcl/Path.source()
Add `Path.source()`
2020-08-19 13:41:50 -04:00
Max Howell
6461a550c6 Add Path.source() 2020-08-19 13:27:40 -04:00
Max Howell
8b90260517 Merge pull request #63 from mxcl/codecov-linux
Code coverage for linux
2020-08-01 19:45:07 -04:00
Max Howell
7924d20c8c Code coverage for linux 2020-08-01 15:59:54 -04:00
Max Howell
07007a5421 GHA CI Badge 2020-07-26 13:59:53 -04:00
Max Howell
8a217b3982 Merge pull request #62 from mxcl/sort-ls
ls() is sorted; Fixes #58
2020-07-26 13:58:44 -04:00
Max Howell
2b50909946 ls() is sorted; Fixes #58 2020-07-26 13:48:15 -04:00
Max Howell
baa6416208 Use GHA instead of Travis where possible 2020-07-26 13:39:10 -04:00
Max Howell
6e99825d9f Probably redundant tests, but why not 2020-02-09 14:52:49 -05:00
Max Howell
6e37bfde4d Update README.md 2020-02-09 14:29:28 -05:00
15 changed files with 386 additions and 127 deletions

3
.github/codecov.yml vendored
View File

@@ -1,2 +1,3 @@
ignore: ignore:
- Tests - Tests/PathTests/etc.swift
- Tests/PathTests/TemporaryDirectory.swift

24
.github/workflows/cd.yml vendored Normal file
View File

@@ -0,0 +1,24 @@
name: CD
on:
release:
types: published
jobs:
docs:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- uses: steven0351/publish-jazzy-docs@v1
with:
personal_access_token: ${{ secrets.PAT }}
config: .github/jazzy.yml
version: ${{ github.event.release.tag_name }}
history: false
pods:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: pod trunk push --allow-warnings
env:
COCOAPODS_TRUNK_TOKEN: ${{ secrets.COCOAPODS_TRUNK_TOKEN }}
VERSION: ${{ github.event.release.tag_name }}

14
.github/workflows/checks.yml vendored Normal file
View File

@@ -0,0 +1,14 @@
on:
push:
branches:
- master
paths:
- '**/*.swift'
- .github/workflows/checks.yml
jobs:
smoke:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: swift --version
- run: swift test --parallel

87
.github/workflows/ci.yml vendored Normal file
View File

@@ -0,0 +1,87 @@
name: CI
on:
pull_request:
paths:
- '**/*.swift'
- .github/workflows/ci.yml
schedule:
- cron: '3 3 * * 5' # 3:03 AM, every Friday
concurrency:
group: ${{ github.head_ref || 'push' }}
cancel-in-progress: true
jobs:
verify-linuxmain:
runs-on: macos-10.15
steps:
- uses: actions/checkout@v2
- run: swift test --generate-linuxmain
- run: git diff --exit-code
apple:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- macos-10.15
- macos-11
platform:
- iOS
- tvOS
- macOS
- watchOS
steps:
- uses: actions/checkout@v2
- uses: mxcl/xcodebuild@v1
with:
platform: ${{ matrix.platform }}
code-coverage: true
warnings-as-errors: true
- uses: codecov/codecov-action@v1
linux:
runs-on: ubuntu-latest
strategy:
matrix:
swift:
- swift:4.2
- swift:5.0
- swift:5.1
- swift:5.2
- swift:5.3
- swift:5.4
- swiftlang/swift:nightly-5.5
container:
image: ${{ matrix.swift }}
steps:
- uses: mxcl/get-swift-version@v1
id: swift
- uses: actions/checkout@v2
- run: useradd -ms /bin/bash mxcl
- run: chown -R mxcl .
# ^^ we need to be a normal user and not root for the tests to be valid
- run: echo ARGS=--enable-code-coverage >> $GITHUB_ENV
if: ${{ steps.swift.outputs.marketing-version > 5 }}
- run: su mxcl -c "swift test --parallel $ARGS"
- name: Generate `.lcov`
if: ${{ steps.swift.outputs.marketing-version > 5 }}
run: |
apt-get -qq update && apt-get -qq install curl
b=$(swift build --show-bin-path)
llvm-cov export \
-format lcov \
-instr-profile="$b"/codecov/default.profdata \
--ignore-filename-regex='\.build|Tests' \
"$b"/*.xctest \
> info.lcov
- uses: codecov/codecov-action@v1
if: ${{ steps.swift.outputs.marketing-version > 5 }}
with:
file: ./info.lcov

View File

@@ -1,90 +1,16 @@
# only run for: merge commits, releases and pull-requests # Travis does CD, GHA does CI
if: type != push OR branch = master OR branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/ OR branch =~ /^\d+\.\d+\.\d+(-.*)?$/ if: branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/ OR branch =~ /^\d+\.\d+\.\d+(-.*)?$/
stages: stages:
- name: pretest
if: NOT branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/
- name: test
if: NOT branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/
- name: deploy - name: deploy
if: branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/ if: branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/
- name: publish - name: publish
if: branch =~ /^\d+\.\d+\.\d+(-.*)?$/ if: branch =~ /^\d+\.\d+\.\d+(-.*)?$/
os: osx os: osx
language: swift
osx_image: xcode10.1
xcode_project: Path.swift.xcodeproj
xcode_scheme: Path.swift-Package
jobs: jobs:
include: include:
- name: macOS / Swift 4.0.3
before_script: swift build -Xswiftc -warnings-as-errors
script: swift test --parallel -Xswiftc -swift-version -Xswiftc 4
- &std
name: macOS / Swift 4.2.1
before_script: swift build -Xswiftc -warnings-as-errors
script: swift test --parallel
- <<: *std
name: macOS / Swift 5.0
osx_image: xcode10.2
- <<: *std
name: macOS / Swift 5.1
osx_image: xcode11
- &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: |
set -o pipefail
xcodebuild \
-project Path.swift.xcodeproj \
-scheme Path.swift-Package \
-destination 'platform=watchOS Simulator,OS=latest,name=Apple Watch Series 4 - 40mm' \
build | xcpretty
after_success: false
- &linux
env: SWIFT_VERSION=4.2.4
os: linux
name: Linux / Swift 4.2.4
language: generic
sudo: false
install: eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
before_script: swift build -Xswiftc -warnings-as-errors
script: swift test --parallel
- <<: *linux
env: SWIFT_VERSION=5.0.3
name: Linux / Swift 5.0.3
- <<: *linux
env: SWIFT_VERSION=5.1.3
name: Linux / Swift 5.1.3
- <<: *linux
env: SWIFT_VERSION=5.2-DEVELOPMENT-SNAPSHOT-2020-01-22-a
name: Linux / Swift 5.2.0-dev+2020-01-22-a
- stage: pretest
name: Check Linux tests are syncd
install: swift test --generate-linuxmain
script: git diff --exit-code
osx_image: xcode10.2
- stage: deploy - stage: deploy
name: Deploy name: Deploy
osx_image: xcode11 osx_image: xcode11
@@ -105,7 +31,7 @@ jobs:
- stage: publish - stage: publish
name: Jazzy name: Jazzy
osx_image: xcode10.2 osx_image: xcode11
install: gem install jazzy install: gem install jazzy
before_script: swift package generate-xcodeproj before_script: swift package generate-xcodeproj
script: | script: |
@@ -121,8 +47,8 @@ jobs:
tags: true tags: true
- name: CocoaPods - name: CocoaPods
osx_image: xcode10.2
env: HOMEBREW_NO_INSTALL_CLEANUP=1 env: HOMEBREW_NO_INSTALL_CLEANUP=1
osx_image: xcode11
install: install:
- brew install mxcl/made/swift-sh - brew install mxcl/made/swift-sh
- curl -O https://raw.githubusercontent.com/mxcl/ops/master/deploy - curl -O https://raw.githubusercontent.com/mxcl/ops/master/deploy

16
Path.swift.podspec Normal file
View File

@@ -0,0 +1,16 @@
Pod::Spec.new do |spec|
spec.name = "Path.swift"
spec.version = ENV['VERSION'] || "0.0.1"
spec.summary = "Delightful, robust, cross-platform and chainable file-pathing functions."
spec.homepage = "https://github.com/mxcl/Path.swift"
spec.license = "Unlicense"
spec.author = { "Max Howell" => "mxcl@me.com" }
spec.source = { :git => "https://github.com/mxcl/Path.swift.git", :tag => "#{spec.version}" }
spec.source_files = "Sources/*.swift"
spec.swift_versions = ['4.2', '5']
spec.module_name = 'Path'
spec.osx.deployment_target = '10.10'
spec.ios.deployment_target = '8.0'
spec.tvos.deployment_target = '9.0'
spec.watchos.deployment_target = '2.0'
end

View File

@@ -31,6 +31,9 @@ print(bar.isFile) // => true
let foo = try Path.root.join("foo").copy(into: Path.root.join("bar").mkdir()) 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
// ^^ the `into:` version will only copy *into* a directory, the `to:` version copies
// to a file at that path, thus you will not accidentally copy into directories you
// may not have realized existed.
// we support dynamic-member-syntax when joining named static members, eg: // 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
@@ -42,16 +45,13 @@ try Bundle.resources.helper.copy(into: Path.root.usr.local.bin).chmod(0o500)
We emphasize safety and correctness, just like Swift, and also (again like We emphasize safety and correctness, just like Swift, and also (again like
Swift), we provide a thoughtful and comprehensive (yet concise) API. Swift), we provide a thoughtful and comprehensive (yet concise) API.
# Support mxcl # Sponsor @mxcl
Hi, Im Max Howell and I have written a lot of open source software—generally Hi, Im Max Howell and I have written a lot of open source software—generally
a good deal of my free time 👨🏻‍💻. a good deal of my free time 👨🏻‍💻. Sponsorship helps me justify creating new open
source and maintaining it. Thank you.
<a href="https://www.patreon.com/mxcl"> [Sponsor @mxcl].
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
</a>
[Other donation/tipping options](http://mxcl.dev/#donate)
# Handbook # Handbook
@@ -117,6 +117,25 @@ everything would compile if we allowed arbituary variables to take *any* named
property as valid syntax. What we have is what you want most of the time but property as valid syntax. What we have is what you want most of the time but
much less (potentially) dangerous (at runtime). much less (potentially) dangerous (at runtime).
### Pathish
`Path`, and `DynamicPath` (the result of eg. `Path.root`) both conform to
`Pathish` which is a protocol that contains all pathing functions. Thus if
you create objects from a mixture of both you need to create generic
functions or convert any `DynamicPath`s to `Path` first:
```swift
let path1 = Path("/usr/lib")!
let path2 = Path.root.usr.bin
var paths = [Path]()
paths.append(path1) // fine
paths.append(path2) // error
paths.append(Path(path2)) // ok
```
This is inconvenient but as Swift stands theres nothing we can think of
that would help.
## Initializing from user-input ## Initializing from user-input
The `Path` initializer returns `nil` unless fed an absolute path; thus to The `Path` initializer returns `nil` unless fed an absolute path; thus to
@@ -140,7 +159,7 @@ strings that you need to be paths:
```swift ```swift
let absolutePath = "/known/path" let absolutePath = "/known/path"
let path1 = Path.root/pathString let path1 = Path.root/absolutePath
let pathWithoutInitialSlash = "known/path" let pathWithoutInitialSlash = "known/path"
let path2 = Path.root/pathWithoutInitialSlash let path2 = Path.root/pathWithoutInitialSlash
@@ -208,7 +227,7 @@ We provide `find()` for recursive listing:
```swift ```swift
for path in Path.home.find() { for path in Path.home.find() {
// descends all directories, and includes hidden files // descends all directories, and includes hidden files by default
// so it behaves the same as the terminal command `find` // so it behaves the same as the terminal command `find`
} }
``` ```
@@ -216,7 +235,7 @@ for path in Path.home.find() {
It is configurable: It is configurable:
```swift ```swift
for path in Path.home.find().depth(max: 1).extension("swift").type(.file) { for path in Path.home.find().depth(max: 1).extension("swift").type(.file).hidden(false) {
// //
} }
``` ```
@@ -278,6 +297,9 @@ Path.home/"/b" // => /Users/mxcl/b
Path.home.foo.bar.join("..") // => /Users/mxcl/foo Path.home.foo.bar.join("..") // => /Users/mxcl/foo
Path.home.foo.bar.join(".") // => /Users/mxcl/foo/bar Path.home.foo.bar.join(".") // => /Users/mxcl/foo/bar
// though note that we provide `.parent`:
Path.home.foo.bar.parent // => /Users/mxcl/foo
// of course, feel free to join variables: // of course, feel free to join variables:
let b = "b" let b = "b"
let c = "c" let c = "c"
@@ -342,9 +364,13 @@ no filesystem entry there at all check if `type` is `nil`.
Changing directory is dangerous, you should *always* try to avoid it and thus Changing directory is dangerous, you should *always* try to avoid it and thus
we dont even provide the method. If you are executing a sub-process then we dont even provide the method. If you are executing a sub-process then
use `Process.currentDirectoryURL`. use `Process.currentDirectoryURL` to change *its* working directory when it
executes.
If you must then use `FileManager.changeCurrentDirectory`. If you must change directory then use `FileManager.changeCurrentDirectory` as
early in your process as *possible*. Altering the global state of your apps
environment is fundamentally dangerous creating hard to debug issues that
you wont find for potentially *years*.
# I thought I should only use `URL`s? # I thought I should only use `URL`s?
@@ -379,7 +405,15 @@ developers) it is snappy and familiar.
SwiftPM: SwiftPM:
```swift ```swift
package.append(.package(url: "https://github.com/mxcl/Path.swift.git", from: "1.0.0")) package.append(
.package(url: "https://github.com/mxcl/Path.swift.git", from: "1.0.0")
)
package.targets.append(
.target(name: "Foo", dependencies: [
.product(name: "Path", package: "Path.swift")
])
)
``` ```
CocoaPods: CocoaPods:
@@ -401,12 +435,13 @@ Carthage:
[badge-platforms]: https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20iOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey.svg [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%20%7C%205.1%20%7C%205.2-orange.svg [badge-languages]: https://img.shields.io/badge/swift-4.2%20%7C%205.x-orange.svg
[docs]: https://mxcl.dev/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-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-codecov]: https://codecov.io/gh/mxcl/Path.swift/branch/master/graph/badge.svg
[badge-ci]: https://travis-ci.com/mxcl/Path.swift.svg [badge-ci]: https://github.com/mxcl/Path.swift/workflows/Checks/badge.svg
[travis]: https://travis-ci.com/mxcl/Path.swift [travis]: https://travis-ci.com/mxcl/Path.swift
[codecov]: https://codecov.io/gh/mxcl/Path.swift [codecov]: https://codecov.io/gh/mxcl/Path.swift
[badge-version]: https://img.shields.io/cocoapods/v/Path.swift.svg?label=version [badge-version]: https://img.shields.io/cocoapods/v/Path.swift.svg?label=version
[cocoapods]: https://cocoapods.org/pods/Path.swift [cocoapods]: https://cocoapods.org/pods/Path.swift
[Sponsor @mxcl]: https://github.com/sponsors/mxcl

View File

@@ -1,21 +1,33 @@
import Foundation import Foundation
/// The `extension` that provides static properties that are common directories. /// The `extension` that provides static properties that are common directories.
extension Path { private enum Foo {
//MARK: Common Directories //MARK: Common Directories
/// Returns a `Path` containing `FileManager.default.currentDirectoryPath`. /// Returns a `Path` containing `FileManager.default.currentDirectoryPath`.
public static var cwd: DynamicPath { static var cwd: DynamicPath {
return .init(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: DynamicPath { static var root: DynamicPath {
return .init(string: "/") return .init(string: "/")
} }
#if swift(>=5.3)
public static func source(for filePath: String = #filePath) -> (file: DynamicPath, directory: DynamicPath) {
let file = DynamicPath(string: filePath)
return (file: file, directory: .init(file.parent))
}
#else
public static func source(for filePath: String = #file) -> (file: DynamicPath, directory: DynamicPath) {
let file = DynamicPath(string: filePath)
return (file: file, directory: .init(file.parent))
}
#endif
/// Returns a `Path` representing the users home directory /// Returns a `Path` representing the users home directory
public static var home: DynamicPath { 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, *) {
@@ -58,7 +70,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: DynamicPath { static var documents: DynamicPath {
return path(for: .documentDirectory) return path(for: .documentDirectory)
} }
@@ -67,7 +79,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: DynamicPath { static var caches: DynamicPath {
return path(for: .cachesDirectory) return path(for: .cachesDirectory)
} }
@@ -76,7 +88,7 @@ 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: DynamicPath { static var applicationSupport: DynamicPath {
return path(for: .applicationSupportDirectory) return path(for: .applicationSupportDirectory)
} }
} }
@@ -96,3 +108,35 @@ func defaultUrl(for searchPath: FileManager.SearchPathDirectory) -> DynamicPath
} }
#endif #endif
/// The `extension` that provides static properties that are common directories.
#if swift(>=5.5)
public extension Pathish where Self == Path {
static var home: DynamicPath { return Foo.home }
static var root: DynamicPath { return Foo.root }
static var cwd: DynamicPath { return Foo.cwd }
static var documents: DynamicPath { return Foo.documents }
static var caches: DynamicPath { return Foo.caches }
static var applicationSupport: DynamicPath { return Foo.applicationSupport }
static func source(for filePath: String = #filePath) -> (file: DynamicPath, directory: DynamicPath) {
return Foo.source(for: filePath)
}
}
#else
public extension Path {
static var home: DynamicPath { return Foo.home }
static var root: DynamicPath { return Foo.root }
static var cwd: DynamicPath { return Foo.cwd }
static var documents: DynamicPath { return Foo.documents }
static var caches: DynamicPath { return Foo.caches }
static var applicationSupport: DynamicPath { return Foo.applicationSupport }
#if swift(>=5.3)
static func source(for filePath: String = #filePath) -> (file: DynamicPath, directory: DynamicPath) {
return Foo.source(for: filePath)
}
#else
static func source(for file: String = #file) -> (file: DynamicPath, directory: DynamicPath) {
return Foo.source(for: file)
}
#endif
}
#endif

View File

@@ -29,7 +29,8 @@ public extension Pathish {
if overwrite, let tokind = to.type, tokind != .directory, type != .directory { if overwrite, let tokind = to.type, tokind != .directory, type != .directory {
try FileManager.default.removeItem(at: to.url) try FileManager.default.removeItem(at: to.url)
} }
#if os(Linux) && !swift(>=5.3) // check if fixed #if os(Linux)
//NOTE doing manually due to inconsistency in Linux Foundation behavior
if !overwrite, to.type != nil { if !overwrite, to.type != nil {
throw CocoaError.error(.fileWriteFileExists) throw CocoaError.error(.fileWriteFileExists)
} }
@@ -69,7 +70,8 @@ public extension Pathish {
if overwrite, let kind = rv.type, kind != .directory { if overwrite, let kind = rv.type, kind != .directory {
try FileManager.default.removeItem(at: rv.url) try FileManager.default.removeItem(at: rv.url)
} }
#if os(Linux) && !swift(>=5.3) // check if fixed #if os(Linux)
//NOTE doing manually due to inconsistency in Linux Foundation behavior
if !overwrite, rv.type != nil { if !overwrite, rv.type != nil {
throw CocoaError.error(.fileWriteFileExists) throw CocoaError.error(.fileWriteFileExists)
} }

View File

@@ -31,6 +31,9 @@ public extension Path {
/// The file extensions find operations will return. Files *and* directories unless you filter for `kinds`. /// The file extensions find operations will return. Files *and* directories unless you filter for `kinds`.
private(set) public var extensions: Set<String>? private(set) public var extensions: Set<String>?
/// Whether to return hidden files
public var hidden:Bool = true
} }
} }
@@ -50,8 +53,12 @@ extension Path.Finder: Sequence, IteratorProtocol {
if enumerator.level < depth.lowerBound { if enumerator.level < depth.lowerBound {
continue continue
} }
#endif
if !hidden, path.basename().hasPrefix(".") {
enumerator.skipDescendants()
continue
}
#endif
if let type = path.type, !types.contains(type) { continue } if let type = path.type, !types.contains(type) { continue }
if let exts = extensions, !exts.contains(path.extension) { continue } if let exts = extensions, !exts.contains(path.extension) { continue }
return path return path
@@ -115,6 +122,15 @@ public extension Path.Finder {
return self return self
} }
/// Whether to skip hidden files and folders.
func hidden(_ hidden: Bool) -> Path.Finder {
#if os(Linux) && !swift(>=5.0)
fputs("warning: hidden not implemented for Swift < 5\n", stderr)
#endif
self.hidden = hidden
return self
}
/// The return type for `Path.Finder` /// The return type for `Path.Finder`
enum ControlFlow { enum ControlFlow {
/// Stop enumerating this directory, return to the parent. /// Stop enumerating this directory, return to the parent.
@@ -164,7 +180,7 @@ public extension Pathish {
if options != .a, path.basename().hasPrefix(".") { return nil } if options != .a, path.basename().hasPrefix(".") { return nil }
// ^^ we dont use the Foundation `skipHiddenFiles` because it considers weird things hidden and we are mirroring `ls` // ^^ we dont use the Foundation `skipHiddenFiles` because it considers weird things hidden and we are mirroring `ls`
return path return path
} }.sorted()
} }
/// Recursively find files under this path. If the path is a file, no files will be found. /// Recursively find files under this path. If the path is a file, no files will be found.
@@ -198,6 +214,6 @@ public extension Array where Element == Path {
/// Options for `Path.ls(_:)` /// Options for `Path.ls(_:)`
public enum ListDirectoryOptions { public enum ListDirectoryOptions {
/// Creates intermediary directories; works the same as `mkdir -p`. /// Lists hidden files also
case a case a
} }

View File

@@ -7,6 +7,8 @@ import func Glibc.realpath
let _realpath = Glibc.realpath let _realpath = Glibc.realpath
#endif #endif
public typealias PathStruct = Path
/** /**
A `Path` represents an absolute path on a filesystem. A `Path` represents an absolute path on a filesystem.
@@ -168,6 +170,7 @@ public extension Pathish {
*/ */
var parent: Path { var parent: Path {
let index = string.lastIndex(of: "/")! let index = string.lastIndex(of: "/")!
guard index != string.indices.startIndex else { return Path(string: "/") }
let substr = string[string.indices.startIndex..<index] let substr = string[string.indices.startIndex..<index]
return Path(string: String(substr)) return Path(string: String(substr))
} }

View File

@@ -136,6 +136,28 @@ extension PathTests {
} }
} }
func testFindHidden() throws {
try Path.mktemp { tmpdir in
let dotFoo = try tmpdir.join(".foo.txt").touch()
let tmpDotA = try tmpdir.join(".a").mkdir()
let tmpDotAFoo = try tmpdir.join(".a").join("foo.txt").touch()
let tmpB = try tmpdir.b.mkdir()
let tmpBFoo = try tmpdir.b.join("foo.txt").touch()
XCTAssertEqual(
Set(tmpdir.find().hidden(true)),
Set([dotFoo,tmpDotA,tmpDotAFoo,tmpB,tmpBFoo]),
relativeTo: tmpdir)
#if !os(Linux) || swift(>=5)
XCTAssertEqual(
Set(tmpdir.find().hidden(false)),
Set([tmpB,tmpBFoo]),
relativeTo: tmpdir)
#endif
}
}
func testFindExtension() throws { func testFindExtension() throws {
try Path.mktemp { tmpdir in try Path.mktemp { tmpdir in
try tmpdir.join("foo.json").touch() try tmpdir.join("foo.json").touch()

View File

@@ -3,7 +3,20 @@ import func XCTest.XCTAssertEqual
import Foundation import Foundation
import XCTest import XCTest
extension PathStruct {
var foo: Int { fatalError()}
}
class PathTests: XCTestCase { class PathTests: XCTestCase {
func testNewStuff() {
#if swift(>=5.5)
func foo<P: Pathish>(_ path: P) {}
foo(.home)
foo(.root)
#endif
}
func testConcatenation() { func testConcatenation() {
XCTAssertEqual((Path.root/"bar").string, "/bar") XCTAssertEqual((Path.root/"bar").string, "/bar")
XCTAssertEqual(Path.cwd.string, FileManager.default.currentDirectoryPath) XCTAssertEqual(Path.cwd.string, FileManager.default.currentDirectoryPath)
@@ -192,6 +205,14 @@ class PathTests: XCTestCase {
XCTAssertEqual(Path.root/"a/foo"/"../../../bar", Path.root/"bar") XCTAssertEqual(Path.root/"a/foo"/"../../../bar", Path.root/"bar")
} }
func testParent() {
XCTAssertEqual(Path("/root/boot")!.parent.string, "/root")
XCTAssertEqual(Path("/root/boot")!.parent.parent.string, "/")
XCTAssertEqual(Path("/root/boot")!.parent.parent.parent.string, "/")
XCTAssertEqual(Path("/root")!.parent.string, "/")
XCTAssertEqual(Path("/root")!.parent.parent.string, "/")
}
func testDynamicMember() { func testDynamicMember() {
XCTAssertEqual(Path.root.Documents, Path.root/"Documents") XCTAssertEqual(Path.root.Documents, Path.root/"Documents")
@@ -199,7 +220,7 @@ class PathTests: XCTestCase {
XCTAssertEqual(a.Documents, Path.home/"foo/Documents") XCTAssertEqual(a.Documents, Path.home/"foo/Documents")
// verify use of the dynamic-member-subscript works according to our rules // verify use of the dynamic-member-subscript works according to our rules
XCTAssertEqual(Path.home[dynamicMember: "../~foo"].string, "\(Path.home.parent.string)/~foo") XCTAssertEqual(Path.home[dynamicMember: "../~foo"].string, Path(Path.home).parent.join("~foo").string)
} }
func testCopyTo() throws { func testCopyTo() throws {
@@ -305,6 +326,13 @@ class PathTests: XCTestCase {
XCTAssertEqual(Path.root.string, "/") XCTAssertEqual(Path.root.string, "/")
XCTAssertEqual(Path.home.string, NSHomeDirectory()) XCTAssertEqual(Path.home.string, NSHomeDirectory())
XCTAssertEqual(Path.documents.string, NSHomeDirectory() + "/Documents") XCTAssertEqual(Path.documents.string, NSHomeDirectory() + "/Documents")
#if swift(>=5.3)
let filePath = Path(#filePath)!
#else
let filePath = Path(#file)!
#endif
XCTAssertEqual(Path.source().file, filePath)
XCTAssertEqual(Path.source().directory, filePath.parent)
#if !os(Linux) #if !os(Linux)
XCTAssertEqual(Path.caches.string, NSHomeDirectory() + "/Library/Caches") XCTAssertEqual(Path.caches.string, NSHomeDirectory() + "/Library/Caches")
XCTAssertEqual(Path.cwd.string, FileManager.default.currentDirectoryPath) XCTAssertEqual(Path.cwd.string, FileManager.default.currentDirectoryPath)
@@ -373,17 +401,13 @@ class PathTests: XCTestCase {
func testTimes() throws { func testTimes() throws {
try Path.mktemp { tmpdir in try Path.mktemp { tmpdir in
let foo = try tmpdir.foo.touch()
let now1 = Date().timeIntervalSince1970.rounded(.down) let now1 = Date().timeIntervalSince1970.rounded(.down)
#if !os(Linux)
XCTAssertEqual(foo.ctime?.timeIntervalSince1970.rounded(.down), now1) //FIXME flakey
#endif
XCTAssertEqual(foo.mtime?.timeIntervalSince1970.rounded(.down), now1) //FIXME flakey
sleep(1) sleep(1)
try foo.touch() let foo = try tmpdir.foo.touch()
let now2 = Date().timeIntervalSince1970.rounded(.down) #if !os(Linux)
XCTAssertNotEqual(now1, now2) XCTAssertGreaterThan(foo.ctime?.timeIntervalSince1970.rounded(.down) ?? 0, now1) //FIXME flakey
XCTAssertEqual(foo.mtime?.timeIntervalSince1970.rounded(.down), now2) //FIXME flakey #endif
XCTAssertGreaterThan(foo.mtime?.timeIntervalSince1970.rounded(.down) ?? 0, now1) //FIXME flakey
XCTAssertNil(tmpdir.void.mtime) XCTAssertNil(tmpdir.void.mtime)
XCTAssertNil(tmpdir.void.ctime) XCTAssertNil(tmpdir.void.ctime)
@@ -447,7 +471,7 @@ class PathTests: XCTestCase {
#if os(macOS) #if os(macOS)
XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.Contents.Frameworks) XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.Contents.Frameworks)
XCTAssertEqual(bndl.defaultResourcesPath, tmpdir.Contents.Resources) XCTAssertEqual(bndl.defaultResourcesPath, tmpdir.Contents.Resources)
#elseif os(tvOS) || os(iOS) #elseif os(tvOS) || os(iOS) || os(watchOS)
XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.Frameworks) XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.Frameworks)
XCTAssertEqual(bndl.defaultResourcesPath, tmpdir) XCTAssertEqual(bndl.defaultResourcesPath, tmpdir)
#else #else
@@ -499,8 +523,19 @@ class PathTests: XCTestCase {
func testTouchThrowsIfCannotWrite() throws { func testTouchThrowsIfCannotWrite() throws {
try Path.mktemp { tmpdir in try Path.mktemp { tmpdir in
print(try FileManager.default.attributesOfItem(atPath: tmpdir.string)[.posixPermissions])
//FIXME fails in Docker image (only)
try tmpdir.chmod(0o000) try tmpdir.chmod(0o000)
let attrs = try FileManager.default.attributesOfItem(atPath: tmpdir.string)
XCTAssertEqual(attrs[.posixPermissions] as? Int, 0)
print(attrs[.posixPermissions])
XCTAssertThrowsError(try tmpdir.bar.touch()) XCTAssertThrowsError(try tmpdir.bar.touch())
XCTAssertFalse(tmpdir.bar.exists)
} }
} }
@@ -653,12 +688,10 @@ class PathTests: XCTestCase {
XCTAssertEqual(bar.type, .symlink) XCTAssertEqual(bar.type, .symlink)
} }
} }
}
private func XCTAssertEqual<P: Pathish, Q: Pathish>(_ p: P, _ q: Q, file: StaticString = #file, line: UInt = #line) { func testOptionalInitializer() throws {
XCTAssertEqual(p.string, q.string, file: file, line: line) XCTAssertNil(Path(""))
} XCTAssertNil(Path("./foo"))
XCTAssertEqual(Path("/foo"), Path.root.foo)
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)
} }

View File

@@ -29,6 +29,7 @@ extension PathTests {
("testFindDepthRange", testFindDepthRange), ("testFindDepthRange", testFindDepthRange),
("testFindExecute", testFindExecute), ("testFindExecute", testFindExecute),
("testFindExtension", testFindExtension), ("testFindExtension", testFindExtension),
("testFindHidden", testFindHidden),
("testFindMaxDepth1", testFindMaxDepth1), ("testFindMaxDepth1", testFindMaxDepth1),
("testFindMaxDepth2", testFindMaxDepth2), ("testFindMaxDepth2", testFindMaxDepth2),
("testFindMinDepth", testFindMinDepth), ("testFindMinDepth", testFindMinDepth),
@@ -45,7 +46,10 @@ extension PathTests {
("testMktemp", testMktemp), ("testMktemp", testMktemp),
("testMoveInto", testMoveInto), ("testMoveInto", testMoveInto),
("testMoveTo", testMoveTo), ("testMoveTo", testMoveTo),
("testNewStuff", testNewStuff),
("testNoUndesiredSymlinkResolution", testNoUndesiredSymlinkResolution), ("testNoUndesiredSymlinkResolution", testNoUndesiredSymlinkResolution),
("testOptionalInitializer", testOptionalInitializer),
("testParent", testParent),
("testPathComponents", testPathComponents), ("testPathComponents", testPathComponents),
("testReadlinkOnFileReturnsSelf", testReadlinkOnFileReturnsSelf), ("testReadlinkOnFileReturnsSelf", testReadlinkOnFileReturnsSelf),
("testReadlinkOnNonExistantFileThrows", testReadlinkOnNonExistantFileThrows), ("testReadlinkOnNonExistantFileThrows", testReadlinkOnNonExistantFileThrows),

View File

@@ -1,11 +1,43 @@
import XCTest import XCTest
import Path import Path
#if swift(>=5.3)
func XCTAssertEqual<P: Pathish>(_ set1: Set<Path>, _ set2: Set<Path>, _ message: @autoclosure () -> String = "", file: StaticString = #filePath, line: UInt = #line, relativeTo: P) {
logic(set1, set2, relativeTo: relativeTo) {
XCTFail($0, file: file, line: line)
}
}
#else
func XCTAssertEqual<P: Pathish>(_ set1: Set<Path>, _ set2: Set<Path>, _ message: @autoclosure () -> String = "", file: StaticString = #file, line: UInt = #line, relativeTo: P) { func XCTAssertEqual<P: Pathish>(_ set1: Set<Path>, _ set2: Set<Path>, _ message: @autoclosure () -> String = "", file: StaticString = #file, line: UInt = #line, relativeTo: P) {
logic(set1, set2, relativeTo: relativeTo) {
XCTFail($0, file: file, line: line)
}
}
#endif
private func logic<P: Pathish>(_ set1: Set<Path>, _ set2: Set<Path>, relativeTo: P, fail: (String) -> Void) {
if set1 != set2 { if set1 != set2 {
let cvt: (Path) -> String = { $0.relative(to: relativeTo) } let cvt: (Path) -> String = { $0.relative(to: relativeTo) }
let out1 = set1.map(cvt).sorted() let out1 = set1.map(cvt).sorted()
let out2 = set1.map(cvt).sorted() let out2 = set2.map(cvt).sorted()
XCTFail("Set(\(out1)) is not equal to Set(\(out2))", file: file, line: line) fail("Set(\(out1)) is not equal to Set(\(out2))")
} }
} }
#if swift(>=5.3)
func XCTAssertEqual<P: Pathish, Q: Pathish>(_ p: P, _ q: Q, file: StaticString = #filePath, line: UInt = #line) {
XCTAssertEqual(p.string, q.string, file: file, line: line)
}
func XCTAssertEqual<P: Pathish, Q: Pathish>(_ p: P?, _ q: Q?, file: StaticString = #filePath, line: UInt = #line) {
XCTAssertEqual(p?.string, q?.string, file: file, line: line)
}
#else
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)
}
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)
}
#endif