Add keyword escaping in resources name (#131)

RedMadRobot · Nov 22, 2021 · 82c3379 · 82c3379
1 parent e48f5ba
commit 82c3379
Show file tree

Hide file tree

Showing 9 changed files with 124 additions and 30 deletions.
diff --git a/Package.resolved b/Package.resolved
@@ -46,6 +46,15 @@
           "version": "1.0.1"
         }
       },
+      {
+        "package": "swift-custom-dump",
+        "repositoryURL": "https://github.com/pointfreeco/swift-custom-dump",
+        "state": {
+          "branch": null,
+          "revision": "21f8fdbb3226e5e28a1a2fffac3e0f3deec34bf0",
+          "version": "0.2.1"
+        }
+      },
       {
         "package": "swift-log",
         "repositoryURL": "https://github.com/apple/swift-log.git",
@@ -64,6 +73,15 @@
           "version": "8.5.0"
         }
       },
+      {
+        "package": "xctest-dynamic-overlay",
+        "repositoryURL": "https://github.com/pointfreeco/xctest-dynamic-overlay",
+        "state": {
+          "branch": null,
+          "revision": "50a70a9d3583fe228ce672e8923010c8df2deddd",
+          "version": "0.2.1"
+        }
+      },
       {
         "package": "Yams",
         "repositoryURL": "https://github.com/jpsim/Yams.git",

diff --git a/Package.swift b/Package.swift
@@ -17,6 +17,7 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-log.git", from: "1.4.0"),
         .package(url: "https://github.com/stencilproject/Stencil.git", from: "0.14.2"),
         .package(url: "https://github.com/tuist/XcodeProj.git", from: "8.5.0"),
+        .package(url: "https://github.com/pointfreeco/swift-custom-dump", from: "0.2.1"),
     ],
     targets: [
 
@@ -65,7 +66,7 @@ let package = Package(
         ),
         .testTarget(
             name: "XcodeExportTests",
-            dependencies: ["XcodeExport"]
+            dependencies: ["XcodeExport", .product(name: "CustomDump", package: "swift-custom-dump")]
         ),
         .testTarget(
             name: "AndroidExportTests",

diff --git a/Sources/XcodeExport/XcodeColorExporter.swift b/Sources/XcodeExport/XcodeColorExporter.swift
@@ -1,7 +1,7 @@
 import Foundation
 import FigmaExportCore
 
-final public class XcodeColorExporter {
+final public class XcodeColorExporter: XcodeExporterBase {
 
     private let output: XcodeColorsOutput
 
@@ -122,7 +122,7 @@ final public class XcodeColorExporter {
         let strings = colorPairs.map { colorPair -> String in
             let bundle = output.assetsInMainBundle ? "" : ", bundle: BundleProvider.bundle"
             let named = groupUsingNamespace ? "\"\(colorPair.light.originalName)\"" : "#function"
-            return "    static var \(colorPair.light.name): Color { Color(\(named)\(bundle)) }"
+            return "    static var \(normalizeName(colorPair.light.name)): Color { Color(\(named)\(bundle)) }"
         }
 
         return """
@@ -151,12 +151,12 @@ final public class XcodeColorExporter {
                 let bundle = output.assetsInMainBundle ? "" : ", in: BundleProvider.bundle, compatibleWith: nil"
                 let prefix = objcAttribute ? "@objc " : ""
                 let named = groupUsingNamespace ? "\"\(colorPair.light.originalName)\"" : "#function"
-                content = "    \(prefix)static var \(colorPair.light.name): UIColor { UIColor(named: \(named)\(bundle))! }"
+                content = "    \(prefix)static var \(normalizeName(colorPair.light.name)): UIColor { UIColor(named: \(named)\(bundle))! }"
             } else {
                 let lightComponents = colorPair.light.toRgbComponents()
                 if let darkComponents = colorPair.dark?.toRgbComponents() {
                     content = """
-                        \(objcAttribute ? "@objc " : "")static var \(colorPair.light.name): UIColor {
+                        \(objcAttribute ? "@objc " : "")static var \(normalizeName(colorPair.light.name)): UIColor {
                             if #available(iOS 13.0, *) {
                                 return UIColor { traitCollection -> UIColor in
                                     if traitCollection.userInterfaceStyle == .dark {
@@ -172,7 +172,7 @@ final public class XcodeColorExporter {
                     """
                 } else {
                     content = """
-                        \(objcAttribute ? "@objc " : "")static var \(colorPair.light.name): UIColor {
+                        \(objcAttribute ? "@objc " : "")static var \(normalizeName(colorPair.light.name)): UIColor {
                             return UIColor(red: \(lightComponents.red), green: \(lightComponents.green), blue: \(lightComponents.blue), alpha: \(lightComponents.alpha))
                         }
                     """

diff --git a/Sources/XcodeExport/XcodeExporterBase.swift b/Sources/XcodeExport/XcodeExporterBase.swift
@@ -0,0 +1,21 @@
+public class XcodeExporterBase {
+
+    private let declarationKeywords = ["associatedtype", "class", "deinit", "enum", "extension", "fileprivate", "func", "import", "init", "inout", "internal", "let", "open", "operator", "private", "precedencegroup", "protocol", "public", "rethrows", "static", "struct", "subscript", "typealias", "var"]
+
+    private let statementKeywords = ["break", "case", "catch", "continue", "default", "defer", "do", "else", "fallthrough", "for", "guard", "if", "in", "repeat", "return", "throw", "switch", "where", "while"]
+
+    private let expressionsKeywords = ["Any", "as", "catch", "false", "is", "nil", "rethrows", "self", "Self", "super", "throw", "throws", "true", "try"]
+
+    private let otherKeywords = ["associativity", "convenience", "didSet", "dynamic", "final", "get", "indirect", "infix", "lazy", "left", "mutating", "none", "nonmutating", "optional", "override", "postfix", "precedence", "prefix", "Protocol", "required", "right", "set", "some", "Type", "unowned", "weak", "willSet"]
+
+    func normalizeName(_ name: String) -> String {
+        let keyword = (declarationKeywords + statementKeywords + expressionsKeywords + otherKeywords).first { keyword in
+            name == keyword
+        }
+        if let keyword = keyword {
+            return "`\(keyword)`"
+        } else {
+            return name
+        }
+    }
+}
diff --git a/Sources/XcodeExport/XcodeIconsExporter.swift b/Sources/XcodeExport/XcodeIconsExporter.swift
@@ -31,7 +31,7 @@ final public class XcodeIconsExporter: XcodeImagesExporterBase {
         }
 
         // Generate extensions
-        let imageNames = icons.map { $0.light.name }
+        let imageNames = icons.map { normalizeName($0.light.name) }
         let extensionFiles = try generateExtensions(names: imageNames, append: append)
 
         return [contentsFile] + imageAssetsFiles + extensionFiles

diff --git a/Sources/XcodeExport/XcodeImagesExporter.swift b/Sources/XcodeExport/XcodeImagesExporter.swift
@@ -15,7 +15,7 @@ final public class XcodeImagesExporter: XcodeImagesExporterBase {
         }
 
         // Generate extensions
-        let imageNames = assets.map { $0.light.name }
+        let imageNames = assets.map { normalizeName($0.light.name) }
         let extensionFiles = try generateExtensions(names: imageNames, append: append)
 
         return [contentsFile] + imageAssetsFiles + extensionFiles

diff --git a/Sources/XcodeExport/XcodeImagesExporterBase.swift b/Sources/XcodeExport/XcodeImagesExporterBase.swift
@@ -1,7 +1,7 @@
 import FigmaExportCore
 import Foundation
 
-public class XcodeImagesExporterBase {
+public class XcodeImagesExporterBase: XcodeExporterBase {
 
     let output: XcodeImagesOutput
 

diff --git a/Tests/XcodeExportTests/XcodeColorExporterTests.swift b/Tests/XcodeExportTests/XcodeColorExporterTests.swift
@@ -1,6 +1,7 @@
 import XCTest
 import FigmaExportCore
 @testable import XcodeExport
+import CustomDump
 
 final class XcodeColorExporterTests: XCTestCase {
 
@@ -28,6 +29,8 @@ final class XcodeColorExporterTests: XCTestCase {
         light: color3,
         dark: nil)
 
+    private let colorWithKeyword = AssetPair<Color>(light: Color(name: "class", platform: .ios, red: 1, green: 1, blue: 1, alpha: 1), dark: nil)
+
     // MARK: - Setup
 
     override func setUp() {
@@ -74,7 +77,7 @@ final class XcodeColorExporterTests: XCTestCase {
         }
 
         """
-        XCTAssertEqual(generatedCode, referenceCode)
+        XCTAssertNoDifference(generatedCode, referenceCode)
     }
 
     func testExport_with_assets() {
@@ -103,7 +106,7 @@ final class XcodeColorExporterTests: XCTestCase {
         }
 
         """
-        XCTAssertEqual(generatedCode, referenceCode)
+        XCTAssertNoDifference(generatedCode, referenceCode)
     }
 
     func testExport_with_objc() {
@@ -137,7 +140,7 @@ final class XcodeColorExporterTests: XCTestCase {
         }
 
         """
-        XCTAssertEqual(generatedCode, referenceCode)
+        XCTAssertNoDifference(generatedCode, referenceCode)
     }
 
     func testExport_with_assets_in_separate_bundle() {
@@ -170,7 +173,7 @@ final class XcodeColorExporterTests: XCTestCase {
         }
 
         """
-        XCTAssertEqual(generatedCode, referenceCode)
+        XCTAssertNoDifference(generatedCode, referenceCode)
     }
 
     func testExport_with_assets_in_swift_package() {
@@ -203,7 +206,7 @@ final class XcodeColorExporterTests: XCTestCase {
         }
 
         """
-        XCTAssertEqual(generatedCode, referenceCode)
+        XCTAssertNoDifference(generatedCode, referenceCode)
     }
 
     func testExport_swiftui() {
@@ -232,7 +235,7 @@ final class XcodeColorExporterTests: XCTestCase {
         }
 
         """
-        XCTAssertEqual(generatedCode, referenceCode)
+        XCTAssertNoDifference(generatedCode, referenceCode)
     }
 
     func testExport_withProvidesNamespace() {
@@ -265,6 +268,32 @@ final class XcodeColorExporterTests: XCTestCase {
         }
 
         """
-        XCTAssertEqual(generatedCode, referenceCode)
+        XCTAssertNoDifference(generatedCode, referenceCode)
+    }
+
+    func testExportWhenNameIsSwiftKeyword() {
+        let output = XcodeColorsOutput(assetsColorsURL: nil, assetsInMainBundle: true, colorSwiftURL: colorsFile)
+        let exporter = XcodeColorExporter(output: output)
+
+        let result = exporter.export(colorPairs: [colorWithKeyword])
+        XCTAssertEqual(result.count, 1)
+
+        let content = result[0].data
+        XCTAssertNotNil(content)
+
+        let generatedCode = String(data: content!, encoding: .utf8)
+        let referenceCode = """
+        \(header)
+
+        import UIKit
+
+        public extension UIColor {
+            static var `class`: UIColor {
+                return UIColor(red: 1.000, green: 1.000, blue: 1.000, alpha: 1.000)
+            }
+        }
+
+        """
+        XCTAssertNoDifference(generatedCode, referenceCode)
     }
 }