Merge pull request #1293 from json-api-dotnet/merge-master-v5.3.0-into-openapi

Merge master v5.3.0 into openapi

Author: bkoelman

.config/dotnet-tools.json

@@ -3,13 +3,13 @@
   "isRoot": true,
   "tools": {
     "jetbrains.resharper.globaltools": {
-      "version": "2023.1.0",
+      "version": "2023.1.2",
       "commands": [
         "jb"
       ]
     },
     "regitlint": {
-      "version": "6.3.10",
+      "version": "6.3.11",
       "commands": [
         "regitlint"
       ]
@@ -21,13 +21,13 @@
       ]
     },
     "dotnet-reportgenerator-globaltool": {
-      "version": "5.1.19",
+      "version": "5.1.20",
       "commands": [
         "reportgenerator"
       ]
     },
     "docfx": {
-      "version": "2.62.2",
+      "version": "2.67.1",
       "commands": [
         "docfx"
       ]

.editorconfig

@@ -8,7 +8,7 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{config,csproj,css,js,json,props,ruleset,xslt}]
+[*.{config,csproj,css,js,json,props,ruleset,xslt,html}]
 indent_size = 2
 
 [*.{cs}]

Directory.Build.props

@@ -4,13 +4,13 @@
     <AspNetVersion>6.0.*</AspNetVersion>
     <EFCoreVersion>7.0.*</EFCoreVersion>
     <EFCorePostgresVersion>7.0.*</EFCorePostgresVersion>
-    <MicrosoftCodeAnalysisVersion>4.5.*</MicrosoftCodeAnalysisVersion>
+    <MicrosoftCodeAnalysisVersion>4.6.*</MicrosoftCodeAnalysisVersion>
     <HumanizerVersion>2.14.1</HumanizerVersion>
-    <SwashbuckleVersion>6.4.*</SwashbuckleVersion>
-    <NSwagApiClientVersion>13.16.*</NSwagApiClientVersion>
-    <MicrosoftApiClientVersion>6.0.*</MicrosoftApiClientVersion>
+    <SwashbuckleVersion>6.5.*</SwashbuckleVersion>
+    <NSwagApiClientVersion>13.19.*</NSwagApiClientVersion>
+    <MicrosoftApiClientVersion>7.0.*</MicrosoftApiClientVersion>
     <NewtonsoftJsonVersion>13.0.*</NewtonsoftJsonVersion>
-    <JsonApiDotNetCoreVersionPrefix>5.2.1</JsonApiDotNetCoreVersionPrefix>
+    <JsonApiDotNetCoreVersionPrefix>5.3.1</JsonApiDotNetCoreVersionPrefix>
     <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodingGuidelines.ruleset</CodeAnalysisRuleSet>
     <WarningLevel>9999</WarningLevel>
     <Nullable>enable</Nullable>
@@ -20,7 +20,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="JetBrains.Annotations" Version="2022.3.1" PrivateAssets="All" />
+    <PackageReference Include="JetBrains.Annotations" Version="2023.2.0" PrivateAssets="All" />
     <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.8.3" PrivateAssets="All" />
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)CSharpGuidelinesAnalyzer.config" Visible="False" />
   </ItemGroup>
@@ -37,8 +37,8 @@
 
   <!-- Test Project Dependencies -->
   <PropertyGroup>
-    <CoverletVersion>3.2.*</CoverletVersion>
+    <CoverletVersion>6.0.*</CoverletVersion>
     <MoqVersion>4.18.*</MoqVersion>
-    <TestSdkVersion>17.5.*</TestSdkVersion>
+    <TestSdkVersion>17.6.*</TestSdkVersion>
   </PropertyGroup>
 </Project>

PackageReadme.md

