Merge pull request #391 from xdev-software/develop

Release

Author: AB-xdev

.config/checkstyle/checkstyle.xml

@@ -79,11 +79,15 @@
 			<property name="format" value="^(?!(.*(Map|List|Set))$).+$"/>
 			<property name="tokens" value="PARAMETER_DEF, VARIABLE_DEF, PATTERN_VARIABLE_DEF, RECORD_COMPONENT_DEF, LAMBDA"/>
 		</module>
+		<!-- Name classes correctly and don't use generic name for everything -->
+		<module name="IllegalIdentifierName">
+			<property name="format" value="^(?!(.*(Helper|Util(s|ity)?))$).+$"/>
+			<property name="tokens" value=" CLASS_DEF"/>
+		</module>
 		<module name="IllegalImport"/>
+		<module name="IllegalSymbol"/>
 		<module name="InterfaceIsType"/>
-		<module name="JavadocStyle">
-			<property name="checkFirstSentence" value="false"/>
-		</module>
+		<module name="JavadocContentLocation"/>
 		<module name="LeftCurly">
 			<!-- Default minus Lambda -->
 			<property name="tokens" value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF, OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
@@ -140,6 +144,8 @@
 		<module name="UnnecessarySemicolonInTryWithResources"/>
 		<module name="UnusedImports"/>
 		<module name="UnusedLocalVariable"/>
+		<!-- Disabled by default; should be enabled on Java 25+ -->
+		<!-- <module name="UnusedTryResourceShouldBeUnnamed"/> -->
 		<module name="UpperEll"/>
 		<module name="VisibilityModifier">
 			<property name="packageAllowed" value="true"/>

.config/pmd/java/ruleset.xml

@@ -13,6 +13,7 @@
 	<!-- About: Formatting -->
 	<!-- Some lines (e.g. description, examples and CDATA) have to start without any indents or this will result in incorrect formatting -->
 
+	<rule ref="category/java/bestpractices.xml/AssertStatementInTest"/>
 	<rule ref="category/java/bestpractices.xml/AvoidPrintStackTrace"/>
 	<rule ref="category/java/bestpractices.xml/AvoidUsingHardCodedIP"/>
 	<rule ref="category/java/bestpractices.xml/ConstantsInInterface"/>
@@ -45,8 +46,10 @@
 	<rule ref="category/java/codestyle.xml/LambdaCanBeMethodReference"/>
 	<rule ref="category/java/codestyle.xml/NoPackage"/>
 	<rule ref="category/java/codestyle.xml/PrematureDeclaration"/>
+	<rule ref="category/java/codestyle.xml/UnnecessaryBlock"/>
 	<rule ref="category/java/codestyle.xml/UnnecessarySemicolon"/>
 	<rule ref="category/java/codestyle.xml/VariableCanBeInlined"/>
+	<rule ref="category/java/codestyle.xml/VariableDeclarationUsageDistance"/>
 
 	<rule ref="category/java/design.xml">
 		<!-- Sometimes abstract classes have just fields -->
@@ -138,6 +141,7 @@
 		</properties>
 	</rule>
 
+	<rule ref="category/java/errorprone.xml/AssertEqualsArgumentOrder"/>
 	<rule ref="category/java/errorprone.xml/AssignmentToNonFinalStatic"/>
 	<rule ref="category/java/errorprone.xml/AvoidDecimalLiteralsInBigDecimalConstructor"/>
 	<rule ref="category/java/errorprone.xml/AvoidMultipleUnaryOperators"/>
@@ -146,7 +150,6 @@
 	<rule ref="category/java/errorprone.xml/CollectionTypeMismatch"/>
 	<rule ref="category/java/errorprone.xml/ComparisonWithNaN"/>
 	<rule ref="category/java/errorprone.xml/DoNotCallGarbageCollectionExplicitly"/>
-	<rule ref="category/java/errorprone.xml/DontImportSun"/>
 	<rule ref="category/java/errorprone.xml/DontUseFloatTypeForLoopIndices"/>
 	<rule ref="category/java/errorprone.xml/EqualsNull"/>
 	<rule ref="category/java/errorprone.xml/IdempotentOperations"/>
@@ -155,6 +158,7 @@
 	<rule ref="category/java/errorprone.xml/InstantiationToGetClass"/>
 	<rule ref="category/java/errorprone.xml/InvalidLogMessageFormat"/>
 	<rule ref="category/java/errorprone.xml/JumbledIncrementer"/>
+	<rule ref="category/java/errorprone.xml/JUnitJupiterTestNoPrivateModifier"/>
 	<rule ref="category/java/errorprone.xml/MisplacedNullCheck"/>
 	<rule ref="category/java/errorprone.xml/MoreThanOneLogger"/>
 	<rule ref="category/java/errorprone.xml/NonStaticInitializer"/>
