Skip to content
This repository was archived by the owner on Apr 6, 2024. It is now read-only.

Commit d68bee9

Browse files
pascalbergerpascalberger
authored
Merge pull request #82 from cake-contrib/feature/gh-79
(GH-79) Rename FilePath and File to FileDirectory and FileName
2 parents 772b73a + f75e604 commit d68bee9

File tree

5 files changed

+43
-43
lines changed

5 files changed

+43
-43
lines changed

‎src/Cake.Issues.Reporting.Generic.Tests/HtmlDxDataGridTemplateTests.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ public void Should_Not_Fail_On_Report_Creation(ColumnSortOrder value)
418418
}
419419
}
420420

421-
public sealed class ThePathVisibleOption
421+
public sealed class TheFileDirectoryVisibleOption
422422
{
423423
[Theory]
424424
[InlineData(true)]
@@ -431,11 +431,11 @@ public void Should_Not_Fail_On_Report_Creation(bool value)
431431
// When / Then
432432
fixture.TestReportCreation(
433433
settings =>
434-
settings.WithOption(HtmlDxDataGridOption.PathVisible, value));
434+
settings.WithOption(HtmlDxDataGridOption.FileDirectoryVisible, value));
435435
}
436436
}
437437

438-
public sealed class ThePathSortOrderOption
438+
public sealed class TheFileDirectorySortOrderOption
439439
{
440440
[Theory]
441441
[InlineData(ColumnSortOrder.Ascending)]
@@ -448,11 +448,11 @@ public void Should_Not_Fail_On_Report_Creation(ColumnSortOrder value)
448448
// When / Then
449449
fixture.TestReportCreation(
450450
settings =>
451-
settings.WithOption(HtmlDxDataGridOption.PathSortOrder, value));
451+
settings.WithOption(HtmlDxDataGridOption.FileDirectorySortOrder, value));
452452
}
453453
}
454454

455-
public sealed class TheFileVisibleOption
455+
public sealed class TheFileNameVisibleOption
456456
{
457457
[Theory]
458458
[InlineData(true)]
@@ -465,11 +465,11 @@ public void Should_Not_Fail_On_Report_Creation(bool value)
465465
// When / Then
466466
fixture.TestReportCreation(
467467
settings =>
468-
settings.WithOption(HtmlDxDataGridOption.FileVisible, value));
468+
settings.WithOption(HtmlDxDataGridOption.FileNameVisible, value));
469469
}
470470
}
471471

472-
public sealed class TheFileSortOrderOption
472+
public sealed class TheFileNameSortOrderOption
473473
{
474474
[Theory]
475475
[InlineData(ColumnSortOrder.Ascending)]
@@ -482,7 +482,7 @@ public void Should_Not_Fail_On_Report_Creation(ColumnSortOrder value)
482482
// When / Then
483483
fixture.TestReportCreation(
484484
settings =>
485-
settings.WithOption(HtmlDxDataGridOption.FileSortOrder, value));
485+
settings.WithOption(HtmlDxDataGridOption.FileNameSortOrder, value));
486486
}
487487
}
488488

@@ -638,8 +638,8 @@ public void Should_Not_Fail_On_Report_Creation()
638638
new List<ReportColumn>
639639
{
640640
ReportColumn.ProjectName,
641-
ReportColumn.Path,
642-
ReportColumn.File
641+
ReportColumn.FileDirectory,
642+
ReportColumn.FileName
643643
}));
644644
}
645645
}

‎src/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -146,32 +146,32 @@ public enum HtmlDxDataGridOption
146146
FilePathSortOrder,
147147

148148
/// <summary>
149-
/// Flag if the <see cref="ReportColumn.Path"/> column should be visible or not.
149+
/// Flag if the <see cref="ReportColumn.FileDirectory"/> column should be visible or not.
150150
/// Either <c>true</c> or <c>false</c>.
151151
/// Default value is <c>true</c>.
152152
/// </summary>
153-
PathVisible,
153+
FileDirectoryVisible,
154154

155155
/// <summary>
156-
/// Sort order of the <see cref="ReportColumn.Path"/> column if it is part of <see cref="SortedColumns"/>.
156+
/// Sort order of the <see cref="ReportColumn.FileDirectory"/> column if it is part of <see cref="SortedColumns"/>.
157157
/// See <see cref="ColumnSortOrder"/> for possible values.
158158
/// Default value is <see cref="ColumnSortOrder.Ascending"/>.
159159
/// </summary>
160-
PathSortOrder,
160+
FileDirectorySortOrder,
161161

