Merge pull request #9 from ra1028/v0.5.0

v0.5.0

Author: ra1028

DifferenceKit.playground/Contents.swift

@@ -18,18 +18,18 @@ PlaygroundPage.current.needsIndefiniteExecution = true
 PlaygroundPage.current.liveView = navigationController.view
 
 let source = [
-    Section(model: "Section 1", elements: ["A", "B", "C"]),
-    Section(model: "Section 2", elements: ["D", "E", "F"]),
-    Section(model: "Section 3", elements: ["G", "H", "I"]),
-    Section(model: "Section 4", elements: ["J", "K", "L"])
+    ArraySection(model: "Section 1", elements: ["A", "B", "C"]),
+    ArraySection(model: "Section 2", elements: ["D", "E", "F"]),
+    ArraySection(model: "Section 3", elements: ["G", "H", "I"]),
+    ArraySection(model: "Section 4", elements: ["J", "K", "L"])
 ]
 
 let target = [
-    Section(model: "Section 5", elements: ["M", "N", "O"]),
-    Section(model: "Section 1", elements: ["A", "C"]),
-    Section(model: "Section 4", elements: ["J", "I", "K", "L"]),
-    Section(model: "Section 3", elements: ["G", "H", "Z"]),
-    Section(model: "Section 6", elements: ["P", "Q", "R"]),
+    ArraySection(model: "Section 5", elements: ["M", "N", "O"]),
+    ArraySection(model: "Section 1", elements: ["A", "C"]),
+    ArraySection(model: "Section 4", elements: ["J", "I", "K", "L"]),
+    ArraySection(model: "Section 3", elements: ["G", "H", "Z"]),
+    ArraySection(model: "Section 6", elements: ["P", "Q", "R"])
 ]
 
 viewController.dataInput = source

DifferenceKit.playground/Sources/TableViewController.swift

@@ -6,7 +6,7 @@ extension String: Differentiable {}
 public final class TableViewController: UITableViewController {
     public var refreshAction: (() -> Void)?
 
-    public var dataInput: [Section<String, String>] {
+    public var dataInput: [ArraySection<String, String>] {
         get { return data }
         set {
             let changeset = StagedChangeset(source: data, target: newValue)
@@ -16,7 +16,7 @@ public final class TableViewController: UITableViewController {
         }
     }
 
-    private var data = [Section<String, String>]()
+    private var data = [ArraySection<String, String>]()
 
     public init() {
         super.init(style: .grouped)

DifferenceKit.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |spec|
   spec.name = 'DifferenceKit'
-  spec.version  = '0.4.1'
+  spec.version  = '0.5.0'
   spec.author = { 'ra1028' => '[email protected]' }
   spec.homepage = 'https://github.com/ra1028/DifferenceKit'
   spec.documentation_url = 'https://ra1028.github.io/DifferenceKit'

DifferenceKit.xcodeproj/project.pbxproj

@@ -9,7 +9,7 @@
 /* Begin PBXBuildFile section */
 		6B2DF878210E2C12004D2D40 /* DifferenceKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 6B2DF86E210E2C12004D2D40 /* DifferenceKit.framework */; };
 		6B5B409C211066BF00A931DB /* AlgorithmTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B4093211066BF00A931DB /* AlgorithmTest.swift */; };
-		6B5B409D211066BF00A931DB /* SectionTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B4094211066BF00A931DB /* SectionTest.swift */; };
+		6B5B409D211066BF00A931DB /* ArraySectionTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B4094211066BF00A931DB /* ArraySectionTest.swift */; };
 		6B5B409E211066BF00A931DB /* StagedChangesetTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B4095211066BF00A931DB /* StagedChangesetTest.swift */; };
 		6B5B409F211066BF00A931DB /* AnyDifferentiableTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B4096211066BF00A931DB /* AnyDifferentiableTest.swift */; };
 		6B5B40A0211066BF00A931DB /* ElementPathTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B4097211066BF00A931DB /* ElementPathTest.swift */; };
@@ -21,7 +21,7 @@
 		6B5B40A7211066EA00A931DB /* DifferentiableSection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B408E211066B300A931DB /* DifferentiableSection.swift */; };
 		6B5B40A8211066EA00A931DB /* Changeset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B408F211066B300A931DB /* Changeset.swift */; };
 		6B5B40A9211066EA00A931DB /* StagedChangeset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B408C211066B300A931DB /* StagedChangeset.swift */; };
