com.prezi.pride.PridePlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-pride-plugin Show documentation
Pride manages multiple Gradle modules as a single Gradle project
The newest version!
package com.prezi.pride;

import com.google.common.base.Throwables;
import com.google.common.collect.Maps;
import org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.DependencySubstitution;
import org.gradle.api.artifacts.component.ModuleComponentSelector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class PridePlugin implements Plugin {
	private static final Logger logger = LoggerFactory.getLogger(PridePlugin.class);
	private static final String MINIMUM_GRADLE_VERSION = "4.0";

	@Override
	public void apply(Project project) {
		boolean prideDisabled = isDisabled(project);
		if (!prideDisabled) {
			// Check if not running from the root of a Pride
			try {
				checkGradleVersion(project);
				checkIfNotRunningFromRootOfPride(project);
			} catch (IOException e) {
				throw Throwables.propagate(e);
			}
		}

		// Apply Pride convention
		project.getConvention().getPlugins().put("pride", new PrideConvention(project));

		// Add dynamicDependencies extension for backwards compatibility
		addLegacyDynamicDependenciesExtension(project);

		// Use replacement rule
		if (!isDisabled(project)) {
			final Set projects = project.getRootProject().getAllprojects();
			project.getConfigurations().all(new Action() {
				@Override
				public void execute(Configuration configuration) {
					configuration.getResolutionStrategy().getDependencySubstitution().all(new ReplaceDependenciesAction(projects));
				}
			});
		}

		// Check dependency versions
		CheckDependencyVersionsTask checkVersions = project.getTasks().create("checkDependencyVersions", CheckDependencyVersionsTask.class);
		checkVersions.setConfigurations(project.getConfigurations());
		checkVersions.setDescription("Checks if substituted dependency projects conform to their requested versions");

		// See https://github.com/prezi/pride/issues/100
		project.afterEvaluate(new Action() {
			@Override
			public void execute(Project project) {
				if (project.getGroup() == null || String.valueOf(project.getGroup()).isEmpty()) {
					throw new IllegalStateException("Group is not specified for project in " + project.getProjectDir());
				}
			}
		});
	}

	@SuppressWarnings("deprecation")
	private void addLegacyDynamicDependenciesExtension(Project project) {
		project.getExtensions().create("dynamicDependencies", DynamicDependenciesExtension.class, project);
	}

	private static void checkGradleVersion(Project project) {
		Pattern versionPattern = Pattern.compile("(\\d+(?:\\.\\d+)+).*");
		String gradleVersion = project.getGradle().getGradleVersion();
		Matcher versionMatcher = versionPattern.matcher(gradleVersion);
		if (!versionMatcher.matches()) {
			throw new GradleException("Invalid Gradle version: " + gradleVersion);
		}
		if (compareVersions(versionMatcher.group(1), MINIMUM_GRADLE_VERSION) < 0) {
			throw new GradleException("Pride requires Gradle version " + MINIMUM_GRADLE_VERSION + " or later. " +
					"If you want to use an earlier Gradle version, try Pride 0.10.");
		}
	}

	static int compareVersions(String a, String b) {
		StringTokenizer tokenizerA = new StringTokenizer(a, ".");
		StringTokenizer tokenizerB = new StringTokenizer(b, ".");

		int result = 0;
		while (result == 0 && tokenizerA.hasMoreTokens() && tokenizerB.hasMoreTokens()) {
			int numberA = Integer.parseInt(tokenizerA.nextToken());
			int numberB = Integer.parseInt(tokenizerB.nextToken());
			result = numberA - numberB;
		}
		if (result == 0) {
			result = tokenizerA.hasMoreTokens() ? 1 : tokenizerB.hasMoreTokens() ? -1 : 0;
		}
		return result;
	}

	private static boolean alreadyCheckedIfRunningFromRootOfPride;

	private static void checkIfNotRunningFromRootOfPride(final Project project) throws IOException {
		// Don't check for a pride when not searching upward
		if (!project.getGradle().getStartParameter().isSearchUpwards()) {
			return;
		}
		if (!alreadyCheckedIfRunningFromRootOfPride) {
			if (!Pride.containsPride(project.getRootDir())) {
				logger.debug("No pride found in " + String.valueOf(project.getRootDir()));
				for (File dir = project.getRootDir().getParentFile(); dir != null && dir.canRead(); dir = dir.getParentFile()) {
					logger.debug("Checking pride in " + dir);
					if (Pride.containsPride(dir)) {
						logger.warn("WARNING: Found a pride in parent directory " + dir + ". " +
								"This means that you are running Gradle from a subproject of the pride. " +
								"Dynamic dependencies cannot be resolved to local projects this way. " +
								"To avoid this warning run Gradle from the root of the pride.");
						break;
					}
				}
			}
			alreadyCheckedIfRunningFromRootOfPride = true;
		}
	}

	public static boolean isDisabled(Project project) {
		return project.hasProperty("pride.disable");
	}

	private static class ReplaceDependenciesAction implements Action {
		private Map modulesToProjectsMapping;
		private final Set projects;

		public ReplaceDependenciesAction(Set projects) {
			this.projects = projects;
		}

		@Override
		public void execute(DependencySubstitution details) {
			// Skip components that are not external components
			if (!(details.getRequested() instanceof ModuleComponentSelector)) {
				return;
			}
			ModuleComponentSelector selector = (ModuleComponentSelector) details.getRequested();
			if (modulesToProjectsMapping == null) {
				modulesToProjectsMapping = Maps.newTreeMap();
				for (Project project : projects) {
					modulesToProjectsMapping.put(project.getGroup() + ":" + project.getName(), project);
				}
				logger.info("Modules to projects mapping: {}", modulesToProjectsMapping);
			}
			String id = selector.getGroup() + ":" + selector.getModule();
			Project dependentProject = modulesToProjectsMapping.get(id);
			if (dependentProject != null) {
				logger.info("Replaced external dependency {} with {}", selector, dependentProject);
				details.useTarget(dependentProject);
			}
		}
	}
}