Publish v1.0

Reviewed-on: #1

Sources/ResgenSwift/Generate/Extensions/StringExtensions.swift

@@ -0,0 +1,18 @@
+//
+//  StringExtensions.swift
+//  
+//
+//  Created by Thibaut Schmitt on 31/08/2022.
+//
+
+import Foundation
+
+extension String {
+    
+    func prependIfRelativePath(_ prependPath: String) -> String {
+        if self.hasPrefix("/") {
+            return self
+        }
+        return prependPath + self
+    }
+}

Sources/ResgenSwift/Generate/Generate.swift

@@ -0,0 +1,57 @@
+//
+//  Generate.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import ToolCore
+import Foundation
+import ArgumentParser
+
+struct Generate: ParsableCommand {
+    
+    // MARK: - CommandConfiguration
+    
+    static var configuration = CommandConfiguration(
+        abstract: "A utility to generate ressources based on a configuration file",
+        version: ResgenSwiftVersion
+    )
+    
+    // MARK: - Static
+    
+    static let toolName = "Generate"
+    
+    // MARK: - Command Options
+    
+    @OptionGroup var options: GenerateOptions
+    
+    // MARK: - Run
+    
+    public func run() throws {
+        print("[\(Self.toolName)] Starting Resgen with configuration: \(options.configurationFile)")
+        
+        // Parse
+        let configuration = ConfigurationFileParser.parse(options.configurationFile)
+        print("Found configurations :")
+        print("  - \(configuration.colors.count) colors configuration")
+        print("  - \(configuration.fonts.count) fonts configuration")
+        print("  - \(configuration.images.count) images configuration")
+        print("  - \(configuration.strings.count) strings configuration")
+        print("  - \(configuration.tags.count) tags configuration")
+        print()
+        
+        print("Input file: \(configuration.colors.first?.inputFile ?? "no input file")")
+        
+        // Execute commands
+        configuration.runnableConfigurations
+            .forEach {
+                let begin = Date()
+                $0.run(projectDirectory: options.projectDirectory,
+                       force: options.forceGeneration)
+                print("Took: \(Date().timeIntervalSince(begin))s\n")
+            }
+
+        print("[\(Self.toolName)] Resgen ended")
+    }
+}

Sources/ResgenSwift/Generate/GenerateError.swift

@@ -0,0 +1,30 @@
+//
+//  ResgenSwiftError.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+enum GenerateError: Error {
+    case fileNotExists(String)
+    case invalidConfigurationFile(String)
+    case commandError([String], String)
+    
+    var localizedDescription: String {
+        switch self {
+        case .fileNotExists(let filename):
+            return " error:[\(Generate.toolName)] File \(filename) does not exists"
+    
+        case .invalidConfigurationFile(let filename):
+            return " error:[\(Generate.toolName)] File \(filename) is not a valid configuration file"
+            
+        case .commandError(let command, let terminationStatus):
+            let readableCommand = command
+                .map { $0 }
+                .joined(separator: " ")
+            return "error:[\(Generate.toolName)] An error occured while running command '\(readableCommand)'. Command terminate with status code: \(terminationStatus)"
+        }
+    }
+}

Sources/ResgenSwift/Generate/GenerateOptions.swift

@@ -0,0 +1,28 @@
+//
+//  GenerateOptions.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+import Foundation
+import ArgumentParser
+
+struct GenerateOptions: ParsableArguments {
+    @Flag(name: [.customShort("f"), .customShort("F")], help: "Should force generation")
+    var forceGeneration = false
+    
+    @Argument(help: "Configuration file.", transform: { $0.replaceTiltWithHomeDirectoryPath() })
+    var configurationFile: String
+    
+    @Option(help: "Project directory. It will be added to every relative path (path that does not start with `/`",
+            transform: {
+        if $0.last == "/" {
+            return $0
+        }
+        return $0 + "/"
+    })
+    var projectDirectory: String
+}

Sources/ResgenSwift/Generate/Model/ConfigurationFile.swift

