Fix Travis

Adding convenience extensions on Path->Bool

.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
@@ -44,19 +44,34 @@ jobs:
       install: eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
       script: swift test
       
-    - <<: *xcodebuild
+    - stage: pretest
-      stage: deploy
+      name: Check if Linux tests are up-to-date
+      install: swift test --generate-linuxmain
+      script: git diff --exit-code
+
+    - stage: deploy
       name: Jazzy
+      before_install: |
+        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
+        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: |
+      before_script: swift package generate-xcodeproj
-        jazzy \
+      script: jazzy
-          --min-acl internal \
-          --no-hide-documentation-coverage \
-          --theme fullwidth \
-          --output output \
-          --readme README.md \
-          --root-url https://mxcl.github.io/Path.swift/ \
-          --github_url https://github.com/mxcl/Path.swift
       deploy:
         provider: pages
         skip-cleanup: true
@@ -64,3 +79,28 @@ jobs:
         local-dir: output
         on:
           tags: true
+
+    - 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

README.md

@@ -16,14 +16,14 @@ let docs = Path.home/"Documents"
 let path = Path(userInput) ?? Path.cwd/userInput
 
 // chainable syntax so you have less boilerplate
-try Path.home.join("foo").mkpath().join("bar").touch().chmod(0o555)
+try Path.home.join("foo").mkdir().join("bar").touch().chmod(0o555)
 
 // easy file-management
 try Path.root.join("foo").copy(to: Path.root/"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
+// ^^ 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
 ```
@@ -41,6 +41,8 @@ can continue to make tools and software you need and love. I appreciate it x.
 	<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
 </a>
 
+[Other donation/tipping options](http://mxcl.github.io/donate/)
+
 # Handbook
 
 Our [online API documentation] is automatically updated for new releases.
@@ -97,6 +99,11 @@ 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`,
+the same conformance as that `Int`, `Float` etc. conform. The protocol enforces
+a nameless initialization and since it is appropriate for us to conform to it,
+we do.
+
 ## Extensions
 
 We have some extensions to Apple APIs:
@@ -165,7 +172,7 @@ Path.root/"~b"     // => /~b
 Path.root/"~/b"    // => /~/b
 
 // but is here
-Path("~/foo")!     // => /Users/foo
+Path("~/foo")!     // => /Users/mxcl/foo
 
 // this does not work though
 Path("~foo")       // => nil
@@ -173,12 +180,21 @@ Path("~foo")       // => nil
 
 # Installation
 
-SwiftPM only:
+SwiftPM:
 
 ```swift
-package.append(.package(url: "https://github.com/mxcl/Path.swift", from: "0.0.0"))
+package.append(.package(url: "https://github.com/mxcl/Path.swift", from: "0.4.1"))
 ```
 
+CocoaPods:
+
+```ruby
+pod 'Path.swift' ~> '0.4.1'
+```
+
+Please note! We are pre 1.0, thus we can change the API as we like! We will tag
+1.0 as soon as possible.
+
 ### Get push notifications for new releases
 
 https://codebasesaga.com/canopy/
@@ -192,4 +208,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/Path+CommonDirectories.swift

@@ -0,0 +1,90 @@
+import Foundation
+
+extension Path {
+    /// Returns a `Path` containing ``FileManager.default.currentDirectoryPath`.
+    public static var cwd: Path {
+        return Path(string: FileManager.default.currentDirectoryPath)
+    }
+
+    /// Returns a `Path` representing the root path.
+    public static var root: Path {
+        return Path(string: "/")
+    }
+
+    /// Returns a `Path` representing the user’s home directory
+    public static var home: Path {
+        let string: String
+      #if os(macOS)
+        if #available(OSX 10.12, *) {
+            string = FileManager.default.homeDirectoryForCurrentUser.path
+        } else {
+            string = NSHomeDirectory()
+        }
+      #else
+        string = NSHomeDirectory()
+      #endif
+        return Path(string: string)
+    }
+
+    /// Helper to allow search path and domain mask to be passed in.
+    private static func path(for searchPath: FileManager.SearchPathDirectory) -> Path {
+    #if os(Linux)
+        // the urls(for:in:) function is not implemented on Linux
+        //TODO strictly we should first try to use the provided binary tool
+
+        let foo = { ProcessInfo.processInfo.environment[$0].flatMap(Path.init) ?? $1 }
+
+        switch searchPath {
+        case .documentDirectory:
+            return Path.home/"Documents"
+        case .applicationSupportDirectory:
+            return foo("XDG_DATA_HOME", Path.home/".local/share")
+        case .cachesDirectory:
+            return foo("XDG_CACHE_HOME", Path.home/".cache")
+        default:
+            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()
+            }
+        }
+        return Path(string: pathString)
+    #endif
+    }
+
+    /**
+     The root for user 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.
+     */
+    public static var documents: Path {
+        return path(for: .documentDirectory)
+    }
+
+    /**
+     The root for cache files.
+     - Note: On Linux this is 'XDG_CACHE_HOME'.
+     - Note: You should create a subdirectory before creating any files.
+     */
+    public static var caches: Path {
+        return path(for: .cachesDirectory)
+    }
+
+    /**
+     For data that supports your running application.
+     - Note: On Linux is `XDG_DATA_HOME`.
+     - Note: You should create a subdirectory before creating any files.
+     */
+    public static var applicationSupport: Path {
+        return path(for: .applicationSupportDirectory)
+    }
+}

