More fixes and tests for funny names

Miguel Perez · Miguel Perez · commit ee259bcb4aa4 · 2021-06-30T22:41:35.000-04:00
The funny name is just a folder that is space separated
diff --git a/Fixtures/Templates/AddTemplate/GoodTemplate/.gitignore b/Fixtures/Templates/AddTemplate/GoodTemplate/.gitignore
diff --git a/Fixtures/Templates/AddTemplateErrors/MissingManifest/.gitignore b/Fixtures/Templates/AddTemplateErrors/MissingManifest/.gitignore
diff --git a/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/ExeTemplate/.gitignore b/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/ExeTemplate/.gitignore
diff --git a/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/LibTemplate/Package.swift b/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/LibTemplate/Package.swift
@@ -0,0 +1,26 @@
+// swift-tools-version:5.5
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "___NAME___",
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "___NAME___",
+            targets: ["___NAME___"]),
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        // .package(url: /* package url */, from: "1.0.0"),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(
+            name: "___NAME___",
+            dependencies: [],
+            path: "Sources"),
+    ]
+)
diff --git a/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/LibTemplate/README.md b/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/LibTemplate/README.md
@@ -0,0 +1,3 @@
+# LibTemplate
+
+A description of this package.
diff --git a/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/LibTemplate/Sources/___NAME___.swift b/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/LibTemplate/Sources/___NAME___.swift
@@ -0,0 +1,6 @@
+public struct ___NAME_AS_C99___ {
+    public private(set) var text = "Hello, World!"
+
+    public init() {
+    }
+}
diff --git a/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/TestTemplate/Sources/___NAME___.swift b/Fixtures/Templates/MakePackageWithTemplate/templates/new-package/TestTemplate/Sources/___NAME___.swift
@@ -1,4 +1,4 @@
-public struct ___NAME___ {
+public struct ___NAME_AS_C99___ {
     public private(set) var text = "Hello, World!"
 
     public init() {
diff --git a/Sources/Commands/SwiftPackageTool.swift b/Sources/Commands/SwiftPackageTool.swift
@@ -226,11 +226,11 @@ extension SwiftPackageTool {
         
         func run(_ swiftTool: SwiftTool) throws {
             guard let cwd = localFileSystem.currentWorkingDirectory else {
-                throw MakePackageErrors.currentWorkingDirectoryNotFound
+                throw InternalError("\(MakePackageErrors.currentWorkingDirectoryNotFound)")
             }
             
             guard let configPath = try swiftTool.getConfigPath() else {
-                throw MakePackageErrors.configPathNotFound
+                throw InternalError("\(MakePackageErrors.configPathNotFound)")
             }
             
             guard packageType == nil || template == nil else {
@@ -270,11 +270,11 @@ extension SwiftPackageTool {
 
         func run(_ swiftTool: SwiftTool) throws {
             guard let cwd = localFileSystem.currentWorkingDirectory else {
-                throw MakePackageErrors.currentWorkingDirectoryNotFound
+                throw InternalError("\(MakePackageErrors.currentWorkingDirectoryNotFound)")
             }
             
             guard let configPath = try swiftTool.getConfigPath() else {
-                throw MakePackageErrors.configPathNotFound
+                throw InternalError("\(MakePackageErrors.configPathNotFound)")
             }
             
             guard packageType == nil || template == nil else {
@@ -311,7 +311,7 @@ extension SwiftPackageTool {
 
         func run(_ swiftTool: SwiftTool) throws {
             guard let configPath = try swiftTool.getConfigPath() else {
-                throw InternalError("Could not find config path")
+                throw InternalError("\(MakePackageErrors.configPathNotFound)")
             }
 
             let templatePath: AbsolutePath
@@ -324,15 +324,15 @@ extension SwiftPackageTool {
                     throw StringError("\(path) is not a valid directory")
                 }
                 
-                templatePath = configPath.withTemplate(template: [name ?? path.basename])
+                templatePath = configPath.withTemplate(template: name ?? path.basename)
                 try localFileSystem.copy(from: path, to: templatePath)
             } else {
                 let provider = GitRepositoryProvider()
                 
                 if let templateName = name {
-                    templatePath = configPath.withTemplate(template: [templateName])
+                    templatePath = configPath.withTemplate(template: templateName)
                 } else if let templateName = url.split(separator: "/").last?.replacingOccurrences(of: ".git", with: "").flatMap({ String($0) }) {
-                    templatePath = configPath.withTemplate(template: [String(templateName)])
+                    templatePath = configPath.withTemplate(template: String(templateName))
                 } else {
                     throw InternalError("Could not determine template name")
                 }
@@ -359,15 +359,15 @@ extension SwiftPackageTool {
         
         func run(_ swiftTool: SwiftTool) throws {
             guard let configPath = try swiftTool.getConfigPath() else {
-                throw InternalError("Could not find config path")
+                throw InternalError("\(MakePackageErrors.configPathNotFound)")
             }
             
-            guard localFileSystem.exists(configPath.withTemplate(template: [templateName])) else {
-                throw StringError("Could not find template: \(templateName)")
+            guard localFileSystem.exists(configPath.withTemplate(template: templateName)) else {
+                throw MakePackageErrors.templateNotFound(configPath.withTemplate(template: templateName))
             }
             
             let provider = GitRepositoryProvider()
-            let templatePath = configPath.withTemplate(template: [templateName])
+            let templatePath = configPath.withTemplate(template: templateName)
             
             guard provider.isValidDirectory(templatePath.pathString) else {
                 throw StringError("Template: \(templateName) is not a git repo, and therefore could not be updated")
diff --git a/Sources/Workspace/InitPackage.swift b/Sources/Workspace/InitPackage.swift
@@ -136,14 +136,14 @@ public final class InitPackage {
         var templateName: String?
         
         if let template = packageTemplateName {
-            guard fileSystem.exists(configPath.withTemplate(template: [template])) else {
-                throw InternalError("Could not find template folder: \(configPath.withTemplate(template: [template]))")
+            guard fileSystem.exists(configPath.withTemplate(template: template)) else {
+                throw InternalError("Could not find template folder: \(configPath.withTemplate(template: template))")
             }
             
             templateName = template
         } else {
             // Checking if a default template is present
-            if fileSystem.exists(configPath.withTemplate(template: ["default"])) {
+            if fileSystem.exists(configPath.withTemplate(template: "default")) {
                 templateName = "default"
                 // There is a guard preventing '--type' to be used in conjunction with '--template'
                 // In the event that the defualt template is present and '--type' was used we'll infrom
@@ -155,10 +155,10 @@ public final class InitPackage {
         }
         
         if let template = templateName {
-            try fileSystem.getDirectoryContents(configPath.withTemplate(template: [template])).forEach {
+            try fileSystem.getDirectoryContents(configPath.withTemplate(template: template)).forEach {
                 progressReporter?("Copying \($0)")
                 try copyTemplate(fileSystem: fileSystem,
-                                 sourcePath: configPath.withTemplate(template: [template, $0]),
+                                 sourcePath: configPath.withTemplate(template: template).appending(component: $0),
                                  destinationPath: destinationPath,
                                  name: packageName)
             }
@@ -592,10 +592,8 @@ public final class InitPackage {
 }
 
 extension AbsolutePath {
-    public func withTemplate(template: [String]) -> AbsolutePath {
-        var components = ["templates", "new-package"]
-        components += template
-        return appending(components: components)
+    public func withTemplate(template: String) -> AbsolutePath {
+        return appending(components: "templates", "new-package", template)
     }
 }
 
diff --git a/Tests/WorkspaceTests/TemplateTests.swift b/Tests/WorkspaceTests/TemplateTests.swift
@@ -144,9 +144,60 @@ class TemplateTests: XCTestCase {
         }
     }
     
+    func testCreateTemplateFunnyName() throws {
+        try XCTSkipIf(InitPackage.createPackageMode == .legacy)
+        fixture(name: "Templates/MakePackageWithTemplate") { prefix in
+            try testWithTemporaryDirectory { tmpPath in
+                let fs = localFileSystem
+                let path = tmpPath.appending(component: "Foo Bar")
+                
+                let _ = try SwiftPMProduct.SwiftPackage.executeProcess(["create", "Foo Bar", "--template", "TestTemplate", "--config-path", prefix.pathString], packagePath: tmpPath)
+                
+                XCTAssert(fs.exists(path.appending(component: "Package.swift")))
+                XCTAssert(fs.exists(path.appending(components: "Sources", "Foo Bar.swift")))
+                
+                XCTAssertBuilds(path)
+            }
+        }
+    }
+    
+    func testInitTemplateFunnyName() throws {
+        try XCTSkipIf(InitPackage.createPackageMode == .legacy)
+        fixture(name: "Templates/MakePackageWithTemplate") { prefix in
+            try testWithTemporaryDirectory { tmpPath in
+                let fs = localFileSystem
+                let path = tmpPath.appending(component: "Foo Bar")
+                try fs.createDirectory(path)
+                
+                let _ = try SwiftPMProduct.SwiftPackage.executeProcess(["init", "--template", "LibTemplate","--config-path", prefix.pathString], packagePath: path)
+                
+                XCTAssert(fs.exists(path.appending(component: "Package.swift")))
+                XCTAssert(fs.exists(path.appending(components: "Sources", "Foo Bar.swift")))
+            
+                if let manifest = try fs.readFileContents(path.appending(component: "Package.swift")).validDescription {
+                    XCTAssert(manifest == transformedManifest(with: "Foo Bar"))
+                }
+                
+                if let swiftFile = try fs.readFileContents(path.appending(components: "Sources", "Foo Bar.swift")).validDescription {
+                    XCTAssert(swiftFile == transformedSwiftFile(with: "Foo Bar"))
+                }
+                
+                XCTAssertBuilds(path)
+            }
+        }
+    }
+    
     private func transformedManifest(with name: String) -> String {
+        // Currently the manifest will drop the patch version if it's zero
+        // the description of Version always returns the patch version even if zero
+        // this is just to drop the patch version
+        var toolsVersion = "\(ToolsVersion.currentToolsVersion.major).\(ToolsVersion.currentToolsVersion.minor)"
+        if ToolsVersion.currentToolsVersion.patch != 0 {
+            toolsVersion += ".\(ToolsVersion.currentToolsVersion.patch)"
+        }
+        
         return """
-// swift-tools-version:5.5
+// swift-tools-version:\(toolsVersion)
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -185,7 +236,7 @@ A description of this package.
     
     private func transformedSwiftFile(with name: String) -> String {
         return """
-public struct \(name) {
+public struct \(name.spm_mangledToC99ExtendedIdentifier()) {
     public private(set) var text = "Hello, World!"
 
     public init() {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# LibTemplate`
	`2`	`+`
	`3`	`+A description of this package.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-public struct ___NAME___ {`
	`1`	`+public struct ___NAME_AS_C99___ {`
`2`	`2`	`public private(set) var text = "Hello, World!"`
`3`	`3`
`4`	`4`	`public init() {`