Seal private/internal types and make methods static when applicable (#…

…5037)

Directory.Build.props

@@ -99,12 +99,10 @@
       [CA1720] Identifier 'xxx' contains type name
       [CA1725] Overriden parameter name mismatch
       [CA1805] Member is explicitly initialized to its default value
-      [CA1822] Member does not access instance data and can be marked as static
       [CA1827] Count() is used where Any() could be used instead to improve performance
       [CA1834] Use 'StringBuilder.Append(char)' instead of 'StringBuilder.Append(string)' when the input is a constant unit string
       [CA1845] Use span-based 'string.Concat' and 'AsSpan' instead of 'Substring'
       [CA1847] Use 'string.Contains(char)' instead of 'string.Contains(string)' - needs polyfill
-      [CA1852] Type can be sealed because it has no subtypes in its containing assembly and is not externally visible
       [CA1854] Prefer a 'TryGetValue' call over a Dictionary indexer access
       [CA1860] Prefer comparing 'Count' to 0 rather than using 'Any()'
       [CA1861] Prefer 'static readonly' fields over constant array arguments
@@ -118,7 +116,7 @@
       [SYSLIB0012] 'Assembly.CodeBase' is obsolete
     -->
     <NoWarn>$(NoWarn);IDE0005;IDE0008;IDE0011;IDE0017;IDE0019;IDE0021;IDE0022;IDE0025;IDE0027;IDE0028;IDE0029;IDE0032;IDE0039;IDE0040;IDE0044;IDE0045;IDE0046;IDE0055;IDE0056;IDE0057;IDE0059;IDE0060;IDE0061;IDE0063;IDE0074;IDE0078;IDE0083;IDE0090;IDE0100;IDE0130;IDE0160;IDE0200;IDE0260;IDE0270;IDE0290;IDE0300;IDE0305;IDE0301;IDE0330;IDE1005</NoWarn>
-    <NoWarn>$(NoWarn);CA1200;CA1304;CA1305;CA1310;CA1311;CA1507;CA1510;CA1514;CA1710;CA1716;CA1720;CA1725;CA1805;CA1822;CA1827;CA1834;CA1845;CA1847;CA1852;CA1854;CA1860;CA1861;CA1862;CA1865;CA1866;CA1870;CA2249;CA2263;SYSLIB0012</NoWarn>
+    <NoWarn>$(NoWarn);CA1200;CA1304;CA1305;CA1310;CA1311;CA1507;CA1510;CA1514;CA1710;CA1716;CA1720;CA1725;CA1805;CA1827;CA1834;CA1845;CA1847;CA1854;CA1860;CA1861;CA1862;CA1865;CA1866;CA1870;CA2249;CA2263;SYSLIB0012</NoWarn>
   </PropertyGroup>
 
 </Project>

src/NSwag.AspNet.Owin/Middlewares/RedirectToIndexMiddleware.cs

