Add update and move support

[winstondu]

Checklist

• [x] All tests are passed.
• [x] Added tests (N/A)
• [x] Documented the code using Xcode markup.
• [x] Searched existing pull requests for ensure not duplicated.

Description

The current code was not correctly leveraging DifferenceKit to address moves and updates. In particular, it was not distinguishing changes in content versus changes in the identifier.

This code change ensures that the difference identifier is no longer of the whole Item, but instead just the hashValue of the Item (as determined by the implemention of Item.)

For a visualization of the difference, please see the below gifs (the example iOS code in this repo was slightly modified to illustrate this).

For a clear conceptual example of the correction that this pull request sets out to accomplish, consider if Item was the following:

struct person: Hashable {
    var birthName : String  // Assume this is our unique identifier for a person.
    var age : Int
    func hash(into hasher: inout Hasher) {
            hasher.combine(birthName)
   }
}

And we had to compare the datasource diff of the following lists (being used as datasource updates for a collectionview): Source: [(birthName: "Andy", age: 15), (birthName: "Kevin", age: 16)]
Target: [(birthName: "Kevin", age: 16)]

Without the change in this pull request, we get 2 deletions and 1 insertion (animated as such)

With this change in this PR , we get 1 deletion and 1 update (correctly animated).

Related Issue

N/A

Motivation and Context

The motivation was for a better, and more correct, diff animation.

Impact on Existing Code

None beyond what is described.

Screenshots

Notice the "move" animations that occur in after that do not happen in before

Before:

After:

[winstondu]

@ra1028

[ollitapa]

Seems really welcome fix in my opinion! 👍

Just for clarification, do I understand correctly:

I have item with automatic hash and equality:

struct MyText: Hashable, Equatable {
    var id: Int
    var text: String
}

Change [ {id: 1, text: "a"} ] -> [ {id: 1, text: "b"} ] will result in one deletion and one insert.

but

struct MyText: Hashable, Equatable {
    var id: Int
    var text: String

    func hash(into hasher: inout Hasher) {
        hasher.combine(id)
    }
}

[ {id: 1, text: "a"} ] -> [ {id: 1, text: "b"} ] will result in one update.

[winstondu]

@ollitapa , that is correct.

[winstondu]

@ra1028 , awaiting your approval to merge :)

[ollitapa]

@ra1028 ping. Would be nice to get this merged 😄

[ra1028]

Thanks @winstondu and reviewers.

Sorry for my late reply.

I think it's difficult to judge this specification change. I agree with its behavior, but it works differently than the original version UICollectionViewDiffableDataSource. Because, DiffableDataSources is only a backport, differences between the original version and the specification can adversely affect future replacements.