Merge branch 'release/0.4.1'

Author: pascalberger

nuspec/nuget/Cake.Issues.Reporting.Generic.nuspec

@@ -21,7 +21,7 @@ See the Project Site for an overview of the whole ecosystem of addins for workin
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <copyright>Copyright © Pascal Berger</copyright>
     <tags>Cake Script Cake-Issues Cake-ReportFormat Issues Reporting Html Markdown</tags>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/0.4.0</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/0.4.1</releaseNotes>
   </metadata>
   <files>
     <file src="Cake.Issues.Reporting.Generic.dll" target="lib\net46" />

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

@@ -85,6 +85,7 @@
   <ItemGroup>
     <Compile Include="ColumnSortOrderExtensionsTests.cs" />
     <Compile Include="DevExtremeThemeExtensionsTests.cs" />
+    <Compile Include="IIssueExtensionTests.cs" />
     <Compile Include="UriExtensionsTests.cs" />
     <Compile Include="FileLinkSettingsTests.cs" />
     <Compile Include="GenericIssueReportFixture.cs" />

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

@@ -0,0 +1,209 @@
+namespace Cake.Issues.Reporting.Generic.Tests
+{
+    using Cake.Issues.Testing;
+    using Shouldly;
+    using Xunit;
+
+    public sealed class IIssueExtensionTests
+    {
+        public sealed class TheProjectPathExtension
+        {
+            [Fact]
+            public void Should_Throw_If_Issue_Is_Null()
+            {
+                // Given
+                IIssue issue = null;
+
+                // When
+                var result = Record.Exception(() => issue.ProjectPath());
+
+                // Then
+                result.IsArgumentNullException("issue");
+            }
+
+            [Fact]
+            public void Should_Return_Full_Path()
+            {
+                // Given
+                var projectPath = @"src\Cake.Issues.Reporting.Generic.Tests\Cake.Issues.Reporting.Generic.Tests.csproj";
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .InProjectFile(projectPath)
+                        .Create();
+
+                // When
+                var result = issue.ProjectPath();
+
+                // Then
+                result.ShouldBe(@"src/Cake.Issues.Reporting.Generic.Tests/Cake.Issues.Reporting.Generic.Tests.csproj");
+            }
+
+            [Fact]
+            public void Should_Return_Null_If_Project_Is_Not_Set()
+            {
+                // Given
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .Create();
+
+                // When
+                var result = issue.ProjectPath();
+
+                // Then
+                result.ShouldBeNull();
+            }
+        }
+
+        public sealed class TheFilePathExtension
+        {
+            [Fact]
+            public void Should_Throw_If_Issue_Is_Null()
+            {
+                // Given
+                IIssue issue = null;
+
+                // When
+                var result = Record.Exception(() => issue.FilePath());
+
+                // Then
+                result.IsArgumentNullException("issue");
+            }
+
+            [Fact]
+            public void Should_Return_Full_Path()
+            {
+                // Given
+                var filePath = @"src\Cake.Issues.Reporting.Generic.Tests\Foo.cs";
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .InFile(filePath)
+                        .Create();
+
+                // When
+                var result = issue.FilePath();
+
+                // Then
+                result.ShouldBe(@"src/Cake.Issues.Reporting.Generic.Tests/Foo.cs");
+            }
+
+            [Fact]
+            public void Should_Return_Null_If_File_Is_Not_Set()
+            {
+                // Given
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .Create();
+
+                // When
+                var result = issue.FilePath();
+
+                // Then
+                result.ShouldBeNull();
+            }
+        }
+
+        public sealed class TheFileDirectoryExtension
+        {
+            [Fact]
+            public void Should_Throw_If_Issue_Is_Null()
+            {
+                // Given
+                IIssue issue = null;
+
+                // When
+                var result = Record.Exception(() => issue.FileDirectory());
+
+                // Then
+                result.IsArgumentNullException("issue");
+            }
+
+            [Fact]
+            public void Should_Return_Full_Path()
+            {
+                // Given
+                var filePath = @"src\Cake.Issues.Reporting.Generic.Tests\Foo.cs";
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .InFile(filePath)
+                        .Create();
+
+                // When
+                var result = issue.FileDirectory();
+
+                // Then
+                result.ShouldBe(@"src/Cake.Issues.Reporting.Generic.Tests");
+            }
+
+            [Fact]
+            public void Should_Return_Null_If_File_Is_Not_Set()
+            {
+                // Given
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .Create();
+
+                // When
+                var result = issue.FileDirectory();
+
+                // Then
+                result.ShouldBeNull();
+            }
+        }
+
+        public sealed class TheFileNameExtension
+        {
+            [Fact]
+            public void Should_Throw_If_Issue_Is_Null()
+            {
+                // Given
+                IIssue issue = null;
+
+                // When
+                var result = Record.Exception(() => issue.FileName());
+
+                // Then
+                result.IsArgumentNullException("issue");
+            }
+
+            [Fact]
+            public void Should_Return_Full_Path()
+            {
+                // Given
+                var filePath = @"src\Cake.Issues.Reporting.Generic.Tests\Foo.cs";
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .InFile(filePath)
+                        .Create();
+
+                // When
+                var result = issue.FileName();
+
+                // Then
+                result.ShouldBe("Foo.cs");
+            }
+
+            [Fact]
+            public void Should_Return_Null_If_File_Is_Not_Set()
+            {
+                // Given
+                var issue =
+                    IssueBuilder
+                        .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                        .Create();
+
+                // When
+                var result = issue.FileName();
+
+                // Then
+                result.ShouldBeNull();
+            }
+        }
+    }
+}

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