@@ -0,0 +1,180 @@
+//
+//  ConfigurationFile.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+struct ConfigurationFile: Codable, CustomDebugStringConvertible {
+    var colors: [ColorsConfiguration]
+    var fonts: [FontsConfiguration]
+    var images: [ImagesConfiguration]
+    var strings: [StringsConfiguration]
+    var tags: [TagsConfiguration]
+    
+    var runnableConfigurations: [Runnable] {
+        let runnables: [[Runnable]] = [colors, fonts, images, strings, tags]
+        return Array(runnables.joined())
+    }
+    
+    var debugDescription: String {
+        """
+        \(colors)
+        -----------
+        -----------
+        \(fonts)
+        -----------
+        -----------
+        \(images)
+        -----------
+        -----------
+        \(strings)
+        -----------
+        -----------
+        \(tags)
+        """
+    }
+}
+
+
+struct ColorsConfiguration: Codable, CustomDebugStringConvertible {
+    let inputFile: String
+    let style: String
+    let xcassetsPath: String
+    let extensionOutputPath: String
+    let extensionName: String?
+    let extensionSuffix: String?
+    private let staticMembers: Bool?
+    
+    var staticMembersOptions: Bool {
+        if let staticMembers = staticMembers {
+            return staticMembers
+        }
+        return false
+    }
+    
+    var debugDescription: String {
+        """
+        Colors configuration:
+            - Input file: \(inputFile)
+            - Style: \(style)
+            - Xcassets path: \(xcassetsPath)
+            - Extension output path: \(extensionOutputPath)
+            - Extension name: \(extensionName ?? "-")
+            - Extension suffix: \(extensionSuffix ?? "-")
+        """
+    }
+}
+
+struct FontsConfiguration: Codable, CustomDebugStringConvertible {
+    let inputFile: String
+    let extensionOutputPath: String
+    let extensionName: String?
+    let extensionSuffix: String?
+    private let staticMembers: Bool?
+    
+    var staticMembersOptions: Bool {
+        if let staticMembers = staticMembers {
+            return staticMembers
+        }
+        return false
+    }
+    
+    var debugDescription: String {
+        """
+        Fonts configuration:
+            - Input file: \(inputFile)
+            - Extension output path: \(extensionOutputPath)
+            - Extension name: \(extensionName ?? "-")
+            - Extension suffix: \(extensionSuffix ?? "-")
+        """
+    }
+}
+
+struct ImagesConfiguration: Codable, CustomDebugStringConvertible {
+    let inputFile: String
+    let xcassetsPath: String
+    let extensionOutputPath: String
+    let extensionName: String?
+    let extensionSuffix: String?
+    private let staticMembers: Bool?
+    
+    var staticMembersOptions: Bool {
+        if let staticMembers = staticMembers {
+            return staticMembers
+        }
+        return false
+    }
+    
+    var debugDescription: String {
+        """
+        Images configuration:
+            - Input file: \(inputFile)
+            - Xcassets path: \(xcassetsPath)
+            - Extension output path: \(extensionOutputPath)
+            - Extension name: \(extensionName ?? "-")
+            - Extension suffix: \(extensionSuffix ?? "-")
+        """
+    }
+}
+
+struct StringsConfiguration: Codable, CustomDebugStringConvertible {
+    let inputFile: String
+    let outputPath: String
+    let langs: String
+    let defaultLang: String
+    let extensionOutputPath: String
+    let extensionName: String?
+    let extensionSuffix: String?
+    private let staticMembers: Bool?
+    
+    var staticMembersOptions: Bool {
+        if let staticMembers = staticMembers {
+            return staticMembers
+        }
+        return false
+    }
+    
+    var debugDescription: String {
+        """
+        Strings configuration:
+            - Input file: \(inputFile)
+            - Output path: \(outputPath)
+            - Langs: \(langs)
+            - Default lang: \(defaultLang)
+            - Extension output path: \(extensionOutputPath)
+            - Extension name: \(extensionName ?? "-")
+            - Extension suffix: \(extensionSuffix ?? "-")
+        """
+    }
+}
+
+struct TagsConfiguration: Codable, CustomDebugStringConvertible {
+    let inputFile: String
+    let lang: String
+    let extensionOutputPath: String
+    let extensionName: String?
+    let extensionSuffix: String?
+    private let staticMembers: Bool?
+    
+    var staticMembersOptions: Bool {
+        if let staticMembers = staticMembers {
+            return staticMembers
+        }
+        return false
+    }
+    
+    var debugDescription: String {
+        """
+        Tags configuration:
+            - Input file: \(inputFile)
+            - Lang: \(lang)
+            - Extension output path: \(extensionOutputPath)
+            - Extension name: \(extensionName ?? "-")
+            - Extension suffix: \(extensionSuffix ?? "-")
+        """
+    }
+}
+

Sources/ResgenSwift/Generate/Parser/ConfigurationFileParser.swift

@@ -0,0 +1,27 @@
+//
+//  ConfigurationFileParser.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+import Yams
+
+class ConfigurationFileParser {
+    static func parse(_ configurationFile: String) -> ConfigurationFile {
+        guard let data = FileManager().contents(atPath: configurationFile) else {
+            let error = GenerateError.fileNotExists(configurationFile)
+            print(error.localizedDescription)
+            Generate.exit(withError: error)
+        }
+        
+        guard let configuration = try? YAMLDecoder().decode(ConfigurationFile.self, from: data) else {
+            let error = GenerateError.invalidConfigurationFile(configurationFile)
+            print(error.localizedDescription)
+            Generate.exit(withError: error)
+        }
+        
+        return configuration
+    }
+}

Sources/ResgenSwift/Generate/Runnable/ColorsConfiguration+ShellCommandable.swift

