Merge pull request #13 from mxcl/more-docs

Improved documentation; Fixes #12

.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 /.build
 /*.xcodeproj
+/build
+/docs

.travis.yml

@@ -15,18 +15,18 @@ xcode_scheme: Path.swift-Package
   
 jobs:
   include:
-    - script: swift test
+    - script: swift test --parallel
-      name: macOS
+      name: macOS / Swift 4.2.1
 
     - &xcodebuild
       before_install: swift package generate-xcodeproj
       xcode_destination: platform=iOS Simulator,OS=latest,name=iPhone XS
-      name: iOS
+      name: iOS / Swift 4.2.1
     - <<: *xcodebuild
       xcode_destination: platform=tvOS Simulator,OS=latest,name=Apple TV
-      name: tvOS
+      name: tvOS / Swift 4.2.1
     - <<: *xcodebuild
-      name: watchOS
+      name: watchOS / Swift 4.2.1
       script: |
         set -o pipefail
         xcodebuild \
@@ -35,26 +35,31 @@ jobs:
           -destination 'platform=watchOS Simulator,OS=latest,name=Apple Watch Series 4 - 40mm' \
           build | xcpretty
 
-    - env: SWIFT_VERSION=4.2.1
+    - &linux
+      env: SWIFT_VERSION=4.2.1
       os: linux
-      name: Linux
+      name: Linux / Swift 4.2.1
       language: generic
       dist: trusty
       sudo: false
       install: eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
-      script: swift test
+      script: swift test --parallel
+      
+    - <<: *linux
+      env: SWIFT_VERSION='5.0-DEVELOPMENT-SNAPSHOT-2019-01-22-a'
+      name: Linux / Swift 5.0.0-dev (2019-01-22)
       
     - stage: pretest
-      name: Check if Linux tests are up-to-date
+      name: Check Linux tests are sync’d
       install: swift test --generate-linuxmain
       script: git diff --exit-code
 
     - stage: deploy
       name: Jazzy
       before_install: |
-        cat << EOF > .jazzy.yaml
+        cat <<\ \ EOF> .jazzy.yaml
         module: Path
-        module_version: $TRAVIS_TAG
+        module_version: TRAVIS_TAG
         custom_categories:
           - name: Path
             children:
@@ -64,13 +69,16 @@ jobs:
           - UseModernBuildSystem=NO
         output: output
         github_url: https://github.com/mxcl/Path.swift
+        exclude:
+          - Sources/Path+StringConvertibles.swift
         EOF
-      install: |
+        sed -i '' "s/TRAVIS_TAG/$TRAVIS_TAG/" .jazzy.yaml
-        gem install jazzy
+      # ^^ this weirdness because Travis multiline YAML is broken and inserts
-        swift package generate-xcodeproj
+      # two spaces in front of the output which means we need a prefixed
-      script: |
+      # delimiter which also weirdly stops bash from doing variable substitution
-        jazzy
+      install: gem install jazzy
-        rm -rf output/docsets
+      before_script: swift package generate-xcodeproj
+      script: jazzy
       deploy:
         provider: pages
         skip-cleanup: true
@@ -81,10 +89,10 @@ jobs:
 
     - name: CocoaPods
       before_install: |
-        cat << EOF > Path.swift.podspec
+        cat <<\ \ EOF> Path.swift.podspec
         Pod::Spec.new do |s|
           s.name = 'Path.swift'
-          s.version          = '$TRAVIS_TAG'
+          s.version = 'TRAVIS_TAG'
           s.summary = 'Delightful, robust file-pathing functions'
           s.homepage = 'https://github.com/mxcl/Path.swift'
           s.license = { :type => 'Unlicense', :file => 'LICENSE.md' }
@@ -96,8 +104,10 @@ jobs:
           s.tvos.deployment_target = '10.0'
           s.watchos.deployment_target = '3.0'
           s.source_files = 'Sources/*'
-          s.swift_version = "4.2"
+          s.swift_version = '4.2'
         end
         EOF
+        sed -i '' "s/TRAVIS_TAG/$TRAVIS_TAG/" Path.swift.podspec
+      # ^^ see the Jazzy deployment for explanation
       install: gem install cocoapods --pre
-      script: pod trunk push --allow-warnings
+      script: pod trunk push

Package@swift-5.0.swift

@@ -0,0 +1,20 @@
+// swift-tools-version:5.0
+import PackageDescription
+
+let pkg = Package(
+    name: "Path.swift",
+    products: [
+        .library(name: "Path", targets: ["Path"]),
+    ],
+    targets: [
+        .target(name: "Path", path: "Sources"),
+        .testTarget(name: "PathTests", dependencies: ["Path"]),
+    ]
+)
+
+pkg.platforms = [
+   .macOS(.v10_10), .iOS(.v8), .tvOS(.v10), .watchOS(.v3)
+]
+pkg.swiftLanguageVersions = [
+    .v4_2, .v5
+]

README.md

@@ -15,21 +15,29 @@ let docs = Path.home/"Documents"
 // paths are *always* absolute thus avoiding common bugs
 let path = Path(userInput) ?? Path.cwd/userInput
 
-// chainable syntax so you have less boilerplate
+// elegant, chainable syntax
 try Path.home.join("foo").mkdir().join("bar").touch().chmod(0o555)
 
-// easy file-management
+// sensible considerations
-try Path.root.join("foo").copy(to: Path.root/"bar")
+try Path.home.join("bar").mkdir()
+try Path.home.join("bar").mkdir()  // doesn’t throw ∵ we already have the desired result
 
-// careful API to avoid common bugs
+// easy file-management
-try Path.root.join("foo").copy(into: Path.root.mkdir("bar"))
+let bar = try Path.root.join("foo").copy(to: Path.root/"bar")
-// ^^ other libraries would make the above `to:` form handle both these cases
+print(bar)         // => /bar
-// but that can easily lead to bugs where you accidentally write files that
+print(bar.isFile)  // => true
-// were meant to be directory destinations
+
+// careful API considerations so as to avoid common bugs
+let foo = try Path.root.join("foo").copy(into: Path.root.mkdir("bar"))
+print(foo)         // => /bar/foo
+print(foo.isFile)  // => true
+
+// A practical example: installing a helper executable
+try Bundle.resources.join("helper").copy(into: Path.home.join(".local/bin").mkpath()).chmod(0o500)
 ```
 
-We emphasize safety and correctness, just like Swift, and also just
+We emphasize safety and correctness, just like Swift, and also (again like
-like Swift, we provide a thoughtful and comprehensive (yet concise) API.
+Swift), we provide a thoughtful and comprehensive (yet concise) API.
 
 # Support mxcl
 
@@ -99,10 +107,8 @@ This is explicit, not hiding anything that code-review may miss and preventing
 common bugs like accidentally creating `Path` objects from strings you did not
 expect to be relative.
 
-Our initializer is nameless because we conform to `LosslessStringConvertible`,
+Our initializer is nameless to be consistent with the equivalent operation for
-the same conformance as that `Int`, `Float` etc. conform. The protocol enforces
+converting strings to `Int`, `Float` etc. in the standard library.
-a nameless initialization and since it is appropriate for us to conform to it,
-we do.
 
 ## Extensions
 
@@ -183,17 +189,23 @@ Path("~foo")       // => nil
 SwiftPM:
 
 ```swift
-package.append(.package(url: "https://github.com/mxcl/Path.swift", from: "0.4.1"))
+package.append(.package(url: "https://github.com/mxcl/Path.swift", from: "0.5.0"))
 ```
 
 CocoaPods:
 
 ```ruby
-pod 'Path.swift' ~> '0.4.1'
+pod 'Path.swift' ~> '0.5.0'
 ```
 
-Please note! We are pre 1.0, thus we can change the API as we like! We will tag
+Carthage:
-1.0 as soon as possible.
+
+> Waiting on: [@Carthage#1945](https://github.com/Carthage/Carthage/pull/1945).
+
+## Please note
+
+We are pre 1.0, thus we can change the API as we like, and we will (to the
+pursuit of getting it *right*)! We will tag 1.0 as soon as possible.
 
 ### Get push notifications for new releases
 

Sources/Extensions.swift

@@ -1,5 +1,6 @@
 import Foundation
 
+/// Extensions on Foundation’s `Bundle` so you get `Path` rather than `String` or `URL`.
 public extension Bundle {
     /// Returns the path for requested resource in this bundle.
     func path(forResource: String, ofType: String?) -> Path? {
@@ -9,21 +10,22 @@ public extension Bundle {
     }
 
     /// Returns the path for the shared-frameworks directory in this bundle.
-    public var sharedFrameworks: Path? {
+    var sharedFrameworks: Path? {
         return sharedFrameworksPath.flatMap(Path.init)
     }
 
     /// Returns the path for the resources directory in this bundle.
-    public var resources: Path? {
+    var resources: Path? {
         return resourcePath.flatMap(Path.init)
     }
 
     /// Returns the path for this bundle.
-    public var path: Path {
+    var path: Path {
         return Path(string: bundlePath)
     }
 }
 
+/// Extensions on `String` that work with `Path` rather than `String` or `URL`
 public extension String {
     /// Initializes this `String` with the contents of the provided path.
     @inlinable
@@ -40,6 +42,7 @@ public extension String {
     }
 }
 
+/// Extensions on `Data` that work with `Path` rather than `String` or `URL`
 public extension Data {
     /// Initializes this `Data` with the contents of the provided path.
     @inlinable

Sources/Path+Attributes.swift

@@ -1,10 +1,38 @@
 import Foundation
 
 public extension Path {
+    //MARK: Filesystem Attributes
+
+    /**
+     Returns the modification-time.
+     - Note: Returns the creation time if there is no modification time.
+     - Note: Returns UNIX-time-zero if neither are available, though this *should* be impossible.
+     */
+    var mtime: Date {
+        do {
+            let attrs = try FileManager.default.attributesOfItem(atPath: string)
+            return attrs[.modificationDate] as? Date ?? attrs[.creationDate] as? Date ?? Date(timeIntervalSince1970: 0)
+        } catch {
+            //TODO log error
+            return Date(timeIntervalSince1970: 0)
+        }
+    }
+
+    /**
+     Sets the file’s attributes using UNIX octal notation.
+
+         Path.home.join("foo").chmod(0o555)
+     */
+    @discardableResult
+    func chmod(_ octal: Int) throws -> Path {
+        try FileManager.default.setAttributes([.posixPermissions: octal], ofItemAtPath: string)
+        return self
+    }
+    
     /// - Note: If file is already locked, does nothing
     /// - Note: If file doesn’t exist, throws
     @discardableResult
