Skip to content

Commit 0c01755

Browse files
SQiShERSQiShER
committed
Restructured DiffNode constructors
1 parent f42e7a0 commit 0c01755

File tree

9 files changed

+52
-77
lines changed

9 files changed

+52
-77
lines changed

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

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,11 @@ public static DiffNode newRootNode()
7070
return new DiffNode();
7171
}
7272

73-
/**
74-
* @deprecated Only used in tests. Doesn't really make sense in the real world, as no parent node implies the
75-
* RootAccessor
76-
*/
77-
@Deprecated
78-
DiffNode(final Accessor accessor, final Class<?> valueType)
73+
public static DiffNode newRootNodeWithType(final Class<?> valueType)
7974
{
80-
this(ROOT, accessor, valueType);
75+
final DiffNode rootNode = newRootNode();
76+
rootNode.setType(valueType);
77+
return rootNode;
8178
}
8279

8380
public DiffNode(final DiffNode parentNode, final Accessor accessor, final Class<?> valueType)
@@ -93,23 +90,10 @@ public DiffNode(final DiffNode parentNode, final Accessor accessor)
9390
this(parentNode, accessor, null);
9491
}
9592

96-
public DiffNode(final Accessor accessor)
97-
{
98-
this(null, accessor, null);
99-
}
100-
101-
/**
102-
* @deprecated Only used in tests
103-
*/
104-
@Deprecated
105-
public DiffNode(final Class<?> valueType)
106-
{
107-
this(ROOT, RootAccessor.getInstance(), valueType);
108-
}
109-
11093
private DiffNode()
11194
{
112-
this(ROOT, RootAccessor.getInstance(), null);
95+
this.parentNode = ROOT;
96+
this.accessor = RootAccessor.getInstance();
11397
}
11498

11599
/**
@@ -242,12 +226,12 @@ public Class<?> getValueType()
242226
}
243227

244228
/**
245-
* Allows for explicit type definition. However, if the accessor is TypeAware, {@link #getValueType()} will
246-
* always return the type returned by the accessor.
229+
* Allows to explicity set the type of this node. This will overshadow the type returned by {@linkplain
230+
* #getValueTypeInfo()} as well as the one returned by the accessor.
247231
*
248232
* @param aClass The type of the value represented by this node.
249233
*/
250-
public void setType(final Class<?> aClass)
234+
public final void setType(final Class<?> aClass)
251235
{
252236
this.valueType = aClass;
253237
}

‎src/test/java/de/danielbechler/diff/category/CategoryServiceSpec.groovy‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,11 @@
1515
*/
1616

