Skip to content

Moved Protocol Declarations Out Of PluginList Files #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tinder-SamMarshall merged 4 commits into from
Mar 25, 2025
Merged

Moved Protocol Declarations Out Of PluginList Files #910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0354297
Moved Protocol Declarations Out Of PluginList Files
tinder-SamMarshall Mar 24, 2025
d7fbe56
Addressing comments
tinder-SamMarshall Mar 24, 2025
2fe7d37
Added needed imports
tinder-SamMarshall Mar 24, 2025
699271b
Added Snapshots For Moved Plugin List Declarations (#911)
tinder-SamMarshall Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions Sources/NodesGenerator/Resources/Stencils/PluginList.stencil
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,6 @@ import {{ import }}
{% endfor %}
{% endif %}

{% if is_periphery_comment_enabled %}
// periphery:ignore
{% endif %}
/// @mockable
@MainActor
internal protocol {{ plugin_list_name }}Flow: {{ view_controllable_flow_type }} {}

{% if is_periphery_comment_enabled %}
// periphery:ignore
{% endif %}
/// @mockable
@MainActor
internal protocol {{ plugin_list_name }}Listener: AnyObject {}

{% if is_periphery_comment_enabled %}
// periphery:ignore
{% endif %}
/// @mockable
@MainActor
internal protocol {{ plugin_list_name }}Builder: AnyObject {
func build(
withListener listener: {{ plugin_list_name }}Listener
) -> {{ plugin_list_name }}Flow
}

// MARK: - Dependency

/// Declares the dependencies required by the component. A code-generated conforming object is made available to the
Expand Down
26 changes: 26 additions & 0 deletions Sources/NodesGenerator/Resources/Stencils/PluginListInterface.stencil
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,32 @@ import {{ import }}
This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
{% if is_periphery_comment_enabled %}
// periphery:ignore
{% endif %}
/// @mockable
@MainActor
internal protocol {{ plugin_list_name }}Listener: AnyObject {}

{% if is_periphery_comment_enabled %}
// periphery:ignore
{% endif %}
/// @mockable
@MainActor
internal protocol {{ plugin_list_name }}Flow: {{ view_controllable_flow_type }} {}

{% if is_periphery_comment_enabled %}
// periphery:ignore
{% endif %}
/// @mockable
@MainActor
internal protocol {{ plugin_list_name }}Builder: AnyObject {
func build(
withListener listener: {{ plugin_list_name }}Listener
) -> {{ plugin_list_name }}Flow
}

/// 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
Expand Down
1 change: 1 addition & 0 deletions Sources/NodesGenerator/StencilTemplate.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,7 @@ public enum StencilTemplate: CustomStringConvertible, Equatable, Sendable {
.union(config.pluginListImports)
case .pluginListInterface:
config.baseImports
.union(["Nodes"])
case .pluginListTests:
config.baseTestImports
.union(["NodesTesting"])
Expand Down
6 changes: 4 additions & 2 deletions Tests/NodesGeneratorTests/StencilTemplateTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,8 @@ final class StencilTemplateTests: XCTestCase, TestFactories {
]
case .pluginListInterface:
expect(imports) == [
"<baseImport>"
"<baseImport>",
"Nodes"
]
case .pluginListTests:
expect(imports) == [
Expand Down Expand Up @@ -494,7 +495,8 @@ final class StencilTemplateTests: XCTestCase, TestFactories {
]
case .pluginListInterface:
expect(imports) == [
"<baseImport>"
"<baseImport>",
"Nodes"
]
case .pluginListTests:
expect(imports) == [
Expand Down
16 changes: 0 additions & 16 deletions ...rTests/__Snapshots__/StencilRendererTests/testRenderPluginList.PluginList-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,5 @@
//<fileHeader>

/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

// MARK: - Dependency

/// Declares the dependencies required by the component. A code-generated conforming object is made available to the
Expand Down
19 changes: 0 additions & 19 deletions ...rTests/__Snapshots__/StencilRendererTests/testRenderPluginList.PluginList-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,6 @@

import <pluginListImport>

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

// MARK: - Dependency

/// Declares the dependencies required by the component. A code-generated conforming object is made available to the
Expand Down
19 changes: 0 additions & 19 deletions ...rTests/__Snapshots__/StencilRendererTests/testRenderPluginList.PluginList-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,6 @@
import <pluginListImport1>
import <pluginListImport2>

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

// MARK: - Dependency

/// Declares the dependencies required by the component. A code-generated conforming object is made available to the
Expand Down
17 changes: 17 additions & 0 deletions ...Snapshots__/StencilRendererTests/testRenderPluginList.PluginListInterface-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@
This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

/// 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 <pluginListName>PluginListKeyType = String
Expand Down
20 changes: 20 additions & 0 deletions ...Snapshots__/StencilRendererTests/testRenderPluginList.PluginListInterface-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ import <pluginListInterfaceImport>
This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

/// 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 <pluginListName>PluginListKeyType = String
Expand Down
20 changes: 20 additions & 0 deletions ...Snapshots__/StencilRendererTests/testRenderPluginList.PluginListInterface-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,26 @@ import <pluginListInterfaceImport2>
This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

/// 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 <pluginListName>PluginListKeyType = String
Expand Down
16 changes: 0 additions & 16 deletions ...napshots__/StencilRendererTests/testRenderPluginList_withTests.PluginList-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,5 @@
//<fileHeader>

/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

// MARK: - Dependency

/// Declares the dependencies required by the component. A code-generated conforming object is made available to the
Expand Down
19 changes: 0 additions & 19 deletions ...napshots__/StencilRendererTests/testRenderPluginList_withTests.PluginList-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,6 @@

import <pluginListImport>

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

// MARK: - Dependency

/// Declares the dependencies required by the component. A code-generated conforming object is made available to the
Expand Down
19 changes: 0 additions & 19 deletions ...napshots__/StencilRendererTests/testRenderPluginList_withTests.PluginList-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,6 @@
import <pluginListImport1>
import <pluginListImport2>

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

// MARK: - Dependency

/// Declares the dependencies required by the component. A code-generated conforming object is made available to the
Expand Down
17 changes: 17 additions & 0 deletions ..._/StencilRendererTests/testRenderPluginList_withTests.PluginListInterface-mockCount-0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@
This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

/// 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 <pluginListName>PluginListKeyType = String
Expand Down
20 changes: 20 additions & 0 deletions ..._/StencilRendererTests/testRenderPluginList_withTests.PluginListInterface-mockCount-1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ import <pluginListInterfaceImport>
This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

/// 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 <pluginListName>PluginListKeyType = String
Expand Down
20 changes: 20 additions & 0 deletions ..._/StencilRendererTests/testRenderPluginList_withTests.PluginListInterface-mockCount-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,26 @@ import <pluginListInterfaceImport2>
This file contains the protocols and types of the plugin list interface requiring public ACL for use in another module.
*/

/// Defines the delegate protocol through which the `Context` interfaces with its listener.
// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Listener: AnyObject {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Flow: <viewControllableFlowType> {}

// periphery:ignore
/// @mockable
@MainActor
internal protocol <pluginListName>Builder: AnyObject {
func build(
withListener listener: <pluginListName>Listener
) -> <pluginListName>Flow
}

/// 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 <pluginListName>PluginListKeyType = String
Expand Down
Loading