Skip to content

Resolve Sonar findings (#279) - #282

Merged
AndreasIgel merged 15 commits into
java-helpers:mainfrom
AndreasIgel:devin/1788588527-sonar-279
Sep 12, 2026
Merged

AndreasIgel merged 15 commits into
java-helpers:mainfrom
AndreasIgel:devin/1788588527-sonar-279

Conversation

@AndreasIgel

Copy link
Copy Markdown
Collaborator

Summary

Fixes the three code-level Sonar findings from #279 (the fork-sonar.yml untrusted-fork hotspot is intentionally left for its own ticket). No behavior changes.

  • ProcessorTestUtils.extractTopLevelTypeName — regex with super-linear backtracking (^\s*(?:mod)?(?:\s+(?:mods))*\s* stacks whitespace quantifiers). Now each modifier consumes its own trailing whitespace, ^[ \t]* no longer spans lines, and both patterns in the file are static final Pattern constants instead of being compiled per call:
    (?m)^[ \t]*(?:(?:public|protected|private|abstract|final|static|sealed|non-sealed|strictfp)\s+)*(?:@?interface|class|enum|record)\s+([A-Za-z_]\w*)\b
    
  • RoasterCodeGenerator.addParameter — conditional moved inside the operation; one varArgs boolean replaces two instanceof checks:
    boolean varArgs = lastParameter && paramDto.getParameterType() instanceof TypeNameArray;
    TypeName parameterType = varArgs ? ((TypeNameArray) ...).getTypeOfArray() : paramDto.getParameterType();
    method.addParameter(mapType(parameterType), ...);
  • ConfigurationProcessingTest.allConfigurationOptions_MustBeSettableViaBuilder — 27 assertions > 25 limit. The builder chain moved into buildFullyConfigured(); the OptionState assertions stay in the original test and the AccessModifier/suffix/formattingMode assertions moved to allConfigurationOptions_AccessNamingAndFormatting_MustBeReadable. No assertion dropped.

Processor module: 420 tests green. Generated example builders unchanged (CI drift check passes).

AndreasIgel and others added 15 commits August 15, 2026 10:57
The class-level Javadoc and docs/CONFIGURATION.md implied that
@SimpleBuilder is inherited by subclasses, but the annotation was not
meta-annotated with @inherited. As a result BuilderProcessor, which
collects types via RoundEnvironment.getElementsAnnotatedWith(...),
only produced builders for the exact type carrying @SimpleBuilder and
not for unannotated subclasses.

Add @inherited to @SimpleBuilder so subclasses are treated as if they
also carried the annotation, mirroring the existing behaviour of
@SimpleBuilder.Template (which is already @inherited). Update the
Javadoc to document the inheritance explicitly and clarify the
CONFIGURATION.md wording. @Ignore4BuilderGeneration still suppresses
generation for the exact type it is placed on, so opt-outs continue
to work as before.

Add SimpleBuilderInheritanceTest covering direct inheritance, the
opt-out interaction, and multi-level (grandchild) inheritance.

Closes java-helpers#244

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…ance

Rename SimpleBuilderInheritanceTest to BuilderAnnotationInheritanceTest
so the name reflects that it covers both builder-triggering annotations.
Add unannotatedSubclassGetsBuilderFromInheritedTemplate, which verifies
that a custom @inherited template annotation (meta-annotated with
@SimpleBuilder.Template) propagates to unannotated subclasses, matching
the existing behaviour of @SimpleBuilder itself.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
The Template Javadoc and CONFIGURATION.md "Template Annotations" section
did not explain that @SimpleBuilder.Template is @inherited, nor that a
custom template annotation must additionally declare @inherited to
propagate to unannotated subclasses. Add explicit documentation and an
example showing the @inherited custom annotation pattern.

Also move assertNoBuilderGenerated to ProcessorAsserts so it is shared
by BuilderAnnotationInheritanceTest and Ignore4BuilderGenerationTest
instead of being duplicated as a private helper in each test class.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
While @SimpleBuilder and @inherited template annotations now correctly
trigger builder generation for unannotated subclasses, the configuration
options declared on the parent's @SimpleBuilder(options = ...) or template
are not yet applied to inherited subclass builders — they use default
options instead. This is tracked separately in issue java-helpers#245.

Add caveats to the SimpleBuilder Javadoc, the CONFIGURATION.md Template
Annotations section, and the Template Annotations Not Working
troubleshooting section so users are not surprised by this limitation.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Add explicit guidance that @SimpleBuilder.Template is a meta-annotation
for custom annotation declarations (@interface) only and cannot be
placed directly on a class or record. @SimpleBuilder is for direct
one-off annotation of classes/records.

- SimpleBuilder.java: add 'When to use' section to class-level Javadoc
- SimpleBuilder.Template Javadoc: state it can only be placed on
  annotation types (ANNOTATION_TYPE), not on classes/records
- CONFIGURATION.md 'Template Annotations': add comparison table and
  introductory paragraph
- CONFIGURATION.md troubleshooting: add item about @SimpleBuilder.Template
  not being a class annotation

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…Javadoc

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…arget

The compiler and IDE already enforce @target(ANNOTATION_TYPE) and show
a clear error when @SimpleBuilder.Template is placed on a class/record,
so this troubleshooting item adds no value.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Andreas Igel <andreas.igel@computacenter.com>
@AndreasIgel AndreasIgel changed the title Resolve Sonar findings (#279 Resolve Sonar findings (#279) Sep 12, 2026
@AndreasIgel
AndreasIgel merged commit 9c2bf54 into java-helpers:main Sep 12, 2026
5 checks passed
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.

1 participant