-		6B5B40AA211066EA00A931DB /* Section.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B408A211066B300A931DB /* Section.swift */; };
+		6B5B40AA211066EA00A931DB /* ArraySection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B408A211066B300A931DB /* ArraySection.swift */; };
 		6B5B40AB211066EA00A931DB /* AnyDifferentiable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B408B211066B300A931DB /* AnyDifferentiable.swift */; };
 		6B5B40AC211066EA00A931DB /* ElementPath.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B408D211066B300A931DB /* ElementPath.swift */; };
 		6B956B762110B25300DE3D29 /* UIKitExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6B5B4088211066B300A931DB /* UIKitExtension.swift */; };
@@ -43,7 +43,7 @@
 		6B2DF88A210E39A8004D2D40 /* DifferenceKit.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = DifferenceKit.xcconfig; sourceTree = "<group>"; };
 		6B5B4086211066B300A931DB /* Algorithm.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Algorithm.swift; sourceTree = "<group>"; };
 		6B5B4088211066B300A931DB /* UIKitExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIKitExtension.swift; sourceTree = "<group>"; };
-		6B5B408A211066B300A931DB /* Section.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Section.swift; sourceTree = "<group>"; };
+		6B5B408A211066B300A931DB /* ArraySection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ArraySection.swift; sourceTree = "<group>"; };
 		6B5B408B211066B300A931DB /* AnyDifferentiable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AnyDifferentiable.swift; sourceTree = "<group>"; };
 		6B5B408C211066B300A931DB /* StagedChangeset.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StagedChangeset.swift; sourceTree = "<group>"; };
 		6B5B408D211066B300A931DB /* ElementPath.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ElementPath.swift; sourceTree = "<group>"; };
@@ -52,7 +52,7 @@
 		6B5B4090211066B300A931DB /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		6B5B4091211066B300A931DB /* Differentiable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Differentiable.swift; sourceTree = "<group>"; };
 		6B5B4093211066BF00A931DB /* AlgorithmTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AlgorithmTest.swift; sourceTree = "<group>"; };
-		6B5B4094211066BF00A931DB /* SectionTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SectionTest.swift; sourceTree = "<group>"; };
+		6B5B4094211066BF00A931DB /* ArraySectionTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ArraySectionTest.swift; sourceTree = "<group>"; };
 		6B5B4095211066BF00A931DB /* StagedChangesetTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = StagedChangesetTest.swift; sourceTree = "<group>"; };
 		6B5B4096211066BF00A931DB /* AnyDifferentiableTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AnyDifferentiableTest.swift; sourceTree = "<group>"; };
 		6B5B4097211066BF00A931DB /* ElementPathTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ElementPathTest.swift; sourceTree = "<group>"; };
@@ -113,12 +113,12 @@
 			children = (
 				6B5B4087211066B300A931DB /* UIExtensions */,
 				6B5B4086211066B300A931DB /* Algorithm.swift */,
-				6B5B4091211066B300A931DB /* Differentiable.swift */,
-				6B5B408E211066B300A931DB /* DifferentiableSection.swift */,
 				6B5B408F211066B300A931DB /* Changeset.swift */,
 				6B5B408C211066B300A931DB /* StagedChangeset.swift */,
-				6B5B408A211066B300A931DB /* Section.swift */,
+				6B5B4091211066B300A931DB /* Differentiable.swift */,
+				6B5B408E211066B300A931DB /* DifferentiableSection.swift */,
 				6B5B408B211066B300A931DB /* AnyDifferentiable.swift */,
+				6B5B408A211066B300A931DB /* ArraySection.swift */,
 				6B5B408D211066B300A931DB /* ElementPath.swift */,
 				6B5B4090211066B300A931DB /* Info.plist */,
 			);
@@ -137,7 +137,7 @@
 			isa = PBXGroup;
 			children = (
 				6B5B4093211066BF00A931DB /* AlgorithmTest.swift */,
-				6B5B4094211066BF00A931DB /* SectionTest.swift */,
+				6B5B4094211066BF00A931DB /* ArraySectionTest.swift */,
 				6B5B4095211066BF00A931DB /* StagedChangesetTest.swift */,
 				6B5B4096211066BF00A931DB /* AnyDifferentiableTest.swift */,
 				6B5B4097211066BF00A931DB /* ElementPathTest.swift */,
@@ -264,7 +264,7 @@
 				6B5B40A5211066EA00A931DB /* Algorithm.swift in Sources */,
 				6B5B40AC211066EA00A931DB /* ElementPath.swift in Sources */,
 				6B5B40A6211066EA00A931DB /* Differentiable.swift in Sources */,
-				6B5B40AA211066EA00A931DB /* Section.swift in Sources */,
+				6B5B40AA211066EA00A931DB /* ArraySection.swift in Sources */,
 				6B5B40A9211066EA00A931DB /* StagedChangeset.swift in Sources */,
 				6B5B40A7211066EA00A931DB /* DifferentiableSection.swift in Sources */,
 			);
