Updated docs and protector lever for some properties. Added SPDiffableCollectionActionableItem.

Author: ivanvorobei

Example iOS/Controllers/DiffableTableController.swift

@@ -20,6 +20,7 @@
 // SOFTWARE.
 
 import UIKit
+import SPDiffable
 
 @available(iOS 13.0, *)
 class DiffableTableController: SPDiffableTableController, SPDiffableTableMediator {

Example iOS/Controllers/RootController.swift

@@ -20,6 +20,7 @@
 // SOFTWARE.
 
 import UIKit
+import SPDiffable
 
 @available(iOS 13.0, *)
 class RootController: DiffableTableController {
@@ -69,13 +70,15 @@ class RootController: DiffableTableController {
             header: SPDiffableTextHeaderFooter(text: "Presenter"),
             footer: SPDiffableTextHeaderFooter(text: "Push in navigation processing by table controller. Sometimes you need manually deselect cell."),
             items: [
-                SPDiffableTableRow(text: "Basic Deselect", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
+                SPDiffableTableRow(text: "Deselect", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
                     guard let self = self else { return }
                     self.tableView.deselectRow(at: indexPath, animated: true)
                 }),
-                SPDiffableTableRow(text: "Basic Push", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
+                SPDiffableTableRow(text: "Push", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
                     guard let self = self else { return }
-                    self.tableView.deselectRow(at: indexPath, animated: true)
+                    let controller = UIViewController()
+                    controller.view.backgroundColor = .secondarySystemGroupedBackground
+                    self.navigationController?.pushViewController(controller, animated: true)
                 })
             ]
         )

Example iOS/Controllers/SideBarController.swift

@@ -20,13 +20,14 @@
 // SOFTWARE.
 
 import UIKit
+import SPDiffable
 
 @available(iOS 14, *)
 class SidebarController: SPDiffableSideBarController {
 
     override func viewDidLoad() {
         super.viewDidLoad()
-        setCellProviders([SPDiffableCollectionCellProviders.sideBar], sections: content)
+        setCellProviders(SPDiffableCollectionCellProviders.sideBar, sections: content)
     }
 
     enum Section: String {

Readme.md

@@ -17,6 +17,7 @@ If you like the project, don't forget to `put star ★` and follow me on GitHub:
     - [How it work](#usage)
     - [Apply content](#apply-content)
     - [Mediator](#mediator)
+    - [Diffable Delegate](#diffable-delegate)
     - [Sidebar](#sidebar)
 - [Ready Use](#ready-use)
     - [Example](#ready-use)
@@ -62,15 +63,10 @@ For work with diffable need create model (inside project you found some ready-us
 
 New model shoud extend from basic class `SPDiffableItem`:
 
-```swift
-class LocationRowModel: SPDiffableItem {}
-```
-
-After it add properties, which you want use. For example:
-
 ```swift
 class LocationRowModel: SPDiffableItem {
 
+    // Add properties, which you need
     public var city: String
     public var adress: String?
 }
@@ -79,59 +75,67 @@ class LocationRowModel: SPDiffableItem {
 Last step, create table controller class and extend of `SPDiffableTableController`. Create custom cell provider, it doing convert it data to table cell:
 
 ```swift
+class DiffableTableController: SPDiffableTableController {
 
-override func viewDidLoad() {
-    super.viewDidLoad()
-    
-    // Register cell for usage it in table view
-    tableView.register(LocationTableCell.self, forCellReuseIdentifier: "LocationTableCell")
-    
-    // Cell provider for `LocationRowModel`
-    let locationCellProvider: SPDiffableTableCellProvider = { (tableView, indexPath, model) -> UITableViewCell? in
-        switch model {
-        case let model as TableRowModel:
-            let cell = tableView.dequeueReusableCell(withIdentifier: "LocationTableCell", for: indexPath) as! LocationTableCell
-            cell.textLabel?.text = model.city
-            cell.detailTextLabel?.text = model.adress
-            return cell
-        default:
-            return nil
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        
+        // Register cell for usage it in table view
+        tableView.register(LocationTableCell.self, forCellReuseIdentifier: "LocationTableCell")
+        
+        // Cell provider for `LocationRowModel`
+        let locationCellProvider: SPDiffableTableCellProvider = { (tableView, indexPath, model) -> UITableViewCell? in
+            switch model {
+            case let model as TableRowModel:
+                let cell = tableView.dequeueReusableCell(withIdentifier: "LocationTableCell", for: indexPath) as! LocationTableCell
+                cell.textLabel?.text = model.city
+                cell.detailTextLabel?.text = model.adress
+                return cell
+            default:
+                return nil
+            }
         }
+        
+        // Pass cell provider and content. 
+        // About content you can read in next section.
+        setCellProviders([locationCellProvider], sections: content)
     }
-    
-    // Pass cell provider and content. 
-    // About content you can read next.
-    setCellProviders([locationCellProvider], sections: content)
 }
 ```
-In project available models for like `SPDiffableTableRow` and other with ready-use properties. Also you can use default cell provider if using project's models. For get it call `SPDiffableTableCellProviders.default`.
 
-### Apply Content
+Now ready model and convert it to views. Time to add content. Read next section.
+
+#### Apply Content
 
-Now table support models and custom cell provider. We can apply diffable content with animation (or not).
-Create section class:
+Now table support models and custom cell provider. You can apply diffable content with animation (or not).
+Create content:
 
 ```swift
-let section = SPDiffableSection(
-    identifier: "example section",
-    header: SPDiffableTextHeaderFooter(text: "Header"),
-    footer: SPDiffableTextHeaderFooter(text: "Footer"),
-    items: [
-        LocationRowModel(city: "Minsk", adress: "Frunze Pr., bld. 47, appt. 7"),
-        LocationRowModel(city: "Shanghai", adress: "Ting Wei Gong Lu 9299long 168hao"),
-        LocationRowModel(city: "London", adress: "94  Whitby Road")
-    ]
-)
 
-let content = [section]
+var content: [SPDiffableSection] {
+    let section = SPDiffableSection(
+        identifier: "example section",
+        header: SPDiffableTextHeaderFooter(text: "Header"),
+        footer: SPDiffableTextHeaderFooter(text: "Footer"),
+        items: [
+            LocationRowModel(city: "Minsk", adress: "Frunze Pr., bld. 47, appt. 7"),
+            LocationRowModel(city: "Shanghai", adress: "Ting Wei Gong Lu 9299long 168hao"),
+            LocationRowModel(city: "London", adress: "94  Whitby Road")
+        ]
+    )
+
+    let content = [section]
+    return content
+}
 ```
 
-You can add more cells or sections. Last step - apply:
+You can add more items or sections. Last step - apply:
 
 ```swift
 diffableDataSource?.apply(sections: content, animating: true)
 ```
 
+Call this when you need update content. When you call `setCellProviders`, it set content by default without animation.
 That all. You can each time create new order or count cells and it automatically show with diffable animation.
 
 ### Mediator
@@ -159,6 +163,28 @@ func diffableTableView(_ tableView: UITableView, titleForHeaderInSection section
 
 In protocol you can find more methods, like `canEdit` and other.
 
+### Diffable Delegate
+
+For handle some useful extensions, you can use delegates `SPDiffableTableDelegate`, `SPDiffableCollectionDelegate`. For example, when you need get which model did select, use this:
+
+```swift
+class DiffableTableController: SPDiffableTableController, SPDiffableTableDelegate {
+
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        
+        // Hidded code for cell providers and content
+        
+        setCellProviders([cellProvider], sections: content)
+        diffableDelegate = self
+    }
+    
+    func diffableTableView(_ tableView: UITableView, didSelectItem item: SPDiffableItem) {
+        // Here you get model, which did select.
+    }
+} 
+```
+
 ### Sidebar
 
 Create new controller and extend from `SPDiffableSideBarController`. Remember, it available only from iOS 14. 
@@ -194,7 +220,7 @@ SPDiffableSection(
 
 ## Ready Use
 
-You can save time and count of code using ready-use classes. In project available models and views. For example you need simple table with native cells. You need create content with `SPDiffableTableRow`:
+You can save time and count lines of code using ready-use classes. In project available models and views. For example you need simple table with native cells. You need create content with `SPDiffableTableRow`:
 
 ```swift
 let section = SPDiffableSection(
@@ -221,18 +247,11 @@ setCellProviders(SPDiffableTableCellProviders.default, sections: [section])
 ```
 
 Now project's models automatically converting to cell. No need any additional work. That all code. 
-
-For update table shoud using `apply()` method:
-
-```swift
-diffableDataSource?.apply(sections: [section], animating: true)
-```
-
 If you use custom table view or table controller, don't forget register cells classes.  For `SPDiffableTableController` all cells already registered.
 
 ## Ready-use classes
 
-It models which you can use now, it shoud close your task without code. Of couse you can create your models.
+It list models which you can use now, it shoud close your task without code. Of couse you can create your models.
 Now in project you can find this ready-use models:
 
 - `SPDiffableItem` it basic class. All item models shoud be extend from it model. Header and footer also.
@@ -252,6 +271,7 @@ Now in project you can find this ready-use models:
 
 #### For Collection:
 
+- `SPDiffableCollectionActionableItem` actionable item for collection view.
 - `SPDiffableSideBarItem` menu item in side bar. Support accessories and actions.
 - `SPDiffableSideBarButton` button item in side bar. Color of title similar to tint.
 - `SPDiffableSideBarHeader` header model for side bar item.

SPDiffable.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = 'SPDiffable'
-  s.version       = '1.1.4'
+  s.version       = '1.1.5'
   s.summary       = 'Extenshion of Diffable API which allow not duplicate code and use less models.'
   s.homepage      = 'https://github.com/varabeis/SPDiffable'
   s.source        = { :git => 'https://github.com/varabeis/SPDiffable.git', :tag => s.version }

SPDiffable.xcodeproj/project.pbxproj

@@ -17,6 +17,7 @@
 		F4920A6424F3BFFA007F7EE9 /* SPDiffableWrapperItem.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4920A6324F3BFFA007F7EE9 /* SPDiffableWrapperItem.swift */; };
 		F4920A6924F447D6007F7EE9 /* SPDiffableTableCellProviders.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4920A6824F447D6007F7EE9 /* SPDiffableTableCellProviders.swift */; };
 		F4920A6C24F44834007F7EE9 /* SPDiffableCollectionCellProviders.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4920A6B24F44834007F7EE9 /* SPDiffableCollectionCellProviders.swift */; };
+		F4D77FAC260B2FFC004660B8 /* SPDiffableCollectionActionableItem.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4D77FAB260B2FFC004660B8 /* SPDiffableCollectionActionableItem.swift */; };
 		F4FBB993260912A50036E67D /* SPDiffableCollectionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4FBB98726090FFE0036E67D /* SPDiffableCollectionDelegate.swift */; };
 		F4FBB995260912A70036E67D /* SPDiffableTableDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4FBB98B260910D40036E67D /* SPDiffableTableDelegate.swift */; };
 		F4FBB99C260912E20036E67D /* SPDiffable.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = "SPDiffable::SPDiffable::Product" /* SPDiffable.framework */; platformFilter = ios; };
@@ -86,6 +87,7 @@
 		F4977BC6252E079A00B20771 /* Example iOS.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = "Example iOS.entitlements"; sourceTree = "<group>"; };
 		F4D6FB12256646FC0046A328 /* FUNDING.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = FUNDING.yml; sourceTree = "<group>"; };
 		F4D6FB16256646FD0046A328 /* .gitignore */ = {isa = PBXFileReference; lastKnownFileType = text; path = .gitignore; sourceTree = "<group>"; };
+		F4D77FAB260B2FFC004660B8 /* SPDiffableCollectionActionableItem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableCollectionActionableItem.swift; sourceTree = "<group>"; };
 		F4FBB98726090FFE0036E67D /* SPDiffableCollectionDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableCollectionDelegate.swift; sourceTree = "<group>"; };
 		F4FBB98B260910D40036E67D /* SPDiffableTableDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableTableDelegate.swift; sourceTree = "<group>"; };
 		OBJ_10 /* SPDiffableCollectionController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableCollectionController.swift; sourceTree = "<group>"; };
@@ -230,6 +232,7 @@
 				OBJ_16 /* SPDiffableSideBarButton.swift */,
 				OBJ_17 /* SPDiffableSideBarHeader.swift */,
 				OBJ_18 /* SPDiffableSideBarItem.swift */,
+				F4D77FAB260B2FFC004660B8 /* SPDiffableCollectionActionableItem.swift */,
 			);
 			path = Models;
 			sourceTree = "<group>";
@@ -451,6 +454,7 @@
 				OBJ_69 /* SPDiffableStepper.swift in Sources */,
 				OBJ_70 /* SPDiffableSubtitleTableViewCell.swift in Sources */,
 				OBJ_71 /* SPDiffableSwitch.swift in Sources */,
+				F4D77FAC260B2FFC004660B8 /* SPDiffableCollectionActionableItem.swift in Sources */,
 				F4FBB995260912A70036E67D /* SPDiffableTableDelegate.swift in Sources */,
 				OBJ_72 /* SPDiffableTableViewCell.swift in Sources */,
 				OBJ_73 /* SPDiffableTableController.swift in Sources */,

Sources/SPDiffable/CellProvider/Models/SPDiffableItem.swift

@@ -22,14 +22,14 @@
 import UIKit
 
 /**
- Basic class for items and sections.
+ SPDiffable: Basic class for items and sections.
 
  All next model's classes shoud be extend from it class.
  */
 open class SPDiffableItem: NSObject, NSCopying {
 
     /**
-     Identifier help for detect uniq cell and doing diffable work and animations.
+     SPDiffable: Identifier help for detect uniq cell and doing diffable work and animations.
 
      Always shoud be uniq. But if it changed, diffable system remove old and insert new (not reload).
      Identifier uses in `Hashable` and `Equatable` protocols.

Sources/SPDiffable/CellProvider/Models/SPDiffableSection.swift

@@ -22,20 +22,23 @@
 import UIKit
 
 /**
- Basic section class. Can set header, footer and items in it section.
+ SPDiffable: Basic section class. Can set header, footer and items in it section.
 
  Using in diffable work. All sections shoud be inhert from it.
  Can init with empty models if need configure later.
  */
 open class SPDiffableSection: NSObject, NSCopying {
 
+    // MARK: - Properties
+    
     /**
-     Identifier help for detect uniq section and doing diffable work and animations.
+     SPDiffable: Identifier help for detect uniq section and doing diffable work and animations.
 
      Always shoud be uniq. But if it changed, diffable system remove old and insert new (not reload).
      Identifier uses in `Hashable` and `Equatable` protocols.
      */
     public var identifier: SectionIdentifier
+    
     public var header: SPDiffableItem?
     public var footer: SPDiffableItem?
 

Sources/SPDiffable/CellProvider/Models/SPDiffableSnapshot.swift

@@ -22,13 +22,13 @@
 import UIKit
 
 /**
- Wrapper of `NSDiffableDataSourceSnapshot` with basic `SPDiffableSection` & `SPDiffableItem`.
+ SPDiffable: Wrapper of `NSDiffableDataSourceSnapshot` with basic `SPDiffableSection` & `SPDiffableItem`.
  */
 @available(iOS 13.0, *)
 public typealias SPDiffableSnapshot = NSDiffableDataSourceSnapshot<SPDiffableSection, SPDiffableItem>
 
 /**
- Wrapper of NSDiffableDataSourceSectionSnapshot  with basic `SPDiffableItem`.
+ SPDiffable: Wrapper of NSDiffableDataSourceSectionSnapshot  with basic `SPDiffableItem`.
  */
 @available(iOS 14, *)
 public typealias SPDiffableSectionSnapshot = NSDiffableDataSourceSectionSnapshot<SPDiffableItem>

Sources/SPDiffable/CellProvider/Models/SPDiffableTextHeaderFooter.swift

@@ -22,7 +22,7 @@
 import UIKit
 
 /**
- Header & Footer model class with simple text.
+ SPDiffable: Header & Footer model class with simple text.
  */
 open class SPDiffableTextHeaderFooter: SPDiffableItem {