RAT-540: Create UI option collections by Claudenw · Pull Request #637 · apache/creadur-rat

Claudenw · 2026-03-22T15:39:53Z

Introduces ui package
Modifications to use ui package.

Changes of note:

AbstractOption becomes UIOption and is UI Specific.
Default values for parameters are moved into the UIOptionsCollection implementations.
HELP option is removed from Arg and left as implementation detail in UIOptionsCollections as there is not a common implementation across the UIs.
ui package is new and contains all the UI classes that will be used to create new UIs. In future PRs the Ant and Maven UIs will be extracted and placed in separate modules.
Many of the files are small changes to solve javadoc, checkstyle, or sonar issues that arise because of small changes to interfaces and low level method signatures.

Claudenw · 2026-05-24T10:06:41Z

@ottlinger, Once you finish this review I will rebase onto main to clean up the build errors.

ottlinger · 2026-05-17T21:53:39Z

+                try {
+                    File includeFileName = context.getCommandLine().getParsedOptionValue(selected);
+                    if (includeFileName != null) {
+                        context.getConfiguration().addIncludedPatterns(ExclusionUtils.asIterable(includeFileName, "#"));


Description says "entries will be excluded from processing", but the method is "addIncludePatterns" - shouldn't it be "addExcludePatterns" then?

Most probably the description of the deprecated option is misleading ....

ottlinger · 2026-05-17T22:04:07Z

+
+
+    private static void doNotExecute(final ArgumentContext context, final Option selected) {
+        throw new ImplementationException(String.format("'%s' should not be executed directly", selected));


Initially I wondered "... what to do instead" is missing in that message to the user of RAT.
If I get this message, did I do something wrong or not?

In the case of "help-licenses" I used the option correctly ....

ottlinger · 2026-05-17T22:14:02Z

-                context.getConfiguration().setStyleSheet(StyleSheets.getStyleSheet(style[0]));
-            }
+    private static void processOutputArgs(final ArgumentContext context, final UIOptionCollection<?> optionCollection) throws ConfigurationException {
+        for (Arg arg : new Arg[]{DRY_RUN, OUTPUT_FAMILIES, OUTPUT_LICENSES, OUTPUT_ARCHIVE, OUTPUT_STANDARD, OUTPUT_FILE, OUTPUT_STYLE}) {


Personally I'd prefer List.of() due to better readability than arrays here ....

ottlinger · 2026-05-17T22:14:16Z

-        } catch (Exception e) {
-            throw ConfigurationException.from(e);
+    private static void processInputArgs(final ArgumentContext context, final UIOptionCollection<?> optionCollection) throws ConfigurationException {
+        for (Arg arg : new Arg[]{SOURCE, EXCLUDE, EXCLUDE_FILE, EXCLUDE_STD, EXCLUDE_PARSE_SCM, EXCLUDE_SIZE,


Personally I'd prefer List.of() due to better readability than arrays here ....

ottlinger · 2026-05-17T22:14:26Z

+        });
+        context.getConfiguration().setFrom(defaultBuilder.build());
+
+        for (Arg arg : new Arg[]{FAMILIES_APPROVED, FAMILIES_APPROVED_FILE, FAMILIES_DENIED, FAMILIES_DENIED_FILE,


Personally I'd prefer List.of() due to better readability than arrays here ....

ottlinger · 2026-05-21T07:18:41Z

+
+import org.apache.rat.ui.UI;
+import org.apache.rat.ui.UIOption;
+


Should we add a general description here that explains the proposed architecture?

ottlinger · 2026-05-24T22:38:15Z

    }

    @OptionCollectionTest.TestFunction
-    @Override


The class contains many unused (reported by IDE) methods - is that part of the changes or can these methods be removed?

ottlinger · 2026-05-24T22:44:22Z

-            <exclude>ALL</exclude>
-          </inputExcludeStds>
+          <inputIncludes>pom.xml</inputIncludes>
+          <inputExcludeStds>ALL</inputExcludeStds>


Should we document this breaking change in the change-notes for 1.0.0 explicitly?

Created RAT-556 as a reminder ticket

ottlinger · 2026-05-24T22:49:41Z

+          <configs>
+            <config>.rat/customConfig.xml</config>
+          </configs>
+          <inputExcludes>.rat/**</inputExcludes>


I'm not sure if this configuration is "Maven-style" - would it make sense to ask over at the Maven mailing list?

plugins contains multiple plugin-entries .... that made me think about this breaking change.

What I mean is: how does a configuration with multiple entries look like?

<inputIncludes> <include>pom.xml</include> <include>foo.bar/include> </inputIncludes>

OR will it become

<inputIncludes>pom.xml</inputIncludes> <inputIncludes>foo.bar</inputIncludes>

ottlinger · 2026-05-25T20:49:49Z

    }

-   private AntDocumentation(final File outputDir) {
+    /* Visible for testing */


Class contains unused methods:

writeTitle

writePara

writeList

Should they be removed or will they be needed later and are only yet unused?

As I recall, this class and methods will be used in the Ant UI package.

I wouldn't worry too much about tools as it goes away at the end of this trasformation.

In the end we will have the following modules

core: (the core functionality)

core test: test code from core packaged with dependencies to make it easier for UI modules. Basically a maven module that points to core /src/test for its /src/main. Jars built like this include dependencies so that when included as test libraries the transitive dependencies are present.

CLI: the current command line interface

ANT: the ANT interface and components from tools that are used for it.

Maven: the Maven interface and the components from tools that are used for it.

packaging: -- Not sure about this one, but I think that it just puts outputs from the above modules into release (as in upload to sonatype or github release style) packages and deploys them.

The UI modules CLI, ANT, and Maven will have multiple sub modules. Something like

UI module pom

tools: Tooling from current tool module + additional bits.

main: The actual code that is released. Module should build the packaging necessary to use the UI as a stand alone unit

Claudenw · 2026-05-26T07:37:57Z

@ottlinger you have a number of good questions and ideas here with respect to how this works going forward. I like the idea of describing how the architecture works. Would you rather I fix/comment on the issues in this PR (and potentially make it larger) or open another PR to add the documentation.

I had planned on writing/updating the general documentation (.md files) when this change is complete.

ottlinger · 2026-05-26T08:00:45Z

@Claudenw I created RAT-557 to add documentation and have a new PR for it. The Maven/configuration stuff should be handled here I guess.

sonarqubecloud · 2026-05-26T13:39:52Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
83.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ottlinger changed the title ~~Create UI option collections~~ RAT-540: Create UI option collections Mar 23, 2026

Claudenw force-pushed the create-UIOptionCollections branch from bf4e7b0 to e493553 Compare April 27, 2026 15:35

Claudenw marked this pull request as draft April 27, 2026 16:11

Claudenw added 21 commits May 6, 2026 19:36

initial working code

be3944a

modified OptionCollection to use CLIOptionCollection

714caee

Switched to cased string preserving the parts from the parsing

6fed7b6

fixed CasedString checkstyle issues

e8af517

cleaned up sonar issues

b8e0a83

added additional tests

d97da52

fixed checkstyle issues

a72886c

added tests

0e2e7be

Switched to UIOptionCollections

685d583

Added AntOptionCollection.java

be916d1

updated Arg documentation

1ef787c

updated RatTool tests

8c3dcb9

fixed review issues

a5497d0

fixed AntDocumentationTest

e7613b4

added CLIOptionTests

d586526

added OptionCollectionParser tests

bb78eea

updated ArgumentTracker

fc15408

fixed errors

b6c92f6

attempted fix

781b260

cleaned up code issues

a3e1c07

initial updates

b93bc7f

Claudenw force-pushed the create-UIOptionCollections branch from 37140e9 to b93bc7f Compare May 8, 2026 13:10

Claudenw added 4 commits May 8, 2026 16:21

fixed test generation

4d66c38

added NOSONAR for some methods

be58d1e

fixed checkstyle issue

09e6b23

fixed typo

364e2c9

Claudenw marked this pull request as ready for review May 8, 2026 16:24

Claudenw requested a review from ottlinger May 8, 2026 16:33

Claudenw mentioned this pull request May 10, 2026

RAT-541: create testhelpers.data package #655

Draft

ottlinger added 4 commits May 18, 2026 00:23

RAT-540: minor changes during review

8f96dd9

Remove unused import

55c2092

RAT-540: Fix typo

2adfe32

RAT-540: Minor changes during review

9b86850

ottlinger added 6 commits May 25, 2026 00:42

RAT-540: Minor review cleanups

31f95ac

RAT-540: Reformat poms

4129233

RAT-540: Minor changes during review

2a48c6d

RAT-540: Fix typos in Velocity files

5cf538e

RAT-540: Fix typos/little errors during review

1eb8f2d

RAT-540: Minor cleanups during review

1ccbd0d

ottlinger requested changes May 25, 2026

View reviewed changes

ottlinger and others added 2 commits May 25, 2026 23:26

RAT-540: Add changelog

95dff0e

Merge branch 'master' into create-UIOptionCollections

e2e7d5d

Fix build warning and reformat pom

bb3a412



		private static void doNotExecute(final ArgumentContext context, final Option selected) {
		throw new ImplementationException(String.format("'%s' should not be executed directly", selected));


		import org.apache.rat.ui.UI;
		import org.apache.rat.ui.UIOption;

Conversation

Claudenw commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Claudenw commented May 24, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Claudenw commented May 26, 2026

Uh oh!

ottlinger commented May 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 26, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Claudenw commented Mar 22, 2026 •

edited

Loading

ottlinger commented May 26, 2026 •

edited

Loading