Skip to content
This repository was archived by the owner on Oct 4, 2018. It is now read-only.

Commit 9e1d30d

Browse files
SQiShERSQiShER
committed
Fixed SQiShER#99: Allow Differs to be easily registered via ObjectDifferBuilder
1 parent d2b89ca commit 9e1d30d

File tree

5 files changed

+228
-1
lines changed

5 files changed

+228
-1
lines changed

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* Copyright 2014 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
18+
19+
import de.danielbechler.diff.differ.Differ
20+
import de.danielbechler.diff.differ.DifferDispatcher
21+
import de.danielbechler.diff.differ.DifferFactory
22+
import spock.lang.Specification
23+
24+
/**
25+
* Created by Daniel Bechler.
26+
*/
27+
@SuppressWarnings("GroovyAssignabilityCheck")
28+
class ObjectDifferBuilderIT extends Specification {
29+
def differMock = Mock(Differ)
30+
31+
def 'Register a DifferExtension'() {
32+
given:
33+
def differFactory = new DifferFactory() {
34+
@Override
35+
Differ createDiffer(DifferDispatcher differDispatcher, NodeQueryService nodeQueryService) {
36+
return differMock
37+
}
38+
}
39+
def objectDiffer = ObjectDifferBuilder.startBuilding()
40+
.differs().register(differFactory)
41+
.build()
42+
43+
when:
44+
objectDiffer.compare("foo", "bar")
45+
46+
then:
47+
1 * differMock.accepts(*_) >> true
48+
49+
and:
50+
1 * differMock.compare(*_)
51+
}
52+
}

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/*
2+
* Copyright 2014 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;
18+
19+
import de.danielbechler.diff.category.CategoryResolver;
20+
import de.danielbechler.diff.comparison.ComparisonStrategyResolver;
21+
import de.danielbechler.diff.comparison.PrimitiveDefaultValueModeResolver;
22+
import de.danielbechler.diff.filtering.IsReturnableResolver;
23+
import de.danielbechler.diff.inclusion.IsIgnoredResolver;
24+
import de.danielbechler.diff.introspection.IntrospectorResolver;
25+
import de.danielbechler.diff.introspection.IsIntrospectableResolver;
26+
27+
/**
28+
* Created by Daniel Bechler.
29+
*/
30+
public interface NodeQueryService extends
31+
CategoryResolver,
32+
IntrospectorResolver, IsIntrospectableResolver,
33+
IsIgnoredResolver,
34+
IsReturnableResolver,
35+
ComparisonStrategyResolver, PrimitiveDefaultValueModeResolver
36+
{
37+
}

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

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,13 @@
2222
import de.danielbechler.diff.circular.CircularReferenceService;
2323
import de.danielbechler.diff.comparison.ComparisonConfigurer;
2424
import de.danielbechler.diff.comparison.ComparisonService;
25+
import de.danielbechler.diff.comparison.ComparisonStrategy;
26+
import de.danielbechler.diff.comparison.PrimitiveDefaultValueMode;
2527
import de.danielbechler.diff.differ.BeanDiffer;
2628
import de.danielbechler.diff.differ.CollectionDiffer;
29+
import de.danielbechler.diff.differ.DifferConfigurer;
2730
import de.danielbechler.diff.differ.DifferDispatcher;
31+
import de.danielbechler.diff.differ.DifferFactory;
2832
import de.danielbechler.diff.differ.DifferProvider;
2933
import de.danielbechler.diff.differ.MapDiffer;
3034
import de.danielbechler.diff.differ.PrimitiveDiffer;
@@ -34,6 +38,12 @@
3438
import de.danielbechler.diff.inclusion.InclusionService;
3539
import de.danielbechler.diff.introspection.IntrospectionConfigurer;
3640
import de.danielbechler.diff.introspection.IntrospectionService;
41+
import de.danielbechler.diff.introspection.Introspector;
42+
import de.danielbechler.diff.node.DiffNode;
43+
44+
import java.util.ArrayList;
45+
import java.util.Collection;
46+
import java.util.Set;
3747

