Fix copy(into:) overwrite mode

Seems like Linux Foundation has a bug

I checked, seems fixed in Swift 5. But added a swift version check se we can verify and if not report the bug.

.travis.yml

@@ -2,6 +2,7 @@
 if: type != push OR branch = master OR branch =~ /^\d+\.\d+(\.\d+)?(-\S*)?$/
 
 stages:
+  - name: pretest
   - name: test
   - name: deploy
     if: branch =~ ^\d+\.\d+\.\d+$
@@ -34,7 +35,6 @@ jobs:
           -destination 'platform=watchOS Simulator,OS=latest,name=Apple Watch Series 4 - 40mm' \
           build | xcpretty
 
-
     - env: SWIFT_VERSION=4.2.1
       os: linux
       name: Linux
@@ -43,30 +43,35 @@ jobs:
       sudo: false
       install: eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
       script: swift test
+      
+    - stage: pretest
+      name: Check if Linux tests are up-to-date
+      install: swift test --generate-linuxmain
+      script: git diff --exit-code
 
-    - <<: *xcodebuild
-      stage: deploy
+    - stage: deploy
       name: Jazzy
       before_install: |
-        cat << EOF > .jazzy.yml
+        cat <<\ \ EOF> .jazzy.yaml
+        module: Path
+        module_version: TRAVIS_TAG
         custom_categories:
           - name: Path
             children:
               - Path
               - /(_:_:)
+        xcodebuild_arguments:
+          - UseModernBuildSystem=NO
+        output: output
+        github_url: https://github.com/mxcl/Path.swift
         EOF
-        touch Contents.md
+        sed -i '' "s/TRAVIS_TAG/$TRAVIS_TAG/" .jazzy.yaml
+      # ^^ this weirdness because Travis multiline YAML is broken and inserts two
+      # spaces in front of the output which means we need a prefixed delimiter which
+      # also weirdly stops bash from doing variable substitution
       install: gem install jazzy
-      script: |
-        jazzy \
-          --no-hide-documentation-coverage \
-          --theme fullwidth \
-          --output output \
-          --readme Contents.md \
-          --root-url https://mxcl.github.io/Path.swift/ \
-          --github_url https://github.com/mxcl/Path.swift \
-          --module Path \
-          --module-version $TRAVIS_TAG
+      before_script: swift package generate-xcodeproj
+      script: jazzy
       deploy:
         provider: pages
         skip-cleanup: true
@@ -75,7 +80,27 @@ jobs:
         on:
           tags: true
 
-    - stage: deploy
-      name: CocoaPods
+    - name: CocoaPods
+      before_install: |
+        cat <<\ \ EOF> Path.swift.podspec
+        Pod::Spec.new do |s|
+          s.name = 'Path.swift'
+          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' }
+          s.author = { 'mxcl' => 'mxcl@me.com' }
+          s.source = { :git => 'https://github.com/mxcl/Path.swift.git', :tag => s.version.to_s }
+          s.social_media_url = 'https://twitter.com/mxcl'
+          s.osx.deployment_target = '10.10'
+          s.ios.deployment_target = '8.0'
+          s.tvos.deployment_target = '10.0'
+          s.watchos.deployment_target = '3.0'
+          s.source_files = 'Sources/*'
+          s.swift_version = '4.2'
+        end
+        EOF
+        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

Path.swift.podspec

