.some

Author: mxcl

.gitignore

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

LICENSE.md

@@ -0,0 +1,27 @@
+Unlicense (Public Domain)
+============================
+
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to &lt;<http://unlicense.org/>&gt;

Package.swift

@@ -0,0 +1,13 @@
+// swift-tools-version:4.2
+import PackageDescription
+
+let package = Package(
+    name: "Path.swift",
+    products: [
+        .library(name: "Path", targets: ["Path"]),
+    ],
+    targets: [
+        .target(name: "Path", path: "Sources"),
+        .testTarget(name: "PathTests", dependencies: ["Path"]),
+    ]
+)

README.md

@@ -0,0 +1,145 @@
+# Path.swift
+
+A file-system pathing library focused on developer experience and robust
+end‐results.
+
+```swift
+// convenient static members
+let home = Path.home
+
+// pleasant joining syntax
+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
+try Path.home.join("foo").mkpath().join("bar").chmod(0o555)
+
+// easy file-management
+try Path.root.join("foo").copy(to: Path.root.join("bar"))
+
+// careful API to avoid common bugs
+try Path.root.join("foo").copy(into: Path.root.mkdir("bar"))
+// ^^ other libraries would make the `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
+```
+
+Paths are just string representations, there *may not* be a real file there.
+
+# Support mxcl
+
+Hi, I’m Max Howell and I have written a lot of open source software, and
+probably you already use some of it (Homebrew anyone?). Please help me so I
+can continue to make tools and software you need and love. I appreciate it x.
+
+<a href="https://www.patreon.com/mxcl">
+	<img src="https://c5.patreon.com/external/logo/[email protected]" width="160">
+</a>
+
+## Codable
+
+We support `Codable` as you would expect:
+
+```swift
+try JSONEncoder().encode([Path.home, Path.home/"foo"])
+```
+
+```json
+[
+    "/Users/mxcl",
+    "/Users/mxcl/foo",
+]
+```
+
+However, often you want to encode relative paths:
+
+```swift
+let encoder = JSONEncoder()
+encoder.userInfo[.relativePath] = Path.home
+encoder.encode([Path.home, Path.home/"foo"])
+```
+
+```json
+[
+    "",
+    "foo",
+]
+```
+
+**Note** make sure you decode with this key set *also*, otherwise we `fatal`
+(unless the paths are absolute obv.)
+
+```swift
+let decoder = JSONDecoder()
+decoder.userInfo[.relativePath] = Path.home
+decoder.decode(from: data)
+```
+
+## Initializing from user-input
+
+The `Path` initializer returns `nil` unless fed an absolute path; thus to
+initialize from user-input that may contain a relative path use this form:
+
+```swift
+let path = Path(userInput) ?? Path.cwd/userInput
+```
+
+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.
+
+## Extensions
+
+We have some extensions to Apple APIs:
+
+```swift
+let bashProfile = try String(contentsOf: Path.home/".bash_profile")
+let history = try Data(contentsOf: Path.home/".history")
+
+bashProfile += "\n\nfoo"
+
+try bashProfile.write(to: Path.home/".bash_profile")
+
+try Bundle.main.resources!.join("foo").copy(to: .home)
+// ^^ `-> Path?` because the underlying `Bundle` function is `-> String?`
+```
+
+## Directory listings
+
+We provide `ls()`, called because it behaves like the Terminal `ls` function,
+the name thus implies its behavior, ie. that it is not recursive.
+
+```swift
+for path in Path.home.ls() {
+    print(path.path)
+    print(path.kind)  // .directory or .file
+}
+
+for path in Path.home.ls() where path.kind == .file {
+    //…
+}
+
+for path in Path.home.ls() where path.mtime > yesterday {
+    //…
+}
+
+let dirs = Path.home.ls().directories().filter {
+    //…
+}
+
+let swiftFiles = Path.home.ls().files(withExtension: "swift")
+```
+
+# Installation
+
+SwiftPM only:
+
+```swift
+package.append(.package(url: "https://github.com/mxcl/Path.swift", from: "0.0.0"))
+```
+
+### Get push notifications for new releases
+
+https://codebasesaga.com/canopy/

Sources/Extensions.swift

@@ -0,0 +1,53 @@
+import Foundation
+
+public extension Bundle {
+    func path(forResource: String, ofType: String?) -> Path? {
+        let f: (String?, String?) -> String? = path(forResource:ofType:)
+        let str = f(forResource, ofType)
+        return str.flatMap(Path.init)
+    }
+
+    public var sharedFrameworks: Path? {
+        return sharedFrameworksPath.flatMap(Path.init)
+    }
+
+    public var resources: Path? {
+        return resourcePath.flatMap(Path.init)
+    }
+}
+
+public extension String {
+    @inlinable
+    init(contentsOf path: Path) throws {
+        try self.init(contentsOfFile: path.string)
+    }
+
+    /// - Returns: `to` to allow chaining
+    @inlinable
+    @discardableResult
+    func write(to: Path, atomically: Bool = false, encoding: String.Encoding = .utf8) throws -> Path {
+        try write(toFile: to.string, atomically: atomically, encoding: encoding)
+        return to
+    }
+}
+
+public extension Data {
+    @inlinable
+    init(contentsOf path: Path) throws {
+        try self.init(contentsOf: path.url)
+    }
+
+    /// - Returns: `to` to allow chaining
+    @inlinable
+    @discardableResult
+    func write(to: Path, atomically: Bool = false) throws -> Path {
+        let opts: NSData.WritingOptions
+        if atomically {
+            opts = .atomicWrite
+        } else {
+            opts = []
+        }
+        try write(to: to.url, options: opts)
+        return to
+    }
+}

Sources/Path+Attributes.swift

@@ -0,0 +1,56 @@
+import Foundation
+
+public extension Path {
+    /// - Note: If file is already locked, does nothing
+    /// - Note: If file doesn’t exist, throws
+    @discardableResult
+    public func lock() throws -> Path {
+        var attrs = try FileManager.default.attributesOfItem(atPath: string)
+        let b = attrs[.immutable] as? Bool ?? false
+        if !b {
+            attrs[.immutable] = true
+            try FileManager.default.setAttributes(attrs, ofItemAtPath: string)
+        }
+        return self
+    }
+
+    /// - Note: If file isn‘t locked, does nothing
+    /// - Note: If file doesn’t exist, does nothing
+    @discardableResult
+    public func unlock() throws -> Path {
+        var attrs: [FileAttributeKey: Any]
+        do {
+            attrs = try FileManager.default.attributesOfItem(atPath: string)
+        } catch CocoaError.fileReadNoSuchFile {
+            return self
+        }
+        let b = attrs[.immutable] as? Bool ?? false
+        if b {
+            attrs[.immutable] = false
+            try FileManager.default.setAttributes(attrs, ofItemAtPath: string)
+        }
+        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: modification-time or creation-time if none
+    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 print(error)
+            return Date()
+        }
+    }
+}

Sources/Path+Codable.swift

@@ -0,0 +1,28 @@
+import Foundation
+
+public extension CodingUserInfoKey {
+    static let relativePath = CodingUserInfoKey(rawValue: "dev.mxcl.Path.relative")!
+}
+
+extension Path: Codable {
+    public init(from decoder: Decoder) throws {
+        let value = try decoder.singleValueContainer().decode(String.self)
+        if value.hasPrefix("/") {
+            string = value
+        } else {
+            guard let root = decoder.userInfo[.relativePath] as? Path else {
+                throw DecodingError.dataCorrupted(.init(codingPath: [], debugDescription: "Path cannot decode a relative path if `userInfo[.relativePath]` not set to a Path object."))
+            }
+            string = (root/value).string
+        }
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.singleValueContainer()
+        if let root = encoder.userInfo[.relativePath] as? Path {
+            try container.encode(relative(to: root))
+        } else {
+            try container.encode(string)
+        }
+    }
+}