Use aggregateJavadocClasspath Configuration

Closes gh-4

Author: rwinch

README.adoc

@@ -50,6 +50,11 @@ plugins {
 }
 ----
 
+=== aggregateJavadocClasspath Configuration
+
+This will create a `Configuration` named `aggregateJavadocClasspath` that is used to determine the classpath for the <<aggregateJavadoc Task>>.
+This `Configuration` is defaulted to include all projects that have the `io.spring.javadoc` applied to it.
+
 === aggregateJavadoc Task
 
 This will create a task named `aggregateJavadoc` of type https://docs.gradle.org/current/dsl/org.gradle.api.tasks.javadoc.Javadoc.html[`Javadoc`].
@@ -71,7 +76,7 @@ You may apply to any module, but you will need to adjust the task accordingly.
 
 === Customizing Aggregated Projects
 
-You can customize which projects' Javadoc is aggregated by explicitly providing projects for the `implementation` configuration.
+You can customize which projects' Javadoc is aggregated by explicitly providing projects for the `aggregateJavadocClasspath` configuration.
 For example, the following explicitly aggregates `module1` and `module2` regardless of which projects have `io.spring.javadoc` applied to them.
 
 [source,groovy]
@@ -81,8 +86,8 @@ plugins {
 }
 
 dependencies {
-    implementation project(':module1')
-    implementation project(':module3')
+    aggregateJavadocClasspath project(':module1')
+    aggregateJavadocClasspath project(':module3')
 }
 ----
 

src/integTest/resources/javadoc/custom-projects/aggregator/build.gradle

@@ -3,6 +3,6 @@ plugins {
 }
 
 dependencies {
-    implementation project(':module1')
-    implementation project(':module3')
+    aggregateJavadocClasspath project(':module1')
+    aggregateJavadocClasspath project(':module3')
 }

src/main/java/io/spring/gradle/javadoc/AggregateJavadocPlugin.java

@@ -28,19 +28,22 @@
 public class AggregateJavadocPlugin implements Plugin<Project> {
 	public static final String AGGREGATE_JAVADOC_TASK_NAME = "aggregateJavadoc";
 
+	public static final String AGGREGATE_JAVADOC_CLASSPATH_CONFIGURATION_NAME = "aggregateJavadocClasspath";
+
 	@Override
 	public void apply(Project project) {
 		project.getPlugins().apply(JavaPlugin.class);
-		aggregatedDependencies(project);
-		Configuration sourcesPath = sourcesPath(project);
-		aggregatedJavadoc(project,sourcesPath);
+		Configuration aggregatedConfiguration = aggregatedConfiguration(project);
+		Configuration sourcesPath = sourcesPath(project, aggregatedConfiguration);
+		aggregatedJavadoc(project,sourcesPath, aggregatedConfiguration);
 	}
 
-	private void aggregatedDependencies(Project project) {
+	private Configuration aggregatedConfiguration(Project project) {
 		ConfigurationContainer configurations = project.getConfigurations();
-		Configuration implementation = configurations
-				.getByName(JavaPlugin.IMPLEMENTATION_CONFIGURATION_NAME);
-		implementation.defaultDependencies(new Action<DependencySet>() {
+		Configuration aggregatedConfiguration = configurations
+				.maybeCreate(AGGREGATE_JAVADOC_CLASSPATH_CONFIGURATION_NAME);
+		configurations.getByName(JavaPlugin.IMPLEMENTATION_CONFIGURATION_NAME).extendsFrom(aggregatedConfiguration);
+		aggregatedConfiguration.defaultDependencies(new Action<DependencySet>() {
 			@Override
 			public void execute(DependencySet defaultDependencies) {
 				project.getGradle().getRootProject().subprojects(new Action<Project>() {
@@ -58,17 +61,18 @@ public void execute(JavadocPlugin javadoc) {
 				});
 			}
 		});
+		return aggregatedConfiguration;
 	}
 
-	private Configuration sourcesPath(Project project) {
+	private Configuration sourcesPath(Project project, Configuration aggregatedConfiguration) {
 		ConfigurationContainer configurations = project.getConfigurations();
 		return configurations.create("sourcesPath", new Action<Configuration>() {
 			@Override
-			public void execute(Configuration config) {
-				config.setCanBeResolved(true);
-				config.setCanBeConsumed(false);
-				config.extendsFrom(configurations.getByName(JavaPlugin.IMPLEMENTATION_CONFIGURATION_NAME));
-				config.attributes(new Action<AttributeContainer>() {
+			public void execute(Configuration sourcesPath) {
+				sourcesPath.setCanBeResolved(true);
+				sourcesPath.setCanBeConsumed(false);
+				sourcesPath.extendsFrom(aggregatedConfiguration);
+				sourcesPath.attributes(new Action<AttributeContainer>() {
 					@Override
 					public void execute(AttributeContainer attributes) {
 						ObjectFactory objects = project.getObjects();
@@ -80,7 +84,7 @@ public void execute(AttributeContainer attributes) {
 								Attribute.of("org.gradle.docselements", String.class), "sources");
 					}
 				});
-				config.outgoing(new Action<ConfigurationPublications>() {
+				sourcesPath.outgoing(new Action<ConfigurationPublications>() {
 					@Override
 					public void execute(
 							ConfigurationPublications publications) {
@@ -100,16 +104,15 @@ public void accept(File file) {
 		});
 	}
 
-	private void aggregatedJavadoc(Project project, Configuration sourcesPath) {
+	private void aggregatedJavadoc(Project project, Configuration sourcesPath, Configuration aggregatedConfiguration) {
 		project.getTasks().create(AGGREGATE_JAVADOC_TASK_NAME, Javadoc.class, new Action<Javadoc>() {
 			@Override
 			public void execute(Javadoc javadoc) {
 				javadoc.setGroup("Documentation");
 				javadoc.setDescription("Generates the aggregate Javadoc");
 				ConfigurationContainer configurations = project.getConfigurations();
-				Configuration compile = configurations.getByName(JavaPlugin.COMPILE_CLASSPATH_CONFIGURATION_NAME);
 				javadoc.setSource(sourcesPath);
-				javadoc.setClasspath(compile);
+				javadoc.setClasspath(aggregatedConfiguration);
 			}
 		});
 	}