(GH-34) Add report using DevExtreme PivotGrid

Author: pascalberger

src/Cake.Issues.Reporting.Generic.Tests/Cake.Issues.Reporting.Generic.Tests.csproj

@@ -83,6 +83,7 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="HtmlDxPivotGridAreaExtensionsTests.cs" />
     <Compile Include="ColumnSortOrderExtensionsTests.cs" />
     <Compile Include="DevExtremeThemeExtensionsTests.cs" />
     <Compile Include="ExceptionAssertExtensions.cs" />

src/Cake.Issues.Reporting.Generic.Tests/GenericIssueReportGeneratorTests.cs

@@ -43,6 +43,7 @@ public sealed class TheInternalCreateReportMethod
             [InlineData(GenericIssueReportTemplate.HtmlDiagnostic)]
             [InlineData(GenericIssueReportTemplate.HtmlDataTable)]
             [InlineData(GenericIssueReportTemplate.HtmlDxDataGrid)]
+            [InlineData(GenericIssueReportTemplate.HtmlDxPivotGrid)]
             public void Should_Generate_Report_From_Embedded_Template(GenericIssueReportTemplate template)
             {
                 // Given

src/Cake.Issues.Reporting.Generic.Tests/HtmlDxPivotGridAreaExtensionsTests.cs

@@ -0,0 +1,27 @@
+namespace Cake.Issues.Reporting.Generic.Tests
+{
+    using Shouldly;
+    using Xunit;
+
+    public sealed class HtmlDxPivotGridAreaExtensionsTests
+    {
+        public sealed class TheToJavaScriptIdentifierMethod
+        {
+            [Theory]
+            [InlineData(HtmlDxPivotGridArea.Column)]
+            [InlineData(HtmlDxPivotGridArea.Row)]
+            [InlineData(HtmlDxPivotGridArea.Filter)]
+            [InlineData(HtmlDxPivotGridArea.Data)]
+            public void Should_Return_Identifier(HtmlDxPivotGridArea area)
+            {
+                // Given
+
+                // When
+                var result = area.ToJavaScriptIdentifier();
+
+                // Then
+                result.ShouldNotBeNullOrWhiteSpace();
+            }
+        }
+    }
+}

src/Cake.Issues.Reporting.Generic/Cake.Issues.Reporting.Generic.csproj

@@ -68,11 +68,14 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="ColumnSortOrder.cs" />
+    <Compile Include="HtmlDxPivotGridAreaExtensions.cs" />
     <Compile Include="ColumnSortOrderExtensions.cs" />
     <Compile Include="DevExtremeTheme.cs" />
     <Compile Include="DevExtremeThemeExtensions.cs" />
     <Compile Include="FileLinkSettings.cs" />
     <Compile Include="HtmlDxDataGridColumnDescription.cs" />
+    <Compile Include="HtmlDxPivotGridArea.cs" />
+    <Compile Include="HtmlDxPivotGridOption.cs" />
     <Compile Include="HtmlDxDataGridOption.cs" />
     <Compile Include="GenericIssueReportFormatAliases.cs" />
     <Compile Include="GenericIssueReportFormatSettingsExtensions.cs" />
@@ -96,6 +99,7 @@
     </None>
     <EmbeddedResource Include="Templates\DataTable.cshtml" />
     <EmbeddedResource Include="Templates\DxDataGrid.cshtml" />
+    <EmbeddedResource Include="Templates\DxPivotGrid.cshtml" />
   </ItemGroup>
   <ItemGroup>
     <Analyzer Include="..\packages\Microsoft.CodeQuality.Analyzers.2.6.3\analyzers\dotnet\cs\Humanizer.dll" />

src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate.cs

@@ -19,6 +19,12 @@ public enum GenericIssueReportTemplate
         /// Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities.
         /// See <see cref="HtmlDxDataGridOption"/> for template specific options.
         /// </summary>
-        HtmlDxDataGrid
+        HtmlDxDataGrid,
+
+        /// <summary>
+        /// Template for a HTML report containing a pivot grid showing number of errors, warnings, suggestions and hints,
+        /// with a detail drill down view and an overview chart.
+        /// </summary>
+        HtmlDxPivotGrid
     }
 }

src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplateExtensions.cs

@@ -25,6 +25,9 @@ public static string GetTemplateResourceName(this GenericIssueReportTemplate tem
                 case GenericIssueReportTemplate.HtmlDxDataGrid:
                     return "DxDataGrid.cshtml";
 
+                case GenericIssueReportTemplate.HtmlDxPivotGrid:
+                    return "DxPivotGrid.cshtml";
+
                 default:
                     throw new ArgumentOutOfRangeException(nameof(template));
             }

src/Cake.Issues.Reporting.Generic/HtmlDxPivotGridArea.cs

@@ -0,0 +1,28 @@
+namespace Cake.Issues.Reporting.Generic
+{
+    /// <summary>
+    /// Possible areas for fields.
+    /// </summary>
+    public enum HtmlDxPivotGridArea
+    {
+        /// <summary>
+        /// Field will be shown as row.
+        /// </summary>
+        Row,
+
+        /// <summary>
+        /// Field will be shown as column.
+        /// </summary>
+        Column,
+
+        /// <summary>
+        /// Field will be shown as data.
+        /// </summary>
+        Data,
+
+        /// <summary>
+        /// Field will be available to filter.
+        /// </summary>
+        Filter
+    }
+}

src/Cake.Issues.Reporting.Generic/HtmlDxPivotGridAreaExtensions.cs

@@ -0,0 +1,32 @@
+namespace Cake.Issues.Reporting.Generic
+{
+    using System;
+
+    /// <summary>
+    /// Extension methods for the <see cref="HtmlDxPivotGridArea"/> enumeration.
+    /// </summary>
+    public static class HtmlDxPivotGridAreaExtensions
+    {
+        /// <summary>
+        /// Returns the short identifier of the pivot grid area.
+        /// </summary>
+        /// <param name="area">Area for which the identifier should be returned.</param>
+        /// <returns>Short identifier of the area.</returns>
+        public static string ToJavaScriptIdentifier(this HtmlDxPivotGridArea area)
+        {
+            switch (area)
+            {
+                case HtmlDxPivotGridArea.Row:
+                    return "row";
+                case HtmlDxPivotGridArea.Column:
+                    return "column";
+                case HtmlDxPivotGridArea.Data:
+                    return "data";
+                case HtmlDxPivotGridArea.Filter:
+                    return "filter";
+                default:
+                    throw new ArgumentException("Unknown enumeration value", nameof(area));
+            }
+        }
+    }
+}