Updated table and collections data sources.

Author: ivanvorobei

Example Apps/iOS Example/Controllers/DiffableTableController.swift

@@ -36,14 +36,14 @@ class DiffableTableController: SPDiffableTableController, SPDiffableTableMediato
     override func viewDidLoad() {
         super.viewDidLoad()
         diffableDataSource?.mediator = self
-        setCellProviders(SPDiffableTableCellProvider.default, sections: content)
+        configureDiffable(sections: content, cellProviders: SPDiffableTableDataSource.CellProvider.default)
     }
 
     var content: [SPDiffableSection] {
         return []
     }
 
     internal func updateContent(animated: Bool) {
-        diffableDataSource?.apply(content, animated: animated)
+        diffableDataSource?.set(content, animated: animated)
     }
 }

Example Apps/iOS Example/Controllers/RootController.swift

@@ -149,8 +149,6 @@ class RootController: DiffableTableController {
         didSet {
             print("Stepper value is: \(stepperValue)")
             updateContent(animated: true)
-            guard let indexPath = diffableDataSource?.indexPath(for: stepperValueIdentifier), let cell = tableView.cellForRow(at: indexPath) else { return }
-            cell.detailTextLabel?.text = "\(Int(stepperValue))"
         }
     }
 

Example Apps/iOS Example/Controllers/SideBarController.swift

