CoreEx/src/CoreEx.Data/Querying/QueryExtensions.cs at main · Avanade/CoreEx · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
namespace CoreEx.Data.Querying;

/// <summary>
/// Provides query-oriented extension methods.
/// </summary>
public static class QueryExtensions
{
    /// <summary>
    /// Adds a dynamic query <see cref="QueryArgs.Filter"/> (basic dynamic <i>OData-like</i> <c>$filter</c> statement).
    /// </summary>
    /// <typeparam name="TSource">The <paramref name="source"/> element <see cref="Type"/>.</typeparam>
    /// <param name="source">The sequence of elements.</param>
    /// <param name="queryConfig">The <see cref="QueryArgsConfig"/>.</param>
    /// <param name="queryArgs">The <see cref="QueryArgs"/>.</param>
    /// <returns>The query.</returns>
    public static IQueryable<TSource> Where<TSource>(this IQueryable<TSource> source, QueryArgsConfig queryConfig, QueryArgs? queryArgs = null) => Where(source, queryConfig, queryArgs?.Filter);

    /// <summary>
    /// Adds a dynamic query <paramref name="filter"/> (basic dynamic <i>OData-like</i> <c>$filter</c> statement).
    /// </summary>
    /// <typeparam name="TSource">The <paramref name="source"/> element <see cref="Type"/>.</typeparam>
    /// <param name="source">The sequence of elements.</param>
    /// <param name="queryConfig">The <see cref="QueryArgsConfig"/>.</param>
    /// <param name="filter">The basic dynamic <i>OData-like</i> <c>$filter</c> statement.</param>
    /// <returns>The query.</returns>
    public static IQueryable<TSource> Where<TSource>(this IQueryable<TSource> source, QueryArgsConfig queryConfig, string? filter)
    {
        queryConfig.ThrowIfNull();
        if (!queryConfig.HasFilterParser && !string.IsNullOrEmpty(filter))
            throw new QueryFilterParserException("Query filter statement is not currently supported.");

        if (!queryConfig.HasFilterParser)
            return source;

        var result = queryConfig.FilterParser.Parse(filter).ThrowOnError();
        var linq = result.ToLinqString(out var args);
        return string.IsNullOrEmpty(linq) ? source : source.Where(result.Config.ParsingConfig, linq, [.. args]);
    }

    /// <summary>
    /// Adds a dynamic query filter (basic dynamic <i>OData-like</i> <c>$filter</c> statement).
    /// </summary>
    /// <typeparam name="TSource">The <paramref name="source"/> element <see cref="Type"/>.</typeparam>
    /// <param name="source">The sequence of elements.</param>
    /// <param name="result">The <see cref="QueryArgsParseResult"/> that contains the parsed dynamic <i>OData-like</i> <c>$filter</c> statement.</param>
    /// <returns>The query.</returns>
    public static IQueryable<TSource> Where<TSource>(this IQueryable<TSource> source, QueryArgsParseResult result)
    {
        result.ThrowIfNull().ThrowOnError();
        if (result.FilterResult is null)
            return source;

        var linq = result.FilterResult.ToLinqString(out var args);
        return string.IsNullOrEmpty(linq) ? source : source.Where(result.Config.ParsingConfig, linq, [.. args]);
    }

    /// <summary>
    /// Adds a dynamic query <see cref="QueryArgs.OrderBy"/> (basic dynamic <i>OData-like</i> <c>$orderby</c> statement).
    /// </summary>
    /// <typeparam name="TSource">The <paramref name="source"/> element <see cref="Type"/>.</typeparam>
    /// <param name="source">The sequence of elements.</param>
    /// <param name="queryConfig">The <see cref="QueryArgsConfig"/>.</param>
    /// <param name="queryArgs">The <see cref="QueryArgs"/>.</param>
    /// <returns>The query.</returns>
    public static IQueryable<TSource> OrderBy<TSource>(this IQueryable<TSource> source, QueryArgsConfig queryConfig, QueryArgs? queryArgs = null) => OrderBy(source, queryConfig, queryArgs?.OrderBy);

    /// <summary>
    /// Adds a dynamic query <paramref name="orderby"/> (basic dynamic <i>OData-like</i> <c>$orderby</c> statement).
    /// </summary>
    /// <typeparam name="TSource">The <paramref name="source"/> element <see cref="Type"/>.</typeparam>
    /// <param name="source">The sequence of elements.</param>
    /// <param name="queryConfig">The <see cref="QueryArgsConfig"/>.</param>
    /// <param name="orderby">The basic dynamic <i>OData-like</i> <c>$orderby</c> statement.</param>
    /// <returns>The query.</returns>
    public static IQueryable<TSource> OrderBy<TSource>(this IQueryable<TSource> source, QueryArgsConfig queryConfig, string? orderby)
    {
        queryConfig.ThrowIfNull();
        if (!queryConfig.HasOrderByParser && !string.IsNullOrEmpty(orderby))
            throw new QueryOrderByParserException("OrderBy filter is not currently supported.");

        if (!queryConfig.HasOrderByParser)
            return source;

        var result = queryConfig.OrderByParser.Parse(orderby).ThrowOnError();
        var linq = result.ToLinqString();
        return string.IsNullOrEmpty(linq) ? source : source.OrderBy(linq);
    }

    /// <summary>
    /// Adds a dynamic query order-by (basic dynamic <i>OData-like</i> <c>$orderby</c> statement).
    /// </summary>
    /// <typeparam name="TSource">The <paramref name="source"/> element <see cref="Type"/>.</typeparam>
    /// <param name="source">The sequence of elements.</param>
    /// <param name="result">The <see cref="QueryArgsParseResult"/> that contains the parsed dynamic <i>OData-like</i> <c>$orderby</c> statement.</param>
    /// <returns>The query.</returns>
    public static IQueryable<TSource> OrderBy<TSource>(this IQueryable<TSource> source, QueryArgsParseResult result)
    {
        result.ThrowIfNull().ThrowOnError();
        if (result.OrderByResult is null)
            return source;

        var linq = result.OrderByResult.ToLinqString();
        return string.IsNullOrEmpty(linq) ? source : source.OrderBy(linq);
    }
}