@@ -12,7 +12,7 @@
 
 namespace NSwag.AspNet.Owin.Middlewares
 {
-    internal class RedirectToIndexMiddleware : OwinMiddleware
+    internal sealed class RedirectToIndexMiddleware : OwinMiddleware
     {
         private readonly string _internalUiRoute;
         private readonly string _internalSwaggerRoute;

src/NSwag.AspNet.Owin/Middlewares/SwaggerUiIndexMiddleware.cs

@@ -7,7 +7,7 @@
 
 namespace NSwag.AspNet.Owin.Middlewares
 {
-    internal class SwaggerUiIndexMiddleware<T> : OwinMiddleware
+    internal sealed class SwaggerUiIndexMiddleware<T> : OwinMiddleware
         where T : OpenApiDocumentGeneratorSettings, new()
     {
         private readonly string _indexPath;

src/NSwag.AspNet.WebApi/JsonExceptionFilterAttribute.cs

@@ -79,7 +79,7 @@ public override void OnActionExecuted(HttpActionExecutedContext context)
             }
         }
 
-        private int GetStatusCode(Exception exception, HttpActionExecutedContext context)
+        private static int GetStatusCode(Exception exception, HttpActionExecutedContext context)
         {
             if (context.ActionContext.ActionDescriptor is ReflectedHttpActionDescriptor actionDescriptor)
             {
@@ -105,7 +105,7 @@ private int GetStatusCode(Exception exception, HttpActionExecutedContext context
             return 500;
         }
 
-        private JsonSerializerSettings CopySettings(JsonSerializerSettings settings)
+        private static JsonSerializerSettings CopySettings(JsonSerializerSettings settings)
         {
             var settingsCopy = new JsonSerializerSettings();
 

src/NSwag.AspNetCore.Launcher/Program.cs

@@ -5,7 +5,7 @@
 
 namespace NSwag.AspNetCore.Launcher
 {
-    internal class Program
+    internal sealed class Program
     {
         // Used to load NSwag.Commands into a process running with the app's dependency context
         private const string EntryPointType = "NSwag.Commands.Generation.AspNetCore.AspNetCoreToOpenApiGeneratorCommandEntryPoint";
@@ -169,7 +169,7 @@ private static bool TryLoadReferencedAssemblies()
             return true;
         }
 
-        private class AssemblyLoadInfo
+        private sealed class AssemblyLoadInfo
         {
             public AssemblyLoadInfo(Version minimumRequiredVersion)
             {

src/NSwag.AspNetCore/JsonExceptionFilterAttribute.cs

@@ -82,7 +82,7 @@ public override void OnActionExecuted(ActionExecutedContext context)
             }
         }
 
-        private int GetStatusCode(Exception exception, ActionExecutedContext context)
+        private static int GetStatusCode(Exception exception, ActionExecutedContext context)
         {
             if (context.ActionDescriptor is ControllerActionDescriptor controllerActionDescriptor)
             {
@@ -116,7 +116,7 @@ private int GetStatusCode(Exception exception, ActionExecutedContext context)
             return 500;
         }
 
-        private JsonSerializerSettings CopySettings(JsonSerializerSettings settings)
+        private static JsonSerializerSettings CopySettings(JsonSerializerSettings settings)
         {
             var settingsCopy = new JsonSerializerSettings();
 

src/NSwag.AspNetCore/Middlewares/RedirectToIndexMiddleware.cs

@@ -12,7 +12,7 @@
 
 namespace NSwag.AspNetCore.Middlewares
 {
-    internal class RedirectToIndexMiddleware
+    internal sealed class RedirectToIndexMiddleware
     {
         private readonly RequestDelegate _nextDelegate;
 

src/NSwag.AspNetCore/Middlewares/SwaggerUiIndexMiddleware.cs

@@ -6,7 +6,7 @@
 
 namespace NSwag.AspNetCore.Middlewares
 {
-    internal class SwaggerUiIndexMiddleware
+    internal sealed class SwaggerUiIndexMiddleware
     {
         private readonly RequestDelegate _nextDelegate;
         private readonly string _indexPath;

src/NSwag.AspNetCore/OpenApiConfigureMvcOptions.cs

@@ -11,7 +11,7 @@
 
 namespace NSwag.AspNetCore
 {
-    internal class OpenApiConfigureMvcOptions : ConfigureOptions<MvcOptions>
+    internal sealed class OpenApiConfigureMvcOptions : ConfigureOptions<MvcOptions>
     {
         public OpenApiConfigureMvcOptions()
             : base(options => options.Conventions.Add(new OpenApiMvcApplicationModelConvention()))

src/NSwag.AspNetCore/OpenApiDocumentProvider.cs

@@ -18,7 +18,7 @@
 
 namespace NSwag.AspNetCore
 {
-    internal class OpenApiDocumentProvider : IDocumentProvider, IOpenApiDocumentGenerator
+    internal sealed class OpenApiDocumentProvider : IDocumentProvider, IOpenApiDocumentGenerator
     {
         private readonly IServiceProvider _serviceProvider;
         private readonly IEnumerable<OpenApiDocumentRegistration> _documents;

src/NSwag.AspNetCore/OpenApiMvcApplicationModelConvention.cs

@@ -2,7 +2,7 @@
 
 namespace NSwag.AspNetCore
 {
-    internal class OpenApiMvcApplicationModelConvention : IApplicationModelConvention
+    internal sealed class OpenApiMvcApplicationModelConvention : IApplicationModelConvention
     {
         public void Apply(ApplicationModel application)
         {

src/NSwag.AspNetCore/SwaggerUiSettingsBase.cs

@@ -122,7 +122,7 @@ protected string GetCustomScriptHtml(HttpRequest request)
         /// <summary>Generates the additional objects JavaScript code.</summary>
         /// <param name="additionalSettings">The additional settings.</param>
         /// <returns>The code.</returns>
-        protected string GenerateAdditionalSettings(IDictionary<string, object> additionalSettings)
+        protected static string GenerateAdditionalSettings(IDictionary<string, object> additionalSettings)
         {
             var code = "";
             foreach (var pair in additionalSettings)

src/NSwag.CodeGeneration.CSharp.Tests/ControllerGenerationFormatTests.cs

@@ -252,7 +252,7 @@ public void When_the_generation_of_dto_classes_are_disabled_then_file_is_generat
             Assert.DoesNotContain("public partial class ComplexTypeResponse", code);
         }
 
-        private OpenApiDocument GetOpenApiDocument()
+        private static OpenApiDocument GetOpenApiDocument()
         {
             JsonSchema complexTypeSchema = new JsonSchema();
             complexTypeSchema.Title = "ComplexType";

src/NSwag.Commands/Commands/Document/CreateDocumentCommand.cs

@@ -33,7 +33,7 @@ public async Task<object> RunAsync(CommandLineProcessor processor, IConsoleHost
             return null;
         }
 
-        private async Task CreateDocumentAsync(string filePath)
+        private static async Task CreateDocumentAsync(string filePath)
         {
             var document = new NSwagDocument();
             document.Path = filePath;

src/NSwag.Commands/Commands/Generation/AspNetCore/AspNetCoreToOpenApiGeneratorCommandEntryPoint.cs

@@ -15,7 +15,7 @@
 namespace NSwag.Commands.Generation.AspNetCore
 {
     /// <summary>In-process entry point for the aspnetcore2swagger command.</summary>
-    internal class AspNetCoreToOpenApiGeneratorCommandEntryPoint
+    internal sealed class AspNetCoreToOpenApiGeneratorCommandEntryPoint
     {
         public static void Process(string commandContent, string outputFile, string applicationName)
         {

src/NSwag.Commands/Commands/OutputCommandBase.cs

@@ -25,7 +25,7 @@ public abstract class OutputCommandBase : IOutputCommand
 
         public abstract Task<object> RunAsync(CommandLineProcessor processor, IConsoleHost host);
 
-        protected Task<OpenApiDocument> ReadSwaggerDocumentAsync(string input)
+        protected static Task<OpenApiDocument> ReadSwaggerDocumentAsync(string input)
         {
             if (!IsJson(input) && !IsYaml(input))
             {
@@ -67,12 +67,12 @@ protected Task<OpenApiDocument> ReadSwaggerDocumentAsync(string input)
             }
         }
 
-        protected bool IsJson(string data)
+        protected static bool IsJson(string data)
         {
             return data.StartsWith("{");
         }
 
-        protected bool IsYaml(string data)
+        protected static bool IsYaml(string data)
         {
             return !IsJson(data) && data.Contains("\n");
         }

src/NSwag.Commands/HostApplication.cs

@@ -181,13 +181,13 @@ void OnEntryPointExit(Exception exception)
 #endif
         }
 
-        private class NoopHostLifetime : IHostLifetime
+        private sealed class NoopHostLifetime : IHostLifetime
         {
             public Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask;
             public Task WaitForStartAsync(CancellationToken cancellationToken) => Task.CompletedTask;
         }
 
-        private class NoopServer : IServer
+        private sealed class NoopServer : IServer
         {
             public IFeatureCollection Features { get; } = new FeatureCollection();
             public void Dispose() { }

src/NSwag.Commands/NSwagDocument.cs

@@ -230,11 +230,13 @@ private async Task<string> StartCommandLineProcessAsync(string command)
 
         private string GetDocumentDirectory()
         {
-            var absoluteDocumentPath = PathUtilities.MakeAbsolutePath(Path, System.IO.Directory.GetCurrentDirectory());
+            var absoluteDocumentPath = PathUtilities.MakeAbsolutePath(Path, Directory.GetCurrentDirectory());
             return System.IO.Path.GetDirectoryName(absoluteDocumentPath);
         }
 
+#pragma warning disable CA1822
         private string GetArgumentsPrefix()
+#pragma warning restore CA1822
         {
 #if NET462
 
@@ -252,7 +254,9 @@ private string GetArgumentsPrefix()
             return "";
         }
 
+#pragma warning disable CA1822
         private string GetProgramName()
+#pragma warning restore CA1822
         {
 #if NET462
 
@@ -270,7 +274,7 @@ private string GetProgramName()
             return "dotnet";
         }
 
-        private string ReadFileIfExists(string filename)
+        private static string ReadFileIfExists(string filename)
         {
             if (filename != null && File.Exists(filename))
             {
@@ -280,15 +284,15 @@ private string ReadFileIfExists(string filename)
             return null;
         }
 
-        private void DeleteFileIfExists(string filename)
+        private static void DeleteFileIfExists(string filename)
         {
             if (File.Exists(filename))
             {
                 File.Delete(filename);
             }
         }
 
-        internal class CommandLineException : Exception
+        private sealed class CommandLineException : Exception
         {
             public CommandLineException(string message, string stackTrace)
                 : base(message)

src/NSwag.Commands/OperationGenerationModeConverter.cs

@@ -11,7 +11,7 @@
 
 namespace NSwag.Commands
 {
-    internal class OperationGenerationModeConverter
+    internal sealed class OperationGenerationModeConverter
     {
         internal static OperationGenerationMode GetOperationGenerationMode(IOperationNameGenerator operationNameGenerator)
         {

src/NSwag.Core.Tests/Serialization/PathItemTests.cs

@@ -24,7 +24,7 @@ public async Task PathItem_With_External_Ref_Can_Be_Serialized()
             Assert.True(getOperation.ActualResponses.ContainsKey("200"));
         }
 
-        private string GetTestDirectory()
+        private static string GetTestDirectory()
         {
             var codeBase = Assembly.GetExecutingAssembly().CodeBase;
             var uri = new UriBuilder(codeBase);

src/NSwag.Core.Yaml.Tests/References/YamlReferencesTests.cs

@@ -29,7 +29,7 @@ public async Task When_yaml_schema_has_references_it_works(string relativePath)
             Assert.Equal(JsonObjectType.Boolean, document.Definitions["ContractObject"].Properties["bar"].ActualTypeSchema.Type);
         }
 
-        private string GetTestDirectory()
+        private static string GetTestDirectory()
         {
             var codeBase = Assembly.GetExecutingAssembly().CodeBase;
             var uri = new UriBuilder(codeBase);

src/NSwag.Core/OpenApiDocument.cs

@@ -329,7 +329,7 @@ public void GenerateOperationIds()
             }
         }
 
-        private string GetOperationNameFromPath(OpenApiOperationDescription operation)
+        private static string GetOperationNameFromPath(OpenApiOperationDescription operation)
         {
             var pathSegments = operation.Path.Trim('/').Split('/');
             var lastPathSegment = pathSegments.LastOrDefault(s => !s.Contains("{"));

src/NSwag.Core/OpenApiPathItem.cs

@@ -104,7 +104,7 @@ IJsonReference IJsonReferenceBase.Reference
         #endregion
 
         // Needed to convert dictionary keys to lower case
-        internal class OpenApiPathItemConverter : JsonConverter
+        internal sealed class OpenApiPathItemConverter : JsonConverter
         {
             public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
             {

src/NSwag.Generation.AspNetCore.Tests/Processors/OperationResponseProcessorTest.cs

@@ -148,8 +148,10 @@ private AspNetCoreOperationProcessorContext GetContext(ApiDescription apiDescrip
             return context;
         }
 
-        private class TestModel { }
+        private sealed class TestModel { }
 
+#pragma warning disable CA1822
         private TestModel SomeAction() => null;
+#pragma warning restore CA1822
     }
 }

src/NSwag.Generation.AspNetCore/AspNetCoreOpenApiDocumentGenerator.cs

@@ -290,7 +290,7 @@ private List<Type> GenerateApiGroups(
             return usedControllerTypes;
         }
 
-        private bool IsOperationDeprecated(ApiDescription apiDescription, ActionDescriptor actionDescriptor, MethodInfo methodInfo)
+        private static bool IsOperationDeprecated(ApiDescription apiDescription, ActionDescriptor actionDescriptor, MethodInfo methodInfo)
         {
             if (methodInfo?.GetCustomAttribute<ObsoleteAttribute>() != null)
             {

src/NSwag.Generation.AspNetCore/Processors/OperationParameterProcessor.cs

@@ -24,7 +24,7 @@
 
 namespace NSwag.Generation.AspNetCore.Processors
 {
-    internal class OperationParameterProcessor : IOperationProcessor
+    internal sealed class OperationParameterProcessor : IOperationProcessor
     {
         private const string MultipartFormData = "multipart/form-data";
 
@@ -247,23 +247,23 @@ private void ApplyOpenApiBodyParameterAttribute(OpenApiOperationDescription oper
             }
         }
 
-        private void EnsureSingleBodyParameter(OpenApiOperationDescription operationDescription)
+        private static void EnsureSingleBodyParameter(OpenApiOperationDescription operationDescription)
         {
             if (operationDescription.Operation.ActualParameters.Count(p => p.Kind == OpenApiParameterKind.Body) > 1)
             {
                 throw new InvalidOperationException($"The operation '{operationDescription.Operation.OperationId}' has more than one body parameter.");
             }
         }
 
-        private void UpdateConsumedTypes(OpenApiOperationDescription operationDescription)
+        private static void UpdateConsumedTypes(OpenApiOperationDescription operationDescription)
         {
             if (operationDescription.Operation.ActualParameters.Any(p => p.IsBinary || p.ActualSchema.IsBinary))
             {
                 operationDescription.Operation.TryAddConsumes("multipart/form-data");
             }
         }
 
-        private void RemoveUnusedPathParameters(OpenApiOperationDescription operationDescription, string httpPath)
+        private static void RemoveUnusedPathParameters(OpenApiOperationDescription operationDescription, string httpPath)
         {
             operationDescription.Path = "/" + Regex.Replace(httpPath, "{(.*?)(:(([^/]*)?))?}", match =>
             {
@@ -324,7 +324,7 @@ private void AddFileParameter(OperationProcessorContext context, ExtendedApiPara
             }
         }
 
-        private JsonSchema CreateOrGetFormDataSchema(OperationProcessorContext context)
+        private static JsonSchema CreateOrGetFormDataSchema(OperationProcessorContext context)
         {
             if (context.OperationDescription.Operation.RequestBody == null)
             {
@@ -501,7 +501,7 @@ private OpenApiParameter CreatePrimitiveParameter(
             return operationParameter;
         }
 
-        private class ExtendedApiParameterDescription
+        private sealed class ExtendedApiParameterDescription
         {
             private readonly IXmlDocsSettings _xmlDocsSettings;
 

src/NSwag.Generation.AspNetCore/Processors/OperationResponseProcessor.cs

@@ -119,7 +119,7 @@ protected override string GetVoidResponseStatusCode()
             return "200";
         }
 
-        private bool IsVoidResponse(Type returnType)
+        private static bool IsVoidResponse(Type returnType)
         {
             return returnType == null || returnType.FullName == "System.Void";
         }