Merge pull request #67 from marcominerva/develop

marcominerva · web-flow · commit 487ffb3339ad · 2024-12-09T12:34:08.000+01:00
Update to .NET 9.0
diff --git a/.editorconfig b/.editorconfig
@@ -131,6 +131,7 @@ csharp_prefer_braces = true:silent
 csharp_prefer_simple_using_statement = true:suggestion
 csharp_style_namespace_declarations = file_scoped:suggestion
 csharp_style_prefer_method_group_conversion = true:silent
+csharp_prefer_system_threading_lock = true:suggestion
 
 # Expression-level preferences
 csharp_prefer_simple_default_expression = true:suggestion
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -12,7 +12,7 @@ on:
     - cron: '0 0 1,15 * *'
     
 env:
-  NET_VERSION: '7.x'
+  NET_VERSION: '9.x'
     
 jobs:
   analyze:
@@ -41,10 +41,10 @@ jobs:
       with:
         dotnet-version: ${{ env.NET_VERSION }}
         dotnet-quality: 'ga'
-        
+
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,11 +53,11 @@ jobs:
         
         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
-
+        
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ?? Command-line programs to run using the OS shell.
     # ?? See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -70,4 +70,4 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -40,7 +40,7 @@ jobs:
       # Run Linter against code base #
       ################################
       - name: Lint Code Base
-        uses: github/super-linter@v4
+        uses: super-linter/super-linter@v7.2.0
         env:
           LINTER_RULES_PATH: '.'
           EDITORCONFIG_FILE_NAME: '.editorconfig'
diff --git a/.github/workflows/publish_fluentvalidation.yml b/.github/workflows/publish_fluentvalidation.yml
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  NET_VERSION: '8.x'
+  NET_VERSION: '9.x'
   PROJECT_NAME: src/MinimalHelpers.FluentValidation 
   PROJECT_FILE: MinimalHelpers.FluentValidation.csproj
   TAG_NAME: fluentvalidation
diff --git a/.github/workflows/publish_openapi.yml b/.github/workflows/publish_openapi.yml
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  NET_VERSION: '8.x'
+  NET_VERSION: '9.x'
   PROJECT_NAME: src/MinimalHelpers.OpenApi 
   PROJECT_FILE: MinimalHelpers.OpenApi.csproj
   TAG_NAME: openapi
diff --git a/.github/workflows/publish_routing.yml b/.github/workflows/publish_routing.yml
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  NET_VERSION: '8.x'
+  NET_VERSION: '9.x'
   PROJECT_NAME: src/MinimalHelpers.Routing 
   PROJECT_FILE: MinimalHelpers.Routing.csproj
   TAG_NAME: routing
diff --git a/.github/workflows/publish_routing_analyzers.yml b/.github/workflows/publish_routing_analyzers.yml
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  NET_VERSION: '8.x'
+  NET_VERSION: '9.x'
   PROJECT_NAME: src/MinimalHelpers.Routing.Analyzers 
   PROJECT_FILE: MinimalHelpers.Routing.Analyzers.csproj
   TAG_NAME: routing-analyzers
diff --git a/.github/workflows/publish_validation.yml b/.github/workflows/publish_validation.yml
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  NET_VERSION: '8.x'
+  NET_VERSION: '9.x'
   PROJECT_NAME: src/MinimalHelpers.Validation 
   PROJECT_FILE: MinimalHelpers.Validation.csproj
   TAG_NAME: validation
diff --git a/README.md b/README.md
@@ -24,26 +24,6 @@ dotnet add package MinimalHelpers.Routing
 
 Create a class to hold your route handlers registration and make it implementing the `IEndpointRouteHandlerBuilder` interface:
 
