Skip to content

Commit 5e6cd23

Browse files
davidkallesendavidkallesen
committed
refactor: introduce GeneratorSettings in framework and map options to it
1 parent 1f1bf69 commit 5e6cd23

File tree

21 files changed

+198
-210
lines changed

21 files changed

+198
-210
lines changed

‎src/Atc.Rest.ApiGenerator.CLI/ApiOptionsHelper.cs

+6
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,12 @@ private static void ApplyGeneratorOverrides(
166166
apiOptions.Generator.EndpointsLocation = serverCommandSettings.EndpointsLocation.Value;
167167
}
168168

169+
if (serverCommandSettings.HandlersLocation is not null &&
170+
serverCommandSettings.HandlersLocation.IsSet)
171+
{
172+
apiOptions.Generator.HandlersLocation = serverCommandSettings.HandlersLocation.Value;
173+
}
174+
169175
if (serverCommandSettings.UsePartialClassForContracts)
170176
{
171177
apiOptions.Generator.UsePartialClassForContracts = serverCommandSettings.UsePartialClassForContracts;

‎src/Atc.Rest.ApiGenerator.CLI/Commands/ArgumentCommandConstants.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ public static class ArgumentCommandConstants
2020
public const string LongConfigurationValidateModelNameCasingStyle = "--validate-modelNameCasingStyle";
2121
public const string LongConfigurationValidateModelPropertyNameCasingStyle = "--validate-modelPropertyNameCasingStyle";
2222

23-
public const string LongContractsLocation = "--contractsLocation";
2423
public const string LongEndpointsLocation = "--endpointsLocation";
24+
public const string LongContractsLocation = "--contractsLocation";
25+
public const string LongHandlersLocation = "--handlersLocation";
2526

2627
public const string LongClientHttpClientName = "--httpClientName";
2728
public const string LongExcludeEndpointGeneration = "--excludeEndpointGeneration";

‎src/Atc.Rest.ApiGenerator.CLI/Commands/Settings/BaseGenerateCommandSettings.cs

+7-3
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,17 @@ public class BaseGenerateCommandSettings : BaseConfigurationCommandSettings
1414
[Description("Use ProblemDetails as default responsen body")]
1515
public bool UseProblemDetailsAsDefaultResponseBody { get; init; }
1616

17+
[CommandOption($"{ArgumentCommandConstants.LongEndpointsLocation} [ENDPOINTSLOCATION]")]
18+
[Description($"If endpoints-localtion is provided, generated files will be placed here instead of the {ContentGeneratorConstants.Endpoints} folder.")]
19+
public FlagValue<string>? EndpointsLocation { get; init; }
20+
1721
[CommandOption($"{ArgumentCommandConstants.LongContractsLocation} [CONTRACTSLOCATION]")]
1822
[Description($"If contracts-localtion is provided, generated files will be placed here instead of the {ContentGeneratorConstants.Contracts} folder.")]
1923
public FlagValue<string>? ContractsLocation { get; init; }
2024

21-
[CommandOption($"{ArgumentCommandConstants.LongEndpointsLocation} [ENDPOINTSLOCATION]")]
22-
[Description($"If endpoints-localtion is provided, generated files will be placed here instead of the {ContentGeneratorConstants.Endpoints} folder.")]
23-
public FlagValue<string>? EndpointsLocation { get; init; }
25+
[CommandOption($"{ArgumentCommandConstants.LongHandlersLocation} [HANDLERSLOCATION]")]
26+
[Description($"If handlers-localtion is provided, generated files will be placed here instead of the {ContentGeneratorConstants.Handlers} folder.")]
27+
public FlagValue<string>? HandlersLocation { get; init; }
2428

2529
[CommandOption(ArgumentCommandConstants.LongUsePartialClassForContracts)]
2630
[Description("Use Partial-Class for contracts")]

‎src/Atc.Rest.ApiGenerator.Client.CSharp/GlobalUsings.cs

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
global using Atc.Rest.ApiGenerator.Framework.Factories.Parameters.ServerClient;
2020
global using Atc.Rest.ApiGenerator.Framework.Helpers;
2121
global using Atc.Rest.ApiGenerator.Framework.Providers;
22+
global using Atc.Rest.ApiGenerator.Framework.Settings;
2223
global using Atc.Rest.ApiGenerator.Framework.Writers;
2324
global using Atc.Rest.ApiGenerator.OpenApi.Extensions;
2425

‎src/Atc.Rest.ApiGenerator.Client.CSharp/ProjectGenerator/ClientCSharpApiGenerator.cs

+48-60
Large diffs are not rendered by default.

‎src/Atc.Rest.ApiGenerator.Client.CSharp/ProjectGenerator/IClientCSharpApiGenerator.cs

-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ namespace Atc.Rest.ApiGenerator.Client.CSharp.ProjectGenerator;
1111
/// </remarks>
1212
public interface IClientCSharpApiGenerator
1313
{
14-
string ContractsLocation { get; set; }
15-
16-
string EndpointsLocation { get; set; }
17-
1814
string HttpClientName { get; set; }
1915

2016
Task ScaffoldProjectFile();

‎src/Atc.Rest.ApiGenerator.Framework.Minimal/GlobalUsings.cs

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
global using Atc.Rest.ApiGenerator.Framework.Minimal.Factories;
2323
global using Atc.Rest.ApiGenerator.Framework.ProjectGenerator;
2424
global using Atc.Rest.ApiGenerator.Framework.Providers;
25+
global using Atc.Rest.ApiGenerator.Framework.Settings;
2526
global using Atc.Rest.ApiGenerator.Framework.Writers;
2627
global using Atc.Rest.ApiGenerator.OpenApi.Extensions;
2728

‎src/Atc.Rest.ApiGenerator.Framework.Minimal/ProjectGenerator/ServerApiGenerator.cs

+14-22
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,7 @@ public class ServerApiGenerator : IServerApiGenerator
1313
private readonly string routeBase;
1414
private readonly string codeGeneratorContentHeader;
1515
private readonly AttributeParameters codeGeneratorAttribute;
16-
private readonly bool useProblemDetailsAsDefaultResponseBody;
17-
private readonly bool usePartialClassForContracts;
18-
private readonly bool usePartialClassForEndpoints;
19-
private readonly bool includeDeprecated;
16+
private readonly GeneratorSettings settings;
2017

2118
public ServerApiGenerator(
2219
ILoggerFactory loggerFactory,
@@ -27,10 +24,7 @@ public ServerApiGenerator(
2724
OpenApiDocument openApiDocument,
2825
IList<ApiOperation> operationSchemaMappings,
2926
string routeBase,
30-
bool useProblemDetailsAsDefaultResponseBody,
31-
bool usePartialClassForContracts,
32-
bool usePartialClassForEndpoints,
33-
bool includeDeprecated)
27+
GeneratorSettings generatorSettings)
3428
{
3529
ArgumentNullException.ThrowIfNull(loggerFactory);
3630
ArgumentNullException.ThrowIfNull(nugetPackageReferenceProvider);
@@ -39,6 +33,7 @@ public ServerApiGenerator(
3933
ArgumentNullException.ThrowIfNull(projectPath);
4034
ArgumentNullException.ThrowIfNull(openApiDocument);
4135
ArgumentNullException.ThrowIfNull(routeBase);
36+
ArgumentNullException.ThrowIfNull(generatorSettings);
4237

4338
logger = loggerFactory.CreateLogger<ServerApiGenerator>();
4439
this.nugetPackageReferenceProvider = nugetPackageReferenceProvider;
@@ -48,10 +43,7 @@ public ServerApiGenerator(
4843
this.openApiDocument = openApiDocument;
4944
this.operationSchemaMappings = operationSchemaMappings;
5045
this.routeBase = routeBase;
51-
this.useProblemDetailsAsDefaultResponseBody = useProblemDetailsAsDefaultResponseBody;
52-
this.usePartialClassForContracts = usePartialClassForContracts;
53-
this.usePartialClassForEndpoints = usePartialClassForEndpoints;
54-
this.includeDeprecated = includeDeprecated;
46+
settings = generatorSettings;
5547

5648
codeGeneratorContentHeader = GeneratedCodeHeaderGeneratorFactory
5749
.Create(apiGeneratorVersion)
@@ -178,7 +170,7 @@ public void GenerateParameters()
178170

179171
foreach (var openApiOperation in openApiPath.Value.Operations)
180172
{
181-
if (openApiOperation.Value.Deprecated && !includeDeprecated)
173+
if (openApiOperation.Value.Deprecated && !settings.IncludeDeprecatedOperations)
182174
{
183175
continue;
184176
}
@@ -222,7 +214,7 @@ public void GenerateResults()
222214

223215
foreach (var openApiOperation in openApiPath.Value.Operations)
224216
{
225-
if (openApiOperation.Value.Deprecated && !includeDeprecated)
217+
if (openApiOperation.Value.Deprecated && !settings.IncludeDeprecatedOperations)
226218
{
227219
continue;
228220
}
@@ -236,7 +228,7 @@ public void GenerateResults()
236228
new GeneratedCodeAttributeGenerator(new GeneratedCodeGeneratorParameters(apiGeneratorVersion)),
237229
new CodeDocumentationTagsGenerator(),
238230
resultParameters,
239-
useProblemDetailsAsDefaultResponseBody);
231+
settings.UseProblemDetailsAsDefaultResponseBody);
240232

241233
var content = contentGenerator.Generate();
242234

@@ -260,7 +252,7 @@ public void GenerateInterfaces()
260252

261253
foreach (var openApiOperation in openApiPath.Value.Operations)
262254
{
263-
if (openApiOperation.Value.Deprecated && !includeDeprecated)
255+
if (openApiOperation.Value.Deprecated && !settings.IncludeDeprecatedOperations)
264256
{
265257
continue;
266258
}
@@ -302,14 +294,14 @@ public void GenerateEndpoints()
302294
GetRouteByApiGroupName(apiGroupName),
303295
ContentGeneratorConstants.EndpointDefinition,
304296
openApiDocument,
305-
usePartialClassForEndpoints);
297+
settings.UsePartialClassForEndpoints);
306298

307299
var contentGenerator = new ContentGenerators.ContentGeneratorServerEndpoints(
308300
new GeneratedCodeHeaderGenerator(new GeneratedCodeGeneratorParameters(apiGeneratorVersion)),
309301
new GeneratedCodeAttributeGenerator(new GeneratedCodeGeneratorParameters(apiGeneratorVersion)),
310302
new CodeDocumentationTagsGenerator(),
311303
endpointParameters,
312-
useProblemDetailsAsDefaultResponseBody);
304+
settings.UseProblemDetailsAsDefaultResponseBody);
313305

314306
var content = contentGenerator.Generate();
315307

@@ -343,7 +335,7 @@ public void MaintainGlobalUsings(
343335
"Microsoft.AspNetCore.Mvc",
344336
};
345337

346-
if (openApiDocument.IsUsingRequiredForSystemTextJsonSerializationAndSystemRuntimeSerialization(includeDeprecated))
338+
if (openApiDocument.IsUsingRequiredForSystemTextJsonSerializationAndSystemRuntimeSerialization(settings.IncludeDeprecatedOperations))
347339
{
348340
requiredUsings.Add("System.Runtime.Serialization");
349341
requiredUsings.Add("System.Text.Json.Serialization");
@@ -354,7 +346,7 @@ public void MaintainGlobalUsings(
354346
requiredUsings.Add("Atc.Rest.Results");
355347
}
356348

357-
if (openApiDocument.IsUsingRequiredForMicrosoftAspNetCoreAuthorization(includeDeprecated))
349+
if (openApiDocument.IsUsingRequiredForMicrosoftAspNetCoreAuthorization(settings.IncludeDeprecatedOperations))
358350
{
359351
requiredUsings.Add("Microsoft.AspNetCore.Authorization");
360352
}
@@ -443,8 +435,8 @@ private void GenerateModel(
443435
codeGeneratorAttribute,
444436
modelName,
445437
apiSchemaModel,
446-
usePartialClassForContracts,
447-
includeDeprecated);
438+
settings.UsePartialClassForContracts,
439+
settings.IncludeDeprecatedOperations);
448440

449441
var contentGeneratorRecord = new GenerateContentForRecords(
450442
new CodeDocumentationTagsGenerator(),

‎src/Atc.Rest.ApiGenerator.Framework.Minimal/ProjectGenerator/ServerDomainGenerator.cs

+10-11
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ public class ServerDomainGenerator : IServerDomainGenerator
1212
private readonly OpenApiDocument openApiDocument;
1313
private readonly string codeGeneratorContentHeader;
1414
private readonly AttributeParameters codeGeneratorAttribute;
15+
private readonly GeneratorSettings settings;
1516

1617
public ServerDomainGenerator(
1718
ILoggerFactory loggerFactory,
@@ -20,7 +21,8 @@ public ServerDomainGenerator(
2021
string projectName,
2122
string apiProjectName,
2223
DirectoryInfo projectPath,
23-
OpenApiDocument openApiDocument)
24+
OpenApiDocument openApiDocument,
25+
GeneratorSettings generatorSettings)
2426
{
2527
ArgumentNullException.ThrowIfNull(loggerFactory);
2628
ArgumentNullException.ThrowIfNull(nugetPackageReferenceProvider);
@@ -29,13 +31,15 @@ public ServerDomainGenerator(
2931
ArgumentNullException.ThrowIfNull(apiProjectName);
3032
ArgumentNullException.ThrowIfNull(projectPath);
3133
ArgumentNullException.ThrowIfNull(openApiDocument);
34+
ArgumentNullException.ThrowIfNull(generatorSettings);
3235

3336
logger = loggerFactory.CreateLogger<ServerDomainGenerator>();
3437
this.nugetPackageReferenceProvider = nugetPackageReferenceProvider;
3538
this.projectName = projectName;
3639
this.apiProjectName = apiProjectName;
3740
this.projectPath = projectPath;
3841
this.openApiDocument = openApiDocument;
42+
settings = generatorSettings;
3943

4044
codeGeneratorContentHeader = GeneratedCodeHeaderGeneratorFactory
4145
.Create(apiGeneratorVersion)
@@ -44,8 +48,6 @@ public ServerDomainGenerator(
4448
.CreateGeneratedCode(apiGeneratorVersion);
4549
}
4650

47-
public string ContractsLocation { get; set; } = ContentGeneratorConstants.Contracts;
48-
4951
public async Task ScaffoldProjectFile()
5052
{
5153
var packageReferences = await nugetPackageReferenceProvider.GetPackageReferencesForDomainProjectForMinimalApi();
@@ -117,11 +119,11 @@ public void ScaffoldHandlers()
117119

118120
foreach (var openApiOperation in urlPath.Value.Operations)
119121
{
120-
var fullNamespace = $"{projectName}.{ContentGeneratorConstants.Handlers}.{apiGroupName}";
122+
var fullNamespace = NamespaceFactory.CreateFull(projectName, settings.HandlersLocation, apiGroupName);
121123

122124
var classParameters = ContentGeneratorServerHandlerParametersFactory.Create(
123125
fullNamespace,
124-
$"Api.Generated.{ContentGeneratorConstants.Contracts}.{apiGroupName}",
126+
$"Api.Generated.{ContentGeneratorConstants.Contracts}.{apiGroupName}", // TODO: Fix this
125127
urlPath.Value,
126128
openApiOperation.Value);
127129

@@ -134,10 +136,7 @@ public void ScaffoldHandlers()
134136
var contentWriter = new ContentWriter(logger);
135137
contentWriter.Write(
136138
projectPath,
137-
projectPath.CombineFileInfo(
138-
ContentGeneratorConstants.Handlers,
139-
apiGroupName,
140-
$"{classParameters.TypeName}.cs"),
139+
FileInfoFactory.Create(projectPath, settings.HandlersLocation, apiGroupName, $"{classParameters.TypeName}.cs"),
141140
ContentWriterArea.Src,
142141
content,
143142
overrideIfExist: false);
@@ -265,8 +264,8 @@ public void MaintainGlobalUsings(
265264

266265
var apiGroupNames = openApiDocument.GetApiGroupNames();
267266

268-
requiredUsings.AddRange(apiGroupNames.Select(x => NamespaceFactory.CreateFull(apiProjectName, ContractsLocation, x)));
269-
requiredUsings.AddRange(apiGroupNames.Select(x => NamespaceFactory.CreateFull(projectName, ContentGeneratorConstants.Handlers, x)));
267+
requiredUsings.AddRange(apiGroupNames.Select(x => NamespaceFactory.CreateFull(apiProjectName, settings.ContractsLocation, x)));
268+
requiredUsings.AddRange(apiGroupNames.Select(x => NamespaceFactory.CreateFull(projectName, settings.HandlersLocation, x)));
270269

271270
GlobalUsingsHelper.CreateOrUpdate(
272271
logger,

‎src/Atc.Rest.ApiGenerator.Framework.Mvc/GlobalUsings.cs

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
global using Atc.Rest.ApiGenerator.Framework.Mvc.Factories;
2525
global using Atc.Rest.ApiGenerator.Framework.ProjectGenerator;
2626
global using Atc.Rest.ApiGenerator.Framework.Providers;
27+
global using Atc.Rest.ApiGenerator.Framework.Settings;
2728
global using Atc.Rest.ApiGenerator.Framework.Writers;
2829
global using Atc.Rest.ApiGenerator.OpenApi.Extensions;
2930

0 commit comments

Comments
 (0)