ahmad-2785 / smartorderby

It intelligently sorts a sequence of items in a simple and practical way.

SmartOrderBy

It intelligently sorts a sequence of items in a simple and practical way.

SmartOrderBy is a method that aims to make the Queryable.OrderBy method smarter and is based on the foundations of .NET.

I would be very happy if you could star ⭐ the project.

Quick Start

The usage of SmartOrderBy is quite simple.

1. Install SmartOrderBy NuGet package from here.

PM> Install-Package SmartOrderBy

2. We add our Sorting object to our Request object.

public Sorting OrderBy { get; set; }

The structure of the Sorting object;

public class Sorting
{
    public string Name { get; set; }
    public string OrderType { get; set; }
}

Name => The name of the field to be sorted.

OrderType => The type of the order. It can be specified as "asc", "ascending", "a" or "desc", "descending", "d".

3. And we sort intelligently. And that's it.

[HttpPost("/publishers")]
public IActionResult GetPublishers(PublisherRequest request)
{
    var result = _context.Publishers
        .Include(x => x.Books)
        .ThenInclude(x => x.Author)
        .OrderBy(request.OrderBy)
        .ToList();

    return Ok(result);
}

Details

If you want to specify the name of the field you want to sort differently from the field in the entity, you need to map it.

👉 You can access the sample domain structure here. 👈

For example, if you want to make a sorting with the name bookId according to the Id field of the Book entity in Publisher, you will need to make a mapping as follows.

OrderByMapper.Map<Publisher, Book>("bookId", x => x.Id);

Or if you want to make a sort with the authorAge name according to the Age field of the Author entity in the Book entity in Publisher;

OrderByMapper.Map<Publisher, Book, Author>("authorAge", x => x.Age);

⭐ The important thing here is to specify the relevant entities in Map<TSource,T1,T2,...> respectively until you reach the sort field.