add common decorations and transformations for base generators

NullIsOne · NullIsOne · commit c9ad7199477a · 2023-07-27T16:40:12.000+04:00
diff --git a/Components/Sources/Collection/Extensions/CollectionContext+CollectionWrappedCell.swift b/Components/Sources/Collection/Extensions/CollectionContext+CollectionWrappedCell.swift
@@ -14,8 +14,6 @@ extension CollectionContext: BuilderContext {
     public typealias ViewType = UICollectionViewCell
     public typealias GeneratorType = CollectionCellGenerator
 
-    // TODO: - add support for other types of generators or make (decorated generator)
-
     public static func gen<Item>(_ type: Item.Type, model: Item.Model) -> GeneratorType where Item: ConfigurableItem,
                                                                                                 Item: RegistrationTypeProvider {
         Item.rddm.collectionGenerator(with: model)
diff --git a/Components/Sources/Common/Extensions/ConfigurableItem+BuilderContext.swift b/Components/Sources/Common/Extensions/ConfigurableItem+BuilderContext.swift
@@ -13,5 +13,5 @@ public extension ConfigurableItem where Self: RegistrationTypeProvider {
     static func build<Context: BuilderContext>(in ctx: Context.Type, with model: Model) -> Context.GeneratorType {
         ctx.gen(Self.self, model: model)
     }
-    
+
 }
diff --git a/Components/Sources/Table/Extensions/TableContext+TableWrappedCell.swift b/Components/Sources/Table/Extensions/TableContext+TableWrappedCell.swift
@@ -14,11 +14,9 @@ extension TableContext: BuilderContext {
     public typealias ViewType = UITableViewCell
     public typealias GeneratorType = TableCellGenerator
 
-    // TODO: - add support for other types of generators or make (decorated generator)
-
     public static func gen<Item>(_ type: Item.Type, model: Item.Model) -> GeneratorType where Item: ConfigurableItem,
                                                                                                 Item: RegistrationTypeProvider {
-                                                                                                    Item.rddm.tableGenerator(with: model)
+        Item.rddm.tableGenerator(with: model)
     }
 
     public static func gen<Item>(_ type: Item.Type, model: Item.Model) -> GeneratorType where Item: ViewType,
diff --git a/Components/Sources/Table/Extensions/TableWrappedCell+RDDM.swift b/Components/Sources/Table/Extensions/TableWrappedCell+RDDM.swift
@@ -11,8 +11,15 @@ import UIKit
 public extension StaticDataDisplayWrapper where Base: UIView & ConfigurableItem & RegistrationTypeProvider {
 
     func tableGenerator(with model: Base.Model) -> BaseCellGenerator<TableWrappedCell<Base>> {
-        TableWrappedCell<Base>.rddm.baseGenerator(with: model,
-                                                  and: .class)
+        TableWrappedCell<Base>.rddm.baseGenerator(with: model, and: .class)
+    }
+
+}
+
+public extension StaticDataDisplayWrapper where Base: UITableViewCell & ConfigurableItem & RegistrationTypeProvider {
+
+    func tableGenerator(with model: Base.Model) -> BaseCellGenerator<Base> {
+        Base.rddm.baseGenerator(with: model, and: Base.prefferedRegistration)
     }
 
 }
diff --git a/Example/ReactiveDataDisplayManager/Collection/CollectionViewController/CollectionViewController.swift b/Example/ReactiveDataDisplayManager/Collection/CollectionViewController/CollectionViewController.swift
@@ -64,14 +64,13 @@ private extension CollectionViewController {
         CollectionGenerators {
             titles.map { title -> CollectionCellGenerator in
                 // Create generator
-                let generator = TitleCollectionViewCell.rddm.calculatableHeightGenerator(with: title, referencedWidth: 100)
-                generator.didSelectEvent += {
-                    debugPrint("\(title) selected")
-                }
-                generator.didDeselectEvent += {
-                    debugPrint("\(title) deselected")
-                }
-                return generator
+                return TitleCollectionViewCell.rddm.calculatableHeightGenerator(with: title, referencedWidth: 100)
+                    .didSelectEvent {
+                        debugPrint("\(title) selected")
+                    }
+                    .didDeselectEvent {
+                        debugPrint("\(title) deselected")
+                    }
             }
         }
     }
diff --git a/Example/ReactiveDataDisplayManager/Collection/FoldableCollectionViewController/FoldableCollectionViewController.swift b/Example/ReactiveDataDisplayManager/Collection/FoldableCollectionViewController/FoldableCollectionViewController.swift
@@ -84,9 +84,9 @@ private extension FoldableCollectionViewController {
         let folder3 = makeFoldableCellGenerator(color: .lightGray, expanded: true)
 
         // Configure relationship
-        folder3.childGenerators = child3
-        folder2.childGenerators = child2 + [folder3]
-        folder1.childGenerators = child1 + [folder2]
+        folder3.children = child3
+        folder2.children = child2 + [folder3]
+        folder1.children = child1 + [folder2]
 
         // Add foldable cell generators to adapter
         let visibleGenerators = getVisibleGenerators(for: folder1)
@@ -131,7 +131,7 @@ private extension FoldableCollectionViewController {
 
     func getVisibleGenerators(for generator: CollectionCellGenerator) -> [CollectionCellGenerator] {
         if let foldableItem = generator as? CollectionFoldableItem, foldableItem.isExpanded {
-            return foldableItem.childGenerators
+            return foldableItem.children
                 .map { getVisibleGenerators(for: $0) }
                 .reduce([generator], +)
         } else {
diff --git a/Example/ReactiveDataDisplayManager/Stack/Landing/LandingStackViewController.swift b/Example/ReactiveDataDisplayManager/Stack/Landing/LandingStackViewController.swift
@@ -80,7 +80,7 @@ private extension LandingStackViewController {
                                                            alignment: .center,
                                                            distribution: .fillEqually,
                                                            spacing: 32),
-                                              childGenerators: [mainButton, secondaryButton])
+                                              children: [mainButton, secondaryButton])
 
         // Add generators to adapter
         adapter += title
diff --git a/Example/ReactiveDataDisplayManager/Stack/Views/Generators/InnerStackCellGenerator.swift b/Example/ReactiveDataDisplayManager/Stack/Views/Generators/InnerStackCellGenerator.swift
@@ -22,13 +22,13 @@ final class InnerStackCellGenerator: ViewGenerator {
     // MARK: - Properties
 
     private let model: Model
-    private let childGenerators: [ViewGenerator]
+    private let children: [ViewGenerator]
 
     // MARK: - Initialization
 
-    init(model: Model, childGenerators: [ViewGenerator]) {
+    init(model: Model, children: [ViewGenerator]) {
         self.model = model
-        self.childGenerators = childGenerators
+        self.children = children
     }
 
 }
@@ -47,7 +47,7 @@ extension InnerStackCellGenerator: ViewBuilder {
         let adapter = view.rddm.baseBuilder
             .build()
 
-        adapter += childGenerators
+        adapter += children
 
         adapter => .reload
     }
diff --git a/Example/ReactiveDataDisplayManager/Table/AllPluginsTableViewController/AllPluginsTableViewController.swift b/Example/ReactiveDataDisplayManager/Table/AllPluginsTableViewController/AllPluginsTableViewController.swift
@@ -199,7 +199,7 @@ private extension AllPluginsTableViewController {
             let generator = FoldableTableViewCell.rddm.foldableGenerator(with: .init(title: "", isExpanded: false))
 
             // Create and add child generators
-            generator.childGenerators = Constants.titles.map { TitleTableViewCell.rddm.baseGenerator(with: $0) }
+            generator.children = Constants.titles.map { TitleTableViewCell.rddm.baseGenerator(with: $0) }
 
             // Add generator to adapter
             adapter += generator
diff --git a/Example/ReactiveDataDisplayManager/Table/FoldableTableViewController/FoldableTableViewController.swift b/Example/ReactiveDataDisplayManager/Table/FoldableTableViewController/FoldableTableViewController.swift
@@ -89,7 +89,7 @@ private extension FoldableTableViewController {
         let generator = FoldableTableViewCell.rddm.foldableGenerator(with: .init(title: id, isExpanded: false))
 
         // Create and add child generators
-        generator.childGenerators = Constants.titleForSubcells.map { TitleTableViewCell.rddm.baseGenerator(with: $0) }
+        generator.children = Constants.titleForSubcells.map { TitleTableViewCell.rddm.baseGenerator(with: $0) }
         return generator
     }
 
diff --git a/Example/ReactiveDataDisplayManager/Table/GravityTableViewController/GravityTableViewController.swift b/Example/ReactiveDataDisplayManager/Table/GravityTableViewController/GravityTableViewController.swift
@@ -72,7 +72,7 @@ private extension GravityTableViewController {
 
     func makeGravityFoldableCellGenerator(with heaviness: Int) -> GravityFoldableCellGenerator {
         let generator = GravityFoldableCellGenerator(heaviness: heaviness)
-        generator.childGenerators = [
+        generator.children = [
             makeGravityCellGenerator(with: 1),
             makeGravityCellGenerator(with: 2)
         ]
diff --git a/ReactiveDataDisplayManagerTests/Mocks/AutoMockable.generated.swift b/ReactiveDataDisplayManagerTests/Mocks/AutoMockable.generated.swift
@@ -102,7 +102,7 @@ class CollectionFoldableItemMock: CollectionFoldableItem {
         set(value) { underlyingIsExpanded = value }
     }
     var underlyingIsExpanded: Bool!
-    var childGenerators: [CollectionCellGenerator] = []
+    var children: [CollectionCellGenerator] = []
     var labelStrategy: AccessibilityStringStrategy {
         get { return underlyingLabelStrategy }
         set(value) { underlyingLabelStrategy = value }
diff --git a/ReactiveDataDisplayManagerTests/Table/Manager/GravityFoldingHeaderGenerator.swift b/ReactiveDataDisplayManagerTests/Table/Manager/GravityFoldingHeaderGenerator.swift
@@ -16,7 +16,7 @@ final class GravityFoldingHeaderGenerator: GravityTableCellGenerator, FoldableIt
 
     var didFoldEvent = Event<Bool>()
     var isExpanded = true
-    var childGenerators = [TableCellGenerator]()
+    var children = [TableCellGenerator]()
 
     // MARK: - GravityTableCellGenerator
 
@@ -93,7 +93,7 @@ final class GravityFoldingTableDataDisplayManagerTests: XCTestCase {
         let childGenerator3 = GravityCellGenerator()
 
         let header = GravityFoldingHeaderGenerator()
-        header.childGenerators = [childGenerator1, childGenerator2, childGenerator3]
+        header.children = [childGenerator1, childGenerator2, childGenerator3]
         header.isExpanded = true
 
         ddm.addCellGenerators([header, childGenerator1, childGenerator2, childGenerator3])
@@ -116,7 +116,7 @@ final class GravityFoldingTableDataDisplayManagerTests: XCTestCase {
         let childGenerator3 = GravityCellGenerator()
 
         let header = GravityFoldingHeaderGenerator()
-        header.childGenerators = [childGenerator1, childGenerator2, childGenerator3]
+        header.children = [childGenerator1, childGenerator2, childGenerator3]
         header.isExpanded = false
 
         ddm.addCellGenerator(header)
diff --git a/Source/Collection/Generators/BaseCollectionCellGenerator.swift b/Source/Collection/Generators/BaseCollectionCellGenerator.swift
@@ -63,3 +63,72 @@ extension BaseCollectionCellGenerator: CollectionCellGenerator {
     }
 
 }
+
+// MARK: - Decorations
+
+public extension BaseCollectionCellGenerator {
+
+    /// - Parameter isNeedDeselect: defines if cell should be deselected after selection
+    func isNeedDeselect(_ isNeedDeselect: Bool) -> Self {
+        self.isNeedDeselect = isNeedDeselect
+        return self
+    }
+
+    /// - Parameter closure: closure that will be called when cell is selected
+    func didSelectEvent(_ closure: @escaping () -> Void) -> Self {
+        self.didSelectEvent.addListner(closure)
+        return self
+    }
+
+    /// - Parameter closure: closure that will be called when cell is deselected in multiple selection mode
+    func didDeselectEvent(_ closure: @escaping () -> Void) -> Self {
+        self.didDeselectEvent.addListner(closure)
+        return self
+    }
+
+}
+
+// MARK: - Transformations
+
+public extension BaseCollectionCellGenerator where Cell: FoldableStateHolder {
+
+    /// Creates FoldableCellGenerator with predefined children
+    /// - Parameter children: array of children
+    func asFoldable(_ children: [CollectionCellGenerator]) -> FoldableCollectionCellGenerator<Cell> {
+        return .init(with: model,
+                     registerType: registerType)
+            .children(children)
+    }
+
+    /// Creates FoldableCellGenerator with children generated by resultBuilder
+    /// - Parameter content: resultBuilder based closure that returns array of children
+    func asFoldable(@GeneratorsBuilder<CollectionCellGenerator>_ content: @escaping (CollectionContext.Type) -> [CollectionCellGenerator]) -> FoldableCollectionCellGenerator<Cell> {
+        return .init(with: model,
+                     registerType: registerType)
+            .children(content)
+    }
+
+}
+
+public extension BaseCollectionCellGenerator where Cell.Model: Equatable {
+
+    /// Creates DiffableCellGenerator with constant but unique Id
+    ///  - Parameter uniqueId: uniqueId to identify cell
+    func asDiffable(uniqueId: AnyHashable) -> DiffableCollectionCellGenerator<Cell> {
+        .init(uniqueId: uniqueId,
+              with: model,
+              registerType: registerType)
+    }
+
+}
+
+public extension BaseCollectionCellGenerator where Cell.Model: Equatable & IdOwner {
+
+    /// Creates DiffableCellGenerator with uniqueId from model
+    func asDiffable() -> DiffableCollectionCellGenerator<Cell> {
+        .init(uniqueId: model.id,
+              with: model,
+              registerType: registerType)
+    }
+
+}
diff --git a/Source/Collection/Generators/FoldableCollectionCellGenerator.swift b/Source/Collection/Generators/FoldableCollectionCellGenerator.swift
@@ -21,7 +21,7 @@ open class FoldableCollectionCellGenerator<Cell: UICollectionViewCell & Configur
     open var isExpanded = false
 
     /// Child generators which can be folded/unfolded
-    open var childGenerators: [CollectionCellGenerator] = []
+    open var children: [CollectionCellGenerator] = []
 
     // MARK: - BaseCollectionCellGenerator
 
@@ -36,3 +36,33 @@ open class FoldableCollectionCellGenerator<Cell: UICollectionViewCell & Configur
     }
 
 }
+
+// MARK: - Decorations
+
+public extension FoldableCollectionCellGenerator {
+
+    /// - Parameter isExpanded: folded/unfolded state
+    func isExpanded(_ isExpanded: Bool) -> Self {
+        self.isExpanded = isExpanded
+        return self
+    }
+
+    /// - Parameter closure: handler closure for expand/collapse events
+    func didFoldEvent(_ closure: @escaping (Bool) -> Void) -> Self {
+        self.didFoldEvent.addListner(closure)
+        return self
+    }
+
+    /// - Parameter children: array of child generators
+    func children(_ children: [CollectionCellGenerator]) -> Self {
+        self.children = children
+        return self
+    }
+
+    /// - Parameter content: resultBuilder based closure that returns an array of child generators
+    func children(@GeneratorsBuilder<CollectionCellGenerator>_ content: @escaping (CollectionContext.Type) -> [CollectionCellGenerator]) -> Self {
+        self.children = content(CollectionContext.self)
+        return self
+    }
+
+}
diff --git a/Source/Collection/Plugins/PluginAction/CollectionFoldablePlugin.swift b/Source/Collection/Plugins/PluginAction/CollectionFoldablePlugin.swift
@@ -21,7 +21,7 @@ public class CollectionFoldablePlugin: BaseCollectionPlugin<CollectionEvent> {
                 return
             }
 
-            let visibleGenerators = foldable.childGenerators
+            let visibleGenerators = foldable.children
                 .map { getVisibleGenerators(for: $0) }
                 .reduce([], +)
 
@@ -50,7 +50,7 @@ private extension CollectionFoldablePlugin {
 
     func getVisibleGenerators(for generator: CollectionCellGenerator) -> [CollectionCellGenerator] {
         if let foldableItem = generator as? CollectionFoldableItem, foldableItem.isExpanded {
-            return foldableItem.childGenerators
+            return foldableItem.children
                 .map { getVisibleGenerators(for: $0) }
                 .reduce([generator], +)
         } else {
diff --git a/Source/Collection/Protocols/CollectionFoldableItem.swift b/Source/Collection/Protocols/CollectionFoldableItem.swift
@@ -12,10 +12,10 @@ import UIKit
 public protocol CollectionFoldableItem: AnyObject, AccessibilityStrategyProvider {
     var didFoldEvent: Event<Bool> { get }
     var isExpanded: Bool { get set }
-    var childGenerators: [CollectionCellGenerator] { get set }
+    var children: [CollectionCellGenerator] { get set }
 }
 
 public extension CollectionFoldableItem {
     var labelStrategy: AccessibilityStringStrategy { .ignored }
-    var traitsStrategy: AccessibilityTraitsStrategy { childGenerators.isEmpty ? .ignored : .just(.button) }
+    var traitsStrategy: AccessibilityTraitsStrategy { children.isEmpty ? .ignored : .just(.button) }
 }
diff --git a/Source/Protocols/Plugins/Generators/FoldableItem.swift b/Source/Protocols/Plugins/Generators/FoldableItem.swift
@@ -26,7 +26,7 @@ public protocol FoldableItem: AnyObject, AccessibilityStrategyProvider {
     var isExpanded: Bool { get set }
 
     /// Generators describing cells to be inserted in expanded state
-    var childGenerators: [TableCellGenerator] { get set }
+    var children: [TableCellGenerator] { get set }
 
 }
 
@@ -36,5 +36,5 @@ public extension FoldableItem {
     }
 
     var labelStrategy: AccessibilityStringStrategy { .ignored }
-    var traitsStrategy: AccessibilityTraitsStrategy { childGenerators.isEmpty ? .ignored : .just(.button) }
+    var traitsStrategy: AccessibilityTraitsStrategy { children.isEmpty ? .ignored : .just(.button) }
 }
diff --git a/Source/Stack/Generators/BaseViewGenerator.swift b/Source/Stack/Generators/BaseViewGenerator.swift
@@ -7,11 +7,11 @@
 
 import UIKit
 
-final public class EmptyViewGenerator<View: ConfigurableItem & RegistrationTypeProvider>: AccessoryViewGenerator {
+public final class EmptyViewGenerator<View: ConfigurableItem & RegistrationTypeProvider>: AccessoryViewGenerator {
 
     public typealias ViewType = View
 
-    public init() {}
+    public init() { }
 
     public func generate() -> View {
         switch View.prefferedRegistration {
diff --git a/Source/Table/Generators/BaseCellGenerator.swift b/Source/Table/Generators/BaseCellGenerator.swift
diff --git a/Source/Table/Generators/FoldableCellGenerator.swift b/Source/Table/Generators/FoldableCellGenerator.swift
diff --git a/Source/Table/Plugins/PluginAction/TableFoldablePlugin.swift b/Source/Table/Plugins/PluginAction/TableFoldablePlugin.swift

Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,5 @@ public extension ConfigurableItem where Self: RegistrationTypeProvider {`
`13`	`13`	`static func build<Context: BuilderContext>(in ctx: Context.Type, with model: Model) -> Context.GeneratorType {`
`14`	`14`	`ctx.gen(Self.self, model: model)`
`15`	`15`	`}`
`16`		`-`
	`16`	`+`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,13 +22,13 @@ final class InnerStackCellGenerator: ViewGenerator {`
`22`	`22`	`// MARK: - Properties`
`23`	`23`
`24`	`24`	`private let model: Model`
`25`		`- private let childGenerators: [ViewGenerator]`
	`25`	`+ private let children: [ViewGenerator]`
`26`	`26`
`27`	`27`	`// MARK: - Initialization`
`28`	`28`
`29`		`- init(model: Model, childGenerators: [ViewGenerator]) {`
	`29`	`+ init(model: Model, children: [ViewGenerator]) {`
`30`	`30`	`self.model = model`
`31`		`- self.childGenerators = childGenerators`
	`31`	`+ self.children = children`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`}`
`@@ -47,7 +47,7 @@ extension InnerStackCellGenerator: ViewBuilder {`
`47`	`47`	`let adapter = view.rddm.baseBuilder`
`48`	`48`	`.build()`
`49`	`49`
`50`		`- adapter += childGenerators`
	`50`	`+ adapter += children`
`51`	`51`
`52`	`52`	`adapter => .reload`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ private extension FoldableTableViewController {`
`89`	`89`	`let generator = FoldableTableViewCell.rddm.foldableGenerator(with: .init(title: id, isExpanded: false))`
`90`	`90`
`91`	`91`	`// Create and add child generators`
`92`		`- generator.childGenerators = Constants.titleForSubcells.map { TitleTableViewCell.rddm.baseGenerator(with: $0) }`
	`92`	`+ generator.children = Constants.titleForSubcells.map { TitleTableViewCell.rddm.baseGenerator(with: $0) }`
`93`	`93`	`return generator`
`94`	`94`	`}`
`95`	`95`