1717
package de.danielbechler.diff.category
18-
1918
import de.danielbechler.diff.access.PropertyAwareAccessor
20-
import de.danielbechler.diff.access.RootAccessor
2119
import de.danielbechler.diff.node.DiffNode
2220
import de.danielbechler.diff.path.NodePath
2321
import de.danielbechler.diff.selector.BeanPropertyElementSelector
2422
import spock.lang.Specification
25-
2623
/**
2724
* @author Daniel Bechler
2825
*/
@@ -36,7 +33,7 @@ class CategoryServiceSpec extends Specification {
3633

3734
def "setup"() {
3835
accessor.elementSelector >> new BeanPropertyElementSelector("foo")
39-
rootNode = new DiffNode(DiffNode.ROOT, RootAccessor.instance, null)
36+
rootNode = DiffNode.newRootNode()
4037
node = new DiffNode(rootNode, accessor, nodeType)
4138
}
4239

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ class DifferDispatcherTest extends Specification {
7575
access(_ as Accessor) >> accessedInstances
7676
getSourceAccessor() >> accessor
7777
}
78-
def node = new DiffNode(RootAccessor.instance, Object)
78+
def node = DiffNode.newRootNode()
7979

8080
when:
8181
differDispatcher.dispatch(node, instances, accessor)

‎src/test/java/de/danielbechler/diff/helper/NodeAssertionsTest.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public class NodeAssertionsTest
3636
@Test
3737
public void testAssertThat_node_does_exist_succeeds_when_node_exists() throws Exception
3838
{
39-
final DiffNode node = new DiffNode(String.class);
39+
final DiffNode node = DiffNode.newRootNodeWithType(String.class);
4040
assertThat(node).root().doesExist();
4141
}
4242

@@ -55,14 +55,14 @@ public void testAssertThat_node_does_not_exist_succeeds_when_node_doesnt_exist()
5555
@Test(expectedExceptions = AssertionError.class)
5656
public void testAssertThat_node_does_not_exist_fails_when_node_exist() throws Exception
5757
{
58-
final DiffNode node = new DiffNode(String.class);
58+
final DiffNode node = DiffNode.newRootNodeWithType(String.class);
5959
assertThat(node).root().doesNotExist();
6060
}
6161

6262
@Test
6363
public void testAssertThat_node_has_children_succeeds_when_children_are_present() throws Exception
6464
{
65-
final DiffNode root = new DiffNode(String.class);
65+
final DiffNode root = DiffNode.newRootNodeWithType(String.class);
6666
final DiffNode child = new DiffNode(root, mock(Accessor.class), String.class);
6767
root.addChild(child);
6868
assertThat(root).root().hasChildren();
@@ -71,7 +71,7 @@ public void testAssertThat_node_has_children_succeeds_when_children_are_present(
7171
@Test(expectedExceptions = AssertionError.class)
7272
public void testAssertThat_node_has_children_fails_when_no_children_are_present() throws Exception
7373
{
74-
final DiffNode node = new DiffNode(String.class);
74+
final DiffNode node = DiffNode.newRootNodeWithType(String.class);
7575
assertThat(node).root().hasChildren();
7676
}
7777

@@ -80,7 +80,7 @@ public void testAssertThat_child_at_property_names_does_exist_succeeds_when_chil
8080
{
8181
final Accessor accessor = mock(Accessor.class);
8282
when(accessor.getElementSelector()).thenReturn(new BeanPropertyElementSelector("value"));
83-
final DiffNode node = new DiffNode(ObjectWithString.class);
83+
final DiffNode node = DiffNode.newRootNodeWithType(ObjectWithString.class);
8484
final DiffNode child = new DiffNode(node, accessor, String.class);
8585
node.addChild(child);
8686
assertThat(node).child("value").doesExist();
@@ -125,14 +125,14 @@ public void testAssertThat_child_at_property_path_builder_does_exist_fails_when_
125125
@Test
126126
public void testAssertThat_node_has_no_children_succeeds_when_node_has_no_children()
127127
{
128-
final DiffNode node = new DiffNode(String.class);
128+
final DiffNode node = DiffNode.newRootNodeWithType(String.class);
129129
assertThat(node).root().hasNoChildren();
130130
}
131131

132132
@Test(expectedExceptions = AssertionError.class)
133133
public void testAssertThat_node_has_no_children_fails_when_node_has_children()
134134
{
135-
final DiffNode root = new DiffNode(String.class);
135+
final DiffNode root = DiffNode.newRootNodeWithType(String.class);
136136
final DiffNode child = new DiffNode(root, mock(Accessor.class), String.class);
137137
root.addChild(child);
138138
assertThat(root).root().hasNoChildren();
@@ -141,22 +141,22 @@ public void testAssertThat_node_has_no_children_fails_when_node_has_children()
141141
@Test(expectedExceptions = IllegalArgumentException.class)
142142
public void testAssertThat_node_has_children_with_negative_count_throws_IllegalArgumentException()
143143
{
144-
final DiffNode node = new DiffNode(String.class);
144+
final DiffNode node = DiffNode.newRootNodeWithType(String.class);
145145
assertThat(node).root().hasChildren(-1);
146146
}
147147

148148
@Test
149149
public void testAssertThat_node_has_changed_state_succeeds_when_node_has_changed()
150150
{
151-
final DiffNode node = new DiffNode(String.class);
151+
final DiffNode node = DiffNode.newRootNodeWithType(String.class);
152152
node.setState(DiffNode.State.CHANGED);
153153
assertThat(node).root().hasState(DiffNode.State.CHANGED);
154154
}
155155

156156
@Test(expectedExceptions = AssertionError.class)
157157
public void testAssertThat_node_has_changed_state_fails_when_node_has_different_state()
158158
{
159-
final DiffNode node = new DiffNode(String.class);
159+
final DiffNode node = DiffNode.newRootNodeWithType(String.class);
160160
node.setState(DiffNode.State.UNTOUCHED);
161161
assertThat(node).root().hasState(DiffNode.State.CHANGED);
162162
}

‎src/test/java/de/danielbechler/diff/inclusion/TypePropertyConfigInclusionResolverTest.groovy‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,23 @@ class TypePropertyConfigInclusionResolverTest extends Specification {
3232

3333
def 'should return DEFAULT when node is not property aware'() {
3434
given:
35-
def node = new DiffNode(Stub(Accessor), null)
35+
def node = new DiffNode(null, Stub(Accessor), null)
3636
expect:
3737
inclusionResolver.getInclusion(node) == DEFAULT
3838
}
3939

4040
def 'should return DEFAULT when node has no parent'() {
4141
given:
4242
def propertyAwareAccessor = Stub(PropertyAwareAccessor)
43-
def node = new DiffNode(propertyAwareAccessor, null)
43+
def node = new DiffNode(null, propertyAwareAccessor, null)
4444
expect:
4545
inclusionResolver.getInclusion(node) == DEFAULT
4646
}
4747

4848
def 'should return DEFAULT when parent node has no type'() {
4949
given:
50-
def propertyAwareAccessor = Stub(PropertyAwareAccessor)
51-
def parentNode = new DiffNode(null)
52-
def node = new DiffNode(parentNode, propertyAwareAccessor, null)
50+
def parentNode = DiffNode.newRootNode()
51+
def node = new DiffNode(parentNode, Stub(PropertyAwareAccessor), null)
5352
expect:
5453
inclusionResolver.getInclusion(node) == DEFAULT
5554
}
@@ -113,7 +112,7 @@ class TypePropertyConfigInclusionResolverTest extends Specification {
113112
}
114113

115114
DiffNode createPropertyNode(Class<?> parentType, String propertyName) {
116-
def parentNode = new DiffNode(parentType)
115+
def parentNode = DiffNode.newRootNodeWithType(parentType)
117116
def accessor = Stub(PropertyAwareAccessor, { getPropertyName() >> propertyName })
118117
return new DiffNode(parentNode, accessor, null)
119118
}

‎src/test/java/de/danielbechler/diff/introspection/IntrospectionServiceTest.groovy‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,17 @@
1515
*/
1616

1717
package de.danielbechler.diff.introspection
18-
1918
import de.danielbechler.diff.ObjectDifferBuilder
20-
import de.danielbechler.diff.access.RootAccessor
2119
import de.danielbechler.diff.access.TypeAwareAccessor
2220
import de.danielbechler.diff.circular.CircularReferenceMatchingMode
2321
import de.danielbechler.diff.inclusion.Inclusion
22+
import de.danielbechler.diff.instantiation.TypeInfo
2423
import de.danielbechler.diff.mock.ObjectWithString
2524
import de.danielbechler.diff.node.DiffNode
2625
import de.danielbechler.diff.path.NodePath
2726
import spock.lang.Shared
2827
import spock.lang.Specification
2928
import spock.lang.Unroll
30-
3129
/**
3230
* @author Daniel Bechler
3331
*/
@@ -40,7 +38,7 @@ class IntrospectionServiceTest extends Specification {
4038

4139
def objectDifferBuilder = Mock(ObjectDifferBuilder)
4240
def introspectionService = new IntrospectionService(objectDifferBuilder)
43-
def rootNode = new DiffNode(DiffNode.ROOT, RootAccessor.instance, ObjectWithString)
41+
def rootNode = DiffNode.newRootNodeWithType(ObjectWithString)
4442
def childNode
4543
def childAccessor = Mock(TypeAwareAccessor)
4644
def defaultIntrospector = Mock(Introspector)
@@ -65,7 +63,7 @@ class IntrospectionServiceTest extends Specification {
6563

6664
def 'introspection should always be disabled for Arrays'() {
6765
given:
68-
rootNode = new DiffNode(DiffNode.ROOT, RootAccessor.instance, type);
66+
rootNode = DiffNode.newRootNodeWithType(type)
6967
introspectionService.ofType(type).toBeEnabled()
7068

7169
expect:
@@ -78,7 +76,7 @@ class IntrospectionServiceTest extends Specification {
7876

7977
def 'introspection should always be disabled for Enums'() {
8078
given:
81-
rootNode = new DiffNode(DiffNode.ROOT, RootAccessor.instance, type);
79+
rootNode = DiffNode.newRootNodeWithType(type)
8280
introspectionService.ofType(type).toBeEnabled()
8381

8482
expect:
@@ -90,7 +88,7 @@ class IntrospectionServiceTest extends Specification {
9088

9189
def 'introspection should always be disabled for nodes with unknown type (null)'() {
9290
given:
93-
rootNode = new DiffNode(DiffNode.ROOT, RootAccessor.instance, null);
91+
rootNode = DiffNode.newRootNode()
9492
introspectionService.ofType(null).toBeEnabled()
9593
9694
expect:
@@ -177,7 +175,8 @@ class IntrospectionServiceTest extends Specification {
177175
given:
178176
def typeIntrospector = Mock(Introspector)
179177
introspectionService.ofType(String).toUse(typeIntrospector)
180-
rootNode = new DiffNode(String)
178+
rootNode = DiffNode.newRootNode()
179+
rootNode.setValueTypeInfo(new TypeInfo(String))
181180
182181
expect:
183182
introspectionService.introspectorForNode(rootNode) == typeIntrospector

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

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,8 @@ class DiffNodeTest extends Specification {
118118

119119
def 'addChild: fails with exception when attempting to add node that is already child of another node'() {
120120
given:
121-
def childNode = new DiffNode(Stub(Accessor), Object)
122-
when:
123-
DiffNode.newRootNode().addChild(childNode)
124-
then:
125-
notThrown IllegalArgumentException
126-
when: 'adding the child node again, but to another node'
121+
def childNode = new DiffNode(DiffNode.newRootNode(), Stub(Accessor), Object)
122+
when: 'adding the child to another node'
127123
DiffNode.newRootNode().addChild(childNode)
128124
then:
129125
thrown IllegalArgumentException
@@ -145,7 +141,7 @@ class DiffNodeTest extends Specification {
145141
def childAccessor = Stub Accessor, {
146142
getElementSelector() >> new BeanPropertyElementSelector('foo')
147143
}
148-
def child = new DiffNode(childAccessor, String)
144+
def child = new DiffNode(null, childAccessor, String)
149145
when:
150146
parent.addChild(child)
151147
then: 'child has been added to parent'
@@ -176,15 +172,15 @@ class DiffNodeTest extends Specification {
176172
PropertyAwareAccessor accessor = Stub(PropertyAwareAccessor) {
177173
getReadMethodAnnotations() >> [annotation]
178174
}
179-
def node = new DiffNode(accessor, Object)
175+
def node = new DiffNode(null, accessor, Object)
180176
expect:
181177
node.propertyAnnotations.size() == 1
182178
node.propertyAnnotations.contains(annotation)
183179
}
184180

185181
def 'getPropertyAnnotations: returns empty set if accessor is not property aware'() {
186182
given:
187-
def node = new DiffNode(Stub(Accessor), Object)
183+
def node = new DiffNode(null, Stub(Accessor), Object)
188184
expect:
189185
node.propertyAnnotations.isEmpty()
190186
}
@@ -194,7 +190,7 @@ class DiffNodeTest extends Specification {
194190
ObjectDiffTest annotation = Mock(ObjectDiffTest)
195191
PropertyAwareAccessor accessor = Mock(PropertyAwareAccessor)
196192
when:
197-
def node = new DiffNode(accessor)
193+
def node = new DiffNode(DiffNode.newRootNode(), accessor)
198194
node.getPropertyAnnotation(ObjectDiffTest) == annotation
199195
then:
200196
1 * accessor.getReadMethodAnnotation(ObjectDiffTest) >> annotation
@@ -204,14 +200,14 @@ class DiffNodeTest extends Specification {
204200
given:
205201
def accessor = Mock(Accessor)
206202
expect:
207-
def node = new DiffNode(accessor, Object)
203+
def node = new DiffNode(null, accessor, Object)
208204
node.getPropertyAnnotation(ObjectDiffTest) == null
209205
}
210206

211207
def 'getPropertyName: returns name from PropertyAwareAccessor'() {
212208
given:
213209
def expectedPropertyName = 'foo';
214-
def nodeWithPropertyName = new DiffNode(Stub(PropertyAwareAccessor, {
210+
def nodeWithPropertyName = new DiffNode(null, Stub(PropertyAwareAccessor, {
215211
getPropertyName() >> expectedPropertyName
216212
}), Object)
217213
expect:
@@ -221,7 +217,7 @@ class DiffNodeTest extends Specification {
221217
def 'getPropertyName: returns name of parent node if it doesn\'t have one itself'() {
222218
given:
223219
def expectedPropertyName = 'foo'
224-
def parentNodeWithPropertyName = new DiffNode(Stub(PropertyAwareAccessor, {
220+
def parentNodeWithPropertyName = new DiffNode(null, Stub(PropertyAwareAccessor, {
225221
getPropertyName() >> expectedPropertyName
226222
}), Object)
227223
and:
@@ -232,14 +228,14 @@ class DiffNodeTest extends Specification {
232228

233229
def 'getPropertyName: returns null when property name can not be resolved from accessor'() {
234230
expect:
235-
def node = new DiffNode(Mock(Accessor), Object)
231+
def node = new DiffNode(null, Mock(Accessor), Object)
236232
node.propertyName == null
237233
}
238234

239235
@Unroll
240236
def 'isPropertyAware: returns #expectedResult when acessor #doesOrDoesNotImplement PropertyAwareAccessor interface'() {
241237
given:
242-
def node = new DiffNode(Stub(accessorType), Object)
238+
def node = new DiffNode(null, Stub(accessorType), Object)
243239
expect:
244240
node.isPropertyAware() == expectedResult
245241
where:

‎src/test/java/de/danielbechler/diff/node/PrintingVisitorTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class PrintingVisitorTest
3030
@Test
3131
public void prints_root_node_if_unchanged_and_without_children()
3232
{
33-
final DiffNode rootNode = new DiffNode(String.class);
33+
final DiffNode rootNode = DiffNode.newRootNodeWithType(String.class);
3434
final TestablePrintingVisitor visitor = new TestablePrintingVisitor("foo", "foo");
3535
rootNode.visit(visitor);
3636
final String output = visitor.getOutput();

0 commit comments

Comments
 (0)