io.spring.gradle.dependencymanagement.DependencyManagementPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dependency-management-plugin Show documentation
A Gradle plugin that provides Maven-like dependency management functionality
There is a newer version: 1.1.7
Show newest version
/*
 * Copyright 2014-2022 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
 *
 *      https://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 io.spring.gradle.dependencymanagement;

import io.spring.gradle.dependencymanagement.dsl.DependencyManagementExtension;
import io.spring.gradle.dependencymanagement.internal.bridge.InternalComponents;
import io.spring.gradle.dependencymanagement.maven.PomDependencyManagementConfigurer;
import org.gradle.api.Action;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.artifacts.maven.MavenResolver;
import org.gradle.api.publish.PublishingExtension;
import org.gradle.api.publish.maven.MavenPublication;
import org.gradle.api.publish.maven.plugins.MavenPublishPlugin;
import org.gradle.api.tasks.Upload;

/**
 * Main class for the dependency management plugin.
 *
 * @author Andy Wilkinson
 */
public class DependencyManagementPlugin implements Plugin {

	@Override
	public void apply(final Project project) {
		InternalComponents internalComponents = new InternalComponents(project);

		final DependencyManagementExtension dependencyManagementExtension = internalComponents
				.getDependencyManagementExtension();

		project.getExtensions().add("dependencyManagement", dependencyManagementExtension);
		internalComponents.createDependencyManagementReportTask("dependencyManagement");

		project.getConfigurations().all(internalComponents.getImplicitDependencyManagementCollector());
		project.getConfigurations().all(internalComponents.getDependencyManagementApplier());

		configurePomCustomization(project, dependencyManagementExtension);
	}

	private void configurePomCustomization(final Project project,
			DependencyManagementExtension dependencyManagementExtension) {
		final PomDependencyManagementConfigurer pomConfigurer = dependencyManagementExtension.getPomConfigurer();
		if (classIsPresent("org.gradle.api.tasks.Upload")) {
			project.getTasks().withType(Upload.class, new UploadPomConfigurationAction(pomConfigurer));
		}
		project.getPlugins().withType(MavenPublishPlugin.class, new Action() {

			@Override
			public void execute(MavenPublishPlugin mavenPublishPlugin) {
				configurePublishingExtension(project, pomConfigurer);
			}

		});
	}

	private boolean classIsPresent(String name) {
		try {
			ClassLoader classLoader = DependencyManagementPlugin.class.getClassLoader();
			Class.forName(name, false, classLoader);
			return true;
		}
		catch (Throwable ex) {
			return false;
		}
	}

	private void configurePublishingExtension(Project project, final PomDependencyManagementConfigurer extension) {
		project.getExtensions().configure(PublishingExtension.class, new Action() {

			@Override
			public void execute(PublishingExtension publishingExtension) {
				configurePublications(publishingExtension, extension);
			}

		});
	}

	private void configurePublications(PublishingExtension publishingExtension,
			final PomDependencyManagementConfigurer extension) {
		publishingExtension.getPublications().withType(MavenPublication.class, new Action() {

			@Override
			public void execute(MavenPublication mavenPublication) {
				mavenPublication.getPom().withXml(extension);
			}

		});
	}

	private static final class UploadPomConfigurationAction implements Action {

		private final PomDependencyManagementConfigurer pomConfigurer;

		private UploadPomConfigurationAction(PomDependencyManagementConfigurer pomConfigurer) {
			this.pomConfigurer = pomConfigurer;
		}

		@Override
		public void execute(final Upload upload) {
			upload.doFirst(new Action() {

				@Override
				@SuppressWarnings("deprecation")
				public void execute(Task task) {
					upload.getRepositories().withType(MavenResolver.class, new Action() {

						@Override
						public void execute(org.gradle.api.artifacts.maven.MavenResolver mavenResolver) {
							mavenResolver.getPom().withXml(UploadPomConfigurationAction.this.pomConfigurer);
						}

					});
				}

			});

		}

	}

}