Skip to content

Commit fed7f25

Browse files
i4004i4004
committed
[fix] analyzer comments
1 parent 796b11c commit fed7f25

11 files changed

Lines changed: 57 additions & 108 deletions

‎src/Simplify.Web.Postman/Assembly/Collection/CollectionBuilder.cs‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,18 @@ namespace Simplify.Web.Postman.Assembly.Collection;
77
/// <summary>
88
/// Provides postman collection model builder
99
/// </summary>
10-
public class CollectionBuilder
10+
/// <remarks>
11+
/// Initializes a new instance of the <see cref="CollectionBuilder" /> class.
12+
/// </remarks>
13+
/// <param name="partBuilders">The part builders.</param>
14+
/// <exception cref="ArgumentNullException">partBuilders</exception>
15+
public class CollectionBuilder(IList<ICollectionPartBuilder> partBuilders)
1116
{
12-
private readonly IList<ICollectionPartBuilder> _partBuilders;
13-
14-
/// <summary>
15-
/// Initializes a new instance of the <see cref="CollectionBuilder"/> class.
16-
/// </summary>
17-
/// <param name="partBuilders">The part builders.</param>
18-
/// <exception cref="ArgumentNullException">partBuilders</exception>
19-
public CollectionBuilder(IList<ICollectionPartBuilder> partBuilders) =>
20-
_partBuilders = partBuilders ?? throw new ArgumentNullException(nameof(partBuilders));
17+
private readonly IList<ICollectionPartBuilder> _partBuilders = partBuilders ?? throw new ArgumentNullException(nameof(partBuilders));
2118

2219
/// <summary>
2320
/// Builds the collection model.
2421
/// </summary>
25-
/// <returns></returns>
2622
public CollectionModel Create()
2723
{
2824
var model = new CollectionModel();

‎src/Simplify.Web.Postman/Assembly/Collection/PartBuilders/BasicTestBuilder.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
using System.Collections.Generic;
21
using Simplify.Web.Postman.Models;
32

43
namespace Simplify.Web.Postman.Assembly.Collection.PartBuilders;
@@ -19,7 +18,7 @@ public static Event Build()
1918
Listen = "test",
2019
Script = new Script
2120
{
22-
Exec = new List<string> { "tests[\"HTTP Code Test\"] = pm.expect(pm.response.code).to.be.oneOf([200, 204]);" },
21+
Exec = ["tests[\"HTTP Code Test\"] = pm.expect(pm.response.code).to.be.oneOf([200, 204]);"],
2322
Type = "text/javascript"
2423
}
2524
};

‎src/Simplify.Web.Postman/Assembly/Collection/PartBuilders/CollectionItemsBuilder.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,11 @@ private static void BuildCollectionItems(CollectionItem currentLevelContainer, i
3535
var path = item.Request.Url.Path;
3636

3737
// If recursion reached request level or reached route parameter
38+
#if NETSTANDARD2_0
3839
if (currentLevel == path.Count || path[currentLevel].StartsWith("{"))
40+
#else
41+
if (currentLevel == path.Count || path[currentLevel].StartsWith('{'))
42+
#endif
3943
{
4044
currentLevelContainer.Items ??= [];
4145

‎src/Simplify.Web.Postman/Assembly/Collection/PartBuilders/RequestBuilder.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
using System;
22
using System.Collections.Generic;
3-
using System.Linq;
43
using System.Text.Json;
54
using Simplify.Web.Controllers.Meta;
65
using Simplify.Web.Controllers.Meta.Routing;
@@ -47,7 +46,7 @@ public static Request Build(IControllerMetadata metaData, KeyValuePair<HttpMetho
4746
Body = TryBuildBody(metaData)
4847
};
4948

50-
private static IList<string> BuildPath(string controllerRoute) => controllerRoute.Split(new[] { '/' }, StringSplitOptions.RemoveEmptyEntries).ToList();
49+
private static IList<string> BuildPath(string controllerRoute) => [.. controllerRoute.Split(new[] { '/' }, StringSplitOptions.RemoveEmptyEntries)];
5150

5251
private static Body? TryBuildBody(IControllerMetadata metaData)
5352
{

‎src/Simplify.Web.Postman/Assembly/Environment/EnvironmentBuilder.cs‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,20 @@ namespace Simplify.Web.Postman.Assembly.Environment;
66
/// <summary>
77
/// Provides postman environment model builder
88
/// </summary>
9-
public class EnvironmentBuilder
9+
/// <remarks>
10+
/// Initializes a new instance of the <see cref="EnvironmentBuilder" /> class.
11+
/// </remarks>
12+
/// <param name="settings">The settings.</param>
13+
public class EnvironmentBuilder(IPostmanGenerationSettings settings)
1014
{
11-
private readonly IPostmanGenerationSettings _settings;
12-
13-
/// <summary>
14-
/// Initializes a new instance of the <see cref="EnvironmentBuilder"/> class.
15-
/// </summary>
16-
/// <param name="settings">The settings.</param>
17-
public EnvironmentBuilder(IPostmanGenerationSettings settings) => _settings = settings;
18-
1915
/// <summary>
2016
/// Creates this environment model.
2117
/// </summary>
2218
/// <returns></returns>
2319
public EnvironmentModel Create() =>
2420
new()
2521
{
26-
Name = _settings.ProjectName,
22+
Name = settings.ProjectName,
2723
Values =
2824
[
2925
new PostmanValue

‎src/Simplify.Web.Postman/Generators/FileBasedCollectionGenerator.cs‎

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,19 @@ namespace Simplify.Web.Postman.Generators;
88
/// <summary>
99
/// Provides file based collection generator
1010
/// </summary>
11-
public class FileBasedCollectionGenerator
11+
/// <remarks>
12+
/// Initializes a new instance of the <see cref="FileBasedCollectionGenerator" /> class.
13+
/// </remarks>
14+
/// <param name="builder">The builder.</param>
15+
/// <param name="exporter">The exporter.</param>
16+
/// <param name="settings">The settings.</param>
17+
public class FileBasedCollectionGenerator(CollectionBuilder builder, ModelToFileExporter exporter, IPostmanGenerationSettings settings)
1218
{
13-
private readonly CollectionBuilder _builder;
14-
private readonly ModelToFileExporter _exporter;
15-
private readonly IPostmanGenerationSettings _settings;
16-
17-
/// <summary>
18-
/// Initializes a new instance of the <see cref="FileBasedCollectionGenerator" /> class.
19-
/// </summary>
20-
/// <param name="builder">The builder.</param>
21-
/// <param name="exporter">The exporter.</param>
22-
/// <param name="settings">The settings.</param>
23-
public FileBasedCollectionGenerator(CollectionBuilder builder, ModelToFileExporter exporter, IPostmanGenerationSettings settings)
24-
{
25-
_exporter = exporter;
26-
_builder = builder;
27-
_settings = settings;
28-
}
29-
3019
/// <summary>
3120
/// Generates the collection
3221
/// </summary>
33-
public void Generate() => _exporter.Export(_builder.Create(), GenerateFileName());
22+
public void Generate() => exporter.Export(builder.Create(), GenerateFileName());
3423

3524
private string GenerateFileName() =>
36-
Path.Combine(_settings.CollectionFileName + _settings.CollectionFileNamePostfix + ".json");
25+
Path.Combine(settings.CollectionFileName + settings.CollectionFileNamePostfix + ".json");
3726
}

‎src/Simplify.Web.Postman/Generators/FileBasedEnvironmentGenerator.cs‎

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,19 @@ namespace Simplify.Web.Postman.Generators;
88
/// <summary>
99
/// Provides file based postman environment generator
1010
/// </summary>
11-
public class FileBasedEnvironmentGenerator
11+
/// <remarks>
12+
/// Initializes a new instance of the <see cref="FileBasedCollectionGenerator" /> class.
13+
/// </remarks>
14+
/// <param name="builder">The builder.</param>
15+
/// <param name="exporter">The exporter.</param>
16+
/// <param name="settings">The settings.</param>
17+
public class FileBasedEnvironmentGenerator(EnvironmentBuilder builder, ModelToFileExporter exporter, IPostmanGenerationSettings settings)
1218
{
13-
private readonly EnvironmentBuilder _builder;
14-
private readonly ModelToFileExporter _exporter;
15-
private readonly IPostmanGenerationSettings _settings;
16-
17-
/// <summary>
18-
/// Initializes a new instance of the <see cref="FileBasedCollectionGenerator" /> class.
19-
/// </summary>
20-
/// <param name="builder">The builder.</param>
21-
/// <param name="exporter">The exporter.</param>
22-
/// <param name="settings">The settings.</param>
23-
public FileBasedEnvironmentGenerator(EnvironmentBuilder builder, ModelToFileExporter exporter, IPostmanGenerationSettings settings)
24-
{
25-
_exporter = exporter;
26-
_builder = builder;
27-
_settings = settings;
28-
}
29-
3019
/// <summary>
3120
/// Generates the collection
3221
/// </summary>
33-
public void Generate() => _exporter.Export(_builder.Create(), GenerateFileName());
22+
public void Generate() => exporter.Export(builder.Create(), GenerateFileName());
3423

3524
private string GenerateFileName() =>
36-
Path.Combine(_settings.EnvironmentFileName + _settings.EnvironmentFileNamePostfix + ".json");
25+
Path.Combine(settings.EnvironmentFileName + settings.EnvironmentFileNamePostfix + ".json");
3726
}

‎src/Simplify.Web.Postman/Generators/FileBasedPostmanGenerator.cs‎

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,19 @@
33
/// <summary>
44
/// Profiles file based postman generator
55
/// </summary>
6-
public class FileBasedPostmanGenerator
6+
/// <remarks>
7+
/// Initializes a new instance of the <see cref="FileBasedPostmanGenerator"/> class.
8+
/// </remarks>
9+
/// <param name="collectionGenerator">The collection generator.</param>
10+
/// <param name="environmentGenerator">The environment generator.</param>
11+
public class FileBasedPostmanGenerator(FileBasedCollectionGenerator collectionGenerator, FileBasedEnvironmentGenerator environmentGenerator)
712
{
8-
private readonly FileBasedCollectionGenerator _collectionGenerator;
9-
private readonly FileBasedEnvironmentGenerator _environmentGenerator;
10-
11-
/// <summary>
12-
/// Initializes a new instance of the <see cref="FileBasedPostmanGenerator"/> class.
13-
/// </summary>
14-
/// <param name="collectionGenerator">The collection generator.</param>
15-
/// <param name="environmentGenerator">The environment generator.</param>
16-
public FileBasedPostmanGenerator(FileBasedCollectionGenerator collectionGenerator, FileBasedEnvironmentGenerator environmentGenerator)
17-
{
18-
_collectionGenerator = collectionGenerator;
19-
_environmentGenerator = environmentGenerator;
20-
}
21-
2213
/// <summary>
2314
/// Generates the postman data.
2415
/// </summary>
2516
public void Generate()
2617
{
27-
_collectionGenerator.Generate();
28-
_environmentGenerator.Generate();
18+
collectionGenerator.Generate();
19+
environmentGenerator.Generate();
2920
}
3021
}

‎src/Simplify.Web.Postman/IO/ModelToFileExporter.cs‎

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,14 @@ namespace Simplify.Web.Postman.IO;
77
/// <summary>
88
/// Provides model to file exporter
99
/// </summary>
10-
public class ModelToFileExporter
10+
/// <remarks>
11+
/// Initializes a new instance of the <see cref="ModelToFileExporter" /> class.
12+
/// </remarks>
13+
/// <param name="serializer">The serializer.</param>
14+
/// <param name="environment">The environment.</param>
15+
/// <param name="generationFolderPath">The generation folder path.</param>
16+
public class ModelToFileExporter(JsonSerializer serializer, IEnvironment environment, string generationFolderPath)
1117
{
12-
private readonly string _generationFolderPath;
13-
14-
private readonly JsonSerializer _serializer;
15-
private readonly IEnvironment _environment;
16-
17-
/// <summary>
18-
/// Initializes a new instance of the <see cref="ModelToFileExporter" /> class.
19-
/// </summary>
20-
/// <param name="serializer">The serializer.</param>
21-
/// <param name="environment">The environment.</param>
22-
/// <param name="generationFolderPath">The generation folder path.</param>
23-
public ModelToFileExporter(JsonSerializer serializer, IEnvironment environment, string generationFolderPath)
24-
{
25-
_generationFolderPath = generationFolderPath;
26-
_serializer = serializer;
27-
_environment = environment;
28-
}
29-
3018
/// <summary>
3119
/// Exports the specified model.
3220
/// </summary>
@@ -39,10 +27,10 @@ public void Export(object model, string fileName)
3927
if (!Directory.Exists(folderPath))
4028
Directory.CreateDirectory(folderPath);
4129

42-
File.WriteAllText(GenerateCollectionFilePath(folderPath, fileName), _serializer.Serialize(model));
30+
File.WriteAllText(GenerateCollectionFilePath(folderPath, fileName), serializer.Serialize(model));
4331
}
4432

4533
private static string GenerateCollectionFilePath(string folderPath, string fileName) => Path.Combine(folderPath, fileName);
4634

47-
private string GenerateExportFolderPath() => Path.Combine(_environment.AppPhysicalPath, _generationFolderPath);
35+
private string GenerateExportFolderPath() => Path.Combine(environment.AppPhysicalPath, generationFolderPath);
4836
}

‎src/Simplify.Web.Postman/Json/JsonSerializer.cs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ public class JsonSerializer
1212
/// Serializes the specified model.
1313
/// </summary>
1414
/// <param name="model">The model.</param>
15-
/// <returns></returns>
1615
public string Serialize(object model) =>
1716
global::System.Text.Json.JsonSerializer.Serialize(model, new JsonSerializerOptions
1817
{

0 commit comments

Comments
 (0)