Merge pull request #497 from xdev-software/develop

Release

Author: AB-xdev

.config/checkstyle/checkstyle.xml

@@ -79,6 +79,11 @@
 			<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))$).+$"/>
+			<property name="tokens" value=" CLASS_DEF"/>
+		</module>
 		<module name="IllegalImport"/>
 		<module name="InterfaceIsType"/>
 		<module name="JavadocStyle">

.config/pmd/java/ruleset.xml

@@ -146,7 +146,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"/>
@@ -164,6 +163,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 +208,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"

.github/workflows/broken-links.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2
         with:
           fail: false # Don't fail on broken links, create an issue instead
 

.github/workflows/check-build.yml

@@ -69,15 +69,15 @@ 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
         if-no-files-found: error
 
     - name: Upload screenshots of test failures
       if: failure()
-      uses: actions/upload-artifact@v6
+      uses: actions/upload-artifact@v7
       with:
         name: test-fail-screenshots-${{ matrix.java }}
         path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/screenshots
@@ -160,7 +160,7 @@ jobs:
 
     - name: Upload report
       if: always()
-      uses: actions/upload-artifact@v6
+      uses: actions/upload-artifact@v7
       with:
         name: pmd-report
         if-no-files-found: ignore

.github/workflows/report-gha-workflow-security-problems.yml

@@ -0,0 +1,61 @@
+name: Report workflow security problems
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ develop ]
+    paths:
+      - '.github/workflows/**'
+
+permissions:
+  issues: write
+
+jobs:
+  prt:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    # Only run this in our repos (Prevent notification spam by forks)
+    if: ${{ github.repository_owner == 'xdev-software' }}
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Check
+        id: check
+        run: |
+          grep -l 'pull_request_target:' --exclude report-gha-workflow-security-problems.yml *.yml > reported.txt && exit 1 || exit 0
+        working-directory: .github/workflows
+
+      - name: Find already existing issue
+        id: find-issue
+        if: ${{ !cancelled() }}
+        run: |
+          echo "number=$(gh issue list -l 'bug' -l 'automated' -L 1 -S 'in:title "Incorrectly configure GHA workflow (prt)"' -s 'open' --json 'number' --jq '.[].number')" >> $GITHUB_OUTPUT
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Close issue if everything is fine
+        if: ${{ success() && steps.find-issue.outputs.number != '' }}
+        run: gh issue close -r 'not planned' ${{ steps.find-issue.outputs.number }}
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Create report
+        if: ${{ failure() && steps.check.conclusion == 'failure' }}
+        run: |
+          echo 'Detected usage of `pull_request_target`. This event is dangerous and MUST NOT BE USED AT ALL COST!' > reported.md
+          echo '' >> reported.md
+          echo '/cc @xdev-software/gha-workflow-security' >> reported.md
+          echo '' >> reported.md
+          echo '```' >> reported.md
+          cat .github/workflows/reported.txt >> reported.md
+          echo '```' >> reported.md
+          cat reported.md
+
+      - name: Create Issue From File
+        if: ${{ failure() && steps.check.conclusion == 'failure' }}
+        uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710 # v6
+        with:
+          issue-number: ${{ steps.find-issue.outputs.number }}
+          title: 'Incorrectly configure GHA workflow (prt)'
+          content-filepath: ./reported.md
+          labels: bug, automated

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 3.0.1
+* Updated dependencies
+
 # 3.0.0
 _Java 17 is now required_
 * Updated dependencies

chartjs-java-model-demo/pom.xml

@@ -44,7 +44,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-compiler-plugin</artifactId>
-				<version>3.14.1</version>
+				<version>3.15.0</version>
 				<configuration>
 					<release>${maven.compiler.release}</release>
 					<compilerArgs>

chartjs-java-model/pom.xml

@@ -59,7 +59,7 @@
 		<dependency>
 			<groupId>tools.jackson.core</groupId>
 			<artifactId>jackson-databind</artifactId>
-			<version>3.0.3</version>
+			<version>3.1.0</version>
 		</dependency>
 
 		<!-- Tests -->
@@ -93,7 +93,7 @@
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter</artifactId>
-			<version>6.0.2</version>
+			<version>6.0.3</version>
 			<scope>test</scope>
 		</dependency>
 
