Merge branch 'feature/carousel_form_changes' into 'develop'

Carousel form changes

See merge request BPHV_MIPS/mvm_core_ui!670

MVMCoreUI/Atomic/Molecules/Items/CarouselItemModel.swift

@@ -21,6 +21,9 @@ import Foundation
     public var peakingUI: Bool?
     public var peakingArrowColor: Color?
     public var analyticsData: JSONValueDictionary?
+    public var fieldValue: String?
+    
+    public func formFieldValue() -> AnyHashable? { return fieldValue }
     
     //--------------------------------------------------
     // MARK: - Keys
@@ -30,6 +33,7 @@ import Foundation
         case peakingUI
         case peakingArrowColor
         case analyticsData
+        case fieldValue
     }
 
     //--------------------------------------------------
@@ -41,6 +45,7 @@ import Foundation
         peakingUI = try typeContainer.decodeIfPresent(Bool.self, forKey: .peakingUI)
         peakingArrowColor = try typeContainer.decodeIfPresent(Color.self, forKey: .peakingArrowColor)
         analyticsData = try typeContainer.decodeIfPresent(JSONValueDictionary.self, forKey: .analyticsData)
+        fieldValue = try typeContainer.decodeIfPresent(String.self, forKey: .fieldValue)
         try super.init(from: decoder)
     }
 
@@ -50,5 +55,6 @@ import Foundation
         try container.encodeIfPresent(peakingUI, forKey: .peakingUI)
         try container.encodeIfPresent(peakingArrowColor, forKey: .peakingArrowColor)
         try container.encodeIfPresent(analyticsData, forKey: .analyticsData)
+        try container.encodeIfPresent(fieldValue, forKey: .fieldValue)
     }
 }

MVMCoreUI/Atomic/Organisms/Carousel/Carousel.swift

@@ -167,12 +167,17 @@ open class Carousel: View {
         
         registerCells(with: carouselModel, delegateObject: delegateObject)
         prepareMolecules(with: carouselModel)
+        FormValidator.setupValidation(for: carouselModel, delegate: delegateObject?.formHolderDelegate)
 
         setupPagingMolecule(carouselModel.pagingMolecule, delegateObject: delegateObject)
         
         pageIndex = carouselModel.index
         pagingView?.currentIndex = carouselModel.index
         collectionView.reloadData()
+        if let selectedIndex = carouselModel.selectedIndex {
+            let adjustedIndex = loop ? selectedIndex + 2 : selectedIndex
+            collectionView.selectItem(at: IndexPath(row: adjustedIndex, section: 0), animated: false, scrollPosition: [])
+        }
     }
     
     //--------------------------------------------------
@@ -391,8 +396,25 @@ extension Carousel: UICollectionViewDataSource {
 }
 
 extension Carousel: UICollectionViewDelegate {
+    public func collectionView(_ collectionView: UICollectionView, shouldSelectItemAt indexPath: IndexPath) -> Bool {
+        guard let cell = collectionView.cellForItem(at: indexPath) as? CollectionTemplateItemProtocol else { return false }
+        return cell.shouldSelect(at: indexPath, delegateObject: delegateObject, additionalData: nil)
+    }
+    
     open func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
-        (collectionView.cellForItem(at: indexPath) as? CollectionTemplateItemProtocol)?.didSelectCell(at: indexPath, delegateObject: delegateObject, additionalData: nil)
+        // Set the selection in the model
+        if let model = model as? CarouselModel {
+            // Adjust for looping
+            var adjustedIndex = loop ? indexPath.row - 2 : indexPath.row
+            if adjustedIndex < 0 {
+                adjustedIndex = adjustedIndex + numberOfPages
+            }
+            model.selectedIndex =  adjustedIndex
+        }
+        if let cell = collectionView.cellForItem(at: indexPath) as? CollectionTemplateItemProtocol {
+            cell.didSelectCell(at: indexPath, delegateObject: delegateObject, additionalData: nil)
+        }
+        _ = FormValidator.validate(delegate: delegateObject?.formHolderDelegate)
     }
 }
 
@@ -414,6 +436,7 @@ extension Carousel: UIScrollViewDelegate {
         if !animated {
             scrollViewDidEndScrollingAnimation(collectionView)
         }
+        _ = FormValidator.validate(delegate: delegateObject?.formHolderDelegate)
     }
     
     /// Adjusts the current contentOffset if we are going onto buffer cells while looping to help with the endless scrolling appearance.

MVMCoreUI/Atomic/Organisms/Carousel/CarouselModel.swift

@@ -9,7 +9,8 @@
 import UIKit
 
 
