Add ObservedObject macro if store_prefix (#863)

* Add ObservedObject macro if store_prefix * Add store_property_wrapper
Tinder · Oct 30, 2024 · 535e279 · 535e279
1 parent b9eb0b3
commit 535e279
Show file tree

Hide file tree

Showing 36 changed files with 88 additions and 20 deletions.
diff --git a/Sources/NodesGenerator/Config.swift b/Sources/NodesGenerator/Config.swift
@@ -61,6 +61,7 @@ public struct Config: Codable, Equatable {
     public var isPeripheryCommentEnabled: Bool
 
     public var storePrefix: String { isObservableStoreEnabled ? "Observable" : "" }
+    public var storePropertyWrapper: String { isObservableStoreEnabled ? "@ObservedObject" : "" }
     public var isNimbleEnabled: Bool { baseTestImports.contains("Nimble") }
 
     public init(

diff --git a/Sources/NodesGenerator/PresetGenerator.swift b/Sources/NodesGenerator/PresetGenerator.swift
@@ -94,6 +94,7 @@ public final class PresetGenerator {
                 contextGenericTypes: config.contextGenericTypes,
                 workerGenericTypes: config.workerGenericTypes,
                 storePrefix: config.storePrefix,
+                storePropertyWrapper: config.storePropertyWrapper,
                 isPreviewProviderEnabled: config.isPreviewProviderEnabled,
                 isPeripheryCommentEnabled: config.isPeripheryCommentEnabled,
                 isNimbleEnabled: config.isNimbleEnabled

diff --git a/Sources/NodesGenerator/Resources/Stencils/ViewController-SwiftUI.stencil b/Sources/NodesGenerator/Resources/Stencils/ViewController-SwiftUI.stencil
@@ -52,7 +52,12 @@ internal struct {{ node_name }}View {
     internal weak var receiver: {{ node_name }}Receiver?
 
     /// The Store instance.
-    private let store: Any{{ store_prefix }}ViewStateStore<{{ node_name }}ViewState>
+    {% if store_property_wrapper %}
+    {{ store_property_wrapper }}
+    private var store: Any{{ store_prefix }}ViewStateStore<{{ node_name }}ViewState>
+    {% else %}
+    private let store: AnyViewStateStore<{{ node_name }}ViewState>
+    {% endif %}
 
     /// The initializer.
     ///

diff --git a/Sources/NodesGenerator/StencilContexts/NodeStencilContext.swift b/Sources/NodesGenerator/StencilContexts/NodeStencilContext.swift
@@ -2,6 +2,8 @@
 //  Copyright © 2021 Tinder (Match Group, LLC)
 //
 
+// swiftlint:disable file_length
+
 // swiftlint:disable:next type_body_length
 public struct NodeStencilContext: StencilContext {
 
@@ -47,6 +49,7 @@ public struct NodeStencilContext: StencilContext {
     private let contextGenericTypes: [String]
     private let workerGenericTypes: [String]
     private let storePrefix: String
+    private let storePropertyWrapper: String
     private let isPreviewProviderEnabled: Bool
     private let isPeripheryCommentEnabled: Bool
     private let isNimbleEnabled: Bool
@@ -96,6 +99,7 @@ public struct NodeStencilContext: StencilContext {
             "context_generic_types": contextGenericTypes,
             "worker_generic_types": workerGenericTypes,
             "store_prefix": storePrefix,
+            "store_property_wrapper": storePropertyWrapper,
             "is_preview_provider_enabled": isPreviewProviderEnabled,
             "is_periphery_comment_enabled": isPeripheryCommentEnabled,
             "is_nimble_enabled": isNimbleEnabled
@@ -146,6 +150,7 @@ public struct NodeStencilContext: StencilContext {
         contextGenericTypes: [String],
         workerGenericTypes: [String],
         storePrefix: String,
+        storePropertyWrapper: String,
         isPreviewProviderEnabled: Bool,
         isPeripheryCommentEnabled: Bool,
         isNimbleEnabled: Bool
@@ -194,12 +199,14 @@ public struct NodeStencilContext: StencilContext {
             contextGenericTypes: contextGenericTypes,
             workerGenericTypes: workerGenericTypes,
             storePrefix: storePrefix,
+            storePropertyWrapper: storePropertyWrapper,
             isPreviewProviderEnabled: isPreviewProviderEnabled,
             isPeripheryCommentEnabled: isPeripheryCommentEnabled,
             isNimbleEnabled: isNimbleEnabled
         )
     }
 
+    // swiftlint:disable:next function_body_length
     public init(
         preset: Preset,
         fileHeader: String,
@@ -238,6 +245,7 @@ public struct NodeStencilContext: StencilContext {
         contextGenericTypes: [String],
         workerGenericTypes: [String],
         storePrefix: String,
+        storePropertyWrapper: String,
         isPreviewProviderEnabled: Bool,
         isPeripheryCommentEnabled: Bool,
         isNimbleEnabled: Bool
@@ -288,6 +296,7 @@ public struct NodeStencilContext: StencilContext {
             contextGenericTypes: contextGenericTypes,
             workerGenericTypes: workerGenericTypes,
             storePrefix: storePrefix,
+            storePropertyWrapper: storePropertyWrapper,
             isPreviewProviderEnabled: isPreviewProviderEnabled,
             isPeripheryCommentEnabled: isPeripheryCommentEnabled,
             isNimbleEnabled: isNimbleEnabled
@@ -338,6 +347,7 @@ public struct NodeStencilContext: StencilContext {
         contextGenericTypes: [String],
         workerGenericTypes: [String],
         storePrefix: String,
+        storePropertyWrapper: String,
         isPreviewProviderEnabled: Bool,
         isPeripheryCommentEnabled: Bool,
         isNimbleEnabled: Bool
@@ -386,8 +396,11 @@ public struct NodeStencilContext: StencilContext {
         self.contextGenericTypes = contextGenericTypes
         self.workerGenericTypes = workerGenericTypes
         self.storePrefix = storePrefix
+        self.storePropertyWrapper = storePropertyWrapper
         self.isPreviewProviderEnabled = isPreviewProviderEnabled
         self.isPeripheryCommentEnabled = isPeripheryCommentEnabled
         self.isNimbleEnabled = isNimbleEnabled
     }
 }
+
+// swiftlint:enable file_length
diff --git a/Sources/NodesGenerator/XcodeTemplatePermutations/NodeXcodeTemplatePermutation.swift b/Sources/NodesGenerator/XcodeTemplatePermutations/NodeXcodeTemplatePermutation.swift
@@ -58,6 +58,7 @@ internal struct NodeXcodeTemplatePermutation: XcodeTemplatePermutation {
             contextGenericTypes: config.contextGenericTypes,
             workerGenericTypes: config.workerGenericTypes,
             storePrefix: config.storePrefix,
+            storePropertyWrapper: config.storePropertyWrapper,
             isPreviewProviderEnabled: config.isPreviewProviderEnabled,
             isPeripheryCommentEnabled: config.isPeripheryCommentEnabled,
             isNimbleEnabled: config.isNimbleEnabled

diff --git a/Tests/NodesGeneratorTests/Support/TestFactories.swift b/Tests/NodesGeneratorTests/Support/TestFactories.swift
@@ -105,6 +105,7 @@ extension TestFactories {
             contextGenericTypes: .mock(with: "contextGenericType", count: mockCount),
             workerGenericTypes: .mock(with: "workerGenericType", count: mockCount),
             storePrefix: mockCount > 0 ? "<storePrefix>" : "",
+            storePropertyWrapper: mockCount > 0 ? "<storePropertyWrapper>" : "",
             isPreviewProviderEnabled: mockCount > 0,
             isPeripheryCommentEnabled: mockCount > 0,
             isNimbleEnabled: mockCount > 0
@@ -153,6 +154,7 @@ extension TestFactories {
             contextGenericTypes: .mock(with: "contextGenericType", count: mockCount),
             workerGenericTypes: .mock(with: "workerGenericType", count: mockCount),
             storePrefix: mockCount > 0 ? "<storePrefix>" : "",
+            storePropertyWrapper: mockCount > 0 ? "<storePropertyWrapper>" : "",
             isPreviewProviderEnabled: mockCount > 0,
             isPeripheryCommentEnabled: mockCount > 0,
             isNimbleEnabled: mockCount > 0

diff --git a/...sGeneratorTests/__Snapshots__/StencilContextsTests/testNodePresetRootStencilContext.1.txt b/...sGeneratorTests/__Snapshots__/StencilContextsTests/testNodePresetRootStencilContext.1.txt
@@ -1,4 +1,4 @@
-▿ 46 key/value pairs
+▿ 47 key/value pairs
   ▿ (2 elements)
     - key: "analytics_imports"
     ▿ value: 1 element
@@ -111,6 +111,9 @@
   ▿ (2 elements)
     - key: "store_prefix"
     - value: "<storePrefix>"
+  ▿ (2 elements)
+    - key: "store_property_wrapper"
+    - value: "<storePropertyWrapper>"
   ▿ (2 elements)
     - key: "view_controllable_flow_type"
     - value: "<viewControllableFlowType>"

diff --git a/Tests/NodesGeneratorTests/__Snapshots__/StencilContextsTests/testNodeStencilContext.1.txt b/Tests/NodesGeneratorTests/__Snapshots__/StencilContextsTests/testNodeStencilContext.1.txt
@@ -1,4 +1,4 @@
-▿ 46 key/value pairs
+▿ 47 key/value pairs
   ▿ (2 elements)
     - key: "analytics_imports"
     ▿ value: 1 element
@@ -111,6 +111,9 @@
   ▿ (2 elements)
     - key: "store_prefix"
     - value: "<storePrefix>"
+  ▿ (2 elements)
+    - key: "store_property_wrapper"
+    - value: "<storePropertyWrapper>"
   ▿ (2 elements)
     - key: "view_controllable_flow_type"
     - value: "<viewControllableFlowType>"

diff --git a/...GeneratorTests/__Snapshots__/StencilContextsTests/testNodeStencilContext_withPlugin.1.txt b/...GeneratorTests/__Snapshots__/StencilContextsTests/testNodeStencilContext_withPlugin.1.txt
@@ -1,4 +1,4 @@
-▿ 46 key/value pairs
+▿ 47 key/value pairs
   ▿ (2 elements)
     - key: "analytics_imports"
     ▿ value: 1 element
@@ -113,6 +113,9 @@
   ▿ (2 elements)
     - key: "store_prefix"
     - value: "<storePrefix>"
+  ▿ (2 elements)
+    - key: "store_property_wrapper"
+    - value: "<storePropertyWrapper>"
   ▿ (2 elements)
     - key: "view_controllable_flow_type"
     - value: "<viewControllableFlowType>"

diff --git a/...pshots__/StencilRendererTests/testRenderNode.ViewController-AppKitSwiftUI-mockCount-1.txt b/...pshots__/StencilRendererTests/testRenderNode.ViewController-AppKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...pshots__/StencilRendererTests/testRenderNode.ViewController-AppKitSwiftUI-mockCount-2.txt b/...pshots__/StencilRendererTests/testRenderNode.ViewController-AppKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...apshots__/StencilRendererTests/testRenderNode.ViewController-UIKitSwiftUI-mockCount-1.txt b/...apshots__/StencilRendererTests/testRenderNode.ViewController-UIKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...apshots__/StencilRendererTests/testRenderNode.ViewController-UIKitSwiftUI-mockCount-2.txt b/...apshots__/StencilRendererTests/testRenderNode.ViewController-UIKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...encilRendererTests/testRenderNode_withPlugin.ViewController-AppKitSwiftUI-mockCount-1.txt b/...encilRendererTests/testRenderNode_withPlugin.ViewController-AppKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...encilRendererTests/testRenderNode_withPlugin.ViewController-AppKitSwiftUI-mockCount-2.txt b/...encilRendererTests/testRenderNode_withPlugin.ViewController-AppKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...tencilRendererTests/testRenderNode_withPlugin.ViewController-UIKitSwiftUI-mockCount-1.txt b/...tencilRendererTests/testRenderNode_withPlugin.ViewController-UIKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...tencilRendererTests/testRenderNode_withPlugin.ViewController-UIKitSwiftUI-mockCount-2.txt b/...tencilRendererTests/testRenderNode_withPlugin.ViewController-UIKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...dererTests/testRenderNode_withPluginAndTests.ViewController-AppKitSwiftUI-mockCount-1.txt b/...dererTests/testRenderNode_withPluginAndTests.ViewController-AppKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...dererTests/testRenderNode_withPluginAndTests.ViewController-AppKitSwiftUI-mockCount-2.txt b/...dererTests/testRenderNode_withPluginAndTests.ViewController-AppKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...ndererTests/testRenderNode_withPluginAndTests.ViewController-UIKitSwiftUI-mockCount-1.txt b/...ndererTests/testRenderNode_withPluginAndTests.ViewController-UIKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...ndererTests/testRenderNode_withPluginAndTests.ViewController-UIKitSwiftUI-mockCount-2.txt b/...ndererTests/testRenderNode_withPluginAndTests.ViewController-UIKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...tencilRendererTests/testRenderNode_withTests.ViewController-AppKitSwiftUI-mockCount-1.txt b/...tencilRendererTests/testRenderNode_withTests.ViewController-AppKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...tencilRendererTests/testRenderNode_withTests.ViewController-AppKitSwiftUI-mockCount-2.txt b/...tencilRendererTests/testRenderNode_withTests.ViewController-AppKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...StencilRendererTests/testRenderNode_withTests.ViewController-UIKitSwiftUI-mockCount-1.txt b/...StencilRendererTests/testRenderNode_withTests.ViewController-UIKitSwiftUI-mockCount-1.txt
@@ -38,7 +38,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...StencilRendererTests/testRenderNode_withTests.ViewController-UIKitSwiftUI-mockCount-2.txt b/...StencilRendererTests/testRenderNode_withTests.ViewController-UIKitSwiftUI-mockCount-2.txt
@@ -39,7 +39,8 @@ internal struct <nodeName>View {
     internal weak var receiver: <nodeName>Receiver?
 
     /// The Store instance.
-    private let store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
+    <storePropertyWrapper>
+    private var store: Any<storePrefix>ViewStateStore<<nodeName>ViewState>
 
     /// The initializer.
     ///

diff --git a/...PermutationTests/testNodeXcodeTemplatePermutation.AppKit-SwiftUI-CreatedForPluginList.txt b/...PermutationTests/testNodeXcodeTemplatePermutation.AppKit-SwiftUI-CreatedForPluginList.txt
@@ -74,6 +74,7 @@
     ▿ stateImports: 1 element
       - "<baseImport>"
     - storePrefix: ""
+    - storePropertyWrapper: ""
     - viewControllableFlowType: "<viewControllableFlowType>"
     - viewControllableMockContents: "<viewControllableMockContents>"
     - viewControllableType: "<viewControllableType>"

diff --git a/...shots__/XcodeTemplatePermutationTests/testNodeXcodeTemplatePermutation.AppKit-SwiftUI.txt b/...shots__/XcodeTemplatePermutationTests/testNodeXcodeTemplatePermutation.AppKit-SwiftUI.txt
@@ -74,6 +74,7 @@
     ▿ stateImports: 1 element
       - "<baseImport>"
     - storePrefix: ""
+    - storePropertyWrapper: ""
     - viewControllableFlowType: "<viewControllableFlowType>"
     - viewControllableMockContents: "<viewControllableMockContents>"
     - viewControllableType: "<viewControllableType>"

diff --git a/...s/__Snapshots__/XcodeTemplatePermutationTests/testNodeXcodeTemplatePermutation.AppKit.txt b/...s/__Snapshots__/XcodeTemplatePermutationTests/testNodeXcodeTemplatePermutation.AppKit.txt
@@ -74,6 +74,7 @@
     ▿ stateImports: 1 element
       - "<baseImport>"
     - storePrefix: ""
+    - storePropertyWrapper: ""
     - viewControllableFlowType: "<viewControllableFlowType>"
     - viewControllableMockContents: "<viewControllableMockContents>"
     - viewControllableType: "<viewControllableType>"

diff --git a/...eTemplatePermutationTests/testNodeXcodeTemplatePermutation.AppKitCreatedForPluginList.txt b/...eTemplatePermutationTests/testNodeXcodeTemplatePermutation.AppKitCreatedForPluginList.txt
@@ -74,6 +74,7 @@
     ▿ stateImports: 1 element
       - "<baseImport>"
     - storePrefix: ""
+    - storePropertyWrapper: ""
     - viewControllableFlowType: "<viewControllableFlowType>"
     - viewControllableMockContents: "<viewControllableMockContents>"
     - viewControllableType: "<viewControllableType>"

diff --git a/...s/__Snapshots__/XcodeTemplatePermutationTests/testNodeXcodeTemplatePermutation.Custom.txt b/...s/__Snapshots__/XcodeTemplatePermutationTests/testNodeXcodeTemplatePermutation.Custom.txt
@@ -74,6 +74,7 @@
     ▿ stateImports: 1 element
       - "<baseImport>"
     - storePrefix: ""
+    - storePropertyWrapper: ""
     - viewControllableFlowType: "<viewControllableFlowType>"
     - viewControllableMockContents: "<viewControllableMockContents>"
     - viewControllableType: "<viewControllableType>"

diff --git a/...eTemplatePermutationTests/testNodeXcodeTemplatePermutation.CustomCreatedForPluginList.txt b/...eTemplatePermutationTests/testNodeXcodeTemplatePermutation.CustomCreatedForPluginList.txt
@@ -74,6 +74,7 @@
     ▿ stateImports: 1 element
       - "<baseImport>"
     - storePrefix: ""
+    - storePropertyWrapper: ""
     - viewControllableFlowType: "<viewControllableFlowType>"
     - viewControllableMockContents: "<viewControllableMockContents>"
     - viewControllableType: "<viewControllableType>"