CollectionMerger 0.1.5

CollectionMerger

Synchronize/merge collections while generating a change report (added/updated/removed), including nested collection merges.

• Targets: net8.0, net9.0, net10.0
• Usage: Call .MapFrom(...) or .MapFromAsync(...) on any collection, passing another collection to merge from
• Output: SyncReport with a list of ChangeRecord items

See CHANGELOG.md for release history.

Installation

.NET CLI

dotnet add package CollectionMerger

Package Manager

Install-Package CollectionMerger

PackageReference

<PackageReference Include="CollectionMerger" Version="x.y.z" />

Getting started

You merge a source collection into a destination collection by providing:

• matchPredicate: how to match a source item to an existing destination item (usually by an ID)
• mapProperties: how to copy/update properties from source to destination
• isSourceDeleted (optional): treat a source item as deleted even when it exists in the source collection
• deleteDestination (optional): custom delete action for destination items (default removes from the collection)

Synchronous version

using CollectionMerger;

var destination = new List<Person>
{
    new() { Id = 1, Name = "Alice" },
    new() { Id = 2, Name = "Bob" }
};

var source = new List<PersonDto>
{
    new() { Id = 1, Name = "Alice Updated" },
    new() { Id = 3, Name = "Charlie" }
};

var report = destination.MapFrom(
    source: source,
    matchPredicate: (src, dest) => src.Id == dest.Id,
    mapProperties: (src, dest, _m) =>
    {
        dest.Id = src.Id;
        dest.Name = src.Name;
    });

Console.WriteLine($"Added: {report.AddedCount}, Updated: {report.UpdatedCount}, Removed: {report.RemovedCount}");

Async version

For async scenarios (e.g., fetching related data from a database, calling APIs), use MapFromAsync:

using CollectionMerger;

var report = await destination.MapFromAsync(
    source: source,
    matchPredicate: async (src, dest) =>
    {
        // Can perform async operations here
        return src.Id == dest.Id;
    },
    mapProperties: async (src, dest, _m) =>
    {
        dest.Id = src.Id;
        dest.Name = await FetchUpdatedNameAsync(src.Id); // Example async operation
    });

Console.WriteLine($"Added: {report.AddedCount}, Updated: {report.UpdatedCount}, Removed: {report.RemovedCount}");

Examples

Nested collections (people + cats)

For nested collections, call MapFrom(...) on the child collection and pass the parent Mapper so paths get nested.

using CollectionMerger;

var report = destinationPeople.MapFrom(
    source: sourcePeople,
    matchPredicate: (srcPerson, destPerson) => srcPerson.ID == destPerson.ID,
    mapProperties: (srcPerson, destPerson, m1) =>
    {
        destPerson.ID = srcPerson.ID;
        destPerson.Name = srcPerson.Name;

        destPerson.Cats.MapFrom(
            parent: m1,
            source: srcPerson.Cats,
            matchPredicate: (srcCat, destCat) => srcCat.ID == destCat.ID,
            mapProperties: (srcCat, destCat, _m2) =>
            {
                destCat.ID = srcCat.ID;
                destCat.Name = srcCat.Name;
            });
    });

Async nested collections

For async nested collections, use MapFromAsync:

using CollectionMerger;

var report = await destinationPeople.MapFromAsync(
    source: sourcePeople,
    matchPredicate: async (srcPerson, destPerson) => srcPerson.ID == destPerson.ID,
    mapProperties: async (srcPerson, destPerson, m1) =>
    {
        destPerson.ID = srcPerson.ID;
        destPerson.Name = srcPerson.Name;

        await destPerson.Cats.MapFromAsync(
            parent: m1,
            source: srcPerson.Cats,
            matchPredicate: async (srcCat, destCat) => srcCat.ID == destCat.ID,
            mapProperties: async (srcCat, destCat, _m2) =>
            {
                destCat.ID = srcCat.ID;
                destCat.Name = await FetchCatNameAsync(srcCat.ID); // Example async operation
            });
    });

Inspecting changes

foreach (var change in report.Changes)
{
    Console.WriteLine($"{change.ChangeType}: {change.Path}");

    if (change.PropertyChanges is null)
        continue;

    foreach (var prop in change.PropertyChanges)
        Console.WriteLine($"  - {prop.PropertyName}: '{prop.OldValue}' -> '{prop.NewValue}'");
}

Source-driven deletes + custom delete actions

Mark a source item as deleted and remove its destination match (default removal):

var report = destination.MapFrom(
    source: source,
    matchPredicate: (src, dest) => src.ID == dest.ID,
    mapProperties: (src, dest, _m) =>
    {
        dest.ID = src.ID;
        dest.Name = src.Name;
    },
    isSourceDeleted: src => src.Deleted);

Provide a custom delete action (soft delete instead of removing):

var report = destination.MapFrom(
    source: source,
    matchPredicate: (src, dest) => src.ID == dest.ID,
    mapProperties: (src, dest, _m) =>
    {
        dest.ID = src.ID;
        dest.Name = src.Name;
    },
    deleteDestination: dest => dest.Deleted = true);

What the report contains

SyncReport.Changes contains ChangeRecord entries:

• ChangeType: Added, Updated, or Removed
• Path: a stable-ish path for the item (supports nesting)
• Item: the destination item instance
• PropertyChanges: only present for Updated

FAQ

How are item paths created?

Paths look like Person[1] and Person[1].Cat[3].

The [...] value is chosen by looking for a public readable ID or Id property on either the source or destination item. If neither exists, it becomes ?.

What counts as an update?

After your mapProperties delegate runs, CollectionMerger snapshots public instance scalar properties (excluding enumerables except string) and records an Updated change if any of those values differ.

Are collections compared automatically?

No. Collection properties are ignored for property change detection. If you want nested changes, perform nested merges with the nested overload of MapFrom(...).

What are the requirements?

• Destination must be an ICollection<TDestination>
• TDestination must have a parameterless constructor (new() constraint)
• Matching behavior is entirely defined by your matchPredicate (make sure it uniquely identifies items)

Similar projects

AutoMapper.Collection

CollectionMerger is similar to AutoMapper.Collection.

Key differences:

• No Entity Framework dependency: CollectionMerger does not have a dependency on Entity Framework, but Entity Framework can be used with it.
• Soft deletes: Supports soft deletes, or even not deleting at all.
• Async/await: Supports async/await patterns.
• Low-level approach: Feels more low level than AutoMapper.Collection, giving you more control.
• No external dependencies: Has no external dependencies.

Feedback / issues

If you hit a bug or want to request a feature, please open an issue: https://github.com/alexdresko/collection-merger/issues

Development (this repo)

Releasing

Releases are automated via Release Please.

• Merge changes into main using Conventional Commits.
• Release Please will open/maintain a release PR updating CHANGELOG.md and package version.
• Merging the release PR creates the GitHub Release + publishes to NuGet.

GitHub setup

The release workflow expects a GitHub Actions secret:

• NUGET_API_KEY (or NUGET_TOKEN): a NuGet.org API key with permission to push packages.