Merge pull request #33 from mxcl/bundle-private-frameworks

Bundle.privateFrameworks

.travis.yml

@@ -90,12 +90,15 @@ jobs:
           tags: true
 
     - name: CocoaPods
-      before_install: |
+      before_install: export TRAVIS_REPO_NAME=${TRAVIS_REPO_SLUG#*/}
+      install: gem install cocoapods
+      before_script: |
         export DESCRIPTION=$(swift - <<\ \ EOF
           import Foundation
           struct Response: Decodable { let description: String }
           let token = ProcessInfo.processInfo.environment["GITHUB_TOKEN"]!
-          let url = URL(string: "https://api.github.com/repos/mxcl/Path.swift")!
+          let slug = ProcessInfo.processInfo.environment["TRAVIS_REPO_SLUG"]!
+          let url = URL(string: "https://api.github.com/repos/\(slug)")!
           var rq = URLRequest(url: url)
           rq.setValue("token \(token)", forHTTPHeaderField: "Authorization")
           let semaphore = DispatchSemaphore(value: 0)
@@ -108,15 +111,15 @@ jobs:
           let rsp = try JSONDecoder().decode(Response.self, from: data)
           print(rsp.description, terminator: "")
         EOF)
-        cat <<\ \ EOF> Path.swift.podspec
+        cat <<\ \ EOF> $TRAVIS_REPO_NAME.podspec
         Pod::Spec.new do |s|
-          s.name = 'Path.swift'
+          s.name = ENV['TRAVIS_REPO_NAME']
           s.version = ENV['TRAVIS_TAG']
           s.summary = ENV['DESCRIPTION']
-          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.homepage = "https://github.com/#{ENV['TRAVIS_REPO_SLUG']}"
+          s.license = { type: 'Unlicense', file: 'LICENSE.md' }
+          s.author = { mxcl: 'mxcl@me.com' }
+          s.source = { git: "https://github.com/#{ENV['TRAVIS_REPO_SLUG']}.git", tag: s.version }
           s.social_media_url = 'https://twitter.com/mxcl'
           s.osx.deployment_target = '10.10'
           s.ios.deployment_target = '8.0'
@@ -126,5 +129,4 @@ jobs:
           s.swift_version = '4.2'
         end
         EOF
-      install: gem install cocoapods --pre
       script: pod trunk push

README.md

@@ -1,4 +1,4 @@
-# Path.swift ![badge-platforms][] ![badge-languages][] [![badge-ci][]][travis] [![badge-jazzy][]][docs] [![badge-codecov][]][codecov] ![badge-version][]
+# Path.swift ![badge-platforms][] ![badge-languages][] [![badge-ci][]][travis] [![badge-jazzy][]][docs] [![badge-codecov][]][codecov] [![badge-version][]][cocoapods]
 
 A file-system pathing library focused on developer experience and robust end
 results.
@@ -36,7 +36,7 @@ print(foo.isFile)  // => true
 let prefs = Path.home.Library.Preferences  // => /Users/mxcl/Library/Preferences
 
 // a practical example: installing a helper executable
-try Bundle.resources.join("helper").copy(into: Path.home.join(".local/bin").mkdir(.p)).chmod(0o500)
+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
@@ -57,7 +57,8 @@ help me continue my work, I appreciate it x
 
 # Handbook
 
-Our [online API documentation][docs] is automatically updated for new releases.
+Our [online API documentation][docs] covers 100% of our public API and is
+automatically updated for new releases.
 
 ## Codable
 
@@ -229,7 +230,7 @@ for that as the check was deemed too expensive to be worthwhile.
 SwiftPM:
 
 ```swift
-package.append(.package(url: "https://github.com/mxcl/Path.swift", from: "0.5.0"))
+package.append(.package(url: "https://github.com/mxcl/Path.swift.git", from: "0.5.0"))
 ```
 
 CocoaPods:
@@ -253,6 +254,7 @@ https://codebasesaga.com/canopy/
 
 # Alternatives
 
+* [Pathos](https://github.com/dduan/Pathos) by Daniel Duan
 * [PathKit](https://github.com/kylef/PathKit) by Kyle Fuller
 * [Files](https://github.com/JohnSundell/Files) by John Sundell
 * [Utility](https://github.com/apple/swift-package-manager) by Apple
@@ -267,3 +269,4 @@ https://codebasesaga.com/canopy/
 [travis]: https://travis-ci.com/mxcl/Path.swift
 [codecov]: https://codecov.io/gh/mxcl/Path.swift
 [badge-version]: https://img.shields.io/cocoapods/v/Path.swift.svg?label=version
+[cocoapods]: https://cocoapods.org/pods/Path.swift

Sources/Extensions.swift

@@ -9,32 +9,25 @@ public extension Bundle {
         return str.flatMap(Path.init)
     }
 
-    /// 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`
+    */
     var sharedFrameworks: Path {
-        var `default`: Path {
-          #if os(macOS)
-            return path.join("Contents/Frameworks")
-          #elseif os(Linux)
-            return path.join("lib")
-          #else
-            return path.join("Frameworks")
-          #endif
+        return sharedFrameworksPath.flatMap(Path.init) ?? defaultSharedFrameworksPath
     }
-        return sharedFrameworksPath.flatMap(Path.init) ?? `default`
+
+    /**
+     Returns the path for the private-frameworks directory in this bundle.
+     - Note: This is typically `Frameworks`
+    */
+    var privateFrameworks: Path {
+        return privateFrameworksPath.flatMap(Path.init) ?? defaultSharedFrameworksPath
     }
 
     /// Returns the path for the resources directory in this bundle.
     var resources: Path {
-        var `default`: Path {
-          #if os(macOS)
-            return path.join("Contents/Resources")
-          #elseif os(Linux)
-            return path.join("share")
-          #else
-            return path
-          #endif
-        }
-        return resourcePath.flatMap(Path.init) ?? `default`
+        return resourcePath.flatMap(Path.init) ?? defaultResourcesPath
     }
 
     /// Returns the path for this bundle.
@@ -107,3 +100,25 @@ public extension FileHandle {
         try self.init(forUpdating: path.url)
     }
 }
+
+internal extension Bundle {
+    var defaultSharedFrameworksPath: Path {
+      #if os(macOS)
+        return path.join("Contents/Frameworks")
+      #elseif os(Linux)
+        return path.join("lib")
+      #else
+        return path.join("Frameworks")
+      #endif
+    }
+
+    var defaultResourcesPath: Path {
+      #if os(macOS)
+        return path.join("Contents/Resources")
+      #elseif os(Linux)
+        return path.join("share")
+      #else
+        return path
+      #endif
+    }
+}

Sources/Path+Attributes.swift

@@ -1,7 +1,4 @@
 import Foundation
-//#if os(Linux)
-//import func Glibc.chmod
-//#endif
 
 public extension Path {
     //MARK: Filesystem Attributes
@@ -40,15 +37,12 @@ public extension Path {
      */
     @discardableResult
     func chmod(_ octal: Int) throws -> Path {
-//    #if os(Linux)
-//        Glibc.chmod(string, __mode_t(octal))
-//    #else
         try FileManager.default.setAttributes([.posixPermissions: octal], ofItemAtPath: string)
-//    #endif
         return self
     }
     
     /**
+     Applies the macOS filesystem “lock” attribute.
      - Note: If file is already locked, does nothing.
      - Note: If file doesn’t exist, throws.
      - Important: On Linux does nothing.
@@ -70,6 +64,7 @@ public extension Path {
      - Note: If file isn‘t locked, does nothing.
      - Note: If file doesn’t exist, does nothing.
      - Important: On Linux does nothing.
+     - SeeAlso: `lock()`
      */
     @discardableResult
     func unlock() throws -> Path {

Sources/Path+CommonDirectories.swift

@@ -47,18 +47,7 @@ extension Path {
             fatalError()
         }
     #else    
-        guard let pathString = FileManager.default.urls(for: searchPath, in: .userDomainMask).first?.path else {
-            switch searchPath {
-            case .documentDirectory:
-                return Path.home/"Documents"
-            case .applicationSupportDirectory:
-                return Path.home/"Library/Application Support"
-            case .cachesDirectory:
-                return Path.home/"Library/Caches"
-            default:
-                fatalError()
-            }
-        }
+        guard let pathString = FileManager.default.urls(for: searchPath, in: .userDomainMask).first?.path else { return defaultUrl(for: searchPath) }
         return Path(string: pathString)
     #endif
     }
@@ -90,3 +79,19 @@ extension Path {
         return path(for: .applicationSupportDirectory)
     }
 }
+
+#if !os(Linux)
+func defaultUrl(for searchPath: FileManager.SearchPathDirectory) -> Path {
+    switch searchPath {
+    case .documentDirectory:
+        return Path.home/"Documents"
+    case .applicationSupportDirectory:
+        return Path.home/"Library/Application Support"
+    case .cachesDirectory:
+        return Path.home/"Library/Caches"
+    default:
+        fatalError()
+    }
+}
+#endif
+

Sources/Path+FileManager.swift

@@ -1,4 +1,7 @@
 import Foundation
+#if os(Linux)
+import Glibc
+#endif
 
 public extension Path {
     //MARK: File Management
@@ -25,6 +28,11 @@ public extension Path {
         if overwrite, to.isFile, isFile {
             try FileManager.default.removeItem(at: to.url)
         }
+    #if os(Linux) && !swift(>=5.1) // check if fixed
+        if !overwrite, to.isFile {
+            throw CocoaError.error(.fileWriteFileExists)
+        }
+    #endif
         try FileManager.default.copyItem(atPath: string, toPath: to.string)
         return to
     }
@@ -38,7 +46,8 @@ public extension Path {
          // 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").mkdir(.p)).chmod(0o500)
 
-     If the destination does not exist, this function creates the directory first.
+     If the destination does not exist, this function creates the directory
+     (including intermediary directories if necessary) first.
 
      - Parameter into: Destination directory
      - Parameter overwrite: If true overwrites any file that already exists at `into`.
@@ -48,25 +57,21 @@ public extension Path {
       `self` because even though *Path.swift’s* policy is to noop if the desired
        end result preexists, checking for this condition is too expensive a
        trade-off.
-     - SeeAlso: `copy(into:overwrite:)`
+     - SeeAlso: `copy(to:overwrite:)`
      */
     @discardableResult
     func copy(into: Path, overwrite: Bool = false) throws -> Path {
         if !into.exists {
-            try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
+            try into.mkdir(.p)
         }
         let rv = into/basename()
         if overwrite, rv.isFile {
             try rv.delete()
         }
-    #if os(Linux)
-    #if swift(>=5.1)
-        // check if fixed
-    #else
+    #if os(Linux) && !swift(>=5.1) // check if fixed
         if !overwrite, rv.isFile {
             throw CocoaError.error(.fileWriteFileExists)
         }
-    #endif
     #endif
         try FileManager.default.copyItem(at: url, to: rv.url)
         return rv
@@ -86,7 +91,7 @@ public extension Path {
        `self` because even though *Path.swift’s* policy is to noop if the desired
        end result preexists, checking for this condition is too expensive a
        trade-off.
-     - SeeAlso: move(into:overwrite:)
+     - SeeAlso: `move(into:overwrite:)`
      */
     @discardableResult
     func move(to: Path, overwrite: Bool = false) throws -> Path {
@@ -103,13 +108,14 @@ public extension Path {
          try Path.root.join("bar").move(into: .home)
          // => "/Users/mxcl/bar"
 
-     If the destination does not exist, this function creates the directory first.
+     If the destination does not exist, this function creates the directory
+     (including intermediary directories if necessary) first.
 
      - Parameter into: Destination directory
      - Parameter overwrite: If true *overwrites* any file that already exists at `into`.
      - Note: `throws` if `into` is a file.
      - Returns: The `Path` of destination filename.
-     - SeeAlso: move(into:overwrite:)
+     - SeeAlso: `move(to:overwrite:)`
      */
     @discardableResult
     func move(into: Path, overwrite: Bool = false) throws -> Path {
@@ -142,13 +148,26 @@ public extension Path {
     }
 
     /**
-     Creates an empty file at this path.
+     Creates an empty file at this path or if the file exists, updates its modification time.
      - Returns: `self` to allow chaining.
      */
     @inlinable
     @discardableResult
     func touch() throws -> Path {
-        return try "".write(to: self)
+        if !exists {
+            guard FileManager.default.createFile(atPath: string, contents: nil) else {
+                throw CocoaError.error(.fileWriteUnknown)
+            }
+        } else {
+        #if os(Linux)
+            let fd = open(string, O_WRONLY)
+            defer { close(fd) }
+            futimens(fd, nil)
+        #else
+            try FileManager.default.setAttributes([.modificationDate: Date()], ofItemAtPath: string)
+        #endif
+        }
+        return self
     }
 
     /**

Tests/PathTests/PathTests.swift

@@ -1,5 +1,5 @@
+@testable import Path
 import XCTest
-import Path
 
 class PathTests: XCTestCase {
     func testConcatenation() {
@@ -169,6 +169,8 @@ class PathTests: XCTestCase {
             try root.foo.touch().copy(to: root.bar)
             XCTAssert(root.foo.isFile)
             XCTAssert(root.bar.isFile)
+            XCTAssertThrowsError(try root.foo.copy(to: root.bar))
+            try root.foo.copy(to: root.bar, overwrite: true)
         }
     }
 
@@ -182,14 +184,25 @@ class PathTests: XCTestCase {
                 XCTAssertTrue(bar1.exists)
                 XCTAssertTrue(bar2.exists)
             }
+
+            // test creates intermediary directories
+            try bar1.copy(into: root1.create.directories)
+
+            // test doesn’t replace file if “copy into” a file
+            let d = try root1.fuz.touch()
+            XCTAssertThrowsError(try root1.baz.touch().copy(into: d))
+            XCTAssert(d.isFile)
+            XCTAssert(root1.baz.isFile)
         }
     }
 
     func testMoveTo() throws {
-        try Path.mktemp { root in
-            try root.foo.touch().move(to: root.bar)
-            XCTAssertFalse(root.foo.exists)
-            XCTAssert(root.bar.isFile)
+        try Path.mktemp { tmpdir in
+            try tmpdir.foo.touch().move(to: tmpdir.bar)
+            XCTAssertFalse(tmpdir.foo.exists)
+            XCTAssert(tmpdir.bar.isFile)
+            XCTAssertThrowsError(try tmpdir.foo.touch().move(to: tmpdir.bar))
+            try tmpdir.foo.move(to: tmpdir.bar, overwrite: true)
         }
     }
 
@@ -203,6 +216,17 @@ class PathTests: XCTestCase {
                 XCTAssertFalse(bar1.exists)
                 XCTAssertTrue(bar2.exists)
             }
+
+            // test creates intermediary directories
+            try root1.baz.touch().move(into: root1.create.directories)
+            XCTAssertFalse(root1.baz.exists)
+            XCTAssert(root1.create.directories.baz.isFile)
+
+            // test doesn’t replace file if “move into” a file
+            let d = try root1.fuz.touch()
+            XCTAssertThrowsError(try root1.baz.touch().move(into: d))
+            XCTAssert(d.isFile)
+            XCTAssert(root1.baz.isFile)
         }
     }
 
@@ -225,10 +249,14 @@ class PathTests: XCTestCase {
         XCTAssertEqual(Path.root.string, "/")
         XCTAssertEqual(Path.home.string, NSHomeDirectory())
         XCTAssertEqual(Path.documents.string, NSHomeDirectory() + "/Documents")
-    #if os(macOS)
+    #if !os(Linux)
         XCTAssertEqual(Path.caches.string, NSHomeDirectory() + "/Library/Caches")
         XCTAssertEqual(Path.cwd.string, FileManager.default.currentDirectoryPath)
         XCTAssertEqual(Path.applicationSupport.string, NSHomeDirectory() + "/Library/Application Support")
+
+        _ = defaultUrl(for: .documentDirectory)
+        _ = defaultUrl(for: .cachesDirectory)
+        _ = defaultUrl(for: .applicationSupportDirectory)
     #endif
     }
 
@@ -298,6 +326,9 @@ class PathTests: XCTestCase {
             let now2 = Date().timeIntervalSince1970.rounded(.down)
             XCTAssertNotEqual(now1, now2)
             XCTAssertEqual(foo.mtime?.timeIntervalSince1970.rounded(.down), now2)  //FIXME flakey
+
+            XCTAssertNil(tmpdir.void.mtime)
+            XCTAssertNil(tmpdir.void.ctime)
         }
     }
 
@@ -325,23 +356,37 @@ class PathTests: XCTestCase {
         XCTAssertThrowsError(try JSONDecoder().decode([Path].self, from: data))
     }
 
-    func testBundleExtensions() {
-        XCTAssertTrue(Bundle.main.path.isDirectory)
-        XCTAssertTrue(Bundle.main.resources.isDirectory)
+    func testBundleExtensions() throws {
+        try Path.mktemp { tmpdir in
+            let bndl = Bundle(path: tmpdir.string)!
+            XCTAssertEqual(bndl.path, tmpdir)
+            XCTAssertEqual(bndl.sharedFrameworks, tmpdir.SharedFrameworks)
+            XCTAssertEqual(bndl.privateFrameworks, tmpdir.Frameworks)
+            XCTAssertEqual(bndl.resources, tmpdir)
+            XCTAssertNil(bndl.path(forResource: "foo", ofType: "bar"))
 
-        // don’t exist in tests
-        _ = Bundle.main.path(forResource: "foo", ofType: "bar")
-        _ = Bundle.main.sharedFrameworks
+        #if os(macOS)
+            XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.Contents.Frameworks)
+            XCTAssertEqual(bndl.defaultResourcesPath, tmpdir.Contents.Resources)
+        #elseif os(tvOS) || os(iOS)
+            XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.Frameworks)
+            XCTAssertEqual(bndl.defaultResourcesPath, tmpdir)
+        #else
+            XCTAssertEqual(bndl.defaultSharedFrameworksPath, tmpdir.lib)
+            XCTAssertEqual(bndl.defaultResourcesPath, tmpdir.share)
+        #endif
+        }
     }
 
-    func testDataExentsions() throws {
+    func testDataExtensions() throws {
         let data = try Data(contentsOf: Path(#file)!)
         try Path.mktemp { tmpdir in
             _ = try data.write(to: tmpdir.foo)
+            _ = try data.write(to: tmpdir.foo, atomically: true)
         }
     }
 
-    func testStringExentsions() throws {
+    func testStringExtensions() throws {
         let string = try String(contentsOf: Path(#file)!)
         try Path.mktemp { tmpdir in
             _ = try string.write(to: tmpdir.foo)
@@ -353,4 +398,30 @@ class PathTests: XCTestCase {
         _ = try FileHandle(forWritingAt: Path(#file)!)
         _ = try FileHandle(forUpdatingAt: Path(#file)!)
     }
+
+    func testSort() {
+        XCTAssertEqual([Path.root.a, Path.root.c, Path.root.b].sorted(), [Path.root.a, Path.root.b, Path.root.c])
+    }
+
+    func testLock() throws {
+    #if !os(Linux)
+        try Path.mktemp { tmpdir in
+            let bar = try tmpdir.bar.touch()
+            try bar.lock()
+            XCTAssertThrowsError(try bar.touch())
+            try bar.unlock()
+            try bar.touch()
+
+            // a non existant file is already “unlocked”
+            try tmpdir.nonExit.unlock()
+        }
+    #endif
+    }
+
+    func testTouchThrowsIfCannotWrite() throws {
+        try Path.mktemp { tmpdir in
+            try tmpdir.chmod(0o000)
+            XCTAssertThrowsError(try tmpdir.bar.touch())
+        }
+    }
 }

Tests/PathTests/XCTestManifests.swift

@@ -9,7 +9,7 @@ extension PathTests {
         ("testConcatenation", testConcatenation),
         ("testCopyInto", testCopyInto),
         ("testCopyTo", testCopyTo),
-        ("testDataExentsions", testDataExentsions),
+        ("testDataExtensions", testDataExtensions),
         ("testDelete", testDelete),
         ("testDynamicMember", testDynamicMember),
         ("testEnumeration", testEnumeration),
@@ -20,6 +20,7 @@ extension PathTests {
         ("testFilesystemAttributes", testFilesystemAttributes),
         ("testIsDirectory", testIsDirectory),
         ("testJoin", testJoin),
+        ("testLock", testLock),
         ("testMkpathIfExists", testMkpathIfExists),
         ("testMktemp", testMktemp),
         ("testMoveInto", testMoveInto),
@@ -28,9 +29,11 @@ extension PathTests {
         ("testRelativePathCodable", testRelativePathCodable),
         ("testRelativeTo", testRelativeTo),
         ("testRename", testRename),
+        ("testSort", testSort),
         ("testStringConvertibles", testStringConvertibles),
-        ("testStringExentsions", testStringExentsions),
+        ("testStringExtensions", testStringExtensions),
         ("testTimes", testTimes),
+        ("testTouchThrowsIfCannotWrite", testTouchThrowsIfCannotWrite),
     ]
 }