@@ -1,19 +0,0 @@
-Pod::Spec.new do |s|
-  s.name             = 'Path.swift'
-  s.version          = '0.4.1'
-  s.summary          = 'Delightful, robust file-pathing functions'
-  s.homepage         = 'https://github.com/mxcl/Path.swift'
-  s.license          = { :type => 'Unlicense', :file => 'LICENSE.md' }
-  s.author           = { 'mxcl' => 'mxcl@me.com' }
-  s.source           = { :git => 'https://github.com/mxcl/Path.swift.git', :tag => s.version.to_s }
-  s.social_media_url = 'https://twitter.com/mxcl'
-
-  s.osx.deployment_target = '10.10'
-  s.ios.deployment_target = '8.0'
-  s.tvos.deployment_target = '10.0'
-  s.watchos.deployment_target = '3.0'
-
-  s.source_files = 'Sources/*'
-  
-  s.swift_version = "4.2"
-end

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
-try Path.root.join("foo").copy(to: Path.root/"bar")
+// sensible considerations
+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
-try Path.root.join("foo").copy(into: Path.root.mkdir("bar"))
-// ^^ other libraries would make the above `to:` form handle both these cases
-// but that can easily lead to bugs where you accidentally write files that
-// were meant to be directory destinations
+// easy file-management
+let bar = try Path.root.join("foo").copy(to: Path.root/"bar")
+print(bar)         // => /bar
+print(bar.isFile)  // => true
+
+// 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
-like Swift, we provide a thoughtful and comprehensive (yet concise) API.
+We emphasize safety and correctness, just like Swift, and also (again like
+Swift), we provide a thoughtful and comprehensive (yet concise) API.
 
 # Support mxcl
 
@@ -208,4 +216,4 @@ https://codebasesaga.com/canopy/
 
 [badge-platforms]: https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20iOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey.svg
 [badge-languages]: https://img.shields.io/badge/swift-4.2-orange.svg
-[online API documentation]: https://mxcl.github.io/Path.swift/
+[online API documentation]: https://mxcl.github.io/Path.swift/Structs/Path.html

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? {
@@ -24,6 +25,7 @@ public extension Bundle {
     }
 }
 
+/// 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+Codable.swift

@@ -1,10 +1,12 @@
 import Foundation
 
+/// Provided for relative-path coding. See the instructions in our `README`.
 public extension CodingUserInfoKey {
     /// If set paths are encoded as relative to this path.
     static let relativePath = CodingUserInfoKey(rawValue: "dev.mxcl.Path.relative")!
 }
 
