Skip to content

Reporting module#2589

Open
TwoOfTwelve wants to merge 14 commits intodevelopfrom
feature/reportingPackage
Open

Reporting module#2589
TwoOfTwelve wants to merge 14 commits intodevelopfrom
feature/reportingPackage

Conversation

@TwoOfTwelve
Copy link
Copy Markdown
Contributor

@TwoOfTwelve TwoOfTwelve commented Sep 9, 2025

Moves all reporting related classes to a new module (#2531).

The following module dependencies are relevant for the new reporting module:

reporting -> core
cli -> reporting
cli -> core

Due to some dependencies not being available some tests had to be adjusted:

  • ReadmeCodeExampleTest has been moved to the cli module, since it needs access to the reporting classes
  • ComparisonReportWriterTest.java and ReportObjectFactoryTest.java build the JPlag options manually, since the test classes from core are not available

Some warnings in the moved code have been fixed

@sonarqubecloud
Copy link
Copy Markdown

Comment thread reporting/pom.xml Outdated
Copy link
Copy Markdown
Member

@tsaglam tsaglam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reminder for us: This is a breaking change, merge only after next minor release.

@tsaglam tsaglam requested a review from Copilot September 19, 2025 12:12
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR creates a new reporting module by extracting reporting-related functionality from the core module. The purpose is to better organize the codebase by separating reporting utilities into their own module while maintaining proper dependencies (reporting -> core, cli -> reporting, cli -> core).

  • Moves all CSV, JSON factory, and report object classes from core to the new reporting module
  • Updates package declarations and import statements across affected files
  • Adjusts test classes to manually build JPlag options since core test utilities are no longer available

Reviewed Changes

Copilot reviewed 32 out of 50 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
reporting/pom.xml Creates new reporting module with dependency on core and test dependency on java language
reporting/src/main/java/de/jplag/reporting/csv/* Updates package declarations from de.jplag.csv to de.jplag.reporting.csv
reporting/src/main/java/de/jplag/reporting/jsonfactory/* Updates imports to use core's FilePathUtil instead of reporting's
reporting/src/test/java/de/jplag/reporting/reportobject/* Refactors tests to manually create JPlag options and use getFirst() instead of get(0)
core/src/main/java/de/jplag/* Moves FilePathUtil and Version classes to core package and updates serializer package locations
cli/src/main/java/de/jplag/cli/* Updates imports to reference new reporting module locations

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread reporting/pom.xml Outdated
@sonarqubecloud
Copy link
Copy Markdown

@TwoOfTwelve TwoOfTwelve requested a review from tsaglam October 30, 2025 12:05
Copy link
Copy Markdown
Member

@tsaglam tsaglam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, right, I am still blocking this. This is not a review, just to unblock it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check if this and the other serializer can be moved into the reporting package by injecting it at runtime or something similar using jackson

Alexander Milster added 3 commits January 12, 2026 12:50
# Conflicts:
#	core/src/main/java/de/jplag/serializer/AllCapsClassNameSerializer.java
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jan 14, 2026

Comment thread reporting/pom.xml Outdated
@Kr0nox Kr0nox self-requested a review March 5, 2026 12:22
@sonarqubecloud
Copy link
Copy Markdown

@Kr0nox
Copy link
Copy Markdown
Member

Kr0nox commented Apr 10, 2026

@TwoOfTwelve can you look at the sonar issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants