Replace the outdated HTML report generation #192 #287
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
…shall be content of the resources.
…eation of OverviewReport
… list of Metrics, implemnted Metric creation from JPlagResult in ReportObjectFactory
…ison reports generator function
…ort as json strings, implemented the function in ReportImplementation, Json strings from JPlagResult can now be generated
…check and returning index or line depending on it
… overview page implementation
…namically update top comparisons list in frontend
Added simple deployment script for report viewer to GH Pages.
More comments.
…ks to matches, sidebar can be hidden now
… match list, set cursor to pointer for clickable areas
sebinside
requested changes
Feb 21, 2022
sebinside
reviewed
Feb 21, 2022
…ist dialog, fixed index.ts
|
@cholakov11 Thank you for implementing the change requests. In my opinion, there are only three things left:
Then, I'll be happy to merge this pull request! 🚀 |
… to override, fixed compariosnview ids
# Conflicts: # jplag/pom.xml # jplag/src/main/java/de/jplag/CLI.java
|
@sebinside Conflicts are fixed, ready to merge. |
sebinside
approved these changes
Mar 8, 2022
Closed
30 tasks
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.
Until now the JPlag report functionality was creating report html files by generating "hard coded" html code. In this pull request changes to the report generation as well as report presentation were introduced.
Report generation
The report generation was moved from generating "hard coded" html to generating JSON files which represent the report. An overview.json file is generated which contains the overall information of a JPlagResult as well as a .json file for each comparison done in the JPlag comparison process.
DTO classes (de.jplag.reportingV2.reportobject.model) are introduced which are used to model the JSON files. ReportObjectFactory is a factory class which takes a JPlagResult object and converts it to a JPlagReport consisting of an OverviewReport and a list of ComparisonReport objects.
The Jackson library is then used to generate json strings from the given JPlagReport. The generated strings are then saved as files on the hard drive.
The .json files can be used by any program which can display .json files or a JPlag report.
Report presentation
A new JPlag report viewer application is introduced in the form of a Vue + Typescript application. The application can be started on local host from its folder report-viewer and accepts .zip files containing overveiw and comparison json files, single json files or searches for report files in its local files folder.
When receiving the .json files the application convets them to Typescript objects (Overview.ts, Comparison.ts) and gives these object to the Vue components to be displayed.
The report viewer consists of three types of pages - a FileUpload page which the entry point to the application and where files to display are specified, an Overview page which display the overall information of a report and a Comparison page for each comparison.
The report viewer supports: