Skip to main content

Advance enum generation for lookup table through T4

Sometime back I had written simple T4 to generate enum for look up tables http://vikutech.blogspot.in/2014/01/enumeration-generation-for-lookup-table.html. Later on I had posted same on Nu-Get https://www.nuget.org/packages/t4.lookup.

This time I am going to extend it to support multiple enums, enum Id, configuration through class and different settings for enum description, columns.

Here is the entire code for generating code

 <#@ template debug="true" hostSpecific="true" #>  
 <#@ output extension=".cs" #>  
 <#@ Assembly Name="System.Data" #>  
 <#@ import namespace="System" #>  
 <#@ import namespace="System.Collections.Generic" #>  
 <#@ include file="EF.Utility.CS.ttinclude"#>  
 <#@ import namespace="System.Data.SqlClient" #>   
 <#  
   // TODO: Look for alternatives to remove connection string  
   var connectString = "data source=.;initial catalog=Test;integrated security=True";  
   var configList = new List<EnumConfiguration>{  
       new EnumConfiguration{  
         TableName = "LookupCountry",  
         EnumName = "Country",    // Can be empty, Get inherited based on table name  
         EnumColumn = new EnumColumnDetail {  
           Key = "Code",  
           EnumDesc = "Name",   // Not Mandatory  
           EnumSequence = "Id"   // Not Mandatory  
           },  
         },  
       new EnumConfiguration{  
         TableName = "LookupCountry",  
         EnumColumn = new EnumColumnDetail {  
           Key = "Code",  
           },  
         }  
       };  
   var code = new CodeGenerationTools(this);  
 #>  
 using System.CodeDom.Compiler;  
 namespace <#=    code.VsNamespaceSuggestion()#>  
 {    
      //------------------------------------------------------------------------------  
      // <auto-generated>  
      //   This code was generated from a template and will be overwritten as soon   
      //       as the template is executed.  
      //  
      //   Changes to this file may cause incorrect behavior and will be lost if  
      //   the code is regenerated.  
      // </auto-generated>  
      //------------------------------------------------------------------------------  
 <#  
   using (SqlConnection connection =  
       new SqlConnection(connectString))  
   {  
     connection.Open();  
     foreach(var config in configList)  
     {  
       if(!config.IsValid()) {  
         throw new ArgumentException("Please check the configuration carefully.");  
       }  
     #>  
   /// <summary>  
   /// <#=config.EnumNameDescription #>  
   /// <summary>  
   [GeneratedCode("T4.Lookup", "2.0")]  
   public enum <#=config.EnumNameDescription #>  
   {  
 <#  
       var command = new SqlCommand(config.ToString(), connection);  
       SqlDataReader reader = command.ExecuteReader();  
       // Call Read before accessing data.   
       while (reader.Read())  
       {  
         var enumId = String.IsNullOrEmpty(config.EnumColumn.EnumSequence) ? String.Empty : (" = " + reader[2]);  
 #>  
     /// <summary>  
     /// <#=          reader[1] #>  
     /// </summary>  
           <#=reader[0] #><#=enumId#>,   
 <#  
       }  
       reader.Close();   
 #>  
   }  
 <#  
     }  
   }  
 #>  
 }  
 <#+  
     /// <summary>  
   /// Enum configuration details  
   /// </summary>  
   internal class EnumConfiguration  
   {  
     /// <summary>  
     /// The enum name  
     /// </summary>  
     private string _enumName;  
     /// <summary>  
     /// The enum name description for XML comment  
     /// </summary>  
     private string _enumNameDesc;  
     public string TableName { get; set; }  
     /// <summary>  
     /// Gets or sets the name of the enum.  
     /// </summary>  
     /// <value>  
     /// The name of the enum.  
     /// </value>  
     public string EnumName  
     {  
       get  
       {  
         return String.IsNullOrEmpty(_enumName) ? TableName : _enumName;  
       }  
       set  
       {  
         _enumName = value;  
       }  
     }  
     /// <summary>  
     /// Gets or sets the enum name description.  
     /// </summary>  
     /// <value>  
     /// The enum name description.  
     /// </value>  
     public string EnumNameDescription  
     {  
       get  
       {  
         return String.IsNullOrEmpty(_enumNameDesc) ? EnumName : _enumNameDesc;  
       }  
       set  
       {  
         _enumNameDesc = value;  
       }  
     }  
     /// <summary>  
     /// Gets or sets the enum column details.  
     /// </summary>  
     /// <value>  
     /// The enum column details.  
     /// </value>  
     public EnumColumnDetail EnumColumn { get; set; }  
     /// <summary>  
     /// Determines whether this instance is valid.  
     /// </summary>  
     /// <returns></returns>  
     public bool IsValid()  
     {  
       return (!String.IsNullOrEmpty(TableName) && EnumColumn != null &&  
         !String.IsNullOrEmpty(EnumColumn.Key));  
     }  
     /// <summary>  
     /// Returns SQL query string.  
     /// </summary>  
     /// <returns>  
     /// Query string for SQL.  
     /// </returns>  
     public override string ToString()  
     {  
       if (IsValid())  
       {  
         // Generate SQL query  
         return String.Format("SELECT {0} AS EnumKey, {1} AS EnumDesc {3} FROM {2} order by {0}",  
           EnumColumn.Key, EnumColumn.EnumDesc, TableName,  
           String.IsNullOrEmpty(EnumColumn.EnumSequence) // Sequence number, if needed  
           ? String.Empty :  
           ", " + EnumColumn.EnumSequence);   
       }  
       return null;  
     }  
   }  
   /// <summary>  
   /// Generating enum column details  
   /// </summary>  
   internal class EnumColumnDetail  
   {  
     /// <summary>  
     /// The enum description  
     /// </summary>  
     private string _enumDesc;  
     /// <summary>  
     /// Gets or sets the key for enum that would be used.  
     /// </summary>  
     /// <value>  
     /// The key.  
     /// </value>  
     public string Key { get; set; }  
     /// <summary>  
     /// Gets or sets the enum description column.  
     /// </summary>  
     /// <value>  
     /// The enum description column.  
     /// </value>  
     public string EnumDesc  
     {  
       get  
       {  
         return String.IsNullOrEmpty(_enumDesc) ? Key : _enumDesc;  
       }  
       set  
       {  
         _enumDesc = value;  
       }  
     }  
     /// <summary>  
     /// Gets or sets the enum sequence Id.  
     /// </summary>  
     /// <value>  
     /// The enum sequence Id.  
     /// </value>  
     public string EnumSequence { get; set; }  
   }  
  #>  

