#Disharmony Ranker
This is a tool for Java codebases that will help you identify the God Classes you should refactor first.
To use the plugin you can perform a mvn clean install locally and then add the following to your project in the build section:
<build>
<plugins>
<plugin>
<groupId>org.hjug.disharmonyranker.plugin</groupId>
<artifactId>disharmony-ranker-maven-plugin</artifactId>
<version>0.1.0-SNAPSHOT</version>
</plugin>
</plugins>
</build>Then run the following command from the root of your project (the source code does not need to be built):
mvn org.hjug.disharmonyranker.plugin:disharmony-ranker-maven-plugin:0.1.0-SNAPSHOT:report
Once the report is generated, you will find a table with the output in target/site/disharmony-ranker-report.html. The classes you should refactor first are at the top.
This plugin will work on both single module and multi-module Maven projects.
This tool is based on the paper Prioritizing Design Debt Investment Opportunities by Nico Zazworka, Carolyn Seaman, and Forrest Shull
There is still much to be done. I hope to publish this proof of concept to maven.org soon to make it easier to use. In the meantime, your feedback would be greatly appreciated.
Limitations
- This plugin only works with Java 8 projects at this time
Future Plans
- Rename this tool with a better name that isn't such a mouthful. Have ideas? Let me know!
- Generate a Google chart above the table. This feature is close to being complete. However, the chart is covering the table, and I'm not the best frontend developer.
- Move from JUnit 4 to Junit 5. Junit 5 is lacking the support for temporary files that JUnit 4 provides.
- Use Maven's Guice to autowire dependencies.
- Incorporate more disharmonies from Object Oriented Metrics In Practice.
- Support Java 11