@@ -0,0 +1,45 @@
+//
+//  ColorsConfiguration+Runnable.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+extension ColorsConfiguration: Runnable {
+    func run(projectDirectory: String, force: Bool) {
+        var args = [String]()
+        
+        if force {
+            args += ["-f"]
+        }
+        
+        args += [
+            inputFile.prependIfRelativePath(projectDirectory),
+            "--style",
+            style,
+            "--xcassets-path",
+            xcassetsPath.prependIfRelativePath(projectDirectory),
+            "--extension-output-path",
+            extensionOutputPath.prependIfRelativePath(projectDirectory),
+            "--static-members",
+            "\(staticMembersOptions)"
+        ]
+        
+        if let extensionName = extensionName {
+            args += [
+                "--extension-name",
+                extensionName
+            ]
+        }
+        if let extensionSuffix = extensionSuffix {
+            args += [
+                "--extension-suffix",
+                extensionSuffix
+            ]
+        }
+        
+        Colors.main(args)
+    }
+}

Sources/ResgenSwift/Generate/Runnable/FontsConfiguration+ShellCommandable.swift

@@ -0,0 +1,42 @@
+//
+//  FontsConfiguration+Runnable.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+extension FontsConfiguration: Runnable {
+    func run(projectDirectory: String, force: Bool) {
+        var args = [String]()
+        
+        if force {
+            args += ["-f"]
+        }
+        
+        args += [
+            inputFile.prependIfRelativePath(projectDirectory),
+            "--extension-output-path",
+            extensionOutputPath.prependIfRelativePath(projectDirectory),
+            "--static-members",
+            "\(staticMembersOptions)"
+        ]
+        
+        if let extensionName = extensionName {
+            args += [
+                "--extension-name",
+                extensionName
+            ]
+        }
+        
+        if let extensionSuffix = extensionSuffix {
+            args += [
+                "--extension-suffix",
+                extensionSuffix
+            ]
+        }
+        
+        Fonts.main(args)
+    }
+}

Sources/ResgenSwift/Generate/Runnable/ImagesConfiguration+ShellCommandable.swift

@@ -0,0 +1,43 @@
+//
+//  ImagesConfiguration+Runnable.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+extension ImagesConfiguration: Runnable {
+    func run(projectDirectory: String, force: Bool) {
+        var args = [String]()
+        
+        if force {
+            args += ["-f"] // Images has a -f and -F options
+        }
+        
+        args += [
+            inputFile.prependIfRelativePath(projectDirectory),
+            "--xcassets-path",
+            xcassetsPath.prependIfRelativePath(projectDirectory),
+            "--extension-output-path",
+            extensionOutputPath.prependIfRelativePath(projectDirectory),
+            "--static-members",
+            "\(staticMembersOptions)"
+        ]
+        
+        if let extensionName = extensionName {
+            args += [
+                "--extension-name",
+                extensionName
+            ]
+        }
+        if let extensionSuffix = extensionSuffix {
+            args += [
+                "--extension-suffix",
+                extensionSuffix
+            ]
+        }
+        
+        Images.main(args)
+    }
+}

Sources/ResgenSwift/Generate/Runnable/Runnable.swift

@@ -0,0 +1,13 @@
+//
+//  ShellCommandable.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+protocol Runnable {
+    func run(projectDirectory: String, force: Bool)
+}
+

Sources/ResgenSwift/Generate/Runnable/StringsConfiguration+ShellCommandable.swift

@@ -0,0 +1,48 @@
+//
+//  StringsConfiguration+Runnable.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+extension StringsConfiguration: Runnable {
+    func run(projectDirectory: String, force: Bool) {
+        var args = [String]()
+        
+        if force {
+            args += ["-f"]
+        }
+        
+        args += [
+            inputFile.prependIfRelativePath(projectDirectory),
+            "--output-path",
+            outputPath.prependIfRelativePath(projectDirectory),
+            "--langs",
+            langs,
+            "--default-lang",
+            defaultLang,
+            "--extension-output-path",
+            extensionOutputPath.prependIfRelativePath(projectDirectory),
+            "--static-members",
+            "\(staticMembersOptions)"
+        ]
+        
+        if let extensionName = extensionName {
+            args += [
+                "--extension-name",
+                extensionName
+            ]
+        }
+        
+        if let extensionSuffix = extensionSuffix {
+            args += [
+                "--extension-suffix",
+                extensionSuffix
+            ]
+        }
+        
+        Stringium.main(args)
+    }
+}

Sources/ResgenSwift/Generate/Runnable/TagsConfiguration+ShellCommandable.swift

@@ -0,0 +1,43 @@
+//
+//  TagsConfiguration+Runnable.swift
+//  
+//
+//  Created by Thibaut Schmitt on 30/08/2022.
+//
+
+import Foundation
+
+extension TagsConfiguration: Runnable {
+    func run(projectDirectory: String, force: Bool) {
+        var args = [String]()
+        
+        if force {
+            args += ["-f"]
+        }
+        
+        args += [
+            inputFile.prependIfRelativePath(projectDirectory),
+            "--lang",
+            lang,
+            "--extension-output-path",
+            extensionOutputPath.prependIfRelativePath(projectDirectory),
+            "--static-members",
+            "\(staticMembersOptions)"
+        ]
+        
+        if let extensionName = extensionName {
+            args += [
+                "--extension-name",
+                extensionName
+            ]
+        }
+        if let extensionSuffix = extensionSuffix {
+            args += [
+                "--extension-suffix",
+                extensionSuffix
+            ]
+        }
+        
+        Tags.main(args)
+    }
+}