@@ -279,7 +279,7 @@
 				6B5B40A0211066BF00A931DB /* ElementPathTest.swift in Sources */,
 				6B5B40A4211066BF00A931DB /* TestTools.swift in Sources */,
 				6B5B40A2211066BF00A931DB /* MeasurementTest.swift in Sources */,
-				6B5B409D211066BF00A931DB /* SectionTest.swift in Sources */,
+				6B5B409D211066BF00A931DB /* ArraySectionTest.swift in Sources */,
 				6B5B409F211066BF00A931DB /* AnyDifferentiableTest.swift in Sources */,
 				6B5B409E211066BF00A931DB /* StagedChangesetTest.swift in Sources */,
 			);

Examples/Example-iOS/Sources/HeaderFooterSectionViewController.swift

@@ -18,7 +18,7 @@ private struct HeaderFooterSectionModel: Differentiable {
     }
 }
 
-private typealias HeaderFooterSection = Section<HeaderFooterSectionModel, String>
+private typealias HeaderFooterSection = ArraySection<HeaderFooterSectionModel, String>
 
 final class HeaderFooterSectionViewController: UITableViewController {
     private var data = [HeaderFooterSection]()

Examples/Example-iOS/Sources/ShuffleEmoticonViewController.swift

@@ -10,7 +10,7 @@ private enum EmoticonSectionID: Differentiable {
     }
 }
 
-private typealias EmoticonSection = Section<EmoticonSectionID, String>
+private typealias EmoticonSection = ArraySection<EmoticonSectionID, String>
 
 final class ShuffleEmoticonViewController: UIViewController {
     private let collectionView: UICollectionView

Examples/Example-tvOS/Sources/HeaderFooterSectionViewController.swift

@@ -18,7 +18,7 @@ private struct HeaderFooterSectionModel: Differentiable {
     }
 }
 
-private typealias HeaderFooterSection = Section<HeaderFooterSectionModel, String>
+private typealias HeaderFooterSection = ArraySection<HeaderFooterSectionModel, String>
 
 final class HeaderFooterSectionViewController: UITableViewController {
     private var data = [HeaderFooterSection]()

Examples/Example-tvOS/Sources/ShuffleEmoticonViewController.swift

@@ -10,7 +10,7 @@ private enum EmoticonSectionID: Differentiable {
     }
 }
 
