Added diffable collection view with same logic. Updated side bar controller and clean code. Added codestyle and to-do list.

ivanvorobei · ivanvorobei · commit b80976d9438d · 2021-04-22T10:59:53.000+03:00
diff --git a/CODESTYLE.md b/CODESTYLE.md
@@ -0,0 +1,25 @@
+# Documentation 
+
+## Using marks
+
+For clean struct code good is using marks. 
+
+```swift
+class Example {
+
+    // MARK: - Init
+    
+    init() {}
+}
+```
+
+Here you find all which using in project.
+
+
+- // MARK: - Init
+- // MARK: - Configure
+- // MARK: - Lifecycle
+- // MARK: - Properties
+
+
+If you can't find valid, add new to codestyle agreements please. Other can be use wit if class is large and need struct it even without adding to codestyle agreements.
diff --git a/SPDiffable.podspec b/SPDiffable.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = 'SPDiffable'
-  s.version       = '1.1.6'
+  s.version       = '1.1.7'
   s.summary       = 'Extenshion of Diffable API which allow not duplicate code and use less models.'
   s.homepage      = 'https://github.com/ivanvorobei/SPDiffable'
   s.source        = { :git => 'https://github.com/ivanvorobei/SPDiffable.git', :tag => s.version }
diff --git a/SPDiffable.xcodeproj/project.pbxproj b/SPDiffable.xcodeproj/project.pbxproj
@@ -17,6 +17,8 @@
 		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 */; };
+		F4AB9BE326315F4400EC27A5 /* SPDiffableCollectionView.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4AB9BE226315F4400EC27A5 /* SPDiffableCollectionView.swift */; };
+		F4AB9BE9263161DA00EC27A5 /* SPDiffableSideBarController.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4AB9BE8263161DA00EC27A5 /* SPDiffableSideBarController.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 */; };
@@ -25,7 +27,6 @@
 		OBJ_53 /* SPDiffableCollectionController.swift in Sources */ = {isa = PBXBuildFile; fileRef = OBJ_10 /* SPDiffableCollectionController.swift */; };
 		OBJ_54 /* SPDiffableCollectionDataSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = OBJ_11 /* SPDiffableCollectionDataSource.swift */; };
 		OBJ_55 /* SPDiffableSideBarButtonCollectionViewListCell.swift in Sources */ = {isa = PBXBuildFile; fileRef = OBJ_12 /* SPDiffableSideBarButtonCollectionViewListCell.swift */; };
-		OBJ_56 /* SPDiffableSideBarController.swift in Sources */ = {isa = PBXBuildFile; fileRef = OBJ_13 /* SPDiffableSideBarController.swift */; };
 		OBJ_57 /* SPDiffableSideBarButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = OBJ_16 /* SPDiffableSideBarButton.swift */; };
 		OBJ_58 /* SPDiffableSideBarHeader.swift in Sources */ = {isa = PBXBuildFile; fileRef = OBJ_17 /* SPDiffableSideBarHeader.swift */; };
 		OBJ_59 /* SPDiffableSideBarItem.swift in Sources */ = {isa = PBXBuildFile; fileRef = OBJ_18 /* SPDiffableSideBarItem.swift */; };
@@ -85,6 +86,10 @@
 		F4920A6824F447D6007F7EE9 /* SPDiffableTableCellProviders.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableTableCellProviders.swift; sourceTree = "<group>"; };
 		F4920A6B24F44834007F7EE9 /* SPDiffableCollectionCellProviders.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableCollectionCellProviders.swift; sourceTree = "<group>"; };
 		F4977BC6252E079A00B20771 /* Example iOS.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = "Example iOS.entitlements"; sourceTree = "<group>"; };
+		F4AB9BE226315F4400EC27A5 /* SPDiffableCollectionView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableCollectionView.swift; sourceTree = "<group>"; };
+		F4AB9BE626315FB400EC27A5 /* CODESTYLE.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CODESTYLE.md; sourceTree = "<group>"; };
+		F4AB9BE8263161DA00EC27A5 /* SPDiffableSideBarController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableSideBarController.swift; sourceTree = "<group>"; };
+		F4AB9BED263163B600EC27A5 /* TODO.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = TODO.md; 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>"; };
@@ -93,7 +98,6 @@
 		OBJ_10 /* SPDiffableCollectionController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableCollectionController.swift; sourceTree = "<group>"; };
 		OBJ_11 /* SPDiffableCollectionDataSource.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableCollectionDataSource.swift; sourceTree = "<group>"; };
 		OBJ_12 /* SPDiffableSideBarButtonCollectionViewListCell.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableSideBarButtonCollectionViewListCell.swift; sourceTree = "<group>"; };
-		OBJ_13 /* SPDiffableSideBarController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableSideBarController.swift; sourceTree = "<group>"; };
 		OBJ_16 /* SPDiffableSideBarButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableSideBarButton.swift; sourceTree = "<group>"; };
 		OBJ_17 /* SPDiffableSideBarHeader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableSideBarHeader.swift; sourceTree = "<group>"; };
 		OBJ_18 /* SPDiffableSideBarItem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SPDiffableSideBarItem.swift; sourceTree = "<group>"; };
@@ -288,6 +292,8 @@
 				OBJ_47 /* README.md */,
 				F4D6FB16256646FD0046A328 /* .gitignore */,
 				OBJ_45 /* SPDiffable.podspec */,