@@ -107,15 +107,15 @@
 		<dependency>
 			<groupId>software.xdev</groupId>
 			<artifactId>testcontainers-selenium</artifactId>
-			<version>1.5.1</version>
+			<version>1.5.3</version>
 			<scope>test</scope>
 		</dependency>
 
 		<!-- Selenium -->
 		<dependency>
 			<groupId>org.seleniumhq.selenium</groupId>
 			<artifactId>selenium-chrome-driver</artifactId>
-			<version>4.40.0</version>
+			<version>4.41.0</version>
 			<scope>test</scope>
 			<exclusions>
 				<!-- Tracing is not needed -->
@@ -175,7 +175,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-compiler-plugin</artifactId>
-				<version>3.14.1</version>
+				<version>3.15.0</version>
 				<configuration>
 					<release>${maven.compiler.release}</release>
 					<compilerArgs>
@@ -219,7 +219,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-surefire-plugin</artifactId>
-				<version>3.5.4</version>
+				<version>3.5.5</version>
 				<configuration>
 					<skipTests>${skipTests}</skipTests>
 				</configuration>
@@ -308,7 +308,7 @@
 							<dependency>
 								<groupId>com.puppycrawl.tools</groupId>
 								<artifactId>checkstyle</artifactId>
-								<version>13.0.0</version>
+								<version>13.3.0</version>
 							</dependency>
 						</dependencies>
 						<configuration>
@@ -346,12 +346,12 @@
 							<dependency>
 								<groupId>net.sourceforge.pmd</groupId>
 								<artifactId>pmd-core</artifactId>
-								<version>7.20.0</version>
+								<version>7.22.0</version>
 							</dependency>
 							<dependency>
 								<groupId>net.sourceforge.pmd</groupId>
 								<artifactId>pmd-java</artifactId>
-								<version>7.20.0</version>
+								<version>7.22.0</version>
 							</dependency>
 						</dependencies>
 					</plugin>

chartjs-java-model/src/test/java/software/xdev/chartjs/model/BasicChartTest.java

@@ -185,35 +185,11 @@ private static <D extends HomogeneousData<D, S>, S extends Dataset<S, O>, O> Sup
 		};
 	}
 
-	public static class ArgumentDTO<O extends Options<?, ?>, D extends AbstractData<?, ?>>
+	public record ArgumentDTO<O extends Options<?, ?>, D extends AbstractData<?, ?>>(
+		Supplier<Chart<?, O, D>> chartSupplier,
+		Supplier<O> optionsSupplier,
+		Supplier<D> dataSupplier
+	)
 	{
-		private final Supplier<Chart<?, O, D>> chartSupplier;
-		private final Supplier<O> optionsSupplier;
-		private final Supplier<D> dataSupplier;
-		
-		public ArgumentDTO(
-			final Supplier<Chart<?, O, D>> chartSupplier,
-			final Supplier<O> optionsSupplier,
-			final Supplier<D> dataSupplier)
-		{
-			this.chartSupplier = chartSupplier;
-			this.optionsSupplier = optionsSupplier;
-			this.dataSupplier = dataSupplier;
-		}
-		
-		public Supplier<Chart<?, O, D>> chartSupplier()
-		{
-			return this.chartSupplier;
-		}
-		
-		public Supplier<O> optionsSupplier()
-		{
-			return this.optionsSupplier;
-		}
-		
-		public Supplier<D> dataSupplier()
-		{
-			return this.dataSupplier;
-		}
 	}
 }

chartjs-java-model/src/test/java/software/xdev/chartjs/model/ChartAxisFormatTest.java

@@ -51,40 +51,11 @@ void format()
 			"Format");
 	}
 
-	public static class CurrencyFormatOptions
+	public record CurrencyFormatOptions(
+		String style,
+		String currency
+	)
 	{
-		private String style;
-		private String currency;
-		
-		public CurrencyFormatOptions()
-		{
-		}
-		
-		public CurrencyFormatOptions(final String style, final String currency)
-		{
-			this.style = style;
-			this.currency = currency;
-		}
-		
-		public String getStyle()
-		{
-			return this.style;
-		}
-		
-		public void setStyle(final String style)
-		{
-			this.style = style;
-		}
-		
-		public String getCurrency()
-		{
-			return this.currency;
-		}
-		
-		public void setCurrency(final String currency)
-		{
-			this.currency = currency;
-		}
 	}
 
 	static BarData data()