Incorporate DatabasePopulator feedback

Refactor DatabasePopulatorUtils.execute(…) into default method
DatabasePopulator.populate(…).
Add support for commentPrefixes in ResourceDatabasePopulator.

Consistently use code instead of literal in Javadoc for boolean
and null values.

Author: mp911de

spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/R2dbcTransactionManager.java

@@ -138,7 +138,7 @@ public ConnectionFactory getConnectionFactory() {
 	/**
 	 * Obtain the {@link ConnectionFactory} for actual use.
 	 *
-	 * @return the {@link ConnectionFactory} (never {@literal null})
+	 * @return the {@link ConnectionFactory} (never {@code null})
 	 * @throws IllegalStateException in case of no ConnectionFactory set
 	 */
 	protected ConnectionFactory obtainConnectionFactory() {
@@ -382,7 +382,7 @@ protected Mono<Void> doCleanupAfterCompletion(TransactionSynchronizationManager
 	 * Prepare the transactional {@link Connection} right after transaction begin.
 	 * <p>
 	 * The default implementation executes a "SET TRANSACTION READ ONLY" statement if the {@link #setEnforceReadOnly
-	 * "enforceReadOnly"} flag is set to {@literal true} and the transaction definition indicates a read-only transaction.
+	 * "enforceReadOnly"} flag is set to {@code true} and the transaction definition indicates a read-only transaction.
 	 * <p>
 	 * The "SET TRANSACTION READ ONLY" is understood by Oracle, MySQL and Postgres and may work with other databases as
 	 * well. If you'd like to adapt this treatment, override this method accordingly.
@@ -441,7 +441,7 @@ protected Mono<Void> prepareTransactionalConnection(Connection con, TransactionD
 	 * {@link IsolationLevel}s, override this method accordingly.
 	 *
 	 * @param isolationLevel the isolation level to translate.
-	 * @return the resolved isolation level. Can be {@literal null} if not resolvable or the isolation level should remain
+	 * @return the resolved isolation level. Can be {@code null} if not resolvable or the isolation level should remain
 	 *         {@link TransactionDefinition#ISOLATION_DEFAULT default}.
 	 * @see TransactionDefinition#getIsolationLevel()
 	 */

spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/init/ConnectionFactoryInitializer.java

@@ -83,7 +83,7 @@ public void setDatabaseCleaner(DatabasePopulator databaseCleaner) {
 	 * Flag to explicitly enable or disable the {@link #setDatabasePopulator database populator} and
 	 * {@link #setDatabaseCleaner database cleaner}.
 	 *
-	 * @param enabled {@literal true} if the database populator and database cleaner should be called on startup and
+	 * @param enabled {@code true} if the database populator and database cleaner should be called on startup and
 	 *          shutdown, respectively
 	 */
 	public void setEnabled(boolean enabled) {

spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/init/DatabasePopulator.java

@@ -49,7 +49,6 @@ public interface DatabasePopulator {
 
 	/**
 	 * Execute the given {@link DatabasePopulator} against the given {@link ConnectionFactory}.
-	 * @param populator the {@link DatabasePopulator} to execute
 	 * @param connectionFactory the {@link ConnectionFactory} to execute against
 	 * @return {@link Mono} that initiates {@link DatabasePopulator#populate(Connection)}
 	 * and is notified upon completion

spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/init/ScriptUtils.java

@@ -76,7 +76,7 @@ public abstract class ScriptUtils {
 	/**
 	 * End of file (EOF) SQL statement separator: {@code "^^^ END OF SCRIPT ^^^"}.
 	 * <p>This value may be supplied as the {@code separator} to {@link
-	 * #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)}
+	 * #executeSqlScript(Connection, EncodedResource, DataBufferFactory, boolean, boolean, String[], String, String, String)}
 	 * to denote that an SQL script contains a single statement (potentially
 	 * spanning multiple lines) with no explicit statement separator. Note that
 	 * such a script should not actually contain this value; it is merely a
@@ -373,7 +373,6 @@ private static Mono<String> readScript(EncodedResource resource, DataBufferFacto
 	 */
 	public static String readScript(LineNumberReader lineNumberReader, @Nullable String lineCommentPrefix,
 			@Nullable String separator, @Nullable String blockCommentEndDelimiter) throws IOException {
-
 		String[] lineCommentPrefixes = (lineCommentPrefix != null) ? new String[] { lineCommentPrefix } : null;
 		return readScript(lineNumberReader, lineCommentPrefixes, separator, blockCommentEndDelimiter);
 	}
@@ -480,7 +479,7 @@ public static boolean containsSqlScriptDelimiters(String script, String delim) {
 	 * @param resource the resource to load the SQL script from; encoded with the
 	 * current platform's default encoding
 	 * @throws ScriptException if an error occurred while executing the SQL script
-	 * @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)
+	 * @see #executeSqlScript(Connection, EncodedResource, DataBufferFactory, boolean, boolean, String[], String, String, String)
 	 * @see #DEFAULT_STATEMENT_SEPARATOR
 	 * @see #DEFAULT_COMMENT_PREFIX
 	 * @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER
@@ -504,7 +503,7 @@ public static Mono<Void> executeSqlScript(Connection connection, Resource resour
 	 * @param resource the resource (potentially associated with a specific encoding)
 	 * to load the SQL script from
 	 * @throws ScriptException if an error occurred while executing the SQL script
-	 * @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)
+	 * @see #executeSqlScript(Connection, EncodedResource, DataBufferFactory, boolean, boolean, String[], String, String, String)
 	 * @see #DEFAULT_STATEMENT_SEPARATOR
 	 * @see #DEFAULT_COMMENT_PREFIX
 	 * @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER

spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/lookup/AbstractRoutingConnectionFactory.java

@@ -104,11 +104,11 @@ public void setDefaultTargetConnectionFactory(Object defaultTargetConnectionFact
 	 * Specify whether to apply a lenient fallback to the default {@link ConnectionFactory}
 	 * if no specific {@link ConnectionFactory} could be found for the current lookup key.
 	 *
-	 * <p>Default is {@literal true}, accepting lookup keys without a corresponding entry
+	 * <p>Default is {@code true}, accepting lookup keys without a corresponding entry
 	 * in the target {@link ConnectionFactory} map - simply falling back to the default
 	 * {@link ConnectionFactory} in that case.
 	 *
-	 * <p>Switch this flag to {@literal false} if you would prefer the fallback to only
+	 * <p>Switch this flag to {@code false} if you would prefer the fallback to only
 	 * apply when no lookup key was emitted. Lookup keys without a {@link ConnectionFactory}
 	 * entry will then lead to an {@link IllegalStateException}.
 	 * @see #setTargetConnectionFactories

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/BindParameterSource.java

@@ -39,14 +39,14 @@ interface BindParameterSource {
 	/**
 	 * Determine whether there is a value for the specified named parameter.
 	 * @param paramName the name of the parameter
-	 * @return {@literal true} if there is a value defined; {@literal false} otherwise
+	 * @return {@code true} if there is a value defined; {@code false} otherwise
 	 */
 	boolean hasValue(String paramName);
 
 	/**
 	 * Return the parameter value for the requested named parameter.
 	 * @param paramName the name of the parameter
-	 * @return the value of the specified parameter, can be {@literal null}
+	 * @return the value of the specified parameter, can be {@code null}
 	 * @throws IllegalArgumentException if there is no value
 	 * for the requested parameter
 	 */

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/DatabaseClient.java

@@ -129,9 +129,9 @@ interface Builder {
 		Builder executeFunction(ExecuteFunction executeFunction);
 
 		/**
-		 * Configure whether to use named parameter expansion. Defaults to {@literal true}.
-		 * @param enabled {@literal true} to use named parameter expansion.
-		 * {@literal false} to disable named parameter expansion.
+		 * Configure whether to use named parameter expansion. Defaults to {@code true}.
+		 * @param enabled {@code true} to use named parameter expansion.
+		 * {@code false} to disable named parameter expansion.
 		 * @see NamedParameterExpander
 		 */
 		Builder namedParameters(boolean enabled);

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/Parameter.java

@@ -93,15 +93,15 @@ public Class<?> getType() {
 
 	/**
 	 * Returns whether this {@link Parameter} has a value.
-	 * @return whether this {@link Parameter} has a value. {@literal false} if {@link #getValue()} is {@code null}
+	 * @return whether this {@link Parameter} has a value. {@code false} if {@link #getValue()} is {@code null}
 	 */
 	public boolean hasValue() {
 		return this.value != null;
 	}
 
 	/**
 	 * Returns whether this {@link Parameter} has a empty.
-	 * @return whether this {@link Parameter} is empty. {@literal true} if {@link #getValue()} is {@code null}
+	 * @return whether this {@link Parameter} is empty. {@code true} if {@link #getValue()} is {@code null}
 	 */
 	public boolean isEmpty() {
 		return this.value == null;

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/binding/BindMarkersFactory.java

@@ -48,7 +48,7 @@ public interface BindMarkersFactory {
 	 * Return whether the {@link BindMarkersFactory} uses identifiable
 	 * placeholders.
 	 * @return whether the {@link BindMarkersFactory} uses identifiable
-	 * placeholders. {@literal false} if multiple placeholders cannot be
+	 * placeholders. {@code false} if multiple placeholders cannot be
 	 * distinguished by just the {@link BindMarker#getPlaceholder() placeholder}
 	 * identifier.
 	 */

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/binding/Bindings.java

@@ -162,14 +162,14 @@ public BindMarker getBindMarker() {
 
 		/**
 		 * Return whether the binding has a value associated with it.
-		 * @return {@literal true} if there is a value present, otherwise {@literal false}
+		 * @return {@code true} if there is a value present, otherwise {@code false}
 		 * for a {@code NULL} binding.
 		 */
 		public abstract boolean hasValue();
 
 		/**
 		 * Return whether the binding is empty.
-		 * @return {@literal true} if this is is a {@code NULL} binding
+		 * @return {@code true} if this is is a {@code NULL} binding
 		 */
 		public boolean isNull() {
 			return !hasValue();

spring-r2dbc/src/test/java/org/springframework/r2dbc/connection/init/AbstractDatabaseInitializationTests.java

@@ -37,6 +37,7 @@ public abstract class AbstractDatabaseInitializationTests {
 
 	ResourceDatabasePopulator databasePopulator = new ResourceDatabasePopulator();
 
+
 	@Test
 	public void scriptWithSingleLineCommentsAndFailedDrop() {
 		databasePopulator.addScript(resource("db-schema-failed-drop-comments.sql"));

spring-r2dbc/src/test/java/org/springframework/r2dbc/connection/init/CompositeDatabasePopulatorTests.java

@@ -43,6 +43,7 @@ public class CompositeDatabasePopulatorTests {
 
 	DatabasePopulator mockedDatabasePopulator2 = mock(DatabasePopulator.class);
 
+
 	@BeforeEach
 	public void before() {
 		when(mockedDatabasePopulator1.populate(mockedConnection)).thenReturn(

spring-r2dbc/src/test/java/org/springframework/r2dbc/connection/init/ConnectionFactoryInitializerUnitTests.java

@@ -24,7 +24,6 @@
 import reactor.core.publisher.Mono;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.BDDMockito.mock;
 import static org.mockito.BDDMockito.when;
 
@@ -44,9 +43,10 @@ public class ConnectionFactoryInitializerUnitTests {
 	MockConnectionFactory connectionFactory = MockConnectionFactory.builder().connection(
 			connection).build();
 
+
 	@Test
 	public void shouldInitializeConnectionFactory() {
-		when(populator.populate(any())).thenReturn(
+		when(populator.populate(connectionFactory)).thenReturn(
 				Mono.<Void> empty().doOnSubscribe(subscription -> called.set(true)));
 
 		ConnectionFactoryInitializer initializer = new ConnectionFactoryInitializer();
@@ -60,7 +60,7 @@ public void shouldInitializeConnectionFactory() {
 
 	@Test
 	public void shouldCleanConnectionFactory() {
-		when(populator.populate(any())).thenReturn(
+		when(populator.populate(connectionFactory)).thenReturn(
 				Mono.<Void> empty().doOnSubscribe(subscription -> called.set(true)));
 
 		ConnectionFactoryInitializer initializer = new ConnectionFactoryInitializer();

spring-r2dbc/src/test/java/org/springframework/r2dbc/connection/init/H2DatabasePopulatorIntegrationTests.java

@@ -36,6 +36,7 @@ public class H2DatabasePopulatorIntegrationTests
 	ConnectionFactory connectionFactory = ConnectionFactories.get("r2dbc:h2:mem:///"
 			+ databaseName + "?options=DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE");
 
+
 	@Override
 	ConnectionFactory getConnectionFactory() {
 		return this.connectionFactory;

spring-r2dbc/src/test/java/org/springframework/r2dbc/connection/init/ResourceDatabasePopulatorUnitTests.java

@@ -37,6 +37,7 @@ public class ResourceDatabasePopulatorUnitTests {
 
 	private static final Resource script3 = mock(Resource.class);
 
+
 	@Test
 	public void constructWithNullResource() {
 		assertThatIllegalArgumentException().isThrownBy(

spring-r2dbc/src/test/java/org/springframework/r2dbc/connection/init/ScriptUtilsUnitTests.java

@@ -31,6 +31,11 @@
 /**
  * Unit tests for {@link ScriptUtils}.
  *
+ * @author Thomas Risberg
+ * @author Sam Brannen
+ * @author Phillip Webb
+ * @author Chris Baldwin
+ * @author Nicolas Debeissat
  * @author Mark Paluch
  */
 public class ScriptUtilsUnitTests {