connectString : The Sql connection string to retrieve tables from look up.

EnumConfiguration class is created to put up configuration for enum generation. configList is initialized to set multiple values based on need.

These are the details to configure enum generation:
TableName : The name of look up table. [Mandatory]
EnumName : Desired enum name associated with TableName. If not provided, get same name as                       table name. [Not-Mandatory]
EnumColumn :
       Key : The column name of table to generate enum names. [Mandatory]
       EnumDesc : The column name of table to generate XML description for each enum name.                             [Not-Mandatory]
       EnumSequence : The column name of table to generate underlying enum value.
                                 [Not-Mandatory]


Comments

Popular posts from this blog

Making FluentValidation compatible with Swagger including Enum or fixed List support

FluentValidation is not directly compatible with Swagger API to validate models. But they do provide an interface through which we can compose Swagger validation manually. That means we look under FluentValidation validators and compose Swagger validator properties to make it compatible. More of all mapping by reading information from FluentValidation and setting it to Swagger Model Schema. These can be done on any custom validation from FluentValidation too just that proper schema property has to be available from Swagger. Custom validation from Enum/List values on FluentValidation using FluentValidation.Validators; using System.Collections.Generic; using System.Linq; using static System.String; /// <summary> /// Validator as per list of items. /// </summary> /// <seealso cref="PropertyValidator" /> public class FixedListValidator : PropertyValidator { /// <summary> /// Gets the valid items /// <...

Getting started with Raspberry Pi

Raspberry Pi is a small, low powered motherboard contains 512 RAM, combined CPU and GPU. It has LAN, 2 USB, HDMI input, Audio Out, SD Card reader and S-Video connectors. We can have many Linux distribution OS on it. To configure, we just need to attach SD Card to it. SD Card could range from class 4 to class 10. In some cases Raspberry Pi could support less then class 4 cards too. It could be powered through mini USB mobile charger. Let's get started with installing OS on SD Card. There are various ways to install OS. Like we can download OSes through  http://www.raspberrypi.org/downloads  and follow the instructions given on it. There is something BerryBoot multi-boot loader through which we can have more then one OS on Raspberry Pi and boot OS according to our need.  http://www.berryterminal.com/doku.php/berryboot  instructions could be followed to install OS with very simple steps. You need to have internet connection on Raspberry Pi to install OS. It coul...

main method return value

Mainly we used to write "static void main" for entry point in console application. Placement of void denotes return type. In main function we could have "int" too but what does it really mean. "int main" signifies return type as integer. The return type of main function tells about execution status of application. Even if we have specified void as return type then it would be marked as successful program execution. If we mark int as return type then we are able to control the execution status. Now, what is the benefit of making main function as int. Windows OS saves result in  %ERRORLEVEL% environment variable of OS. If we create batch file and execute application through it then we will able to get status and based on result we can trigger something else through batch file. Let's suppose we have created program called TEST.EXE. Batch file script: @echo off REM Execute main program REM TEST.EXE @if  "%ERRORLEVEL%" == "0...

Trim text in MVC Core through Model Binder

