< Summary - Code Coverage

Information
Class: Plainquire.Sort.Swashbuckle.Filters.EntitySortSetParameterReplacer
Assembly: Plainquire.Sort.Swashbuckle
File(s): /home/runner/work/plainquire/plainquire/Plainquire.Sort/Plainquire.Sort.Swashbuckle/Filters/EntitySortSetParameterReplacer.cs
Tag: 70_19770578580
Line coverage
97%
Covered lines: 33
Uncovered lines: 1
Coverable lines: 34
Total lines: 81
Line coverage: 97%
Branch coverage
75%
Covered branches: 12
Total branches: 16
Branch coverage: 75%
Method coverage
100%
Covered methods: 4
Total methods: 4
Method coverage: 100%

Metrics

MethodBranch coverage Cyclomatic complexity NPath complexity Sequence coverage
.ctor(...)83.33%66100%
Apply(...)50%22100%
IsEntitySortSetParameter(...)50%22100%
GetConfiguration(...)66.66%6675%

File(s)

/home/runner/work/plainquire/plainquire/Plainquire.Sort/Plainquire.Sort.Swashbuckle/Filters/EntitySortSetParameterReplacer.cs

#LineLine coverage
 1using Microsoft.AspNetCore.Mvc.ApiExplorer;
 2using Microsoft.Extensions.DependencyInjection;
 3using Microsoft.Extensions.Options;
 4using Microsoft.OpenApi;
 5using Plainquire.Filter.Abstractions;
 6using Plainquire.Sort.Abstractions;
 7using Plainquire.Sort.Swashbuckle.Models;
 8using Swashbuckle.AspNetCore.SwaggerGen;
 9using System;
 10using System.Collections.Generic;
 11using System.Diagnostics.CodeAnalysis;
 12using System.Linq;
 13using System.Reflection;
 14
 15namespace Plainquire.Sort.Swashbuckle.Filters;
 16
 17/// <summary>
 18/// Replaces action parameters of type <see cref="IOperationFilter"/> with filterable properties of type <c>TEntity</c>.
 19/// Implements <see cref="IOperationFilter" />
 20/// </summary>
 21/// <seealso cref="EntitySort" />
 22[SuppressMessage("ReSharper", "ClassNeverInstantiated.Global", Justification = "Created by reflection")]
 23public class EntitySortSetParameterReplacer : IOperationFilter
 24{
 25    private readonly IServiceProvider _serviceProvider;
 26    private readonly SortConfiguration _defaultConfiguration;
 27
 28    /// <summary>
 29    /// Initializes a new instance of the <see cref="EntitySortSetParameterReplacer"/> class.
 30    /// </summary>
 31    /// <param name="serviceProvider"></param>
 32    public EntitySortSetParameterReplacer(IServiceProvider serviceProvider)
 33    {
 3234        _serviceProvider = serviceProvider;
 3235        _defaultConfiguration = _serviceProvider.GetService<IOptions<SortConfiguration>>()?.Value ?? SortConfiguration.D
 3236    }
 37
 38    /// <inheritdoc />
 39    public void Apply(OpenApiOperation operation, OperationFilterContext context)
 40    {
 2941        operation.Parameters ??= new List<IOpenApiParameter>();
 2942        var parametersToReplace = operation.Parameters
 2943            .Join(
 2944                context.ApiDescription.ParameterDescriptions,
 2945                parameter => parameter.Name,
 2946                description => description.Name,
 2947                (parameter, description) => (Parameter: parameter, Description: description),
 2948                StringComparer.OrdinalIgnoreCase
 2949            )
 2950            .Where(openApi => IsEntitySortSetParameter(openApi.Description))
 2951            .SelectMany(openApi =>
 2952                openApi.Description.ParameterDescriptor
 2953                    .ParameterType
 2954                    .GetProperties()
 2955                    .Select(x => x.PropertyType)
 2956                    .Where(type => type.IsGenericEntitySort())
 2957                    .Select(entitySortType => new SortParameterReplacement(
 2958                        OpenApiParameter: openApi.Parameter,
 2959                        OpenApiDescription: openApi.Description,
 2960                        SortedType: entitySortType.GenericTypeArguments[0],
 2961                        Configuration: GetConfiguration(entitySortType))
 2962                    )
 2963            )
 2964            .ToList();
 65
 2966        operation.ReplaceSortParameters(parametersToReplace);
 2967    }
 68
 69    [SuppressMessage("ReSharper", "ConditionalAccessQualifierIsNonNullableAccordingToAPIContract", Justification = "Para
 70    private static bool IsEntitySortSetParameter(ApiParameterDescription description)
 9071        => description.ParameterDescriptor?.ParameterType.GetCustomAttribute<EntitySortSetAttribute>() != null;
 72
 73    private SortConfiguration GetConfiguration(Type entitySortType)
 74    {
 3075        if (!entitySortType.IsGenericEntitySort())
 076            throw new ArgumentException("Type is not an EntitySort<>", nameof(entitySortType));
 77
 3078        var entityTypeConfiguration = ((EntitySort?)_serviceProvider.GetService(entitySortType))?.Configuration;
 3079        return entityTypeConfiguration ?? _defaultConfiguration;
 80    }
 81}