-**.NET 6.0**
-
-```csharp
-public class PeopleEndpoints : MinimalHelpers.Routing.IEndpointRouteHandlerBuilder
-{
-    public void MapEndpoints(IEndpointRouteBuilder endpoints)
-    {
-        endpoints.MapGet("/api/people", GetList);
-        endpoints.MapGet("/api/people/{id:guid}", Get);
-        endpoints.MapPost("/api/people", Insert);
-        endpoints.MapPut("/api/people/{id:guid}", Update);
-        endpoints.MapDelete("/api/people/{id:guid}", Delete);
-    }
-
-    // ...
-}
-```
-
-**.NET 7.0 or higher**
-
 ```csharp
 public class PeopleEndpoints : MinimalHelpers.Routing.IEndpointRouteHandlerBuilder
 {
@@ -60,9 +40,6 @@ public class PeopleEndpoints : MinimalHelpers.Routing.IEndpointRouteHandlerBuild
 }
 ```
 
-> **Note**
-Starting from .NET 7.0, the `IEndpointRouteHandlerBuilder` interface exposes the `MapEndpoints` method as static abstract, so it can be called without creating an instance of the handler.
-
 Call the `MapEndpoints()` extension method on the **WebApplication** object inside *Program.cs* before the `Run()` method invocation:
 
 ```csharp
@@ -94,9 +71,7 @@ app.MapEndpoints(type =>
 > **Note**
 These methods rely on Reflection to scan the Assembly and find the classes that implement the `IEndpointRouteHandlerBuilder` interface. This can have a performance impact, especially in large projects. If you have performance issues, consider using the explicit registration method. Moreover, this solution is incompatibile with Native AOT.
 
-If you're working with .NET 7.0 or higher, the reccommended approach is to use the **MinimalHelpers.Routing.Analyzers** package, that provides a Source Generator for endpoints registration, as described later.
-
-## MinimalHelpers.Routing.Analyzers (.NET 7.0 or higher)
+## MinimalHelpers.Routing.Analyzers
 
 [![Nuget](https://img.shields.io/nuget/v/MinimalHelpers.Routing.Analyzers)](https://www.nuget.org/packages/MinimalHelpers.Routing.Analyzers)
 [![Nuget](https://img.shields.io/nuget/dt/MinimalHelpers.Routing.Analyzers)](https://www.nuget.org/packages/MinimalHelpers.Routing.Analyzers)
diff --git a/samples/MinimalSample/MinimalSample.csproj b/samples/MinimalSample/MinimalSample.csproj
@@ -1,15 +1,16 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk.Web">
 
 	<PropertyGroup>
-		<TargetFramework>net8.0</TargetFramework>
+		<TargetFramework>net9.0</TargetFramework>
 		<Nullable>enable</Nullable>
 		<ImplicitUsings>enable</ImplicitUsings>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="11.10.0" />
-		<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.10" />
-		<PackageReference Include="Swashbuckle.AspNetCore" Version="6.9.0" />
+		<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="11.11.0" />
+		<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
+		<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="7.1.0" />
+		<PackageReference Include="TinyHelpers.AspNetCore" Version="4.0.5" />
 	</ItemGroup>
 
 	<ItemGroup>
diff --git a/samples/MinimalSample/Program.cs b/samples/MinimalSample/Program.cs
@@ -1,10 +1,13 @@
 using FluentValidation;
 using MinimalHelpers.Validation;
+using TinyHelpers.AspNetCore.OpenApi;
 
 var builder = WebApplication.CreateBuilder(args);
 
-builder.Services.AddEndpointsApiExplorer();
-builder.Services.AddSwaggerGen();
+builder.Services.AddOpenApi(options =>
+{
+    options.AddDefaultResponse();
+});
 
 builder.Services.AddValidatorsFromAssemblyContaining<Program>();
 
@@ -28,8 +31,11 @@
 
 if (app.Environment.IsDevelopment())
 {
-    app.UseSwagger();
-    app.UseSwaggerUI();
+    app.MapOpenApi();
+    app.UseSwaggerUI(options =>
+    {
+        options.SwaggerEndpoint("/openapi/v1.json", builder.Environment.ApplicationName);
+    });
 }
 
 // Maps all the endpoints.
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -9,7 +9,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.143"  PrivateAssets="All" />
+        <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.146"  PrivateAssets="All" />
     </ItemGroup>
 
 </Project>
diff --git a/src/MinimalHelpers.FluentValidation/MinimalHelpers.FluentValidation.csproj b/src/MinimalHelpers.FluentValidation/MinimalHelpers.FluentValidation.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net8.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
         <LangVersion>latest</LangVersion>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
@@ -40,7 +40,7 @@
     </ItemGroup>
 
     <ItemGroup>
-      <PackageReference Include="FluentValidation" Version="11.10.0" />
+      <PackageReference Include="FluentValidation" Version="11.11.0" />
     </ItemGroup>
 
     <ItemGroup>
@@ -54,7 +54,7 @@
 
     <Target Name="IncludeProjectReferenceDlls" DependsOnTargets="BuildOnlySettings;ResolveReferences">
         <ItemGroup>
-            <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->WithMetadataValue('PrivateAssets', 'All'))"/>
+            <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths-&gt;WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')-&gt;WithMetadataValue('PrivateAssets', 'All'))" />
         </ItemGroup>
     </Target>
 </Project>
diff --git a/src/MinimalHelpers.FluentValidation/version.json b/src/MinimalHelpers.FluentValidation/version.json
@@ -1,6 +1,6 @@
 {
 	"$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-	"version": "1.0",
+	"version": "1.1",
 	"publicReleaseRefSpec": [
 		"^refs/heads/master$" // we release out of master
 	],
diff --git a/src/MinimalHelpers.OpenApi/MinimalHelpers.OpenApi.csproj b/src/MinimalHelpers.OpenApi/MinimalHelpers.OpenApi.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net8.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
         <LangVersion>latest</LangVersion>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
@@ -29,6 +29,14 @@
         <FrameworkReference Include="Microsoft.AspNetCore.App" />
     </ItemGroup>
 
+    <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.11" />
+    </ItemGroup>
+    
+    <ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
+    </ItemGroup>
+
     <ItemGroup>
         <None Include="..\..\Toolbox.png">
             <Pack>True</Pack>
@@ -37,7 +45,4 @@
         <None Include="..\..\README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
-    <ItemGroup>
-      <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.9.0" />
-    </ItemGroup>
 </Project>
diff --git a/src/MinimalHelpers.OpenApi/OpenApiExtensions.cs b/src/MinimalHelpers.OpenApi/OpenApiExtensions.cs
@@ -1,27 +1,12 @@
-﻿using Microsoft.AspNetCore.Http;
-using Microsoft.OpenApi.Models;
-using Swashbuckle.AspNetCore.SwaggerGen;
+﻿using Microsoft.OpenApi.Models;
 
 namespace MinimalHelpers.OpenApi;
 
 /// <summary>
-/// Provides extension methods for <see cref="SwaggerGenOptions"/>.
+/// Provides extension methods for OpenAPI objects.
 /// </summary>
-public static class SwaggerExtensions
+public static class OpenApiExtensions
 {
-    /// <summary>
-    /// Adds an <see cref="IOperationFilter"/> that fixes <see langword="swagger.json"/> generation for <see cref="IFormFile"/> and <see cref="IFormFileCollection"/> parameters when using the <see langword="WithOpenApi"/> extension method on endpoints.
-    /// </summary>
-    /// <param name="options">The <see cref="SwaggerGenOptions"/> that contains the options to generate Swagger documentation.</param>
-    /// <seealso cref="IFormFile"/>
-    /// <seealso cref="IFormFileCollection"/>
-    /// <seealso cref="SwaggerGenOptions"/>
-    /// <seealso cref="IOperationFilter"/>
-    [Obsolete("This method is no longer necessary and will be removed in a future version")]
-    public static void AddFormFile(this SwaggerGenOptions options)
-    {
-    }
-
     /// <summary>
     /// Gets the <see cref="OpenApiParameter"/> by name from the specified list of parameters.
     /// </summary>
diff --git a/src/MinimalHelpers.OpenApi/version.json b/src/MinimalHelpers.OpenApi/version.json
@@ -1,11 +1,11 @@
 {
-	"$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-	"version": "2.0",
-	"publicReleaseRefSpec": [
-		"^refs/heads/master$" // we release out of master
-	],
-	"nugetPackageVersion": {
-		"semVer": 2
-	},
-	"pathFilters": [ "." ]
+    "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
+    "version": "2.1",
+    "publicReleaseRefSpec": [
+        "^refs/heads/master$" // we release out of master
+    ],
+    "nugetPackageVersion": {
+        "semVer": 2
+    },
+    "pathFilters": [ "." ]
 }
diff --git a/src/MinimalHelpers.Routing.Analyzers/EndpointRouteHandlerGenerator.cs b/src/MinimalHelpers.Routing.Analyzers/EndpointRouteHandlerGenerator.cs
@@ -3,6 +3,7 @@
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Text;
 
 namespace MinimalHelpers.Routing.Analyzers;
 
@@ -42,7 +43,7 @@ private void Execute(SourceProductionContext context, (Compilation Compilation,
         var (compilation, classes) = tuple;
 
         var @interface = GetIEndpointRouteHandlerBuilderInterface();
-        context.AddSource("IEndpointRouteHandlerBuilder.g.cs", @interface);
+        context.AddSource("IEndpointRouteHandlerBuilder.g.cs", SourceText.From(@interface));
 
         var prefixCode = """
             // <auto-generated />
@@ -84,7 +85,7 @@ public static IEndpointRouteBuilder MapEndpoints(this IEndpointRouteBuilder endp
 
         codeBuilder.AppendLine(suffixCode);
 
-        context.AddSource("EndpointRouteBuilderExtensions.g.cs", codeBuilder.ToString());
+        context.AddSource("EndpointRouteBuilderExtensions.g.cs", SourceText.From(codeBuilder.ToString()));
     }
 
     private static string GetIEndpointRouteHandlerBuilderInterface()
diff --git a/src/MinimalHelpers.Routing.Analyzers/MinimalHelpers.Routing.Analyzers.csproj b/src/MinimalHelpers.Routing.Analyzers/MinimalHelpers.Routing.Analyzers.csproj
@@ -6,6 +6,8 @@
         <Nullable>enable</Nullable>
         <ImplicitUsings>true</ImplicitUsings>
         <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
+        <IncludeBuildOutput>false</IncludeBuildOutput>
+        <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
         <Authors>Marco Minerva</Authors>
         <Company>Marco Minerva</Company>
         <Product>Routing Helpers for Minimal APIs</Product>
diff --git a/src/MinimalHelpers.Routing.Analyzers/version.json b/src/MinimalHelpers.Routing.Analyzers/version.json
@@ -1,11 +1,11 @@
 {
-	"$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-	"version": "1.0",
-	"publicReleaseRefSpec": [
-		"^refs/heads/master$" // we release out of master
-	],
-	"nugetPackageVersion": {
-		"semVer": 2
-	},
-	"pathFilters": [ "." ]
+    "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
+    "version": "1.1",
+    "publicReleaseRefSpec": [
+        "^refs/heads/master$" // we release out of master
+    ],
+    "nugetPackageVersion": {
+        "semVer": 2
+    },
+    "pathFilters": [ "." ]
 }
diff --git a/src/MinimalHelpers.Routing/IEndpointRouteBuilderExtensions.cs b/src/MinimalHelpers.Routing/IEndpointRouteBuilderExtensions.cs
diff --git a/src/MinimalHelpers.Routing/IEndpointRouteHandlerBuilder.cs b/src/MinimalHelpers.Routing/IEndpointRouteHandlerBuilder.cs
diff --git a/src/MinimalHelpers.Routing/MinimalHelpers.Routing.csproj b/src/MinimalHelpers.Routing/MinimalHelpers.Routing.csproj
diff --git a/src/MinimalHelpers.Routing/version.json b/src/MinimalHelpers.Routing/version.json
diff --git a/src/MinimalHelpers.Validation.Abstractions/MinimalHelpers.Validation.Abstractions.csproj b/src/MinimalHelpers.Validation.Abstractions/MinimalHelpers.Validation.Abstractions.csproj
diff --git a/src/MinimalHelpers.Validation.Abstractions/version.json b/src/MinimalHelpers.Validation.Abstractions/version.json
diff --git a/src/MinimalHelpers.Validation/MinimalHelpers.Validation.csproj b/src/MinimalHelpers.Validation/MinimalHelpers.Validation.csproj
diff --git a/src/MinimalHelpers.Validation/version.json b/src/MinimalHelpers.Validation/version.json
