Make mongo-hibernate.jar a Java module

HIBERNATE-52

Author: stIncMale

build.gradle.kts

@@ -39,15 +39,15 @@ java {
 }
 
 tasks.withType<Javadoc> {
-    exclude("/com/mongodb/hibernate/internal/**")
-    exclude("com/mongodb/hibernate/dialect/**")
-    exclude("com/mongodb/hibernate/jdbc/**")
+    //    exclude("/com/mongodb/hibernate/internal/**")
+    //    exclude("com/mongodb/hibernate/dialect/**")
+    //    exclude("com/mongodb/hibernate/jdbc/**")
 
     val standardDocletOptions = options as StandardJavadocDocletOptions
     standardDocletOptions.apply {
         author(true)
         version(true)
-        encoding = "UTF-8"
+        encoding("UTF-8")
         charSet("UTF-8")
         docEncoding("UTF-8")
         addBooleanOption("html5", true)
@@ -141,7 +141,8 @@ spotless {
 tasks.check { dependsOn(tasks.spotlessApply) }
 
 tasks.withType<JavaCompile>().configureEach {
-    options.compilerArgs.addAll(listOf("-Xlint:all", "-Werror"))
+    options.compilerArgs.addAll(
+        listOf("-Xlint:all", "-Xlint:-requires-automatic", "-Xlint:-requires-transitive-automatic", "-Werror"))
     when (this) {
         tasks.compileJava.get() ->
             options.errorprone {

src/integrationTest/java/com/mongodb/hibernate/query/AbstractQueryIntegrationTests.java

@@ -26,7 +26,7 @@
 
 import com.mongodb.client.MongoCollection;
 import com.mongodb.hibernate.TestCommandListener;
-import com.mongodb.hibernate.dialect.MongoDialect;
+import com.mongodb.hibernate.internal.dialect.TestMongoDialect;
 import com.mongodb.hibernate.junit.MongoExtension;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -251,7 +251,7 @@ private void assertAffectedCollections(Set<String> expectedAffectedCollections)
                 .containsExactlyInAnyOrderElementsOf(expectedAffectedCollections);
     }
 
-    protected static final class TranslateResultAwareDialect extends MongoDialect {
+    protected static final class TranslateResultAwareDialect extends TestMongoDialect {
         private AbstractJdbcOperationQuery capturedTranslateResult;
 
         public TranslateResultAwareDialect(DialectResolutionInfo info) {

src/integrationTest/java/com/mongodb/hibernate/query/select/LimitOffsetFetchClauseIntegrationTests.java

@@ -23,9 +23,9 @@
 import static org.hibernate.cfg.AvailableSettings.QUERY_PLAN_CACHE_ENABLED;
 import static org.junit.jupiter.params.provider.EnumSource.Mode.EXCLUDE;
 
-import com.mongodb.hibernate.dialect.MongoDialect;
 import com.mongodb.hibernate.internal.FeatureNotSupportedException;
 import com.mongodb.hibernate.internal.MongoConstants;
+import com.mongodb.hibernate.internal.dialect.TestMongoDialect;
 import com.mongodb.hibernate.query.AbstractQueryIntegrationTests;
 import com.mongodb.hibernate.query.Book;
 import java.util.Arrays;
@@ -625,7 +625,7 @@ private void setQueryOptionsAndQuery(
      * the query plan cache is hit, not whether {@link SqlAstTranslator} is reused afterwards (e.g., incompatible
      * {@link org.hibernate.query.spi.QueryOptions QueryOptions}s will end up with new translator bing created).
      */
-    protected static final class TranslatingCacheTestingDialect extends MongoDialect {
+    protected static final class TranslatingCacheTestingDialect extends TestMongoDialect {
         private final AtomicInteger selectTranslatingCounter = new AtomicInteger();
 
         public TranslatingCacheTestingDialect(DialectResolutionInfo info) {

src/main/java/com/mongodb/hibernate/cfg/MongoConfigurator.java

@@ -18,7 +18,7 @@
 
 import com.mongodb.ConnectionString;
 import com.mongodb.MongoClientSettings;
-import com.mongodb.hibernate.internal.Sealed;
+import com.mongodb.hibernate.internal.cfg.MongoConfigurationBuilder;
 import com.mongodb.hibernate.service.spi.MongoConfigurationContributor;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -74,8 +74,7 @@
  *
  * @see MongoConfigurationContributor
  */
-@Sealed
-public interface MongoConfigurator {
+public sealed interface MongoConfigurator permits MongoConfigurationBuilder {
     /**
      * Configures {@link MongoClientSettings}.
      *

src/main/java/com/mongodb/hibernate/dialect/MongoDialect.java

@@ -20,8 +20,8 @@
 import static java.lang.String.format;
 
 import com.mongodb.hibernate.internal.FeatureNotSupportedException;
-import com.mongodb.hibernate.internal.Sealed;
 import com.mongodb.hibernate.internal.dialect.MongoAggregateSupport;
+import com.mongodb.hibernate.internal.dialect.TestMongoDialect;
 import com.mongodb.hibernate.internal.dialect.function.array.MongoArrayConstructorFunction;
 import com.mongodb.hibernate.internal.dialect.function.array.MongoArrayContainsFunction;
 import com.mongodb.hibernate.internal.dialect.function.array.MongoArrayIncludesFunction;
@@ -152,8 +152,7 @@
  * href="https://docs.jboss.org/hibernate/orm/6.6/userguide/html_single/Hibernate_User_Guide.html#hql-exp-functions">HQL
  * functions</a> see {@link #initializeFunctionRegistry(FunctionContributions)}.
  */
-@Sealed
-public class MongoDialect extends Dialect {
+public sealed class MongoDialect extends Dialect permits TestMongoDialect {
     private static final DatabaseVersion MINIMUM_VERSION = DatabaseVersion.make(7);
 
     public MongoDialect(DialectResolutionInfo info) {

src/main/java/com/mongodb/hibernate/internal/Sealed.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mongodb.hibernate.internal.dialect;
+
+import com.mongodb.hibernate.dialect.MongoDialect;
+import org.hibernate.engine.jdbc.dialect.spi.DialectResolutionInfo;
+
+public abstract non-sealed class TestMongoDialect extends MongoDialect {
+    protected TestMongoDialect(DialectResolutionInfo info) {
+        super(info);
+    }
+}

src/main/java/com/mongodb/hibernate/internal/dialect/TestMongoDialect.java

@@ -0,0 +1,15 @@
+/** The MongoDB Extension for Hibernate ORM module. */
+module com.mongodb.hibernate {
+    requires java.naming;
+    requires java.sql;
+    requires jakarta.persistence;
+    requires transitive org.hibernate.orm.core;
+    requires org.mongodb.bson;
+    requires transitive org.mongodb.driver.core;
+    requires org.mongodb.driver.sync.client;
+    requires org.jspecify;
+
+    exports com.mongodb.hibernate.annotations;
+    exports com.mongodb.hibernate.cfg;
+    exports com.mongodb.hibernate.service.spi;
+}