+/// Provided for relative-path coding. See the instructions in our `README`.
 extension Path: Codable {
     public init(from decoder: Decoder) throws {
         let value = try decoder.singleValueContainer().decode(String.self)

Sources/Path+FileManager.swift

@@ -7,7 +7,7 @@ public extension Path {
      - Parameter to: Destination filename.
      - Parameter overwrite: If true overwrites any file that already exists at `to`.
      - Returns: `to` to allow chaining
-     - SeeAlso: copy(into:overwrite:)
+     - SeeAlso: `copy(into:overwrite:)`
      */
     @discardableResult
     public func copy(to: Path, overwrite: Bool = false) throws -> Path {
@@ -22,21 +22,34 @@ public extension Path {
      Copies a file into a directory
 
      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 {
         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)
+        // 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
     }

Sources/Path+ls.swift

@@ -1,13 +1,19 @@
 import Foundation
 
 public extension Path {
-    /// Same as the `ls` command ∴ is ”shallow”
-    /// - Parameter skipHiddenFiles: Same as the `ls -a` if false. Otherwise returns only the non hidden files. Default is false.
-    func ls(skipHiddenFiles: Bool = false) throws -> [Entry] {
-        let options: FileManager.DirectoryEnumerationOptions = skipHiddenFiles ? [.skipsHiddenFiles] : []
-        let paths = try FileManager.default.contentsOfDirectory(at: url,
-                                                                includingPropertiesForKeys: nil,
-                                                                options: options)
+    /**
+     Same as the `ls -a` command ∴ is ”shallow”
+     - Parameter includeHiddenFiles: If `true`, hidden files are included in the results. Defaults to `true`.
+     - Important: `includeHiddenFiles` does not work on Linux
+     */
+    func ls(includeHiddenFiles: Bool = true) throws -> [Entry] {
+        var opts = FileManager.DirectoryEnumerationOptions()
+    #if !os(Linux)
+        if !includeHiddenFiles {
+            opts.insert(.skipsHiddenFiles)
+        }
+    #endif
+        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 }
             return Entry(kind: path.isDirectory ? .directory : .file, path: path)

Sources/Path->Bool.swift

@@ -5,6 +5,16 @@ public extension Path {
     var isWritable: Bool {
         return FileManager.default.isWritableFile(atPath: string)
     }
+    
+    /// 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 deletable by the current user.
+    var isDeletable: Bool {
+        return FileManager.default.isDeletableFile(atPath: string)
+    }
 
     /// Returns true if the path represents an actual directory.
     var isDirectory: Bool {

Sources/Path.swift

@@ -10,7 +10,7 @@ import Foundation
      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.
  */
 public struct Path: Equatable, Hashable, Comparable {
     /// The underlying filesystem path
@@ -113,7 +113,7 @@ public struct Path: Equatable, Hashable, Comparable {
 
      - Parameter pathComponent: The string to join with this path.
      - Returns: A new joined path.
-     - SeeAlso: /(:Path,:String)
+     - SeeAlso: `/(_:, _:)`
      */
     public func join<S>(_ pathComponent: S) -> Path where S: StringProtocol {
         //TODO standardizingPath does more than we want really (eg tilde expansion)
@@ -154,7 +154,7 @@ public struct Path: Equatable, Hashable, Comparable {
  - 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(_:)
+ - SeeAlso: `Path.join(_:)`
  */
 @inlinable
 public func /<S>(lhs: Path, rhs: S) -> Path where S: StringProtocol {

Tests/PathTests/PathTests.swift

@@ -31,8 +31,9 @@ class PathTests: XCTestCase {
         XCTAssertEqual(paths, ["a", "b", "c", ".d"])
         
     }
-    
+
     func testEnumerationSkippingHiddenFiles() throws {
+    #if !os(Linux)
         let tmpdir_ = try TemporaryDirectory()
         let tmpdir = tmpdir_.path
         try tmpdir.join("a").mkdir().join("c").touch()
@@ -42,7 +43,7 @@ class PathTests: XCTestCase {
         
         var paths = Set<String>()
         var dirs = 0
-        for entry in try tmpdir.ls(skipHiddenFiles: true) {
+        for entry in try tmpdir.ls(includeHiddenFiles: false) {
             if entry.kind == .directory {
                 dirs += 1
             }
@@ -50,7 +51,7 @@ class PathTests: XCTestCase {
         }
         XCTAssertEqual(dirs, 1)
         XCTAssertEqual(paths, ["a", "b", "c"])
-        
+    #endif
     }
 
     func testRelativeTo() {
@@ -131,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/TemporaryDirectory.swift

@@ -52,3 +52,20 @@ extension Path {
         return try body(tmp.path)
     }
 }
+
+
+#if !os(macOS) && !os(Linux)
+import XCTest
+
+// SwiftPM generates code that is improperly escaped thus we require this to
+// compile on iOS & tvOS.
+public typealias XCTestCaseEntry = (testCaseClass: XCTestCase.Type, allTests: [(String, (XCTestCase) throws -> Void)])
+
+public func testCase<T: XCTestCase>(_ allTests: [(String, (T) -> () throws -> Void)]) -> XCTestCaseEntry {
+    fatalError()
+}
+
+public func testCase<T: XCTestCase>(_ allTests: [(String, (T) -> () -> Void)]) -> XCTestCaseEntry {
+    fatalError()
+}
+#endif

Tests/PathTests/XCTestManifests.swift

@@ -5,9 +5,12 @@ extension PathTests {
         ("testBasename", testBasename),
         ("testCodable", testCodable),
         ("testConcatenation", testConcatenation),
+        ("testCopyInto", testCopyInto),
         ("testEnumeration", testEnumeration),
+        ("testEnumerationSkippingHiddenFiles", testEnumerationSkippingHiddenFiles),
         ("testExists", testExists),
         ("testIsDirectory", testIsDirectory),
+        ("testJoin", testJoin),
         ("testMkpathIfExists", testMkpathIfExists),
         ("testMktemp", testMktemp),
         ("testRelativePathCodable", testRelativePathCodable),
@@ -15,7 +18,7 @@ extension PathTests {
     ]
 }
 
-#if os(Linux)
+#if !os(macOS)
 public func __allTests() -> [XCTestCaseEntry] {
     return [
         testCase(PathTests.__allTests),