Add Action taking equivalents for all Closure-taking methods in Script

gradle · big-guy · Sep 24, 2022 · Sep 24, 2022 · Sep 24, 2022 · Sep 24, 2022
commit 9774ff128de92553f84e5d2689bc01997cd16dba
@@ -42,6 +42,7 @@ import org.gradle.api.file.DeleteSpec
 import org.gradle.api.file.FileTree
 import org.gradle.api.file.ProjectLayout
 import org.gradle.api.file.SyncSpec
+import org.gradle.api.initialization.dsl.ScriptHandler
 import org.gradle.api.internal.DynamicObjectAware
 import org.gradle.api.internal.GradleInternal
 import org.gradle.api.internal.ProcessOperations
@@ -692,6 +693,11 @@ class ProblemReportingCrossProjectModelAccess(
             delegate.buildscript(configureClosure)
         }
 
+        override fun buildscript(action: Action<in ScriptHandler>) {
+            onAccess()
+            delegate.buildscript(action)
+        }
+
         override fun copy(closure: Closure<*>): WorkResult {
             onAccess()
             return delegate.copy(closure)

diff --git a/subprojects/core-api/src/main/java/org/gradle/api/Project.java b/subprojects/core-api/src/main/java/org/gradle/api/Project.java
@@ -1581,6 +1581,17 @@ public interface Project extends Comparable<Project>, ExtensionAware, PluginAwar
      */
     void buildscript(Closure configureClosure);
 
+    /**
+     * <p>Configures the build script classpath for this project.
+     *
+     * @param action the action to use to configure the build script classpath.
+     *
+     * @see Script#buildscript(Action)
+     *
+     * @since 8.0
+     */
+    void buildscript(Action<? super ScriptHandler> action);
+
     /**
      * Copies the specified files.  The given closure is used to configure a {@link CopySpec}, which is then used to
      * copy the files. Example:

diff --git a/subprojects/core-api/src/main/java/org/gradle/api/Script.java b/subprojects/core-api/src/main/java/org/gradle/api/Script.java
@@ -21,9 +21,11 @@
 import org.gradle.api.file.ConfigurableFileTree;
 import org.gradle.api.file.CopySpec;
 import org.gradle.api.file.FileTree;
+import org.gradle.api.file.SyncSpec;
 import org.gradle.api.initialization.dsl.ScriptHandler;
 import org.gradle.api.logging.Logger;
 import org.gradle.api.logging.LoggingManager;
+import org.gradle.api.plugins.ObjectConfigurationAction;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.resources.ResourceHandler;
 import org.gradle.api.tasks.WorkResult;
@@ -57,6 +59,17 @@ public interface Script {
      */
     void apply(Closure closure);
 
+    /**
+     * <p>Configures the delegate object for this script using plugins or scripts.
+     *
+     * <p>The given action is used to configure an {@link org.gradle.api.plugins.ObjectConfigurationAction} which is
+     * then used to configure the delegate object.</p>
+     *
+     * @param action The action to configure the {@code ObjectConfigurationAction}.
+     * @since 8.0
+     */
+    void apply(Action<? super ObjectConfigurationAction> action);
+
     /**
      * <p>Configures the delegate object for this script using plugins or scripts.
      *
@@ -93,6 +106,16 @@ public interface Script {
      */
     void buildscript(Closure configureClosure);
 
+    /**
+     * Configures the classpath for this script.
+     *
+     * <p>The given action is executed against this script's {@link ScriptHandler}. </p>
+     *
+     * @param action the action to use to configure the script classpath.
+     * @since 8.0
+     */
+    void buildscript(Action<? super ScriptHandler> action);
+
     /**
      * <p>Resolves a file path relative to the directory containing this script. This works as described for {@link
      * Project#file(Object)}</p>
@@ -143,6 +166,20 @@ public interface Script {
      */
     ConfigurableFileCollection files(Object paths, Closure configureClosure);
 
+    /**
+     * <p>Creates a new {@code ConfigurableFileCollection} using the given paths. The file collection is configured
+     * using the given action. This method works as described for {@link Project#files(Object, Action)}.
+     * Relative paths are resolved relative to the directory containing this script.</p>
+     *
+     * @param paths The contents of the file collection. Evaluated as per {@link #files(Object...)}.
+     * @param action The action to use to configure the file collection.
+     * @return the configured file tree. Never returns null.
+     *
+     * @see Project#files(Object, Action)
+     * @since 8.0
+     */
+    ConfigurableFileCollection files(Object paths, Action<? super ConfigurableFileCollection> action);
+
     /**
      * <p>Returns the relative path from the directory containing this script to the given path. The given path object
      * is (logically) resolved as described for {@link #file(Object)}, from which a relative path is calculated.</p>
@@ -201,6 +238,31 @@ public interface Script {
      */
     ConfigurableFileTree fileTree(Object baseDir, Closure configureClosure);
 
+    /**
+     * <p>Creates a new {@code ConfigurableFileTree} using the given base directory. The given baseDir path is evaluated
+     * as per {@link #file(Object)}. The action will be used to configure the new file tree.
+     * Example:</p>
+     *
+     * <pre>
+     * fileTree('src') {
+     *    exclude '**&#47;.svn/**'
+     * }.copy { into 'dest'}
+     * </pre>
+     *
+     * <p>The returned file tree is lazy, so that it scans for files only when the contents of the file tree are
+     * queried. The file tree is also live, so that it scans for files each time the contents of the file tree are
+     * queried.</p>
+     *
+     * @param baseDir The base directory of the file tree. Evaluated as per {@link #file(Object)}.
+     * @param action Action to configure the {@code ConfigurableFileTree} object.
+     * @return the configured file tree. Never returns null.
+     *
+     * @see Project#fileTree(Object, Action)
+     *
+     * @since 8.0
+     */
+    ConfigurableFileTree fileTree(Object baseDir, Action<? super ConfigurableFileTree> action);
+
     /**
      * <p>Creates a new {@code FileTree} which contains the contents of the given ZIP file. The given zipPath path is
      * evaluated as per {@link #file(Object)}. You can combine this method with the {@link #copy(groovy.lang.Closure)}
@@ -281,6 +343,52 @@ public interface Script {
      */
     WorkResult copy(Closure closure);
 
+    /**
+     * Copy the specified files.  The given action is used to configure a {@link org.gradle.api.file.CopySpec}, which
+     * is then used to copy the files. Example:
+     * <pre>
+     * copy {
+     *    from configurations.runtimeClasspath
+     *    into 'build/deploy/lib'
+     * }
+     * </pre>
+     * Note that CopySpecs can be nested:
+     * <pre>
+     * copy {
+     *    into 'build/webroot'
+     *    exclude '**&#47;.svn/**'
+     *    from('src/main/webapp') {
+     *       include '**&#47;*.jsp'
+     *       filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])
+     *    }
+     *    from('src/main/js') {
+     *       include '**&#47;*.js'
+     *    }
+     * }
+     * </pre>
+     *
+     * @param action Action to configure the CopySpec
+     * @return {@link org.gradle.api.tasks.WorkResult} that can be used to check if the copy did any work.
+     *
+     * @see Project#copy(Action)
+     *
+     * @since 8.0
+     */
+    WorkResult copy(Action<? super CopySpec> action);
+
+    /**
+     * Synchronizes the contents of a destination directory with some source directories and files.
+     * The given action is used to configure a {@link SyncSpec}, which is then used to synchronize the files.
+     *
+     * @param action Action to configure the SyncSpec
+     * @return {@link org.gradle.api.tasks.WorkResult} that can be used to check if the sync did any work.
+     *
+     * @see Project#sync(Action)
+     *
+     * @since 8.0
+     */
+    WorkResult sync(Action<? super SyncSpec> action);
+
     /**
      * Creates a {@link org.gradle.api.file.CopySpec} which can later be used to copy files or create an archive. The
      * given closure is used to configure the {@link org.gradle.api.file.CopySpec} before it is returned by this
@@ -291,6 +399,19 @@ public interface Script {
      */
     CopySpec copySpec(Closure closure);
 
+    /**
+     * Creates a {@link org.gradle.api.file.CopySpec} which can later be used to copy files or create an archive. The
+     * given action is used to configure the {@link org.gradle.api.file.CopySpec} before it is returned by this
+     * method.
+     *
+     * @param action Action to configure the CopySpec
+     * @return The CopySpec
+     *
+     * @since 8.0
+     * @see Project#copySpec(Action)
+     */
+    CopySpec copySpec(Action<? super CopySpec> action);
+
     /**
      * Creates a directory and returns a file pointing to it.
      *

diff --git a/subprojects/core/src/main/java/org/gradle/api/internal/project/DefaultProject.java b/subprojects/core/src/main/java/org/gradle/api/internal/project/DefaultProject.java
@@ -47,6 +47,7 @@
 import org.gradle.api.file.FileTree;
 import org.gradle.api.file.ProjectLayout;
 import org.gradle.api.file.SyncSpec;
+import org.gradle.api.initialization.dsl.ScriptHandler;
 import org.gradle.api.internal.CollectionCallbackActionDecorator;
 import org.gradle.api.internal.DomainObjectContext;
 import org.gradle.api.internal.DynamicObjectAware;
@@ -1259,7 +1260,12 @@ public void artifacts(Action<? super ArtifactHandler> configureAction) {
 
     @Override
     public void buildscript(Closure configureClosure) {
-        ConfigureUtil.configure(configureClosure, getBuildscript());
+        buildscript(ConfigureUtil.configureUsing(configureClosure));
+    }
+
+    @Override
+    public void buildscript(Action<? super ScriptHandler> action) {
+        Actions.with(getBuildscript(), action);
     }
 
     @Override
@@ -1278,7 +1284,7 @@ public Task task(String task, Action<? super Task> configureAction) {
 
     @Override
     public Task task(String task, Closure configureClosure) {
-        return taskContainer.create(task).configure(configureClosure);
+        return taskContainer.create(task).configure(ConfigureUtil.configureUsing(configureClosure));
     }
 
     public Task task(Object task, Closure configureClosure) {
@@ -1296,7 +1302,7 @@ public Task task(Map options, Object task) {
 
     @Override
     public Task task(Map options, String task, Closure configureClosure) {
-        return taskContainer.create(addMaps(Cast.uncheckedNonnullCast(options), singletonMap(Task.TASK_NAME, task))).configure(configureClosure);
+        return taskContainer.create(addMaps(Cast.uncheckedNonnullCast(options), singletonMap(Task.TASK_NAME, task))).configure(ConfigureUtil.configureUsing(configureClosure));
     }
 
     public Task task(Map options, Object task, Closure configureClosure) {

diff --git a/subprojects/core/src/main/java/org/gradle/api/internal/project/ProjectScript.java b/subprojects/core/src/main/java/org/gradle/api/internal/project/ProjectScript.java
@@ -15,20 +15,20 @@
  */
 package org.gradle.api.internal.project;
 
-import groovy.lang.Closure;
+import org.gradle.api.Action;
 import org.gradle.api.initialization.dsl.ScriptHandler;
 import org.gradle.api.logging.Logger;
 import org.gradle.api.logging.LoggingManager;
+import org.gradle.api.plugins.ObjectConfigurationAction;
 import org.gradle.internal.logging.StandardOutputCapture;
 import org.gradle.plugin.use.internal.PluginsAwareScript;
 
 import java.util.Map;
 
 public abstract class ProjectScript extends PluginsAwareScript {
-
     @Override
-    public void apply(Closure closure) {
-        getScriptTarget().apply(closure);
+    public void apply(Action<? super ObjectConfigurationAction> action) {
+        getScriptTarget().apply(action);
     }
 
     @Override
@@ -43,8 +43,8 @@ public ScriptHandler getBuildscript() {
     }
 
     @Override
-    public void buildscript(Closure configureClosure) {
-        getScriptTarget().buildscript(configureClosure);
+    public void buildscript(Action<? super ScriptHandler> action) {
+        getScriptTarget().buildscript(action);
     }
 
     @Override

diff --git a/subprojects/core/src/main/java/org/gradle/groovy/scripts/DefaultScript.java b/subprojects/core/src/main/java/org/gradle/groovy/scripts/DefaultScript.java
@@ -25,6 +25,7 @@
 import org.gradle.api.file.CopySpec;
 import org.gradle.api.file.DeleteSpec;
 import org.gradle.api.file.FileTree;
+import org.gradle.api.file.SyncSpec;
 import org.gradle.api.initialization.dsl.ScriptHandler;
 import org.gradle.api.internal.ProcessOperations;
 import org.gradle.api.internal.file.DefaultFileOperations;
@@ -40,6 +41,7 @@
 import org.gradle.api.logging.Logger;
 import org.gradle.api.logging.Logging;
 import org.gradle.api.logging.LoggingManager;
+import org.gradle.api.plugins.ObjectConfigurationAction;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.provider.ProviderFactory;
 import org.gradle.api.resources.ResourceHandler;
@@ -121,9 +123,14 @@ private DefaultObjectConfigurationAction createObjectConfigurationAction() {
 
     @Override
     public void apply(Closure closure) {
-        DefaultObjectConfigurationAction action = createObjectConfigurationAction();
-        ConfigureUtil.configure(closure, action);
-        action.execute();
+        apply(ConfigureUtil.configureUsing(closure));
+    }
+
+    @Override
+    public void apply(Action<? super ObjectConfigurationAction> action) {
+        DefaultObjectConfigurationAction configurationAction = createObjectConfigurationAction();
+        action.execute(configurationAction);
+        configurationAction.execute();
     }
 
     @Override
@@ -143,6 +150,11 @@ public void buildscript(Closure configureClosure) {
         ConfigureUtil.configure(configureClosure, getBuildscript());
     }
 
+    @Override
+    public void buildscript(Action<? super ScriptHandler> action) {
+        Actions.with(getBuildscript(), action);
+    }
+
     @Override
     public File file(Object path) {
         return fileOperations.file(path);
@@ -168,6 +180,11 @@ public ConfigurableFileCollection files(Object paths, Closure configureClosure)
         return ConfigureUtil.configure(configureClosure, files(paths));
     }
 
+    @Override
+    public ConfigurableFileCollection files(Object paths, Action<? super ConfigurableFileCollection> action) {
+        return Actions.with(files(paths), action);
+    }
+
     @Override
     public String relativePath(Object path) {
         return fileOperations.relativePath(path);
@@ -188,6 +205,11 @@ public ConfigurableFileTree fileTree(Object baseDir, Closure configureClosure) {
         return ConfigureUtil.configure(configureClosure, fileOperations.fileTree(baseDir));
     }
 
+    @Override
+    public ConfigurableFileTree fileTree(Object baseDir, Action<? super ConfigurableFileTree> action) {
+        return Actions.with(fileTree(baseDir), action);
+    }
+
     @Override
     public FileTree zipTree(Object zipPath) {
         return fileOperations.zipTree(zipPath);
@@ -208,11 +230,13 @@ public WorkResult copy(Closure closure) {
         return copy(ConfigureUtil.configureUsing(closure));
     }
 
+    @Override
     public WorkResult copy(Action<? super CopySpec> action) {
         return fileOperations.copy(action);
     }
 
-    public WorkResult sync(Action<? super CopySpec> action) {
+    @Override
+    public WorkResult sync(Action<? super SyncSpec> action) {
         return fileOperations.sync(action);
     }
 
@@ -221,6 +245,11 @@ public CopySpec copySpec(Closure closure) {
         return Actions.with(copySpec(), ConfigureUtil.configureUsing(closure));
     }
 
+    @Override
+    public CopySpec copySpec(Action<? super CopySpec> action) {
+        return Actions.with(fileOperations.copySpec(), action);
+    }
+
     public CopySpec copySpec() {
         return fileOperations.copySpec();
     }