Skip to content

Commit 759c57b

Browse files
SQiShERSQiShER
committed
Moved IdentityStrategy configuration back into own confugration module
1 parent b10e9c3 commit 759c57b

19 files changed

Lines changed: 154 additions & 75 deletions

‎src/integration-test/java/de/danielbechler/diff/identity/IdentityStrategyAT.groovy‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ package de.danielbechler.diff.identity
1818

1919
import de.danielbechler.diff.ObjectDiffer
2020
import de.danielbechler.diff.ObjectDifferBuilder
21-
import de.danielbechler.diff.comparison.IdentityStrategy
2221
import de.danielbechler.diff.path.NodePath
2322
import spock.lang.Specification
2423

@@ -28,7 +27,7 @@ class IdentityStrategyAT extends Specification {
2827
List<?> collection = []
2928
}
3029

31-
static class SimpleIdentityStrategy implements IdentityStrategy {
30+
static class NonMatchingIdentityStrategy implements IdentityStrategy {
3231

3332
@Override
3433
boolean equals(Object working, Object base) {
@@ -37,10 +36,9 @@ class IdentityStrategyAT extends Specification {
3736
}
3837

3938
def 'configure IdentityStrategy for property of specific type'() {
40-
def strategy = new SimpleIdentityStrategy()
39+
def strategy = new NonMatchingIdentityStrategy()
4140
ObjectDiffer objectDiffer = ObjectDifferBuilder.startBuilding()
42-
.comparison()
43-
.ofCollectionItems(ObjectWithListProperty, 'collection').toUse(strategy)
41+
.identity().ofCollectionItems(ObjectWithListProperty, 'collection').via(strategy)
4442
.and().build()
4543

4644
def working = new ObjectWithListProperty(collection: ['a'])
@@ -53,10 +51,10 @@ class IdentityStrategyAT extends Specification {
5351
}
5452

5553
def 'configure IdentityStrategy for element at specific path'() {
56-
def strategy = new SimpleIdentityStrategy()
54+
def strategy = new NonMatchingIdentityStrategy()
5755
ObjectDiffer objectDiffer = ObjectDifferBuilder.startBuilding()
58-
.comparison()
59-
.ofCollectionItems(NodePath.with('collection')).toUse(strategy)
56+
.identity()
57+
.ofCollectionItems(NodePath.with('collection')).via(strategy)
6058
.and().build()
6159

6260
def working = new ObjectWithListProperty(collection: ['a'])

‎src/integration-test/java/de/danielbechler/diff/identity/IdentityStrategyIT.groovy‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ package de.danielbechler.diff.identity
1919
import de.danielbechler.diff.ObjectDiffer
2020
import de.danielbechler.diff.ObjectDifferBuilder
2121
import de.danielbechler.diff.access.CollectionItemAccessor
22-
import de.danielbechler.diff.comparison.IdentityStrategy
2322
import de.danielbechler.diff.differ.CollectionDiffer
2423
import de.danielbechler.diff.node.DiffNode
2524
import de.danielbechler.diff.path.NodePath
@@ -47,9 +46,9 @@ class IdentityStrategyIT extends Specification {
4746
expect:
4847
if (identityStrategyEnabled) {
4948
def identityStrategy = new CodeIdentityStrategy()
50-
objectDiffer = objectDifferBuilder.comparison()
49+
objectDiffer = objectDifferBuilder.identity()
5150
.ofCollectionItems(NodePath.withRoot())
52-
.toUse(identityStrategy)
51+
.via(identityStrategy)
5352
.and().build()
5453
baseSelector = new CollectionItemElementSelector(baseCode.clone())
5554
workingSelector = new CollectionItemElementSelector(workingCode.clone())
@@ -76,7 +75,7 @@ class IdentityStrategyIT extends Specification {
7675
def working = [new Code(id: 'working', code: '1')]
7776
def base = [new Code(id: 'base', code: '1')]
7877
def node = ObjectDifferBuilder.startBuilding()
79-
.comparison().ofCollectionItems(NodePath.withRoot()).toUse(identityStrategy)
78+
.identity().ofCollectionItems(NodePath.withRoot()).via(identityStrategy)
8079
.and().build()
8180
.compare(working, base)
8281
and:
@@ -94,7 +93,7 @@ class IdentityStrategyIT extends Specification {
9493
def working = [new Code(id: 'working', code: '1')]
9594
def base = [new Code(id: 'base', code: '1')]
9695
def node = ObjectDifferBuilder.startBuilding()
97-
.comparison().ofCollectionItems(NodePath.withRoot()).toUse(identityStrategy)
96+
.identity().ofCollectionItems(NodePath.withRoot()).via(identityStrategy)
9897
.and().build()
9998
.compare(working, base)
10099
and:
@@ -114,7 +113,7 @@ class IdentityStrategyIT extends Specification {
114113
def working = [new Code(id: 'working', code: '1')]
115114
def base = [new Code(id: 'base', code: '1')]
116115
def node = ObjectDifferBuilder.startBuilding()
117-
.comparison().ofCollectionItems(NodePath.withRoot()).toUse(identityStrategy)
116+
.identity().ofCollectionItems(NodePath.withRoot()).via(identityStrategy)
118117
.and().build()
119118
.compare(working, base)
120119
and:

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
import de.danielbechler.diff.differ.PrimitiveDiffer;
3535
import de.danielbechler.diff.filtering.FilteringConfigurer;
3636
import de.danielbechler.diff.filtering.ReturnableNodeService;
37+
import de.danielbechler.diff.identity.IdentityService;
3738
import de.danielbechler.diff.inclusion.InclusionConfigurer;
3839
import de.danielbechler.diff.inclusion.InclusionService;
3940
import de.danielbechler.diff.introspection.IntrospectionConfigurer;
@@ -57,6 +58,7 @@ public class ObjectDifferBuilder
5758
private final CategoryService categoryService = new CategoryService(this);
5859
private final InclusionService inclusionService = new InclusionService(categoryService, this);
5960
private final ComparisonService comparisonService = new ComparisonService(this);
61+
private final IdentityService identityService = new IdentityService(this);
6062
private final ReturnableNodeService returnableNodeService = new ReturnableNodeService(this);
6163
private final CircularReferenceService circularReferenceService = new CircularReferenceService(this);
6264
private final DifferConfigurer differConfigurer = new DifferConfigurerImpl();
@@ -112,6 +114,24 @@ public ComparisonConfigurer comparison()
112114
return comparisonService;
113115
}
114116

117+
/**
118+
* <b>EXPERT FEATURE</b>: Allows to configure the way the identity of objects is determined in order to establish
119+
* the relationship between different versions. By default this is done via the <code>equals</code> method; but
120+
* sometimes that's just not possible. For example when you are dealing with generated classes or you are dealing
121+
* with third-party code.
122+
* <p/>
123+
* Please keep in mind that this only alters the way this library establishes the connection between two objects.
124+
* This doesn't extend to the underlying collections. So keep what in mind when you start merging your collections
125+
* and weird things start to happen.
126+
* <p/>
127+
* <b>WARNING</b>: Personally I'd try to avoid this feature as long as possible and only use it when there is
128+
* absolutely no other way.
129+
*/
130+
public IdentityService identity()
131+
{
132+
return identityService;
133+
}
134+
115135
/**
116136
* Allows to assign custom categories (or tags) to entire types or selected
117137
* elements and properties.
@@ -147,7 +167,7 @@ public ObjectDiffer build()
147167
returnableNodeService,
148168
comparisonService,
149169
introspectionService));
150-
differProvider.push(new CollectionDiffer(differDispatcher, comparisonService, comparisonService));
170+
differProvider.push(new CollectionDiffer(differDispatcher, comparisonService, identityService));
151171
differProvider.push(new MapDiffer(differDispatcher, comparisonService));
152172
differProvider.push(new PrimitiveDiffer(comparisonService));
153173
for (final DifferFactory differFactory : differFactories)

‎src/main/java/de/danielbechler/diff/access/CollectionItemAccessor.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616

1717
package de.danielbechler.diff.access;
1818

19-
import de.danielbechler.diff.comparison.EqualsIdentityStrategy;
20-
import de.danielbechler.diff.comparison.IdentityStrategy;
19+
import de.danielbechler.diff.identity.EqualsIdentityStrategy;
20+
import de.danielbechler.diff.identity.IdentityStrategy;
2121
import de.danielbechler.diff.selector.CollectionItemElementSelector;
2222
import de.danielbechler.diff.selector.ElementSelector;
2323
import de.danielbechler.util.Assert;

‎src/main/java/de/danielbechler/diff/comparison/ComparisonConfigurer.java‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,6 @@ public interface ComparisonConfigurer
3535

3636
OfPrimitiveTypes ofPrimitiveTypes();
3737

38-
/**
39-
* Allows to configure the way object identities are established between collection items.
40-
*/
41-
OfCollectionItems ofCollectionItems(NodePath nodePath);
42-
43-
/**
44-
* Allows to configure the way object identities are established between collection items.
45-
*/
46-
OfCollectionItems ofCollectionItems(Class<?> type, String propertyName);
47-
4838
ObjectDifferBuilder and();
4939

5040
interface Of
@@ -58,11 +48,6 @@ interface Of
5848
ComparisonConfigurer toUseCompareToMethod();
5949
}
6050

61-
interface OfCollectionItems
62-
{
63-
ComparisonConfigurer toUse(IdentityStrategy identityStrategy);
64-
}
65-
6651
interface OfPrimitiveTypes
6752
{
6853
ComparisonConfigurer toTreatDefaultValuesAs(PrimitiveDefaultValueMode primitiveDefaultValueMode);

‎src/main/java/de/danielbechler/diff/comparison/ComparisonService.java‎

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,12 @@
2727
import java.util.HashMap;
2828
import java.util.Map;
2929

30-
public class ComparisonService implements ComparisonConfigurer, ComparisonStrategyResolver, PrimitiveDefaultValueModeResolver, IdentityStrategyResolver
30+
public class ComparisonService implements ComparisonConfigurer, ComparisonStrategyResolver, PrimitiveDefaultValueModeResolver
3131
{
3232
private static final ComparisonStrategy COMPARABLE_COMPARISON_STRATEGY = new ComparableComparisonStrategy();
3333
private static final ComparisonStrategy EQUALS_ONLY_COMPARISON_STRATEGY = new EqualsOnlyComparisonStrategy();
3434

3535
private final NodePathValueHolder<ComparisonStrategy> nodePathComparisonStrategies = NodePathValueHolder.of(ComparisonStrategy.class);
36-
private final CollectionComparisonService collectionComparisonService = new CollectionComparisonService(this);
3736
private final Map<Class<?>, ComparisonStrategy> typeComparisonStrategyMap = new HashMap<Class<?>, ComparisonStrategy>();
3837
private final ObjectDifferBuilder objectDifferBuilder;
3938

@@ -114,26 +113,11 @@ public OfPrimitiveTypes ofPrimitiveTypes()
114113
return new OfPrimitiveTypesImpl();
115114
}
116115

117-
public OfCollectionItems ofCollectionItems(final NodePath nodePath)
118-
{
119-
return collectionComparisonService.ofCollectionItems(nodePath);
120-
}
121-
122-
public OfCollectionItems ofCollectionItems(final Class<?> type, final String propertyName)
123-
{
124-
return collectionComparisonService.ofCollectionItems(type, propertyName);
125-
}
126-
127116
public ObjectDifferBuilder and()
128117
{
129118
return objectDifferBuilder;
130119
}
131120

132-
public IdentityStrategy resolveIdentityStrategy(final DiffNode node)
133-
{
134-
return collectionComparisonService.resolveIdentityStrategy(node);
135-
}
136-
137121
private abstract static class AbstractOf implements Of
138122
{
139123
public ComparisonConfigurer toUseEqualsMethod()

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
import de.danielbechler.diff.access.Instances;
2222
import de.danielbechler.diff.comparison.ComparisonStrategy;
2323
import de.danielbechler.diff.comparison.ComparisonStrategyResolver;
24-
import de.danielbechler.diff.comparison.IdentityStrategy;
25-
import de.danielbechler.diff.comparison.IdentityStrategyResolver;
24+
import de.danielbechler.diff.identity.IdentityStrategy;
25+
import de.danielbechler.diff.identity.IdentityStrategyResolver;
2626
import de.danielbechler.diff.node.DiffNode;
2727
import de.danielbechler.util.Assert;
2828

src/main/java/de/danielbechler/diff/comparison/CollectionComparisonService.java renamed to src/main/java/de/danielbechler/diff/identity/CollectionItemIdentityService.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@
1414
* limitations under the License.
1515
*/
1616

17-
package de.danielbechler.diff.comparison;
17+
package de.danielbechler.diff.identity;
1818

1919
import de.danielbechler.diff.inclusion.ValueNode;
2020
import de.danielbechler.diff.node.DiffNode;
2121
import de.danielbechler.diff.path.NodePath;
2222

23-
public class CollectionComparisonService implements IdentityStrategyResolver
23+
class CollectionItemIdentityService implements IdentityStrategyResolver
2424
{
2525
private final ValueNode<IdentityStrategy> nodePathIdentityStrategies;
2626
private final TypePropertyIdentityStrategyResolver typePropertyIdentityStrategyResolver;
27-
private final ComparisonConfigurer comparisonConfigurer;
27+
private final IdentityConfigurer identityConfigurer;
2828

29-
public CollectionComparisonService(final ComparisonConfigurer comparisonConfigurer)
29+
public CollectionItemIdentityService(final IdentityConfigurer identityConfigurer)
3030
{
31-
this.comparisonConfigurer = comparisonConfigurer;
31+
this.identityConfigurer = identityConfigurer;
3232
this.nodePathIdentityStrategies = new ValueNode<IdentityStrategy>();
3333
this.typePropertyIdentityStrategyResolver = new TypePropertyIdentityStrategyResolver();
3434
}
@@ -48,17 +48,17 @@ public IdentityStrategy resolveIdentityStrategy(final DiffNode node)
4848
return EqualsIdentityStrategy.getInstance();
4949
}
5050

51-
public ComparisonConfigurer.OfCollectionItems ofCollectionItems(final NodePath nodePath)
51+
public IdentityConfigurer.OfCollectionItems ofCollectionItems(final NodePath nodePath)
5252
{
5353
return new OfCollectionItemsByNodePath(nodePath);
5454
}
5555

56-
public ComparisonConfigurer.OfCollectionItems ofCollectionItems(final Class<?> type, final String propertyName)
56+
public IdentityConfigurer.OfCollectionItems ofCollectionItems(final Class<?> type, final String propertyName)
5757
{
5858
return new OfCollectionItemsByTypeProperty(type, propertyName);
5959
}
6060

61-
private class OfCollectionItemsByNodePath implements ComparisonConfigurer.OfCollectionItems
61+
private class OfCollectionItemsByNodePath implements IdentityConfigurer.OfCollectionItems
6262
{
6363
private final NodePath nodePath;
6464

@@ -67,14 +67,14 @@ public OfCollectionItemsByNodePath(final NodePath nodePath)
6767
this.nodePath = nodePath;
6868
}
6969

70-
public ComparisonConfigurer toUse(final IdentityStrategy identityStrategy)
70+
public IdentityConfigurer via(final IdentityStrategy identityStrategy)
7171
{
7272
nodePathIdentityStrategies.getNodeForPath(nodePath).setValue(identityStrategy);
73-
return comparisonConfigurer;
73+
return identityConfigurer;
7474
}
7575
}
7676

77-
private class OfCollectionItemsByTypeProperty implements ComparisonConfigurer.OfCollectionItems
77+
private class OfCollectionItemsByTypeProperty implements IdentityConfigurer.OfCollectionItems
7878
{
7979
private final Class<?> type;
8080
private final String propertyName;
@@ -85,10 +85,10 @@ public OfCollectionItemsByTypeProperty(final Class<?> type, final String propert
8585
this.propertyName = propertyName;
8686
}
8787

88-
public ComparisonConfigurer toUse(final IdentityStrategy identityStrategy)
88+
public IdentityConfigurer via(final IdentityStrategy identityStrategy)
8989
{
9090
typePropertyIdentityStrategyResolver.setStrategy(identityStrategy, type, propertyName);
91-
return comparisonConfigurer;
91+
return identityConfigurer;
9292
}
9393
}
9494
}

src/main/java/de/danielbechler/diff/comparison/EqualsIdentityStrategy.java renamed to src/main/java/de/danielbechler/diff/identity/EqualsIdentityStrategy.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package de.danielbechler.diff.comparison;
1+
package de.danielbechler.diff.identity;
22

33
import de.danielbechler.util.Objects;
44

‎src/main/java/de/danielbechler/diff/identity/IdentityConfigurer.java‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*
2+
* Copyright 2015 Daniel Bechler
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package de.danielbechler.diff.identity;
18+
19+
import de.danielbechler.diff.ObjectDifferBuilder;
20+
import de.danielbechler.diff.path.NodePath;
21+
22+
public interface IdentityConfigurer
23+
{
24+
/**
25+
* Allows to configure the way object identities are established between collection items.
26+
*/
27+
OfCollectionItems ofCollectionItems(NodePath nodePath);
28+
29+
/**
30+
* Allows to configure the way object identities are established between collection items.
31+
*/
32+
OfCollectionItems ofCollectionItems(Class<?> type, String propertyName);
33+
34+
ObjectDifferBuilder and();
35+
36+
interface OfCollectionItems
37+
{
38+
IdentityConfigurer via(IdentityStrategy identityStrategy);
39+
}
40+
}

0 commit comments

Comments
 (0)