Edit sample file

SampleFiles/Tags/Generated/Analytics+GenAllScript.swift

@@ -169,19 +169,22 @@ class AnalyticsManager {
 
     // MARK: - section_one
 
-    func logScreenS1DefOne() {
+    func logScreenS1DefOne(title: String) {
         logScreen(
-            name: "s1 def one",
-            path: "s1_def_one/"
+            name: "s1 def one \(title)",
+            path: "s1_def_one/\(title)"
         )
     }
 
-    func logEventS1DefTwo() {
+    func logEventS1DefTwo(title: String, count: String) {
         logEvent(
             name: "s1 def two",
             action: "test",
             category: "test",
-            params: [:]
+            params: [
+                "title": title,
+				"count": count
+            ]
         )
     }
 

SampleFiles/Tags/sampleTags.yml

@@ -3,9 +3,13 @@ categories:
   - id: section_one
     screens:
       - id: s1_def_one
-        name: s1 def one
-        path: s1_def_one/
-        tags: ios
+        name: s1 def one _TITLE_
+        path: s1_def_one/_TITLE_
+        tags: ios,droid
+        parameters:
+          - name: title
+            type: String
+            replaceIn: name,path
               
     events:
       - id: s1_def_two
@@ -13,6 +17,11 @@ categories:
         action: test
         category: test
         tags: ios
+        parameters:
+          - name: title
+            type: String
+          - name: count
+            type: String
             
   - id: section_two
     screens:

Sources/ResgenSwift/Analytics/Analytics.swift

@@ -32,6 +32,10 @@ struct Analytics: ParsableCommand {
     mutating func run() {
         print("[\(Self.toolName)] Starting analytics generation")
         print("[\(Self.toolName)] Will use inputFile \(options.inputFile) to generate analytics for target: \(options.target)")
+
+        // Check requirements
+        guard checkRequirements() else { return }
+
         print("[\(Self.toolName)] Will generate analytics")
         
         // Check requirements
@@ -63,6 +67,12 @@ struct Analytics: ParsableCommand {
             Analytics.exit(withError: error)
         }
 
+        guard TrackerType.hasValidTarget(in: options.target) else {
+            let error = AnalyticsError.noValidTracker(options.target)
+            print(error.description)
+            Analytics.exit(withError: error)
+        }
+
         // Check if needed to regenerate
         guard GeneratorChecker.shouldGenerate(force: options.forceGeneration,
                                               inputFilePath: options.inputFile,
@@ -74,19 +84,3 @@ struct Analytics: ParsableCommand {
         return true
     }
 }
-
-extension Analytics {
-    enum TargetType: CaseIterable {
-        case matomo
-        case firebase
-        
-        var value: String {
-            switch self {
-            case .matomo:
-                "matomo"
-            case .firebase:
-                "firebase"
-            }
-        }
-    }
-}

Sources/ResgenSwift/Analytics/AnalyticsError.swift

@@ -8,16 +8,20 @@
 import Foundation
 
 enum AnalyticsError: Error {
+    case noValidTracker(String)
     case fileNotExists(String)
     case missingElement(String)
     case invalidParameter(String)
-    
+    case parseFailed(String)
     case writeFile(String, String)
     
     var description: String {
         switch self {
+        case .noValidTracker(let inputTargets):
+            return "error: [\(Analytics.toolName)] '\(inputTargets)' ne contient aucun tracker valid"
+
         case .fileNotExists(let filename):
-            return "error: [\(Analytics.toolName)] File \(filename) does not exists "
+            return "error: [\(Analytics.toolName)] File \(filename) does not exists"
             
         case .missingElement(let element):
             return "error: [\(Analytics.toolName)] Missing \(element) for Matomo"
@@ -25,6 +29,9 @@ enum AnalyticsError: Error {
         case .invalidParameter(let reason):
             return "error: [\(Analytics.toolName)] Invalid parameter \(reason)"
             
+        case .parseFailed(let baseError):
+            return "error: [\(Analytics.toolName)] Parse input file failed: \(baseError)"
+
         case .writeFile(let subErrorDescription, let filename):
             return "error: [\(Analytics.toolName)] An error occured while writing content to \(filename): \(subErrorDescription)"
         }

Sources/ResgenSwift/Analytics/Generator/AnalyticsGenerator.swift

@@ -10,13 +10,13 @@ import ToolCore
 import CoreVideo
 
 class AnalyticsGenerator {
-    static var targets: [Analytics.TargetType] = []
+    static var targets: [TrackerType] = []
 
     static func writeExtensionFiles(sections: [AnalyticsCategory], target: String, tags: [String], staticVar: Bool, extensionName: String, extensionFilePath: String) {
         // Get target type from enum
         let targetsString: [String] = target.components(separatedBy: " ")
                 
-        Analytics.TargetType.allCases.forEach { enumTarget in
+        TrackerType.allCases.forEach { enumTarget in
             if targetsString.contains(enumTarget.value) {
                 targets.append(enumTarget)
             }
@@ -58,7 +58,7 @@ class AnalyticsGenerator {
         
         \(Self.getImport())
         
-        \(Self.getAnalytics())
+        \(Self.getAnalyticsProtocol())
         // MARK: - Manager
         
         class AnalyticsManager {
@@ -91,10 +91,10 @@ class AnalyticsGenerator {
     private static func getImport() -> String {
         var result: [String] = []
         
-        if targets.contains(Analytics.TargetType.matomo) {
+        if targets.contains(TrackerType.matomo) {
             result.append("import MatomoTracker")
         }
-        if targets.contains(Analytics.TargetType.firebase) {
+        if targets.contains(TrackerType.firebase) {
             result.append("import FirebaseAnalytics")
         }
         
@@ -136,13 +136,13 @@ class AnalyticsGenerator {
         var content: [String] = []
         let footer = "    }"
         
-        if targets.contains(Analytics.TargetType.matomo) {
+        if targets.contains(TrackerType.matomo) {
             header = "func configure(siteId: String, url: String) {"
-        } else if targets.contains(Analytics.TargetType.firebase) {
+        } else if targets.contains(TrackerType.firebase) {
             header = "func configure() {"
         }
         
-        if targets.contains(Analytics.TargetType.matomo) {
+        if targets.contains(TrackerType.matomo) {
             content.append("""
                     managers.append(
                         MatomoAnalyticsManager(
@@ -152,7 +152,7 @@ class AnalyticsGenerator {
                     )
             """)
         }
-        if targets.contains(Analytics.TargetType.firebase) {
+        if targets.contains(TrackerType.firebase) {
             content.append("        managers.append(FirebaseAnalyticsManager())")
         }
         
@@ -164,7 +164,7 @@ class AnalyticsGenerator {
             .joined(separator: "\n")
     }
     
-    private static func getAnalytics() -> String {
+    private static func getAnalyticsProtocol() -> String {
         let proto = """
         // MARK: - Protocol
         
@@ -182,12 +182,12 @@ class AnalyticsGenerator {
         
         var result: [String] = [proto]
         
-        if targets.contains(Analytics.TargetType.matomo) {
-            result.append(MatomoGenerator.service.content)
+        if targets.contains(TrackerType.matomo) {
+            result.append(MatomoGenerator.service)
         }
         
-        if targets.contains(Analytics.TargetType.firebase) {
-            result.append(FirebaseGenerator.service.content)
+        if targets.contains(TrackerType.firebase) {
+            result.append(FirebaseGenerator.service)
         }
         
         return result.joined(separator: "\n")

Sources/ResgenSwift/Analytics/Generator/FirebaseGenerator.swift

@@ -8,19 +8,20 @@
 import Foundation
 
 enum FirebaseGenerator {
-    case service
 
-    var content: String {
+    static var service: String {
         [
-            FirebaseGenerator.service.header,
-            FirebaseGenerator.service.logScreen,
-            FirebaseGenerator.service.logEvent,
-            FirebaseGenerator.service.footer
+            FirebaseGenerator.header,
+            FirebaseGenerator.logScreen,
+            FirebaseGenerator.logEvent,
+            FirebaseGenerator.footer
         ]
             .joined(separator: "\n")
     }
     
-    private var header: String {
+    // MARK: - Private vars
+
+    private static var header: String {
         """
         // MARK: - Firebase
 
@@ -28,7 +29,7 @@ enum FirebaseGenerator {
         """
     }
     
-    private var logScreen: String {
+    private static var logScreen: String {
         """
             func logScreen(name: String, path: String) {
                 var parameters = [
@@ -44,7 +45,7 @@ enum FirebaseGenerator {
         """
     }
     
-    private var logEvent: String {
+    private static var logEvent: String {
         """
             func logEvent(
                 name: String,
@@ -71,7 +72,7 @@ enum FirebaseGenerator {
         """
     }
     
-    private var footer: String {
+    private static var footer: String {
         """
         }
         

Sources/ResgenSwift/Analytics/Generator/MatomoGenerator.swift

@@ -8,20 +8,21 @@
 import Foundation
 
 enum MatomoGenerator {
-    case service
 
-    var content: String {
+    static var service: String {
         [
-            MatomoGenerator.service.header,
-            MatomoGenerator.service.setup,
-            MatomoGenerator.service.logScreen,
-            MatomoGenerator.service.logEvent,
-            MatomoGenerator.service.footer
+            MatomoGenerator.header,
+            MatomoGenerator.setup,
+            MatomoGenerator.logScreen,
+            MatomoGenerator.logEvent,
+            MatomoGenerator.footer
         ]
             .joined(separator: "\n")
     }
     
-    private var header: String {
+    // MARK: - Private vars
+
+    private static var header: String {
         """
         // MARK: - Matomo
 
@@ -34,7 +35,7 @@ enum MatomoGenerator {
         """
     }
     
-    private var setup: String {
+    private static var setup: String {
         """
             // MARK: - Init
         
@@ -63,7 +64,7 @@ enum MatomoGenerator {
         """
     }
     
-    private var logScreen: String {
+    private static var logScreen: String {
         """
             func logScreen(name: String, path: String) {
                 guard !tracker.isOptedOut else { return }
@@ -79,7 +80,7 @@ enum MatomoGenerator {
         """
     }
     
-    private var logEvent: String {
+    private static var logEvent: String {
         """
             func logEvent(
                 name: String,
@@ -100,7 +101,7 @@ enum MatomoGenerator {
         """
     }
     
-    private var footer: String {
+    private static var footer: String {
         """
         }
         

Sources/ResgenSwift/Analytics/Model/AnalyticsCategory.swift

@@ -11,10 +11,14 @@ class AnalyticsCategory {
     let id: String // OnBoarding
     var definitions = [AnalyticsDefinition]()
     
+    // MARK: - Init
+
     init(id: String) {
         self.id = id
     }
     
+    // MARK: - Methods
+
     func hasOneOrMoreMatchingTags(tags: [String]) -> Bool {
         let allTags = definitions.flatMap { $0.tags }
         let allTagsSet = Set(allTags)

Sources/ResgenSwift/Analytics/Model/AnalyticsDefinition.swift

@@ -6,6 +6,7 @@
 //
 
 import Foundation
+import ToolCore
 
 class AnalyticsDefinition {
     let id: String
@@ -18,12 +19,16 @@ class AnalyticsDefinition {
     var parameters: [AnalyticsParameter] = []
     var type: TagType
     
+    // MARK: - Init
+
     init(id: String, name: String, type: TagType) {
         self.id = id
         self.name = name
         self.type = type
     }
     
+    // MARK: - Methods
+
     func hasOneOrMoreMatchingTags(inputTags: [String]) -> Bool {
         if Set(inputTags).isDisjoint(with: tags) {
             return false
@@ -31,7 +36,7 @@ class AnalyticsDefinition {
         return true
     }
     
-    // MARK: - Methods
+    // MARK: - Private Methods
 
     private func getFuncName() -> String {
         var pascalCaseTitle: String = ""
@@ -150,27 +155,3 @@ class AnalyticsDefinition {
         """
     }
 }
-
-extension AnalyticsDefinition {
-    enum TagType {
-        case screen
-        case event
-    }
-}
-
-extension String {
-    func replacingFirstOccurrence(of: String, with: String) -> Self {
-        if let range = self.range(of: of) {
-            let tmp = self.replacingOccurrences(
-                of: of,
-                with: with,
-                options: .literal,
-                range: range
-            )
-
-            return tmp
-        }
-        
-        return self
-    }
-}

Sources/ResgenSwift/Analytics/Model/AnalyticsFile.swift

@@ -17,9 +17,7 @@ struct AnalyticsCategoryDTO: Codable {
     var events: [AnalyticsDefinitionEventDTO]?
 }
 
-protocol AnalyticsDefinitionDTO: Codable {}
-
-struct AnalyticsDefinitionScreenDTO: AnalyticsDefinitionDTO {
+struct AnalyticsDefinitionScreenDTO: Codable {
     var id: String
     var name: String
     var tags: String
@@ -29,7 +27,7 @@ struct AnalyticsDefinitionScreenDTO: AnalyticsDefinitionDTO {
     var path: String?
 }
 
-struct AnalyticsDefinitionEventDTO: AnalyticsDefinitionDTO {
+struct AnalyticsDefinitionEventDTO: Codable {
     var id: String
     var name: String
     var tags: String

Sources/ResgenSwift/Analytics/Model/AnalyticsParameter.swift

@@ -12,6 +12,8 @@ class AnalyticsParameter {
     var type: String
     var replaceIn: [String] = []
     
+    // MARK: - Init
+    
     init(name: String, type: String) {
         self.name = name
         self.type = type

Sources/ResgenSwift/Analytics/Model/TagType.swift

@@ -0,0 +1,16 @@
+//
+//  TagType.swift
+//  
+//
+//  Created by Thibaut Schmitt on 08/12/2023.
+//
+
+import Foundation
+
+extension AnalyticsDefinition {
+    
+    enum TagType {
+        case screen
+        case event
+    }
+}

Sources/ResgenSwift/Analytics/Model/TargetType.swift

@@ -0,0 +1,29 @@
+//
+//  TargetType.swift
+//  
+//
+//  Created by Thibaut Schmitt on 08/12/2023.
+//
+
+import Foundation
+
+enum TrackerType: CaseIterable {
+    case matomo
+    case firebase
+
+    var value: String {
+        switch self {
+        case .matomo:
+            "matomo"
+        case .firebase:
+            "firebase"
+        }
+    }
+
+    static func hasValidTarget(in targets: String) -> Bool {
+        for tracker in Self.allCases where targets.contains(tracker.value) {
+            return true
+        }
+        return false
+    }
+}

Sources/ResgenSwift/Analytics/Parser/AnalyticsFileParser.swift

@@ -15,24 +15,25 @@ class AnalyticsFileParser {
     private static func parseYaml() -> AnalyticsFile {
         guard let data = FileManager().contents(atPath: inputFile) else {
             let error = AnalyticsError.fileNotExists(inputFile)
+            print(error.description)
             Analytics.exit(withError: error)
         }
         
         do {
             let tagFile = try YAMLDecoder().decode(AnalyticsFile.self, from: data)
             return tagFile
-        } catch let error {
+        } catch {
+            let error = AnalyticsError.parseFailed(error.localizedDescription)
+            print(error.description)
             Analytics.exit(withError: error)
         }
     }
 
-    private static func getParameters(fromData data: [AnalyticsParameterDTO]) -> [AnalyticsParameter] {
-        var parameters: [AnalyticsParameter] = []
-        
-        data.forEach { value in
+    private static func getParameters(from parameters: [AnalyticsParameterDTO]) -> [AnalyticsParameter] {
+        parameters.map { dtoParameter in
             // Type
             
-            let type = value.type.uppercasedFirst()
+            let type = dtoParameter.type.uppercasedFirst()
 
             guard 
                 type == "String" ||
@@ -40,20 +41,22 @@ class AnalyticsFileParser {
                 type == "Double" ||
                 type == "Bool"
             else {
-                let error = AnalyticsError.invalidParameter("type of \(value.name)")
+                let error = AnalyticsError.invalidParameter("type of \(dtoParameter.name)")
+                print(error.description)
                 Analytics.exit(withError: error)
             }
 
-            let parameter: AnalyticsParameter = AnalyticsParameter(name: value.name, type: type)
+            let parameter = AnalyticsParameter(
+                name: dtoParameter.name,
+                type: type
+            )
 
-            if let replaceIn = value.replaceIn {
+            if let replaceIn = dtoParameter.replaceIn {
                 parameter.replaceIn = replaceIn.components(separatedBy: ",")
             }
 
-            parameters.append(parameter)
+            return parameter
         }
-        
-        return parameters
     }
 
     private static func getTagDefinition(
@@ -64,24 +67,24 @@ class AnalyticsFileParser {
         comments: String?,
         parameters: [AnalyticsParameterDTO]?
     ) -> AnalyticsDefinition {
-        let definition: AnalyticsDefinition = AnalyticsDefinition(id: id, name: name, type: type)
-        definition.tags = tags.components(separatedBy: ",")
+        let definition = AnalyticsDefinition(id: id, name: name, type: type)
+        definition.tags = tags
+            .components(separatedBy: ",")
+            .map { $0.removeLeadingTrailingWhitespace() }
 
         if let comments = comments {
             definition.comments = comments
         }
         
         if let parameters = parameters {
-            definition.parameters = Self.getParameters(fromData: parameters)
+            definition.parameters = Self.getParameters(from: parameters)
         }
         
         return definition
     }
     
-    private static func getTagDefinitionScreen(fromData screens: [AnalyticsDefinitionScreenDTO]) -> [AnalyticsDefinition] {
-        var definitions: [AnalyticsDefinition] = []
-            
-        for screen in screens {
+    private static func getTagDefinitionScreen(from screens: [AnalyticsDefinitionScreenDTO]) -> [AnalyticsDefinition] {
+        screens.map { screen in
             let definition: AnalyticsDefinition = Self.getTagDefinition(
                 id: screen.id,
                 name: screen.name,
@@ -91,27 +94,24 @@ class AnalyticsFileParser {
                 parameters: screen.parameters
             )
 
-            if target.contains(Analytics.TargetType.matomo.value) {
+            if target.contains(TrackerType.matomo.value) {
                 // Path
 
                 guard let path = screen.path else {
                     let error = AnalyticsError.missingElement("screen path")
+                    print(error.description)
                     Analytics.exit(withError: error)
                 }
 
                 definition.path = path
             }
 
-            definitions.append(definition)
+            return definition
+        }
     }
     
-        return definitions
-    }
-    
-    private static func getTagDefinitionEvent(fromData events: [AnalyticsDefinitionEventDTO]) -> [AnalyticsDefinition] {
-        var definitions: [AnalyticsDefinition] = []
-            
-        for event in events {
+    private static func getTagDefinitionEvent(from events: [AnalyticsDefinitionEventDTO]) -> [AnalyticsDefinition] {
+        events.map { event in
             let definition: AnalyticsDefinition = Self.getTagDefinition(
                 id: event.id,
                 name: event.name,
@@ -121,53 +121,58 @@ class AnalyticsFileParser {
                 parameters: event.parameters
             )
 
-            if target.contains(Analytics.TargetType.matomo.value) {
+            if target.contains(TrackerType.matomo.value) {
                 // Category
-                
                 guard let category = event.category else {
                     let error = AnalyticsError.missingElement("event category")
+                    print(error.description)
                     Analytics.exit(withError: error)
                 }
 
                 definition.category = category
 
                 // Action
-                
                 guard let action = event.action else {
                     let error = AnalyticsError.missingElement("event action")
+                    print(error.description)
                     Analytics.exit(withError: error)
                 }
 
                 definition.action = action
             }
 
-            definitions.append(definition)
+            return definition
         }
-        
-        return definitions
     }
     
     static func parse(_ inputFile: String, target: String) -> [AnalyticsCategory] {
         self.inputFile = inputFile
         self.target = target
         
-        let tagFile: AnalyticsFile = Self.parseYaml()
-        var sections: [AnalyticsCategory] = []
+        let tagFile = Self.parseYaml()
         
-        tagFile.categories.forEach { categorie in
+        return tagFile
+            .categories
+            .map { categorie in
                 let section: AnalyticsCategory = AnalyticsCategory(id: categorie.id)
 
                 if let screens = categorie.screens {
-                section.definitions.append(contentsOf: Self.getTagDefinitionScreen(fromData: screens))
+                    section
+                        .definitions
+                        .append(
+                            contentsOf: Self.getTagDefinitionScreen(from: screens)
+                        )
                 }
 
                 if let events = categorie.events {
-                section.definitions.append(contentsOf: Self.getTagDefinitionEvent(fromData: events))
+                    section
+                        .definitions
+                        .append(
+                        contentsOf: Self.getTagDefinitionEvent(from: events)
+                    )
                 }
 
-            sections.append(section)
+                return section
             }
-        
-        return sections
     }
 }

Sources/ToolCore/StringExtensions.swift

@@ -89,4 +89,19 @@ public extension String {
     func uppercasedFirst() -> String {
         prefix(1).uppercased() + dropFirst()
     }
+
+    func replacingFirstOccurrence(of: String, with: String) -> Self {
+        if let range = self.range(of: of) {
+            let tmp = self.replacingOccurrences(
+                of: of,
+                with: with,
+                options: .literal,
+                range: range
+            )
+
+            return tmp
+        }
+
+        return self
+    }
 }

Tests/ResgenSwiftTests/Analytics/AnalyticsGeneratorTests.swift

@@ -51,7 +51,7 @@ final class AnalyticsGeneratorTests: XCTestCase {
         ]
         
         // When
-        AnalyticsGenerator.targets = [Analytics.TargetType.firebase]
+        AnalyticsGenerator.targets = [TrackerType.firebase]
         let extensionContent = AnalyticsGenerator.getExtensionContent(sections: [sectionOne, sectionTwo, sectionThree],
                                                                  tags: ["ios", "iosonly"],
                                                                  staticVar: false,
@@ -216,7 +216,7 @@ final class AnalyticsGeneratorTests: XCTestCase {
         ]
         
         // When
-        AnalyticsGenerator.targets = [Analytics.TargetType.matomo]
+        AnalyticsGenerator.targets = [TrackerType.matomo]
         let extensionContent = AnalyticsGenerator.getExtensionContent(sections: [sectionOne, sectionTwo, sectionThree],
                                                                  tags: ["ios", "iosonly"],
                                                                  staticVar: false,
@@ -409,7 +409,7 @@ final class AnalyticsGeneratorTests: XCTestCase {
         ]
         
         // When
-        AnalyticsGenerator.targets = [Analytics.TargetType.matomo, Analytics.TargetType.firebase]
+        AnalyticsGenerator.targets = [TrackerType.matomo, TrackerType.firebase]
         let extensionContent = AnalyticsGenerator.getExtensionContent(sections: [sectionOne, sectionTwo, sectionThree],
                                                                  tags: ["ios", "iosonly"],
                                                                  staticVar: false,

Tests/ResgenSwiftTests/Analytics/DiffString.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  DiffString.swift
 //  
 //
 //  Created by Loris Perret on 06/12/2023.
@@ -7,7 +7,6 @@
 
 import Foundation
 
-
 /// Find first differing character between two strings
 ///
 /// :param: s1 First String