When properties are explicitly included, this will now automatically include their children too [#70]

Author: SQiShER

src/main/java/de/danielbechler/diff/Configuration.java

@@ -77,7 +77,7 @@ public enum PrimitiveDefaultValueMode
 	private final Collection<PropertyPath> includedProperties = new HashSet<PropertyPath>(10);
 	private final Collection<PropertyPath> excludedProperties = new HashSet<PropertyPath>(10);
 	private final Collection<PropertyPath> equalsOnlyProperties = new LinkedHashSet<PropertyPath>(10);
-    private final Collection<Class<?>> compareToOnlyTypes = new LinkedHashSet<Class<?>>(10);
+	private final Collection<Class<?>> compareToOnlyTypes = new LinkedHashSet<Class<?>>(10);
 	private final Collection<Class<?>> equalsOnlyTypes = new LinkedHashSet<Class<?>>(10);
 	private boolean returnUnchangedNodes = false;
 	private boolean returnIgnoredNodes = false;
@@ -125,11 +125,11 @@ public Configuration withoutProperty(final PropertyPath propertyPath)
 		return this;
 	}
 
-    public Configuration withCompareToOnlyType(final Class<?> type)
-    {
-        this.compareToOnlyTypes.add(type);
-        return this;
-    }
+	public Configuration withCompareToOnlyType(final Class<?> type)
+	{
+		this.compareToOnlyTypes.add(type);
+		return this;
+	}
 
 	public Configuration withEqualsOnlyType(final Class<?> type)
 	{
@@ -248,6 +248,16 @@ else if (includedProperties.contains(node.getPropertyPath()))
 		{
 			return true;
 		}
+		else
+		{
+			for (final PropertyPath includedProperty : includedProperties)
+			{
+				if (includedProperty.isParentOf(node.getPropertyPath()))
+				{
+					return true;
+				}
+			}
+		}
 		return false;
 	}
 
@@ -264,22 +274,22 @@ public boolean isExcluded(final Node node)
 		return false;
 	}
 
-    public boolean isCompareToOnly(final Node node)
-    {
-        final Class<?> propertyType = node.getType();
-        if (propertyType != null)
-        {
-            if (compareToOnlyTypes.contains(propertyType) && Comparable.class.isAssignableFrom(propertyType))
-            {
-                return true;
-            }
-            if (Classes.isComparableType(propertyType))
-            {
-                return true;
-            }
-        }
-        return false;
-    }
+	public boolean isCompareToOnly(final Node node)
+	{
+		final Class<?> propertyType = node.getType();
+		if (propertyType != null)
+		{
+			if (compareToOnlyTypes.contains(propertyType) && Comparable.class.isAssignableFrom(propertyType))
+			{
+				return true;
+			}
+			if (Classes.isComparableType(propertyType))
+			{
+				return true;
+			}
+		}
+		return false;
+	}
 
 	public boolean isEqualsOnly(final Node node)
 	{
@@ -335,7 +345,7 @@ else if (node.hasChildren())
 		return true;
 	}
 
-    public boolean isIntrospectible(final Node node)
+	public boolean isIntrospectible(final Node node)
 	{
 		if (node.isAdded())
 		{

src/main/java/de/danielbechler/util/Collections.java

@@ -42,6 +42,10 @@ public static boolean isEmpty(final Collection<?> c)
 
 	public static <T> boolean containsAny(final Iterable<T> haystack, final Iterable<T> needles)
 	{
+		if (haystack == null || needles == null)
+		{
+			return false;
+		}
 		for (final T straw : haystack)
 		{
 			for (final T needle : needles)

src/test/java/de/danielbechler/diff/NodeInspectorSpec.groovy

@@ -0,0 +1,24 @@
+package de.danielbechler.diff
+
+import de.danielbechler.diff.path.PropertyPath
+import spock.lang.Specification
+/**
+ * @author Daniel Bechler
+ */
+class NodeInspectorSpec extends Specification
+{
+  def "isIncluded should include children of included properties"()
+  {
+    given: "a configuration with explicitly included property"
+    Configuration configuration = new Configuration()
+    configuration.withPropertyPath(PropertyPath.buildWith("collection"))
+
+    and: "a node that represents a child of the included property"
+    de.danielbechler.diff.node.Node node = Mock(de.danielbechler.diff.node.Node)
+    node.isRootNode() >> false
+    node.getPropertyPath() >> PropertyPath.buildWith("collection", "child")
+
+    expect:
+    configuration.isIncluded(node)
+  }
+}

src/test/java/de/danielbechler/diff/integration/issues/issue70/Person.java

@@ -0,0 +1,40 @@
+package de.danielbechler.diff.integration.issues.issue70;
+
+import java.util.*;
+
+/** @author Daniel Bechler */
+public class Person
+{
+	private String name;
+	private List<String> aliases;
+
+	public Person()
+	{
+	}
+
+	public Person(final String name, final List<String> aliases)
+	{
+		this.name = name;
+		this.aliases = aliases;
+	}
+
+	public String getName()
+	{
+		return this.name;
+	}
+
+	public void setName(final String name)
+	{
+		this.name = name;
+	}
+
+	public List<String> getAliases()
+	{
+		return this.aliases;
+	}
+
+	public void setAliases(final List<String> aliases)
+	{
+		this.aliases = aliases;
+	}
+}

src/test/java/de/danielbechler/diff/integration/issues/issue70/PersonDiffTest.java

@@ -0,0 +1,29 @@
+package de.danielbechler.diff.integration.issues.issue70;
+
+import de.danielbechler.diff.*;
+import de.danielbechler.diff.node.*;
+import de.danielbechler.diff.path.*;
+import de.danielbechler.diff.visitor.*;
+import org.junit.*;
+import org.junit.runner.*;
+import org.junit.runners.*;
+
+import java.util.*;
+
+@RunWith(JUnit4.class)
+public class PersonDiffTest
+{
+	@Test
+	public void testIncludeCollectionAttribute()
+	{
+		final Person a = new Person("Gulen Chongtham", Arrays.asList("Hola Espanyol", "Vicky Boss"));
+		final Person b = new Person("Gulen Chongthamm", Arrays.asList("Hola Espanyol", "Vicky Boss", "Roger Harper"));
+
+		final ObjectDiffer differ = ObjectDifferFactory.getInstance(new Configuration().withPropertyPath(PropertyPath.buildWith("aliases")));
+
+		final Node root = differ.compare(b, a);
+		root.visit(new PrintingVisitor(b, a));
+
+		NodeAssertions.assertThat(root).root().hasChanges();
+	}
+}