-private typealias EmoticonSection = Section<EmoticonSectionID, String>
+private typealias EmoticonSection = ArraySection<EmoticonSectionID, String>
 
 final class ShuffleEmoticonViewController: UIViewController {
     private let collectionView: UICollectionView

README.md

@@ -112,21 +112,21 @@ let source = [
 ```
 
 In the case of sectioned collection, the section itself must have a unique identifier and be able to compare whether there is an update.  
-So each section must conform to `DifferentiableSection` protocol, but in most cases you can use `Section` that general type conformed to it.  
-`Section` requires a model conforming to `Differentiable` for differentiate from other sections:
+So each section must conform to `DifferentiableSection` protocol, but in most cases you can use `ArraySection` that general type conformed to it.  
+`ArraySection` requires a model conforming to `Differentiable` for differentiate from other sections:
 ```swift
 enum Model: Differentiable {
     case a, b, c
 }
 
-let source: [Section<Model, String>] = [
-    Section(model: .a, elements: ["A", "B"]),
-    Section(model: .b, elements: ["C"])
+let source: [ArraySection<Model, String>] = [
+    ArraySection(model: .a, elements: ["A", "B"]),
+    ArraySection(model: .b, elements: ["C"])
 ]
-let target: [Section<Model, String>] = [
-    Section(model: .c, elements: ["D", "E"]),
-    Section(model: .a, elements: ["A"]),
-    Section(model: .b, elements: ["B", "C"])
+let target: [ArraySection<Model, String>] = [
+    ArraySection(model: .c, elements: ["D", "E"]),
+    ArraySection(model: .a, elements: ["A"]),
+    ArraySection(model: .b, elements: ["B", "C"])
 ]
 
 let changeset = StagedChangeset(source: source, target: target)

Sources/Algorithm.swift

@@ -65,7 +65,6 @@ public extension StagedChangeset where Collection: RangeReplaceableCollection, C
             target: targetElements,
             trackTargetIndexAsUpdated: false,
             mapIndex: { ElementPath(element: $0, section: section) },
-            differentiable: { $0 },
             remainedInTarget: { firstStageElements.append($0) }
         )
 
@@ -124,7 +123,7 @@ public extension StagedChangeset where Collection: RangeReplaceableCollection, C
     /// - Complexity: O(n)
     public init(source: Collection, target: Collection) {
         typealias Section = Collection.Element
-        typealias SectionIdentifier = Collection.Element.Model.DifferenceIdentifier
+        typealias SectionIdentifier = Collection.Element.DifferenceIdentifier
         typealias Element = Collection.Element.Collection.Element
         typealias ElementIdentifier = Collection.Element.Collection.Element.DifferenceIdentifier
 
@@ -161,8 +160,7 @@ public extension StagedChangeset where Collection: RangeReplaceableCollection, C
             source: sourceSections,
             target: targetSections,
             trackTargetIndexAsUpdated: true,
-            mapIndex: { $0 },
-            differentiable: { $0.model }
+            mapIndex: { $0 }
         )
 
         // Calculate the element differences.
@@ -265,7 +263,7 @@ public extension StagedChangeset where Collection: RangeReplaceableCollection, C
                 offsetByDelete += 1
             }
 
-            let section = Section(model: sourceSections[sourceSectionIndex].model, elements: firstStageElements)
+            let section = Section(source: sourceSections[sourceSectionIndex], elements: firstStageElements)
             firstStageSections.append(section)
         }
 
@@ -286,7 +284,7 @@ public extension StagedChangeset where Collection: RangeReplaceableCollection, C
             let secondStageSection = firstStageSections[sourceSectionIndex - sectionDeleteOffset]
             secondStageSections.append(secondStageSection)
 
-            let thirdStageSection = Section(model: secondStageSection.model, elements: targetElements)
+            let thirdStageSection = Section(source: secondStageSection, elements: targetElements)
             thirdStageSections.append(thirdStageSection)
 
             for targetElementIndex in targetElements.indices {
@@ -381,12 +379,11 @@ public extension StagedChangeset where Collection: RangeReplaceableCollection, C
 
 /// The shared algorithm to calculate differences between two linear collections.
 @discardableResult
-private func differentiate<E, D: Differentiable, I>(
+private func differentiate<E: Differentiable, I>(
     source: ContiguousArray<E>,
     target: ContiguousArray<E>,
     trackTargetIndexAsUpdated: Bool,
     mapIndex: (Int) -> I,
-    differentiable: (E) -> D,
     remainedInTarget: ((E) -> Void)? = nil
     ) -> DifferentiateResult<I> {
     var deleted = [I]()
@@ -396,19 +393,19 @@ private func differentiate<E, D: Differentiable, I>(
 
     var sourceTraces = ContiguousArray<Trace<Int>>()
     var targetReferences = ContiguousArray<Int?>(repeating: nil, count: target.count)
-    var sourceIdentifiers = ContiguousArray<D.DifferenceIdentifier>()
+    var sourceIdentifiers = ContiguousArray<E.DifferenceIdentifier>()
 
     sourceIdentifiers.reserveCapacity(source.count)
     sourceTraces.reserveCapacity(source.count)
 
     for sourceElement in source {
         sourceTraces.append(Trace())
-        sourceIdentifiers.append(differentiable(sourceElement).differenceIdentifier)
+        sourceIdentifiers.append(sourceElement.differenceIdentifier)
     }
 
     sourceIdentifiers.withUnsafeBufferPointer { bufferPointer in
         // The pointer and the table key are for optimization.
-        var sourceOccurrencesTable = [TableKey<D.DifferenceIdentifier>: Occurrence](minimumCapacity: source.count * 2)
+        var sourceOccurrencesTable = [TableKey<E.DifferenceIdentifier>: Occurrence](minimumCapacity: source.count * 2)
 
         // Record the index where the element was found in source collection into occurrences table.
         for sourceIndex in sourceIdentifiers.indices {
@@ -430,7 +427,7 @@ private func differentiate<E, D: Differentiable, I>(
 
         // Record the target index and the source index that the element having the same identifier.
         for targetIndex in target.indices {
-            var targetIdentifier = differentiable(target[targetIndex]).differenceIdentifier
+            var targetIdentifier = target[targetIndex].differenceIdentifier
             let key = TableKey(pointer: &targetIdentifier)
 
             switch sourceOccurrencesTable[key] {
@@ -481,7 +478,7 @@ private func differentiate<E, D: Differentiable, I>(
             let sourceElement = source[sourceIndex]
             let targetElement = target[targetIndex]
 
-            if !differentiable(targetElement).isContentEqual(to: differentiable(sourceElement)) {
+            if !targetElement.isContentEqual(to: sourceElement) {
                 updated.append(mapIndex(trackTargetIndexAsUpdated ? targetIndex : sourceIndex))
             }