Static HTML report model clean-ups #8606
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fviernau
force-pushed
the
trivial-static-html-model-fixes
branch
2 times, most recently
from
8d8849a
to
259845b
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8606 +/- ##
=========================================
Coverage 67.97% 67.97%
Complexity 1005 1005
=========================================
Files 244 244
Lines 7844 7844
Branches 876 876
=========================================
Hits 5332 5332
Misses 2129 2129
Partials 383 383
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
sschuberth
requested changes
May 2, 2024
plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt
Outdated
Show resolved
Hide resolved
plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt
Outdated
Show resolved
Hide resolved
This is more consistent with ORT's code base, which usually does not use the term "model" as a class name suffix. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
Also move the class into `ProjectTable` to allow for that shorter name. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
Also move the class into `IssueTable` to allow for that shorter name. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
Move all direct nested class of `ReportTable` to the top level for a better overview. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
This is only needed in the static HTML reporter. So, move it next to the other helper functions. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
fviernau
force-pushed
the
trivial-static-html-model-fixes
branch
from
259845b
to
12e74fd
Compare
The report is table-based and consists of multiple tables. The previous name made it sound like it would be a single table. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
fviernau
force-pushed
the
trivial-static-html-model-fixes
branch
from
12e74fd
to
be8df83
Compare
sschuberth
reviewed
May 3, 2024
| @@ -174,7 +174,7 @@ class StaticHtmlReporter : Reporter { | |||
| return document.serialize().normalizeLineBreaks() | |||
| } | |||
|
|
|||
| private fun getRuleViolationSummaryString(ruleViolations: List<ResolvableViolation>): String { | |||
| private fun getRuleViolationSummaryString(ruleViolations: List<TableReportViolation>): String { | |||
There was a problem hiding this comment.
Should this also use plural "TablesReport..." to not have too many variants of the spelling, and to document that it belongs to the scope of TablesReport?
There was a problem hiding this comment.
Or maybe just move these classes inside of TablesReport and omit the prefix, similar to like you did for the Row classes?
`ResolvableIssue` and `ResolvableRuleViolation` are the representations of issues and rule violations within the domain of the static HTML report model. So, use the name of the model as the prefix, instead of the "Resolvable" prefix which focuses too much on only one of its properties. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
This is a fix-up for 9c6b867. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
fviernau
force-pushed
the
trivial-static-html-model-fixes
branch
from
be8df83
to
704a86f
Compare
sschuberth
approved these changes
May 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A couple of trivial refactors focusing on cleaning-up the model classes of the static HTML report.
Please see the individual commit messages.
Part of: #7921.