@@ -0,0 +1,5 @@
+A framework for building [JSON:API](http://jsonapi.org/) compliant REST APIs using .NET Core and Entity Framework Core. Includes support for [Atomic Operations](https://jsonapi.org/ext/atomic/).
+
+The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection, making extensibility incredibly easy.
+
+For more information, visit [www.jsonapi.net](https://www.jsonapi.net/).

README.md

@@ -130,3 +130,8 @@ Alternatively, to build and validate the code, run all tests, generate code cove
 ```bash
 pwsh Build.ps1
 ```
+
+## Sponsors
+
+<a href="https://jb.gg/OpenSourceSupport"><img align="middle" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg" alt="JetBrains Logo" style="width:150px"></a> &nbsp;
+<a href="https://www.araxis.com/buy/open-source"><img align="middle" src="https://www.araxis.com/theme/37/img/araxis-logo-lg.svg" alt="Araxis Logo" style="width:150px"></a>

appveyor.yml

@@ -67,6 +67,7 @@ for:
         Copy-Item CNAME _site/CNAME
         Copy-Item home/*.html _site/
         Copy-Item home/*.ico _site/
+        New-Item -Force _site/styles -ItemType Directory | Out-Null
         Copy-Item -Recurse home/assets/* _site/styles/
         CD _site
         git add -A 2>&1

benchmarks/QueryString/QueryStringParserBenchmarks.cs

@@ -4,8 +4,8 @@
 using JsonApiDotNetCore;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
+using JsonApiDotNetCore.Queries.Parsing;
 using JsonApiDotNetCore.QueryStrings;
-using JsonApiDotNetCore.QueryStrings.Internal;
 using JsonApiDotNetCore.Resources;
 using Microsoft.Extensions.Logging.Abstractions;
 
@@ -37,11 +37,23 @@ public QueryStringParserBenchmarks()
 
         var resourceFactory = new ResourceFactory(new ServiceContainer());
 
-        var includeReader = new IncludeQueryStringParameterReader(request, resourceGraph, options);
-        var filterReader = new FilterQueryStringParameterReader(request, resourceGraph, resourceFactory, options);
-        var sortReader = new SortQueryStringParameterReader(request, resourceGraph);
-        var sparseFieldSetReader = new SparseFieldSetQueryStringParameterReader(request, resourceGraph);
-        var paginationReader = new PaginationQueryStringParameterReader(request, resourceGraph, options);
+        var includeParser = new IncludeParser(options);
+        var includeReader = new IncludeQueryStringParameterReader(includeParser, request, resourceGraph);
+
+        var filterScopeParser = new QueryStringParameterScopeParser();
+        var filterValueParser = new FilterParser(resourceFactory);
+        var filterReader = new FilterQueryStringParameterReader(filterScopeParser, filterValueParser, request, resourceGraph, options);
+
+        var sortScopeParser = new QueryStringParameterScopeParser();
+        var sortValueParser = new SortParser();
+        var sortReader = new SortQueryStringParameterReader(sortScopeParser, sortValueParser, request, resourceGraph);
+
+        var sparseFieldSetScopeParser = new SparseFieldTypeParser(resourceGraph);
+        var sparseFieldSetValueParser = new SparseFieldSetParser();
+        var sparseFieldSetReader = new SparseFieldSetQueryStringParameterReader(sparseFieldSetScopeParser, sparseFieldSetValueParser, request, resourceGraph);
+
+        var paginationParser = new PaginationParser();
+        var paginationReader = new PaginationQueryStringParameterReader(paginationParser, request, resourceGraph, options);
 
         IQueryStringParameterReader[] readers = ArrayFactory.Create<IQueryStringParameterReader>(includeReader, filterReader, sortReader,
             sparseFieldSetReader, paginationReader);

benchmarks/Serialization/OperationsSerializationBenchmarks.cs

@@ -3,7 +3,6 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
-using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
 

benchmarks/Serialization/ResourceSerializationBenchmarks.cs

@@ -6,7 +6,6 @@
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
-using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Serialization.Objects;
 

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -5,7 +5,6 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
-using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Serialization.Response;

benchmarks/Tools/NeverResourceDefinitionAccessor.cs

@@ -2,6 +2,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries.Expressions;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 
@@ -13,6 +14,7 @@ namespace Benchmarks.Tools;
 internal sealed class NeverResourceDefinitionAccessor : IResourceDefinitionAccessor
 {
     bool IResourceDefinitionAccessor.IsReadOnlyRequest => throw new NotImplementedException();
+    public IQueryableBuilder QueryableBuilder => throw new NotImplementedException();
 
     public IImmutableSet<IncludeElementExpression> OnApplyIncludes(ResourceType resourceType, IImmutableSet<IncludeElementExpression> existingIncludes)
     {

docs/build-dev.ps1

@@ -37,11 +37,15 @@ if (-Not $NoBuild -Or -Not (Test-Path -Path _site)) {
     Invoke-Expression ./generate-examples.ps1
 }
 
+dotnet tool restore
+VerifySuccessExitCode
+
 dotnet docfx ./docfx.json
 VerifySuccessExitCode
 
 Copy-Item -Force home/*.html _site/
 Copy-Item -Force home/*.ico _site/
+New-Item -Force _site/styles -ItemType Directory | Out-Null
 Copy-Item -Force -Recurse home/assets/* _site/styles/
 
 cd _site

docs/docfx.json

@@ -40,7 +40,7 @@
         "dest": "_site",
         "globalMetadataFiles": [],
         "fileMetadataFiles": [],
-        "template": [ "default" ],
+        "template": [ "default", "modern" ],
         "postProcessors": [],
         "noLangKeyword": false,
         "keepFileLink": false,

docs/home/assets/fonts/icofont.eot

@@ -95,7 +95,6 @@ h1, h2, h3, h4, h5, h6, .font-primary {
   margin-top: 72px;
 }
 
-
 /*--------------------------------------------------------------
 # Hero Section
 --------------------------------------------------------------*/
@@ -300,12 +299,6 @@ section {
   .breadcrumbs ol li {
     display: inline-block;
   }
-
-
-}
-
-div[feature]:hover {
-  cursor: pointer;
 }
 
 /*--------------------------------------------------------------
@@ -401,6 +394,34 @@ div[feature]:hover {
   margin-bottom: 0;
 }
 
+div[feature]:hover {
+  cursor: pointer;
+}
+
+/*--------------------------------------------------------------
+# Sponsors
+--------------------------------------------------------------*/
+.sponsors .icon-box {
+  padding: 30px;
+  position: relative;
+  overflow: hidden;
+  margin: 0 0 40px 0;
+  background: #fff;
+  box-shadow: 0 10px 29px 0 rgba(68, 88, 144, 0.1);
+  transition: all 0.3s ease-in-out;
+  border-radius: 15px;
+  text-align: center;
+  border-bottom: 3px solid #fff;
+}
+
+.sponsors .icon-box:hover {
+  transform: translateY(-5px);
+  border-color: #ef7f4d;
+}
+
+div[sponsor]:hover {
+  cursor: pointer;
+}
 
 /*--------------------------------------------------------------
 # Footer

docs/home/assets/fonts/icofont.svg

@@ -38,7 +38,6 @@
     }
   });
 
-
   // Feature panels linking
   $('div[feature]#filter').on('click', () => navigateTo('usage/reading/filtering.html'));
   $('div[feature]#sort').on('click', () => navigateTo('usage/reading/sorting.html'));
@@ -49,13 +48,19 @@
   $('div[feature]#validation').on('click', () => navigateTo('usage/options.html#enable-modelstate-validation'));
   $('div[feature]#customizable').on('click', () => navigateTo('usage/extensibility/resource-definitions.html'));
 
-
   const navigateTo = (url) => {
-    if (!window.getSelection().toString()){
+    if (!window.getSelection().toString()) {
       window.location = url;
     }
   }
 
+  // Sponsor panels linking
+  $('div[sponsor]#jetbrains').on('click', () => navigateExternalTo('https://jb.gg/OpenSourceSupport'));
+  $('div[sponsor]#araxis').on('click', () => navigateExternalTo('https://www.araxis.com/buy/open-source'));
+
+  const navigateExternalTo = (url) => {
+    window.open(url, "_blank");
+  }
 
   hljs.initHighlightingOnLoad()