=== Response Options ===

seguemark · seguemark · commit 646711148185 · 2015-08-12T17:38:26.000-04:00
Added ResponseOptions parameters to DataTablesResult method calls
Changed arrayOutput method signatures to wrap arrayOutput into ResponseOptions

=== DT_RowID ===
Added DT_RowID to ResponseOptions, allows selection of DT_RowID column in each DataTablesResult.Create call - implicitly sets ResponseOptions.ArrayOutputType to ArrayOfObjects.
Added DataTablesRowIdAttribute to set DT_RowID at the class level; also allows exclusion of the attributed property from being emitted under its normal column name
ResponseOptions.DT_RowID -overrides- DataTablesRowIdAttribute
If a class property has DataTablesRowIdAttribute and DataTablesExcludeAttribute, then DataTablesRowIdAttribute will have no effect
DataTablesRowIdAttribute and DT_RowID only affect conversion of a row to a Dictionary (via DataTablesTypeInfo.ToDictionary)
diff --git a/Mvc.JQuery.Datatables/DataTablesResult.cs b/Mvc.JQuery.Datatables/DataTablesResult.cs
@@ -20,37 +20,56 @@ public abstract class DataTablesResult : ActionResult
         /// <returns></returns>
         public static DataTablesResult<TSource> Create<TSource, TTransform>(IQueryable<TSource> q, DataTablesParam dataTableParam,
             Func<TSource, TTransform> transform, ArrayOutputType? arrayOutput = null)
+        {
+            return Create(q, dataTableParam, transform, new ResponseOptions<TSource>() { ArrayOutputType = arrayOutput });
+        }
+
+        public static DataTablesResult<TSource> Create<TSource>(IQueryable<TSource> q, DataTablesParam dataTableParam,
+            ArrayOutputType? arrayOutput = null)
+        {
+            return Create(q, dataTableParam, new ResponseOptions<TSource>() { ArrayOutputType = arrayOutput });
+        }
+
+        /// <typeparam name="TSource"></typeparam>
+        /// <typeparam name="TTransform"></typeparam>
+        /// <param name="q">A queryable for the data. The properties of this can be marked up with [DataTablesAttribute] to control sorting/searchability/visibility</param>
+        /// <param name="dataTableParam"></param>
+        /// <param name="transform">//a transform for custom column rendering e.g. to do a custom date row => new { CreatedDate = row.CreatedDate.ToString("dd MM yy") } </param>
+        /// <returns></returns>
+        public static DataTablesResult<TSource> Create<TSource, TTransform>(IQueryable<TSource> q, DataTablesParam dataTableParam,
+            Func<TSource, TTransform> transform, ResponseOptions<TSource> responseOptions = null)
         {
             var result = new DataTablesResult<TSource>(q, dataTableParam);
 
             result.Data = result.Data
                 .Transform<TSource, Dictionary<string, object>>(row => TransformTypeInfo.MergeTransformValuesIntoDictionary(transform, row))
                 .Transform<Dictionary<string, object>, Dictionary<string, object>>(StringTransformers.StringifyValues);
 
-            result.Data = ApplyOutputRules(result.Data, arrayOutput);
+            result.Data = ApplyOutputRules(result.Data, responseOptions);
 
             return result;
         }
 
         public static DataTablesResult<TSource> Create<TSource>(IQueryable<TSource> q, DataTablesParam dataTableParam,
-            ArrayOutputType? arrayOutput = null)
+            ResponseOptions<TSource> responseOptions = null)
         {
             var result = new DataTablesResult<TSource>(q, dataTableParam);
 
+            var dictionaryTransform = DataTablesTypeInfo<TSource>.ToDictionary(responseOptions);
             result.Data = result.Data
-                .Transform<TSource, Dictionary<string, object>>(DataTablesTypeInfo<TSource>.ToDictionary)
+                .Transform<TSource, Dictionary<string, object>>(dictionaryTransform)
                 .Transform<Dictionary<string, object>, Dictionary<string, object>>(StringTransformers.StringifyValues);
 
-            result.Data = ApplyOutputRules(result.Data, arrayOutput);
+            result.Data = ApplyOutputRules(result.Data, responseOptions);
 
             return result;
         }
 
