Merge pull request #32 from cake-contrib/feature/gh-31

pascalberger · web-flow · commit c80ff6252f6c · 2018-06-27T20:54:59.000+02:00
(GH-31) Add report using DevExtreme DataGrid
diff --git a/src/Cake.Issues.Reporting.Generic.Tests/GenericIssueReportGeneratorTests.cs b/src/Cake.Issues.Reporting.Generic.Tests/GenericIssueReportGeneratorTests.cs
@@ -42,6 +42,7 @@ public sealed class TheInternalCreateReportMethod
             [Theory]
             [InlineData(GenericIssueReportTemplate.HtmlDiagnostic)]
             [InlineData(GenericIssueReportTemplate.HtmlDataTable)]
+            [InlineData(GenericIssueReportTemplate.HtmlDxDataGrid)]
             public void Should_Generate_Report_From_Embedded_Template(GenericIssueReportTemplate template)
             {
                 // Given
diff --git a/src/Cake.Issues.Reporting.Generic/Cake.Issues.Reporting.Generic.csproj b/src/Cake.Issues.Reporting.Generic/Cake.Issues.Reporting.Generic.csproj
@@ -86,6 +86,7 @@
     <None Include="FodyWeavers.xml" />
     <None Include="packages.config" />
     <EmbeddedResource Include="Templates\DataTable.cshtml" />
+    <EmbeddedResource Include="Templates\DxDataGrid.cshtml" />
   </ItemGroup>
   <ItemGroup>
     <Analyzer Include="..\packages\Microsoft.CodeQuality.Analyzers.2.6.0\analyzers\dotnet\cs\Microsoft.CodeQuality.Analyzers.dll" />
diff --git a/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate.cs b/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate.cs
@@ -13,6 +13,11 @@ public enum GenericIssueReportTemplate
         /// <summary>
         /// Template for a HTML report containing a rich data table view with sorting and search functionality.
         /// </summary>
-        HtmlDataTable
+        HtmlDataTable,
+
+        /// <summary>
+        /// Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities.
+        /// </summary>
+        HtmlDxDataGrid
     }
 }
diff --git a/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplateExtensions.cs b/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplateExtensions.cs
@@ -22,6 +22,9 @@ public static string GetTemplateResourceName(this GenericIssueReportTemplate tem
                 case GenericIssueReportTemplate.HtmlDataTable:
                     return "DataTable.cshtml";
 
+                case GenericIssueReportTemplate.HtmlDxDataGrid:
+                    return "DxDataGrid.cshtml";
+
                 default:
                     throw new ArgumentOutOfRangeException(nameof(template));
             }
