Add protected YamlProcessor.getFlattenedMap method

Add a protected getFlattenedMap method to the YamlProcessor that
subclasses can use to flatten a source Map so that it has the same
entries as the Properties, but retains order.

Issue: SPR-12499

Author: philwebb

spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java

@@ -212,7 +212,7 @@ private Map<String, Object> asMap(Object object) {
 
 	private boolean process(Map<String, Object> map, MatchCallback callback) {
 		Properties properties = new Properties();
-		assignProperties(properties, map, null);
+		properties.putAll(getFlattenedMap(map));
 
 		if (this.documentMatchers.isEmpty()) {
 			if (this.logger.isDebugEnabled()) {
@@ -247,8 +247,23 @@ private boolean process(Map<String, Object> map, MatchCallback callback) {
 		return false;
 	}
 
-	private void assignProperties(Properties properties, Map<String, Object> input, String path) {
-		for (Entry<String, Object> entry : input.entrySet()) {
+	/**
+	 * Return a flattened version of the given map, recursively following any nested Map
+	 * or Collection values. Entries from the resulting map retain the same order as the
+	 * source. When called with the Map from a {@link MatchCallback} the result will
+	 * contain the same values as the {@link MatchCallback} Properties.
+	 * @param source the source map
+	 * @return a flattened map
+	 * @since 4.2.3
+	 */
+	protected final Map<String, Object> getFlattenedMap(Map<String, Object> source) {
+		Map<String, Object> result = new LinkedHashMap<String, Object>();
+		buildFlattenedMap(result, source, null);
+		return result;
+	}
+
+	private void buildFlattenedMap(Map<String, Object> result, Map<String, Object> source, String path) {
+		for (Entry<String, Object> entry : source.entrySet()) {
 			String key = entry.getKey();
 			if (StringUtils.hasText(path)) {
 				if (key.startsWith("[")) {
@@ -260,26 +275,26 @@ private void assignProperties(Properties properties, Map<String, Object> input,
 			}
 			Object value = entry.getValue();
 			if (value instanceof String) {
-				properties.put(key, value);
+				result.put(key, value);
 			}
 			else if (value instanceof Map) {
 				// Need a compound key
 				@SuppressWarnings("unchecked")
 				Map<String, Object> map = (Map<String, Object>) value;
-				assignProperties(properties, map, key);
+				buildFlattenedMap(result, map, key);
 			}
 			else if (value instanceof Collection) {
 				// Need a compound key
 				@SuppressWarnings("unchecked")
 				Collection<Object> collection = (Collection<Object>) value;
 				int count = 0;
 				for (Object object : collection) {
-					assignProperties(properties,
+					buildFlattenedMap(result,
 							Collections.singletonMap("[" + (count++) + "]", object), key);
 				}
 			}
 			else {
-				properties.put(key, value == null ? "" : value);
+				result.put(key, value == null ? "" : value);
 			}
 		}
 	}

spring-beans/src/test/java/org/springframework/beans/factory/config/YamlProcessorTests.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.beans.factory.config;
 
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Properties;
 
@@ -23,7 +24,6 @@
 import org.junit.rules.ExpectedException;
 import org.yaml.snakeyaml.parser.ParserException;
 import org.yaml.snakeyaml.scanner.ScannerException;
-
 import org.springframework.core.io.ByteArrayResource;
 
 import static org.junit.Assert.*;
@@ -135,4 +135,24 @@ public void process(Properties properties, Map<String, Object> map) {
 			}
 		});
 	}
+
+	@Test
+	@SuppressWarnings("unchecked")
+	public void flattenedMapIsSameAsPropertiesButOrdered() {
+		this.processor.setResources(new ByteArrayResource(
+				"foo: bar\nbar:\n spam: bucket".getBytes()));
+		this.processor.process(new MatchCallback() {
+			@Override
+			public void process(Properties properties, Map<String, Object> map) {
+				assertEquals("bucket", properties.get("bar.spam"));
+				assertEquals(2, properties.size());
+				Map<String, Object> flattenedMap = processor.getFlattenedMap(map);
+				assertEquals("bucket", flattenedMap.get("bar.spam"));
+				assertEquals(2, flattenedMap.size());
+				assertTrue(flattenedMap instanceof LinkedHashMap);
+				Map<String, Object> bar = (Map<String, Object>) map.get("bar");
+				assertEquals("bucket", bar.get("spam"));
+			}
+		});
+	}
 }