3848
/**
3949
* This is the entry point of every diffing operation. It acts as a factory to get hold of an actual {@link
@@ -50,6 +60,9 @@ public class ObjectDifferBuilder
5060
private final ComparisonService comparisonService = new ComparisonService(this);
5161
private final ReturnableNodeService returnableNodeService = new ReturnableNodeService(this);
5262
private final CircularReferenceService circularReferenceService = new CircularReferenceService(this);
63+
private final DifferConfigurer differConfigurer = new DifferConfigurerImpl();
64+
private final NodeQueryService nodeQueryService = new NodeQueryServiceImpl();
65+
private final Collection<DifferFactory> differFactories = new ArrayList<DifferFactory>();
5366

5467
private ObjectDifferBuilder()
5568
{
@@ -63,11 +76,20 @@ public static ObjectDiffer buildDefault()
6376
public ObjectDiffer build()
6477
{
6578
final DifferProvider differProvider = new DifferProvider();
66-
final DifferDispatcher differDispatcher = new DifferDispatcher(differProvider, circularReferenceService, circularReferenceService, inclusionService, returnableNodeService);
79+
final DifferDispatcher differDispatcher = new DifferDispatcher(
80+
differProvider,
81+
circularReferenceService,
82+
circularReferenceService,
83+
inclusionService,
84+
returnableNodeService);
6785
differProvider.push(new BeanDiffer(differDispatcher, introspectionService, returnableNodeService, comparisonService, introspectionService));
6886
differProvider.push(new CollectionDiffer(differDispatcher, comparisonService));
6987
differProvider.push(new MapDiffer(differDispatcher, comparisonService));
7088
differProvider.push(new PrimitiveDiffer(comparisonService));
89+
for (final DifferFactory differFactory : differFactories)
90+
{
91+
differProvider.push(differFactory.createDiffer(differDispatcher, nodeQueryService));
92+
}
7193
return new ObjectDiffer(differDispatcher);
7294
}
7395

@@ -125,4 +147,57 @@ public CategoryConfigurer categories()
125147
{
126148
return categoryService;
127149
}
150+
151+
public DifferConfigurer differs()
152+
{
153+
return differConfigurer;
154+
}
155+
156+
public class DifferConfigurerImpl implements DifferConfigurer
157+
{
158+
public ObjectDifferBuilder register(final DifferFactory differFactory)
159+
{
160+
differFactories.add(differFactory);
161+
return ObjectDifferBuilder.this;
162+
}
163+
164+
}
165+
166+
private class NodeQueryServiceImpl implements NodeQueryService
167+
{
168+
public Set<String> resolveCategories(final DiffNode node)
169+
{
170+
return categoryService.resolveCategories(node);
171+
}
172+
173+
public Introspector introspectorForNode(final DiffNode node)
174+
{
175+
return introspectionService.introspectorForNode(node);
176+
}
177+
178+
public boolean isIntrospectable(final DiffNode node)
179+
{
180+
return introspectionService.isIntrospectable(node);
181+
}
182+
183+
public boolean isIgnored(final DiffNode node)
184+
{
185+
return inclusionService.isIgnored(node);
186+
}
187+
188+
public boolean isReturnable(final DiffNode node)
189+
{
190+
return returnableNodeService.isReturnable(node);
191+
}
192+
193+
public ComparisonStrategy resolveComparisonStrategy(final DiffNode node)
194+
{
195+
return comparisonService.resolveComparisonStrategy(node);
196+
}
197+
198+
public PrimitiveDefaultValueMode resolvePrimitiveDefaultValueMode(final DiffNode node)
199+
{
200+
return comparisonService.resolvePrimitiveDefaultValueMode(node);
201+
}
202+
}
128203
}

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/*
2+
* Copyright 2014 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.differ;
18+
19+
import de.danielbechler.diff.ObjectDifferBuilder;
20+
21+
/**
22+
* Created by Daniel Bechler.
23+
*/
24+
public interface DifferConfigurer
25+
{
26+
/**
27+
* Registers a new Differ to be used when comparing objects. Differs that have been registered later always win
28+
* over earlier Differs. This way it is easily possible to override the default behavior, without actually removing
29+
* the standard differs.
30+
*
31+
* @param differFactory Factory that creates a new Differ. Will be called exactly once and the resulting Differ
32+
* will be pushed to the underlying {@link de.danielbechler.diff.differ.DifferProvider}.
33+
* @return The {@link de.danielbechler.diff.ObjectDifferBuilder} for chaining.
34+
*/
35+
ObjectDifferBuilder register(DifferFactory differFactory);
36+
}

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/*
2+
* Copyright 2014 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.differ;
18+
19+
import de.danielbechler.diff.NodeQueryService;
20+
21+
/**
22+
* Created by Daniel Bechler.
23+
*/
24+
public interface DifferFactory
25+
{
26+
Differ createDiffer(DifferDispatcher differDispatcher, NodeQueryService nodeQueryService);
27+
}

0 commit comments

Comments
 (0)