feat: escape files starting with a number

alephao · Sep 19, 2024 · 1ec39b3 · 1ec39b3
1 parent fc6588a
commit 1ec39b3
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 16 deletions.
diff --git a/Sources/SacogeCore/AssetDirectory.swift b/Sources/SacogeCore/AssetDirectory.swift
@@ -44,9 +44,9 @@ struct AssetDirectory {
 
     for subpath in subpaths {
       #if swift(>=6)
-      let subpathURL = url.appending(path: subpath)
+        let subpathURL = url.appending(path: subpath)
       #else
-      let subpathURL = url.appendingPathComponent(subpath)
+        let subpathURL = url.appendingPathComponent(subpath)
       #endif
       var isDir: ObjCBool = false
       _ = FileManager.default.fileExists(
@@ -96,7 +96,9 @@ extension AssetDirectory {
   }
 
   private var declarationName: String {
-    url.lastPathComponent.replacingSymbolsWithUnderscores()
+    url.lastPathComponent
+      .replacingSymbolsWithUnderscores()
+      .escapingFirstDigitIfNumber()
   }
 
   private func declaration(for child: AssetFileOrDirectory) -> String {

diff --git a/Sources/SacogeCore/AssetFile.swift b/Sources/SacogeCore/AssetFile.swift
@@ -35,9 +35,9 @@ struct AssetFile {
     }
 
     #if swift(>=6)
-    let fileURL = URL(filePath: url.path, directoryHint: .notDirectory)
+      let fileURL = URL(filePath: url.path, directoryHint: .notDirectory)
     #else
-    let fileURL = URL(fileURLWithPath: url.path)
+      let fileURL = URL(fileURLWithPath: url.path)
     #endif
 
     let data = try Data(contentsOf: fileURL)
@@ -48,17 +48,17 @@ struct AssetFile {
       + externalURL.pathExtension
 
     #if swift(>=6)
-    let externalPathWithChecksum =
-      externalURL
-      .deletingLastPathComponent()
-      .appending(path: externalFileName)
-      .path
+      let externalPathWithChecksum =
+        externalURL
+        .deletingLastPathComponent()
+        .appending(path: externalFileName)
+        .path
     #else
-    let externalPathWithChecksum =
-      externalURL
-      .deletingLastPathComponent()
-      .appendingPathComponent(externalFileName)
-      .path
+      let externalPathWithChecksum =
+        externalURL
+        .deletingLastPathComponent()
+        .appendingPathComponent(externalFileName)
+        .path
     #endif
 
     self.url = url
@@ -78,7 +78,9 @@ extension AssetFile {
   }
 
   var staticReferenceVarName: String {
-    url.lastPathComponent.replacingSymbolsWithUnderscores()
+    url.lastPathComponent
+      .replacingSymbolsWithUnderscores()
+      .escapingFirstDigitIfNumber()
   }
 
   func dictEntry(parentPath: String) -> String {

diff --git a/Sources/SacogeCore/String+Formatting.swift b/Sources/SacogeCore/String+Formatting.swift
@@ -6,6 +6,12 @@ extension String {
       .replacingOccurrences(of: ".", with: "_")
   }
 
+  func escapingFirstDigitIfNumber() -> String {
+    (first?.isNumber ?? false)
+      ? "_\(self)"
+      : self
+  }
+
   func indent(_ n: Int) -> String {
     return String(repeating: " ", count: n) + self
   }

diff --git a/Tests/SacogeCoreTests/GeneratorMappingTests.swift b/Tests/SacogeCoreTests/GeneratorMappingTests.swift
@@ -9,6 +9,7 @@ final class GeneratorMappingTests: GeneratorTestCase {
       """
       extension MyAsset {
         public static let externalToInternalMapping: [String: String] = [
+          MyAsset._1_number._2_number_txt.externalPath: MyAsset._1_number._2_number_txt.internalPath,
           MyAsset.deep.deep2.deep3.level3_nochecksum_txt.externalPath: MyAsset.deep.deep2.deep3.level3_nochecksum_txt.internalPath,
           MyAsset.deep.deep2.deep3.level3_txt.externalPath: MyAsset.deep.deep2.deep3.level3_txt.internalPath,
           MyAsset.deep.deep2.level2_nochecksum_txt.externalPath: MyAsset.deep.deep2.level2_nochecksum_txt.internalPath,

diff --git a/Tests/SacogeCoreTests/GeneratorStaticReferencesTests.swift b/Tests/SacogeCoreTests/GeneratorStaticReferencesTests.swift
@@ -8,6 +8,12 @@ final class GeneratorStaticReferencesTests: GeneratorTestCase {
     assertInlineSnapshot(of: generated, as: .lines) {
       """
       extension MyAsset {
+        public enum _1_number {
+          public static let _2_number_txt = Asset(
+            internalPath: "1_number/2_number.txt",
+            externalPath: "/static/immutable/1_number/2_number_e3b0c442.txt"
+          )
+        }
         public enum deep {
           public enum deep2 {
             public enum deep3 {

diff --git a/Tests/SacogeCoreTests/GeneratorTestCase.swift b/Tests/SacogeCoreTests/GeneratorTestCase.swift
@@ -34,6 +34,7 @@ class GeneratorTestCase: XCTestCase {
     try touch("my_public_files/with-dash.txt")
     try touch("my_public_files/with_underscore.txt")
     try touch("my_public_files/[email protected]")
+    try touch("my_public_files/1_number/2_number.txt")
 
     // Ignore
     try touch("my_public_files/ignore_this.txt")

diff --git a/Tests/SacogeCoreTests/GeneratorTests.swift b/Tests/SacogeCoreTests/GeneratorTests.swift
@@ -20,6 +20,12 @@ final class GeneratorTests: GeneratorTestCase {
       }
 
       extension MyAsset {
+        public enum _1_number {
+          public static let _2_number_txt = Asset(
+            internalPath: "1_number/2_number.txt",
+            externalPath: "/static/immutable/1_number/2_number_e3b0c442.txt"
+          )
+        }
         public enum deep {
           public enum deep2 {
             public enum deep3 {
@@ -76,6 +82,7 @@ final class GeneratorTests: GeneratorTestCase {
 
       extension MyAsset {
         public static let externalToInternalMapping: [String: String] = [
+          MyAsset._1_number._2_number_txt.externalPath: MyAsset._1_number._2_number_txt.internalPath,
           MyAsset.deep.deep2.deep3.level3_nochecksum_txt.externalPath: MyAsset.deep.deep2.deep3.level3_nochecksum_txt.internalPath,
           MyAsset.deep.deep2.deep3.level3_txt.externalPath: MyAsset.deep.deep2.deep3.level3_txt.internalPath,
           MyAsset.deep.deep2.level2_nochecksum_txt.externalPath: MyAsset.deep.deep2.level2_nochecksum_txt.internalPath,