@@ -27,7 +27,7 @@ class SidebarController: SPDiffableSideBarController {
 
     override func viewDidLoad() {
         super.viewDidLoad()
-        setCellProviders(SPDiffableCollectionCellProvider.sideBar, sections: content)
+        configureDiffable(sections: content, cellProviders: SPDiffableCollectionDataSource.CellProvider.sideBar)
     }
 
     enum Section: String {
@@ -47,10 +47,9 @@ class SidebarController: SPDiffableSideBarController {
                     SPDiffableSideBarItem(title: "Browse", image: UIImage(systemName: "square.grid.2x2"), action: { _, _ in }),
                     SPDiffableSideBarItem(title: "Radio", image: UIImage(systemName: "dot.radiowaves.left.and.right"), action: { _, _ in }),
                     SPDiffableSideBarItem(title: "Search", image: UIImage(systemName: "magnifyingglass"), action: { _, _ in
-                        print("action call 2")
+                        
                     }),
                     SPDiffableSideBarButton(title: "Button", image: UIImage(systemName: "plus.square.fill"), action: { [weak self] _, _ in
-                        print("action call")
                         guard let self = self else { return }
                         let controller = UIViewController()
                         controller.view.backgroundColor = .systemBackground

Readme.md

@@ -14,15 +14,6 @@ Apple's diffable API requerid models for each object type. If you want use it in
     - [Swift Package Manager](#swift-package-manager)
     - [CocoaPods](#cocoapods)
     - [Manually](#manually)
-- [Ready Use](#ready-use)
-    - [Example](#ready-use)
-    - [Available Classes](#available-classes)
-- [Usage](#usage)
-    - [How it work](#usage)
-    - [Set Content](#set-content)
-    - [Get Content](#get-content)
-    - [Wrapper](#wrapper)
-    - [Sidebar](#sidebar)
 - [Russian Community](#russian-community)
 
 ## Installation
@@ -53,222 +44,6 @@ pod 'SPDiffable'
 
 If you prefer not to use any of dependency managers, you can integrate manually. Put `Sources/SPDiffable` folder in your Xcode project. Make sure to enable `Copy items if needed` and `Create groups`.
 
-## Ready Use
-
-For example you need simple table with native cells. You need create content with `SPDiffableTableRow`:
-
-```swift
-let section = SPDiffableSection(
-    id: "example section",
-    header: SPDiffableTextHeaderFooter(text: "Header"),
-    footer: SPDiffableTextHeaderFooter(text: "Footer"),
-    items: [
-        SPDiffableTableRow(text: "First Cell", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
-            guard let self = self else { return }
-            self.tableView.deselectRow(at: indexPath, animated: true)
-        }),
-        SPDiffableTableRow(text: "Second Cell", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
-            guard let self = self else { return }
-            self.tableView.deselectRow(at: indexPath, animated: true)
-        }),
-    ]
-)
-```
-
-You init cell model and pass action, choose selection style and other. As you see, model describe native table cell. Next, you need set cell provider, but it also already available, for get it call `SPDiffableTableController.default`.
-
-```swift
-setCellProviders(SPDiffableTableCellProvider.default, sections: [section])
-```
-
-Now project's models automatically converting to cell. No need any additional work. That all code. 
-If you use custom table view or table controller, don't forget register cells classes.  For `SPDiffableTableController` all cells already registered.
-
-## Available Classes
-
-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.
-- `SPDiffableSection` section class. Included footer and header properties, also items (cells).
-- `SPDiffableTextHeaderFooter` header or footer class with text.
-
-#### For Table:
-
-Here provided models:
-
-- `SPDiffableTableRow` it native item for table cell. Support all basic styles and action for tap event.
-- `SPDiffableTableRowSubtitle` it native item for table cell with subtitle. Support all as before.
-- `SPDiffableTableRowButton` item for table in style as button. Support table styles and action for tap.
-- `SPDiffableTableRowStepper` item for table cell with stepper. Has maximum value and minimum, also incuded action with passed value.
-- `SPDiffableTableRowSwitch` item for table with switch, included default state and action for change event.
-
-Here provided cells:
-
-- `SPDiffableTableViewCell` basic table cell with detail text right side.
-- `SPDiffableSubtitleTableViewCell` basic table cell with two lines of texts.
-- `SPDiffableStepper` cell with stepper control. Using with `SPDiffableTableRowStepper` model.
-- `SPDiffableSwitch` cell with switch. Using with `SPDiffableTableRowSwitch` model.
-- `SPDiffableSlider` cell with slider.
-
-#### For Collection:
-
-Provided only models, becouse for most items using list registration and no need specific cell class.
-
-- `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.
-
-## Usage
-
-Before read it, highly recomded check `Example` target in project. It examle show all features, like use stepper and switch, like process actions, create custom models and many other. Also you can skip full undestand logic and read [Ready-use section](https://github.com/ivanvorobei/SPDiffable#ready-use) with minimum of code for start.
-
-For work with diffable need create model (inside project you found some ready-use models) and do cell provider, which convert data-model to `UITableViewCell` or `UICollectionViewCell`. Next example for table, but all methods and class names available for collections.
-
-New model shoud extend from basic class `SPDiffableItem`:
-
-```swift
-class LocationRowModel: SPDiffableItem {
-
-    // Add properties, which you need
-    public var city: String
-    public var adress: String?
-}
-```
-
-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
-            }
-        }
-        
-        // Pass cell provider and content. 
-        // About content you can read in next section.
-        setCellProviders([locationCellProvider], sections: content)
-    }
-}
-```
-
-Now ready model and convert it to views. Time to add content.
-
-### Set Content
-
-Now table support models and custom cell provider. You can apply diffable content with animation (or not).
-Create content:
-
-```swift
-
-var content: [SPDiffableSection] {
-    let section = SPDiffableSection(
-        id: "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 items or sections. Last step - apply:
-
-```swift
-diffableDataSource?.apply(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.
-
-#### Reload Content
-
-If you need something like old function `.reloadData()` in collection and table, look at this method:
-
-```swift
-// Reload fully content
-diffableDataSource.reload(content)
-
-// Reload only specific items
-diffableDataSource.reload(items) // or for 1 item `reload(item)`
-```
-
-Changes apply without animation and like deep reload.
-
-### Get Content
-
-You can get index path by item, item by id and many other funcs:
-
-```swift
-func item(for indexPath: IndexPath) -> SPDiffableItem? {}
-func indexPath(for itemID: SPDiffableItem.Identifier) -> IndexPath? {}
-func sections() -> [SPDiffableSection] {}
-func section(for index: Int) -> SPDiffableSection? {}
-func cell<T: UITableViewCell>(_ type: T.Type, for itemID: SPDiffableItem.Identifier) -> T? {}
-```
-
-### Wrapper
-
-In project you can find class `SPDiffableWrapperItem`. Using it, when you don't want create custom item model for you diffable struct. You can pass any your model and uwrap it later in cell provider.
-
-```swift
-let item = SPDiffableWrapperItem(id: "uniq-identifier", model: LocationRowModel(city: "Minsk"))
-```
-
-### Sidebar
-
-Create new controller and extend from `SPDiffableSideBarController`. Remember, it available only from iOS 14. 
-
-```swift
-class SidebarController: SPDiffableSideBarController {}
-```
-
-In class available ready-use cell providers for menu item and header section. For get it shoud call:
-
-```swift
-override func viewDidLoad() {
-    super.viewDidLoad()
-    setCellProviders(SPDiffableCollectionCellProvider.sideBar, sections: content)
-}
-```
-
-Content it array of `SPDiffableSection`. For menu model need use model `SPDiffableSideBarItem` or `SPDiffableSideBarButton`. For header and footer will create `SPDiffableSideBarHeader` model.
-
-```swift
-SPDiffableSection(
-    id: Section.library.rawValue,
-    header: SPDiffableSideBarHeader(text: "Library", accessories: [.outlineDisclosure()]),
-    items: [
-        SPDiffableSideBarItem(title: "Recently Added", image: UIImage(systemName: "clock"), action: { _ in }),
-        SPDiffableSideBarItem(title: "Artists", image: UIImage(systemName: "music.mic"), action: { _ in }),
-        SPDiffableSideBarItem(title: "Albums", image: UIImage(systemName: "rectangle.stack"), action: { _ in }),
-        SPDiffableSideBarItem(title: "Songs", image: UIImage(systemName: "music.note"), action: { _ in }),
-        SPDiffableSideBarButton(title: "Add New", image: UIImage(systemName: "plus.square.fill"), action: { _ in })
-    ]
-)
-```
-
 ## Russian Community
 
 Я веду [телеграм-канал](https://sparrowcode.io/telegram), там публикую новости и туториалы.<br>

SPDiffable.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name = 'SPDiffable'
-  s.version = '3.0.0'
+  s.version = '4.0.0'
   s.summary = 'Extension of Diffable API which allow not duplicate code and use less models. Included example for SideBar.'
   s.homepage = 'https://github.com/ivanvorobei/SPDiffable'
   s.source = { :git => 'https://github.com/ivanvorobei/SPDiffable.git', :tag => s.version }

Sources/SPDiffable/Collection/DataSource/AppleCollectionDiffableDataSource.swift

@@ -0,0 +1,44 @@
+// The MIT License (MIT)
+// Copyright © 2020 Ivan Vorobei (hello@ivanvorobei.by)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import UIKit
+
+@available(iOS 13.0, *)
+open class AppleCollectionDiffableDataSource: UICollectionViewDiffableDataSource<SPDiffableSection, SPDiffableItem> {
+    
+    // MARK: - Init
+    
+    public init(
+        collectionView: UICollectionView,
+        cellProvider: @escaping CellProvider,
+        headerFooterProvider: SupplementaryViewProvider?
+    ) {
+        super.init(collectionView: collectionView, cellProvider: cellProvider)
+        self.supplementaryViewProvider = supplementaryViewProvider
+    }
+    
+    // MARK: - Wrappers
+    
+    typealias Snapshot = NSDiffableDataSourceSnapshot<SPDiffableSection, SPDiffableItem>
+    
+    @available(iOS 14.0, *)
+    typealias SectionSnapshot = NSDiffableDataSourceSectionSnapshot<SPDiffableItem>
+}