Added enum cases for PluginInterface file (#887)

* Added Plugin Interface File

* Remove declarations from Plugin.swift

* Added enum cases for PluginInterface file

* Fixed enums to include interface file in plugin alone generation

* Update Sources/NodesGenerator/Resources/Stencils/PluginInterface.stencil

Co-authored-by: Christopher Fuller <[email protected]>

* Added snapshots for PluginInterface file (#888)

* Added snapshots for PluginInterface file

* regebed snapshots

* fixed snapshots

* Fixed closure length warning

* fixed plural string and snapshots

---------

Co-authored-by: Christopher Fuller <[email protected]>

Author: tinder-SamMarshall

Sources/NodesGenerator/PresetGenerator.swift

@@ -44,6 +44,7 @@ public final class PresetGenerator {
                 flowTestsImports: node.flowTests.imports(with: config),
                 interfaceImports: node.interface.imports(with: config),
                 pluginImports: node.plugin.imports(with: config),
+                pluginInterfaceImports: node.pluginInterface.imports(with: config),
                 pluginTestsImports: node.pluginTests.imports(with: config),
                 stateImports: node.state.imports(with: config),
                 dependencies: config.dependencies,

Sources/NodesGenerator/StencilContexts/NodeStencilContext.swift

@@ -26,6 +26,7 @@ public struct NodeStencilContext: StencilContext {
     private let flowTestsImports: [String]
     private let interfaceImports: [String]
     private let pluginImports: [String]
+    private let pluginInterfaceImports: [String]
     private let pluginTestsImports: [String]
     private let stateImports: [String]
     private let viewControllerImports: [String]
@@ -77,6 +78,7 @@ public struct NodeStencilContext: StencilContext {
             "flow_tests_imports": flowTestsImports,
             "interface_imports": interfaceImports,
             "plugin_imports": pluginImports,
+            "plugin_interface_imports": pluginInterfaceImports,
             "plugin_tests_imports": pluginTestsImports,
             "state_imports": stateImports,
             "view_controller_imports": viewControllerImports,
@@ -113,7 +115,7 @@ public struct NodeStencilContext: StencilContext {
         ]
     }
 
-    // swiftlint:disable:next function_default_parameter_at_end
+    // swiftlint:disable:next function_default_parameter_at_end function_body_length
     public init(
         fileHeader: String,
         nodeName: String,
@@ -129,6 +131,7 @@ public struct NodeStencilContext: StencilContext {
         flowTestsImports: Set<String>,
         interfaceImports: Set<String>,
         pluginImports: Set<String>,
+        pluginInterfaceImports: Set<String>,
         pluginTestsImports: Set<String>,
         stateImports: Set<String>,
         viewControllerImports: Set<String>,
@@ -179,6 +182,7 @@ public struct NodeStencilContext: StencilContext {
             flowTestsImports: flowTestsImports,
             interfaceImports: interfaceImports,
             pluginImports: pluginImports,
+            pluginInterfaceImports: pluginInterfaceImports,
             pluginTestsImports: pluginTestsImports,
             stateImports: stateImports,
             viewControllerImports: viewControllerImports,
@@ -278,6 +282,7 @@ public struct NodeStencilContext: StencilContext {
             flowTestsImports: flowTestsImports,
             interfaceImports: interfaceImports,
             pluginImports: [],
+            pluginInterfaceImports: [],
             pluginTestsImports: [],
             stateImports: stateImports,
             viewControllerImports: viewControllerImports,
@@ -330,6 +335,7 @@ public struct NodeStencilContext: StencilContext {
         flowTestsImports: Set<String>,
         interfaceImports: Set<String>,
         pluginImports: Set<String>,
+        pluginInterfaceImports: Set<String>,
         pluginTestsImports: Set<String>,
         stateImports: Set<String>,
         viewControllerImports: Set<String>,
@@ -380,6 +386,7 @@ public struct NodeStencilContext: StencilContext {
         self.flowTestsImports = flowTestsImports.sortedImports()
         self.interfaceImports = interfaceImports.sortedImports()
         self.pluginImports = pluginImports.sortedImports()
+        self.pluginInterfaceImports = pluginInterfaceImports.sortedImports()
         self.pluginTestsImports = pluginTestsImports.sortedImports()
         self.stateImports = stateImports.sortedImports()
         self.viewControllerImports = viewControllerImports.sortedImports()

Sources/NodesGenerator/StencilContexts/NodeViewInjectedStencilContext.swift

@@ -22,6 +22,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
     private let flowTestsImports: [String]
     private let interfaceImports: [String]
     private let pluginImports: [String]
+    private let pluginInterfaceImports: [String]
     private let pluginTestsImports: [String]
     private let stateImports: [String]
     private let dependencies: [[String: Any]]
@@ -52,6 +53,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
             "flow_tests_imports": flowTestsImports,
             "interface_imports": interfaceImports,
             "plugin_imports": pluginImports,
+            "plugin_interface_imports": pluginInterfaceImports,
             "plugin_tests_imports": pluginTestsImports,
             "state_imports": stateImports,
             "dependencies": dependencies,
@@ -83,6 +85,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
         flowTestsImports: Set<String>,
         interfaceImports: Set<String>,
         pluginImports: Set<String>,
+        pluginInterfaceImports: Set<String>,
         pluginTestsImports: Set<String>,
         stateImports: Set<String>,
         dependencies: [Config.Variable],
@@ -112,6 +115,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
             flowTestsImports: flowTestsImports,
             interfaceImports: interfaceImports,
             pluginImports: pluginImports,
+            pluginInterfaceImports: pluginInterfaceImports,
             pluginTestsImports: pluginTestsImports,
             stateImports: stateImports,
             dependencies: dependencies,
@@ -141,6 +145,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
         flowTestsImports: Set<String>,
         interfaceImports: Set<String>,
         pluginImports: Set<String>,
+        pluginInterfaceImports: Set<String>,
         pluginTestsImports: Set<String>,
         stateImports: Set<String>,
         dependencies: [Config.Variable],
@@ -171,6 +176,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
             flowTestsImports: flowTestsImports,
             interfaceImports: interfaceImports,
             pluginImports: pluginImports,
+            pluginInterfaceImports: pluginInterfaceImports,
             pluginTestsImports: pluginTestsImports,
             stateImports: stateImports,
             dependencies: dependencies,
@@ -202,6 +208,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
         flowTestsImports: Set<String>,
         interfaceImports: Set<String>,
         pluginImports: Set<String>,
+        pluginInterfaceImports: Set<String>,
         pluginTestsImports: Set<String>,
         stateImports: Set<String>,
         dependencies: [Config.Variable],
@@ -231,6 +238,7 @@ public struct NodeViewInjectedStencilContext: StencilContext {
         self.flowTestsImports = flowTestsImports.sortedImports()
         self.interfaceImports = interfaceImports.sortedImports()
         self.pluginImports = pluginImports.sortedImports()
+        self.pluginInterfaceImports = pluginInterfaceImports.sortedImports()
         self.pluginTestsImports = pluginTestsImports.sortedImports()
         self.stateImports = stateImports.sortedImports()
         self.dependencies = dependencies.map(\.dictionary)

Sources/NodesGenerator/StencilContexts/PluginStencilContext.swift

@@ -12,6 +12,7 @@ public struct PluginStencilContext: StencilContext {
     private let fileHeader: String
     private let pluginName: String
     private let pluginImports: [String]
+    private let pluginInterfaceImports: [String]
     private let pluginTestsImports: [String]
     private let isPeripheryCommentEnabled: Bool
     private let isNimbleEnabled: Bool
@@ -21,6 +22,7 @@ public struct PluginStencilContext: StencilContext {
             "file_header": fileHeader,
             "plugin_name": pluginName,
             "plugin_imports": pluginImports,
+            "plugin_interface_imports": pluginInterfaceImports,
             "plugin_tests_imports": pluginTestsImports,
             "is_periphery_comment_enabled": isPeripheryCommentEnabled,
             "is_nimble_enabled": isNimbleEnabled
@@ -31,13 +33,15 @@ public struct PluginStencilContext: StencilContext {
         fileHeader: String,
         pluginName: String,
         pluginImports: Set<String>,
+        pluginInterfaceImports: Set<String>,
         pluginTestsImports: Set<String>,
         isPeripheryCommentEnabled: Bool,
         isNimbleEnabled: Bool
     ) {
         self.fileHeader = fileHeader
         self.pluginName = pluginName
         self.pluginImports = pluginImports.sortedImports()
+        self.pluginInterfaceImports = pluginInterfaceImports.sortedImports()
         self.pluginTestsImports = pluginTestsImports.sortedImports()
         self.isPeripheryCommentEnabled = isPeripheryCommentEnabled
         self.isNimbleEnabled = isNimbleEnabled

Sources/NodesGenerator/StencilRenderer.swift

@@ -40,7 +40,7 @@ public final class StencilRenderer {
         includeTests: Bool
     ) throws -> [String: String] {
         let additional: [StencilTemplate] = includeTests ? [.pluginTests] : []
-        let stencils: [StencilTemplate] = [.plugin] + additional
+        let stencils: [StencilTemplate] = [.plugin, .pluginInterface] + additional
         return try render(stencils: stencils, with: context.dictionary)
     }
 

Sources/NodesGenerator/StencilTemplate.swift

@@ -20,6 +20,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
     case flowTests
     case interface(Variation)
     case plugin
+    case pluginInterface
     case pluginTests
     case pluginList
     case pluginListTests
@@ -62,6 +63,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
         public let flowTests: StencilTemplate
         public let interface: StencilTemplate
         public let plugin: StencilTemplate
+        public let pluginInterface: StencilTemplate
         public let pluginTests: StencilTemplate
         public let state: StencilTemplate
         public let viewController: StencilTemplate
@@ -80,6 +82,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
             self.flowTests = .flowTests
             self.interface = .interface(variation)
             self.plugin = .plugin
+            self.pluginInterface = .pluginInterface
             self.pluginTests = .pluginTests
             self.state = .state
             self.viewController = .viewController(variation)
@@ -98,7 +101,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
                 state,
                 viewController,
                 viewState
-            ] + (includePlugin ? [.plugin] : [])
+            ] + (includePlugin ? [.plugin, .pluginInterface] : [])
             guard includeTests
             else { return stencils }
             let testsStencils: [StencilTemplate] = [
@@ -125,6 +128,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
         public let flowTests: StencilTemplate
         public let interface: StencilTemplate
         public let plugin: StencilTemplate
+        public let pluginInterface: StencilTemplate
         public let pluginTests: StencilTemplate
         public let state: StencilTemplate
 
@@ -139,6 +143,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
             self.flowTests = .flowTests
             self.interface = .interface(.regular)
             self.plugin = .plugin
+            self.pluginInterface = .pluginInterface
             self.pluginTests = .pluginTests
             self.state = .state
         }
@@ -151,7 +156,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
                 flow,
                 interface,
                 state
-            ] + (includePlugin ? [.plugin] : [])
+            ] + (includePlugin ? [.plugin, .pluginInterface] : [])
             guard includeTests
             else { return stencils }
             let testsStencils: [StencilTemplate] = [
@@ -188,6 +193,8 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
             "Interface"
         case .plugin:
             "Plugin"
+        case .pluginInterface:
+            "PluginInterface"
         case .pluginTests:
             "PluginTests"
         case .pluginList:
@@ -225,6 +232,8 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
             description
         case .plugin, .pluginTests:
             description
+        case .pluginInterface:
+            description
         case let .interface(variation):
             description.appending(variation.suffix)
         case .pluginList, .pluginListTests:
@@ -277,6 +286,8 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
             config.baseImports
                 .union(["Nodes"])
                 .union(config.dependencyInjectionImports)
+        case .pluginInterface:
+            config.baseImports
         case .pluginTests:
             config.baseTestImports
                 .union(["NodesTesting"])

Sources/NodesGenerator/XcodeTemplatePermutations/NodeViewInjectedXcodeTemplatePermutation.swift

@@ -33,6 +33,7 @@ internal struct NodeViewInjectedXcodeTemplatePermutation: XcodeTemplatePermutati
             flowTestsImports: node.flowTests.imports(with: config),
             interfaceImports: node.interface.imports(with: config),
             pluginImports: node.plugin.imports(with: config),
+            pluginInterfaceImports: node.pluginInterface.imports(with: config),
             pluginTestsImports: node.pluginTests.imports(with: config),
             stateImports: node.state.imports(with: config),
             dependencies: config.dependencies,

Sources/NodesGenerator/XcodeTemplatePermutations/NodeXcodeTemplatePermutation.swift

@@ -36,6 +36,7 @@ internal struct NodeXcodeTemplatePermutation: XcodeTemplatePermutation {
             flowTestsImports: node.flowTests.imports(with: config, including: uiFramework),
             interfaceImports: node.interface.imports(with: config, including: uiFramework),
             pluginImports: node.plugin.imports(with: config, including: uiFramework),
+            pluginInterfaceImports: node.pluginInterface.imports(with: config, including: uiFramework),
             pluginTestsImports: node.pluginTests.imports(with: config, including: uiFramework),
             stateImports: node.state.imports(with: config, including: uiFramework),
             viewControllerImports: node.viewController.imports(with: config, including: uiFramework),

Sources/NodesGenerator/XcodeTemplatePermutations/PluginXcodeTemplatePermutation.swift

@@ -16,12 +16,14 @@ internal struct PluginXcodeTemplatePermutation: XcodeTemplatePermutation {
     internal init(name: String, config: Config) {
         self.name = name
         let plugin: StencilTemplate = .plugin
+        let pluginInterface: StencilTemplate = .pluginInterface
         let pluginTests: StencilTemplate = .pluginTests
-        stencils = [plugin] + (config.isTestTemplatesGenerationEnabled ? [pluginTests] : [])
+        stencils = [plugin, pluginInterface] + (config.isTestTemplatesGenerationEnabled ? [pluginTests] : [])
         stencilContext = PluginStencilContext(
             fileHeader: XcodeTemplateConstants.fileHeader,
             pluginName: XcodeTemplateConstants.variable(XcodeTemplateConstants.productName),
             pluginImports: plugin.imports(with: config),
+            pluginInterfaceImports: pluginInterface.imports(with: config),
             pluginTestsImports: pluginTests.imports(with: config),
             isPeripheryCommentEnabled: config.isPeripheryCommentEnabled,
             isNimbleEnabled: config.isNimbleEnabled

Tests/NodesGeneratorTests/StencilRendererTests.swift

@@ -60,6 +60,7 @@ final class StencilRendererTests: XCTestCase, TestFactories {
                     "Flow",
                     "Interface",
                     "Plugin",
+                    "PluginInterface",
                     "State",
                     "ViewController",
                     "ViewState"
@@ -109,31 +110,34 @@ final class StencilRendererTests: XCTestCase, TestFactories {
 
     func testRenderNode_withPluginAndTests() throws {
         let stencilRenderer: StencilRenderer = .init()
+        let expectedTemplates: [String] = [
+            "Analytics",
+            "AnalyticsTests",
+            "Builder",
+            "BuilderTests",
+            "Context",
+            "ContextTests",
+            "Flow",
+            "FlowTests",
+            "Interface",
+            "Plugin",
+            "PluginInterface",
+            "PluginTests",
+            "State",
+            "ViewController",
+            "ViewControllerTests",
+            "ViewState",
+            "ViewStateFactoryTests"
+        ]
+
         try mockCounts.forEach { count in
             try UIFramework.Kind.allCases.forEach { kind in
                 let context: NodeStencilContext = try givenNodeStencilContext(mockCount: count)
                 let templates: [String: String] = try stencilRenderer.renderNode(context: context,
                                                                                  kind: kind,
                                                                                  includePlugin: true,
                                                                                  includeTests: true)
-                expect(templates.keys.sorted()) == [
-                    "Analytics",
-                    "AnalyticsTests",
-                    "Builder",
-                    "BuilderTests",
-                    "Context",
-                    "ContextTests",
-                    "Flow",
-                    "FlowTests",
-                    "Interface",
-                    "Plugin",
-                    "PluginTests",
-                    "State",
-                    "ViewController",
-                    "ViewControllerTests",
-                    "ViewState",
-                    "ViewStateFactoryTests"
-                ]
+                expect(templates.keys.sorted()) == expectedTemplates
                 templates.forEach { name, template in
                     assertSnapshot(of: template,
                                    as: .lines,
@@ -262,7 +266,7 @@ final class StencilRendererTests: XCTestCase, TestFactories {
             let context: PluginStencilContext = givenPluginStencilContext(mockCount: count)
             let templates: [String: String] = try stencilRenderer
                 .renderPlugin(context: context, includeTests: false)
-            expect(templates.keys.sorted()) == ["Plugin"]
+            expect(templates.keys.sorted()) == ["Plugin", "PluginInterface"]
             templates.forEach { name, template in
                 assertSnapshot(of: template,
                                as: .lines,
@@ -277,7 +281,7 @@ final class StencilRendererTests: XCTestCase, TestFactories {
             let context: PluginStencilContext = givenPluginStencilContext(mockCount: count)
             let templates: [String: String] = try stencilRenderer
                 .renderPlugin(context: context, includeTests: true)
-            expect(templates.keys.sorted()) == ["Plugin", "PluginTests"]
+            expect(templates.keys.sorted()) == ["Plugin", "PluginInterface", "PluginTests"]
             templates.forEach { name, template in
                 assertSnapshot(of: template,
                                as: .lines,