Skip to content

Commit b3d5c2e

Browse files
SQiShERSQiShER
committed
Merge pull request SQiShER#160 from scompo/master
Fixes SQiShER#157
2 parents 10dac19 + a020094 commit b3d5c2e

8 files changed

Lines changed: 113 additions & 6 deletions

File tree

‎src/integration-test/java/de/danielbechler/diff/categories/CategoriesTestIT.groovy‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
package de.danielbechler.diff.categories
2+
3+
import de.danielbechler.diff.ObjectDifferBuilder
4+
import de.danielbechler.diff.introspection.ObjectDiffProperty
5+
import de.danielbechler.diff.node.DiffNode
6+
import de.danielbechler.diff.node.Visit
7+
import de.danielbechler.diff.path.NodePath
8+
import spock.lang.Specification
9+
10+
class CategoriesTestIT extends Specification{
11+
12+
def "should return all categories"(){
13+
setup:
14+
def obj1 = new MyObject("aaa","aaa")
15+
def obj2 = new MyObject("bbb","bbb")
16+
def differ = ObjectDifferBuilder.startBuilding()
17+
.categories()
18+
.ofNode(NodePath.with("firstString")).toBe("cat1")
19+
.ofNode(NodePath.with("secondString")).toBe("cat1")
20+
.and()
21+
.build()
22+
def node = differ.compare(obj1,obj2)
23+
24+
expect :
25+
node.getChild("firstString").getCategories() == ["cat1"] as Set
26+
node.getChild("secondString").getCategories() == ["cat1", "catAnnotation"] as Set
27+
}
28+
29+
class MyObject{
30+
31+
def firstString
32+
def secondString
33+
34+
MyObject(firstString,secondString) {
35+
36+
this.firstString = firstString
37+
this.secondString = secondString
38+
}
39+
40+
@ObjectDiffProperty(categories = ["catAnnotation"])
41+
def getSecondString() {
42+
return secondString
43+
}
44+
}
45+
}