+				F4AB9BE626315FB400EC27A5 /* CODESTYLE.md */,
+				F4AB9BED263163B600EC27A5 /* TODO.md */,
 				OBJ_6 /* Package.swift */,
 				OBJ_7 /* Sources */,
 				F47A41CF24EB222C0054DBB2 /* Example iOS */,
@@ -322,8 +328,9 @@
 			children = (
 				OBJ_15 /* Models */,
 				OBJ_10 /* SPDiffableCollectionController.swift */,
+				F4AB9BE226315F4400EC27A5 /* SPDiffableCollectionView.swift */,
 				OBJ_12 /* SPDiffableSideBarButtonCollectionViewListCell.swift */,
-				OBJ_13 /* SPDiffableSideBarController.swift */,
+				F4AB9BE8263161DA00EC27A5 /* SPDiffableSideBarController.swift */,
 			);
 			path = Collection;
 			sourceTree = "<group>";
@@ -434,8 +441,9 @@
 				OBJ_54 /* SPDiffableCollectionDataSource.swift in Sources */,
 				F4920A6C24F44834007F7EE9 /* SPDiffableCollectionCellProviders.swift in Sources */,
 				OBJ_55 /* SPDiffableSideBarButtonCollectionViewListCell.swift in Sources */,
-				OBJ_56 /* SPDiffableSideBarController.swift in Sources */,
 				OBJ_57 /* SPDiffableSideBarButton.swift in Sources */,
+				F4AB9BE326315F4400EC27A5 /* SPDiffableCollectionView.swift in Sources */,
+				F4AB9BE9263161DA00EC27A5 /* SPDiffableSideBarController.swift in Sources */,
 				F4920A6924F447D6007F7EE9 /* SPDiffableTableCellProviders.swift in Sources */,
 				OBJ_58 /* SPDiffableSideBarHeader.swift in Sources */,
 				OBJ_59 /* SPDiffableSideBarItem.swift in Sources */,