@@ -70,7 +70,6 @@
     <Compile Include="ColumnSortOrderExtensions.cs" />
     <Compile Include="DevExtremeTheme.cs" />
     <Compile Include="DevExtremeThemeExtensions.cs" />
-    <Compile Include="FileLinkType.cs" />
     <Compile Include="FileLinkSettings.cs" />
     <Compile Include="HtmlDxDataGridOption.cs" />
     <Compile Include="GenericIssueReportFormatAliases.cs" />

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

@@ -87,10 +87,10 @@ public string GetFileLink(IIssue issue)
                     .Replace("{ProviderName}", issue.ProviderName)
                     .Replace("{Priority}", issue.Priority?.ToString())
                     .Replace("{PriorityName}", issue.PriorityName)
-                    .Replace("{ProjectPath}", issue.ProjectFileRelativePath?.FullPath.ToString())
+                    .Replace("{ProjectPath}", issue.ProjectPath())
                     .Replace("{PojectName}", issue.ProjectName)
-                    .Replace("{FilePath}", issue.AffectedFileRelativePath?.FullPath.ToString())
-                    .Replace("{Path}", issue.FilePath())
+                    .Replace("{FilePath}", issue.FilePath())
+                    .Replace("{Path}", issue.FileDirectory())
                     .Replace("{File}", issue.FileName())
                     .Replace("{Line}", issue.Line?.ToString())
                     .Replace("{Rule}", issue.Rule)

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

@@ -47,6 +47,20 @@ public enum HtmlDxDataGridOption
         /// </summary>
         EnableFiltering,
 
+        /// <summary>
+        /// Flag if the <see cref="ReportColumn.ProviderType"/> column should be visible or not.
+        /// Either <c>true</c> or <c>false</c>.
+        /// Default value is <c>false</c>.
+        /// </summary>
+        ProviderTypeVisible,
+
+        /// <summary>
+        /// Sort order of the <see cref="ReportColumn.ProviderType"/> column if it is part of <see cref="SortedColumns"/>.
+        /// See <see cref="ColumnSortOrder"/> for possible values.
+        /// Default value is <see cref="ColumnSortOrder.Ascending"/>.
+        /// </summary>
+        ProviderTypeSortOrder,
+
         /// <summary>
         /// Flag if the <see cref="ReportColumn.ProviderName"/> column should be visible or not.
         /// Either <c>true</c> or <c>false</c>.
