Improve support for 'requires runtime' in javadoc task

#20

Author: jjohannes

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-rc-3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesPlugin.java

@@ -33,7 +33,6 @@
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.SourceSetContainer;
 import org.gradle.api.tasks.TaskProvider;
-import org.gradle.api.tasks.compile.JavaCompile;
 import org.gradle.util.GradleVersion;
 import org.gradlex.javamodule.dependencies.internal.bridges.ExtraJavaModuleInfoBridge;
 import org.gradlex.javamodule.dependencies.internal.compile.AddSyntheticModulesToCompileClasspathAction;
@@ -55,6 +54,8 @@
 import static org.gradlex.javamodule.dependencies.internal.utils.ModuleNamingUtil.sourceSetToModuleName;
 import static java.util.Optional.empty;
 import static org.gradle.api.plugins.HelpTasksPlugin.HELP_GROUP;
+import static org.gradlex.javamodule.dependencies.internal.utils.TaskConfigurationUtil.isJavaCompileTask;
+import static org.gradlex.javamodule.dependencies.internal.utils.TaskConfigurationUtil.isJavadocTask;
 
 @SuppressWarnings("unused")
 @NonNullApi
@@ -88,12 +89,14 @@ private void setupForJavaProject(Project project, JavaModuleDependenciesExtensio
             process(ModuleInfo.Directive.REQUIRES_STATIC_TRANSITIVE, sourceSet.getCompileOnlyApiConfigurationName(), sourceSet, project, javaModuleDependencies);
             process(ModuleInfo.Directive.REQUIRES_RUNTIME, sourceSet.getRuntimeOnlyConfigurationName(), sourceSet, project, javaModuleDependencies);
 
-            project.getTasks().named(sourceSet.getCompileJavaTaskName(), JavaCompile.class, javaCompile -> {
-                ModuleInfo moduleInfo = findModuleInfoInSourceSet(sourceSet, project);
-                List<String> requiresRuntime = moduleInfo.get(ModuleInfo.Directive.REQUIRES_RUNTIME);
-                if (!requiresRuntime.isEmpty()) {
-                    javaCompile.doFirst(project.getObjects().newInstance(AddSyntheticModulesToCompileClasspathAction.class,
-                            project.getLayout().getBuildDirectory().dir("tmp").get().getAsFile(), requiresRuntime));
+            project.getTasks().configureEach(task -> {
+                if (isJavaCompileTask(task, sourceSet) || isJavadocTask(task, sourceSet)) {
+                    List<String> requiresRuntime =
+                            findModuleInfoInSourceSet(sourceSet, project).get(ModuleInfo.Directive.REQUIRES_RUNTIME);
+                    if (!requiresRuntime.isEmpty()) {
+                        task.doFirst(project.getObjects().newInstance(AddSyntheticModulesToCompileClasspathAction.class,
+                                project.getLayout().getBuildDirectory().dir("tmp/java-module-dependencies/" + task.getName()).get().getAsFile(), requiresRuntime));
+                    }
                 }
             });
         });

src/main/java/org/gradlex/javamodule/dependencies/internal/compile/AddSyntheticModulesToCompileClasspathAction.java

@@ -22,6 +22,7 @@
 import org.gradle.api.file.ConfigurableFileCollection;
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.tasks.compile.JavaCompile;
+import org.gradle.api.tasks.javadoc.Javadoc;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfoClassCreator;
 
 import javax.inject.Inject;
@@ -48,15 +49,20 @@ public void execute(Task task) {
             return;
         }
 
-        JavaCompile javaCompile = (JavaCompile) task;
-
         ConfigurableFileCollection syntheticModuleInfoFolders = objects.fileCollection();
         for (String moduleName : moduleDependencies) {
-            File dir = new File(tmpFolder, "java-module-dependencies/" + moduleName + "-synthetic");
+            File dir = new File(tmpFolder, moduleName + "-synthetic");
             ModuleInfoClassCreator.createEmpty(moduleName, dir);
             syntheticModuleInfoFolders.from(dir);
         }
 
-        javaCompile.setClasspath(javaCompile.getClasspath().plus(syntheticModuleInfoFolders));
+        if (task instanceof JavaCompile) {
+            JavaCompile javaCompile = (JavaCompile) task;
+            javaCompile.setClasspath(javaCompile.getClasspath().plus(syntheticModuleInfoFolders));
+        }
+        if (task instanceof Javadoc) {
+            Javadoc javadoc = (Javadoc) task;
+            javadoc.setClasspath(javadoc.getClasspath().plus(syntheticModuleInfoFolders));
+        }
     }
 }

src/main/java/org/gradlex/javamodule/dependencies/internal/utils/TaskConfigurationUtil.java

@@ -0,0 +1,17 @@
+package org.gradlex.javamodule.dependencies.internal.utils;
+
+import org.gradle.api.Task;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.compile.JavaCompile;
+import org.gradle.api.tasks.javadoc.Javadoc;
+
+public class TaskConfigurationUtil {
+
+    public static boolean isJavaCompileTask(Task task, SourceSet sourceSet) {
+        return task instanceof JavaCompile && task.getName().equals(sourceSet.getCompileJavaTaskName());
+    }
+
+    public static boolean isJavadocTask(Task task, SourceSet sourceSet) {
+        return task instanceof Javadoc && task.getName().equals(sourceSet.getJavadocTaskName());
+    }
+}

src/test/groovy/org/gradlex/javamodule/dependencies/test/RequiresRuntimeTest.groovy

@@ -127,10 +127,6 @@ class RequiresRuntimeTest extends Specification {
                     implementation(gav("org.slf4j.simple", "2.0.3"))
                 }
             }
-            // TODO ideally, this should not be necessary
-            tasks.javadoc {
-                classpath = sourceSets.main.get().runtimeClasspath
-            }
         '''
         appModuleInfoFile << '''
             module org.gradlex.test.app {