Contribute groovy source sets with extension

subprojects/code-quality/src/main/groovy/org/gradle/api/plugins/quality/CodeNarcPlugin.java

@@ -19,14 +19,14 @@
 import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.file.ProjectLayout;
 import org.gradle.api.file.RegularFile;
+import org.gradle.api.file.SourceDirectorySet;
 import org.gradle.api.internal.ConventionMapping;
-import org.gradle.api.internal.plugins.DslObject;
 import org.gradle.api.plugins.GroovyBasePlugin;
 import org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.provider.ProviderFactory;
+import org.gradle.api.tasks.GroovySourceDirectorySet;
 import org.gradle.api.tasks.SourceSet;
-import org.gradle.internal.metaobject.DynamicObject;
 
 import java.io.File;
 
@@ -114,7 +114,7 @@ private void configureReportsConventionMapping(CodeNarc task, final String baseN
     @Override
     protected void configureForSourceSet(final SourceSet sourceSet, CodeNarc task) {
         task.setDescription("Run CodeNarc analysis for " + sourceSet.getName() + " classes");
-        DynamicObject dynamicObject = new DslObject(sourceSet).getAsDynamicObject();
-        task.setSource(dynamicObject.getProperty("allGroovy"));
+        SourceDirectorySet groovySourceSet =  sourceSet.getExtensions().getByType(GroovySourceDirectorySet.class);
+        task.setSource(groovySourceSet.matching(filter -> filter.include("**/*.groovy")));
     }
 }

subprojects/core/src/main/java/org/gradle/api/internal/file/DefaultSourceDirectorySet.java

@@ -67,15 +67,35 @@ public class DefaultSourceDirectorySet extends CompositeFileTree implements Sour
     private TaskProvider<?> compileTaskProvider;
 
     public DefaultSourceDirectorySet(String name, String displayName, Factory<PatternSet> patternSetFactory, FileCollectionFactory fileCollectionFactory, DirectoryFileTreeFactory directoryFileTreeFactory, ObjectFactory objectFactory) {
+        this(name, displayName, patternSetFactory.create(), patternSetFactory.create(), fileCollectionFactory, directoryFileTreeFactory, objectFactory.directoryProperty(), objectFactory.directoryProperty());
+    }
+
+    DefaultSourceDirectorySet(String name, String displayName, PatternSet patterns, PatternSet filters, FileCollectionFactory fileCollectionFactory, DirectoryFileTreeFactory directoryFileTreeFactory, DirectoryProperty destinationDirectory, DirectoryProperty classesDirectory) {
         this.name = name;
         this.displayName = displayName;
         this.fileCollectionFactory = fileCollectionFactory;
         this.directoryFileTreeFactory = directoryFileTreeFactory;
-        this.patterns = patternSetFactory.create();
-        this.filter = patternSetFactory.create();
+        this.patterns = patterns;
+        this.filter = filters;
+        this.dirs = new FileCollectionAdapter(new SourceDirectories());
+        this.destinationDirectory = destinationDirectory;
+        this.classesDirectory = classesDirectory;
+    }
+
+    public DefaultSourceDirectorySet(SourceDirectorySet sourceSet) {
+        if (!(sourceSet instanceof DefaultSourceDirectorySet)) {
+            throw new RuntimeException("Invalid source set type:" + source.getClass());
+        }
+        DefaultSourceDirectorySet defaultSourceSet = (DefaultSourceDirectorySet) sourceSet;
+        this.name = defaultSourceSet.name;
+        this.displayName = defaultSourceSet.displayName;
+        this.fileCollectionFactory = defaultSourceSet.fileCollectionFactory;
+        this.directoryFileTreeFactory = defaultSourceSet.directoryFileTreeFactory;
+        this.patterns = defaultSourceSet.patterns;
+        this.filter = defaultSourceSet.filter;
         this.dirs = new FileCollectionAdapter(new SourceDirectories());
-        this.destinationDirectory = objectFactory.directoryProperty();
-        this.classesDirectory = objectFactory.directoryProperty();
+        this.destinationDirectory = defaultSourceSet.destinationDirectory;
+        this.classesDirectory = defaultSourceSet.classesDirectory;
     }
 
     @Override

