Add user defined fields template generation.

I-RzR-I · I-RzR-I · commit 68fecc14eea0 · 2025-03-20T22:05:16.000+02:00
Add custom user defined fields on template generation based on class type (GenerateTemplate/Async&lt;T&gt;).
diff --git a/src/DynamicExcelProvider/Abstractions/IExcelWriteFactoryProvider.cs b/src/DynamicExcelProvider/Abstractions/IExcelWriteFactoryProvider.cs
@@ -207,11 +207,12 @@ Task<IResult> GenerateAsync<TDataModel>(Stream stream, IReadOnlyCollection<TData
         /// </summary>
         /// <typeparam name="T">Generic type parameter.</typeparam>
         /// <param name="lcid">The lcid.</param>
+        /// <param name="customOutFields">Custom user defined output/result fields.</param>
         /// <returns>
         ///     The template.
         /// </returns>
         /// =================================================================================================
-        IResult<byte[]> GenerateTemplate<T>(int lcid) where T : class;
+        IResult<byte[]> GenerateTemplate<T>(int lcid, IReadOnlyCollection<string> customOutFields = null) where T : class;
 
         /// -------------------------------------------------------------------------------------------------
         /// <summary>
@@ -220,26 +221,30 @@ Task<IResult> GenerateAsync<TDataModel>(Stream stream, IReadOnlyCollection<TData
         /// <typeparam name="T">Generic type parameter.</typeparam>
         /// <param name="stream">The stream.</param>
         /// <param name="lcid">The lcid.</param>
+        /// <param name="customOutFields">Custom user defined output/result fields.</param>
         /// <returns>
         ///     The template.
         /// </returns>
         /// =================================================================================================
-        IResult GenerateTemplate<T>(MemoryStream stream, int lcid) where T : class;
+        IResult GenerateTemplate<T>(MemoryStream stream, int lcid, 
+            IReadOnlyCollection<string> customOutFields = null) where T : class;
 
         /// -------------------------------------------------------------------------------------------------
         /// <summary>
         ///     Generates a template asynchronous.
         /// </summary>
         /// <typeparam name="T">Generic type parameter.</typeparam>
         /// <param name="lcid">The lcid.</param>
+        /// <param name="customOutFields">Custom user defined output/result fields.</param>
         /// <param name="cancellationToken">
         ///     (Optional) A token that allows processing to be cancelled.
         /// </param>
         /// <returns>
         ///     The template asynchronous.
         /// </returns>
         /// =================================================================================================
-        Task<IResult<byte[]>> GenerateTemplateAsync<T>(int lcid, CancellationToken cancellationToken = default) where T : class;
+        Task<IResult<byte[]>> GenerateTemplateAsync<T>(int lcid, 
+            IReadOnlyCollection<string> customOutFields = null, CancellationToken cancellationToken = default) where T : class;
 
         /// -------------------------------------------------------------------------------------------------
         /// <summary>
@@ -248,13 +253,15 @@ Task<IResult> GenerateAsync<TDataModel>(Stream stream, IReadOnlyCollection<TData
         /// <typeparam name="T">Generic type parameter.</typeparam>
         /// <param name="stream">The stream.</param>
         /// <param name="lcid">The lcid.</param>
+        /// <param name="customOutFields">Custom user defined output/result fields.</param>
         /// <param name="cancellationToken">
         ///     (Optional) A token that allows processing to be cancelled.
         /// </param>
         /// <returns>
         ///     The template asynchronous.
         /// </returns>
         /// =================================================================================================
-        Task<IResult> GenerateTemplateAsync<T>(MemoryStream stream, int lcid, CancellationToken cancellationToken = default) where T : class;
+        Task<IResult> GenerateTemplateAsync<T>(MemoryStream stream, int lcid, 
+            IReadOnlyCollection<string> customOutFields = null, CancellationToken cancellationToken = default) where T : class;
     }
 }
diff --git a/src/DynamicExcelProvider/Helpers/DataValidationsBuildHelper.cs b/src/DynamicExcelProvider/Helpers/DataValidationsBuildHelper.cs
@@ -55,7 +55,9 @@ internal static class DataValidationsBuildHelper
         ///     The DataValidations.
         /// </returns>
         /// =================================================================================================
-        internal static DataValidations BuildSheetDataValidations(ref IEnumerable<PropertyInfo> properties, ref IReadOnlyCollection<PropTranslateModel> outputProps)
+        internal static DataValidations BuildSheetDataValidations(
+            ref IEnumerable<PropertyInfo> properties, 
+            ref IReadOnlyCollection<PropTranslateModel> outputProps)
         {
             try
             {
diff --git a/src/DynamicExcelProvider/Helpers/DocGenerateParserHelper.cs b/src/DynamicExcelProvider/Helpers/DocGenerateParserHelper.cs
@@ -18,6 +18,7 @@
 
 using AggregatedGenericResultMessage;
 using AggregatedGenericResultMessage.Abstractions;
+using DomainCommonExtensions.ArraysExtensions;
 using DomainCommonExtensions.DataTypeExtensions;
 using DynamicExcelProvider.Extensions;
 using DynamicExcelProvider.Helpers.DataTable;
@@ -34,6 +35,7 @@
 #endregion
 
 [assembly: InternalsVisibleTo("GeneralDocumentGeneratorTests")]
+
 namespace DynamicExcelProvider.Helpers
 {
     /// -------------------------------------------------------------------------------------------------
@@ -112,18 +114,18 @@ internal static IResult<byte[]> Generate<TResult>(IReadOnlyCollection<TResult> d
 
             var ms = new MemoryStream();
             var wbDef = WorkbookParseBuildHelper.BuildAndParseToWorkbookDefinition(
-                sheetName, 
+                sheetName,
                 outputProps,
                 embeddedModelCollection,
-                data, 
+                data,
                 false);
             if (wbDef.IsSuccess.IsFalse())
                 return Result<byte[]>.Failure(wbDef.GetFirstMessage());
 
             var document = SpreadsheetDocumentHelper.Instance.Write(ms, wbDef.Response);
-            
-            return document.IsSuccess.IsFalse() 
-                ? Result<byte[]>.Failure(document.Messages.FirstOrDefault()?.Message) 
+
+            return document.IsSuccess.IsFalse()
+                ? Result<byte[]>.Failure(document.Messages.FirstOrDefault()?.Message)
                 : Result<byte[]>.Success(ms.ToArray());
         }
 
@@ -150,18 +152,18 @@ internal static IResult Generate<TResult>(Stream stream, IReadOnlyCollection<TRe
             var (outputProps, embeddedModelCollection) = infoDataModel.Response;
 
             var wbDef = WorkbookParseBuildHelper.BuildAndParseToWorkbookDefinition(
-                sheetName, 
-                outputProps, 
-                embeddedModelCollection, 
-                data, 
+                sheetName,
+                outputProps,
+                embeddedModelCollection,
+                data,
                 false);
             if (wbDef.IsSuccess.IsFalse())
                 return Result.Failure(wbDef.GetFirstMessage());
 
             var document = SpreadsheetDocumentHelper.Instance.Write(stream, wbDef.Response);
-            
-            return document.IsSuccess.IsFalse() 
-                ? Result.Failure(document.Messages.FirstOrDefault()?.Message) 
+
+            return document.IsSuccess.IsFalse()
+                ? Result.Failure(document.Messages.FirstOrDefault()?.Message)
                 : Result.Success();
         }
 
@@ -178,7 +180,7 @@ internal static IResult<byte[]> Generate(ExcelCollectionExportConfiguration expo
         {
             var infoDataModel = (IResult<(List<PropTranslateModel>, List<PropModel>)>)WorkbookParseBuildHelper
                 .BuildAndParseInternalModelDynamic(
-                exportConfiguration.Configuration, 
+                exportConfiguration.Configuration,
                 exportConfiguration.DataCollection.FirstOrDefault());
             if (infoDataModel.IsSuccess.IsFalse())
                 return Result<byte[]>.Failure(infoDataModel.GetFirstMessage());
@@ -188,18 +190,18 @@ internal static IResult<byte[]> Generate(ExcelCollectionExportConfiguration expo
             var ms = new MemoryStream();
 
             var wbDef = WorkbookParseBuildHelper.BuildAndParseToWorkbookDefinition(
-                exportConfiguration.Configuration.SheetName, 
+                exportConfiguration.Configuration.SheetName,
                 outputProps,
-                embeddedModelCollection, 
-                exportConfiguration.DataCollection, 
+                embeddedModelCollection,
+                exportConfiguration.DataCollection,
                 true);
             if (wbDef.IsSuccess.IsFalse())
                 return Result<byte[]>.Failure(wbDef.GetFirstMessage());
 
             var document = SpreadsheetDocumentHelper.Instance.Write(ms, wbDef.Response);
 
-            return document.IsSuccess.IsFalse() 
-                ? Result<byte[]>.Failure(document.Messages.FirstOrDefault()?.Message) 
+            return document.IsSuccess.IsFalse()
+                ? Result<byte[]>.Failure(document.Messages.FirstOrDefault()?.Message)
                 : Result<byte[]>.Success(ms.ToArray());
         }
 
@@ -217,26 +219,26 @@ internal static IResult Generate(Stream stream, ExcelCollectionExportConfigurati
         {
             var infoDataModel = (IResult<(List<PropTranslateModel>, List<PropModel>)>)WorkbookParseBuildHelper
                 .BuildAndParseInternalModelDynamic(
-                exportConfiguration.Configuration, 
+                exportConfiguration.Configuration,
                 exportConfiguration.DataCollection.FirstOrDefault());
             if (infoDataModel.IsSuccess.IsFalse())
                 return Result.Failure(infoDataModel.GetFirstMessage());
 
             var (outputProps, embeddedModelCollection) = infoDataModel.Response;
 
             var wbDef = WorkbookParseBuildHelper.BuildAndParseToWorkbookDefinition(
-                exportConfiguration.Configuration.SheetName, 
+                exportConfiguration.Configuration.SheetName,
                 outputProps,
-                embeddedModelCollection, 
+                embeddedModelCollection,
                 exportConfiguration.DataCollection,
                 true);
             if (wbDef.IsSuccess.IsFalse())
                 return Result.Failure(wbDef.GetFirstMessage());
 
             var document = SpreadsheetDocumentHelper.Instance.Write(stream, wbDef.Response);
 
-            return document.IsSuccess.IsFalse() 
-                ? Result.Failure(document.Messages.FirstOrDefault()?.Message) 
+            return document.IsSuccess.IsFalse()
+                ? Result.Failure(document.Messages.FirstOrDefault()?.Message)
                 : Result.Success();
         }
 
@@ -246,11 +248,15 @@ internal static IResult Generate(Stream stream, ExcelCollectionExportConfigurati
         /// </summary>
         /// <typeparam name="T">Generic type parameter.</typeparam>
         /// <param name="lcid">The lcid.</param>
+        /// <param name="customOutFields">Custom user defined output/result fields.</param>
         /// <returns>
         ///     The template.
         /// </returns>
         /// =================================================================================================
-        internal static IResult<byte[]> GenerateTemplate<T>(int lcid) where T : class
+        internal static IResult<byte[]> GenerateTemplate<T>(
+            int lcid,
+            IReadOnlyCollection<string> customOutFields = null) 
+            where T : class
         {
             const string sheetName = "Sheet1";
             var infoDataModel = WorkbookParseBuildHelper.BuildAndParseInternalModelDynamic(
@@ -260,26 +266,29 @@ internal static IResult<byte[]> GenerateTemplate<T>(int lcid) where T : class
 
             var (outputProps, embeddedModelCollection) = infoDataModel.Response;
 
+            if (customOutFields.IsNullOrEmptyEnumerable().IsFalse())
+                outputProps = outputProps.Where(x => customOutFields!.Contains(x.CommonName)).ToList();
+
             var ms = new MemoryStream();
 
             var wbDef = WorkbookParseBuildHelper.BuildAndParseToWorkbookDefinition(
-                sheetName: sheetName, 
+                sheetName: sheetName,
                 outputProps: outputProps,
                 embeddedModelCollection: embeddedModelCollection,
-                data: new List<T>(), 
-                isDynamic: true, 
-                sourceRowType: typeof(T), 
+                data: new List<T>(),
+                isDynamic: true,
+                sourceRowType: typeof(T),
                 generateSheetValidations: true);
             if (wbDef.IsSuccess.IsFalse())
                 return Result<byte[]>.Failure(wbDef.GetFirstMessage());
 
             var document = SpreadsheetDocumentHelper.Instance.Write(
-                stream: ms, 
-                workBook: wbDef.Response, 
+                stream: ms,
+                workBook: wbDef.Response,
                 appendSheetValidations: true);
 
-            return document.IsSuccess.IsFalse() 
-                ? Result<byte[]>.Failure(document.Messages.FirstOrDefault()?.Message) 
+            return document.IsSuccess.IsFalse()
+                ? Result<byte[]>.Failure(document.Messages.FirstOrDefault()?.Message)
                 : Result<byte[]>.Success(ms.ToArray());
         }
 
@@ -290,11 +299,16 @@ internal static IResult<byte[]> GenerateTemplate<T>(int lcid) where T : class
         /// <typeparam name="T">Generic type parameter.</typeparam>
         /// <param name="stream">The stream.</param>
         /// <param name="lcid">The lcid.</param>
+        /// <param name="customOutFields">Custom user defined output/result fields.</param>
         /// <returns>
         ///     The template.
         /// </returns>
         /// =================================================================================================
-        internal static IResult GenerateTemplate<T>(MemoryStream stream, int lcid) where T : class
+        internal static IResult GenerateTemplate<T>(
+            MemoryStream stream, 
+            int lcid,
+            IReadOnlyCollection<string> customOutFields = null) 
+            where T : class
         {
             const string sheetName = "Sheet1";
             var infoDataModel = WorkbookParseBuildHelper.BuildAndParseInternalModelDynamic(
@@ -304,6 +318,9 @@ internal static IResult GenerateTemplate<T>(MemoryStream stream, int lcid) where
 
             var (outputProps, embeddedModelCollection) = infoDataModel.Response;
 
+            if (customOutFields.IsNullOrEmptyEnumerable().IsFalse())
+                outputProps = outputProps.Where(x => customOutFields!.Contains(x.CommonName)).ToList();
+
             var wbDef = WorkbookParseBuildHelper.BuildAndParseToWorkbookDefinition(
                 sheetName: sheetName,
                 outputProps: outputProps,
@@ -316,8 +333,8 @@ internal static IResult GenerateTemplate<T>(MemoryStream stream, int lcid) where
                 return Result.Failure(wbDef.GetFirstMessage());
 
             var document = SpreadsheetDocumentHelper.Instance.Write(
-                stream: stream, 
-                workBook: wbDef.Response, 
+                stream: stream,
+                workBook: wbDef.Response,
                 appendSheetValidations: true);
 
             return document.IsSuccess.IsFalse()
diff --git a/src/DynamicExcelProvider/Providers/ExcelWriteFactoryProvider.cs b/src/DynamicExcelProvider/Providers/ExcelWriteFactoryProvider.cs
@@ -170,21 +170,24 @@ public async Task<IResult> GenerateAsync(
             => await _spreadsheetDocumentService.WriteFileAsync(stream, workBook, cancellationToken);
 
         /// <inheritdoc />
-        public IResult<byte[]> GenerateTemplate<T>(int lcid) where T : class
-            => DocGenerateParserHelper.GenerateTemplate<T>(lcid);
+        public IResult<byte[]> GenerateTemplate<T>(int lcid, IReadOnlyCollection<string> customOutFields = null) where T : class
+            => DocGenerateParserHelper.GenerateTemplate<T>(lcid, customOutFields);
 
         /// <inheritdoc />
-        public IResult GenerateTemplate<T>(MemoryStream stream, int lcid) where T : class
-            => DocGenerateParserHelper.GenerateTemplate<T>(stream, lcid);
+        public IResult GenerateTemplate<T>(MemoryStream stream, int lcid, 
+            IReadOnlyCollection<string> customOutFields = null) where T : class
+            => DocGenerateParserHelper.GenerateTemplate<T>(stream, lcid, customOutFields);
 
         /// <inheritdoc />
         public async Task<IResult<byte[]>> GenerateTemplateAsync<T>(int lcid, 
+            IReadOnlyCollection<string> customOutFields = null, 
             CancellationToken cancellationToken = default) where T : class
-            => await Task.Run(() => GenerateTemplate<T>(lcid), cancellationToken);
+            => await Task.Run(() => GenerateTemplate<T>(lcid, customOutFields), cancellationToken);
 
         /// <inheritdoc />
         public async Task<IResult> GenerateTemplateAsync<T>(MemoryStream stream, int lcid, 
+            IReadOnlyCollection<string> customOutFields = null, 
             CancellationToken cancellationToken = default) where T : class
-            => await Task.Run(() => GenerateTemplate<T>(stream, lcid), cancellationToken);
+            => await Task.Run(() => GenerateTemplate<T>(stream, lcid, customOutFields), cancellationToken);
     }
 }
diff --git a/src/tests/GeneralDocumentGeneratorTests/GenerateExcelTemplateTests.cs b/src/tests/GeneralDocumentGeneratorTests/GenerateExcelTemplateTests.cs
@@ -91,5 +91,33 @@ public void Generator_xlsx_Empty_Template_Stream_PublicSet_Test(int lcid)
             Assert.IsNotNull(fs);
             Assert.IsNotNull(fs.Length > 0);
         }
+
+        [DataRow(1048)]
+        [DataRow(1033)]
+        [TestMethod]
+        public void Generator_xlsx_Empty_Template_Stream_PublicSet_CustomFields_Test(int lcid)
+        {
+            var ms = new MemoryStream();
+            var bytesArray = DocGenerateParserHelper.GenerateTemplate<GenerateDataTemp>(
+                ms, lcid, new[]
+                {
+                    nameof(GenerateDataTemp.Id),
+                    nameof(GenerateDataTemp.OperationId),
+                    nameof(GenerateDataTemp.Name)
+                });
+
+            if (bytesArray.IsSuccess.IsFalse())
+                throw new Exception(bytesArray.GetFirstMessage());
+
+            Assert.IsTrue(bytesArray.IsSuccess);
+
+            var filePath = Path.Combine(Directory.GetCurrentDirectory(),
+                $"G_xlsx_Empty_T_Stream_PublicSet_CustomFields_{lcid}_{Guid.NewGuid():N}.xlsx");
+            using var fs = new FileStream(filePath, FileMode.OpenOrCreate, FileAccess.ReadWrite);
+            fs.Write(ms.ToArray());
+
+            Assert.IsNotNull(fs);
+            Assert.IsNotNull(fs.Length > 0);
+        }
     }
 }
diff --git a/src/tests/GeneralDocumentGeneratorTests/Models/GenerateDataTemp.cs b/src/tests/GeneralDocumentGeneratorTests/Models/GenerateDataTemp.cs
@@ -46,7 +46,7 @@ public class GenerateDataTemp
         [ExcelPropName("Nume", 1048, true, 3)]
         public string Name { get; set; }
 
-        [ExcelPropValidation(ValidationType.TextLength, ValidationOperatorType.LessThan, minValue: 5, promptMessage: "Code, max length 5", errorMessage: "Maximum length!!")]
+        [ExcelPropValidation(ValidationType.TextLength, ValidationOperatorType.LessThan, minValue: 5, promptMessage: "Code, length < 5", errorMessage: "Maximum length!!")]
         [ExcelPropName("Cod", 1048, true, 4)]
         public string Code { get; set; }
 

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,9 @@ internal static class DataValidationsBuildHelper`
`55`	`55`	`/// The DataValidations.`
`56`	`56`	`/// </returns>`
`57`	`57`	`/// =================================================================================================`
`58`		`- internal static DataValidations BuildSheetDataValidations(ref IEnumerable<PropertyInfo> properties, ref IReadOnlyCollection<PropTranslateModel> outputProps)`
	`58`	`+ internal static DataValidations BuildSheetDataValidations(`
	`59`	`+ ref IEnumerable<PropertyInfo> properties,`
	`60`	`+ ref IReadOnlyCollection<PropTranslateModel> outputProps)`
`59`	`61`	`{`
`60`	`62`	`try`
`61`	`63`	`{`