@@ -164,6 +168,7 @@
 	<rule ref="category/java/errorprone.xml/SingletonClassReturningNewInstance"/>
 	<rule ref="category/java/errorprone.xml/UnconditionalIfStatement"/>
 	<rule ref="category/java/errorprone.xml/UnnecessaryCaseChange"/>
+	<rule ref="category/java/errorprone.xml/UnsupportedJdkApiUsage"/>
 	<rule ref="category/java/errorprone.xml/UselessPureMethodCall"/>
 
 
@@ -208,6 +213,36 @@
 	<rule ref="category/java/security.xml"/>
 
 
+	<rule name="AvoidOptionalGet"
+		language="java"
+		message="Avoid using Optional#get"
+		class="net.sourceforge.pmd.lang.rule.xpath.XPathRule"
+		externalInfoUrl="https://stackoverflow.com/a/49159955">
+		<description>
+`Optional#get` can be interpreted as a getter by developers, however this is not the case as it throws an exception when empty.
+
+It should be replaced by
+* doing a mapping directly using `.map` or `.ifPresent`
+* using the preferred `.orElseThrow`, `.orElse` or `.or` methods
+
+Java Developer Brian Goetz also writes regarding this topic:
+
+> Java 8 was a huge improvement to the platform, but one of the few mistakes we made was the naming of `Optional.get()`, because the name just invites people to call it without calling `isPresent()`, undermining the whole point of using `Optional` in the first place.
+>
+> During the Java 9 time frame, we proposed to deprecate `Optional.get()`, but the public response to that was ... let's say cold. As a smaller step, we introduced `orElseThrow()` in 10 (see [JDK-8140281](https://bugs.openjdk.java.net/browse/JDK-8140281)) as a more transparently named synonym for the current pernicious behavior of `get()`. IDEs warn on unconditional use of `get()`, but not on `orElseThrow()`, which is a step forward in teaching people to code better. The question is, in a sense, a "glass half empty" view of the current situation; `get()` is still problematic.
+		</description>
+		<priority>3</priority>
+		<properties>
+			<property name="xpath">
+				<value>
+<![CDATA[
+//MethodCall[pmd-java:matchesSig('java.util.Optional#get()')]
+]]>
+				</value>
+			</property>
+		</properties>
+	</rule>
+
 	<rule name="AvoidStringBuilderOrBuffer"
 		language="java"
 		message="StringBuilder/StringBuffer should not be used"
@@ -387,7 +422,8 @@ If you are 100% sure that you escaped the value properly and you have no better
 				<value>
 <![CDATA[
 //ConstructorCall[pmd-java:typeIs('com.vaadin.flow.component.Html')] |
-//MethodCall[@MethodName='setAttribute' and //ImportDeclaration[starts-with(@PackageName,'com.vaadin')]]/ArgumentList/StringLiteral[1][contains(lower-case(@Image),'html')]
+//MethodCall[@MethodName='setAttribute' and //ImportDeclaration[starts-with(@PackageName,'com.vaadin')]]/ArgumentList/StringLiteral[1][contains(lower-case(@Image),'html')] |
+//MethodCall[pmd-java:matchesSig('com.vaadin.flow.dom.Element#setProperty(java.lang.String,java.lang.String)')]/ArgumentList/StringLiteral[1][contains(lower-case(@Image),'html')]
 ]]>
 				</value>
 			</property>
@@ -410,7 +446,7 @@ A `Set` also prevents duplicates when the ORM reads multiple identical rows from
 				<value>
 <![CDATA[
 //ClassDeclaration[pmd-java:hasAnnotation('jakarta.persistence.Entity')]
-//FieldDeclaration[pmd-java:hasAnnotation('jakarta.persistence.ManyToMany') or pmd-java:hasAnnotation('jakarta.persistence.OneToMany')]
+//FieldDeclaration[pmd-java:hasAnnotation('jakarta.persistence.ManyToMany') or pmd-java:hasAnnotation('jakarta.persistence.OneToMany') or pmd-java:hasAnnotation('jakarta.persistence.ElementCollection')]
 /ClassType[pmd-java:typeIs('java.util.List')]
 ]]>
 				</value>

.config/topo/upstream.yml

@@ -0,0 +1,2 @@
+- url: https://github.com/xdev-software/openapi-client-maven-template.git
+  branch: master

.github/.lycheeignore

@@ -1,3 +1,4 @@
 # Ignorefile for broken link check
 localhost
 mvnrepository.com
+stackoverflow.com

.github/workflows/broken-links.yml

@@ -3,7 +3,7 @@ name: Broken links
 on:
   workflow_dispatch:
   schedule:
-    - cron: "23 23 * * 0"
+    - cron: "23 5 * * 0"
 
 permissions:
   issues: write
@@ -13,14 +13,15 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
       - run: mv .github/.lycheeignore .lycheeignore
 
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2
+        uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2
         with:
+          args: "--verbose --no-progress './**/*.md'"
           fail: false # Don't fail on broken links, create an issue instead
 
       - name: Find already existing issue

.github/workflows/check-build.yml

@@ -31,7 +31,7 @@ jobs:
         java: [17, 21, 25]
         distribution: [temurin]
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Set up JDK
       uses: actions/setup-java@v5
@@ -40,7 +40,7 @@ jobs:
         java-version: ${{ matrix.java }}
 
     - name: Cache Maven
-      uses: actions/cache@v5
+      uses: actions/cache@v6
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-mvn-build-${{ hashFiles('**/pom.xml') }}
@@ -69,7 +69,7 @@ jobs:
         fi
 
     - name: Upload demo files
-      uses: actions/upload-artifact@v6
+      uses: actions/upload-artifact@v7
       with:
         name: demo-files-java-${{ matrix.java }}
         path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
@@ -84,7 +84,7 @@ jobs:
         java: [21]
         distribution: [temurin]
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Set up JDK
       uses: actions/setup-java@v5
@@ -93,15 +93,15 @@ jobs:
         java-version: ${{ matrix.java }}
 
     - name: Cache Maven
-      uses: actions/cache@v5
+      uses: actions/cache@v6
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-mvn-checkstyle-${{ hashFiles('**/pom.xml') }}
         restore-keys: |
           ${{ runner.os }}-mvn-checkstyle-
 
     - name: CheckStyle Cache
-      uses: actions/cache@v5
+      uses: actions/cache@v6
       with:
         path: '**/target/checkstyle-cachefile'
         key: ${{ runner.os }}-checkstyle-${{ hashFiles('**/pom.xml') }}
@@ -120,7 +120,7 @@ jobs:
         java: [17]
         distribution: [temurin]
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Set up JDK
       uses: actions/setup-java@v5
@@ -129,15 +129,15 @@ jobs:
         java-version: ${{ matrix.java }}
 
     - name: Cache Maven
-      uses: actions/cache@v5
+      uses: actions/cache@v6
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-mvn-pmd-${{ hashFiles('**/pom.xml') }}
         restore-keys: |
           ${{ runner.os }}-mvn-pmd-
 
     - name: PMD Cache
-      uses: actions/cache@v5
+      uses: actions/cache@v6
       with:
         path: '**/target/pmd/pmd.cache'
         key: ${{ runner.os }}-pmd-${{ hashFiles('**/pom.xml') }}
@@ -151,8 +151,8 @@ jobs:
       run: ./mvnw -B pmd:aggregate-cpd pmd:cpd-check -P pmd -DskipTests -T2C
 
     - name: Upload report
-      if: always()
-      uses: actions/upload-artifact@v6
+      if: ${{ !cancelled() }}
+      uses: actions/upload-artifact@v7
       with:
         name: pmd-report
         if-no-files-found: ignore

.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Set up JDK
       uses: actions/setup-java@v5
@@ -28,7 +28,7 @@ jobs:
 
     # Try to reuse existing cache from check-build
     - name: Try restore Maven Cache
-      uses: actions/cache/restore@v5
+      uses: actions/cache/restore@v6
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-mvn-build-${{ hashFiles('**/pom.xml') }}
@@ -63,7 +63,7 @@ jobs:
     outputs:
       upload_url: ${{ steps.create-release.outputs.upload_url }}
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Configure Git
       run: |
@@ -91,7 +91,7 @@ jobs:
 
     - name: Create Release
       id: create-release
-      uses: shogo82148/actions-create-release@559c27ce7eb834825e2b55927c64f6d1bd1db716 # v1
+      uses: shogo82148/actions-create-release@6a396031bc74c57403da1018fec74d24c6aa03cd # v1
       with:
         tag_name: v${{ steps.version.outputs.release }}
         release_name: v${{ steps.version.outputs.release }}
@@ -115,7 +115,7 @@ jobs:
     needs: [prepare-release]
     timeout-minutes: 60
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Init Git and pull
       run: |
@@ -163,7 +163,7 @@ jobs:
     needs: [prepare-release]
     timeout-minutes: 15
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Init Git and pull
       run: |
@@ -179,7 +179,7 @@ jobs:
 
     # Try to reuse existing cache from check-build
     - name: Try restore Maven Cache
-      uses: actions/cache/restore@v5
+      uses: actions/cache/restore@v6
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-mvn-build-${{ hashFiles('**/pom.xml') }}
@@ -191,7 +191,7 @@ jobs:
       working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
     - name: Deploy to Github pages
-      uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
+      uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./${{ env.PRIMARY_MAVEN_MODULE }}/target/site
@@ -202,7 +202,7 @@ jobs:
     needs: [publish-maven]
     timeout-minutes: 10
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Init Git and pull
       run: |