Skip to main content

Auto fluent mapping generation for OpenAccess/Telerik DataAccess through T4

There is two way to map code first with DB related entities. The first is data annotation which is like setting attributes and the other one is fluent mapping. Fluent mapping is very powerful and flexible approach to map entities. The only downside of fluent mapping is incompatibility with client side validation where as MVC has inbuilt functionality to validate on client side with data annotation.

We will look into basic fluent mapping generation along with data annotation if present. Default data annotation is not compatible with Telerik DataAccess/OpenAccess. This article does not gives information about how fluent mapping works or how to generate it but auto generation of fluent mapping by any give model.

Pre-requisites for fluent generation
I have took help of two different libraries to generate fluent mapping for OpenAccess.
- MultiOutput.ttinclude (https://github.com/subsonic/SubSonic-3.0-Templates/blob/master/ActiveRecord/MultiOutput.ttinclude) : This is to generate multiple files through single T4 file.
- VisualStudioAutomationHelper.ttinclude (https://github.com/PombeirP/T4Factories/blob/master/T4Factories.Testbed/CodeTemplates/VisualStudioAutomationHelper.ttinclude) : This will help us in reading existing models and refactoring through EnvDte library.

Guide to be followed for generation:

 Choose the path to include above files (In my case those are kept in T4Plugin):
<#@ include file="../../T4Plugin/VisualStudioAutomationHelper.ttinclude" #>

<#@ include file="../../T4Plugin/MultiOutput.ttinclude" #>

 White-listing and black listing properties
var whiteListPropertyTypes = new List<string>(){};

var blackListedPropertyNames = new List<string>();
In whiteListPropertyTypes list, we can specify the custom types that need to be included. Like some enumeration types. In same way some properties could be excluded by help of blackListedPropertyNames list.

Listing classes for generation of fluent mapping
var codeClass in allClasses.OfType<CodeClass2>()
        .Where(clas=> clas!=null && clas.FullName.StartsWith("T4FluentMapping.DomainModel") &&

        !clas.FullName.EndsWith("MetadataSource"))
This code will list up all classes starts with T4FluentMapping.DomainModel and excludes class ends with MetadataSource.

That is all needed to generate basic fluent mapping. Here the all code goes:
-----------------------------------------------------------------------------------------------
<#@ template  debug="true" hostSpecific="true" #>
<#@ output extension=".cs" #>
<#@ Assembly Name="EnvDTE" #>
<#@ Assembly Name="EnvDTE80" #>
<#@ Assembly name="System.ComponentModel.DataAnnotations" #>
<#@ import namespace="EnvDTE" #>
<#@ import namespace="EnvDTE80" #>
<#@ import namespace="System" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Collections" #>
<#@ import namespace="System.Collections.Generic" #> 
<#@ import namespace="System.ComponentModel.DataAnnotations" #>
<#@ import namespace="System.Text.RegularExpressions" #>
<#@ include file="../../T4Plugin/VisualStudioAutomationHelper.ttinclude" #>
<#@ include file="../../T4Plugin/MultiOutput.ttinclude" #>

 <#

     // get a reference to the project of this t4 template
    var project = VisualStudioHelper.CurrentProject;

     // get all class items from the code model
    var allClasses = VisualStudioHelper.GetAllCodeElementsOfType(project.CodeModel.CodeElements, EnvDTE.vsCMElement.vsCMElementClass, false);

     // TODO: Extra parameter type to get it listed
    // Ex: Model.Enumeration.DbOperation
var whiteListPropertyTypes = new List<string>(){};
var blackListedPropertyNames = new List<string>();

     // iterate all classes
    foreach(var codeClass in allClasses.OfType<CodeClass2>()
        .Where(clas=> clas!=null && clas.FullName.StartsWith("T4FluentMapping.DomainModel") &&
        !clas.FullName.EndsWith("MetadataSource")))
    {
        var fileName=codeClass.Name+"Mapping.Generated.cs";
        #>
namespace T4FluentMapping.Model.Mapping.FluentMapping
{
    //------------------------------------------------------------------------------
    // <auto-generated>
    //     This code was generated from a template and will be re-created if deleted
    //   with default values if executed.
    // </auto-generated>
    //------------------------------------------------------------------------------
    using Telerik.OpenAccess.Metadata;
    using Telerik.OpenAccess.Metadata.Fluent;

     /// <summary>
    /// Fluent mapping for <see cref="<#=            codeClass.FullName#>"/>
    /// </summary>
    public partial class <#=            codeClass.Name#>Mapping
   : MappingConfiguration<<#=            codeClass.FullName #>>
    {
        /// <summary>
        /// Initializes a basic fluent mappings for <see cref="<#=            codeClass.FullName#>" />
        /// </summary>
   public void InitializeBasicMappings()
   {
   this.MapType(map => new
   {
<#
        // iterate all properties
        var allProperties = VisualStudioHelper.GetAllCodeElementsOfType(codeClass.Members, EnvDTE.vsCMElement.vsCMElementProperty, true);
        foreach(EnvDTE.CodeProperty property in allProperties
.Where(prop=>(prop as CodeProperty2).ReadWrite == vsCMPropertyKind.vsCMPropertyKindReadWrite))
        {
            // for excluding property
            var commentForFieldValue = ((property.Name == "FieldValue" && codeClass.Name == "SystemDataField" )
|| blackListedPropertyNames.Any(propName=>propName == property.Name)
)?"//":String.Empty;
            if (IsPrimitive(property.Type) || whiteListPropertyTypes.Contains(property.Type.AsFullName))
            {
        #>
                <#=commentForFieldValue#>map.<#=property.Name #>,
<#          
            }
            #>
<#
        }
        #>
            }).ToTable("<#= codeClass.Name #>");

 // Data annotation mappings
<#
// For data annotation attribute mapping
foreach(EnvDTE.CodeProperty property in allProperties)
{
if(IsType(property.Type,typeof(bool)))
{
#>this.HasProperty(model => model.<#=property.Name#>).HasColumnType("bit");
<#
}

 foreach(var attribute in GetAttributes(property))
{
if(attribute.Name == "Required")
{
#>this.HasProperty(model => model.<#=property.Name#>).IsNotNullable();
<#
}
if(attribute.Name == "MaxLength")
{
#>this.HasProperty(model => model.<#=property.Name#>).HasColumnType("varchar").HasLength(<#=attribute.Value#>);
<#
}
if(attribute.Name == "StringLength")
{
#>this.HasProperty(model => model.<#=property.Name#>).HasColumnType("varchar").HasLength(<#=attribute.Value#>);
<#
}
}
if(whiteListPropertyTypes.Contains(property.Type.AsFullName))
{
#>this.HasProperty(model => model.<#=property.Name#>);
<#
}
if(IsNullable(property.Type))
{
#>this.HasProperty(model => model.<#=property.Name#>).IsNullable();
<#
}
}#>
}
    }
}
<#
    SaveOutput(fileName);
DeleteOldOutputs();
    }
#>

 <#+
    // Support C# and VB syntax
    private static readonly Regex _unwrapNullableRegex = new Regex(@"^System.Nullable(<|\(Of )(?<UnderlyingTypeName>.*)(>|\))$");

 private static Type[] _primitiveList;

 private static void InitializePrimitives()
{
if(_primitiveList == null)
{
var types = new[]
{
typeof (Enum),
typeof (String),
typeof (Char),

 typeof (Boolean),
typeof (Byte),
typeof (Int16),
typeof (Int32),
typeof (Int64),
typeof (Single),
typeof (Double),
typeof (Decimal),

 typeof (SByte),
typeof (UInt16),
typeof (UInt32),
typeof (UInt64),

 typeof (DateTime),
typeof (DateTimeOffset),
typeof (TimeSpan),
};
var nullTypes = from t in types
where t.IsValueType
select typeof (Nullable<>).MakeGenericType(t);

 _primitiveList = types.Concat(nullTypes).ToArray();
}
}
   /// <summary>
    /// Determines whether the supplied CodeTypeRef represents a primitive .NET type, e.g.,
    /// byte, bool, float, etc.
    /// </summary>
    public static bool IsPrimitive(CodeTypeRef codeTypeRef)
    {
InitializePrimitives();
return _primitiveList.Any(item => item.FullName == codeTypeRef.AsFullName || _unwrapNullableRegex.Match(codeTypeRef.AsFullName).Success);
    }

 public static bool IsNullable(CodeTypeRef codeTypeRef)
    {
return _unwrapNullableRegex.Match(codeTypeRef.AsFullName).Success;
    }

 public static IEnumerable<CodeAttribute> GetAttributes(CodeProperty codeProperty)
{
return codeProperty.Attributes.OfType<CodeAttribute>().ToList();
}

     public static bool IsType<T>(CodeTypeRef codeTypeRef)
    {
        return IsType(codeTypeRef , typeof(T));
    }
 
public static bool IsType(CodeTypeRef codeTypeRef, Type type)
    {
return codeTypeRef.AsFullName == type.ToString() || codeTypeRef.AsFullName == "System.Nullable<"+ type.ToString()+ ">";
    }
 #>
-----------------------------------------------------------------------------------------------



Labels:

Comments

Post a Comment

Popular posts from this blog

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...
Post a Comment
Read more

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...
Post a Comment
Read more

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...
2 comments
Read more

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...
Post a Comment
Read more

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...
Post a Comment
Read more

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 ...
Post a Comment
Read more

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...
3 comments
Read more

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 /// <...
1 comment
Read more

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...
Post a Comment
Read more

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager. As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up: [assembly: OwinStartup(typeof(MyProject.Web.Startup))] Ninject configuration Configuring Ninject kernel through method which would be used to register under Owin. Startup.cs public IKernel CreateKernel() { var kernel = new StandardKernel(); try { //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>(); // TODO: Put any other injection which are required. return kernel; } catch { kernel.Dispose(); thro...
Post a Comment
Read more