diff --git a/SPDiffable.xcodeproj/project.xcworkspace/xcuserdata/ivanvorobei.xcuserdatad/UserInterfaceState.xcuserstate b/SPDiffable.xcodeproj/project.xcworkspace/xcuserdata/ivanvorobei.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/Sources/SPDiffable/Collection/SPDiffableCollectionController.swift b/Sources/SPDiffable/Collection/SPDiffableCollectionController.swift
@@ -55,7 +55,7 @@ open class SPDiffableCollectionController: UICollectionViewController {
     // MARK: - UICollectionViewDelegate
     
     open override func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
-        guard let item = diffableDataSource?.itemIdentifier(for: indexPath) else { return }
+        guard let item = diffableDataSource?.item(for: indexPath) else { return }
         diffableDelegate?.diffableCollectionView?(collectionView, didSelectItem: item)
         switch item {
         case let model as SPDiffableCollectionActionableItem:
diff --git a/Sources/SPDiffable/Collection/SPDiffableCollectionView.swift b/Sources/SPDiffable/Collection/SPDiffableCollectionView.swift
@@ -0,0 +1,83 @@
+// 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
+
+/**
+ SPDiffable: Basic diffable collection view.
+ 
+ For common init call `setCellProviders` with default data and providers for it models.
+ If need init manually, shoud init `diffableDataSource` first, and next apply content when you need it.
+ */
+@available(iOS 13.0, *)
+open class SPDiffableCollectionView: UICollectionView, UICollectionViewDelegate {
+    
+    // MARK: - Properties
+    
+    open var diffableDataSource: SPDiffableCollectionDataSource?
+    
+    open weak var diffableDelegate: SPDiffableCollectionDelegate?
+    
+    // MARK: - Init
+    
+    public init() {
+        super.init(frame: .zero, collectionViewLayout: UICollectionViewFlowLayout())
+        commonInit()
+    }
+    
+    required public init?(coder: NSCoder) {
+        super.init(coder: coder)
+        commonInit()
+    }
+    
+    private func commonInit() {
+        delegate = self
+    }
+    
+    // MARK: - Configure
+    
+    /**
+     SPDiffable: Init `diffableDataSource` and apply content to data source without animation.
+     
+     If need custom logic, you can manually init and apply data when you need.
+     
+     - warning: Changes applied not animatable.
+     - parameter providers: Cell Providers with valid order for processing.
+     - parameter sections: Content as array of `SPDiffableSection`.
+     */
+    open func setCellProviders( _ providers: [SPDiffableCollectionCellProvider], sections: [SPDiffableSection]) {
+        diffableDataSource = SPDiffableCollectionDataSource(collectionView: self, cellProviders: providers)
+        diffableDataSource?.apply(sections, animated: false)
+    }
+    
+    // MARK: - UICollectionViewDelegate
+    
+    open func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
+        guard let item = diffableDataSource?.item(for: indexPath) else { return }
+        diffableDelegate?.diffableCollectionView?(collectionView, didSelectItem: item)
+        switch item {
+        case let model as SPDiffableCollectionActionableItem:
+            model.action?(indexPath)
+        default:
+            break
+        }
+    }
+}
diff --git a/Sources/SPDiffable/Collection/SPDiffableSideBarController.swift b/Sources/SPDiffable/Collection/SPDiffableSideBarController.swift
@@ -31,17 +31,28 @@ import UIKit
  Layout detect data source and automatically set header and footer mode.
 */
 @available(iOS 14, *)
-open class SPDiffableSideBarController: UIViewController, UICollectionViewDelegate {
+open class SPDiffableSideBarController: SPDiffableCollectionController {
     
-    // MARK: - Properties
+    // MARK: - Init
     
-    open lazy var collectionView = UICollectionView(frame: .zero, collectionViewLayout: layout)
+    public init() {
+        super.init(collectionViewLayout: UICollectionViewFlowLayout())
+        commonInit()
+        
+    }
+    
+    public required init?(coder: NSCoder) {
+        super.init(coder: coder)
+        commonInit()
+    }
     
-    open var diffableDataSource: SPDiffableCollectionDataSource?
+    private func commonInit() {
+        collectionView.setCollectionViewLayout(makeLayout(), animated: false)
+    }
     
-    open weak var diffableDelegate: SPDiffableCollectionDelegate?
+    // MARK: - Layout
     
-    private var layout: UICollectionViewCompositionalLayout {
+    private func makeLayout() -> UICollectionViewCompositionalLayout {
         return UICollectionViewCompositionalLayout { [weak self] (section, layoutEnvironment) -> NSCollectionLayoutSection? in
             var configuration = UICollectionLayoutListConfiguration(appearance: .sidebar)
             let header = self?.diffableDataSource?.snapshot().sectionIdentifiers[section].header
@@ -51,50 +62,4 @@ open class SPDiffableSideBarController: UIViewController, UICollectionViewDelega
             return NSCollectionLayoutSection.list(using: configuration, layoutEnvironment: layoutEnvironment)
         }
     }
-    
-    // MARK: - Configure
-    
-    /**
-     SPDiffable: Init `diffableDataSource` and apply content to data source without animation.
-     
-     If need custom logic, you can manually init and apply data when you need.
-     
-     - warning: Changes applied not animatable.
-     - parameter providers: Cell Providers with valid order for processing.
-     - parameter sections: Content as array of `SPDiffableSection`.
-     */
-    public func setCellProviders( _ providers: [SPDiffableCollectionCellProvider], sections: [SPDiffableSection]) {
-        diffableDataSource = SPDiffableCollectionDataSource(collectionView: collectionView, cellProviders: providers)
-        diffableDataSource?.apply(sections, animated: false)
-    }
-    
-    // MARK: - Lifecycle
-    
-    open override func viewDidLoad() {
-        super.viewDidLoad()
-        collectionView.delegate = self
-        collectionView.translatesAutoresizingMaskIntoConstraints = false
-        view.addSubview(collectionView)
-        NSLayoutConstraint.activate([
-            collectionView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
-            collectionView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            collectionView.topAnchor.constraint(equalTo: view.topAnchor),
-            collectionView.bottomAnchor.constraint(equalTo: view.bottomAnchor)
-        ])
-    }
-    
-    // MARK: - UICollectionViewDelegate
-    
-    public func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
-        guard let item = diffableDataSource?.itemIdentifier(for: indexPath) else { return }
-        diffableDelegate?.diffableCollectionView?(collectionView, didSelectItem: item)
-        switch item {
-        case let item as SPDiffableSideBarItem:
-            item.action(indexPath)
-        case let item as SPDiffableSideBarButton:
-            item.action(indexPath)
-        default:
-            break
-        }
-    }
 }
diff --git a/Sources/SPDiffable/DataSource/SPDiffableCollectionDataSource.swift b/Sources/SPDiffable/DataSource/SPDiffableCollectionDataSource.swift
@@ -47,7 +47,7 @@ open class SPDiffableCollectionDataSource: UICollectionViewDiffableDataSource<SP
         }
     }
     
-    // MARK: - Apply Wrappers
+    // MARK: - Apply Content
     
     /**
      SPDiffable: Applying sections to current snapshot.
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,3 @@
+# To Do List 
+
+- Update `SPDiffableCollectionDelegate` & `SPDiffableTableDelegate` for process index path.

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ open class SPDiffableCollectionDataSource: UICollectionViewDiffableDataSource<SP`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
`50`		`- // MARK: - Apply Wrappers`
	`50`	`+ // MARK: - Apply Content`
`51`	`51`
`52`	`52`	`/**`
`53`	`53`	`SPDiffable: Applying sections to current snapshot.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# To Do List`
	`2`	`+`
	`3`	+- Update `SPDiffableCollectionDelegate` & `SPDiffableTableDelegate` for process index path.