Restore dependency-tools API compatibility

Refactor dependency-tools to restore API compatibility with Spring
Boot 1.0. This should reduce reflection hacks that tools such as Gretty
would otherwise have to make.

See gh-1035

Author: Phillip Webb

spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/GrabMetadataTransformation.java

@@ -39,9 +39,9 @@
 import org.codehaus.groovy.syntax.SyntaxException;
 import org.codehaus.groovy.transform.ASTTransformation;
 import org.springframework.boot.cli.compiler.grape.DependencyResolutionContext;
+import org.springframework.boot.dependency.tools.Dependencies;
 import org.springframework.boot.dependency.tools.ManagedDependencies;
-import org.springframework.boot.dependency.tools.PropertiesFileManagedDependencies;
-import org.springframework.boot.dependency.tools.VersionManagedDependencies;
+import org.springframework.boot.dependency.tools.PropertiesFileDependencies;
 import org.springframework.boot.groovy.GrabMetadata;
 
 /**
@@ -151,11 +151,10 @@ private void updateArtifactCoordinatesResolver(
 			List<Map<String, String>> metadataDependencies) {
 		URI[] uris = Grape.getInstance().resolve(null,
 				metadataDependencies.toArray(new Map[metadataDependencies.size()]));
-		List<ManagedDependencies> managedDependencies = new ArrayList<ManagedDependencies>(
-				uris.length);
+		List<Dependencies> managedDependencies = new ArrayList<Dependencies>(uris.length);
 		for (URI uri : uris) {
 			try {
-				managedDependencies.add(new PropertiesFileManagedDependencies(uri.toURL()
+				managedDependencies.add(new PropertiesFileDependencies(uri.toURL()
 						.openStream()));
 			}
 			catch (IOException ex) {
@@ -164,8 +163,8 @@ private void updateArtifactCoordinatesResolver(
 			}
 		}
 
-		this.resolutionContext.setManagedDependencies(new VersionManagedDependencies(
-				managedDependencies));
+		this.resolutionContext.setManagedDependencies(ManagedDependencies
+				.get(managedDependencies));
 	}
 
 	private void handleDuplicateGrabMetadataAnnotation(AnnotationNode annotationNode) {

spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/dependencies/ManagedDependenciesArtifactCoordinatesResolver.java

@@ -16,13 +16,13 @@
 
 package org.springframework.boot.cli.compiler.dependencies;
 
+import org.springframework.boot.dependency.tools.Dependencies;
 import org.springframework.boot.dependency.tools.Dependency;
 import org.springframework.boot.dependency.tools.ManagedDependencies;
-import org.springframework.boot.dependency.tools.VersionManagedDependencies;
 import org.springframework.util.StringUtils;
 
 /**
- * {@link ArtifactCoordinatesResolver} backed by {@link ManagedDependencies}.
+ * {@link ArtifactCoordinatesResolver} backed by {@link Dependencies}.
  * 
  * @author Phillip Webb
  */
