Skip to content

Commit 13fc156

Browse files
tonyhalletttonyhallett
committed
completed
1 parent 6059bf2 commit 13fc156

File tree

7 files changed

+91
-37
lines changed

7 files changed

+91
-37
lines changed

‎FineCodeCoverageTests/AppOptionsProvider_Tests.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,7 @@ internal void Should_Use_Deseralized_String_From_Store_For_AppOption_Property(Fu
317317
{ nameof(IAppOptions.ShowToolWindowToolbar),true},
318318
{nameof(IAppOptions.ExcludeAssemblies),new string[]{ "Exclude"} },
319319
{nameof(IAppOptions.IncludeAssemblies),new string[]{ "Include"} },
320+
{nameof(IAppOptions.NamespaceQualification),NamespaceQualification.AlwaysUnqualified }
320321
};
321322
var mockJsonConvertService = autoMocker.GetMock<IJsonConvertService>();
322323
mockJsonConvertService.Setup(

‎FineCodeCoverageTests/MsCodeCoverage/RunSettingsTemplateReplacementsFactory_Tests.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -701,5 +701,6 @@ internal class TestCoverageProjectOptions : IAppOptions
701701
public string[] ExcludeAssemblies { get; set; }
702702
public string[] IncludeAssemblies { get; set; }
703703
public bool DisabledNoCoverage { get; set; }
704+
public NamespaceQualification NamespaceQualification { get; set; }
704705
}
705706
}

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,8 @@ If you are using option 1) then project and global options will only be used whe
241241
|ToolsDirectory|Folder to which copy tools subfolder. Must alredy exist. Requires restart of VS.|
242242
|ThresholdForCyclomaticComplexity| When [cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) exceeds this value for a method then the method will be present in the risk hotspots tab. |
243243
|StickyCoverageTable|Set to true for coverage table to have a sticky thead.|
244-
|NamespacedClasses|Set to false to show classes in report in short form. Affects grouping.|
244+
|NamespacedClasses|Set to false to show types in report in short form. Affects grouping.|
245+
|NamespaceQualification|Control qualification of types in report when NamespacedClasses is true.<br>FullyQualified - always fully qualify.<br>AlwaysUnqualified - always unqualified.<br>UnqualifiedByNamespace - unqualified when grouping by namespace.<br>QualifiedByNamespaceLevel - omits the first grouping level identifier parts. Reduces space whilst maintaining uniqueness.|
245246
|HideFullyCovered|Set to true to hide classes, namespaces and assemblies that are fully covered.|
246247
|Hide0Coverage|Set to true to hide classes, namespaces and assemblies that have 0% coverage.|
247248
|Hide0Coverable|Set to false to show classes, namespaces and assemblies that are not coverable.|

‎SharedProject/Core/ReportGenerator/ReportGeneratorUtil.cs‎