Trimming text can be done on client side codes, but I believe it is most suitable on MVC Model Binder since it would be at one place on infrastructure level which would be free from any manual intervention of developer. This would allow every post request to be processed and converted to a trimmed string. Let us start by creating Model binder using Microsoft.AspNetCore.Mvc.ModelBinding; using System; using System.Threading.Tasks; public class TrimmingModelBinder : IModelBinder { private readonly IModelBinder FallbackBinder; public TrimmingModelBinder(IModelBinder fallbackBinder) { FallbackBinder = fallbackBinder ?? throw new ArgumentNullException(nameof(fallbackBinder)); } public Task BindModelAsync(ModelBindingContext bindingContext) { if (bindingContext == null) { throw new ArgumentNullException(nameof(bindingContext)); } var valueProviderResult = bindingContext.ValueProvider.GetValue(bin...

Kendo MVC Grid DataSourceRequest with AutoMapper - Advance

The actual process to make DataSourceRequest compatible with AutoMapper was explained in my previous post  Kendo MVC Grid DataSourceRequest with AutoMapper , where we had created custom model binder attribute and in that property names were changed as data models. In this post we will be looking into using AutoMapper's Queryable extension to retrieve the results based on selected columns. When  Mapper.Map<RoleViewModel>(data)  is called it retrieves all column values from table. The Queryable extension provides a way to retrieve only selected columns from table. In this particular case based on properties of  RoleViewModel . The previous approach that we implemented is perfect as far as this article ( 3 Tips for Using Telerik Data Access and AutoMapper ) is concern about performance where it states: While this functionality allows you avoid writing explicit projection in to your LINQ query it has the same fatal flaw as doing so - it prevents the qu...

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied. The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented. So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of  CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc. Let's first look into how that will be implemented. public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request) { if (request == null) { throw new Argume...

C# Response files

Response files are similar to batch files, having some specific instruction. On execution they perform some predefined task based on instruction. Response file contains instruction to compile programs. If we have to build complex program through command line then response files are really helpful in development process. rsp is an extension for response files. By default, csc.rsp file exists under "Framework" folder Ex: C:\Windows\Microsoft.NET\Framework\v4.0.30319. csc.rsp contains long list of system references (dlls). Some contents under csc.rsp # Reference the common Framework libraries /r:Accessibility.dll /r:Microsoft.CSharp.dll /r:System.Configuration.dll /r:System.Configuration.Install.dll /r:System.Core.dll /r:System.Data.dll /r:System.Data.DataSetExtensions.dll /r:System.Data.Linq.dll .......... In same way we can have our own response file defined which might include some third party dll. Let's see an example. Suppose we have to create an appli...

Implementing/Automating audit logs in Telerik Data Access

Audit logs can be tedious task if done manually, also developer might miss to update audit log implementation on certain level. The codes would be repeated on all places if not centralized. There are many approach available to maintain change history of model/table. Like having single history table and manage all changes of all models in same table. We may maintain in same table with some flags and JSON data for change list. We will look for maintaining history table based on each required data models with minimum effort and performance. To reduce code, I am going to use T4 to generate history models automatically based on original model. Also we are going to take care of Artificial type values. Step 1 - Create a custom attribute to mark model that history need to be maintained. /// <summary> /// Attribute to maintain history table /// </summary> [AttributeUsage(AttributeTargets.Class)] public class ManageHistoryAttribute : Attribute ...

Using Redis distributed cache in dotnet core with helper extension methods

Redis cache is out process cache provider for a distributed environment. It is popular in Azure Cloud solution, but it also has a standalone application to operate upon in case of small enterprises application. How to install Redis Cache on a local machine? Redis can be used as a local cache server too on our local machines. At first install, Chocolatey https://chocolatey.org/ , to make installation of Redis easy. Also, the version under Chocolatey supports more commands and compatible with Official Cache package from Microsoft. After Chocolatey installation hit choco install redis-64 . Once the installation is done, we can start the server by running redis-server . Distributed Cache package and registration dotnet core provides IDistributedCache interface which can be overrided with our own implementation. That is one of the beauties of dotnet core, having DI implementation at heart of framework. There is already nuget package available to override IDistributedCache i...

Centralized model validation both for MVC/WebApi and SPA client-side validation using FluentValidation

Validation is one of the crucial parts of any application. It has to validate on both client side and server side requests. What are target features or implementation from this article? Model validation for any given model. Centralized/One code for validation on both server-side and client-side. Automatic validation of model without writing any extra codes on/under actions for validation.  NO EXTRA/ANY codes on client-side to validate any form. Compatible with SPA. Can be compatible with any client-side validation framework/library. Like Angular Reactive form validation or any jquery validation libraries. Tools used in the implementation? FluentValidation : I feel DataAnnotation validation are excellent and simple to use, but in case of complex validation or writing any custom validations are always tricker and need to write a lot of codes to achieve whereas FluentValidations are simple even in case of complex validation. Generally, we need to validate inc...