@@ -32,7 +32,7 @@ public class ManagedDependenciesArtifactCoordinatesResolver implements
 	private final ManagedDependencies dependencies;
 
 	public ManagedDependenciesArtifactCoordinatesResolver() {
-		this(new VersionManagedDependencies());
+		this(ManagedDependencies.get());
 	}
 
 	public ManagedDependenciesArtifactCoordinatesResolver(ManagedDependencies dependencies) {

spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/grape/ManagedDependenciesFactory.java

@@ -24,12 +24,11 @@
 import org.eclipse.aether.graph.Dependency;
 import org.eclipse.aether.util.artifact.JavaScopes;
 import org.springframework.boot.dependency.tools.ManagedDependencies;
-import org.springframework.boot.dependency.tools.PomManagedDependencies;
-import org.springframework.boot.dependency.tools.VersionManagedDependencies;
+import org.springframework.boot.dependency.tools.PomDependencies;
 
 /**
  * Factory to create Maven {@link Dependency} objects from Boot
- * {@link PomManagedDependencies}.
+ * {@link PomDependencies}.
  * 
  * @author Phillip Webb
  */
@@ -38,7 +37,7 @@ public class ManagedDependenciesFactory {
 	private final ManagedDependencies dependencies;
 
 	ManagedDependenciesFactory() {
-		this(new VersionManagedDependencies());
+		this(ManagedDependencies.get());
 	}
 
 	public ManagedDependenciesFactory(ManagedDependencies dependencies) {

spring-boot-integration-tests/src/test/java/org/springframework/boot/starter/StarterDependenciesIntegrationTests.java

@@ -32,15 +32,15 @@
 import org.junit.runner.RunWith;
 import org.junit.runners.Parameterized;
 import org.junit.runners.Parameterized.Parameters;
-import org.springframework.boot.dependency.tools.VersionManagedDependencies;
+import org.springframework.boot.dependency.tools.ManagedDependencies;
 import org.springframework.util.FileCopyUtils;
 
 import static org.junit.Assert.fail;
 
 /**
  * Tests for the various starter projects to check that they don't pull in unwanted
  * transitive dependencies when used with Gradle
- *
+ * 
  * @author Andy Wilkinson
  */
 @RunWith(Parameterized.class)
@@ -89,8 +89,8 @@ public static void createProject() throws IOException {
 
 	@BeforeClass
 	public static void determineVersions() throws Exception {
-		springVersion = new VersionManagedDependencies().find("spring-core").getVersion();
-		bootVersion = new VersionManagedDependencies().find("spring-boot").getVersion();
+		springVersion = ManagedDependencies.get().find("spring-core").getVersion();
+		bootVersion = ManagedDependencies.get().find("spring-boot").getVersion();
 	}
 
 	@AfterClass

spring-boot-tools/spring-boot-dependency-tools/src/main/java/org/springframework/boot/dependency/tools/AbstractManagedDependencies.java renamed to spring-boot-tools/spring-boot-dependency-tools/src/main/java/org/springframework/boot/dependency/tools/AbstractDependencies.java

@@ -21,18 +21,18 @@
 import java.util.Map;
 
 /**
- * Abstract base implementation for {@link ManagedDependencies}.
+ * Abstract base implementation for {@link Dependencies}.
  * 
  * @author Phillip Webb
  * @since 1.1.0
  */
-abstract class AbstractManagedDependencies implements ManagedDependencies {
+abstract class AbstractDependencies implements Dependencies {
 
 	private final Map<ArtifactAndGroupId, Dependency> byArtifactAndGroupId;
 
 	private final Map<String, Dependency> byArtifactId;
 
-	public AbstractManagedDependencies() {
+	public AbstractDependencies() {
 		this.byArtifactAndGroupId = new LinkedHashMap<ArtifactAndGroupId, Dependency>();
 		this.byArtifactId = new LinkedHashMap<String, Dependency>();
 	}
@@ -52,12 +52,6 @@ public Iterator<Dependency> iterator() {
 		return this.byArtifactAndGroupId.values().iterator();
 	}
 
-	@Override
-	public String getSpringBootVersion() {
-		Dependency dependency = find("org.springframework.boot", "spring-boot");
-		return (dependency == null ? null : dependency.getVersion());
-	}
-
 	protected void add(ArtifactAndGroupId artifactAndGroupId, Dependency dependency) {
 		this.byArtifactAndGroupId.put(artifactAndGroupId, dependency);
 		this.byArtifactId.put(dependency.getArtifactId(), dependency);

spring-boot-tools/spring-boot-dependency-tools/src/main/java/org/springframework/boot/dependency/tools/Dependencies.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2012-2014 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.springframework.boot.dependency.tools;
+
+import java.util.Iterator;
+
+/**
+ * Interface for accessing a known set of dependencies.
+ * 
+ * @author Phillip Webb
+ * @see Dependency
+ * @since 1.1.0
+ */
+public interface Dependencies extends Iterable<Dependency> {
+
+	/**
+	 * Find a single dependency for the given group and artifact IDs.
+	 * @param groupId the group ID
+	 * @param artifactId the artifact ID
+	 * @return a {@link Dependency} or {@code null}
+	 */
+	public Dependency find(String groupId, String artifactId);
+
+	/**
+	 * Find a single dependency for the artifact IDs.
+	 * @param artifactId the artifact ID
+	 * @return a {@link Dependency} or {@code null}
+	 */
+	public Dependency find(String artifactId);
+
+	/**
+	 * Provide an {@link Iterator} over all managed {@link Dependency Dependencies}.
+	 */
+	@Override
+	public Iterator<Dependency> iterator();
+
+}

spring-boot-tools/spring-boot-dependency-tools/src/main/java/org/springframework/boot/dependency/tools/Dependency.java

@@ -16,19 +16,14 @@
 
 package org.springframework.boot.dependency.tools;
 
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
-import org.w3c.dom.Element;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-
 /**
- * A single managed dependency.
+ * A single dependency.
  * 
  * @author Phillip Webb
- * @see ManagedDependencies
+ * @see Dependencies
  */
 public final class Dependency {
 
@@ -133,19 +128,6 @@ public boolean equals(Object obj) {
 		return false;
 	}
 
-	static Dependency fromDependenciesXml(Element element) throws Exception {
-		String groupId = getTextContent(element, "groupId");
-		String artifactId = getTextContent(element, "artifactId");
-		String version = getTextContent(element, "version");
-		List<Exclusion> exclusions = Exclusion.fromExclusionsXml(element
-				.getElementsByTagName("exclusions"));
-		return new Dependency(groupId, artifactId, version, exclusions);
-	}
-
-	private static String getTextContent(Element element, String tagName) {
-		return element.getElementsByTagName(tagName).item(0).getTextContent();
-	}
-
 	/**
 	 * A dependency exclusion.
 	 */
@@ -155,7 +137,7 @@ public static final class Exclusion {
 
 		private final String artifactId;
 
-		private Exclusion(String groupId, String artifactId) {
+		Exclusion(String groupId, String artifactId) {
 			Assert.notNull(groupId, "GroupId must not be null");
 			Assert.notNull(groupId, "ArtifactId must not be null");
 			this.groupId = groupId;
@@ -204,31 +186,6 @@ public boolean equals(Object obj) {
 			return false;
 		}
 
-		private static List<Exclusion> fromExclusionsXml(NodeList exclusion) {
-			if (exclusion == null || exclusion.getLength() == 0) {
-				return Collections.emptyList();
-			}
-			return fromExclusionsXml(exclusion.item(0));
-		}
-
-		private static List<Exclusion> fromExclusionsXml(Node item) {
-			List<Exclusion> exclusions = new ArrayList<Dependency.Exclusion>();
-			NodeList children = item.getChildNodes();
-			for (int i = 0; i < children.getLength(); i++) {
-				Node child = children.item(i);
-				if (child instanceof Element) {
-					exclusions.add(fromExclusionXml((Element) child));
-				}
-			}
-			return exclusions;
-		}
-
-		private static Exclusion fromExclusionXml(Element element) {
-			String groupId = getTextContent(element, "groupId");
-			String artifactId = getTextContent(element, "artifactId");
-			return new Exclusion(groupId, artifactId);
-		}
-
 	}
 
 }

spring-boot-tools/spring-boot-dependency-tools/src/main/java/org/springframework/boot/dependency/tools/ManagedDependencies.java

@@ -16,40 +16,96 @@
 
 package org.springframework.boot.dependency.tools;
 
+import java.util.Collection;
+import java.util.Collections;
 import java.util.Iterator;
 
 /**
- * Interface for accessing a known managed set of dependencies.
+ * {@link Dependencies} used by various spring boot tools. Provides programmatic access to
+ * 'spring-boot-dependencies' and can also support user defined version managed
+ * dependencies.
  * 
  * @author Phillip Webb
  * @see Dependency
  */
-public interface ManagedDependencies extends Iterable<Dependency> {
+public abstract class ManagedDependencies implements Dependencies {
+
+	// NOTE: Take care if changing the API of this class, it is used by the third-party
+	// Gretty tool (https://github.com/akhikhl/gretty)
+
+	private final Dependencies delegate;
+
+	ManagedDependencies(Dependencies delegate) {
+		this.delegate = delegate;
+	}
 
 	/**
-	 * @return The Spring Boot version being managed.
+	 * Return the 'spring-boot-dependencies' POM version.
+	 * @deprecated since 1.1.0 in favor of {@link #getSpringBootVersion()}
 	 */
-	public String getSpringBootVersion();
+	@Deprecated
+	public String getVersion() {
+		return getSpringBootVersion();
+	}
+
+	/**
+	 * Return the 'spring-boot-dependencies' POM version.
+	 */
+	public String getSpringBootVersion() {
+		Dependency dependency = find("org.springframework.boot", "spring-boot");
+		return (dependency == null ? null : dependency.getVersion());
+	}
 
 	/**
 	 * Find a single dependency for the given group and artifact IDs.
 	 * @param groupId the group ID
 	 * @param artifactId the artifact ID
 	 * @return a {@link Dependency} or {@code null}
 	 */
-	public Dependency find(String groupId, String artifactId);
+	@Override
+	public Dependency find(String groupId, String artifactId) {
+		return this.delegate.find(groupId, artifactId);
+	}
 
 	/**
 	 * Find a single dependency for the artifact IDs.
 	 * @param artifactId the artifact ID
 	 * @return a {@link Dependency} or {@code null}
 	 */
-	public Dependency find(String artifactId);
+	@Override
+	public Dependency find(String artifactId) {
+		return this.delegate.find(artifactId);
+	}
 
 	/**
 	 * Provide an {@link Iterator} over all managed {@link Dependency Dependencies}.
 	 */
 	@Override
-	public Iterator<Dependency> iterator();
+	public Iterator<Dependency> iterator() {
+		return this.delegate.iterator();
+	}
+
+	/**
+	 * Return spring-boot managed dependencies.
+	 * @return The dependencies.
+	 * @see #get(Collection)
+	 */
+	public static ManagedDependencies get() {
+		return get(Collections.<Dependencies> emptySet());
+	}
+
+	/**
+	 * Return spring-boot managed dependencies with optional version managed dependencies.
+	 * @param versionManagedDependencies a collection of {@link Dependencies} that take
+	 * precedence over the {@literal spring-boot-dependencies}.
+	 * @return the dependencies
+	 * @since 1.1.0
+	 */
+	public static ManagedDependencies get(
+			Collection<Dependencies> versionManagedDependencies) {
+		return new ManagedDependencies(new ManagedDependenciesDelegate(
+				versionManagedDependencies)) {
+		};
+	}
 
 }