[
{
"path": ".circleci/config.yml",
"content": "version: 2\njobs:\n build:\n\n working_directory: ~/DbSetup\n\n docker:\n - image: circleci/openjdk:8-jdk\n\n steps:\n\n - checkout\n - run: ./gradlew build\n - store_test_results:\n path: DbSetup-core/build/test-results/test\n - store_test_results:\n path: DbSetup-kotlin/build/test-results/test\n"
},
{
"path": ".gitignore",
"content": "/.project\n.gradle\n/.settings\n/bin\nbuild/\n/.classpath\n/.classpath.idea/\n/.java-version\n*.iml\n.idea\nout\nclasses\n.sdkmanrc\n"
},
{
"path": "DbSetup-core/build.gradle.kts",
"content": "plugins {\n `java-library-convention`\n}\n\nproject.description = \"Helps you setup your database with test data\"\n\njava {\n withJavadocJar()\n}\n\ndependencies {\n compileOnly(\"com.google.code.findbugs:jsr305:2.0.0\")\n compileOnly(\"net.sourceforge.findbugs:annotations:1.3.2\")\n\n testImplementation(\"junit:junit:4.+\")\n testImplementation(\"org.mockito:mockito-all:1.9.0\")\n testImplementation(\"org.hsqldb:hsqldb:2.3.3\")\n}\n\ntasks {\n javadoc {\n (options as StandardJavadocDocletOptions).apply {\n overview(file(\"src/main/java/com/ninja_squad/dbsetup/overview.html\").path)\n noTimestamp(true)\n linkSource(true)\n addBooleanOption(\"Xdoclint:all,-missing\", true)\n }\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/DbSetup.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup;\n\nimport java.sql.Connection;\nimport java.sql.SQLException;\n\nimport javax.annotation.Nonnull;\n\nimport com.ninja_squad.dbsetup.bind.BinderConfiguration;\nimport com.ninja_squad.dbsetup.bind.DefaultBinderConfiguration;\nimport com.ninja_squad.dbsetup.destination.Destination;\nimport com.ninja_squad.dbsetup.operation.Operation;\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\n/**\n * Allows executing a sequence of database operations. This object is reusable, and can thus be used several times\n * to launch the same sequence of database operations. Here's a typical usage scenario in a unit test:\n *
\n * In the above code, CommonOperations.DELETE_ALL and CommonOperations.INSERT_REFERENCE_DATA\n * are operations shared by multiple test classes.\n *
\n * Note that, to speed up test executions, a {@link DbSetupTracker} can be used, at the price of a slightly\n * bigger complexity.\n * @author JB Nizet\n */\npublic final class DbSetup {\n private final Destination destination;\n private final Operation operation;\n private final BinderConfiguration binderConfiguration;\n\n /**\n * Constructor which uses the {@link DefaultBinderConfiguration#INSTANCE default binder configuration}.\n * @param destination the destination of the sequence of database operations\n * @param operation the operation to execute (most of the time, an instance of\n * {@link com.ninja_squad.dbsetup.operation.CompositeOperation}\n */\n public DbSetup(@Nonnull Destination destination, @Nonnull Operation operation) {\n this(destination, operation, DefaultBinderConfiguration.INSTANCE);\n }\n\n /**\n * Constructor allowing to use a custom {@link BinderConfiguration}.\n * @param destination the destination of the sequence of database operations\n * @param operation the operation to execute (most of the time, an instance of\n * {@link com.ninja_squad.dbsetup.operation.CompositeOperation}\n * @param binderConfiguration the binder configuration to use.\n */\n public DbSetup(@Nonnull Destination destination,\n @Nonnull Operation operation,\n @Nonnull BinderConfiguration binderConfiguration) {\n Preconditions.checkNotNull(destination, \"destination may not be null\");\n Preconditions.checkNotNull(operation, \"operation may not be null\");\n Preconditions.checkNotNull(binderConfiguration, \"binderConfiguration may not be null\");\n\n this.destination = destination;\n this.operation = operation;\n this.binderConfiguration = binderConfiguration;\n }\n\n /**\n * Executes the sequence of operations. All the operations use the same connection, and are grouped\n * in a single transaction. The transaction is rolled back if any exception occurs.\n */\n public void launch() {\n try {\n Connection connection = destination.getConnection();\n try {\n connection.setAutoCommit(false);\n operation.execute(connection, binderConfiguration);\n connection.commit();\n }\n catch (SQLException e) {\n connection.rollback();\n throw e;\n }\n catch (RuntimeException e) {\n connection.rollback();\n throw e;\n }\n finally {\n connection.close();\n }\n }\n catch (SQLException e) {\n throw new DbSetupRuntimeException(e);\n }\n }\n\n @Override\n public String toString() {\n return \"DbSetup [destination=\"\n + destination\n + \", operation=\"\n + operation\n + \", binderConfiguration=\"\n + binderConfiguration\n + \"]\";\n }\n\n @Override\n public int hashCode() {\n final int prime = 31;\n int result = 1;\n result = prime * result + binderConfiguration.hashCode();\n result = prime * result + destination.hashCode();\n result = prime * result + operation.hashCode();\n return result;\n }\n\n @Override\n public boolean equals(Object obj) {\n if (this == obj) {\n return true;\n }\n if (obj == null) {\n return false;\n }\n if (getClass() != obj.getClass()) {\n return false;\n }\n DbSetup other = (DbSetup) obj;\n return binderConfiguration.equals(other.binderConfiguration)\n && destination.equals(other.destination)\n && operation.equals(other.operation);\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/DbSetupRuntimeException.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup;\n\n/**\n * A runtime exception indicating that a DbSetup failed.\n * @author JB Nizet\n */\npublic class DbSetupRuntimeException extends RuntimeException {\n\n public DbSetupRuntimeException() {\n super();\n }\n\n public DbSetupRuntimeException(String message, Throwable cause) {\n super(message, cause);\n }\n\n public DbSetupRuntimeException(String message) {\n super(message);\n }\n\n public DbSetupRuntimeException(Throwable cause) {\n super(cause);\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/DbSetupTracker.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup;\n\nimport javax.annotation.Nonnull;\n\n\n/**\n *
\n * This class allows speeding up test execution, by avoiding re-executing the same sequence of database operations\n * before each test method even if each of these test methods leaves the database as it is (and only performs read-only\n * operations, which is the most frequent case).\n *
\n *
Example usage:
\n *
\n * // the tracker is static because JUnit uses a separate Test instance for every test method.\n * private static DbSetupTracker dbSetupTracker = new DbSetupTracker();\n *\n * @Before\n * public void setUp() throws Exception {\n * Operation operation =\n * Operations.sequenceOf(\n * CommonOperations.DELETE_ALL,\n * CommonOperations.INSERT_REFERENCE_DATA,\n * Operations.insertInto(\"CLIENT\")\n * .columns(\"CLIENT_ID\", \"FIRST_NAME\", \"LAST_NAME\", \"DATE_OF_BIRTH\", \"COUNTRY_ID\")\n * .values(1L, \"John\", \"Doe\", \"1975-07-19\", 1L)\n * .values(2L, \"Jack\", \"Smith\", \"1969-08-22\", 2L)\n * .build());\n * DbSetup dbSetup = new DbSetup(new DataSourceDestination(dataSource), operation);\n * dbSetupTracker.launchIfNecessary(dbSetup);\n * }\n *\n * @Test\n * public void readOnlyTest1() {\n * dbSetupTracker.skipNextLaunch();\n * ...\n * }\n *\n * @Test\n * public void readOnlyTest2() {\n * dbSetupTracker.skipNextLaunch();\n * ...\n * }\n *\n * @Test\n * public void readOnlyTest3() {\n * dbSetupTracker.skipNextLaunch();\n * ...\n * }\n *\n * @Test\n * public void readWriteTest1() {\n * // No call to dbSetupTracker.skipNextLaunch();\n * ...\n * }\n *
\n * @author JB Nizet\n */\npublic final class DbSetupTracker {\n private DbSetup lastSetupLaunched;\n private boolean nextLaunchSkipped;\n\n /**\n * Executes the given DbSetup unless all the following conditions are true:\n *
\n *
{@link #skipNextLaunch()} has been called since the last call to this method;
\n *
the given dbSetup is equal to the last DbSetup launched by this method
\n *
\n * This method resets the skipNextLaunch flag to false.\n * @param dbSetup the DbSetup to execute (or skip)\n */\n public void launchIfNecessary(@Nonnull DbSetup dbSetup) {\n boolean skipLaunch = nextLaunchSkipped && dbSetup.equals(lastSetupLaunched);\n nextLaunchSkipped = false;\n if (skipLaunch) {\n return;\n }\n dbSetup.launch();\n lastSetupLaunched = dbSetup;\n }\n\n /**\n * Marks the current test method as read-only, and thus the need for the next test method to re-execute the same\n * sequence of database setup operations.\n */\n public void skipNextLaunch() {\n this.nextLaunchSkipped = true;\n }\n\n @Override\n public String toString() {\n return \"DbSetupTracker [lastSetupLaunched=\"\n + lastSetupLaunched\n + \", nextLaunchSkipped=\"\n + nextLaunchSkipped\n + \"]\";\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/Operations.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup;\n\nimport java.util.List;\n\nimport javax.annotation.Nonnull;\n\nimport com.ninja_squad.dbsetup.operation.CompositeOperation;\nimport com.ninja_squad.dbsetup.operation.DeleteAll;\nimport com.ninja_squad.dbsetup.operation.Insert;\nimport com.ninja_squad.dbsetup.operation.Operation;\nimport com.ninja_squad.dbsetup.operation.SqlOperation;\nimport com.ninja_squad.dbsetup.operation.Truncate;\n\n/**\n * A static factory class for operations. Static import of this class can help make the code more readable.\n * @author JB Nizet\n */\npublic final class Operations {\n private Operations() {\n }\n\n /**\n * Creates a delete from table operation.\n * @param table the table to delete all from\n * @see DeleteAll\n */\n public static DeleteAll deleteAllFrom(@Nonnull String table) {\n return DeleteAll.from(table);\n }\n\n /**\n * Creates a sequence of delete from table operations.\n * @param tables the tables to delete all from\n * @see DeleteAll\n */\n public static Operation deleteAllFrom(@Nonnull String... tables) {\n return DeleteAll.from(tables);\n }\n\n /**\n * Creates a sequence of delete from ... operations.\n * @param tables the tables to delete all from\n * @see DeleteAll\n */\n public static Operation deleteAllFrom(@Nonnull List tables) {\n return DeleteAll.from(tables);\n }\n\n /**\n * Creates a truncate table ... operation.\n * @param table the table to truncate\n * @see Truncate\n */\n public static Truncate truncate(@Nonnull String table) {\n return Truncate.table(table);\n }\n\n /**\n * Creates a sequence of truncate table ... operations.\n * @param tables the tables to truncate\n * @see Truncate\n */\n public static Operation truncate(@Nonnull String... tables) {\n return Truncate.tables(tables);\n }\n\n /**\n * Creates a sequence of truncate table ... operations.\n * @param tables the tables to truncate\n * @see Truncate\n */\n public static Operation truncate(@Nonnull List tables) {\n return Truncate.tables(tables);\n }\n\n /**\n * Creates a SQL operation.\n * @param sqlStatement the SQL statement to execute (using {@link java.sql.Statement#executeUpdate(String)})\n * @see SqlOperation\n */\n public static SqlOperation sql(@Nonnull String sqlStatement) {\n return SqlOperation.of(sqlStatement);\n }\n\n /**\n * Creates a sequence of SQL operations.\n * @param sqlStatements the SQL statements to execute (using {@link java.sql.Statement#executeUpdate(String)})\n * @see SqlOperation\n */\n public static Operation sql(@Nonnull String... sqlStatements) {\n return SqlOperation.of(sqlStatements);\n }\n\n /**\n * Creates a sequence of SQL operations.\n * @param sqlStatements the SQL statements to execute (using {@link java.sql.Statement#executeUpdate(String)})\n * @see SqlOperation\n */\n public static Operation sql(@Nonnull List sqlStatements) {\n return SqlOperation.of(sqlStatements);\n }\n\n /**\n * Creates a builder for a sequence of insert operations.\n * @param table the table to insert into\n * @see Insert\n */\n public static Insert.Builder insertInto(@Nonnull String table) {\n return Insert.into(table);\n }\n\n /**\n * Creates a sequence of operations.\n * @param operations the operations to put in a sequence\n * @see CompositeOperation\n */\n public static Operation sequenceOf(@Nonnull Operation... operations) {\n return CompositeOperation.sequenceOf(operations);\n }\n\n /**\n * Creates a sequence of operations.\n * @param operations the operations to put in a sequence\n * @see CompositeOperation\n */\n public static Operation sequenceOf(@Nonnull List operations) {\n return CompositeOperation.sequenceOf(operations);\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/bind/Binder.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.bind;\n\nimport java.sql.PreparedStatement;\nimport java.sql.SQLException;\n\nimport com.ninja_squad.dbsetup.DbSetupTracker;\n\n/**\n * An object which binds a value to a prepared statement parameter. It's advised to make implementations of this\n * interface immutable, and to make them implement equals and hashCode in order for {@link DbSetupTracker} to function\n * properly, or to make them singletons.\n * @author JB Nizet\n */\npublic interface Binder {\n /**\n * Binds the given value to the given parameter in the given prepared statement.\n * @param statement the statement to bind the parameter to\n * @param param The index of the parameter to bind in the statement\n * @param value The value to bind (may be null)\n * @throws SQLException if the binding throws a {@link SQLException}\n */\n void bind(PreparedStatement statement, int param, Object value) throws SQLException;\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/bind/BinderConfiguration.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.bind;\n\nimport com.ninja_squad.dbsetup.DbSetup;\nimport com.ninja_squad.dbsetup.DbSetupTracker;\n\nimport javax.annotation.Nullable;\nimport java.sql.ParameterMetaData;\nimport java.sql.SQLException;\n\n/**\n * An object which returns the appropriate {@link Binder} based on the metadata of the prepared statement.\n * The default instance of this interface is {@link DefaultBinderConfiguration}. If the binders returned by this\n * default configuration don't fit for the particular database you're using, or if you would like the binders\n * returned by the configuration to support additional data types, you might want to provide a different implementation\n * of this interface to the {@link DbSetup}.\n *
\n * It's advised to make implementations of this interface immutable, and to make them implement equals and hashCode\n * in order for {@link DbSetupTracker} to function properly, or to make them singletons.\n * @author JB Nizet\n */\npublic interface BinderConfiguration {\n\n /**\n * Returns the appropriate {@link Binder} for the given parameter, based on the given metadata.\n * @param metadata the metadata allowing to decide which Binder to return. null if the Insert has been\n * configured to not use metadata, or if the JDBC driver returned null metadata, or the JDBC driver threw a\n * SQLException when asked for the metadata\n * @param param the param for which a binder is requested\n * @return the binder for the given param and its metadata\n * @throws SQLException if a SQLException occurs while using the metadata\n */\n Binder getBinder(@Nullable ParameterMetaData metadata, int param) throws SQLException;\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/bind/Binders.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012-2016, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.bind;\n\nimport java.math.BigDecimal;\nimport java.math.BigInteger;\nimport java.sql.Date;\nimport java.sql.Time;\nimport java.sql.Timestamp;\nimport java.sql.Types;\nimport java.time.Instant;\nimport java.time.LocalDate;\nimport java.time.LocalDateTime;\nimport java.time.LocalTime;\nimport java.time.OffsetDateTime;\nimport java.time.OffsetTime;\nimport java.time.ZonedDateTime;\nimport java.util.Calendar;\nimport java.util.TimeZone;\n\n/**\n * Utility class allowing to get various kinds of binders. The {@link DefaultBinderConfiguration} uses binders\n * returned by this class, based on the type of the parameter.\n * @author JB Nizet\n */\npublic final class Binders {\n\n private static final Binder DEFAULT_BINDER = new DefaultBinder();\n private static final Binder DATE_BINDER = new DateBinder();\n private static final Binder TIMESTAMP_BINDER = new TimestampBinder();\n private static final Binder DECIMAL_BINDER = new DecimalBinder();\n private static final Binder INTEGER_BINDER = new IntegerBinder();\n private static final Binder TIME_BINDER = new TimeBinder();\n private static final Binder STRING_BINDER = new StringBinder();\n\n private Binders() {\n }\n\n /**\n * Returns the default binder. This binder is normally used for columns of a type that is not handled by the other\n * binders. It is also used when the metadata are not used and the Insert thus doesn't know the type of the column.\n * It simply uses stmt.setObject() to bind the parameter, except if the value being bound is of some\n * some well-known type not handled by JDBC:\n *
\n *
enum: the name of the enum is bound
\n *
java.util.Date: the date is transformed to a java.sql.Timestamp
\n *
java.util.Calendar: the calendar is transformed to a java.sql.Timestamp,\n * and is passed as third argument of\n * PreparedStatement.setTimestamp() to pass the timezone
\n *
java.time.LocalDate: transformed to a java.sql.Date
\n *
java.time.LocalTime: transformed to a java.sql.Time
\n *
java.time.LocalDateTime: transformed to a java.sql.Timestamp
\n *
java.time.Instant: transformed to a java.sql.Timestamp
\n *
java.time.ZonedDateTime and OffsetDateTime: transformed to a\n * java.sql.Timestamp. The time zone is also used to create a Calendar passed as\n * third argument of PreparedStatement.setTimestamp() to pass the timezone
\n *
java.time.OffsetTime: transformed to a\n * java.sql.Time. The time zone is also used to create a Calendar passed as third\n * argument of PreparedStatement.setTime() to pass the timezone
\n *
\n */\n public static Binder defaultBinder() {\n return DEFAULT_BINDER;\n }\n\n /**\n * Returns a binder suitable for columns of type CHAR and VARCHAR. The returned binder supports values of type\n *
\n *
String
\n *
enum: the name of the enum is used as bound value
\n *
Object: the toString() of the object is used as bound value
\n *
\n */\n public static Binder stringBinder() {\n return STRING_BINDER;\n }\n\n /**\n * Returns a binder suitable for columns of type DATE. The returned binder supports values of type\n *
\n *
java.sql.Date
\n *
java.util.Date: the milliseconds of the date are used to construct a\n * java.sql.Date.
\n *
java.util.Calendar: the milliseconds of the calendar are used to construct a\n * java.sql.Date, and the calendar is passed as third argument of\n * PreparedStatement.setDate() to pass the timezone\n *
\n *
String: the string is transformed to a java.sql.Date using the Date.valueOf()\n * method
\n *
java.time.LocalDate: transformed to a java.sql.Date using\n * Date.valueOf()
\n *
java.time.LocalDateTime: transformed to a LocalDate (and thus ignoring the time),\n * and then transformed to a java.sql.Date using Date.valueOf()
\n *
java.time.Instantthe milliseconds of the instant are used to construct a\n * java.sql.Date.
\n *
java.time.ZonedDateTime and java.time.OffsetDateTime: transformed to an Instant\n * and then to a java.sql.Date. The time zone is also used to create a Calendar\n * passed as third argument of PreparedStatement.setDate() to pass the timezone
\n *
\n * If the value is none of these types, stmt.setObject() is used to bind the value.\n */\n public static Binder dateBinder() {\n return DATE_BINDER;\n }\n\n /**\n * Returns a binder suitable for columns of type TIMESTAMP and TIMESTAMP_WITH_TIMEZONE. The returned binder\n * supports values of type\n *
\n *
java.sql.Timestamp
\n *
java.util.Date: the milliseconds of the date are used to construct a\n * java.sql.Timestamp
\n *
java.util.Calendar: the milliseconds of the calendar are used to construct a\n * java.sql.Timestamp, and the calendar is passed as third argument of\n * PreparedStatement.setTimestamp() to pass the timezone
\n *
String: the string is transformed to a java.sql.Timestamp using the\n * Timestamp.valueOf() method, or using the java.sql.Date.valueOf() method if the\n * string has less than 19 characters
\n *
java.time.LocalDateTime: transformed to a java.sql.Timestamp using\n * Timestamp.valueOf()
\n *
java.time.LocalDate: transformed to a LocalDateTime with the time at start of day,\n * and then transformed to a java.sql.Timestamp using Timestamp.valueOf()
\n *
java.time.Instant: transformed to a java.sql.Timestamp using\n * Timestamp.from()
\n *
java.time.ZonedDateTime and java.time.OffsetDateTime: transformed to an Instant\n * and then to a java.sql.Timestamp using Timestamp.from(). The time zone is also\n * used to create a Calendar passed as third argument of\n * PreparedStatement.setTimestamp() to pass the timezone
\n *
\n * If the value is none of these types, stmt.setObject() is used to bind the value.\n */\n public static Binder timestampBinder() {\n return TIMESTAMP_BINDER;\n }\n\n /**\n * Returns a binder suitable for columns of type TIME or TIME_WITH_TIMEZONE. The returned binder supports values\n * of type\n *
\n *
java.sql.Time
\n *
java.util.Date: the milliseconds of the date are used to construct a\n * java.sql.Time
\n *
java.util.Calendar: the milliseconds of the calendar are used to construct a\n * java.sql.Time, and the calendar is passed as third argument of\n * PreparedStatement.setTimestamp() to pass the timezone\n *
\n *
String: the string is transformed to a java.sql.Time using the\n * Time.valueOf() method
\n *
java.time.LocalTime: transformed to a java.sql.Time using\n * Time.valueOf()
\n *
java.time.OffsetTime: transformed to a LocalTime and then to a\n * java.sql.Time using Time.valueOf(). The time zone is also\n * used to create a Calendar passed as third argument of\n * PreparedStatement.setTime() to pass the timezone
\n *
\n * If the value is none of these types, stmt.setObject() is used to bind the value.\n */\n public static Binder timeBinder() {\n return TIME_BINDER;\n }\n\n /**\n * Returns a binder suitable for numeric, decimal columns. The returned binder supports values of type\n *
\n *
String: the string is transformed to a java.math.BigDecimal using its constructor
\n *
\n * If the value is none of these types, stmt.setObject() is used to bind the value.\n */\n public static Binder decimalBinder() {\n return DECIMAL_BINDER;\n }\n\n /**\n * Returns a binder suitable for numeric, integer columns. The returned binder supports values of type\n *
\n *
BigInteger: the object is transformed to a String and bound using\n * stmt.setObject(), with BIGINT as target type.\n *
\n *
enum: the enum is transformed into an integer by taking its ordinal
\n *
String: the string is bound using stmt.setObject(), with BIGINT as\n * target type.\n *
\n *
\n * If the value is none of these types, stmt.setObject() is used to bind the value.\n */\n public static Binder integerBinder() {\n return INTEGER_BINDER;\n }\n\n /**\n * The implementation for {@link Binders#stringBinder()}\n * @author JB Nizet\n */\n private static final class StringBinder implements Binder {\n @Override\n public void bind(java.sql.PreparedStatement stmt, int param, Object value) throws java.sql.SQLException {\n if (value instanceof String) {\n stmt.setString(param, (String) value);\n }\n else if (value instanceof Enum) {\n stmt.setString(param, ((Enum) value).name());\n }\n else if (value == null) {\n stmt.setObject(param, null);\n }\n else {\n stmt.setString(param, value.toString());\n }\n }\n\n @Override\n public String toString() {\n return \"Binders.stringBinder\";\n }\n }\n\n /**\n * The implementation for {@link Binders#timeBinder()}\n * @author JB Nizet\n */\n private static final class TimeBinder implements Binder {\n @Override\n public void bind(java.sql.PreparedStatement stmt, int param, Object value) throws java.sql.SQLException {\n if (value instanceof Time) {\n stmt.setTime(param, (Time) value);\n }\n else if (value instanceof java.util.Date) {\n stmt.setTime(param, new Time(((java.util.Date) value).getTime()));\n }\n else if (value instanceof Calendar) {\n Calendar calendar = (Calendar) value;\n stmt.setTime(param, new Time(calendar.getTimeInMillis()), calendar);\n }\n else if (value instanceof String) {\n stmt.setTime(param, Time.valueOf((String) value));\n }\n else if (value instanceof LocalTime) {\n stmt.setTime(param, Time.valueOf((LocalTime) value));\n }\n else if (value instanceof OffsetTime) {\n OffsetTime offsetTime = (OffsetTime) value;\n stmt.setTime(param,\n Time.valueOf(offsetTime.toLocalTime()),\n Calendar.getInstance(TimeZone.getTimeZone(offsetTime.getOffset())));\n }\n else {\n stmt.setObject(param, value);\n }\n }\n\n @Override\n public String toString() {\n return \"Binders.timeBinder\";\n }\n }\n\n /**\n * The implementation for {@link Binders#integerBinder()}\n * @author JB Nizet\n */\n private static final class IntegerBinder implements Binder {\n @Override\n public void bind(java.sql.PreparedStatement stmt, int param, Object value) throws java.sql.SQLException {\n if (value instanceof BigInteger) {\n stmt.setObject(param, value.toString(), Types.BIGINT);\n }\n else if (value instanceof Enum) {\n stmt.setInt(param, ((Enum) value).ordinal());\n }\n else if (value instanceof String) {\n stmt.setObject(param, value, Types.BIGINT);\n }\n else {\n stmt.setObject(param, value);\n }\n }\n\n @Override\n public String toString() {\n return \"Binders.integerBinder\";\n }\n }\n\n /**\n * The implementation for {@link Binders#decimalBinder()}\n * @author JB Nizet\n */\n private static final class DecimalBinder implements Binder {\n @Override\n public void bind(java.sql.PreparedStatement stmt, int param, Object value) throws java.sql.SQLException {\n if (value instanceof String) {\n stmt.setBigDecimal(param, new BigDecimal((String) value));\n }\n else {\n stmt.setObject(param, value);\n }\n }\n\n @Override\n public String toString() {\n return \"Binders.decimalBinder\";\n }\n }\n\n /**\n * The implementation for {@link Binders#timestampBinder()}\n * @author JB Nizet\n */\n private static final class TimestampBinder implements Binder {\n // the number of chars in yyyy-mm-dd hh:mm:ss\n private static final int MIN_NUMBER_OF_CHARS_FOR_TIMESTAMP = 19;\n\n @Override\n public void bind(java.sql.PreparedStatement stmt, int param, Object value) throws java.sql.SQLException {\n if (value instanceof Timestamp) {\n stmt.setTimestamp(param, (Timestamp) value);\n }\n else if (value instanceof java.util.Date) {\n stmt.setTimestamp(param, new Timestamp(((java.util.Date) value).getTime()));\n }\n else if (value instanceof Calendar) {\n stmt.setTimestamp(param, new Timestamp(((Calendar) value).getTimeInMillis()), (Calendar) value);\n }\n else if (value instanceof String) {\n String valueAsString = (String) value;\n if (valueAsString.length() >= MIN_NUMBER_OF_CHARS_FOR_TIMESTAMP) {\n stmt.setTimestamp(param, Timestamp.valueOf(valueAsString));\n }\n else {\n Date valueAsDate = Date.valueOf(valueAsString);\n stmt.setTimestamp(param, new Timestamp(valueAsDate.getTime()));\n }\n }\n else if (value instanceof LocalDateTime) {\n LocalDateTime localDateTime = (LocalDateTime) value;\n stmt.setTimestamp(param, Timestamp.valueOf(localDateTime));\n }\n else if (value instanceof Instant) {\n Instant instant = (Instant) value;\n stmt.setTimestamp(param, Timestamp.from(instant));\n }\n else if (value instanceof ZonedDateTime) {\n ZonedDateTime zonedDateTime = (ZonedDateTime) value;\n stmt.setTimestamp(param,\n Timestamp.from(zonedDateTime.toInstant()),\n Calendar.getInstance(TimeZone.getTimeZone(zonedDateTime.getZone())));\n }\n else if (value instanceof OffsetDateTime) {\n OffsetDateTime offsetDateTime = (OffsetDateTime) value;\n stmt.setTimestamp(param,\n Timestamp.from(offsetDateTime.toInstant()),\n Calendar.getInstance(TimeZone.getTimeZone(offsetDateTime.getOffset())));\n }\n else if (value instanceof LocalDate) {\n LocalDate localDate = (LocalDate) value;\n stmt.setTimestamp(param, Timestamp.valueOf(localDate.atStartOfDay()));\n }\n else {\n stmt.setObject(param, value);\n }\n }\n\n @Override\n public String toString() {\n return \"Binders.timestampBinder\";\n }\n }\n\n /**\n * The implementation for {@link Binders#dateBinder()}\n * @author JB Nizet\n */\n private static final class DateBinder implements Binder {\n @Override\n public void bind(java.sql.PreparedStatement stmt, int param, Object value) throws java.sql.SQLException {\n if (value instanceof Date) {\n stmt.setDate(param, (Date) value);\n }\n else if (value instanceof java.util.Date) {\n stmt.setDate(param, new Date(((java.util.Date) value).getTime()));\n }\n else if (value instanceof Calendar) {\n Calendar calendar = (Calendar) value;\n stmt.setDate(param, new Date(calendar.getTimeInMillis()), calendar);\n }\n else if (value instanceof String) {\n stmt.setDate(param, Date.valueOf((String) value));\n }\n else if (value instanceof LocalDate) {\n LocalDate localDate = (LocalDate) value;\n stmt.setDate(param, Date.valueOf(localDate));\n }\n else if (value instanceof LocalDateTime) {\n LocalDateTime localDateTime = (LocalDateTime) value;\n stmt.setDate(param, Date.valueOf(localDateTime.toLocalDate()));\n }\n else if (value instanceof Instant) {\n Instant instant = (Instant) value;\n stmt.setDate(param, new Date(instant.toEpochMilli()));\n }\n else if (value instanceof ZonedDateTime) {\n ZonedDateTime zonedDateTime = (ZonedDateTime) value;\n stmt.setDate(param,\n new Date(zonedDateTime.toInstant().toEpochMilli()),\n Calendar.getInstance(TimeZone.getTimeZone(zonedDateTime.getZone())));\n }\n else if (value instanceof OffsetDateTime) {\n OffsetDateTime offsetDateTime = (OffsetDateTime) value;\n stmt.setDate(param,\n new Date(offsetDateTime.toInstant().toEpochMilli()),\n Calendar.getInstance(TimeZone.getTimeZone(offsetDateTime.getOffset())));\n }\n else {\n stmt.setObject(param, value);\n }\n }\n\n @Override\n public String toString() {\n return \"Binders.dateBinder\";\n }\n }\n\n /**\n * The implementation for {@link Binders#defaultBinder()}\n * @author JB Nizet\n */\n private static final class DefaultBinder implements Binder {\n @Override\n public void bind(java.sql.PreparedStatement stmt, int param, Object value) throws java.sql.SQLException {\n if (value instanceof Enum) {\n stmt.setString(param, ((Enum) value).name());\n }\n else if (value instanceof java.util.Date) {\n stmt.setTimestamp(param, new Timestamp(((java.util.Date) value).getTime()));\n }\n else if (value instanceof Calendar) {\n Calendar calendar = (Calendar) value;\n stmt.setTimestamp(param, new Timestamp(calendar.getTime().getTime()), calendar);\n }\n else if (value instanceof LocalDate) {\n stmt.setDate(param, Date.valueOf((LocalDate) value));\n }\n else if (value instanceof LocalTime) {\n stmt.setTime(param, Time.valueOf((LocalTime) value));\n }\n else if (value instanceof LocalDateTime) {\n stmt.setTimestamp(param, Timestamp.valueOf((LocalDateTime) value));\n }\n else if (value instanceof Instant) {\n stmt.setTimestamp(param, Timestamp.from((Instant) value));\n }\n else if (value instanceof ZonedDateTime) {\n ZonedDateTime zonedDateTime = (ZonedDateTime) value;\n stmt.setTimestamp(param,\n Timestamp.from(zonedDateTime.toInstant()),\n Calendar.getInstance(TimeZone.getTimeZone(zonedDateTime.getZone())));\n }\n else if (value instanceof OffsetDateTime) {\n OffsetDateTime offsetDateTime = (OffsetDateTime) value;\n stmt.setTimestamp(param,\n Timestamp.from(offsetDateTime.toInstant()),\n Calendar.getInstance(TimeZone.getTimeZone(offsetDateTime.getOffset())));\n }\n else if (value instanceof OffsetTime) {\n OffsetTime offsetTime = (OffsetTime) value;\n stmt.setTime(param,\n Time.valueOf(offsetTime.toLocalTime()),\n Calendar.getInstance(TimeZone.getTimeZone(offsetTime.getOffset())));\n }\n else {\n stmt.setObject(param, value);\n }\n }\n\n @Override\n public String toString() {\n return \"Binders.defaultBinder\";\n }\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/bind/DefaultBinderConfiguration.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012-2016, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.bind;\n\nimport java.sql.ParameterMetaData;\nimport java.sql.SQLException;\nimport java.sql.Types;\n\nimport com.ninja_squad.dbsetup.DbSetup;\n\n/**\n * Default implementation of {@link BinderConfiguration}, used by default by {@link DbSetup}.\n * @author JB Nizet\n */\npublic class DefaultBinderConfiguration implements BinderConfiguration {\n\n /**\n * A shareable, reusable instance of this class.\n */\n public static final DefaultBinderConfiguration INSTANCE = new DefaultBinderConfiguration();\n\n /**\n * Constructor. Protected because it doesn't make much sense to instantiate this class,\n * but extending it can be useful.\n */\n protected DefaultBinderConfiguration() {\n }\n\n /**\n * Uses the parameter type of the given parameter and returns the following Binders depending on the type\n * got from the metadata.\n *
\n *
null metadata (i.e. metadata not used or not returned): {@link Binders#defaultBinder()}
DECIMAL, DOUBLE, FLOAT, NUMERIC, REAL : {@link Binders#decimalBinder()}
\n *
other : {@link Binders#defaultBinder()}
\n *
\n *\n * If the parameter type can't be obtained from the metadata, the default binder is returned.\n */\n @Override\n public Binder getBinder(ParameterMetaData metadata, int param) throws SQLException {\n if (metadata == null) {\n return Binders.defaultBinder();\n }\n try {\n int sqlType = metadata.getParameterType(param);\n if (sqlType == Types.DATE) {\n return Binders.dateBinder();\n }\n if (sqlType == Types.TIME || sqlType == Types.TIME_WITH_TIMEZONE) {\n return Binders.timeBinder();\n }\n if (sqlType == Types.TIMESTAMP || sqlType == Types.TIMESTAMP_WITH_TIMEZONE) {\n return Binders.timestampBinder();\n }\n if (sqlType == Types.BIGINT\n || sqlType == Types.INTEGER\n || sqlType == Types.SMALLINT\n || sqlType == Types.TINYINT) {\n return Binders.integerBinder();\n }\n if (sqlType == Types.DECIMAL\n || sqlType == Types.DOUBLE\n || sqlType == Types.FLOAT\n || sqlType == Types.NUMERIC\n || sqlType == Types.REAL) {\n return Binders.decimalBinder();\n }\n if (sqlType == Types.VARCHAR\n || sqlType == Types.CHAR\n || sqlType == Types.LONGNVARCHAR\n || sqlType == Types.LONGVARCHAR\n || sqlType == Types.NCHAR\n || sqlType == Types.NVARCHAR) {\n return Binders.stringBinder();\n }\n return Binders.defaultBinder();\n }\n catch (SQLException e) {\n // the database can't return types from parameters. Fall back to default binder.\n return Binders.defaultBinder();\n }\n }\n\n @Override\n public String toString() {\n return \"DefaultBinderConfiguration\";\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/destination/DataSourceDestination.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.destination;\n\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\nimport javax.annotation.Nonnull;\nimport javax.annotation.concurrent.Immutable;\nimport javax.sql.DataSource;\nimport java.sql.Connection;\nimport java.sql.SQLException;\n\n/**\n * A destination which wraps a DataSource and gets its connection from the wrapped DataSource\n * @author JB Nizet\n */\n@Immutable\npublic final class DataSourceDestination implements Destination {\n private final DataSource dataSource;\n\n /**\n * Constructor\n * @param dataSource the wrapped DataSource\n */\n public DataSourceDestination(@Nonnull DataSource dataSource) {\n Preconditions.checkNotNull(dataSource, \"dataSource may not be null\");\n this.dataSource = dataSource;\n }\n\n /**\n * Factory method creating a new DataSourceDestination. This allows a more readable style than using the\n * constructor:\n *\n *
\n * DbSetup dbSetup = new DbSetup(DataSourceDestination.with(dataSource), operation);\n *
\n *\n * or, if this method is statically imported:\n *\n *
\n * DbSetup dbSetup = new DbSetup(with(dataSource), operation);\n *
\n *\n * instead of\n *\n *
\n * DbSetup dbSetup = new DbSetup(new DataSourceDestination(dataSource), operation);\n *
\n *\n * @param dataSource the wrapped DataSource\n */\n public static DataSourceDestination with(@Nonnull DataSource dataSource) {\n return new DataSourceDestination(dataSource);\n }\n\n @Override\n public Connection getConnection() throws SQLException {\n return dataSource.getConnection();\n }\n\n @Override\n public String toString() {\n return \"DataSourceDestination [dataSource=\" + dataSource + \"]\";\n }\n\n @Override\n public int hashCode() {\n return dataSource.hashCode();\n }\n\n @Override\n public boolean equals(Object obj) {\n if (this == obj) {\n return true;\n }\n if (obj == null) {\n return false;\n }\n if (getClass() != obj.getClass()) {\n return false;\n }\n DataSourceDestination other = (DataSourceDestination) obj;\n return dataSource.equals(other.dataSource);\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/destination/Destination.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.destination;\n\nimport java.sql.Connection;\nimport java.sql.SQLException;\n\nimport com.ninja_squad.dbsetup.DbSetupTracker;\n\n/**\n * The destination of a database setup. It's advised to make implementations of this\n * interface immutable, and to make them implement equals and hashCode in order for {@link DbSetupTracker} to function\n * properly, or to make them singletons.\n * @author JB Nizet\n */\npublic interface Destination {\n /**\n * Returns a connection to the destination database\n * @return a connection to the destination database\n * @throws SQLException if a connection can't be returned\n */\n Connection getConnection() throws SQLException;\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/destination/DriverManagerDestination.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.destination;\n\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\nimport javax.annotation.Nonnull;\nimport javax.annotation.concurrent.Immutable;\nimport java.sql.Connection;\nimport java.sql.DriverManager;\nimport java.sql.SQLException;\n\n/**\n * A destination which uses the {@link DriverManager} to get a connection\n * @author JB Nizet\n */\n@Immutable\npublic final class DriverManagerDestination implements Destination {\n\n private final String url;\n private final String user;\n private final String password;\n\n /**\n * Constructor\n * @param url the URL of the database\n * @param user the user used to get a connection\n * @param password the password used to get a connection\n */\n public DriverManagerDestination(@Nonnull String url, String user, String password) {\n Preconditions.checkNotNull(url, \"url may not be null\");\n this.url = url;\n this.user = user;\n this.password = password;\n }\n\n /**\n * Factory method creating a new DriverManagerDestination. This allows a more readable style than using the\n * constructor:\n *\n *
\n *\n * @param url the URL of the database\n * @param user the user used to get a connection\n * @param password the password used to get a connection\n */\n public static DriverManagerDestination with(@Nonnull String url, String user, String password) {\n return new DriverManagerDestination(url, user, password);\n }\n\n @Override\n public Connection getConnection() throws SQLException {\n return DriverManager.getConnection(url, user, password);\n }\n\n @Override\n public String toString() {\n return \"DriverManagerDestination [url=\"\n + url\n + \", user=\"\n + user\n + \", password=\"\n + password\n + \"]\";\n }\n\n @Override\n public int hashCode() {\n final int prime = 31;\n int result = 1;\n result = prime * result + url.hashCode();\n result = prime * result + ((password == null) ? 0 : password.hashCode());\n result = prime * result + ((user == null) ? 0 : user.hashCode());\n return result;\n }\n\n @Override\n public boolean equals(Object obj) {\n if (this == obj) {\n return true;\n }\n if (obj == null) {\n return false;\n }\n if (getClass() != obj.getClass()) {\n return false;\n }\n DriverManagerDestination other = (DriverManagerDestination) obj;\n if (password == null) {\n if (other.password != null) {\n return false;\n }\n }\n else if (!password.equals(other.password)) {\n return false;\n }\n if (!url.equals(other.url)) {\n return false;\n }\n if (user == null) {\n if (other.user != null) {\n return false;\n }\n }\n else if (!user.equals(other.user)) {\n return false;\n }\n return true;\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/generator/DateSequenceValueGenerator.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2013-2016, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.generator;\n\nimport javax.annotation.Nonnull;\nimport java.sql.Timestamp;\nimport java.time.LocalDate;\nimport java.time.LocalDateTime;\nimport java.time.ZoneId;\nimport java.time.ZonedDateTime;\nimport java.time.temporal.ChronoUnit;\nimport java.time.temporal.TemporalUnit;\nimport java.util.Calendar;\nimport java.util.Date;\nimport java.util.TimeZone;\n\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\n/**\n * A {@link ValueGenerator} that returns a sequence of dates, starting at a given zoned date time and incremented by a\n * given time, specified as an increment and a temporal unit.\n * @author JB\n */\npublic final class DateSequenceValueGenerator implements ValueGenerator {\n\n // the number of chars in yyyy-mm-dd hh:mm:ss\n private static final int MIN_NUMBER_OF_CHARS_FOR_TIMESTAMP = 19;\n\n /**\n * The available units for the increment of this sequence\n * @deprecated use ChronoField instead. This enum is only kept to maintain backward compatibility\n */\n @Deprecated\n public enum CalendarField {\n YEAR(ChronoUnit.YEARS),\n MONTH(ChronoUnit.MONTHS),\n DAY(ChronoUnit.DAYS),\n HOUR(ChronoUnit.HOURS),\n MINUTE(ChronoUnit.MINUTES),\n SECOND(ChronoUnit.SECONDS),\n MILLISECOND(ChronoUnit.MILLIS);\n\n private TemporalUnit unit;\n\n CalendarField(TemporalUnit unit) {\n this.unit = unit;\n }\n\n private TemporalUnit toTemporalUnit() {\n return unit;\n }\n }\n\n private ZonedDateTime next;\n private int increment;\n private TemporalUnit unit;\n\n DateSequenceValueGenerator() {\n this(LocalDate.now().atStartOfDay().atZone(ZoneId.systemDefault()), 1, ChronoUnit.DAYS);\n }\n\n private DateSequenceValueGenerator(ZonedDateTime next, int increment, TemporalUnit unit) {\n this.next = next;\n this.increment = increment;\n this.unit = unit;\n }\n\n /**\n * Restarts the sequence at the given date, in the given time zone\n * @return this instance, for chaining\n * @deprecated use one of the other startingAt() methods taking java.time types as argument\n */\n @Deprecated\n public DateSequenceValueGenerator startingAt(@Nonnull Date startDate, @Nonnull TimeZone timeZone) {\n Preconditions.checkNotNull(startDate, \"startDate may not be null\");\n Preconditions.checkNotNull(timeZone, \"timeZone may not be null\");\n next = startDate.toInstant().atZone(timeZone.toZoneId());\n return this;\n }\n\n /**\n * Restarts the sequence at the given date, in the default time zone\n * @return this instance, for chaining\n * @deprecated use one of the other startingAt() methods taking java.time types as argument\n */\n @Deprecated\n public DateSequenceValueGenerator startingAt(@Nonnull Date startDate) {\n return startingAt(startDate, TimeZone.getDefault());\n }\n\n /**\n * Restarts the sequence at the given date\n * @return this instance, for chaining\n * @deprecated use one of the other startingAt() methods taking java.time types as argument\n */\n @Deprecated\n public DateSequenceValueGenerator startingAt(@Nonnull Calendar startDate) {\n Preconditions.checkNotNull(startDate, \"startDate may not be null\");\n next = startDate.toInstant().atZone(startDate.getTimeZone().toZoneId());\n return this;\n }\n\n /**\n * Restarts the sequence at the given date, in the default time zone\n * @param startDate the starting date, as a String. The supported formats are the same as the ones supported by\n * {@link com.ninja_squad.dbsetup.bind.Binders#timestampBinder()}, i.e. the formats supported by\n * java.sql.Timestamp.valueOf() and java.sql.Date.valueOf()\n * @return this instance, for chaining\n */\n public DateSequenceValueGenerator startingAt(@Nonnull String startDate) {\n Preconditions.checkNotNull(startDate, \"startDate may not be null\");\n if (startDate.length() >= MIN_NUMBER_OF_CHARS_FOR_TIMESTAMP) {\n return startingAt(new Date(Timestamp.valueOf(startDate).getTime()));\n }\n else {\n return startingAt(new Date(java.sql.Date.valueOf(startDate).getTime()));\n }\n }\n\n /**\n * Restarts the sequence at the given local date, in the default time zone\n * @return this instance, for chaining\n */\n public DateSequenceValueGenerator startingAt(@Nonnull LocalDate startDate) {\n return startingAt(startDate.atStartOfDay());\n }\n\n /**\n * Restarts the sequence at the given local date time, in the default time zone\n * @return this instance, for chaining\n */\n public DateSequenceValueGenerator startingAt(@Nonnull LocalDateTime startDate) {\n return startingAt(startDate.atZone(ZoneId.systemDefault()));\n }\n\n /**\n * Restarts the sequence at the given zoned date time\n * @return this instance, for chaining\n */\n public DateSequenceValueGenerator startingAt(@Nonnull ZonedDateTime startDate) {\n next = startDate;\n return this;\n }\n\n /**\n * Increments the date by the given increment of the given unit.\n * @return this instance, for chaining\n * @deprecated use the other {@link #incrementingBy(int, TemporalUnit)} method\n */\n @Deprecated\n public DateSequenceValueGenerator incrementingBy(int increment, @Nonnull CalendarField unit) {\n Preconditions.checkNotNull(unit, \"unit may not be null\");\n return incrementingBy(increment, unit.toTemporalUnit());\n }\n\n /**\n * Increments the date by the given increment of the given unit. One of the constants of ChronoField is typically\n * used for the unit.\n * @return this instance, for chaining\n */\n public DateSequenceValueGenerator incrementingBy(int increment, @Nonnull TemporalUnit unit) {\n Preconditions.checkNotNull(unit, \"unit may not be null\");\n this.increment = increment;\n this.unit = unit;\n return this;\n }\n\n @Override\n public ZonedDateTime nextValue() {\n ZonedDateTime result = next;\n next = next.plus(increment, unit);\n return result;\n }\n\n @Override\n public String toString() {\n return \"DateSequenceValueGenerator[\"\n + \"next=\" + next\n + \", increment=\" + increment\n + \", unit=\" + unit\n + \"]\";\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/generator/SequenceValueGenerator.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2013, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.generator;\n\n/**\n * A {@link ValueGenerator} which generates a sequence of long values. By default, the sequence starts at 1 and\n * increments by 1, but this can be customized. Instances of this class are created using\n * {@link ValueGenerators#sequence()}.\n * @author JB Nizet\n */\npublic final class SequenceValueGenerator implements ValueGenerator {\n\n private long next = 1L;\n private int increment = 1;\n\n SequenceValueGenerator() {\n this(1, 1);\n }\n\n private SequenceValueGenerator(long start, int increment) {\n this.next = start;\n this.increment = increment;\n }\n\n /**\n * Restarts the sequence at the given value\n * @param start the starting value of the created generator\n * @return this instance, for chaining\n */\n public SequenceValueGenerator startingAt(long start) {\n this.next = start;\n return this;\n }\n\n /**\n * Increments the value by the given increment.\n * @return this instance, for chaining\n */\n public SequenceValueGenerator incrementingBy(int increment) {\n this.increment = increment;\n return this;\n }\n\n @Override\n public Long nextValue() {\n long result = next;\n next += increment;\n return result;\n }\n\n @Override\n public String toString() {\n return \"SequenceValueGenerator[\"\n + \"next=\"\n + next\n + \", increment=\"\n + increment\n + \"]\";\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/generator/StringSequenceValueGenerator.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2013-2016, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.generator;\n\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\n/**\n * A {@link ValueGenerator} that returns a string prefix followed by a sequence number, optionally left-padded\n * with 0 to ensure a correct ordering (for example: CODE_001, CODE_002, etc.). Instances of this generator\n * are created by {@link ValueGenerators#stringSequence(String)}.\n * @author JB\n */\npublic final class StringSequenceValueGenerator implements ValueGenerator {\n private String prefix;\n private long next;\n private int increment;\n\n /**\n * The length of the number once padded. 0 if no padding must be applied\n */\n private int paddedNumberLength;\n\n StringSequenceValueGenerator(String prefix) {\n this(prefix, 1L, 1, 0);\n }\n\n private StringSequenceValueGenerator(String prefix, long next, int increment, int paddedNumberLength) {\n this.prefix = prefix;\n this.next = next;\n this.increment = increment;\n this.paddedNumberLength = paddedNumberLength;\n }\n\n /**\n * Tells the generator to left-pad the number it generates with 0 until the length of the number is the given\n * length. For example, passing 3 to this method will generate numbers 001, 002, 003, 004, etc. If the generated\n * number, before padding, has a length already equal or larger that the given length, the number is not padded.\n * @param paddedNumberLength the length of the number once padded. Must be > 0.\n * @return this instance, for chaining\n */\n public StringSequenceValueGenerator withLeftPadding(int paddedNumberLength) {\n Preconditions.checkArgument(paddedNumberLength > 0, \"paddedNumberLength must be > 0\");\n this.paddedNumberLength = paddedNumberLength;\n return this;\n }\n\n /**\n * Tells the generator to avoid left-padding the number it generates with 0\n * @return this instance, for chaining\n */\n public StringSequenceValueGenerator withoutLeftPadding() {\n this.paddedNumberLength = 0;\n return this;\n }\n\n /**\n * Restarts the sequence at the given value\n * @param start the new starting value of the sequence\n * @return this instance, for chaining\n */\n public StringSequenceValueGenerator startingAt(long start) {\n this.next = start;\n return this;\n }\n\n /**\n * Increments the number by the given increment.\n * @return this instance, for chaining\n */\n public StringSequenceValueGenerator incrementingBy(int increment) {\n this.increment = increment;\n return this;\n }\n\n @Override\n public String nextValue() {\n long number = next;\n next += increment;\n return prefix + leftPadIfNecessary(number);\n }\n\n private String leftPadIfNecessary(long number) {\n String numberAsString = Long.toString(number);\n if (numberAsString.length() >= paddedNumberLength) {\n return numberAsString;\n }\n StringBuilder builder = new StringBuilder(paddedNumberLength);\n for (int i = 0; i < paddedNumberLength - numberAsString.length(); i++) {\n builder.append('0');\n }\n return builder.append(numberAsString).toString();\n }\n\n @Override\n public String toString() {\n return \"StringSequenceValueGenerator[\"\n + \"prefix='\" + prefix + '\\''\n + \", next=\" + next\n + \", increment=\" + increment\n + \", paddedNumberLength=\" + paddedNumberLength\n + \"]\";\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/generator/ValueGenerator.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2013, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.generator;\n\n/**\n * A value generator allows generating values for a specific column in a sequence of inserts. This is useful when you\n * don't want to specify a value for each of the inserted rows in a table, and when a default value is not an option\n * either because, for example, the column has a unique constraint.\n * @param the type of value that this generator generates\n *\n * @see ValueGenerators for useful implementations of this interface\n * @author JB Nizet\n */\npublic interface ValueGenerator {\n /**\n * Called each time a new row is inserted, to get the value to insert in the column using this value generator.\n * @return the value to insert in the column associated with this generator.\n */\n T nextValue();\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/generator/ValueGenerators.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2013, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.generator;\n\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\nimport javax.annotation.Nonnull;\nimport javax.annotation.Nullable;\n\n/**\n * Utility class containing factory methods for {@link ValueGenerator}\n * @author JB Nizet\n */\npublic final class ValueGenerators {\n private ValueGenerators() {\n }\n\n /**\n * Returns a value generator which generates a sequence of long values starting with 1, with an increment of 1.\n * The starting value and increment can be customized using\n *
\n */\n public static SequenceValueGenerator sequence() {\n return new SequenceValueGenerator();\n }\n\n /**\n * Returns a value generator which always returns the same, given value.\n */\n public static ValueGenerator constant(@Nullable final T constant) {\n return new ValueGenerator() {\n @Override\n public T nextValue() {\n return constant;\n }\n\n @Override\n public String toString() {\n return \"ValueGenerators.constant(\" + constant + \")\";\n }\n };\n }\n\n /**\n * Returns a value generator that returns a string prefix followed by a sequence number, optionally left-padded\n * with 0 to ensure a correct ordering (for example: CODE_001, CODE_002, etc.). The returned generator starts the\n * sequence at 1 and increments by 1, and doesn't pad the numbers.\n * @param prefix the prefix before the generated number (for example: \"CODE_\").\n */\n public static StringSequenceValueGenerator stringSequence(@Nonnull String prefix) {\n Preconditions.checkNotNull(prefix, \"prefix may not be null\");\n return new StringSequenceValueGenerator(prefix);\n }\n\n /**\n * Returns a value generator that returns a sequence of dates, starting at a given date and incremented by a given\n * time, specified as an increment and a calendar field. The returned generator starts today at 00:00:00\n * and increments by 1 day by default.\n */\n public static DateSequenceValueGenerator dateSequence() {\n return new DateSequenceValueGenerator();\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/operation/CompositeOperation.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.operation;\n\nimport javax.annotation.Nonnull;\nimport javax.annotation.concurrent.Immutable;\nimport java.sql.Connection;\nimport java.sql.SQLException;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.List;\n\nimport com.ninja_squad.dbsetup.bind.BinderConfiguration;\n\n/**\n * A composite operation or, in other words, an operation which consists in executing a sequence of other operations.\n * @author JB Nizet\n */\n@Immutable\npublic final class CompositeOperation implements Operation {\n\n private static final Operation NOP = new Operation() {\n\n @Override\n public void execute(Connection connection, BinderConfiguration configuration) {\n // does nothing since it's a NOP\n }\n\n @Override\n public String toString() {\n return \"NOP\";\n }\n };\n\n private final List operations;\n\n private CompositeOperation(List operations) {\n this.operations = new ArrayList(operations);\n }\n\n /**\n * Creates a new Operation containing all the given operations\n * @param operations the sequence of operations\n */\n public static Operation sequenceOf(@Nonnull Operation... operations) {\n return sequenceOf(Arrays.asList(operations));\n }\n\n /**\n * Creates a new Operation containing all the given operations\n * @param operations the sequence of operations\n */\n public static Operation sequenceOf(@Nonnull List operations) {\n if (operations.isEmpty()) {\n return NOP;\n }\n else if (operations.size() == 1) {\n return operations.get(0);\n }\n return new CompositeOperation(operations);\n }\n\n /**\n * Executes the sequence of operations\n * @throws SQLException as soon as one of the operations in the sequence throws a SQLException\n */\n @Override\n public void execute(Connection connection, BinderConfiguration configuration) throws SQLException {\n for (Operation operation : operations) {\n operation.execute(connection, configuration);\n }\n }\n\n @Override\n public String toString() {\n StringBuilder builder = new StringBuilder();\n boolean first = true;\n for (Operation operation : operations) {\n if (!first) {\n builder.append('\\n');\n }\n else {\n first = false;\n }\n builder.append(operation);\n }\n return builder.toString();\n }\n\n @Override\n public int hashCode() {\n return operations.hashCode();\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null) {\n return false;\n }\n if (getClass() != o.getClass()) {\n return false;\n }\n CompositeOperation other = (CompositeOperation) o;\n return this.operations.equals(other.operations);\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/operation/DeleteAll.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.operation;\n\nimport com.ninja_squad.dbsetup.bind.BinderConfiguration;\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\nimport javax.annotation.Nonnull;\nimport javax.annotation.concurrent.Immutable;\nimport java.sql.Connection;\nimport java.sql.SQLException;\nimport java.sql.Statement;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.List;\n\n/**\n * An operation which deletes everything from a given database table.\n * @author JB Nizet\n */\n@Immutable\npublic final class DeleteAll implements Operation {\n\n private final String table;\n\n private DeleteAll(String table) {\n Preconditions.checkNotNull(table, \"table may not be null\");\n this.table = table;\n }\n\n @Override\n public void execute(Connection connection, BinderConfiguration configuration) throws SQLException {\n Statement stmt = connection.createStatement();\n try {\n stmt.executeUpdate(\"delete from \" + table);\n }\n finally {\n stmt.close();\n }\n }\n\n /**\n * Returns an operation which deletes all the rows from the given table.\n * @param table the table to delete everything from.\n */\n public static DeleteAll from(@Nonnull String table) {\n return new DeleteAll(table);\n }\n\n /**\n * Returns a composite operation which deletes all the rows from the given tables, in the same order as the\n * tables. If A has a foreign key to B, which has a foreign key to C, tables should be listed in the following\n * order: A, B, C. Otherwise, referential constraint will break. If there is a cycle in the dependencies, you might\n * want to use a sequence of {@link SqlOperation} to disable the foreign key constraints, then delete everything\n * from the tables, then use another sequence of {@link SqlOperation} to re-enable the foreign key constraints.\n * @param tables the tables to delete everything from.\n */\n public static Operation from(@Nonnull String... tables) {\n return from(Arrays.asList(tables));\n }\n\n /**\n * Returns a composite operation which deletes all the rows from the given tables, in the same order as the\n * tables. If A has a foreign key to B, which has a foreign key to C, tables should be listed in the following\n * order: A, B, C. Otherwise, referential constraint will break. If there is a cycle in the dependencies, you might\n * want to use a sequence of {@link SqlOperation} to disable the foreign key constraints, then delete everything\n * from the tables, then use another sequence of {@link SqlOperation} to re-enable the foreign key constraints.\n * @param tables the tables to delete everything from.\n */\n public static Operation from(@Nonnull List tables) {\n List operations = new ArrayList(tables.size());\n for (String table : tables) {\n operations.add(new DeleteAll(table));\n }\n return CompositeOperation.sequenceOf(operations);\n }\n\n @Override\n public String toString() {\n return \"delete from \" + table;\n }\n\n @Override\n public int hashCode() {\n return table.hashCode();\n }\n\n @Override\n public boolean equals(Object obj) {\n if (this == obj) {\n return true;\n }\n if (obj == null) {\n return false;\n }\n if (getClass() != obj.getClass()) {\n return false;\n }\n DeleteAll other = (DeleteAll) obj;\n return this.table.equals(other.table);\n }\n}\n"
},
{
"path": "DbSetup-core/src/main/java/com/ninja_squad/dbsetup/operation/Insert.java",
"content": "/*\n * The MIT License\n *\n * Copyright (c) 2012-2016, Ninja Squad\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n * THE SOFTWARE.\n */\n\npackage com.ninja_squad.dbsetup.operation;\n\nimport javax.annotation.Nonnull;\nimport javax.annotation.concurrent.Immutable;\nimport java.sql.Connection;\nimport java.sql.ParameterMetaData;\nimport java.sql.PreparedStatement;\nimport java.sql.SQLException;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.HashMap;\nimport java.util.HashSet;\nimport java.util.Iterator;\nimport java.util.LinkedHashMap;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Set;\n\nimport com.ninja_squad.dbsetup.bind.Binder;\nimport com.ninja_squad.dbsetup.bind.BinderConfiguration;\nimport com.ninja_squad.dbsetup.bind.Binders;\nimport com.ninja_squad.dbsetup.generator.ValueGenerator;\nimport com.ninja_squad.dbsetup.generator.ValueGenerators;\nimport com.ninja_squad.dbsetup.util.Preconditions;\n\n/**\n * Operation which inserts one or several rows into a table. Example usage:\n *
\n *\n * The above operation will insert two rows inside the CLIENT table. For each row, the column DELETED will be set to\n * false and the column VERSION will be set to 1. For the column CLIENT_TYPE, instead of using the\n * {@link Binder} associated to the type of the column found in the metadata of the table, a custom binder will be used.\n *
\n * Instead of specifying values as an ordered sequence which must match the sequence of column names, some might prefer\n * passing a map of column/value associations. This makes things more verbose, but can be more readable in some cases,\n * when the number of columns is high. This also allows not specifying any value for columns that must stay null.\n * The map can be constructed like any other map and passed to the builder, or it can be added using a fluent builder.\n * The following snippet:\n *\n *
\n * Insert insert =\n * Insert.into(\"CLIENT\")\n * .columns(\"CLIENT_ID\", \"FIRST_NAME\", \"LAST_NAME\", \"DATE_OF_BIRTH\", \"CLIENT_TYPE\")\n * .row().column(\"CLIENT_ID\", 1L)\n * .column(\"FIRST_NAME\", \"John\")\n * .column(\"LAST_NAME\", \"Doe\")\n * .column(\"DATE_OF_BIRTH\", \"1975-07-19\")\n * .end()\n * .row().column(\"CLIENT_ID\", 2L)\n * .column(\"FIRST_NAME\", \"Jack\")\n * .column(\"LAST_NAME\", \"Smith\")\n * .end() // null date of birth, because it's not in the row\n * .build();\n *
\n *\n * When building the Insert using column/value associations, it might seem redundant to specify the set of column names\n * before inserting the rows. Remember, though, that all the rows of an Insert are inserted using the same\n * parameterized SQL query. We thus need a robust and easy way to know all the columns to insert for every row of the\n * insert. To be able to spot errors easily and early, and to avoid complex rules, the rule is thus simple: the set of\n * columns (excluding the generated ones) is specified either by columns(), or by the columns of the first row. All the\n * subsequent rows may not have additional columns. And null is inserted for all the absent columns of the\n * subsequent rows. The above example can thus be written as\n *\n *
\n * Insert insert =\n * Insert.into(\"CLIENT\")\n * .row().column(\"CLIENT_ID\", 1L)\n * .column(\"FIRST_NAME\", \"John\")\n * .column(\"LAST_NAME\", \"Doe\")\n * .column(\"DATE_OF_BIRTH\", \"1975-07-19\")\n * .end()\n * .row().column(\"CLIENT_ID\", 2L)\n * .column(\"FIRST_NAME\", \"Jack\")\n * .column(\"LAST_NAME\", \"Smith\")\n * .end() // null date of birth, because it's not in the row\n * .build();\n *
\n *\n * but the following will throw an exception, because the DATE_OF_BIRTH column is not part of the first row:\n *\n *