Lines changed: 83 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ async Task run(string outputReportType, string inputReports)
170170
reportTypeSettings.Add($@"""-reports:{inputReports}""");
171171
reportTypeSettings.Add($@"""-plugins:{typeof(FccLightReportBuilder).Assembly.Location}""");
172172
reportTypeSettings.Add($@"""-reporttypes:{FccLightReportBuilder.REPORT_TYPE}""");
173-
var (cyclomaticThreshold, crapScoreThreshold, nPathThreshold) = HotspotThresholds();
173+
var (cyclomaticThreshold, crapScoreThreshold, nPathThreshold) = HotspotThresholds(appOptionsProvider.Get());
174174
175175
reportTypeSettings.Add($@"""riskHotspotsAnalysisThresholds:metricThresholdForCyclomaticComplexity={cyclomaticThreshold}""");
176176
reportTypeSettings.Add($@"""riskHotspotsAnalysisThresholds:metricThresholdForCrapScore={crapScoreThreshold}""");
@@ -337,9 +337,9 @@ Alternative is lighten / darken the background color
337337
style.InnerHtml = changedCss;
338338
}
339339
340-
private string GetStickyTableHead()
340+
private string GetStickyTableHead(IAppOptions appOptions)
341341
{
342-
if (!appOptionsProvider.Get().StickyCoverageTable)
342+
if (!appOptions.StickyCoverageTable)
343343
{
344344
return "";
345345
}
@@ -829,9 +829,40 @@ private string HideGroupingCss()
829829
";
830830
}
831831
832-
private string ObserveAndHideFullyCovered()
832+
private string CoverageInfoObserver()
833+
{
834+
var code = @"
835+
var coverageInfoObserver = (function(){
836+
var mutationObserver;
837+
var callbacks = [];
838+
function observe(){
839+
mutationObserver.observe(
840+
document.querySelector(""coverage-info""),
841+
{ attributes: false, childList: true, subtree: true }
842+
)
843+
}
844+
function cb(record,obs){
845+
mutationObserver.disconnect();
846+
for(var i=0;i<callbacks.length;i++){
847+
callbacks[i]();
848+
}
849+
observe();
850+
}
851+
return {
852+
observe:function(callback){
853+
callbacks.push(callback);
854+
if(!mutationObserver){
855+
mutationObserver = new MutationObserver(cb);
856+
observe();
857+
}
858+
}
859+
}
860+
})();
861+
";
862+
return code;
863+
}
864+
private string ObserveAndHideFullyCovered(IAppOptions appOptions)
833865
{
834-
var appOptions = appOptionsProvider.Get();
835866
if (!(appOptions.HideFullyCovered | appOptions.Hide0Coverage | appOptions.Hide0Coverable))
836867
{
837868
return "";
@@ -840,12 +871,9 @@ private string ObserveAndHideFullyCovered()
840871
function getCellValue(row, index){{
841872
return parseInt(row.cells[index].innerText);
842873
}}
843-
var targetNode = document;
844874
845-
var config = {{ attributes: false, childList: true, subtree: true }};
846875
847-
var callback = function(mutationsList, observer) {{
848-
console.log(""mutation observer hide fully covered"");
876+
var hideCoverage = function() {{
849877
var rows = document.querySelectorAll(""coverage-info table tbody tr"");
850878
for(var i=0;i<rows.length;i++){{
851879
var row = rows[i];
@@ -879,41 +907,64 @@ function getCellValue(row, index){{
879907
880908
}};
881909
}};
882-
883-
var observer = new MutationObserver(callback);
884-
observer.observe(targetNode, config);
910+
hideCoverage();
911+
coverageInfoObserver.observe(hideCoverage);
885912
";
886913
return code;
887914
}
888915
889-
private string ObserveAndHideNamespaceWhenGroupingByNamespace()
916+
private string ObserveAndHideNamespaceWhenGroupingByNamespace(IAppOptions appOptions)
890917
{
918+
919+
if (!appOptions.NamespacedClasses || appOptions.NamespaceQualification == NamespaceQualification.FullyQualified)
920+
{
921+
return "";
922+
}
923+
var fullyQualifiedToName = "";
924+
switch(appOptions.NamespaceQualification)
925+
{
926+
case NamespaceQualification.AlwaysUnqualified:
927+
case NamespaceQualification.UnqualifiedByNamespace:
928+
fullyQualifiedToName = "var name = fullyQualified.substring(fullyQualified.lastIndexOf(\".\") + 1);";
929+
break;
930+
case NamespaceQualification.QualifiedByNamespaceLevel:
931+
fullyQualifiedToName = @"
932+
var parts = fullyQualified.split(""."");
933+
var namespaceParts = parts.slice(0,parts.length-1);
934+
var type = parts[parts.length-1];
935+
var name = type;
936+
if(namespaceParts.length > groupingLevel){
937+
name = namespaceParts.slice(groupingLevel).join(""."") + ""."" + type;
938+
}";
939+
break;
940+
default:
941+
throw new Exception($"Unknown GroupingNamespaceQualification '{appOptions.NamespaceQualification}'");
942+
}
943+
var alwaysUnqualified = appOptions.NamespaceQualification == NamespaceQualification.AlwaysUnqualified;
891944
var code = $@"
892-
var targetNode = document;
893-
894945
var config = {{ attributes: false, childList: true, subtree: true }};
895946
896-
var callback = function(mutationsList, observer) {{
947+
var changeQualification = function() {{
897948
var groupingInput = document.querySelector(""coverage-info .customizebox input"");
898-
if(!groupingInput || groupingInput.value == 0){{
949+
if(!groupingInput || groupingInput.value <= 0 && !{alwaysUnqualified.ToString().ToLower()}){{
899950
return;
900951
}}
901-
console.log(""mutation observer namespace"");
952+
953+
var groupingLevel = groupingInput.value;
902954
var rows = document.querySelectorAll(""coverage-info table tbody tr[class-row]"");
903955
for(var i=0;i<rows.length;i++){{
904956
var row = rows[i];
905957
var cell = row.cells[0];
906958
var a = cell.querySelector(""a"");
907959
var fullyQualified = a.innerText;
908-
var name = fullyQualified.substring(fullyQualified.lastIndexOf(""."") + 1);
960+
{fullyQualifiedToName}
909961
a.innerText = name;
910962
}};
911963
}};
912-
913-
var observer = new MutationObserver(callback);
914-
observer.observe(targetNode, config);
964+
changeQualification();
965+
coverageInfoObserver.observe(changeQualification);
915966
";
916-
return code;
967+
return code;
917968
}
918969
919970
private string HackGroupingToAllowAll(int groupingLevel)
@@ -1000,7 +1051,7 @@ public string ProcessUnifiedHtml(string htmlForProcessing, string reportOutputFo
10001051
ReportColours = reportColoursProvider.GetColours();
10011052
return assemblyUtil.RunInAssemblyResolvingContext(() =>
10021053
{
1003-
var (cyclomaticThreshold, crapScoreThreshold, nPathThreshold) = HotspotThresholds();
1054+
var (cyclomaticThreshold, crapScoreThreshold, nPathThreshold) = HotspotThresholds(appOptions);
10041055
var noRiskHotspotsHeader = "No risk hotspots that exceed options :";
10051056
var noRiskHotspotsCyclomaticMsg = $"Cyclomatic complexity : {cyclomaticThreshold}";
10061057
var noRiskHotspotsNpathMsg =$"NPath complexity : {nPathThreshold}";
@@ -1154,10 +1205,11 @@ public string ProcessUnifiedHtml(string htmlForProcessing, string reportOutputFo
11541205
11551206
htmlSb.Replace("</body>", $@"
11561207
<script type=""text/javascript"">
1157-
{GetStickyTableHead()}
1208+
{GetStickyTableHead(appOptions)}
11581209
{HackGroupingToAllowAll(groupingLevel)}
1159-
{ObserveAndHideFullyCovered()}
1160-
{ObserveAndHideNamespaceWhenGroupingByNamespace()}
1210+
{CoverageInfoObserver()}
1211+
{ObserveAndHideNamespaceWhenGroupingByNamespace(appOptions)}
1212+
{ObserveAndHideFullyCovered(appOptions)}
11611213
function getRuleBySelector(cssRules,selector){{
11621214
for(var i=0;i<cssRules.length;i++){{
11631215
if(cssRules[i].selectorText == selector){{
@@ -1672,13 +1724,12 @@ private void HideRowsFromOverviewTable(HtmlDocument doc)
16721724
}
16731725
}
16741726

1675-
private (int cyclomaticThreshold, int crapScoreThreshold, int nPathThreshold) HotspotThresholds()
1727+
private (int cyclomaticThreshold, int crapScoreThreshold, int nPathThreshold) HotspotThresholds(IAppOptions appOptions)
16761728
{
1677-
var options = appOptionsProvider.Get();
16781729
return (
1679-
options.ThresholdForCyclomaticComplexity,
1680-
options.ThresholdForCrapScore,
1681-
options.ThresholdForNPathComplexity
1730+
appOptions.ThresholdForCyclomaticComplexity,
1731+
appOptions.ThresholdForCrapScore,
1732+
appOptions.ThresholdForNPathComplexity
16821733
);
16831734

16841735
}

‎SharedProject/Options/AppOptionsPage.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ You can also ignore additional attributes by adding to this list (short name or
268268

269269
[Category(commonReportCategory)]
270270
[Description("Control qualification of types when NamespacedClasses is true.")]
271-
public GroupingNamespaceQualification GroupingNamespaceQualification { get; set; }
271+
public NamespaceQualification NamespaceQualification { get; set; }
272272

273273
[Category(commonReportCategory)]
274274
[Description("Set to true to hide classes, namespaces and assemblies that are fully covered.")]

‎SharedProject/Options/AppOptionsProvider.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,6 @@ internal class AppOptions : IAppOptions
209209
public bool ShowToolWindowToolbar { get; set; }
210210
public string[] ExcludeAssemblies { get; set; }
211211
public string[] IncludeAssemblies { get; set; }
212-
public GroupingNamespaceQualification GroupingNamespaceQualification { get; set; }
212+
public NamespaceQualification NamespaceQualification { get; set; }
213213
}
214214
}

‎SharedProject/Options/IAppOptions.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ internal interface IAppOptions : IMsCodeCoverageOptions, IOpenCoverCoverletExclu
6666
RunMsCodeCoverage RunMsCodeCoverage { get; set; }
6767
bool ShowToolWindowToolbar { get; set; }
6868

69-
GroupingNamespaceQualification GroupingNamespaceQualification { get; set; }
69+
NamespaceQualification NamespaceQualification { get; set; }
7070
}
7171

72-
internal enum GroupingNamespaceQualification
72+
internal enum NamespaceQualification
7373
{
7474
FullyQualified,
7575
AlwaysUnqualified,

0 commit comments

Comments
 (0)