diff --git a/src/Cake.Issues.Reporting.Generic/Templates/DxDataGrid.cshtml b/src/Cake.Issues.Reporting.Generic/Templates/DxDataGrid.cshtml
@@ -0,0 +1,140 @@
+﻿@model IEnumerable<Cake.Issues.IIssue>
+    @using Newtonsoft.Json
+    @using Cake.Issues.Reporting.Generic
+
+    <!DOCTYPE html>
+
+    @{
+        var issues =
+            from issue in Model
+            select
+                new
+                {
+                    issue.ProviderName,
+                    issue.ProviderType,
+                    issue.Priority,
+                    issue.PriorityName,
+                    issue.Project,
+                    Path = issue.FilePath(),
+                    File = issue.FileName(),
+                    issue.Line,
+                    issue.Rule,
+                    issue.RuleUrl,
+                    issue.Message
+                };
+    }
+
+    <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
+    <head>
+        <meta charset="utf-8" />
+        <title>Issues Report</title>
+
+        @* DevExtreme dependencies *@
+        <script type="text/javascript" src="https://ajax.aspnetcdn.com/ajax/jquery/jquery-3.1.0.min.js"></script>
+        @* DevExtreme themes *@
+        <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/18.1.3/css/dx.common.css" />
+        <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/18.1.3/css/dx.light.css" />
+        @* DevExtreme library *@
+        <script type="text/javascript" src="https://cdn3.devexpress.com/jslib/18.1.3/js/dx.all.js"></script>
+    </head>
+    <body class="dx-viewport">
+        <h1>Issues Report</h1>
+
+        <div class="container">
+            <div id="gridContainer"></div>
+        </div>
+
+        <script type="text/javascript">
+        var issues = @Raw(JsonConvert.SerializeObject(issues));
+        </script>
+
+        <script type="text/javascript">
+            $(function(){
+                $("#gridContainer").dxDataGrid({
+                    dataSource: issues,
+                    loadPanel: {
+                        enabled: true
+                    },
+                    searchPanel: {
+                        visible: true
+                    },
+                    groupPanel: {
+                        visible: true
+                    },
+                    headerFilter: {
+                        visible: true
+                    },
+                    rowAlternationEnabled: true,
+                    allowColumnResizing: true,
+                    columns: [
+                        {
+                            dataField: "ProviderName",
+                            groupIndex: 0
+                        },
+                        {
+                            caption: "Severity",
+                            dataField: "PriorityName",
+                            calculateSortValue: "Priority",
+                            width: "90px",
+                            sortIndex: 0,
+                            sortOrder: "desc"
+                        },
+                        {
+                            dataField: "Project",
+                            sortIndex: 1,
+                            sortOrder: "asc"
+                        },
+                        {
+                            dataField: "Path",
+                            sortIndex: 2,
+                            sortOrder: "asc"
+                        },
+                        {
+                            dataField: "File",
+                            sortIndex: 3,
+                            sortOrder: "asc"
+                        },
+                        {
+                            dataField: "Line",
+                            allowFiltering: false,
+                            allowGrouping: false,
+                            width: "70px",
+                            sortIndex: 4,
+                            sortOrder: "asc"
+                        },
+                        {
+                            dataField: "Rule",
+                            cellTemplate: function (container, options) {
+                                if (options.data["RuleUrl"]) {
+                                    $('<a>', {
+                                        text: options.value,
+                                        href: options.data["RuleUrl"],
+                                        target: "_blank"
+                                    }).appendTo(container);
+                                }
+                                else {
+                                    container.text(options.value);
+                                }
+                            }
+                        },
+                        {
+                            dataField: "Message"
+                        }
+                    ],
+                    summary: {
+                        groupItems: [{
+                            column: "ProviderType",
+                            summaryType: "count",
+                            displayFormat: "{0} issues",
+                        }],
+                        totalItems: [{
+                            column: "Severity",
+                            summaryType: "count",
+                            displayFormat: "{0} issues"
+                        }]
+                    }
+                });
+            });
+        </script>
+    </body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ public sealed class TheInternalCreateReportMethod`
`42`	`42`	`[Theory]`
`43`	`43`	`[InlineData(GenericIssueReportTemplate.HtmlDiagnostic)]`
`44`	`44`	`[InlineData(GenericIssueReportTemplate.HtmlDataTable)]`
	`45`	`+ [InlineData(GenericIssueReportTemplate.HtmlDxDataGrid)]`
`45`	`46`	`public void Should_Generate_Report_From_Embedded_Template(GenericIssueReportTemplate template)`
`46`	`47`	`{`
`47`	`48`	`// Given`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,11 @@ public enum GenericIssueReportTemplate`
`13`	`13`	`/// <summary>`
`14`	`14`	`/// Template for a HTML report containing a rich data table view with sorting and search functionality.`
`15`	`15`	`/// </summary>`
`16`		`- HtmlDataTable`
	`16`	`+ HtmlDataTable,`
	`17`	`+`
	`18`	`+ /// <summary>`
	`19`	`+ /// Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities.`
	`20`	`+ /// </summary>`
	`21`	`+ HtmlDxDataGrid`
`17`	`22`	`}`
`18`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ public static string GetTemplateResourceName(this GenericIssueReportTemplate tem`
`22`	`22`	`case GenericIssueReportTemplate.HtmlDataTable:`
`23`	`23`	`return "DataTable.cshtml";`
`24`	`24`
	`25`	`+ case GenericIssueReportTemplate.HtmlDxDataGrid:`
	`26`	`+ return "DxDataGrid.cshtml";`
	`27`	`+`
`25`	`28`	`default:`
`26`	`29`	`throw new ArgumentOutOfRangeException(nameof(template));`
`27`	`30`	`}`