‎src/main/java/de/danielbechler/diff/ObjectDifferBuilder.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,8 @@ public ObjectDiffer build()
160160
circularReferenceService,
161161
inclusionService,
162162
returnableNodeService,
163-
introspectionService);
163+
introspectionService,
164+
categoryService);
164165
differProvider.push(new BeanDiffer(
165166
differDispatcher,
166167
introspectionService,

‎src/main/java/de/danielbechler/diff/differ/DifferDispatcher.java‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import de.danielbechler.diff.access.Accessor;
2020
import de.danielbechler.diff.access.Instances;
2121
import de.danielbechler.diff.access.PropertyAwareAccessor;
22+
import de.danielbechler.diff.category.CategoryResolver;
2223
import de.danielbechler.diff.introspection.PropertyReadException;
2324
import de.danielbechler.diff.circular.CircularReferenceDetector;
2425
import de.danielbechler.diff.circular.CircularReferenceDetectorFactory;
@@ -46,6 +47,7 @@ public class DifferDispatcher
4647
private final CircularReferenceDetectorFactory circularReferenceDetectorFactory;
4748
private final CircularReferenceExceptionHandler circularReferenceExceptionHandler;
4849
private final IsIgnoredResolver isIgnoredResolver;
50+
private final CategoryResolver categoryResolver;
4951
private final IsReturnableResolver isReturnableResolver;
5052
private final PropertyAccessExceptionHandlerResolver propertyAccessExceptionHandlerResolver;
5153
private static final ThreadLocal<CircularReferenceDetector> workingThreadLocal = new ThreadLocal<CircularReferenceDetector>();
@@ -56,14 +58,18 @@ public DifferDispatcher(final DifferProvider differProvider,
5658
final CircularReferenceExceptionHandler circularReferenceExceptionHandler,
5759
final IsIgnoredResolver ignoredResolver,
5860
final IsReturnableResolver returnableResolver,
59-
final PropertyAccessExceptionHandlerResolver propertyAccessExceptionHandlerResolver)
61+
final PropertyAccessExceptionHandlerResolver propertyAccessExceptionHandlerResolver,
62+
final CategoryResolver categoryResolver)
6063
{
6164
Assert.notNull(differProvider, "differFactory");
6265
this.differProvider = differProvider;
6366

6467
Assert.notNull(ignoredResolver, "ignoredResolver");
6568
this.isIgnoredResolver = ignoredResolver;
6669

70+
Assert.notNull(categoryResolver, "categoryResolver");
71+
this.categoryResolver = categoryResolver;
72+
6773
this.circularReferenceDetectorFactory = circularReferenceDetectorFactory;
6874
this.circularReferenceExceptionHandler = circularReferenceExceptionHandler;
6975
this.isReturnableResolver = returnableResolver;
@@ -101,6 +107,10 @@ public DiffNode dispatch(final DiffNode parentNode,
101107
{
102108
parentNode.addChild(node);
103109
}
110+
if(node != null)
111+
{
112+
node.addCategories(categoryResolver.resolveCategories(node));
113+
}
104114
return node;
105115
}
106116

‎src/main/java/de/danielbechler/diff/inclusion/InclusionService.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,4 +279,5 @@ public ObjectDifferBuilder and()
279279
{
280280
return rootConfiguration;
281281
}
282+
282283
}

‎src/main/java/de/danielbechler/diff/node/DiffNode.java‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
import java.util.Map;
3939
import java.util.Set;
4040
import java.util.TreeSet;
41+
import java.util.Collection;
4142
import java.util.concurrent.atomic.AtomicBoolean;
4243

4344
import static java.util.Collections.unmodifiableSet;
@@ -67,6 +68,7 @@ public class DiffNode
6768
private Class<?> valueType;
6869
private TypeInfo valueTypeInfo;
6970
private IdentityStrategy childIdentityStrategy;
71+
private final Set<String> additionalCategories = new TreeSet<String>();
7072

7173
public void setChildIdentityStrategy(final IdentityStrategy identityStrategy)
7274
{
@@ -573,7 +575,11 @@ public boolean isExcluded()
573575
return false;
574576
}
575577

576-
// TODO These categories should also contain the ones configured via CategoryService
578+
/**
579+
* Returns an unmodifiable {@link java.util.Set} of {@link java.lang.String} with the categories of this node.
580+
*
581+
* @return an unmodifiable {@link java.util.Set} of {@link java.lang.String} with the categories of this node
582+
*/
577583
public final Set<String> getCategories()
578584
{
579585
final Set<String> categories = new TreeSet<String>();
@@ -589,7 +595,9 @@ public final Set<String> getCategories()
589595
categories.addAll(categoriesFromAccessor);
590596
}
591597
}
592-
return categories;
598+
categories.addAll(additionalCategories);
599+
600+
return unmodifiableSet(categories);
593601
}
594602

