Reuse getSources logic for Jvm languages

diffplug · Mar 11, 2023 · dafe3c8 · dafe3c8
1 parent da0f09b
commit dafe3c8
Show file tree

Hide file tree

Showing 5 changed files with 92 additions and 128 deletions.
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/GroovyExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/GroovyExtension.java
@@ -23,22 +23,18 @@
 
 import org.gradle.api.GradleException;
 import org.gradle.api.Project;
-import org.gradle.api.file.FileCollection;
 import org.gradle.api.internal.plugins.DslObject;
 import org.gradle.api.plugins.GroovyBasePlugin;
-import org.gradle.api.plugins.JavaPluginConvention;
-import org.gradle.api.plugins.JavaPluginExtension;
 import org.gradle.api.tasks.GroovySourceDirectorySet;
 import org.gradle.api.tasks.GroovySourceSet;
-import org.gradle.api.tasks.SourceSet;
 import org.gradle.util.GradleVersion;
 
 import com.diffplug.spotless.extra.EclipseBasedStepBuilder;
 import com.diffplug.spotless.extra.groovy.GrEclipseFormatterStep;
 import com.diffplug.spotless.generic.LicenseHeaderStep;
 import com.diffplug.spotless.java.ImportOrderStep;
 
-public class GroovyExtension extends FormatExtension implements HasBuiltinDelimiterForLicense {
+public class GroovyExtension extends FormatExtension implements HasBuiltinDelimiterForLicense, JvmLang {
 	static final String NAME = "groovy";
 
 	@Inject
@@ -108,43 +104,28 @@ public void configFile(Object... configFiles) {
 	@Override
 	protected void setupTask(SpotlessTask task) {
 		if (target == null) {
-			if (GradleVersion.current().compareTo(GradleVersion.version("7.1")) >= 0) {
-				JavaPluginExtension javaPluginExtension = getProject().getExtensions().findByType(JavaPluginExtension.class);
-				if (javaPluginExtension == null || !getProject().getPlugins().hasPlugin(GroovyBasePlugin.class)) {
-					throw new GradleException("You must apply the groovy plugin before the spotless plugin if you are using the groovy extension.");
-				}
-				//Add all Groovy files (may contain Java files as well)
-
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : javaPluginExtension.getSourceSets()) {
-					union = union.plus(sourceSet.getExtensions().getByType(GroovySourceDirectorySet.class).filter(file -> {
-						String name = file.getName();
+			final String message = "You must apply the groovy plugin before the spotless plugin if you are using the groovy extension.";
+			if (!getProject().getPlugins().hasPlugin(GroovyBasePlugin.class)) {
+				throw new GradleException(message);
+			}
+			target = getSources(getProject(),
+					message,
+					sourceSet -> {
+						if (GradleVersion.current().compareTo(GradleVersion.version("7.1")) >= 0) {
+							return sourceSet.getExtensions().getByType(GroovySourceDirectorySet.class);
+						} else {
+							final GroovySourceSet groovySourceSet = new DslObject(sourceSet).getConvention().getPlugin(GroovySourceSet.class);
+							return groovySourceSet.getGroovy();
+						}
+					},
+					file -> {
+						final String name = file.getName();
 						if (excludeJava) {
 							return name.endsWith(".groovy");
 						} else {
 							return name.endsWith(".groovy") || name.endsWith(".java");
 						}
-					}));
-				}
-				target = union;
-			} else {
-				JavaPluginConvention convention = getProject().getConvention().getPlugin(JavaPluginConvention.class);
-				if (convention == null || !getProject().getPlugins().hasPlugin(GroovyBasePlugin.class)) {
-					throw new GradleException("You must apply the groovy plugin before the spotless plugin if you are using the groovy extension.");
-				}
-				//Add all Groovy files (may contain Java files as well)
-
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : convention.getSourceSets()) {
-					GroovySourceSet groovySourceSet = new DslObject(sourceSet).getConvention().getPlugin(GroovySourceSet.class);
-					if (excludeJava) {
-						union = union.plus(groovySourceSet.getAllGroovy());
-					} else {
-						union = union.plus(groovySourceSet.getGroovy());
-					}
-				}
-				target = union;
-			}
+					});
 		} else if (excludeJava) {
 			throw new IllegalArgumentException("'excludeJava' is not supported in combination with a custom 'target'.");
 		}

diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java
@@ -25,13 +25,8 @@
 
 import javax.inject.Inject;
 
-import org.gradle.api.GradleException;
 import org.gradle.api.Project;
-import org.gradle.api.file.FileCollection;
-import org.gradle.api.plugins.JavaPluginConvention;
-import org.gradle.api.plugins.JavaPluginExtension;
 import org.gradle.api.tasks.SourceSet;
-import org.gradle.util.GradleVersion;
 
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.extra.EclipseBasedStepBuilder;
@@ -44,7 +39,7 @@
 import com.diffplug.spotless.java.PalantirJavaFormatStep;
 import com.diffplug.spotless.java.RemoveUnusedImportsStep;
 
-public class JavaExtension extends FormatExtension implements HasBuiltinDelimiterForLicense {
+public class JavaExtension extends FormatExtension implements HasBuiltinDelimiterForLicense, JvmLang {
 	static final String NAME = "java";
 
 	@Inject
@@ -361,27 +356,10 @@ private FormatterStep createStep() {
 	@Override
 	protected void setupTask(SpotlessTask task) {
 		if (target == null) {
-			if (GradleVersion.current().compareTo(GradleVersion.version("7.1")) >= 0) {
-				JavaPluginExtension javaPluginExtension = getProject().getExtensions().findByType(JavaPluginExtension.class);
-				if (javaPluginExtension == null) {
-					throw new GradleException("You must either specify 'target' manually or apply the 'java' plugin.");
-				}
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : javaPluginExtension.getSourceSets()) {
-					union = union.plus(sourceSet.getAllJava());
-				}
-				target = union;
-			} else {
-				JavaPluginConvention javaPlugin = getProject().getConvention().findPlugin(JavaPluginConvention.class);
-				if (javaPlugin == null) {
-					throw new GradleException("You must either specify 'target' manually or apply the 'java' plugin.");
-				}
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : javaPlugin.getSourceSets()) {
-					union = union.plus(sourceSet.getAllJava());
-				}
-				target = union;
-			}
+			target = getSources(getProject(),
+					"You must either specify 'target' manually or apply the 'java' plugin.",
+					SourceSet::getAllJava,
+					file -> file.getName().endsWith(".java"));
 		}
 
 		steps.replaceAll(step -> {

diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JvmLang.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JvmLang.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2023 DiffPlug
+ *
+ * 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.diffplug.gradle.spotless;
+
+import java.io.File;
+import java.util.function.Function;
+
+import org.gradle.api.GradleException;
+import org.gradle.api.Project;
+import org.gradle.api.file.FileCollection;
+import org.gradle.api.file.SourceDirectorySet;
+import org.gradle.api.plugins.JavaPluginConvention;
+import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.specs.Spec;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.SourceSetContainer;
+import org.gradle.util.GradleVersion;
+
+interface JvmLang {
+
+	default FileCollection getSources(Project project, String message, Function<SourceSet, SourceDirectorySet> sourceSetSourceDirectory, Spec<? super File> filterSpec) {
+		final SourceSetContainer sourceSets;
+		FileCollection union = project.files();
+		if (GradleVersion.current().compareTo(GradleVersion.version("7.1")) >= 0) {
+			final JavaPluginExtension javaPluginExtension = project.getExtensions().findByType(JavaPluginExtension.class);
+			if (javaPluginExtension == null) {
+				throw new GradleException(message);
+			}
+			sourceSets = javaPluginExtension.getSourceSets();
+		} else {
+			final JavaPluginConvention javaPluginConvention = project.getConvention().findPlugin(JavaPluginConvention.class);
+			if (javaPluginConvention == null) {
+				throw new GradleException(message);
+			}
+			sourceSets = javaPluginConvention.getSourceSets();
+		}
+		for (SourceSet sourceSet : sourceSets) {
+			union = union.plus(sourceSetSourceDirectory.apply(sourceSet).filter(filterSpec));
+		}
+		return union;
+	}
+}
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinExtension.java
@@ -27,12 +27,7 @@
 import javax.annotation.Nullable;
 import javax.inject.Inject;
 
-import org.gradle.api.GradleException;
-import org.gradle.api.file.FileCollection;
-import org.gradle.api.plugins.JavaPluginConvention;
-import org.gradle.api.plugins.JavaPluginExtension;
 import org.gradle.api.tasks.SourceSet;
-import org.gradle.util.GradleVersion;
 
 import com.diffplug.common.collect.ImmutableSortedMap;
 import com.diffplug.spotless.FileSignature;
@@ -43,7 +38,7 @@
 import com.diffplug.spotless.kotlin.KtfmtStep.KtfmtFormattingOptions;
 import com.diffplug.spotless.kotlin.KtfmtStep.Style;
 
-public class KotlinExtension extends FormatExtension implements HasBuiltinDelimiterForLicense {
+public class KotlinExtension extends FormatExtension implements HasBuiltinDelimiterForLicense, JvmLang {
 	static final String NAME = "kotlin";
 
 	@Inject
@@ -232,33 +227,13 @@ private FormatterStep createStep() {
 	@Override
 	protected void setupTask(SpotlessTask task) {
 		if (target == null) {
-			if (GradleVersion.current().compareTo(GradleVersion.version("7.1")) >= 0) {
-				JavaPluginExtension javaPluginExtension = getProject().getExtensions().findByType(JavaPluginExtension.class);
-				if (javaPluginExtension == null) {
-					throw new GradleException("You must either specify 'target' manually or apply a kotlin plugin.");
-				}
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : javaPluginExtension.getSourceSets()) {
-					union = union.plus(sourceSet.getAllSource().filter(file -> {
-						String name = file.getName();
+			target = getSources(getProject(),
+					"You must either specify 'target' manually or apply a kotlin plugin.",
+					SourceSet::getAllSource,
+					file -> {
+						final String name = file.getName();
 						return name.endsWith(".kt") || name.endsWith(".kts");
-					}));
-				}
-				target = union;
-			} else {
-				JavaPluginConvention javaPlugin = getProject().getConvention().findPlugin(JavaPluginConvention.class);
-				if (javaPlugin == null) {
-					throw new GradleException("You must either specify 'target' manually or apply a kotlin plugin.");
-				}
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : javaPlugin.getSourceSets()) {
-					union = union.plus(sourceSet.getAllSource().filter(file -> {
-						String name = file.getName();
-						return name.endsWith(".kt") || name.endsWith(".kts");
-					}));
-				}
-				target = union;
-			}
+					});
 		}
 		super.setupTask(task);
 	}

diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/ScalaExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/ScalaExtension.java
@@ -21,17 +21,12 @@
 import javax.annotation.Nullable;
 import javax.inject.Inject;
 
-import org.gradle.api.GradleException;
-import org.gradle.api.file.FileCollection;
-import org.gradle.api.plugins.JavaPluginConvention;
-import org.gradle.api.plugins.JavaPluginExtension;
 import org.gradle.api.tasks.SourceSet;
-import org.gradle.util.GradleVersion;
 
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.scala.ScalaFmtStep;
 
-public class ScalaExtension extends FormatExtension {
+public class ScalaExtension extends FormatExtension implements JvmLang {
 	static final String NAME = "scala";
 
 	@Inject
@@ -81,33 +76,13 @@ private FormatterStep createStep() {
 	@Override
 	protected void setupTask(SpotlessTask task) {
 		if (target == null) {
-			if (GradleVersion.current().compareTo(GradleVersion.version("7.1")) >= 0) {
-				JavaPluginExtension javaPluginExtension = getProject().getExtensions().findByType(JavaPluginExtension.class);
-				if (javaPluginExtension == null) {
-					throw new GradleException("You must either specify 'target' manually or apply the 'scala' plugin.");
-				}
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : javaPluginExtension.getSourceSets()) {
-					union = union.plus(sourceSet.getAllSource().filter(file -> {
-						String name = file.getName();
+			target = getSources(getProject(),
+					"You must either specify 'target' manually or apply the 'scala' plugin.",
+					SourceSet::getAllSource,
+					file -> {
+						final String name = file.getName();
 						return name.endsWith(".scala") || name.endsWith(".sc");
-					}));
-				}
-				target = union;
-			} else {
-				JavaPluginConvention javaPlugin = getProject().getConvention().findPlugin(JavaPluginConvention.class);
-				if (javaPlugin == null) {
-					throw new GradleException("You must either specify 'target' manually or apply the 'scala' plugin.");
-				}
-				FileCollection union = getProject().files();
-				for (SourceSet sourceSet : javaPlugin.getSourceSets()) {
-					union = union.plus(sourceSet.getAllSource().filter(file -> {
-						String name = file.getName();
-						return name.endsWith(".scala") || name.endsWith(".sc");
-					}));
-				}
-				target = union;
-			}
+					});
 		}
 		super.setupTask(task);
 	}