HHH-19869 List community dialects in dialect guide

Author: yrodiere

documentation/documentation.gradle

@@ -139,6 +139,7 @@ dependencies {
 	reportAggregation project(':hibernate-ant')
 	reportAggregation project(':hibernate-enhance-maven-plugin')
 	reportAggregation project(':hibernate-jpamodelgen')
+    reportAggregation project(':hibernate-community-dialects')
 
 	asciidoctorGems 'rubygems:rouge:4.1.1'
 
@@ -813,7 +814,7 @@ def renderDialectGuideTask = tasks.register( 'renderDialectGuide', AsciidoctorTa
     group = "Documentation"
     description = 'Renders the Dialect guide in HTML format using Asciidoctor.'
     inputs.property "hibernate-version", project.ormVersion
-    dependsOn generateDialectTableReport
+    dependsOn generateDialectTableReport, generateCommunityDialectTableReport
 
     sourceDir = file( 'src/main/asciidoc/dialect' )
     sources 'dialect.adoc'

documentation/src/main/asciidoc/dialect/dialect.adoc

@@ -35,9 +35,9 @@ These dialects are not directly supported by the Hibernate team:
 
 Instead, the dialects are maintained on a best-effort basis by vendors or individuals.
 
-// TODO:
-// Below is a list of community dialects and the minimum required version of the database.
-// include::{generated-report-dir}/dialect/dialect-table-community.adoc[]
+Below is a list of community dialects and the minimum required version of the database.
+
+include::{generated-report-dir}/dialect/dialect-table-community.adoc[]
 
 [NOTE]
 ====

local-build-plugins/src/main/java/org/hibernate/orm/post/DialectReportTask.java

@@ -22,6 +22,7 @@
 import org.gradle.api.file.RegularFile;
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.Provider;
+import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.OutputFile;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.SourceSetContainer;
@@ -36,13 +37,27 @@
  * @author Steve Ebersole
  */
 public abstract class DialectReportTask extends AbstractJandexAwareTask {
+	private final Property<String> sourceProject;
+	private final Property<String> sourcePackage;
 	private final Property<RegularFile> reportFile;
 
 	public DialectReportTask() {
-		setDescription( "Generates a report of the supported Dialects" );
+		setDescription( "Generates a report of Dialects" );
+		sourceProject = getProject().getObjects().property(String.class);
+		sourcePackage = getProject().getObjects().property(String.class);
 		reportFile = getProject().getObjects().fileProperty();
 	}
 
+	@Input
+	public Property<String> getSourceProject() {
+		return sourceProject;
+	}
+
+	@Input
+	public Property<String> getSourcePackage() {
+		return sourcePackage;
+	}
+
 	@OutputFile
 	public Property<RegularFile> getReportFile() {
 		return reportFile;
@@ -55,16 +70,19 @@ protected Provider<RegularFile> getTaskReportFileReference() {
 
 	@TaskAction
 	public void generateDialectReport() {
-		// the ones we want are all in the hibernate-core project
-		final Project coreProject = getProject().getRootProject().project( "hibernate-core" );
-		final SourceSetContainer sourceSets = coreProject.getExtensions().getByType( SourceSetContainer.class );
+		// TODO this probably messes up the cache since we don't declare an explicit dependency to a source set
+		//   but the problem is pre-existing and I don't have time to investigate.
+		Project sourceProject = getProject().getRootProject().project( this.sourceProject.get() );
+		final SourceSetContainer sourceSets = sourceProject.getExtensions().getByType( SourceSetContainer.class );
 		final SourceSet sourceSet = sourceSets.getByName( SourceSet.MAIN_SOURCE_SET_NAME );
-		final ClassLoader classLoader = Helper.asClassLoader( sourceSet, coreProject.getConfigurations().getByName( "testRuntimeClasspath" ) );
+		final ClassLoader classLoader = Helper.asClassLoader( sourceSet, sourceProject.getConfigurations().getByName( "testRuntimeClasspath" ) );
 
 		final DialectClassDelegate dialectClassDelegate = new DialectClassDelegate( classLoader );
 
 		final Index index = getIndexManager().getIndex();
 		final Collection<ClassInfo> allDialectClasses = index.getAllKnownSubclasses( DialectClassDelegate.DIALECT_CLASS_NAME );
+		String sourcePackagePrefix = this.sourcePackage.get() + ".";
+		allDialectClasses.removeIf( c -> !c.name().toString().startsWith( sourcePackagePrefix ) );
 		if ( allDialectClasses.isEmpty() ) {
 			throw new RuntimeException( "Unable to find Dialects" );
 		}

local-build-plugins/src/main/java/org/hibernate/orm/post/ReportGenerationPlugin.java

@@ -62,10 +62,23 @@ public void apply(Project project) {
 				DialectReportTask.class,
 				(task) -> {
 					task.dependsOn( indexerTask );
+					task.setProperty( "sourceProject", "hibernate-core" );
+					task.setProperty( "sourcePackage", "org.hibernate.dialect" );
 					task.setProperty( "reportFile", project.getLayout().getBuildDirectory().file( "orm/generated/dialect/dialect-table.adoc" ) );
 				}
 		);
 
+		final TaskProvider<DialectReportTask> communityDialectTableTask = project.getTasks().register(
+				"generateCommunityDialectTableReport",
+				DialectReportTask.class,
+				(task) -> {
+					task.dependsOn( indexerTask );
+					task.setProperty( "sourceProject", "hibernate-community-dialects" );
+					task.setProperty( "sourcePackage", "org.hibernate.community.dialect" );
+					task.setProperty( "reportFile", project.getLayout().getBuildDirectory().file( "orm/generated/dialect/dialect-table-community.adoc" ) );
+				}
+		);
+
 		final Task groupingTask = project.getTasks().maybeCreate( "generateReports" );
 		groupingTask.setGroup( TASK_GROUP_NAME );
 		groupingTask.dependsOn( indexerTask );
@@ -74,5 +87,6 @@ public void apply(Project project) {
 		groupingTask.dependsOn( internalsTask );
 		groupingTask.dependsOn( loggingTask );
 		groupingTask.dependsOn( dialectTableTask );
+		groupingTask.dependsOn( communityDialectTableTask );
 	}
 }