595603
/**
@@ -732,6 +740,12 @@ else if (childCount() > 1)
732740
return sb.toString();
733741
}
734742

743+
public void addCategories(final Collection<String> additionalCategories)
744+
{
745+
Assert.notNull(additionalCategories, "additionalCategories");
746+
this.additionalCategories.addAll(additionalCategories);
747+
}
748+
735749
/**
736750
* @return Returns the path to the first node in the hierarchy that represents the same object instance as
737751
* this one. (Only if {@link #isCircular()} returns <code>true</code>.

‎src/test/java/de/danielbechler/diff/differ/DifferDispatcherShould.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import de.danielbechler.diff.access.Accessor;
2020
import de.danielbechler.diff.access.Instances;
2121
import de.danielbechler.diff.access.RootAccessor;
22+
import de.danielbechler.diff.category.CategoryResolver;
2223
import de.danielbechler.diff.circular.CircularReferenceDetector;
2324
import de.danielbechler.diff.circular.CircularReferenceDetectorFactory;
2425
import de.danielbechler.diff.circular.CircularReferenceExceptionHandler;
@@ -62,6 +63,8 @@ public class DifferDispatcherShould
6263
@Mock
6364
private IsIgnoredResolver ignoredResolver;
6465
@Mock
66+
private CategoryResolver categoryResolver;
67+
@Mock
6568
private IsReturnableResolver returnableResolver;
6669
@Mock
6770
private Instances instances;
@@ -79,7 +82,7 @@ public void setUp() throws Exception
7982
when(instances.access(any(Accessor.class))).thenReturn(accessedInstances);
8083
when(accessedInstances.getSourceAccessor()).thenReturn(accessor);
8184

82-
differDispatcher = new DifferDispatcher(differProvider, circularReferenceDetectorFactory, circularReferenceExceptionHandler, ignoredResolver, returnableResolver, propertyAccessExceptionHandlerResolver);
85+
differDispatcher = new DifferDispatcher(differProvider, circularReferenceDetectorFactory, circularReferenceExceptionHandler, ignoredResolver, returnableResolver, propertyAccessExceptionHandlerResolver, categoryResolver);
8386
}
8487

8588
@Test

‎src/test/java/de/danielbechler/diff/differ/DifferDispatcherTest.groovy‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package de.danielbechler.diff.differ
1818

1919
import de.danielbechler.diff.access.*
20+
import de.danielbechler.diff.category.CategoryResolver
2021
import de.danielbechler.diff.circular.CircularReferenceDetector
2122
import de.danielbechler.diff.circular.CircularReferenceDetectorFactory
2223
import de.danielbechler.diff.circular.CircularReferenceExceptionHandler
@@ -53,14 +54,18 @@ class DifferDispatcherTest extends Specification {
5354
def isReturnableResolver = Stub IsReturnableResolver, {
5455
isReturnable(_ as DiffNode) >> true
5556
}
57+
def categoryResolver = Stub CategoryResolver, {
58+
resolveCategories(_ as DiffNode) >> Collections.emptySet()
59+
}
5660
def propertyAccessExceptionHandlerResolver = Mock PropertyAccessExceptionHandlerResolver
5761
def differDispatcher = new DifferDispatcher(
5862
differProvider,
5963
circularReferenceDetectorFactory,
6064
circularReferenceExceptionHandler,
6165
isIgnoredResolver,
6266
isReturnableResolver,
63-
propertyAccessExceptionHandlerResolver)
67+
propertyAccessExceptionHandlerResolver,
68+
categoryResolver)
6469

6570
@Ignore
6671
def "when a circular reference is detected"() {

‎src/test/java/de/danielbechler/diff/node/DiffNodeTest.groovy‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,4 +245,32 @@ class DiffNodeTest extends Specification {
245245

246246
doesOrDoesNotImplement = expectedResult ? 'implements' : 'does not implement'
247247
}
248+
249+
def "should return added categories"(){
250+
given:
251+
def node = new DiffNode(null, Mock(Accessor), Object)
252+
node.addCategories(["addedCategory"] as List)
253+
expect :
254+
node.getCategories() == ["addedCategory"] as Set
255+
}
256+
257+
def "categories should not be modifiable by a client directly"(){
258+
259+
when:
260+
def node = new DiffNode(null, Mock(Accessor), Object)
261+
def cats = node.getCategories()
262+
cats.removeAll()
263+
then :
264+
thrown UnsupportedOperationException
265+
}
266+
267+
def "should throw exception when added a null collection"(){
268+
269+
when:
270+
def node = new DiffNode(null, Mock(Accessor), Object)
271+
node.addCategories(null)
272+
then :
273+
def ex = thrown(IllegalArgumentException)
274+
ex.message == "'additionalCategories' must not be null"
275+
}
248276
}

0 commit comments

Comments
 (0)