-@objcMembers public class CarouselModel: MoleculeModelProtocol {
+@objcMembers public class CarouselModel: MoleculeModelProtocol, FormFieldProtocol {
+    
     //--------------------------------------------------
     // MARK: - Properties
     //--------------------------------------------------
@@ -33,11 +34,31 @@ import UIKit
     public var leftPadding: CGFloat?
     public var rightPadding: CGFloat?
     public var accessibilityText: String?
-
+    public var baseValue: AnyHashable?
+    public var fieldKey: String?
+    public var groupName: String = FormValidator.defaultGroupName
+    
+    public var selectable = false
+    public var selectedIndex: Int?
+    
     public init(molecules: [MoleculeModelProtocol & CarouselItemModelProtocol]) {
         self.molecules = molecules
     }
     
+    public func formFieldValue() -> AnyHashable? {
+        guard selectable else {
+            // Use visible item value, else index
+            if let fieldValue = molecules[index].formFieldValue() {
+                return fieldValue
+            }
+            return index
+        }
+        // Use selected item value, else index
+        guard let selectedIndex = selectedIndex else { return nil }
+        guard let fieldValue = molecules[selectedIndex].formFieldValue() else { return selectedIndex }
+        return fieldValue
+    }
+    
     //--------------------------------------------------
     // MARK: - Keys
     //--------------------------------------------------
@@ -59,6 +80,10 @@ import UIKit
         case leftPadding
         case rightPadding
         case accessibilityText
+        case groupName
+        case fieldKey
+        case selectable
+        case selectedIndex
     }
     
     //--------------------------------------------------
@@ -69,6 +94,8 @@ import UIKit
         let typeContainer = try decoder.container(keyedBy: CodingKeys.self)
         molecules = try typeContainer.decodeModels(codingKey: .molecules)
         index = try typeContainer.decodeIfPresent(Int.self, forKey: .index) ?? 0
+        selectable = try typeContainer.decodeIfPresent(Bool.self, forKey: .selectable) ?? false
+        selectedIndex = try typeContainer.decodeIfPresent(Int.self, forKey: .selectedIndex)
         backgroundColor = try typeContainer.decodeIfPresent(Color.self, forKey: .backgroundColor)
         spacing = try typeContainer.decodeIfPresent(CGFloat.self, forKey: .spacing)
         border = try typeContainer.decodeIfPresent(Bool.self, forKey: .border)
@@ -86,6 +113,11 @@ import UIKit
         leftPadding = try typeContainer.decodeIfPresent(CGFloat.self, forKey: .leftPadding)
         rightPadding = try typeContainer.decodeIfPresent(CGFloat.self, forKey: .rightPadding)
         accessibilityText = try typeContainer.decodeIfPresent(String.self, forKey: .accessibilityText)
+        fieldKey = try typeContainer.decodeIfPresent(String.self, forKey: .fieldKey)
+        if let groupName = try typeContainer.decodeIfPresent(String.self, forKey: .groupName) {
+            self.groupName = groupName
+        }
+        baseValue = formFieldValue()
    }
 
    public func encode(to encoder: Encoder) throws {
@@ -105,5 +137,10 @@ import UIKit
         try container.encodeIfPresent(leftPadding, forKey: .leftPadding)
         try container.encodeIfPresent(rightPadding, forKey: .rightPadding)
         try container.encodeIfPresent(accessibilityText, forKey: .accessibilityText)
+        try container.encodeIfPresent(fieldKey, forKey: .fieldKey)
+        try container.encode(groupName, forKey: .groupName)
+        try container.encode(index, forKey: .index)
+        try container.encode(selectable, forKey: .selectable)
+        try container.encode(selectedIndex, forKey: .selectedIndex)
     }
 }

MVMCoreUI/Atomic/Protocols/ModelProtocols/CarouselItemModelProtocol.swift

@@ -11,11 +11,14 @@ import Foundation
 
 public protocol CarouselItemModelProtocol: ContainerModelProtocol {
     var analyticsData: JSONValueDictionary? { get set }
+    func formFieldValue() -> AnyHashable?
 }
+
 public extension CarouselItemModelProtocol {
     
     var analyticsData: JSONValueDictionary?  {
         get { return nil }
         set { analyticsData = newValue }
     }
+    func formFieldValue() -> AnyHashable? { return nil }
 }

MVMCoreUI/Atomic/Templates/CollectionTemplateItemProtocol.swift

@@ -19,6 +19,9 @@ public protocol CollectionTemplateItemProtocol: UICollectionViewCell {
 
     /// Called when the cell will display.
     func willDisplay()
+    
+    /// Handle the selection of cell
+    func shouldSelect(at index: IndexPath, delegateObject: MVMCoreUIDelegateObject?, additionalData: [AnyHashable: Any]?) -> Bool
 }
 
 // Default implementation does nothing
@@ -26,4 +29,8 @@ extension CollectionTemplateItemProtocol {
     public func didSelectCell(at index: IndexPath, delegateObject: MVMCoreUIDelegateObject?, additionalData: [AnyHashable: Any]?) {}
 
     public func willDisplay() {}
+    
+    public func shouldSelect(at index: IndexPath, delegateObject: MVMCoreUIDelegateObject?, additionalData: [AnyHashable: Any]?) -> Bool {
+        return false
+    }
 }

MVMCoreUI/BaseClasses/CollectionViewCell.swift

@@ -116,11 +116,15 @@ open class CollectionViewCell: UICollectionViewCell, MoleculeViewProtocol, MVMCo
     
     // MARK: - Override
     
-    open func didSelectCell(at index: IndexPath, delegateObject: MVMCoreUIDelegateObject?, additionalData: [AnyHashable : Any]?) {
+    open func shouldSelect(at index: IndexPath, delegateObject: MVMCoreUIDelegateObject?, additionalData: [AnyHashable: Any]?) -> Bool {
-        guard let action = model?.action else { return }
+        if let action = model?.action {
-        Button.performButtonAction(with: action, button: self, delegateObject: delegateObject, additionalData: additionalData)
+            Button.performButtonAction(with: action, button: self, delegateObject: delegateObject, additionalData: additionalData)
+        }
+        return false
     }
     
+    open func didSelectCell(at index: IndexPath, delegateObject: MVMCoreUIDelegateObject?, additionalData: [AnyHashable : Any]?) {}
+    
     // Column logic, set width.
     override open func preferredLayoutAttributesFitting(_ layoutAttributes: UICollectionViewLayoutAttributes) -> UICollectionViewLayoutAttributes {
         let autoLayoutAttributes = super.preferredLayoutAttributesFitting(layoutAttributes)