Sources/Path+ls.swift

@@ -1,14 +1,24 @@
 import Foundation
 
 public extension Path {
-    /// same as the `ls` command ∴ is ”shallow”
+    /**
-    func ls() throws -> [Entry] {
+     Same as the `ls -a` command ∴ is ”shallow”
-        let relativePaths = try FileManager.default.contentsOfDirectory(atPath: string)
+     - Parameter includeHiddenFiles: If `true`, hidden files are included in the results. Defaults to `true`.
-        func convert(relativePath: String) -> Entry {
+     - Important: `includeHiddenFiles` does not work on Linux
-            let path = self/relativePath
+     */
+    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)
         }
-        return relativePaths.map(convert)
+        return paths.compactMap(convert)
     }
 }
 

Sources/Path->Bool.swift

@@ -6,6 +6,16 @@ public extension Path {
         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 {
         var isDir: ObjCBool = false

Sources/Path.swift

@@ -16,31 +16,6 @@ public struct Path: Equatable, Hashable, Comparable {
     /// The underlying filesystem path
     public let string: String
 
-    /// Returns a `Path` containing ``FileManager.default.currentDirectoryPath`.
-    public static var cwd: Path {
-        return Path(string: FileManager.default.currentDirectoryPath)
-    }
-
-    /// Returns a `Path` representing the root path.
-    public static var root: Path {
-        return Path(string: "/")
-    }
-
-    /// Returns a `Path` representing the user’s home directory
-    public static var home: Path {
-        let string: String
-      #if os(macOS)
-        if #available(OSX 10.12, *) {
-            string = FileManager.default.homeDirectoryForCurrentUser.path
-        } else {
-            string = NSHomeDirectory()
-        }
-      #else
-        string = NSHomeDirectory()
-      #endif
-        return Path(string: string)
-    }
-
     /**
      Returns the filename extension of this path.
      - Remark: Implemented via `NSString.pathExtension`.

Tests/PathTests/PathTests.swift

@@ -17,6 +17,7 @@ class PathTests: XCTestCase {
         try tmpdir.join("a").mkdir().join("c").touch()
         try tmpdir.join("b").touch()
         try tmpdir.join("c").touch()
+        try tmpdir.join(".d").mkdir().join("e").touch()
 
         var paths = Set<String>()
         var dirs = 0
@@ -26,8 +27,31 @@ class PathTests: XCTestCase {
             }
             paths.insert(entry.path.basename())
         }
+        XCTAssertEqual(dirs, 2)
+        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()
+        try tmpdir.join("b").touch()
+        try tmpdir.join("c").touch()
+        try tmpdir.join(".d").mkdir().join("e").touch()
+        
+        var paths = Set<String>()
+        var dirs = 0
+        for entry in try tmpdir.ls(includeHiddenFiles: false) {
+            if entry.kind == .directory {
+                dirs += 1
+            }
+            paths.insert(entry.path.basename())
+        }
         XCTAssertEqual(dirs, 1)
         XCTAssertEqual(paths, ["a", "b", "c"])
+    #endif
     }
 
     func testRelativeTo() {

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

@@ -6,8 +6,10 @@ extension PathTests {
         ("testCodable", testCodable),
         ("testConcatenation", testConcatenation),
         ("testEnumeration", testEnumeration),
+        ("testEnumerationSkippingHiddenFiles", testEnumerationSkippingHiddenFiles),
         ("testExists", testExists),
         ("testIsDirectory", testIsDirectory),
+        ("testJoin", testJoin),
         ("testMkpathIfExists", testMkpathIfExists),
         ("testMktemp", testMktemp),
         ("testRelativePathCodable", testRelativePathCodable),
@@ -15,7 +17,7 @@ extension PathTests {
     ]
 }
 
-#if os(Linux)
+#if !os(macOS)
 public func __allTests() -> [XCTestCaseEntry] {
     return [
         testCase(PathTests.__allTests),