-        private static DataTablesData ApplyOutputRules(DataTablesData sourceData, ArrayOutputType? arrayOutput = null)
+        private static DataTablesData ApplyOutputRules<TSource>(DataTablesData sourceData, ResponseOptions<TSource> responseOptions)
         {
             DataTablesData outputData = sourceData;
 
-            switch (arrayOutput)
+            switch (responseOptions.ArrayOutputType)
             {
                 case ArrayOutputType.ArrayOfObjects:
                     // Nothing is needed
diff --git a/Mvc.JQuery.Datatables/DataTablesRowIdAttribute.cs b/Mvc.JQuery.Datatables/DataTablesRowIdAttribute.cs
@@ -0,0 +1,25 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+using Mvc.JQuery.Datatables.Models;
+
+namespace Mvc.JQuery.Datatables
+{
+    public class DataTablesRowIdAttribute : DataTablesAttributeBase
+    {
+        public bool EmitAsColumnName { get; set; }
+
+        public override void ApplyTo(ColDef colDef, PropertyInfo pi)
+        {
+            // This attribute does not affect rendering
+        }
+
+        public DataTablesRowIdAttribute()
+        {
+            EmitAsColumnName = true;
+        }
+    }
+}
diff --git a/Mvc.JQuery.Datatables/Models/DataTablesData.cs b/Mvc.JQuery.Datatables/Models/DataTablesData.cs
@@ -11,7 +11,7 @@ public class DataTablesData
         public object[] aaData { get; set; }
 
      
-        public DataTablesData Transform<TData, TTransform>(Func<TData, TTransform> transformRow)
+        public DataTablesData Transform<TData, TTransform>(Func<TData, TTransform> transformRow, ResponseOptions responseOptions = null)
         {
             var data = new DataTablesData 
             {
diff --git a/Mvc.JQuery.Datatables/Models/ResponseOptions.cs b/Mvc.JQuery.Datatables/Models/ResponseOptions.cs
@@ -0,0 +1,54 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Mvc.JQuery.Datatables.Models
+{
+    public class ResponseOptions
+    {
+        public virtual ArrayOutputType? ArrayOutputType { get; set; }
+
+        public static ResponseOptions<TSource> For<TSource>(IQueryable<TSource> data, 
+            Action<ResponseOptions<TSource>> setOptions) where TSource : class
+        {
+            var responseOptions = new ResponseOptions<TSource>();
+            setOptions(responseOptions);
+            return responseOptions;
+        }
+    }
+
+    public class ResponseOptions<TSource> : ResponseOptions
+    {
+        public Func<TSource, object> DT_RowID
+        {
+            get
+            {
+                return dt_rowid;
+            }
+            set
+            {
+                dt_rowid = value;
+                if (value != null)
+                {
+                    ArrayOutputType = Models.ArrayOutputType.ArrayOfObjects;
+                }
+            }
+        }
+        private Func<TSource, object> dt_rowid;
+
+        public override ArrayOutputType? ArrayOutputType
+        {
+            get { return base.ArrayOutputType; }
+            set
+            {
+                if (DT_RowID != null && value != Models.ArrayOutputType.ArrayOfObjects)
+                {
+                    throw new ArgumentOutOfRangeException("ArrayOutputType", "ArrayOutputType must be ArrayOfObjects when DT_RowID is set");
+                }
+                base.ArrayOutputType = value;
+            }
+        }
+    }
+}
diff --git a/Mvc.JQuery.Datatables/Mvc.JQuery.Datatables.csproj b/Mvc.JQuery.Datatables/Mvc.JQuery.Datatables.csproj
@@ -82,6 +82,7 @@
     <Compile Include="DataTablesExcludeAttribute.cs" />
     <Compile Include="DataTablesFiltering.cs" />
     <Compile Include="DataTablesFilterAttribute.cs" />
+    <Compile Include="DataTablesRowIdAttribute.cs" />
     <Compile Include="LengthMenuVm.cs" />
     <Compile Include="Models\ArrayOutputType.cs" />
     <Compile Include="Models\ColDef.cs" />
@@ -105,6 +106,7 @@
     <Compile Include="DynamicLinq\Signature.cs" />
     <Compile Include="FilterDef.cs" />
     <Compile Include="Models\Language.cs" />
+    <Compile Include="Models\ResponseOptions.cs" />
     <Compile Include="Reflection\DataTablesPropertyInfo.cs" />
     <Compile Include="Reflection\DataTablesTypeInfo.cs" />
     <Compile Include="Reflection\DataTablesTypeInfoHelper.cs" />
diff --git a/Mvc.JQuery.Datatables/Reflection/DataTablesTypeInfo.cs b/Mvc.JQuery.Datatables/Reflection/DataTablesTypeInfo.cs
@@ -4,6 +4,7 @@
 using System.Collections.Specialized;
 using System.Linq;
 using System.Reflection;
+using Mvc.JQuery.Datatables.Models;
 
 namespace Mvc.JQuery.Datatables.Reflection
 {
@@ -27,10 +28,12 @@ orderby attributes.OfType<DataTablesAttribute>().Select(a => a.Order as int?).Si
     static class DataTablesTypeInfo<T>
     {
         internal static DataTablesPropertyInfo[] Properties { get; private set; }
+        internal static DataTablesPropertyInfo RowID { get; private set; }
 
         static DataTablesTypeInfo()
         {
             Properties = DataTablesTypeInfo.Properties(typeof (T));
+            RowID = Properties.SingleOrDefault(x => x.Attributes.Any(y => y is DataTablesRowIdAttribute));
         }
 
         public static Dictionary<string, object> ToDictionary(T row)
@@ -40,9 +43,38 @@ public static Dictionary<string, object> ToDictionary(T row)
             {
                 dictionary[pi.PropertyInfo.Name] = pi.PropertyInfo.GetValue(row, null);
             }
+            if (RowID != null)
+            {
+                dictionary["DT_RowID"] = RowID.PropertyInfo.GetValue(row, null);
+                if (!RowID.Attributes.OfType<DataTablesRowIdAttribute>().First().EmitAsColumnName)
+                {
+                    dictionary.Remove(RowID.PropertyInfo.Name);
+                }
+            }
             return dictionary;
         }
 
+        public static Func<T, Dictionary<string, object>> ToDictionary(ResponseOptions<T> options = null)
+        {
+            if (options == null || options.DT_RowID == null)
+            {
+                return ToDictionary;
+            }
+            else
+            {
+                return row =>
+                {
+                    var dictionary = new Dictionary<string, object>();
+                    dictionary["DT_RowID"] = options.DT_RowID(row);
+                    foreach (var pi in Properties)
+                    {
+                        dictionary[pi.PropertyInfo.Name] = pi.PropertyInfo.GetValue(row, null);
+                    }
+                    return dictionary;
+                };
+            }
+        }
+
         public static OrderedDictionary ToOrderedDictionary(T row)
         {
             var dictionary = new OrderedDictionary();

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public class DataTablesData`
`11`	`11`	`public object[] aaData { get; set; }`
`12`	`12`
`13`	`13`
`14`		`- public DataTablesData Transform<TData, TTransform>(Func<TData, TTransform> transformRow)`
	`14`	`+ public DataTablesData Transform<TData, TTransform>(Func<TData, TTransform> transformRow, ResponseOptions responseOptions = null)`
`15`	`15`	`{`
`16`	`16`	`var data = new DataTablesData`
`17`	`17`	`{`