162162
/// <summary>
163-
/// Flag if the <see cref="ReportColumn.File"/> column should be visible or not.
163+
/// Flag if the <see cref="ReportColumn.FileName"/> column should be visible or not.
164164
/// Either <c>true</c> or <c>false</c>.
165165
/// Default value is <c>true</c>.
166166
/// </summary>
167-
FileVisible,
167+
FileNameVisible,
168168

169169
/// <summary>
170-
/// Sort order of the <see cref="ReportColumn.File"/> column if it is part of <see cref="SortedColumns"/>.
170+
/// Sort order of the <see cref="ReportColumn.FileName"/> column if it is part of <see cref="SortedColumns"/>.
171171
/// See <see cref="ColumnSortOrder"/> for possible values.
172172
/// Default value is <see cref="ColumnSortOrder.Ascending"/>.
173173
/// </summary>
174-
FileSortOrder,
174+
FileNameSortOrder,
175175

176176
/// <summary>
177177
/// Flag if the <see cref="ReportColumn.Line"/> column should be visible or not.
@@ -239,7 +239,7 @@ public enum HtmlDxDataGridOption
239239
/// <summary>
240240
/// List of <see cref="ReportColumn"/> which should be sorted.
241241
/// Default value is <see cref="ReportColumn.PriorityName"/>, <see cref="ReportColumn.ProjectName"/>,
242-
/// <see cref="ReportColumn.Path"/>, <see cref="ReportColumn.File"/>, <see cref="ReportColumn.Line"/>.
242+
/// <see cref="ReportColumn.FileDirectory"/>, <see cref="ReportColumn.FileName"/>, <see cref="ReportColumn.Line"/>.
243243
/// </summary>
244244
SortedColumns,
245245

‎src/Cake.Issues.Reporting.Generic/ReportColumn.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ public enum ReportColumn
4444
/// <summary>
4545
/// Column for the value returned by <see cref="IIssueExtension.FilePath(IIssue)"/>.
4646
/// </summary>
47-
Path = 800,
47+
FileDirectory = 800,
4848

4949
/// <summary>
5050
/// Column for the value returned by <see cref="IIssueExtension.FileName(IIssue)"/>.
5151
/// </summary>
52-
File = 900,
52+
FileName = 900,
5353

5454
/// <summary>
5555
/// Column for the <see cref="IIssue.Line"/> field.

‎src/Cake.Issues.Reporting.Generic/Templates/DataTable.cshtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
<tr>
6666
<th scope="col">Severity</th>
6767
<th scope="col">Project</th>
68-
<th scope="col">Path</th>
68+
<th scope="col">Directory</th>
6969
<th scope="col">File</th>
7070
<th scope="col">Line</th>
7171
<th scope="col">Rule</th>

