XML comments added

Custom settings control

Author: i4004

src/Simplify.Web.Postman/CollectionBuilder.cs

@@ -4,15 +4,27 @@
 
 namespace Simplify.Web.Postman
 {
+	/// <summary>
+	/// Provides postman collection model builder
+	/// </summary>
 	public class CollectionBuilder
 	{
 		private readonly IList<ICollectionPartBuilder> _partBuilders;
 
+		/// <summary>
+		/// Initializes a new instance of the <see cref="CollectionBuilder"/> class.
+		/// </summary>
+		/// <param name="partBuilders">The part builders.</param>
+		/// <exception cref="ArgumentNullException">partBuilders</exception>
 		public CollectionBuilder(IList<ICollectionPartBuilder> partBuilders)
 		{
 			_partBuilders = partBuilders ?? throw new ArgumentNullException(nameof(partBuilders));
 		}
 
+		/// <summary>
+		/// Builds the collection model.
+		/// </summary>
+		/// <returns></returns>
 		public CollectionModel Create()
 		{
 			var model = new CollectionModel();

src/Simplify.Web.Postman/CollectionModelSerializer.cs

@@ -3,8 +3,16 @@
 
 namespace Simplify.Web.Postman
 {
+	/// <summary>
+	/// Provides postman collection model serializer
+	/// </summary>
 	public class CollectionModelSerializer
 	{
+		/// <summary>
+		/// Serializes the specified model.
+		/// </summary>
+		/// <param name="model">The model.</param>
+		/// <returns></returns>
 		public string Serialize(CollectionModel model)
 		{
 			return JsonSerializer.Serialize(model);

src/Simplify.Web.Postman/DefaultPostmanGenerationSettingsFactory.cs

@@ -0,0 +1,28 @@
+namespace Simplify.Web.Postman
+{
+	/// <summary>
+	/// Provides default PostmanGenerationSettings factory
+	/// </summary>
+	public static class DefaultPostmanGenerationSettingsFactory
+	{
+		/// <summary>
+		/// Creates the new or updates the existing settings.
+		/// </summary>
+		/// <param name="settings">The settings.</param>
+		/// <param name="projectAssemblyName">Name of the project assembly.</param>
+		/// <returns></returns>
+		public static PostmanGenerationSettings CreateOrUpdateSettings(PostmanGenerationSettings? settings, string projectAssemblyName)
+		{
+			if (settings == null)
+				settings = new PostmanGenerationSettings();
+
+			if (settings.CollectionFileName == null)
+				settings.CollectionFileName = projectAssemblyName;
+
+			if (settings.EnvironmentFileName == null)
+				settings.EnvironmentFileName = projectAssemblyName;
+
+			return settings;
+		}
+	}
+}

src/Simplify.Web.Postman/FileCollectionExporter.cs

@@ -4,22 +4,33 @@
 
 namespace Simplify.Web.Postman
 {
+	/// <summary>
+	/// Provides postman collection to file exporter
+	/// </summary>
+	/// <seealso cref="ICollectionExporter" />
 	public class FileCollectionExporter : ICollectionExporter
 	{
-		private const string GenerationFolderPath = "postman";
-		private const string CollectionFileNamePostfix = ".postman_collection";
-
 		private readonly CollectionModelSerializer _serializer;
 		private readonly IEnvironment _environment;
-		private readonly string _projectAssemblyName;
-
-		public FileCollectionExporter(CollectionModelSerializer serializer, IEnvironment environment, string projectAssemblyName)
+		private readonly PostmanGenerationSettings _settings;
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="FileCollectionExporter"/> class.
+		/// </summary>
+		/// <param name="serializer">The serializer.</param>
+		/// <param name="environment">The environment.</param>
+		/// <param name="settings">The settings.</param>
+		public FileCollectionExporter(CollectionModelSerializer serializer, IEnvironment environment, PostmanGenerationSettings settings)
 		{
 			_serializer = serializer;
 			_environment = environment;
-			_projectAssemblyName = projectAssemblyName;
+			_settings = settings;
 		}
 
+		/// <summary>
+		/// Exports the specified model.
+		/// </summary>
+		/// <param name="model">The model.</param>
 		public void Export(CollectionModel model)
 		{
 			var folderPath = GenerateExportFolderPath();
@@ -30,14 +41,14 @@ public void Export(CollectionModel model)
 			File.WriteAllText(GenerateCollectionFilePath(folderPath), _serializer.Serialize(model));
 		}
 
-		public string GenerateExportFolderPath()
+		private string GenerateExportFolderPath()
 		{
-			return Path.Combine(_environment.SitePhysicalPath, GenerationFolderPath);
+			return Path.Combine(_environment.SitePhysicalPath, _settings.GenerationFolderPath);
 		}
 
-		public string GenerateCollectionFilePath(string folderPath)
+		private string GenerateCollectionFilePath(string folderPath)
 		{
-			return Path.Combine(folderPath, _projectAssemblyName + CollectionFileNamePostfix + ".json");
+			return Path.Combine(folderPath, _settings.CollectionFileName + _settings.CollectionFileNamePostfix + ".json");
 		}
 	}
 }

src/Simplify.Web.Postman/ICollectionExporter.cs

@@ -2,8 +2,15 @@
 
 namespace Simplify.Web.Postman
 {
+	/// <summary>
+	/// Represents postman collection exporter
+	/// </summary>
 	public interface ICollectionExporter
 	{
+		/// <summary>
+		/// Exports the specified model.
+		/// </summary>
+		/// <param name="model">The model.</param>
 		void Export(CollectionModel model);
 	}
 }

src/Simplify.Web.Postman/ICollectionPartBuilder.cs

@@ -2,8 +2,15 @@
 
 namespace Simplify.Web.Postman
 {
+	/// <summary>
+	/// Provides postman collection part builder
+	/// </summary>
 	public interface ICollectionPartBuilder
 	{
+		/// <summary>
+		/// Builds the specified model part.
+		/// </summary>
+		/// <param name="model">The model.</param>
 		void Build(CollectionModel model);
 	}
 }

src/Simplify.Web.Postman/Models/CollectionHeader.cs

@@ -1,5 +1,8 @@
 namespace Simplify.Web.Postman.Models
 {
+	/// <summary>
+	/// Provides postman collection header
+	/// </summary>
 	public class CollectionHeader
 	{
 	}

src/Simplify.Web.Postman/Models/CollectionModel.cs

@@ -1,7 +1,16 @@
 namespace Simplify.Web.Postman.Models
 {
+	/// <summary>
+	/// Provides postman collection model
+	/// </summary>
 	public class CollectionModel
 	{
-		public CollectionHeader Header { get; set; }
+		/// <summary>
+		/// Gets or sets the header.
+		/// </summary>
+		/// <value>
+		/// The header.
+		/// </value>
+		public CollectionHeader? Header { get; set; }
 	}
 }

src/Simplify.Web.Postman/PostmanGenerationSettings.cs

@@ -1,6 +1,58 @@
 namespace Simplify.Web.Postman
 {
+	/// <summary>
+	/// Provides postman files generation settings
+	/// </summary>
 	public class PostmanGenerationSettings
 	{
+		/// <summary>
+		/// Initializes a new instance of the <see cref="PostmanGenerationSettings"/> class.
+		/// </summary>
+		public PostmanGenerationSettings()
+		{
+			GenerationFolderPath = "postman";
+			CollectionFileNamePostfix = ".postman_collection";
+			EnvironmentFileNamePostfix = ".postman_environment";
+		}
+
+		/// <summary>
+		/// Gets or sets the name of the collection file.
+		/// </summary>
+		/// <value>
+		/// The name of the collection file.
+		/// </value>
+		public string? CollectionFileName { get; set; }
+
+		/// <summary>
+		/// Gets or sets the collection file name postfix.
+		/// </summary>
+		/// <value>
+		/// The collection file name postfix.
+		/// </value>
+		public string CollectionFileNamePostfix { get; set; }
+
+		/// <summary>
+		/// Gets or sets the name of the environment file.
+		/// </summary>
+		/// <value>
+		/// The name of the environment file.
+		/// </value>
+		public string? EnvironmentFileName { get; set; }
+
+		/// <summary>
+		/// Gets or sets the environment file name postfix.
+		/// </summary>
+		/// <value>
+		/// The environment file name postfix.
+		/// </value>
+		public string EnvironmentFileNamePostfix { get; set; }
+
+		/// <summary>
+		/// Gets or sets the generation folder path.
+		/// </summary>
+		/// <value>
+		/// The generation folder path.
+		/// </value>
+		public string GenerationFolderPath { get; set; }
 	}
 }

src/Simplify.Web.Postman/PostmanGenerator.cs

@@ -2,17 +2,33 @@
 
 namespace Simplify.Web.Postman
 {
+	/// <summary>
+	///  Provides postman data generation root
+	/// </summary>
 	public class PostmanGenerator
 	{
 		private readonly CollectionBuilder _builder;
 		private readonly ICollectionExporter _exporter;
 
+		/// <summary>
+		/// Initializes a new instance of the <see cref="PostmanGenerator"/> class.
+		/// </summary>
+		/// <param name="builder">The builder.</param>
+		/// <param name="exporter">The exporter.</param>
+		/// <exception cref="ArgumentNullException">
+		/// builder
+		/// or
+		/// exporter
+		/// </exception>
 		public PostmanGenerator(CollectionBuilder builder, ICollectionExporter exporter)
 		{
 			_builder = builder ?? throw new ArgumentNullException(nameof(builder));
 			_exporter = exporter ?? throw new ArgumentNullException(nameof(exporter));
 		}
 
+		/// <summary>
+		/// Generates the postman collection.
+		/// </summary>
 		public void GenerateCollection()
 		{
 			_exporter.Export(_builder.Create());