-    public func lock() throws -> Path {
+    func lock() throws -> Path {
         var attrs = try FileManager.default.attributesOfItem(atPath: string)
         let b = attrs[.immutable] as? Bool ?? false
         if !b {
@@ -17,7 +45,7 @@ public extension Path {
     /// - Note: If file isn‘t locked, does nothing
     /// - Note: If file doesn’t exist, does nothing
     @discardableResult
-    public func unlock() throws -> Path {
+    func unlock() throws -> Path {
         var attrs: [FileAttributeKey: Any]
         do {
             attrs = try FileManager.default.attributesOfItem(atPath: string)
@@ -31,30 +59,4 @@ public extension Path {
         }
         return self
     }
-
-    /**
-     Sets the file’s attributes using UNIX octal notation.
-
-         Path.home.join("foo").chmod(0o555)
-     */
-    @discardableResult
-    public func chmod(_ octal: Int) throws -> Path {
-        try FileManager.default.setAttributes([.posixPermissions: octal], ofItemAtPath: string)
-        return self
-    }
-
-    /**
-     Returns the modification-time.
-     - Note: Returns the creation time if there is no modification time.
-     - Note: Returns UNIX-time-zero if neither are available, though this *should* be impossible.
-     */
-    public var mtime: Date {
-        do {
-            let attrs = try FileManager.default.attributesOfItem(atPath: string)
-            return attrs[.modificationDate] as? Date ?? attrs[.creationDate] as? Date ?? Date()
-        } catch {
-            //TODO log error
-            return Date(timeIntervalSince1970: 0)
-        }
-    }
 }

Sources/Path+Codable.swift

@@ -1,11 +1,31 @@
 import Foundation
 
+/**
+ Provided for relative-path coding. See the instructions in our
+ [README](https://github.com/mxcl/Path.swift/#codable).
+*/
 public extension CodingUserInfoKey {
-    /// If set paths are encoded as relative to this path.
+    /**
+     If set on an `Encoder`’s `userInfo` all paths are encoded relative to this path.
+
+     For example:
+
+         let encoder = JSONEncoder()
+         encoder.userInfo[.relativePath] = Path.home
+         encoder.encode([Path.home, Path.home/"foo"])
+
+     - Remark: See the [README](https://github.com/mxcl/Path.swift/#codable) for more information.
+    */
     static let relativePath = CodingUserInfoKey(rawValue: "dev.mxcl.Path.relative")!
 }
 
+/**
+ Provided for relative-path coding. See the instructions in our
+ [README](https://github.com/mxcl/Path.swift/#codable).
+*/
 extension Path: Codable {    
+    /// - SeeAlso: `CodingUserInfoKey.relativePath`
+    // :nodoc:
     public init(from decoder: Decoder) throws {
         let value = try decoder.singleValueContainer().decode(String.self)
         if value.hasPrefix("/") {
@@ -18,6 +38,8 @@ extension Path: Codable {
         }
     }
 
+    /// - SeeAlso: `CodingUserInfoKey.relativePath`
+    // :nodoc:
     public func encode(to encoder: Encoder) throws {
         var container = encoder.singleValueContainer()
         if let root = encoder.userInfo[.relativePath] as? Path {

Sources/Path+CommonDirectories.swift

@@ -1,6 +1,8 @@
 import Foundation
 
 extension Path {
+    //MARK: Common Directories
+    
     /// Returns a `Path` containing ``FileManager.default.currentDirectoryPath`.
     public static var cwd: Path {
         return Path(string: FileManager.default.currentDirectoryPath)

Sources/Path+FileManager.swift

@@ -1,17 +1,20 @@
 import Foundation
 
 public extension Path {
+    //MARK: File Management
+    
     /**
      Copies a file.
      - Note: `throws` if `to` is a directory.
      - Parameter to: Destination filename.
-     - Parameter overwrite: If true overwrites any file that already exists at `to`.
+     - Parameter overwrite: If `true` and both `self` and `to` are files, overwrites `to`.
+     - Note: If either `self` or `to are directories, `overwrite` is ignored.
      - Returns: `to` to allow chaining
-     - SeeAlso: copy(into:overwrite:)
+     - SeeAlso: `copy(into:overwrite:)`
      */
     @discardableResult
-    public func copy(to: Path, overwrite: Bool = false) throws -> Path {
+    func copy(to: Path, overwrite: Bool = false) throws -> Path {
-        if overwrite, to.exists {
+        if overwrite, to.isFile, isFile {
             try FileManager.default.removeItem(at: to.url)
         }
         try FileManager.default.copyItem(atPath: string, toPath: to.string)
@@ -23,20 +26,33 @@ public extension Path {
 
      If the destination does not exist, this function creates the directory first.
     
+        // Create ~/.local/bin, copy `ls` there and make the new copy executable
+        try Path.root.join("bin/ls").copy(into: Path.home.join(".local/bin").mkpath()).chmod(0o500)
+
      - Note: `throws` if `into` is a file.
      - Parameter into: Destination directory
      - Parameter overwrite: If true overwrites any file that already exists at `into`.
      - Returns: The `Path` of the newly copied file.
-     - SeeAlso: copy(into:overwrite:)
+     - SeeAlso: `copy(into:overwrite:)`
      */
     @discardableResult
-    public func copy(into: Path, overwrite: Bool = false) throws -> Path {
+    func copy(into: Path, overwrite: Bool = false) throws -> Path {
         if !into.exists {
             try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
-        } else if overwrite, !into.isDirectory {
-            try into.delete()
         }
         let rv = into/basename()
+        if overwrite, rv.isFile {
+            try rv.delete()
+        }
+    #if os(Linux)
+    #if swift(>=5.1)
+        // check if fixed
+    #else
+        if !overwrite, rv.isFile {
+            throw CocoaError.error(.fileWriteFileExists)
+        }
+    #endif
+    #endif
         try FileManager.default.copyItem(at: url, to: rv.url)
         return rv
     }
@@ -50,7 +66,7 @@ public extension Path {
      - SeeAlso: move(into:overwrite:)
      */
     @discardableResult
-    public func move(to: Path, overwrite: Bool = false) throws -> Path {
+    func move(to: Path, overwrite: Bool = false) throws -> Path {
         if overwrite, to.exists {
             try FileManager.default.removeItem(at: to.url)
         }
@@ -70,7 +86,7 @@ public extension Path {
      - SeeAlso: move(into:overwrite:)
      */
     @discardableResult
-    public func move(into: Path) throws -> Path {
+    func move(into: Path) throws -> Path {
         if !into.exists {
             try into.mkpath()
         } else if !into.isDirectory {
@@ -83,7 +99,7 @@ public extension Path {
 
     /// Deletes the path, recursively if a directory.
     @inlinable
-    public func delete() throws {
+    func delete() throws {
         try FileManager.default.removeItem(at: url)
     }
 
@@ -123,7 +139,7 @@ public extension Path {
      - Returns: `self` to allow chaining.
      */
     @discardableResult
-    public func mkdir() throws -> Path {
+    func mkdir() throws -> Path {
         try _foo {
             try FileManager.default.createDirectory(at: self.url, withIntermediateDirectories: false, attributes: nil)
         }
@@ -136,39 +152,10 @@ public extension Path {
      - Returns: `self` to allow chaining.
      */
     @discardableResult
-    public func mkpath() throws -> Path {
+    func mkpath() throws -> Path {
         try _foo {
             try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true, attributes: nil)
         }
         return self
     }
-
-    /**
-     Replaces the contents of the file at this path with the provided string.
-     - Note: If file doesn’t exist, creates file
-     - Note: If file is not writable, makes writable first, resetting permissions after the write
-     - Parameter contents: The string that will become the contents of this file.
-     - Parameter atomically: If `true` the operation will be performed atomically.
-     - Parameter encoding: The string encoding to use.
-     - Returns: `self` to allow chaining.
-     */
-    @discardableResult
-    public func replaceContents(with contents: String, atomically: Bool = false, encoding: String.Encoding = .utf8) throws -> Path {
-        let resetPerms: Int?
-        if exists, !isWritable {
-            resetPerms = try FileManager.default.attributesOfItem(atPath: string)[.posixPermissions] as? Int
-            let perms = resetPerms ?? 0o777
-            try chmod(perms | 0o200)
-        } else {
-            resetPerms = nil
-        }
-
-        defer {
-            _ = try? resetPerms.map(self.chmod)
-        }
-
-        try contents.write(to: self)
-
-        return self
-    }
 }

Sources/Path+StringConvertibles.swift

@@ -1,13 +1,5 @@
 import class Foundation.NSString
 
-extension Path: LosslessStringConvertible {
-    /// Returns `nil` unless fed an absolute path
-    public init?(_ description: String) {
-        guard description.starts(with: "/") || description.starts(with: "~/") else { return nil }
-        self.init(string: (description as NSString).standardizingPath)
-    }
-}
-
 extension Path: CustomStringConvertible {    
     /// Returns `Path.string`
     public var description: String {

Sources/Path+ls.swift

@@ -1,8 +1,10 @@
 import Foundation
 
 public extension Path {
+    //MARK: Directory Listings
+    
     /**
-     Same as the `ls -a` command ∴ is ”shallow”
+     Same as the `ls -a` command ∴ output is ”shallow” and unsorted.
      - Parameter includeHiddenFiles: If `true`, hidden files are included in the results. Defaults to `true`.
      - Important: `includeHiddenFiles` does not work on Linux
      */
@@ -22,6 +24,7 @@ public extension Path {
     }
 }
 
+/// Convenience functions for the array return value of `Path.ls()`
 public extension Array where Element == Path.Entry {
     /// Filters the list of entries to be a list of Paths that are directories.
     var directories: [Path] {

Sources/Path->Bool.swift

@@ -1,15 +1,11 @@
 import Foundation
 
 public extension Path {
-    /// Returns true if the path represents an actual file that is also writable by the current user.
+    //MARK: Filesystem Properties
-    var isWritable: Bool {
-        return FileManager.default.isWritableFile(atPath: string)
-    }
 
-    /// Returns true if the path represents an actual directory.
+    /// Returns true if the path represents an actual filesystem entry.
-    var isDirectory: Bool {
+    var exists: Bool {
-        var isDir: ObjCBool = false
+        return FileManager.default.fileExists(atPath: string)
-        return FileManager.default.fileExists(atPath: string, isDirectory: &isDir) && isDir.boolValue
     }
 
     /// Returns true if the path represents an actual filesystem entry that is *not* a directory.
@@ -18,13 +14,29 @@ public extension Path {
         return FileManager.default.fileExists(atPath: string, isDirectory: &isDir) && !isDir.boolValue
     }
 
+    /// Returns true if the path represents an actual directory.
+    var isDirectory: Bool {
+        var isDir: ObjCBool = false
+        return FileManager.default.fileExists(atPath: string, isDirectory: &isDir) && isDir.boolValue
+    }
+
+    /// Returns true if the path represents an actual file that is also readable by the current user.
+    var isReadable: Bool {
+        return FileManager.default.isReadableFile(atPath: string)
+    }
+
+    /// Returns true if the path represents an actual file that is also writable by the current user.
+    var isWritable: Bool {
+        return FileManager.default.isWritableFile(atPath: string)
+    }
+        
+    /// Returns true if the path represents an actual file that is also deletable by the current user.
+    var isDeletable: Bool {
+        return FileManager.default.isDeletableFile(atPath: string)
+    }
+
     /// Returns true if the path represents an actual file that is also executable by the current user.
     var isExecutable: Bool {
         return FileManager.default.isExecutableFile(atPath: string)
     }
-
-    /// Returns true if the path represents an actual filesystem entry.
-    var exists: Bool {
-        return FileManager.default.fileExists(atPath: string)
-    }
 }

Sources/Path.swift

@@ -3,26 +3,44 @@ import Foundation
 /**
  Represents a platform filesystem absolute path.
 
- The recommended conversions from string are:
+ `Path` supports `Codable`, and can be configured to
+ [encode paths *relatively*](https://github.com/mxcl/Path.swift/#codable).
+
+ Sorting a `Sequence` of `Path`s will return the locale-aware sort order, which
+ will give you the same order as Finder, (though folders will not be sorted
+ first).
+
+ Converting from a `String` is a common first step, here are the recommended
+ ways to do that:
 
      let p1 = Path.root/pathString
      let p2 = Path.root/url.path
      let p3 = Path.cwd/relativePathString
      let p4 = Path(userInput) ?? Path.cwd/userInput
 
- - Note: There may not be an actual filename at the path.
+ - Note: There may not be an actual filesystem entry at the path. The underlying
+   representation for `Path` is `String`.
  */
 public struct Path: Equatable, Hashable, Comparable {
+
+    init(string: String) {
+        self.string = string
+    }
+
+    /// Returns `nil` unless fed an absolute path
+    public init?(_ description: String) {
+        guard description.starts(with: "/") || description.starts(with: "~/") else { return nil }
+        self.init(string: (description as NSString).standardizingPath)
+    }
+
+//MARK: Properties
+
     /// The underlying filesystem path
     public let string: String
 
-    /**
+    /// Returns a `URL` representing this file path.
-     Returns the filename extension of this path.
+    public var url: URL {
-     - Remark: Implemented via `NSString.pathExtension`.
+        return URL(fileURLWithPath: string)
-     */
-    @inlinable
-    public var `extension`: String {
-        return (string as NSString).pathExtension
     }
 
     /**
@@ -37,33 +55,51 @@ public struct Path: Equatable, Hashable, Comparable {
         return Path(string: (string as NSString).deletingLastPathComponent)
     }
 
-    /// Returns a `URL` representing this file path.
+    /**
+     Returns the filename extension of this path.
+     - Remark: Implemented via `NSString.pathExtension`.
+     */
     @inlinable
-    public var url: URL {
+    public var `extension`: String {
-        return URL(fileURLWithPath: string)
+        return (string as NSString).pathExtension
+    }
+
+//MARK: Pathing
+
+    /**
+     Joins a path and a string to produce a new path.
+
+         Path.root.join("a")             // => /a
+         Path.root.join("a/b")           // => /a/b
+         Path.root.join("a").join("b")   // => /a/b
+         Path.root.join("a").join("/b")  // => /a/b
+
+     - Parameter pathComponent: The string to join with this path.
+     - Returns: A new joined path.
+     - SeeAlso: `Path./(_:, _:)`
+     */
+    public func join<S>(_ pathComponent: S) -> Path where S: StringProtocol {
+        //TODO standardizingPath does more than we want really (eg tilde expansion)
+        let str = (string as NSString).appendingPathComponent(String(pathComponent))
+        return Path(string: (str as NSString).standardizingPath)
     }
 
     /**
-     The basename for the provided file, optionally dropping the file extension.
+     Joins a path and a string to produce a new path.
 
-         Path.root.join("foo.swift").basename()  // => "foo.swift"
+         Path.root/"a"       // => /a
-         Path.root.join("foo.swift").basename(dropExtension: true)  // => "foo"
+         Path.root/"a/b"     // => /a/b
+         Path.root/"a"/"b"   // => /a/b
+         Path.root/"a"/"/b"  // => /a/b
 
-     - Returns: A string that is the filename’s basename.
+     - Parameter lhs: The base path to join with `rhs`.
-     - Parameter dropExtension: If `true` returns the basename without its file extension.
+     - Parameter rhs: The string to join with this `lhs`.
+     - Returns: A new joined path.
+     - SeeAlso: `join(_:)`
      */
-    public func basename(dropExtension: Bool = false) -> String {
+    @inlinable
-        let str = string as NSString
+    public static func /<S>(lhs: Path, rhs: S) -> Path where S: StringProtocol {
-        if !dropExtension {
+        return lhs.join(rhs)
-            return str.lastPathComponent
-        } else {
-            let ext = str.pathExtension
-            if !ext.isEmpty {
-                return String(str.lastPathComponent.dropLast(ext.count + 1))
-            } else {
-                return str.lastPathComponent
-            }
-        }
     }
 
     /**
@@ -104,30 +140,41 @@ public struct Path: Equatable, Hashable, Comparable {
     }
 
     /**
-     Joins a path and a string to produce a new path.
+     The basename for the provided file, optionally dropping the file extension.
 
-         Path.root.join("a")             // => /a
+         Path.root.join("foo.swift").basename()  // => "foo.swift"
-         Path.root.join("a/b")           // => /a/b
+         Path.root.join("foo.swift").basename(dropExtension: true)  // => "foo"
-         Path.root.join("a").join("b")   // => /a/b
-         Path.root.join("a").join("/b")  // => /a/b
 
-     - Parameter pathComponent: The string to join with this path.
+     - Returns: A string that is the filename’s basename.
-     - Returns: A new joined path.
+     - Parameter dropExtension: If `true` returns the basename without its file extension.
-     - SeeAlso: /(:Path,:String)
      */
-    public func join<S>(_ pathComponent: S) -> Path where S: StringProtocol {
+    public func basename(dropExtension: Bool = false) -> String {
-        //TODO standardizingPath does more than we want really (eg tilde expansion)
+        let str = string as NSString
-        let str = (string as NSString).appendingPathComponent(String(pathComponent))
+        if !dropExtension {
-        return Path(string: (str as NSString).standardizingPath)
+            return str.lastPathComponent
+        } else {
+            let ext = str.pathExtension
+            if !ext.isEmpty {
+                return String(str.lastPathComponent.dropLast(ext.count + 1))
+            } else {
+                return str.lastPathComponent
+            }
+        }
     }
 
     /// Returns the locale-aware sort order for the two paths.
+    /// :nodoc:
     @inlinable
     public static func <(lhs: Path, rhs: Path) -> Bool {
         return lhs.string.compare(rhs.string, locale: .current) == .orderedAscending
     }
 
-    /// A file entry from a directory listing.
+//MARK: Entry
+
+    /**
+     A file entry from a directory listing.
+     - SeeAlso: `ls()`
+    */
     public struct Entry {
         /// The kind of this directory entry.
         public enum Kind {
@@ -142,21 +189,3 @@ public struct Path: Equatable, Hashable, Comparable {
         public let path: Path
     }
 }
-
-/**
- Joins a path and a string to produce a new path.
-
-     Path.root/"a"       // => /a
-     Path.root/"a/b"     // => /a/b
-     Path.root/"a"/"b"   // => /a/b
-     Path.root/"a"/"/b"  // => /a/b
-
- - Parameter lhs: The base path to join with `rhs`.
- - Parameter rhs: The string to join with this `lhs`.
- - Returns: A new joined path.
- - SeeAlso: Path.join(_:)
- */
-@inlinable
-public func /<S>(lhs: Path, rhs: S) -> Path where S: StringProtocol {
-    return lhs.join(rhs)
-}

Tests/PathTests/PathTests.swift

@@ -132,5 +132,21 @@ class PathTests: XCTestCase {
         XCTAssertEqual(Path.root/"~/b", Path("/~/b"))
         XCTAssertEqual(Path("~/foo"), Path.home/"foo")
         XCTAssertNil(Path("~foo"))
+
+        XCTAssertEqual(Path.root/"a/foo"/"../bar", Path.root/"a/bar")
+        XCTAssertEqual(Path.root/"a/foo"/"/../bar", Path.root/"a/bar")
+        XCTAssertEqual(Path.root/"a/foo"/"../../bar", Path.root/"bar")
+        XCTAssertEqual(Path.root/"a/foo"/"../../../bar", Path.root/"bar")
+    }
+
+    func testCopyInto() throws {
+        try Path.mktemp { root in
+            let bar = try root.join("bar").touch()
+            try Path.mktemp { root in
+                try root.join("bar").touch()
+                XCTAssertThrowsError(try bar.copy(into: root))
+                try bar.copy(into: root, overwrite: true)
+            }
+        }
     }
 }

Tests/PathTests/XCTestManifests.swift

@@ -5,6 +5,7 @@ extension PathTests {
         ("testBasename", testBasename),
         ("testCodable", testCodable),
         ("testConcatenation", testConcatenation),
+        ("testCopyInto", testCopyInto),
         ("testEnumeration", testEnumeration),
         ("testEnumerationSkippingHiddenFiles", testEnumerationSkippingHiddenFiles),
         ("testExists", testExists),