‎src/Cake.Issues.Reporting.Generic/Templates/DxDataGrid.cshtml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727
ColumnSortOrder projectNameSortOrder = ViewBagHelper.ValueOrDefault(ViewBag.ProjectNameSortOder, ColumnSortOrder.Ascending);
2828
bool filePathVisible = ViewBagHelper.ValueOrDefault(ViewBag.FilePathVisible, false);
2929
ColumnSortOrder filePathSortOrder = ViewBagHelper.ValueOrDefault(ViewBag.FilePathSortOder, ColumnSortOrder.Ascending);
30-
bool pathVisible = ViewBagHelper.ValueOrDefault(ViewBag.PathVisible, true);
31-
ColumnSortOrder pathSortOrder = ViewBagHelper.ValueOrDefault(ViewBag.PathSortOder, ColumnSortOrder.Ascending);
32-
bool fileVisible = ViewBagHelper.ValueOrDefault(ViewBag.FileVisible, true);
33-
ColumnSortOrder fileSortOrder = ViewBagHelper.ValueOrDefault(ViewBag.FileSortOder, ColumnSortOrder.Ascending);
30+
bool fileDirectoryVisible = ViewBagHelper.ValueOrDefault(ViewBag.FileDirectoryVisible, true);
31+
ColumnSortOrder fileDirectorySortOrder = ViewBagHelper.ValueOrDefault(ViewBag.FileDirectorySortOder, ColumnSortOrder.Ascending);
32+
bool fileNameVisible = ViewBagHelper.ValueOrDefault(ViewBag.FileNameVisible, true);
33+
ColumnSortOrder fileNameSortOrder = ViewBagHelper.ValueOrDefault(ViewBag.FileNameSortOder, ColumnSortOrder.Ascending);
3434
bool lineVisible = ViewBagHelper.ValueOrDefault(ViewBag.LineVisible, true);
3535
ColumnSortOrder lineSortOrder = ViewBagHelper.ValueOrDefault(ViewBag.LineSortOder, ColumnSortOrder.Ascending);
3636
bool ruleVisible = ViewBagHelper.ValueOrDefault(ViewBag.RuleVisible, true);
@@ -40,7 +40,7 @@
4040
bool messageVisible = ViewBagHelper.ValueOrDefault(ViewBag.MessageVisible, true);
4141
ColumnSortOrder messageSortOrder = ViewBagHelper.ValueOrDefault(ViewBag.MessageSortOder, ColumnSortOrder.Ascending);
4242
var groupedColumns = ViewBagHelper.ValueOrDefault(ViewBag.GroupedColumns, new List<ReportColumn> { ReportColumn.ProviderName });
43-
var sortedColumns = ViewBagHelper.ValueOrDefault(ViewBag.SortedColumns, new List<ReportColumn> { ReportColumn.PriorityName, ReportColumn.ProjectName, ReportColumn.Path, ReportColumn.File, ReportColumn.Line });
43+
var sortedColumns = ViewBagHelper.ValueOrDefault(ViewBag.SortedColumns, new List<ReportColumn> { ReportColumn.PriorityName, ReportColumn.ProjectName, ReportColumn.FileDirectory, ReportColumn.FileName, ReportColumn.Line });
4444
FileLinkSettings fileLinkSettings = ViewBagHelper.ValueOrDefault(ViewBag.FileLinkSettings, new FileLinkSettings());
4545
List<HtmlDxDataGridColumnDescription> additionalColumns = ViewBagHelper.ValueOrDefault(ViewBag.AdditionalColumns, new List<HtmlDxDataGridColumnDescription>());
4646
}
@@ -58,8 +58,8 @@
5858
addProjectPath: projectPathVisible,
5959
addProjectName: projectNameVisible,
6060
addFilePath: filePathVisible,
61-
addFileDirectory: pathVisible,
62-
addFileName: fileVisible,
61+
addFileDirectory: fileDirectoryVisible,
62+
addFileName: fileNameVisible,
6363
addLine: lineVisible,
6464
addRule: ruleVisible,
6565
addRuleUrl: ruleVisible || ruleUrlVisible,
@@ -246,40 +246,40 @@
246246
},
247247
</text>
248248
}
249-
@if (pathVisible)
249+
@if (fileDirectoryVisible)
250250
{
251251
<text>
252252
{
253253
caption: "Directory",
254254
dataField: "FileDirectory",
255-
visibleIndex: @((int)ReportColumn.Path),
256-
@if (groupedColumns.Contains(ReportColumn.Path))
255+
visibleIndex: @((int)ReportColumn.FileDirectory),
256+
@if (groupedColumns.Contains(ReportColumn.FileDirectory))
257257
{
258-
@:groupIndex: @groupedColumns.IndexOf(ReportColumn.Path),
258+
@:groupIndex: @groupedColumns.IndexOf(ReportColumn.FileDirectory),
259259
}
260-
@if (sortedColumns.Contains(ReportColumn.Path))
260+
@if (sortedColumns.Contains(ReportColumn.FileDirectory))
261261
{
262-
@:sortIndex: @sortedColumns.IndexOf(ReportColumn.Path),
263-
@:sortOrder: "@pathSortOrder.ToShortString()",
262+
@:sortIndex: @sortedColumns.IndexOf(ReportColumn.FileDirectory),
263+
@:sortOrder: "@fileDirectorySortOrder.ToShortString()",
264264
}
265265
},
266266
</text>
267267
}
268-
@if (fileVisible)
268+
@if (fileNameVisible)
269269
{
270270
<text>
271271
{
272272
caption: "File",
273273
dataField: "FileName",
274-
visibleIndex: @((int)ReportColumn.File),
275-
@if (groupedColumns.Contains(ReportColumn.File))
274+
visibleIndex: @((int)ReportColumn.FileName),
275+
@if (groupedColumns.Contains(ReportColumn.FileName))
276276
{
277-
@:groupIndex: @groupedColumns.IndexOf(ReportColumn.File),
277+
@:groupIndex: @groupedColumns.IndexOf(ReportColumn.FileName),
278278
}
279-
@if (sortedColumns.Contains(ReportColumn.File))
279+
@if (sortedColumns.Contains(ReportColumn.FileName))
280280
{
281-
@:sortIndex: @sortedColumns.IndexOf(ReportColumn.File),
282-
@:sortOrder: "@fileSortOrder.ToShortString()",
281+
@:sortIndex: @sortedColumns.IndexOf(ReportColumn.FileName),
282+
@:sortOrder: "@fileNameSortOrder.ToShortString()",
283283
}
284284
@if (fileLinkSettings != null && !string.IsNullOrWhiteSpace(fileLinkSettings.FileLinkPattern))
285285
{

0 commit comments

Comments
 (0)