Merge pull request #542 from abertelrud/remove-implicit-path-creation-from-string-literals

Remove `ExpressibleByStringLiteral` conformance for AbsolutePath and RelativePath

Author: abertelrud

Sources/Basic/Path.swift

@@ -206,23 +206,6 @@ public struct AbsolutePath {
     }
 }
 
-/// Adoption of the ExpressibleByStringLiteral protocol allows literal strings
-/// to be implicitly converted to AbsolutePaths.
-extension AbsolutePath : ExpressibleByStringLiteral {
-    public typealias UnicodeScalarLiteralType = StringLiteralType
-    public typealias ExtendedGraphemeClusterLiteralType = StringLiteralType
-    public init(stringLiteral value: String) {
-        self.init(value)
-    }
-    public init(extendedGraphemeClusterLiteral value: String) {
-        self.init(stringLiteral: value)
-    }
-    public init(unicodeScalarLiteral value: String) {
-        self.init(stringLiteral: value)
-    }
-}
-
-
 /// Represents a relative file system path.  A relative path never starts with
 /// a `/` character, and holds a normalized string representation.  As with
 /// AbsolutePath, the normalization is strictly syntactic, and does not access
@@ -299,22 +282,6 @@ public struct RelativePath {
     }
 }
 
-/// Adoption of the ExpressibleByStringLiteral protocol allows literal strings
-/// to be implicitly converted to RelativePaths.
-extension RelativePath : ExpressibleByStringLiteral {
-    public typealias UnicodeScalarLiteralType = StringLiteralType
-    public typealias ExtendedGraphemeClusterLiteralType = StringLiteralType
-    public init(stringLiteral value: String) {
-        self.init(value)
-    }
-    public init(extendedGraphemeClusterLiteral value: String) {
-        self.init(stringLiteral: value)
-    }
-    public init(unicodeScalarLiteral value: String) {
-        self.init(stringLiteral: value)
-    }
-}
-
 // Make absolute paths Hashable.
 extension AbsolutePath : Hashable {
     public var hashValue: Int {

Sources/Build/misc.swift

@@ -145,7 +145,7 @@ protocol ClangModuleCachable {
 
 extension ClangModuleCachable {
     func moduleCacheDir(prefix: AbsolutePath) -> AbsolutePath {
-        return prefix.appending("ModuleCache")
+        return prefix.appending(component: "ModuleCache")
     }
 }
 

Sources/Commands/Options.swift

@@ -20,10 +20,10 @@ public class Options {
 
     public class Path {
         public lazy var root = getroot()
-        public var packages: AbsolutePath { return root.appending("Packages") }
+        public var packages: AbsolutePath { return root.appending(component: "Packages") }
 
         public var build: AbsolutePath {
-            get { return _build != nil ? AbsolutePath(_build!) : getroot().appending(".build") }
+            get { return _build != nil ? AbsolutePath(_build!) : getroot().appending(component: ".build") }
             set { _build = newValue.asString }
         }
         private var _build = getEnvBuildPath()?.asString
@@ -48,7 +48,7 @@ private func getroot() -> AbsolutePath {
     while !isFile(root.appending(component: Manifest.filename)) {
         root = root.parentDirectory
 
-        guard root != "/" else {
+        guard !root.isRoot else {
             // abort because lazy properties cannot throw and we
             // want erroring on no manifest found to be “lazy” so
             // any path that requires this property errors, but we

Sources/Commands/SwiftPackageTool.swift

@@ -182,7 +182,7 @@ public struct SwiftPackageTool: SwiftTool {
                         let item = opts.path.packages.appending(RelativePath(name))
 
                         // Only look at repositories.
-                        guard exists(item.appending(".git")) else { continue }
+                        guard exists(item.appending(component: ".git")) else { continue }
 
                         // If there is a staged or unstaged diff, don't remove the
                         // tree. This won't detect new untracked files, but it is

Sources/Commands/SwiftTestTool.swift

@@ -282,13 +282,13 @@ public struct SwiftTestTool: SwiftTool {
         let xctestHelperBin = "swiftpm-xctest-helper"
         let binDirectory = AbsolutePath(CommandLine.arguments.first!, relativeTo: currentWorkingDirectory).parentDirectory
         // XCTestHelper tool is installed in libexec.
-        let maybePath = binDirectory.appending("../libexec/swift/pm/").appending(RelativePath(xctestHelperBin))
+        let maybePath = binDirectory.parentDirectory.appending(components: "libexec", "swift", "pm", xctestHelperBin)
         if isFile(maybePath) {
             return maybePath
         }
         // This will be true during swiftpm developement.
         // FIXME: Factor all of the development-time resource location stuff into a common place.
-        let path = binDirectory.appending(RelativePath(xctestHelperBin))
+        let path = binDirectory.appending(component: xctestHelperBin)
         if isFile(path) {
             return path 
         }

Sources/Commands/init.swift

@@ -93,7 +93,7 @@ final class InitPackage {
     }
 
     private func writeGitIgnore() throws {
-        let gitignore = rootd.appending(".gitignore")
+        let gitignore = rootd.appending(component: ".gitignore")
         guard exists(gitignore) == false else {
             return
         } 
@@ -110,7 +110,7 @@ final class InitPackage {
         if mode == .systemModule {
             return
         }
-        let sources = rootd.appending("Sources")
+        let sources = rootd.appending(component: "Sources")
         guard exists(sources) == false else {
             return
         }
@@ -138,7 +138,7 @@ final class InitPackage {
         if mode != .systemModule {
             return
         }
-        let modulemap = rootd.appending("module.modulemap")
+        let modulemap = rootd.appending(component: "module.modulemap")
         guard exists(modulemap) == false else {
             return
         }
@@ -156,7 +156,7 @@ final class InitPackage {
         if mode == .systemModule {
             return
         }
-        let tests = rootd.appending("Tests")
+        let tests = rootd.appending(component: "Tests")
         guard exists(tests) == false else {
             return
         }
@@ -171,7 +171,7 @@ final class InitPackage {
     }
 
     private func writeLinuxMain(testsPath: AbsolutePath) throws {
-        try writePackageFile(testsPath.appending("LinuxMain.swift")) { stream in
+        try writePackageFile(testsPath.appending(component: "LinuxMain.swift")) { stream in
             stream <<< "import XCTest\n"
             stream <<< "@testable import \(moduleName)TestSuite\n\n"
             stream <<< "XCTMain([\n"

Sources/Get/PackagesDirectory.swift

@@ -43,7 +43,7 @@ public final class PackagesDirectory {
 
     /// The path to the packages.
     var packagesPath: AbsolutePath {
-        return rootPath.appending("Packages")
+        return rootPath.appending(component: "Packages")
     }
 
     /// The set of all repositories available within the `Packages` directory, by origin.

Sources/PackageLoading/ManifestLoader.swift

@@ -110,7 +110,7 @@ public final class ManifestLoader {
         cmd += [manifestPath.asString]
 
         //Create and open a temporary file to write toml to
-        let filePath = manifestPath.parentDirectory.appending(".Package.toml")
+        let filePath = manifestPath.parentDirectory.appending(component: ".Package.toml")
         let fp = try fopen(filePath, mode: .write)
         defer { fp.closeFile() }
 

Sources/PackageLoading/PackageBuilder.swift

@@ -191,7 +191,7 @@ public struct PackageBuilder {
     }
 
     private var packagesDirectory: AbsolutePath {
-        return packagePath.appending("Packages")
+        return packagePath.appending(component: "Packages")
     }
 
     private var excludedPaths: [AbsolutePath] {
@@ -232,7 +232,7 @@ public struct PackageBuilder {
 
     /// Collects the modules which are defined by a package.
     private func constructModules() throws -> [Module] {
-        let moduleMapPath = packagePath.appending("module.modulemap")
+        let moduleMapPath = packagePath.appending(component: "module.modulemap")
         if fileSystem.isFile(moduleMapPath) {
             let sources = Sources(paths: [moduleMapPath], root: packagePath)
             return [try CModule(name: manifest.name, sources: sources, path: packagePath, pkgConfig: pkgConfigPath, providers: manifest.package.providers)]
@@ -408,7 +408,7 @@ public struct PackageBuilder {
     }
 
     private func constructTestModules(modules: [Module]) throws -> [Module] {
-        let testsPath = packagePath.appending("Tests")
+        let testsPath = packagePath.appending(component: "Tests")
 
         // Don't try to walk Tests if it is in excludes or doesn't exists.
         guard fileSystem.isDirectory(testsPath) && !excludedPaths.contains(testsPath) else {

Sources/PackageModel/Module.swift

@@ -131,7 +131,7 @@ public class ClangModule: CModule {
         }
         let type: ModuleType = isLibrary ? .library : .executable
 
-        try super.init(name: name, type: type, sources: sources, path: sources.root.appending("include"), isTest: isTest)
+        try super.init(name: name, type: type, sources: sources, path: sources.root.appending(component: "include"), isTest: isTest)
     }
 }
 

Sources/SourceControl/CheckoutManager.swift

@@ -182,7 +182,7 @@ public class CheckoutManager {
 
     /// The path at which we persist the manager state.
     private var statePath: AbsolutePath {
-        return path.appending("manager-state.json")
+        return path.appending(component: "manager-state.json")
     }
 
     /// Restore the manager state from disk.

Sources/Utility/Platform.swift

@@ -27,7 +27,7 @@ public enum Platform {
         case "darwin":
             return .darwin
         case "linux":
-            if isFile("/etc/debian_version") {
+            if isFile(AbsolutePath("/etc/debian_version")) {
                 return .linux(.debian)
             }
         default:

Sources/Xcodeproj/generate().swift

@@ -40,14 +40,14 @@ public func generate(dstdir: AbsolutePath, projectName: String, graph: PackageGr
 
     let xcodeprojName = "\(projectName).xcodeproj"
     let xcodeprojPath = dstdir.appending(RelativePath(xcodeprojName))
-    let schemesDirectory = xcodeprojPath.appending("xcshareddata/xcschemes")
+    let schemesDirectory = xcodeprojPath.appending(components: "xcshareddata", "xcschemes")
     try makeDirectories(xcodeprojPath)
     try makeDirectories(schemesDirectory)
     let schemeName = "\(projectName).xcscheme"
     let directoryReferences = try findDirectoryReferences(path: srcroot)
 
 ////// the pbxproj file describes the project and its targets
-    try open(xcodeprojPath.appending("project.pbxproj")) { stream in
+    try open(xcodeprojPath.appending(component: "project.pbxproj")) { stream in
         try pbxproj(srcroot: srcroot, projectRoot: dstdir, xcodeprojPath: xcodeprojPath, graph: graph, directoryReferences: directoryReferences, options: options, printer: stream)
     }
 
@@ -59,7 +59,7 @@ public func generate(dstdir: AbsolutePath, projectName: String, graph: PackageGr
 
 ////// we generate this file to ensure our main scheme is listed
    /// before any inferred schemes Xcode may autocreate
-    try open(schemesDirectory.appending("xcschememanagement.plist")) { print in
+    try open(schemesDirectory.appending(component: "xcschememanagement.plist")) { print in
         print("<?xml version=\"1.0\" encoding=\"UTF-8\"?>")
         print("<plist version=\"1.0\">")
         print("<dict>")

Sources/Xcodeproj/pbxproj().swift

@@ -53,7 +53,7 @@ public func pbxproj(srcroot: AbsolutePath, projectRoot: AbsolutePath, xcodeprojP
     print("        };")
 
 ////// Package.swift file
-    let packageSwift = fileRef(inProjectRoot: "Package.swift", srcroot: srcroot)
+    let packageSwift = fileRef(inProjectRoot: RelativePath("Package.swift"), srcroot: srcroot)
     print("        \(packageSwift.refId) = {")
     print("            isa = PBXFileReference;")
     print("            lastKnownFileType = sourcecode.swift;")