subprojects/docs/src/docs/dsl/org.gradle.api.tasks.GroovySourceDirectorySet.xml

@@ -0,0 +1,23 @@
+<section>
+    <section>
+        <title>Properties</title>
+        <table>
+            <thead>
+                <tr>
+                    <td>Name</td>
+                    <td>Default with <literal>groovy</literal> plugin</td>
+                </tr>
+            </thead>
+        </table>
+    </section>
+    <section>
+        <title>Methods</title>
+        <table>
+            <thead>
+                <tr>
+                    <td>Name</td>
+                </tr>
+            </thead>
+        </table>
+    </section>
+</section>

subprojects/docs/src/docs/dsl/plugins.xml

@@ -8,6 +8,7 @@
     </plugin>
     <plugin id="groovy" description="Groovy Plugin">
         <extends targetClass="org.gradle.api.tasks.SourceSet" mixinClass="org.gradle.api.tasks.GroovySourceSet"/>
+        <extends targetClass="org.gradle.api.tasks.SourceSet" mixinClass="org.gradle.api.tasks.GroovySourceDirectorySet"/>
     </plugin>
     <plugin id="publishing" description="Publishing Plugin">
         <extends targetClass="org.gradle.api.Project" id="publishing" extensionClass="org.gradle.api.publish.PublishingExtension"/>

subprojects/docs/src/docs/release/notes.md

