io.spring.gradle.dependencymanagement.internal.report.DependencyManagementReportTask 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
The newest version!
/*
 * Copyright 2014-2024 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.internal.report;

import java.util.Comparator;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;

import io.spring.gradle.dependencymanagement.internal.DependencyManagementContainer;
import org.gradle.api.DefaultTask;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.ConfigurationContainer;
import org.gradle.api.tasks.TaskAction;

/**
 * Task to display the dependency management for a project.
 *
 * @author Andy Wilkinson.
 */
public class DependencyManagementReportTask extends DefaultTask {

	private DependencyManagementContainer dependencyManagementContainer;

	private DependencyManagementReportRenderer renderer = new DependencyManagementReportRenderer();

	private final String projectPath;

	private final String projectDescription;

	private final boolean rootProject;

	private final ConfigurationContainer configurationContainer;

	public DependencyManagementReportTask() {
		Project project = getProject();
		this.projectPath = project.getPath();
		this.projectDescription = project.getDescription();
		this.rootProject = project.getRootProject().equals(project);
		this.configurationContainer = project.getConfigurations();
	}

	void setRenderer(DependencyManagementReportRenderer renderer) {
		this.renderer = renderer;
	}

	/**
	 * Sets the container for the dependency management that will be reported.
	 * @param dependencyManagementContainer the container
	 */
	public void setDependencyManagementContainer(DependencyManagementContainer dependencyManagementContainer) {
		this.dependencyManagementContainer = dependencyManagementContainer;
	}

	/**
	 * {@link TaskAction} that produces the dependency management report.
	 */
	@TaskAction
	public void report() {
		this.renderer.startProject(this.projectPath, this.projectDescription, this.rootProject);
		Map globalManagedVersions = this.dependencyManagementContainer
			.getManagedVersionsForConfiguration(null);
		this.renderer.renderGlobalManagedVersions(globalManagedVersions);
		Set configurations = new TreeSet<>(Comparator.comparing(Configuration::getName));
		configurations.addAll(this.configurationContainer);
		for (Configuration configuration : configurations) {
			Map managedVersions = this.dependencyManagementContainer
				.getManagedVersionsForConfiguration(configuration);
			this.renderer.renderConfigurationManagedVersions(managedVersions, configuration, globalManagedVersions);
		}
	}

}