org.gradle.api.tasks.GroovyRuntime Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2013 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.tasks;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import org.gradle.api.Buildable;
import org.gradle.api.GradleException;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Dependency;
import org.gradle.api.file.FileCollection;
import org.gradle.api.internal.file.collections.LazilyInitializedFileCollection;
import org.gradle.api.internal.plugins.GroovyJarFile;
import org.gradle.api.internal.tasks.TaskDependencyResolveContext;
import org.gradle.util.VersionNumber;
import javax.annotation.Nullable;
import java.io.File;
import java.util.List;
/**
* Provides information related to the Groovy runtime(s) used in a project. Added by the
* {@link org.gradle.api.plugins.GroovyBasePlugin} as a project extension named {@code groovyRuntime}.
*
* Example usage:
*
*
* apply plugin: "groovy"
*
* repositories {
* mavenCentral()
* }
*
* dependencies {
* compile "org.codehaus.groovy:groovy-all:2.1.2"
* }
*
* def groovyClasspath = groovyRuntime.inferGroovyClasspath(configurations.compile)
* // The returned class path can be used to configure the 'groovyClasspath' property of tasks
* // such as 'GroovyCompile' or 'Groovydoc', or to execute these and other Groovy tools directly.
*
*/
public class GroovyRuntime {
private static final VersionNumber GROOVY_VERSION_WITH_SEPARATE_ANT = VersionNumber.parse("2.0");
private static final VersionNumber GROOVY_VERSION_REQUIRING_TEMPLATES = VersionNumber.parse("2.5");
private final Project project;
public GroovyRuntime(Project project) {
this.project = project;
}
/**
* Searches the specified class path for Groovy Jars ({@code groovy(-indy)}, {@code groovy-all(-indy)}) and returns a corresponding class path for executing Groovy tools such as the Groovy
* compiler and Groovydoc tool. The tool versions will match those of the Groovy Jars found. If no Groovy Jars are found on the specified class path, a class path with the contents of the {@code
* groovy} configuration will be returned.
*
* The returned class path may be empty, or may fail to resolve when asked for its contents.
*
* @param classpath a class path containing Groovy Jars
* @return a corresponding class path for executing Groovy tools such as the Groovy compiler and Groovydoc tool
*/
public FileCollection inferGroovyClasspath(final Iterable classpath) {
// alternatively, we could return project.getLayout().files(Runnable)
// would differ in at least the following ways: 1. live 2. no autowiring
return new LazilyInitializedFileCollection() {
@Override
public String getDisplayName() {
return "Groovy runtime classpath";
}
@Override
public FileCollection createDelegate() {
GroovyJarFile groovyJar = findGroovyJarFile(classpath);
if (groovyJar == null) {
throw new GradleException(String.format("Cannot infer Groovy class path because no Groovy Jar was found on class path: %s", Iterables.toString(classpath)));
}
if (groovyJar.isGroovyAll()) {
return project.getLayout().files(groovyJar.getFile());
}
if (project.getRepositories().isEmpty()) {
throw new GradleException("Cannot infer Groovy class path because no repository is declared for the project.");
}
String notation = groovyJar.getDependencyNotation();
List dependencies = Lists.newArrayList();
// project.getDependencies().create(String) seems to be the only feasible way to create a Dependency with a classifier
dependencies.add(project.getDependencies().create(notation));
VersionNumber groovyVersion = groovyJar.getVersion();
if (groovyVersion.compareTo(GROOVY_VERSION_WITH_SEPARATE_ANT) >= 0) {
// add groovy-ant to bring in Groovydoc for Groovy 2.0+
addGroovyDependency(notation, dependencies, "groovy-ant");
}
if (groovyVersion.compareTo(GROOVY_VERSION_REQUIRING_TEMPLATES) >= 0) {
// add groovy-templates for Groovy 2.5+
addGroovyDependency(notation, dependencies, "groovy-templates");
}
return project.getConfigurations().detachedConfiguration(dependencies.toArray(new Dependency[0]));
}
private void addGroovyDependency(String groovyDependencyNotion, List dependencies, String otherDependency) {
dependencies.add(project.getDependencies().create(groovyDependencyNotion.replace(":groovy:", ":" + otherDependency + ":")));
}
// let's override this so that delegate isn't created at autowiring time (which would mean on every build)
@Override
public void visitDependencies(TaskDependencyResolveContext context) {
if (classpath instanceof Buildable) {
context.add(classpath);
}
}
};
}
@Nullable
private static GroovyJarFile findGroovyJarFile(Iterable classpath) {
for (File file : classpath) {
GroovyJarFile groovyJar = GroovyJarFile.parse(file);
if (groovyJar != null) {
return groovyJar;
}
}
return null;
}
}