@@ -61,6 +75,20 @@ public enum HtmlDxDataGridOption
         /// </summary>
         ProviderNameSortOrder,
 
+        /// <summary>
+        /// Flag if the <see cref="ReportColumn.Priority"/> column should be visible or not.
+        /// Either <c>true</c> or <c>false</c>.
+        /// Default value is <c>false</c>.
+        /// </summary>
+        PriorityVisible,
+
+        /// <summary>
+        /// Sort order of the <see cref="ReportColumn.Priority"/> column if it is part of <see cref="SortedColumns"/>.
+        /// See <see cref="ColumnSortOrder"/> for possible values.
+        /// Default value is <see cref="ColumnSortOrder.Descending"/>.
+        /// </summary>
+        PrioritySortOrder,
+
         /// <summary>
         /// Flag if the <see cref="ReportColumn.PriorityName"/> column should be visible or not.
         /// Either <c>true</c> or <c>false</c>.
@@ -75,6 +103,20 @@ public enum HtmlDxDataGridOption
         /// </summary>
         PriorityNameSortOrder,
 
+        /// <summary>
+        /// Flag if the <see cref="ReportColumn.ProjectPath"/> column should be visible or not.
+        /// Either <c>true</c> or <c>false</c>.
+        /// Default value is <c>false</c>.
+        /// </summary>
+        ProjectPathVisible,
+
+        /// <summary>
+        /// Sort order of the <see cref="ReportColumn.ProjectPath"/> column if it is part of <see cref="SortedColumns"/>.
+        /// See <see cref="ColumnSortOrder"/> for possible values.
+        /// Default value is <see cref="ColumnSortOrder.Ascending"/>.
+        /// </summary>
+        ProjectPathSortOrder,
+
         /// <summary>
         /// Flag if the <see cref="ReportColumn.ProjectName"/> column should be visible or not.
         /// Either <c>true</c> or <c>false</c>.
@@ -89,6 +131,20 @@ public enum HtmlDxDataGridOption
         /// </summary>
         ProjectNameSortOrder,
 
+        /// <summary>
+        /// Flag if the <see cref="ReportColumn.FilePath"/> column should be visible or not.
+        /// Either <c>true</c> or <c>false</c>.
+        /// Default value is <c>false</c>.
+        /// </summary>
+        FilePathVisible,
+
+        /// <summary>
+        /// Sort order of the <see cref="ReportColumn.FilePath"/> column if it is part of <see cref="SortedColumns"/>.
+        /// See <see cref="ColumnSortOrder"/> for possible values.
+        /// Default value is <see cref="ColumnSortOrder.Ascending"/>.
+        /// </summary>
+        FilePathSortOrder,
+
         /// <summary>
         /// Flag if the <see cref="ReportColumn.Path"/> column should be visible or not.
         /// Either <c>true</c> or <c>false</c>.
@@ -145,6 +201,20 @@ public enum HtmlDxDataGridOption
         /// </summary>
         RuleSortOrder,
 
+        /// <summary>
+        /// Flag if the <see cref="ReportColumn.RuleUrl"/> column should be visible or not.
+        /// Either <c>true</c> or <c>false</c>.
+        /// Default value is <c>false</c>.
+        /// </summary>
+        RuleUrlVisible,
+
+        /// <summary>
+        /// Sort order of the <see cref="ReportColumn.RuleUrl"/> column if it is part of <see cref="SortedColumns"/>.
+        /// See <see cref="ColumnSortOrder"/> for possible values.
+        /// Default value is <see cref="ColumnSortOrder.Ascending"/>.
+        /// </summary>
+        RuleUrlSortOrder,
+
         /// <summary>
         /// Flag if the <see cref="ReportColumn.Message"/> column should be visible or not.
         /// Either <c>true</c> or <c>false</c>.