#186 - use default creator if none provided

jenetics · Jan 9, 2025 · 699eea6 · 699eea6
1 parent 276ea08
commit 699eea6
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 7 deletions.
diff --git a/jpx/src/main/java/io/jenetics/jpx/GPX.java b/jpx/src/main/java/io/jenetics/jpx/GPX.java
@@ -302,7 +302,9 @@ public static Version of(final String version) {
 	 *
 	 * @param creator the name or URL of the software that created your GPX
 	 *        document. This allows others to inform the creator of a GPX
-	 *        instance document that fails to validate.
+	 *        instance document that fails to validate. If the {@code creator}
+	 *        is {@code null}, {@code "JPX - https://github.com/jenetics/jpx"}
+	 *        is used instead.
 	 * @param version the GPX version
 	 * @param metadata the metadata about the GPS file
 	 * @param wayPoints the way-points
@@ -322,7 +324,7 @@ private GPX(
 		final Document extensions
 	) {
 		_version = requireNonNull(version);
-		_creator = creator;
+		_creator = creator != null ? creator : _CREATOR;
 		_metadata = metadata;
 		_wayPoints = copyOf(wayPoints);
 		_routes = copyOf(routes);
@@ -1701,7 +1703,9 @@ public static Writer of(final Indent indent) {
 	 *
 	 * @param creator the name or URL of the software that created your GPX
 	 *        document. This allows others to inform the creator of a GPX
-	 *        instance document that fails to validate.
+	 *        instance document that fails to validate. If the {@code creator}
+	 *        is {@code null}, {@code "JPX - https://github.com/jenetics/jpx"}
+	 *        is used instead.
 	 * @param  version the GPX version
 	 * @param metadata the metadata about the GPS file
 	 * @param wayPoints the way-points
@@ -1737,7 +1741,9 @@ public static GPX of(
 	 *
 	 * @param creator the name or URL of the software that created your GPX
 	 *        document. This allows others to inform the creator of a GPX
-	 *        instance document that fails to validate.
+	 *        instance document that fails to validate. If the {@code creator}
+	 *        is {@code null}, {@code "JPX - https://github.com/jenetics/jpx"}
+	 *        is used instead.
 	 * @param metadata the metadata about the GPS file
 	 * @param wayPoints the way-points
 	 * @param routes the routes
@@ -1771,7 +1777,9 @@ public static GPX of(
 	 *
 	 * @param creator the name or URL of the software that created your GPX
 	 *        document. This allows others to inform the creator of a GPX
-	 *        instance document that fails to validate.
+	 *        instance document that fails to validate. If the {@code creator}
+	 *        is {@code null}, {@code "JPX - https://github.com/jenetics/jpx"}
+	 *        is used instead.
 	 * @param metadata the metadata about the GPS file
 	 * @param wayPoints the way-points
 	 * @param routes the routes
@@ -1805,7 +1813,9 @@ public static GPX of(
 	 *
 	 * @param creator the name or URL of the software that created your GPX
 	 *        document. This allows others to inform the creator of a GPX
-	 *        instance document that fails to validate.
+	 *        instance document that fails to validate. If the {@code creator}
+	 *        is {@code null}, {@code "JPX - https://github.com/jenetics/jpx"}
+	 *        is used instead.
 	 * @param  version the GPX version
 	 * @param metadata the metadata about the GPS file
 	 * @param wayPoints the way-points

diff --git a/jpx/src/test/java/io/jenetics/jpx/GPXTest.java b/jpx/src/test/java/io/jenetics/jpx/GPXTest.java
@@ -969,7 +969,7 @@ public void issue186_MissingCreator() throws IOException {
 		}
 
 		assertThat(gpx_lenient.getVersion()).isEqualTo("1.1");
-		assertThat(gpx_lenient.getCreator()).isNull();
+		assertThat(gpx_lenient.getCreator()).isEqualTo("JPX - https://github.com/jenetics/jpx");
 		assertThat(gpx_lenient.getTracks()).hasSize(1);
 		assertThat(gpx_lenient.getTracks().get(0).getSegments()).hasSize(1);
 		assertThat(gpx_lenient.getTracks().get(0).getSegments().get(0)).hasSize(9);
@@ -983,8 +983,22 @@ public void issue186_MissingCreator() throws IOException {
 		} catch (Exception e) {
 			Assert.fail("Unexpected exception was thrown: " + e);
 		}
+	}
 
+	@Test
+	public void issue186_NullCreator() throws IOException {
+		Random random = new Random();
+		GPX createGPX = GPX.of(
+			Version.V11,
+			null,
+			random.nextBoolean() ? MetadataTest.nextMetadata(random) : null,
+			random.nextBoolean() ? WayPointTest.nextWayPoints(random) : null,
+			random.nextBoolean() ? RouteTest.nextRoutes(random) : null,
+			random.nextBoolean() ? TrackTest.nextTracks(random) : null,
+			random.nextBoolean() ? doc() : null
+		);
 
+		assertThat(createGPX.getCreator()).isEqualTo("JPX - https://github.com/jenetics/jpx");
 	}
 
 }