Inclusion stuff works now. Tests still unfinished.

Author: SQiShER

.idea/compiler.xml

@@ -17,7 +17,6 @@
 package de.danielbechler.diff
 
 import de.danielbechler.diff.collection.CollectionItemElementSelector
-import de.danielbechler.diff.visitor.PrintingVisitor
 import spock.lang.Specification
 
 import static de.danielbechler.diff.PhoneBookSetup.Contact
@@ -27,12 +26,15 @@ import static de.danielbechler.diff.PhoneBookSetup.Contact
  */
 class InclusionAndExclusionITCase extends Specification {
 
+	static final GEORGE_SELECTOR = new CollectionItemElementSelector(new Contact(id: 'george'))
+	static final KRAMER_SELECTOR = new CollectionItemElementSelector(new Contact(id: 'kramer'))
+
 	def builder = ObjectDifferBuilder.startBuilding()
 	def configurable = builder.configure()
 	def working = PhoneBookSetup.getWorking()
 	def base = PhoneBookSetup.getBase()
 
-	def "Sanity check"() {
+	def "sanity check"() {
 		when:
 		  def node = ObjectDifferBuilder.buildDefault().compare(working, base)
 
@@ -44,12 +46,13 @@ class InclusionAndExclusionITCase extends Specification {
 		  node.getChild('contacts').childCount() == 2
 
 		and: "only Georges name should have changed"
-		  node.getChild('contacts').getChild(new CollectionItemElementSelector(new Contact(id: 'george'))).childCount() == 1
-		  node.getChild('contacts').getChild(new CollectionItemElementSelector(new Contact(id: 'george'))).getChild('name').changed
+		  node.getChild('contacts').getChild(GEORGE_SELECTOR).childCount() == 1
+		  node.getChild('contacts').getChild(GEORGE_SELECTOR).getChild('name').changed
 
 		and: "only Kramers number should have changed"
-		  node.getChild('contacts').getChild(new CollectionItemElementSelector(new Contact(id: 'kramer'))).childCount() == 1
-		  node.getChild('contacts').getChild(new CollectionItemElementSelector(new Contact(id: 'kramer'))).getChild('number').changed
+
+		  node.getChild('contacts').getChild(KRAMER_SELECTOR).childCount() == 1
+		  node.getChild('contacts').getChild(KRAMER_SELECTOR).getChild('number').changed
 	}
 
 	def "Property with specific name excluded via configuration"() {
@@ -60,7 +63,7 @@ class InclusionAndExclusionITCase extends Specification {
 		  def node = builder.build().compare(working, base)
 
 		then: "Georges name change should be ignored"
-		  node.getChild('contacts').getChild(new CollectionItemElementSelector(new Contact(id: 'george'))) == null
+		  node.getChild('contacts').getChild(GEORGE_SELECTOR) == null
 
 		and: "The name change of the phone book should be ignored too"
 		  node.getChild('name') == null
@@ -74,7 +77,7 @@ class InclusionAndExclusionITCase extends Specification {
 		  def node = builder.build().compare(working, base)
 
 		then: "Kramers changed number should be ignored"
-		  node.getChild('contacts').getChild(new CollectionItemElementSelector(new Contact(id: 'kramer'))) == null
+		  node.getChild('contacts').getChild(KRAMER_SELECTOR) == null
 	}
 
 	def "Type excluded via configuration"() {
@@ -93,14 +96,14 @@ class InclusionAndExclusionITCase extends Specification {
 		  configurable.inclusion().toExclude().node(NodePath
 				  .startBuilding()
 				  .propertyName('contacts')
-				  .collectionItem(new Contact(id: 'george'))
+				  .element(GEORGE_SELECTOR)
 				  .build())
 
 		when:
 		  def node = builder.build().compare(working, base)
 
 		then:
-		  node.getChild('contacts').getChild(new CollectionItemElementSelector(new Contact(id: 'george'))) == null
+		  node.getChild('contacts').getChild(GEORGE_SELECTOR) == null
 	}
 
 	def "Property excluded via @ObjectDiffProperty annotation"() {
@@ -139,7 +142,15 @@ class InclusionAndExclusionITCase extends Specification {
 	}
 
 	def "including an element via path includes all its children"() {
+		given:
+		  configurable.inclusion().toInclude().node(NodePath.with('contacts'))
+
+		when:
+		  def node = builder.build().compare(working, base)
 
+		then:
+		  node.getChild('contacts').changed
+		  node.getChild("contacts").childCount() == 2
 	}
 
 	def "including an element via category"() {
@@ -172,25 +183,61 @@ class InclusionAndExclusionITCase extends Specification {
 
 	def "include all but some specific elements"() {
 		given:
-		  configurable.inclusion().toInclude().node(NodePath.startBuilding().propertyName('contacts').any().build())
-		  configurable.inclusion().toExclude().node(NodePath.startBuilding().propertyName('contacts').collectionItem(new Contact(id: 'kramer')).build())
+		  configurable.inclusion().toInclude().node(NodePath.startBuilding().propertyName('contacts').build())
+		  configurable.inclusion().toExclude().node(NodePath.startBuilding().propertyName('contacts').element(KRAMER_SELECTOR).build())
 
 		when:
 		  def node = builder.build().compare(working, base)
 
-		and:
-		  node.visit(new PrintingVisitor(working, base))
-
 		then:
 		  node.getChild('contacts').changed
 		  node.getChild('contacts').childCount() == 1
 	}
 
-	def "including an element via category only includes properties if any of their parent elements is also somehow included"() {
+	def "when an element is included by property name, all its children will be implicitly included"() {
+		given:
+		  configurable.inclusion().toInclude().node(NodePath.startBuilding().propertyName('contacts').build())
+
+		when:
+		  def node = builder.build().compare(working, base)
+
+		then:
+		  node.childCount() == 1
+		  node.getChild('contacts').childCount() == 2
+		  node.getChild('contacts').getChild(GEORGE_SELECTOR).changed
+		  node.getChild('contacts').getChild(KRAMER_SELECTOR).changed
+	}
+
+	def "when an element is included by category, all its children will be implicitly included"() {
+		given:
+		  configurable.categories().ofNode(NodePath.startBuilding().propertyName('contacts').build()).toBe('identifier')
+		  configurable.inclusion().toInclude().categories('identifier')
+
+		when:
+		  def node = builder.build().compare(working, base)
+
+		then:
+		  node.childCount() == 1
+		  node.getChild('contacts').changed
+	}
+
+	def "when a child of an explicitly excluded element is included it should be excluded as well"() {
+		given:
+		  configurable.inclusion().toExclude().node(NodePath.startBuilding().propertyName('contacts').build())
+		  configurable.inclusion().toInclude().node(NodePath.startBuilding().propertyName('contacts').element(GEORGE_SELECTOR).build())
+
+		when:
+		  def node = builder.build().compare(working, base)
+
+		then:
+		  node.getChild('contacts') == null
+	}
+
+	def "including a category includes matching properties only if they can be reached due to other inclusion rules"() {
 		def includedCategory = "representation"
 		def nodePathToKramer = NodePath.startBuilding()
 				.propertyName("contacts")
-				.collectionItem(new Contact(id: "kramer"))
+				.element(KRAMER_SELECTOR)
 				.build()
 
 		given:

.idea/inspectionProfiles/Project_Default.xml

@@ -18,7 +18,10 @@
 
 /**
  * Created by Daniel Bechler.
+ *
+ * @deprecated Not very intuitive to work with (at least not internally)
  */
+@Deprecated
 public final class AnyElementSelector extends ElementSelector
 {
 	@Override

.idea/misc.xml

@@ -1,9 +1,15 @@
 package de.danielbechler.diff;
 
-import java.util.*;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
 
-import static java.util.Arrays.*;
-import static java.util.Collections.*;
+import static java.util.Arrays.asList;
+import static java.util.Collections.emptySet;
 
 /**
  *
@@ -13,6 +19,11 @@ class CategoryService implements CategoryConfiguration, CategoryResolver
 	private final NodePathValueHolder<String[]> nodePathCategories = NodePathValueHolder.of(String[].class);
 	private final Map<Class<?>, String[]> typeCategories = new HashMap<Class<?>, String[]>();
 
+	private static Collection<String> categoriesFromNode(final DiffNode node)
+	{
+		return node.getCategories();
+	}
+
 	public Set<String> resolveCategories(final DiffNode node)
 	{
 		final Set<String> categories = new TreeSet<String>();
@@ -24,12 +35,13 @@ public Set<String> resolveCategories(final DiffNode node)
 
 	private Collection<String> categoriesFromNodePathConfiguration(final DiffNode node)
 	{
-		final String[] categories = nodePathCategories.valueForNodePath(node.getPath());
-		if (categories != null)
+		final Collection<String> allCategories = new HashSet<String>();
+		final List<String[]> accumulatedValues = nodePathCategories.accumulatedValuesForNodePath(node.getPath());
+		for (final String[] categoriesForElement : accumulatedValues)
 		{
-			return asList(categories);
+			allCategories.addAll(asList(categoriesForElement));
 		}
-		return emptySet();
+		return allCategories;
 	}
 
 	private Collection<String> categoriesFromTypeConfiguration(final DiffNode node)
@@ -46,11 +58,6 @@ private Collection<String> categoriesFromTypeConfiguration(final DiffNode node)
 		return emptySet();
 	}
 
-	private static Collection<String> categoriesFromNode(final DiffNode node)
-	{
-		return node.getCategories();
-	}
-
 	public Of ofNode(final NodePath nodePath)
 	{
 		return new Of()

src/integration-test/java/de/danielbechler/diff/InclusionAndExclusionITCase.groovy

@@ -31,6 +31,7 @@ public class ConfigNode
 	private final Map<ElementSelector, ConfigNode> children = new HashMap<ElementSelector, ConfigNode>();
 	private final ElementSelector elementSelector;
 	private final ConfigNode parent;
+	@Deprecated
 	private ConfigNode prototype;
 	private Inclusion inclusion;
 
@@ -133,26 +134,27 @@ public boolean hasChild(final ElementSelector childSelector)
 
 	public boolean isIncluded()
 	{
-		if (inclusion == EXCLUDED)
-		{
-			return false;
-		}
-		final ConfigNode parentWithInclusion = getClosestParentWithInclusion();
-		if (parentWithInclusion == null)
+		if (inclusion != EXCLUDED)
 		{
+			final ConfigNode parentWithInclusion = getClosestParentWithInclusion();
+			if (parentWithInclusion != null)
+			{
+				return parentWithInclusion.getInclusion() != EXCLUDED;
+			}
 			if (!hasInclusion() && hasPrototype() && prototype.hasInclusion())
 			{
 				return prototype.inclusion == INCLUDED;
 			}
-			else
+			if (inclusion == INCLUDED)
+			{
+				return true;
+			}
+			if (hasIncludedChildren())
 			{
-				return inclusion == INCLUDED || hasIncludedChildren();
+				return true;
 			}
 		}
-		else
-		{
-			return parentWithInclusion.getInclusion() != EXCLUDED;
-		}
+		return false;
 	}
 
 	public boolean isExcluded()

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

@@ -119,7 +119,11 @@ private boolean isExcluded(final DiffNode node)
 	{
 		if (hasInclusions(EXCLUDED))
 		{
-			if (isExcludedByPath(node))
+			if (node.isExcluded())
+			{
+				return true;
+			}
+			else if (isExcludedByPath(node))
 			{
 				return true;
 			}
@@ -152,7 +156,12 @@ private boolean isExcludedByPropertyName(final DiffNode node)
 
 	private boolean isExcludedByPath(final DiffNode node)
 	{
-		return nodeInclusions.getNodeForPath(node.getPath()).isExcluded();
+		final ConfigNode configNode = nodeInclusions.getNodeForPath(node.getPath());
+		if (configNode.isExcluded() && !configNode.containsInclusion(INCLUDED))
+		{
+			return true;
+		}
+		return false;
 	}
 
 	private boolean isExcludedByCategory(final DiffNode node)
@@ -264,3 +273,11 @@ public To propertyNames(final String... propertyNames)
 		}
 	}
 }
+
+/*
+TODO
+Per Default sind alle Nodes included
+Wenn es explizite inclusion Regeln gibt, sind nur noch Nodes included die den Regeln gerecht werden
+Ein Node ist included wenn sein Parent included ist, außer er ist explizit excluded
+Ein Node ist excluded wenn sein Parent excluded ist, außer er ist explizit included
+*/

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

@@ -11,7 +11,10 @@
 
 /**
  * @author Daniel Bechler
+ * @see de.danielbechler.diff.ConfigNode
+ * @deprecated The ConfigNode provides a much more powerful way to store values for NodePaths.
  */
+@Deprecated
 class NodePathValueHolder<T>
 {
 	private final Map<ElementSelector, NodePathValueHolder<T>> elementValueHolders = new HashMap<ElementSelector, NodePathValueHolder<T>>();