Merge branch 'main' into mock-plugin-list-tests-import

Author: tinder-cfuller

Sources/NodesGenerator/Config.swift

@@ -38,6 +38,7 @@ public struct Config: Codable, Equatable {
     public var dependencyInjectionImports: Set<String>
     public var builderImports: Set<String>
     public var flowImports: Set<String>
+    public var interfaceImports: Set<String>
     public var pluginListImports: Set<String>
     public var viewControllerImports: Set<String>
     public var dependencies: [Variable]
@@ -94,6 +95,7 @@ extension Config {
         dependencyInjectionImports = ["NeedleFoundation"]
         builderImports = []
         flowImports = []
+        interfaceImports = []
         pluginListImports = []
         viewControllerImports = []
         dependencies = []
@@ -168,6 +170,9 @@ extension Config {
         flowImports =
             (try? decoder.decode(CodingKeys.flowImports))
             ?? defaults.flowImports
+        interfaceImports =
+            (try? decoder.decode(CodingKeys.interfaceImports))
+            ?? defaults.interfaceImports
         pluginListImports =
             (try? decoder.decode(CodingKeys.pluginListImports))
             ?? defaults.pluginListImports

Sources/NodesGenerator/Resources/Stencils/Interface-SwiftUI.stencil

@@ -6,19 +6,17 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-// This file defines the protocols and types in the interface requiring public ACL for use in another module.
+/*
+ This file contains the protocols and types of the interface requiring public ACL for use in another module.
+ */
 {% if node_name != "App" %}
 
-// MARK: - Listener
-
 /// Defines the delegate protocol through which the `Context` interfaces with its listener.
 /// @mockable
 @MainActor
 internal protocol {{ node_name }}Listener: AnyObject {}
 {% endif %}
 
-// MARK: - Flow
-
 /// @mockable
 @MainActor
 {% if plugin_list_name %}
@@ -27,8 +25,6 @@ internal protocol {{ node_name }}Flow: {{ plugin_list_name }}Flow {}
 internal protocol {{ node_name }}Flow: {{ view_controllable_flow_type }} {}
 {% endif %}
 
-// MARK: - Builder
-
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}

Sources/NodesGenerator/Resources/Stencils/Interface.stencil

@@ -6,19 +6,17 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-// This file defines the protocols and types in the interface requiring public ACL for use in another module.
+/*
+ This file contains the protocols and types of the interface requiring public ACL for use in another module.
+ */
 {% if node_name != "App" %}
 
-// MARK: - Listener
-
 /// Defines the delegate protocol through which the `Context` interfaces with its listener.
 /// @mockable
 @MainActor
 internal protocol {{ node_name }}Listener: AnyObject {}
 {% endif %}
 
-// MARK: - Flow
-
 /// @mockable
 @MainActor
 {% if owns_view %}
@@ -35,8 +33,6 @@ internal protocol {{ node_name }}Flow: Flow {
 internal protocol {{ node_name }}Flow: Flow {}
 {% endif %}
 
-// MARK: - Builder
-
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}

Sources/NodesGenerator/Resources/Stencils/PluginInterface.stencil

@@ -6,7 +6,9 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-// This file defines the protocols and types in the plugin interface requiring public ACL for use in another module.
+/*
+ This file contains the protocols and types of the plugin interface requiring public ACL for use in another module.
+ */
 
 /// Dynamic state from the caller provided to the plugin to use in determining whether it is enabled.
 /// - NOTE: An alias to a tuple is supported.

Sources/NodesGenerator/Resources/Stencils/PluginList.stencil

@@ -79,25 +79,6 @@ public final class {{ plugin_list_name }}PluginListComponent: Component
 
 // MARK: - Plugin List
 
-/// Declares the type of key used to identify plugins within the collection.
-/// - NOTE: May be any ``Hashable`` type such as ``String`` or an enumeration.
-internal typealias {{ plugin_list_name }}PluginListKeyType = String
-
-/// Dynamic state from the caller provided to the plugins to use in determining whether they are enabled.
-/// - NOTE: An alias to a tuple is supported.
-internal typealias {{ plugin_list_name }}PluginListStateType = Void
-
-{% if is_periphery_comment_enabled %}
-// periphery:ignore
-{% endif %}
-/// @mockable
-@MainActor
-internal protocol {{ plugin_list_name }}PluginList {
-    func createAll() -> [{{ plugin_list_name }}Builder]
-    func create() -> {{ plugin_list_name }}Builder?
-    func create(key: {{ plugin_list_name }}PluginListKeyType) -> {{ plugin_list_name }}Builder?
-}
-
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}

Sources/NodesGenerator/Resources/Stencils/PluginListInterface.stencil

@@ -0,0 +1,30 @@
+//{{ file_header }}
+{% if plugin_list_interface_imports %}
+
+{% for import in plugin_list_interface_imports %}
+import {{ import }}
+{% endfor %}
+{% endif %}
+
+/*
+ This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
+ */
+
+/// Declares the type of key used to identify plugins within the collection.
+/// - NOTE: May be any ``Hashable`` type such as ``String`` or an enumeration.
+internal typealias {{ plugin_list_name }}PluginListKeyType = String
+
+/// Dynamic state from the caller provided to the plugins to use in determining whether they are enabled.
+/// - NOTE: An alias to a tuple is supported.
+internal typealias {{ plugin_list_name }}PluginListStateType = Void
+
+{% if is_periphery_comment_enabled %}
+// periphery:ignore
+{% endif %}
+/// @mockable
+@MainActor
+internal protocol {{ plugin_list_name }}PluginList {
+    func createAll() -> [{{ plugin_list_name }}Builder]
+    func create() -> {{ plugin_list_name }}Builder?
+    func create(key: {{ plugin_list_name }}PluginListKeyType) -> {{ plugin_list_name }}Builder?
+}

Sources/NodesGenerator/StencilContexts/PluginListStencilContext.swift

@@ -12,6 +12,7 @@ public struct PluginListStencilContext: StencilContext {
     private let fileHeader: String
     private let pluginListName: String
     private let pluginListImports: [String]
+    private let pluginListInterfaceImports: [String]
     private let pluginListTestsImports: [String]
     private let viewControllableFlowType: String
     private let isPeripheryCommentEnabled: Bool
@@ -22,6 +23,7 @@ public struct PluginListStencilContext: StencilContext {
             "file_header": fileHeader,
             "plugin_list_name": pluginListName,
             "plugin_list_imports": pluginListImports,
+            "plugin_list_interface_imports": pluginListInterfaceImports,
             "plugin_list_tests_imports": pluginListTestsImports,
             "view_controllable_flow_type": viewControllableFlowType,
             "is_periphery_comment_enabled": isPeripheryCommentEnabled,
@@ -33,6 +35,7 @@ public struct PluginListStencilContext: StencilContext {
         fileHeader: String,
         pluginListName: String,
         pluginListImports: Set<String>,
+        pluginListInterfaceImports: Set<String>,
         pluginListTestsImports: Set<String>,
         viewControllableFlowType: String,
         isPeripheryCommentEnabled: Bool,
@@ -41,6 +44,7 @@ public struct PluginListStencilContext: StencilContext {
         self.fileHeader = fileHeader
         self.pluginListName = pluginListName
         self.pluginListImports = pluginListImports.sortedImports()
+        self.pluginListInterfaceImports = pluginListInterfaceImports.sortedImports()
         self.pluginListTestsImports = pluginListTestsImports.sortedImports()
         self.viewControllableFlowType = viewControllableFlowType
         self.isPeripheryCommentEnabled = isPeripheryCommentEnabled

Sources/NodesGenerator/StencilRenderer.swift

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

Sources/NodesGenerator/StencilTemplate.swift

@@ -23,6 +23,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
     case pluginInterface
     case pluginTests
     case pluginList
+    case pluginListInterface
     case pluginListTests
     case state
     case viewController(Variation)
@@ -199,6 +200,8 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
             "PluginTests"
         case .pluginList:
             "PluginList"
+        case .pluginListInterface:
+            "PluginListInterface"
         case .pluginListTests:
             "PluginListTests"
         case .state:
@@ -238,6 +241,8 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
             description.appending(variation.suffix)
         case .pluginList, .pluginListTests:
             description
+        case .pluginListInterface:
+            description
         case .state:
             description
         case let .viewController(variation), let .viewControllerTests(variation):
@@ -282,6 +287,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
         case .interface:
             config.baseImports
                 .union(["Nodes"])
+                .union(config.interfaceImports)
         case .plugin:
             config.baseImports
                 .union(["Nodes"])
@@ -296,6 +302,8 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
                 .union(["Nodes"])
                 .union(config.dependencyInjectionImports)
                 .union(config.pluginListImports)
+        case .pluginListInterface:
+            config.baseImports
         case .pluginListTests:
             config.baseTestImports
                 .union(["NodesTesting"])

Sources/NodesGenerator/XcodeTemplatePermutations/PluginListXcodeTemplatePermutation.swift

@@ -16,12 +16,15 @@ internal struct PluginListXcodeTemplatePermutation: XcodeTemplatePermutation {
     internal init(name: String, config: Config) {
         self.name = name
         let pluginList: StencilTemplate = .pluginList
+        let pluginListInterface: StencilTemplate = .pluginListInterface
         let pluginListTests: StencilTemplate = .pluginListTests
-        stencils = [pluginList] + (config.isTestTemplatesGenerationEnabled ? [pluginListTests] : [])
+        stencils = [pluginList, pluginListInterface]
+            + (config.isTestTemplatesGenerationEnabled ? [pluginListTests] : [])
         stencilContext = PluginListStencilContext(
             fileHeader: XcodeTemplateConstants.fileHeader,
             pluginListName: XcodeTemplateConstants.variable(XcodeTemplateConstants.productName),
             pluginListImports: pluginList.imports(with: config),
+            pluginListInterfaceImports: pluginListInterface.imports(with: config),
             pluginListTestsImports: pluginListTests.imports(with: config),
             viewControllableFlowType: config.viewControllableFlowType,
             isPeripheryCommentEnabled: config.isPeripheryCommentEnabled,