Merge pull request #38 from cake-contrib/feature/issue-extensions

pascalberger · web-flow · commit 4ecf6444b4ba · 2018-06-27T20:42:47.000+02:00
(GH-37) Add extension for returning file name and path
diff --git a/src/Cake.Issues.Reporting.Generic/Cake.Issues.Reporting.Generic.csproj b/src/Cake.Issues.Reporting.Generic/Cake.Issues.Reporting.Generic.csproj
@@ -73,6 +73,7 @@
     <Compile Include="GenericIssueReportFormatAliases.cs" />
     <Compile Include="GenericIssueReportGenerator.cs" />
     <Compile Include="GenericIssueReportFormatSettings.cs" />
+    <Compile Include="IIssueExtension.cs" />
     <Compile Include="RazorEngineReferenceResolver.cs" />
     <Compile Include="GenericIssueReportTemplate.cs" />
     <Compile Include="GenericIssueReportTemplateExtensions.cs" />
diff --git a/src/Cake.Issues.Reporting.Generic/IIssueExtension.cs b/src/Cake.Issues.Reporting.Generic/IIssueExtension.cs
@@ -0,0 +1,30 @@
+﻿namespace Cake.Issues.Reporting.Generic
+{
+    using Cake.Core.IO;
+
+    /// <summary>
+    /// Extension for <see cref="IIssue"/>.
+    /// </summary>
+    public static class IIssueExtension
+    {
+        /// <summary>
+        /// Returns the path of the <see cref="IIssue.AffectedFileRelativePath"/>.
+        /// </summary>
+        /// <param name="issue">Issue for which the path should be returned.</param>
+        /// <returns>Path of the file affected by the issue.</returns>
+        public static string FilePath(this IIssue issue)
+        {
+            return issue.AffectedFileRelativePath?.GetDirectory().FullPath;
+        }
+
+        /// <summary>
+        /// Returns the name of the file of the <see cref="IIssue.AffectedFileRelativePath"/>.
+        /// </summary>
+        /// <param name="issue">Issue for which the file name should be returned.</param>
+        /// <returns>Name of the file affected by the issue.</returns>
+        public static string FileName(this IIssue issue)
+        {
+            return issue.AffectedFileRelativePath?.GetFilename().ToString();
+        }
+    }
+}
diff --git a/src/Cake.Issues.Reporting.Generic/RazorEngineReferenceResolver.cs b/src/Cake.Issues.Reporting.Generic/RazorEngineReferenceResolver.cs
@@ -31,6 +31,7 @@ public IEnumerable<CompilerReference> GetReferences(
             yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Newtonsoft.Json.dll"));
             yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Cake.Core.dll"));
             yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Cake.Issues.dll"));
+            yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Cake.Issues.Reporting.Generic.dll"));
             yield return CompilerReference.From(typeof(RazorEngine.Engine).Assembly);
         }
 
diff --git a/src/Cake.Issues.Reporting.Generic/Templates/DataTable.cshtml b/src/Cake.Issues.Reporting.Generic/Templates/DataTable.cshtml
@@ -1,4 +1,5 @@
 ﻿@model IEnumerable<Cake.Issues.IIssue>
+@using Cake.Issues.Reporting.Generic
 
 <!DOCTYPE html>
 
@@ -77,18 +78,8 @@
                     <tr>
                         <td>@issue.PriorityName</td>
                         <td>@issue.Project</td>
-                        <td>
-                            @if (issue.AffectedFileRelativePath != null)
-                            {
-                                @issue.AffectedFileRelativePath.GetDirectory()
-                            }
-                        </td>
-                        <td>
-                            @if (issue.AffectedFileRelativePath != null)
-                            {
-                                @issue.AffectedFileRelativePath.GetFilename()
-                            }
-                        </td>
+                        <td>@issue.FilePath()</td>
+                        <td>@issue.FileName()</td>
                         <td>@issue.Line</td>
                         <td>
                             @if (issue.RuleUrl != null)

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ public IEnumerable<CompilerReference> GetReferences(`
`31`	`31`	`yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Newtonsoft.Json.dll"));`
`32`	`32`	`yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Cake.Core.dll"));`
`33`	`33`	`yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Cake.Issues.dll"));`
	`34`	`+ yield return CompilerReference.From(this.FindLoaded(loadedAssemblies, "Cake.Issues.Reporting.Generic.dll"));`
`34`	`35`	`yield return CompilerReference.From(typeof(RazorEngine.Engine).Assembly);`
`35`	`36`	`}`
`36`	`37`