@@ -102,6 +102,34 @@ class JavaAgentCommandLineArgumentProvider implements CommandLineArgumentProvide
 }
 ```
 
+### Easier groovy source set configuration in the Kotlin DSL
+
+When using the Kotlin DSL a special construct was required for configuring `groovy` sources:
+
+```kotlin
+sourceSets {
+    main {
+        withConvention(GroovySourceSet::class) {
+            groovy {
+                setSrcDirs(listOf("src/groovy"))
+            }
+        }
+    }
+}
+```
+
+Gradle 7.1 defines the `groovy` source set as an extension. This means that the Kotlin-DSL has auto-generated accessors and `withConvention` block can be omitted:
+
+```kotlin
+sourceSets {
+    main {
+        groovy {
+            setSrcDirs(listOf("src/groovy"))
+        }
+    }
+}
+```
+
 ## Promoted features
 Promoted features are features that were incubating in previous versions of Gradle but are now supported and subject to backwards compatibility.
 See the User Manual section on the “[Feature Lifecycle](userguide/feature_lifecycle.html)” for more information.

subprojects/docs/src/docs/userguide/jvm/groovy_plugin.adoc

@@ -166,11 +166,11 @@ The Groovy plugin does not add any convention properties to the project.
 [[sec:groovy_source_set_properties]]
 == Source set properties
 
-The Groovy plugin adds the following convention properties to each source set in the project. You can use these properties in your build script as though they were properties of the source set object.
+The Groovy plugin adds the following extensions to each source set in the project. You can use these properties in your build script as though they were properties of the source set object.
 
 === Groovy Plugin — source set properties
 
-`groovy` — link:{groovyDslPath}/org.gradle.api.file.SourceDirectorySet.html[SourceDirectorySet] (read-only)::
+`groovy` — link:{groovyDslPath}/org.gradle.api.tasks.GroovySourceDirectorySet.html[GroovySourceDirectorySet] (read-only)::
 _Default value_: Not null
 +
 The Groovy source files of this source set. Contains all `.groovy` and `.java` files found in the Groovy source directories, and excludes all other types of files.

subprojects/docs/src/docs/userguide/migration/upgrading_version_7.adoc

@@ -157,6 +157,33 @@ The last set of classes have no external or internal usages and therefore were d
 - `DeferredUtil`
 - `ChangeListener`
 
+==== The return type of the `groovy { }` block has changed
+The `groovy` source set is now defined via extension. This extension is backed by the link:{groovyDslPath}/org.gradle.api.tasks.GroovySourceDirectorySet.html[GroovySourceDirectorySet] interface.
+The 'idiomatic' DSL declaration is backward compatible:
+
+```groovy
+sourceSets {
+    main {
+        groovy {
+            // ...
+        }
+    }
+}
+```
+
+However, the return type of the groovy block has changed from link:{groovyDslPath}/org.gradle.api.tasks.GroovySourceSet.html[GroovySourceSet] to
+link:{groovyDslPath}/org.gradle.api.tasks.GroovySourceDirectorySet.html[GroovySourceDirectorySet]. This means that the following snippet no longer works in Gradle 7.1:
+
+```groovy
+ sourceSets {
+     main {
+         GroovySourceSet sourceSet = groovy {
+             // ...
+         }
+     }
+ }
+ ```
+
 [[java_exec_properties]]
 ==== Properties deprecated in JavaExec task
 
@@ -302,3 +329,12 @@ link:{javadocPath}/org/gradle/api/plugins/WarPluginConvention.html[WarPluginConv
 === Deprecated `ear` plugin conventions
 
 link:{javadocPath}/org/gradle/plugins/ear/EarPluginConvention.html[EarPluginConvention] is now deprecated and scheduled for removal in Gradle 8.0. Clients should configure the `ear` task directly. Also, link:{javadocPath}/org/gradle/api/DomainObjectCollection.html#withType-java.lang.Class-[tasks.withType(War.class).configureEach(...)] can be used to configure each task of type `Ear`.
+
+[[groovy_source_set_deprecation]]
+=== Deprecated `GroovySourceSet` interface
+link:{javadocPath}/org/gradle/api/tasks/GroovySourceSet.html[GroovySourceSet] is now deprecated and scheduled for removal in Gradle 8.0. Clients should configure `groovy` sources configuration via the
+the link:{javadocPath}/org/gradle/api/tasks/GroovySourceDirectorySet.html[new extension] defined on the source set object:
+```java
+GroovySourceDirectorySet groovySources = sourceSet.getExtensions().getByType(GroovySourceDirectorySet.class);
+groovySources.setSrcDirs(Arrays.asList("sources/groovy"));
+```

subprojects/docs/src/snippets/groovy/customizedLayout/kotlin/build.gradle.kts

@@ -14,18 +14,14 @@ dependencies {
 // tag::custom-source-locations[]
 sourceSets {
     main {
-        withConvention(GroovySourceSet::class) {
-            groovy {
-                setSrcDirs(listOf("src/groovy"))
-            }
+        groovy {
+            setSrcDirs(listOf("src/groovy"))
         }
     }
 
     test {
-        withConvention(GroovySourceSet::class) {
-            groovy {
-                setSrcDirs(listOf("test/groovy"))
-            }
+        groovy {
+            setSrcDirs(listOf("test/groovy"))
         }
     }
 }

subprojects/docs/src/snippets/tutorial/compileTaskClasspath/kotlin/build.gradle.kts

@@ -14,6 +14,6 @@ tasks.named<AbstractCompile>("compileGroovy") {
 tasks.named<AbstractCompile>("compileJava") {
     // Java also depends on the result of Groovy compilation
     // (which automatically makes it depend of compileGroovy)
-    classpath += files(sourceSets.main.get().withConvention(GroovySourceSet::class) { groovy }.classesDirectory)
+    classpath += files(sourceSets.main.get().groovy.classesDirectory)
 }
 // end::compile-task-classpath[]

subprojects/language-groovy/src/main/java/org/gradle/api/tasks/compile/GroovyCompile.java

@@ -36,8 +36,8 @@
 import org.gradle.api.internal.tasks.compile.GroovyCompilerFactory;
 import org.gradle.api.internal.tasks.compile.GroovyJavaJointCompileSpec;
 import org.gradle.api.internal.tasks.compile.HasCompileOptions;
-import org.gradle.api.internal.tasks.compile.MinimalJavaCompilerDaemonForkOptions;
 import org.gradle.api.internal.tasks.compile.MinimalGroovyCompileOptions;
+import org.gradle.api.internal.tasks.compile.MinimalJavaCompilerDaemonForkOptions;
 import org.gradle.api.internal.tasks.compile.incremental.IncrementalCompilerFactory;
 import org.gradle.api.internal.tasks.compile.incremental.recomp.GroovyRecompilationSpecProvider;
 import org.gradle.api.internal.tasks.compile.incremental.recomp.RecompilationSpecProvider;

subprojects/plugin-development/src/main/java/org/gradle/plugin/devel/internal/precompiled/PrecompiledGroovyPluginsPlugin.java

@@ -21,9 +21,8 @@
 import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.file.FileTree;
 import org.gradle.api.file.SourceDirectorySet;
-import org.gradle.api.internal.plugins.DslObject;
 import org.gradle.api.plugins.GroovyBasePlugin;
-import org.gradle.api.tasks.GroovySourceSet;
+import org.gradle.api.tasks.GroovySourceDirectorySet;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.TaskContainer;
 import org.gradle.api.tasks.TaskProvider;
@@ -81,7 +80,7 @@ private void exposeScriptsAsPlugins(Project project) {
             task.getPrecompiledGroovyScriptsOutputDirectory().convention(buildDir.dir("groovy-dsl-plugins/output/plugin-classes"));
 
             SourceDirectorySet javaSource = pluginSourceSet.getJava();
-            SourceDirectorySet groovySource = new DslObject(pluginSourceSet).getConvention().getPlugin(GroovySourceSet.class).getGroovy();
+            SourceDirectorySet groovySource = pluginSourceSet.getExtensions().getByType(GroovySourceDirectorySet.class);
             task.getClasspath().from(pluginSourceSet.getCompileClasspath(), javaSource.getClassesDirectory(), groovySource.getClassesDirectory());
         });
 

subprojects/plugins/src/main/java/org/gradle/api/internal/tasks/DefaultGroovySourceDirectorySet.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2021 the original author or authors.
+ *
+ * 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 org.gradle.api.internal.tasks;
+
+import org.gradle.api.file.SourceDirectorySet;
+import org.gradle.api.internal.file.DefaultSourceDirectorySet;
+import org.gradle.api.tasks.GroovySourceDirectorySet;
+
+public class DefaultGroovySourceDirectorySet extends DefaultSourceDirectorySet implements GroovySourceDirectorySet {
+
+    public DefaultGroovySourceDirectorySet(SourceDirectorySet sourceDirectorySet) {
+        super(sourceDirectorySet);
+    }
+}

subprojects/plugins/src/main/java/org/gradle/api/internal/tasks/DefaultGroovySourceSet.java

@@ -21,27 +21,34 @@
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.reflect.HasPublicType;
 import org.gradle.api.reflect.TypeOf;
+import org.gradle.api.tasks.GroovySourceDirectorySet;
 import org.gradle.api.tasks.GroovySourceSet;
 
 import javax.annotation.Nullable;
 
 import static org.gradle.api.reflect.TypeOf.typeOf;
 import static org.gradle.util.internal.ConfigureUtil.configure;
 
+@Deprecated
 public class DefaultGroovySourceSet implements GroovySourceSet, HasPublicType {
-    private final SourceDirectorySet groovy;
+    private final GroovySourceDirectorySet groovy;
     private final SourceDirectorySet allGroovy;
 
     public DefaultGroovySourceSet(String name, String displayName, ObjectFactory objectFactory) {
-        groovy = objectFactory.sourceDirectorySet(name, displayName +  " Groovy source");
-        groovy.getFilter().include("**/*.java", "**/*.groovy");
+        this.groovy = createGroovySourceDirectorySet(name, displayName, objectFactory);
         allGroovy = objectFactory.sourceDirectorySet("all" + name, displayName + " Groovy source");
         allGroovy.source(groovy);
         allGroovy.getFilter().include("**/*.groovy");
     }
 
+    private static GroovySourceDirectorySet createGroovySourceDirectorySet(String name, String displayName, ObjectFactory objectFactory) {
+        GroovySourceDirectorySet groovySourceDirectorySet = new DefaultGroovySourceDirectorySet(objectFactory.sourceDirectorySet(name, displayName + " Groovy source"));
+        groovySourceDirectorySet.getFilter().include("**/*.java", "**/*.groovy");
+        return groovySourceDirectorySet;
+    }
+
     @Override
-    public SourceDirectorySet getGroovy() {
+    public GroovySourceDirectorySet getGroovy() {
         return groovy;
     }
 

subprojects/plugins/src/main/java/org/gradle/api/plugins/GroovyBasePlugin.java

@@ -24,7 +24,6 @@
 import org.gradle.api.file.SourceDirectorySet;
 import org.gradle.api.internal.classpath.ModuleRegistry;
 import org.gradle.api.internal.plugins.DslObject;
-import org.gradle.api.internal.tasks.DefaultGroovySourceSet;
 import org.gradle.api.internal.tasks.DefaultSourceSet;
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.plugins.internal.JvmPluginsHelper;
@@ -33,6 +32,7 @@
 import org.gradle.api.provider.Provider;
 import org.gradle.api.reporting.ReportingExtension;
 import org.gradle.api.tasks.GroovyRuntime;
+import org.gradle.api.tasks.GroovySourceDirectorySet;
 import org.gradle.api.tasks.TaskProvider;
 import org.gradle.api.tasks.compile.GroovyCompile;
 import org.gradle.api.tasks.javadoc.Groovydoc;
@@ -87,10 +87,12 @@ private void configureCompileDefaults() {
         project.getTasks().withType(GroovyCompile.class).configureEach(compile -> compile.getConventionMapping().map("groovyClasspath", () -> groovyRuntime.inferGroovyClasspath(compile.getClasspath())));
     }
 
+    @SuppressWarnings("deprecation")
     private void configureSourceSetDefaults() {
         project.getExtensions().getByType(JavaPluginExtension.class).getSourceSets().all(sourceSet -> {
-            final DefaultGroovySourceSet groovySourceSet = new DefaultGroovySourceSet("groovy", ((DefaultSourceSet) sourceSet).getDisplayName(), objectFactory);
+            final org.gradle.api.internal.tasks.DefaultGroovySourceSet groovySourceSet = new org.gradle.api.internal.tasks.DefaultGroovySourceSet("groovy", ((DefaultSourceSet) sourceSet).getDisplayName(), objectFactory);
             new DslObject(sourceSet).getConvention().getPlugins().put("groovy", groovySourceSet);
+            sourceSet.getExtensions().add(GroovySourceDirectorySet.class, "groovy", groovySourceSet.getGroovy());
 
             final SourceDirectorySet groovySource = groovySourceSet.getGroovy();
             groovySource.srcDir("src/" + sourceSet.getName() + "/groovy");

subprojects/plugins/src/main/java/org/gradle/api/plugins/GroovyPlugin.java

@@ -18,8 +18,8 @@
 
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
-import org.gradle.api.internal.plugins.DslObject;
-import org.gradle.api.tasks.GroovySourceSet;
+import org.gradle.api.file.SourceDirectorySet;
+import org.gradle.api.tasks.GroovySourceDirectorySet;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.javadoc.Groovydoc;
 
@@ -47,8 +47,8 @@ private void configureGroovydoc(final Project project) {
             SourceSet sourceSet = project.getExtensions().getByType(JavaPluginExtension.class).getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME);
             groovyDoc.setClasspath(sourceSet.getOutput().plus(sourceSet.getCompileClasspath()));
 
-            GroovySourceSet groovySourceSet = new DslObject(sourceSet).getConvention().getPlugin(GroovySourceSet.class);
-            groovyDoc.setSource(groovySourceSet.getGroovy());
+            SourceDirectorySet groovySourceSet = sourceSet.getExtensions().getByType(GroovySourceDirectorySet.class);
+            groovyDoc.setSource(groovySourceSet);
         });
     }
 }