Merge pull request #48 from jenetics/releases/r2.1.0

#r2.1.0

Author: jenetics

README.md

@@ -10,7 +10,7 @@ _Making the JDBC usage simpler and less verbose._
 
 ## Overview
 
-JDBC is the basic API for accessing relational databases. Being basic makes it quite tedious to use directly. This lead to higher level abstractions like [JPA](https://docs.oracle.com/javaee/7/tutorial/partpersist.htm). Using a full-grown _Object Relational Mapper_ on the other side might be to heavy weight for many uses cases. _FacileJDBC_ tries to fill the gap by making the low level JDBC access less verbose and tedious. SQL is still used as query language.
+JDBC is the basic API for accessing relational databases. Being basic makes it quite tedious to use directly. This leads to higher level abstractions like [JPA](https://docs.oracle.com/javaee/7/tutorial/partpersist.htm). Using a full-grown _Object Relational Mapper_ on the other side might be to heavy weight for many uses cases. _FacileJDBC_ tries to fill the gap by making the low-level JDBC access less verbose and tedious. SQL is still used as a query language.
 
 > The API of this library has been heavily influenced by the Scala [Anorm](https://playframework.github.io/anorm/) library.
 
@@ -470,7 +470,7 @@ final Transactional db = ds::getConnection;
 
 The library is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
 
-    Copyright 2019-2021 Franz Wilhelmstötter
+    Copyright 2019-2023 Franz Wilhelmstötter
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -486,44 +486,32 @@ The library is licensed under the [Apache License, Version 2.0](http://www.apach
 
 ## Release notes
 
-### [2.0.0](https://github.com/jenetics/facilejdbc/releases/tag/v2.0.0)
+### [2.1.0](https://github.com/jenetics/facilejdbc/releases/tag/v2.1.0)
 
 #### Improvements
 
-* [#21](https://github.com/jenetics/facilejdbc/issues/21): Create `Ctor` instances from Record classes. It is now possible to create `Ctor` directly from `record` classes.
+* [#23](https://github.com/jenetics/facilejdbc/issues/23): Implementation of `Stored` class.
 ```java
-// Simple `Dctor` creation.
-final Dctor<Book> dctor = Dctor.of(Book.class);
+// Reading 'Link' objects from db.
+final List<Stored<Long, Link>> links = select
+	.as(LINK_PARSER.stored("id").list(), conn);
 
-// Adapt the name conversion.
-final Dctor<Book> dctor = Records.dctor(
-    Book.class,
-    component -> switch (component.getName()) {
-        case "author" -> "primary_author";
-        case "isbn" -> "isbn13";
-        default -> Records.toSnakeCase(component);
-    }
-);
+// Printing the result + its DB ids.
+links.forEach(System.out::println);
 
-// Add additional columns.
-final Dctor<Book> dctor = Records.dctor(
-    Book.class,
-    field("title_hash", book -> book.title().hashCode())
-);
+// > Stored[id=1, value=Link[http://jenetics.io, text=null, type=null]]
+// > Stored[id=2, value=Link[http://jenetics.io, text=Jenetics, type=web]]
+// > Stored[id=3, value=Link[https://duckduckgo.com, text=DuckDuckGo, type=search]]
 ```
-* [#43](https://github.com/jenetics/facilejdbc/issues/43): Create `RowParser` instances from `record` classes.
+* [#49](https://github.com/jenetics/facilejdbc/issues/49): Implement `PreparedQuery` class.
 ```java
-// Simple `RowParser` creation.
-final RowParser<Book> parser = RowParser.of(Book.class);
-
-// Adapting the record component parsing.
-final RowParser<Book> parser = Records.parserWithFields(
-    Book.class,
-    Map.of(
-        "isbn", string("isbn").map(Isbn::new),
-        "authors", int64("id").map(Author::selectByBookId)
-    )
-);
+final var query = INSERT_LINK.prepareQuery(conn);
+final var batch = Batch.of(links, LINK_DCTOR);
+query.execute(batch);
 ```
 
+#### Bug
+
+* [#23](https://github.com/jenetics/facilejdbc/issues/23): Remove wrong `null` check in `Param` factory method.
+
 _[All Release Notes](RELEASE_NOTES.md)_

RELEASE_NOTES.md

@@ -1,5 +1,33 @@
 ## Release notes
 
+### [2.1.0](https://github.com/jenetics/facilejdbc/releases/tag/v2.1.0)
+
+#### Improvements
+
+* [#23](https://github.com/jenetics/facilejdbc/issues/23): Implementation of `Stored` class.
+```java
+// Reading 'Link' objects from db.
+final List<Stored<Long, Link>> links = select
+	.as(LINK_PARSER.stored("id").list(), conn);
+
+// Printing the result + its DB ids.
+links.forEach(System.out::println);
+
+// > Stored[id=1, value=Link[http://jenetics.io, text=null, type=null]]
+// > Stored[id=2, value=Link[http://jenetics.io, text=Jenetics, type=web]]
+// > Stored[id=3, value=Link[https://duckduckgo.com, text=DuckDuckGo, type=search]]
+```
+* [#49](https://github.com/jenetics/facilejdbc/issues/49): Implement `PreparedQuery` class.
+```java
+final var query = INSERT_LINK.prepareQuery(conn);
+final var batch = Batch.of(links, LINK_DCTOR);
+query.execute(batch);
+```
+
+#### Bug
+
+* [#23](https://github.com/jenetics/facilejdbc/issues/23): Remove wrong `null` check in `Param` factory method.
+
 ### [2.0.0](https://github.com/jenetics/facilejdbc/releases/tag/v2.0.0)
 
 #### Improvements

build.gradle.kts

@@ -27,13 +27,13 @@
 
 plugins {
 	base
-	id("me.champeau.jmh") version "0.6.6" apply false
+	alias(libs.plugins.jmh)
 }
 
 rootProject.version = FacileJDBC.VERSION
 
 tasks.named<Wrapper>("wrapper") {
-	version = "7.3"
+	version = "8.4"
 	distributionType = Wrapper.DistributionType.ALL
 }
 
@@ -74,6 +74,10 @@ gradle.projectsEvaluated {
 				targetCompatibility = JavaVersion.VERSION_17
 			}
 
+			configure<JavaPluginExtension> {
+				modularity.inferModulePath.set(true)
+			}
+
 			setupJava(project)
 			setupTestReporting(project)
 			setupJavadoc(project)
@@ -127,7 +131,7 @@ fun setupTestReporting(project: Project) {
 	project.apply(plugin = "jacoco")
 
 	project.configure<JacocoPluginExtension> {
-		toolVersion = "0.8.7"
+		toolVersion = "0.8.11"
 	}
 
 	project.tasks {

buildSrc/build.gradle.kts

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
 /*
  * Facile JDBC Library (@__identifier__@).
  * Copyright (c) @__year__@ Franz Wilhelmstötter
@@ -34,6 +36,10 @@ repositories {
 	gradlePluginPortal()
 }
 
+tasks.withType<KotlinCompile>().configureEach {
+	kotlinOptions.jvmTarget = "17"
+}
+
 configure<JavaPluginExtension> {
 	sourceCompatibility = JavaVersion.VERSION_17
 	targetCompatibility = JavaVersion.VERSION_17

buildSrc/src/main/kotlin/Env.kt

@@ -52,7 +52,7 @@ object Env {
  * Information about the library and author.
  */
 object FacileJDBC {
-	const val VERSION = "2.0.0"
+	const val VERSION = "2.1.0"
 	const val ID = "facilejdbc"
 	const val NAME = "facilejdbc"
 	const val GROUP = "io.jenetics"

facilejdbc/src/main/java/io/jenetics/facilejdbc/Batch.java

@@ -30,7 +30,7 @@
 /**
  * Represents a whole batch of query parameter values. A <em>batch</em> is
  * essentially an {@link Iterable} of records or row-creation functions. The
- * available factory functions makes it easy to create a batch from a given
+ * available factory functions make it easy to create a batch from a given
  * list of records or parameters.
  *
  * <pre>{@code

facilejdbc/src/main/java/io/jenetics/facilejdbc/CSV.java

@@ -25,7 +25,7 @@
 import java.util.Arrays;
 
 /**
- * Helper class for exporting DB result to CSV string.
+ * Helper class for exporting a DB result to CSV string.
  *
  * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
  * @version 1.3

facilejdbc/src/main/java/io/jenetics/facilejdbc/Param.java

@@ -33,7 +33,7 @@
  * This is the  base interface of the {@link SingleParam} and {@link MultiParam}
  * class.
  * <p>
- * Creating single valued parameters:
+ * Creating single-valued parameters:
  * <pre>{@code
  * INSERT_QUERY.on(
  *     Param.value("forename", "Werner"),
@@ -84,7 +84,6 @@ public sealed interface Param permits SingleParam, MultiParam {
 	 *         {@code null}
 	 */
 	static SingleParam value(final String name, final Object value) {
-		requireNonNull(value);
 		return SingleParam.of(
 			name,
 			(idx, stmt) -> stmt.setObject(idx, map(value))

facilejdbc/src/main/java/io/jenetics/facilejdbc/ParamValue.java

@@ -23,7 +23,7 @@
 import java.sql.SQLException;
 
 /**
- * Represents a SQL value which can be set to a prepared statement. Instead of
+ * Represents an SQL value which can be set to a prepared statement. Instead of
  * representing the parameter value directly, a value is defined by it's
  * <em>insertion</em> strategy.
  *

facilejdbc/src/main/java/io/jenetics/facilejdbc/ParamValues.java

@@ -45,7 +45,7 @@ public interface ParamValues {
 	ParamValues EMPTY = (params, stmt) -> {};
 
 	/**
-	 * Fills the parameters of the given statement.
+	 * Fills the parameters with the given statement.
 	 *
 	 * @param paramNames the list of parameter names which should be set, if
 	 *        available by this {@code ParamValues} object. The list of parameter
@@ -60,8 +60,8 @@ void set(final List<String> paramNames, final PreparedStatement stmt)
 	/**
 	 * Returns a composed {@code SqlParamValues} that performs, in sequence,
 	 * {@code this} operation followed by the {@code after} operation. If
-	 * performing either operation throws an exception, it is relayed to the
-	 * caller of the composed operation. If performing this operation throws an
+	 * performing either operation, throws an exception, it is relayed to the
+	 * caller of the composed operation. If performing this operation, throws an
 	 * exception, the after operation will not be performed.
 	 *
 	 * @param after the preparer to perform after {@code this} preparer