Merge pull request 'v1.2.2' (#5) from v1.2.2 into master

Reviewed-on: #5

Jenkinsfile

@@ -1,6 +1,6 @@
 library "openiumpipeline"
 
-env.DEVELOPER_DIR="/Applications/Xcode_13.3.0.app/Contents/Developer"
+env.DEVELOPER_DIR= "/Applications/Xcode-14.3.0.app/Contents/Developer"
 //env.SIMULATOR_DEVICE_TYPES="iPad--7th-generation-"
 env.IS_PACKAGE_SWIFT=1
 env.TARGETS_MACOS=1

SampleFiles/Colors/Generated/ColorYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Color 1.0
+// Generated by ResgenSwift.Color 1.2
 
 import SwiftUI
 

SampleFiles/Colors/Generated/UIColorYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Color 1.0
+// Generated by ResgenSwift.Color 1.2
 
 import UIKit
 

SampleFiles/Fonts/Generated/FontYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Fonts 1.0
+// Generated by ResgenSwift.Fonts 1.2
 
 import SwiftUI
 

SampleFiles/Fonts/Generated/UIFontYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Fonts 1.0
+// Generated by ResgenSwift.Fonts 1.2
 
 import UIKit
 

SampleFiles/Images/Generated/ImageYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Images 1.0
+// Generated by ResgenSwift.Images 1.2
 // Images from sampleImages
 
 import SwiftUI

SampleFiles/Images/Generated/UIImage+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Images 1.0
+// Generated by ResgenSwift.Images 1.2
 // Images from sampleImages
 
 import UIKit

SampleFiles/Strings/Generated/String+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Strings.Stringium 1.0
+// Generated by ResgenSwift.Strings.Stringium 1.2
 
 import UIKit
 
@@ -6,6 +6,26 @@ fileprivate let kStringsFileName = "sampleStrings"
 
 extension String {
 
+    enum KeyGenAllScript: String {
+        case param_lang = "param_lang"
+        case generic_back = "generic_back"
+        case generic_loading_data = "generic_loading_data"
+        case generic_welcome_firstname_format = "generic_welcome_firstname_format"
+        case test_equal_symbol = "test_equal_symbol"
+        case placeholders_test_one = "placeholders_test_one"
+
+        var keyPath: KeyPath<String, String> {
+            switch self {
+            case .param_lang: return \String.param_lang
+            case .generic_back: return \String.generic_back
+            case .generic_loading_data: return \String.generic_loading_data
+            case .generic_welcome_firstname_format: return \String.generic_welcome_firstname_format
+            case .test_equal_symbol: return \String.test_equal_symbol
+            case .placeholders_test_one: return \String.placeholders_test_one
+            }
+        }
+    }
+
     // MARK: - Webservice
 
     /// Translation in en :

SampleFiles/Strings/Generated/en-us.lproj/sampleStrings.strings

@@ -1,6 +1,6 @@
 /**
  * Apple Strings File
- * Generated by ResgenSwift 1.0
+ * Generated by ResgenSwift 1.2
  * Language: en-us
  */
 

SampleFiles/Strings/Generated/en.lproj/sampleStrings.strings

@@ -1,6 +1,6 @@
 /**
  * Apple Strings File
- * Generated by ResgenSwift 1.0
+ * Generated by ResgenSwift 1.2
  * Language: en
  */
 

SampleFiles/Strings/Generated/fr.lproj/sampleStrings.strings

@@ -1,6 +1,6 @@
 /**
  * Apple Strings File
- * Generated by ResgenSwift 1.0
+ * Generated by ResgenSwift 1.2
  * Language: fr
  */
 

SampleFiles/Tags/Generated/Tags+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Strings.Tags 1.0
+// Generated by ResgenSwift.Strings.Tags 1.2
 
 import UIKit
 

SampleFiles/genAllRessources.sh

@@ -2,33 +2,33 @@
 
 FORCE_FLAG="$1"
 
-# Font
-swift run -c release ResgenSwift fonts $FORCE_FLAG "./Fonts/sampleFontsAll.txt" \
- --extension-output-path "./Fonts/Generated" \
- --extension-name "UIFontYolo" \
- --extension-name-swift-ui "FontYolo" \
- --extension-suffix "GenAllScript" \
- --info-plist-paths "./Fonts/Generated/test.plist ./Fonts/Generated/test2.plist"
-
-echo "\n-------------------------\n"
-
-# Color
-swift run -c release ResgenSwift colors $FORCE_FLAG "./Colors/sampleColors1.txt" \
- --style all \
- --xcassets-path "./Colors/colors.xcassets" \
- --extension-output-path "./Colors/Generated/" \
- --extension-name "UIColorYolo" \
- --extension-name-swift-ui "ColorYolo" \
- --extension-suffix "GenAllScript"
-
-echo "\n-------------------------\n"
-
-# Twine
-swift run -c release ResgenSwift strings twine $FORCE_FLAG "./Twine/sampleStrings.txt" \
- --output-path "./Twine/Generated" \
- --langs "fr en en-us" \
- --default-lang "en" \
- --extension-output-path "./Twine/Generated"
+## Font
+#swift run -c release ResgenSwift fonts $FORCE_FLAG "./Fonts/sampleFontsAll.txt" \
+# --extension-output-path "./Fonts/Generated" \
+# --extension-name "UIFontYolo" \
+# --extension-name-swift-ui "FontYolo" \
+# --extension-suffix "GenAllScript" \
+# --info-plist-paths "./Fonts/Generated/test.plist ./Fonts/Generated/test2.plist"
+#
+#echo "\n-------------------------\n"
+#
+## Color
+#swift run -c release ResgenSwift colors $FORCE_FLAG "./Colors/sampleColors1.txt" \
+# --style all \
+# --xcassets-path "./Colors/colors.xcassets" \
+# --extension-output-path "./Colors/Generated/" \
+# --extension-name "UIColorYolo" \
+# --extension-name-swift-ui "ColorYolo" \
+# --extension-suffix "GenAllScript"
+#
+#echo "\n-------------------------\n"
+#
+## Twine
+#swift run -c release ResgenSwift strings twine $FORCE_FLAG "./Twine/sampleStrings.txt" \
+# --output-path "./Twine/Generated" \
+# --langs "fr en en-us" \
+# --default-lang "en" \
+# --extension-output-path "./Twine/Generated"
 
 echo "\n-------------------------\n"
 
@@ -43,19 +43,19 @@ swift run -c release ResgenSwift strings stringium $FORCE_FLAG "./Strings/sample
 
 echo "\n-------------------------\n"
 
-# Tags
-swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/sampleTags.txt" \
- --lang "ium" \
- --extension-output-path "./Tags/Generated" \
- --extension-name "Tags" \
- --extension-suffix "GenAllScript"
-
-echo "\n-------------------------\n"
-
-# Images
-swift run -c release ResgenSwift images $FORCE_FLAG "./Images/sampleImages.txt" \
- --xcassets-path "./Images/imagium.xcassets" \
- --extension-output-path "./Images/Generated" \
- --extension-name "UIImage" \
- --extension-name-swift-ui "ImageYolo" \
- --extension-suffix "GenAllScript"
+## Tags
+#swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/sampleTags.txt" \
+# --lang "ium" \
+# --extension-output-path "./Tags/Generated" \
+# --extension-name "Tags" \
+# --extension-suffix "GenAllScript"
+#
+#echo "\n-------------------------\n"
+#
+## Images
+#swift run -c release ResgenSwift images $FORCE_FLAG "./Images/sampleImages.txt" \
+# --xcassets-path "./Images/imagium.xcassets" \
+# --extension-output-path "./Images/Generated" \
+# --extension-name "UIImage" \
+# --extension-name-swift-ui "ImageYolo" \
+# --extension-suffix "GenAllScript"

Sources/ResgenSwift/Generate/Generate.swift

@@ -42,7 +42,8 @@ struct Generate: ParsableCommand {
         print()
         
         if let architecture = configuration.architecture {
-            ArchitectureGenerator.writeArchitecture(architecture)
+            ArchitectureGenerator.writeArchitecture(architecture,
+                                                    projectDirectory: options.projectDirectory)
         }
         
         // Execute commands

Sources/ResgenSwift/Generate/Generator/ArchitectureGenerator.swift

@@ -9,7 +9,7 @@ import ToolCore
 import Foundation
 
 struct ArchitectureGenerator {
-    static func writeArchitecture(_ architecture: ConfigurationArchitecture) {
+    static func writeArchitecture(_ architecture: ConfigurationArchitecture, projectDirectory: String) {
         // Create extension content
         let architectureContent = [
             "// Generated by ResgenSwift.\(Generate.toolName) \(ResgenSwiftVersion)",
@@ -18,7 +18,7 @@ struct ArchitectureGenerator {
             .joined(separator: "\n\n")
         
         let filename = "\(architecture.classname).swift"
-        guard let filePath = architecture.path else {
+        guard let filePath = architecture.path?.prependIfRelativePath(projectDirectory) else {
             let error = GenerateError.writeFile(filename, "Path of file is not defined.")
             print(error.description)
             Generate.exit(withError: error)

Sources/ResgenSwift/Strings/Generator/StringsFileGenerator.swift

@@ -12,7 +12,12 @@ class StringsFileGenerator {
     
     // MARK: - Strings Files
     
-    static func writeStringsFiles(sections: [Section], langs: [String], defaultLang: String, tags: [String], outputPath: String, inputFilenameWithoutExt: String) {
+    static func writeStringsFiles(sections: [Section],
+                                  langs: [String],
+                                  defaultLang: String,
+                                  tags: [String],
+                                  outputPath: String,
+                                  inputFilenameWithoutExt: String) {
         var stringsFilesContent = [String: String]()
         for lang in langs {
             stringsFilesContent[lang] = Self.generateStringsFileContent(lang: lang,
@@ -37,7 +42,10 @@ class StringsFileGenerator {
         }
     }
     
-    static func generateStringsFileContent(lang: String, defaultLang: String, tags inputTags: [String], sections: [Section]) -> String {
+    static func generateStringsFileContent(lang: String,
+                                           defaultLang: String,
+                                           tags inputTags: [String],
+                                           sections: [Section]) -> String {
         var stringsFileContent = """
         /**
          * Apple Strings File
@@ -86,14 +94,22 @@ class StringsFileGenerator {
     
     // MARK: - Extension file
     
-    static func writeExtensionFiles(sections: [Section], defaultLang lang: String, tags: [String], staticVar: Bool, inputFilename: String, extensionName: String, extensionFilePath: String) {
+    static func writeExtensionFiles(sections: [Section],
+                                    defaultLang lang: String,
+                                    tags: [String],
+                                    staticVar: Bool,
+                                    inputFilename: String,
+                                    extensionName: String,
+                                    extensionFilePath: String,
+                                    extensionSuffix: String) {
         // Get extension content
         let extensionFileContent = Self.getExtensionContent(sections: sections,
                                                             defaultLang: lang,
                                                             tags: tags,
                                                             staticVar: staticVar,
                                                             inputFilename: inputFilename,
-                                                            extensionName: extensionName)
+                                                            extensionName: extensionName,
+                                                            extensionSuffix: extensionSuffix)
         
         // Write content
         let extensionFilePathURL = URL(fileURLWithPath: extensionFilePath)
@@ -108,9 +124,16 @@ class StringsFileGenerator {
     
     // MARK: - Extension content
     
-    static func getExtensionContent(sections: [Section], defaultLang lang: String, tags: [String], staticVar: Bool, inputFilename: String, extensionName: String) -> String {
+    static func getExtensionContent(sections: [Section],
+                                    defaultLang lang: String,
+                                    tags: [String],
+                                    staticVar: Bool,
+                                    inputFilename: String,
+                                    extensionName: String,
+                                    extensionSuffix: String) -> String {
         [
             Self.getHeader(stringsFilename: inputFilename, extensionClassname: extensionName),
+            Self.getEnumKey(sections: sections, tags: tags, extensionClassname: extensionName, extensionSuffix: extensionSuffix),
             Self.getProperties(sections: sections, defaultLang: lang, tags: tags, staticVar: staticVar),
             Self.getFooter()
         ]
@@ -131,6 +154,50 @@ class StringsFileGenerator {
         """
     }
     
+    private static func getEnumKey(sections: [Section], tags: [String], extensionClassname: String, extensionSuffix: String) -> String {
+        var enumDefinition = "\n    enum Key\(extensionSuffix.uppercasedFirst()): String {\n"
+        
+        // Enum
+        sections.forEach { section in
+            // Check that at least one string will be generated
+            guard section.hasOneOrMoreMatchingTags(tags: tags) else {
+                return // Go to next section
+            }
+            
+            section.definitions.forEach { definition in
+                guard definition.hasOneOrMoreMatchingTags(inputTags: tags) == true else {
+                    return // Go to next definition
+                }
+                debugPrint("Found definition")
+                enumDefinition += "        case \(definition.name) = \"\(definition.name)\"\n"
+            }
+        }
+        
+        // KeyPath accessors
+        enumDefinition += "\n"
+        enumDefinition += "        var keyPath: KeyPath<\(extensionClassname), String> {\n"
+        enumDefinition += "            switch self {\n"
+        sections.forEach { section in
+            // Check that at least one string will be generated
+            guard section.hasOneOrMoreMatchingTags(tags: tags) else {
+                return // Go to next section
+            }
+            
+            section.definitions.forEach { definition in
+                guard definition.hasOneOrMoreMatchingTags(inputTags: tags) == true else {
+                    return // Go to next definition
+                }
+                debugPrint("Found definition")
+                enumDefinition += "            case .\(definition.name): return \\\(extensionClassname).\(definition.name)\n"
+            }
+        }
+        enumDefinition += "            }\n" // Switch
+        enumDefinition += "        }\n" // var keyPath
+        enumDefinition += "    }" // Enum
+        
+        return enumDefinition
+    }
+    
     private static func getProperties(sections: [Section], defaultLang lang: String, tags: [String], staticVar: Bool) -> String {
         sections.compactMap { section in
             // Check that at least one string will be generated

Sources/ResgenSwift/Strings/Stringium/Stringium.swift

@@ -57,7 +57,8 @@ struct Stringium: ParsableCommand {
                                                  staticVar: options.staticMembers,
                                                  inputFilename: options.inputFilenameWithoutExt,
                                                  extensionName: options.extensionName,
-                                                 extensionFilePath: options.extensionFilePath)
+                                                 extensionFilePath: options.extensionFilePath,
+                                                 extensionSuffix: options.extensionSuffix)
         
         print("[\(Self.toolName)] Strings generated")
     }

Sources/ResgenSwift/Strings/Stringium/StringiumOptions.swift

@@ -36,8 +36,8 @@ struct StringiumOptions: ParsableArguments {
     @Option(help: "Extension name. If not specified, it will generate an String extension.")
     var extensionName: String = Stringium.defaultExtensionName
     
-    @Option(help: "Extension suffix. Ex: MyApp, it will generate {extensionName}+{extensionSuffix}.swift")
-    var extensionSuffix: String?
+    @Option(help: "Extension suffix: {extensionName}+{extensionSuffix}.swift")
+    var extensionSuffix: String
 }
 
 // MARK: - Private var getter
@@ -68,10 +68,7 @@ extension StringiumOptions {
 
 extension StringiumOptions {
     var extensionFileName: String {
-        if let extensionSuffix = extensionSuffix {
-            return "\(extensionName)+\(extensionSuffix).swift"
-        }
-        return "\(extensionName).swift"
+        "\(extensionName)+\(extensionSuffix).swift"
     }
     
     var extensionFilePath: String {

Sources/ToolCore/StringExtensions.swift

@@ -85,4 +85,8 @@ public extension String {
         blue = String(colorClean.prefix(2))
         return (alpha: alpha, red: red, green: green, blue: blue)
     }
+    
+    func uppercasedFirst() -> String {
+        prefix(1).uppercased() + dropFirst()
+    }
 }

Tests/ResgenSwiftTests/Strings/StringsFileGeneratorTests.swift

@@ -131,7 +131,8 @@ final class StringsFileGeneratorTests: XCTestCase {
                                                                         tags: ["ios", "iosonly", "notranslation"],
                                                                         staticVar: false,
                                                                         inputFilename: "myInputFilename",
-                                                                        extensionName: "GenStrings")
+                                                                        extensionName: "GenStrings",
+                                                                        extensionSuffix: "strings")
         
         // Expect
         let expect = """
@@ -207,7 +208,8 @@ final class StringsFileGeneratorTests: XCTestCase {
                                                                         tags: ["ios", "iosonly", "notranslation"],
                                                                         staticVar: true,
                                                                         inputFilename: "myInputFilename",
-                                                                        extensionName: "GenStrings")
+                                                                        extensionName: "GenStrings",
+                                                                        extensionSuffix: "strings")
         
         // Expect
         let expect = """