Skip to content

Commit 86eb37d

Browse files
committed
Updated breaking changes for the rename to Dossier
1 parent b2ce172 commit 86eb37d

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

BREAKING_CHANGES.md

+21-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
1-
NTestDataBuilder Breaking Changes
2-
=================================
1+
Breaking Changes
2+
================
33

4-
Version 2.0.0
5-
-------------
4+
Breaking change from NTestDataBuilder -> TestStack.Dossier 1.0
5+
--------------------------------------------------------------
6+
7+
Namespace has changed from NTestDataBuilder to TestStack.Dossier.
8+
9+
### Reason
10+
11+
The project has been renamed.
12+
13+
### Fix
14+
15+
Do a global find and replace of `using NTestDataBuilder` with `using TestStack.Dossier`.
16+
17+
Breaking change from NTestDataBuilder -> TestStack.Dossier 1.0
18+
--------------------------------------------------------------
619

720
When you don't `Set` a default value for a property that you later `Get` in your builder it will now generate an anonymous value for that property rather than throwing an exception.
821

@@ -16,8 +29,8 @@ The old behaviour of throwing an exception if a value hasn't been specified is n
1629

1730
If you want to fix a static value for a property then by all means you can still use `Set` calls in your builder constructor. If you aren't happy with the default anonymous value that is generated for a property you can use the `Any` property to generate a value from a different equivalence class in combination with a `Set` call in your builder constructor.
1831

19-
Version 2.0.0
20-
-------------
32+
Breaking change from NTestDataBuilder -> TestStack.Dossier 1.0
33+
--------------------------------------------------------------
2134

2235
The way that lists are generated no longer uses NBuilder - the new syntax is backwards compatible with NBuilder except that the namespace you need to include is different. You can also refactor your list generation to be a lot more terse, but that is optional. Any `BuildList` extension methods you created will now need to be deleted since they are no longer needed. You also need to ensure that all of the methods you call are marked virtual so the list generation can proxy those method calls.
2336

@@ -47,10 +60,10 @@ You also no longer need a custom extension method for the `BuildList` method so
4760
Simply add the following to the files that generate lists of builders and change your builder modification methods to be virtual and the existing syntax should work:
4861

4962
```
50-
using NTestDataBuilder.Lists;
63+
using TestStack.Dossier.Lists;
5164
```
5265

53-
Assuming you aren't using NBuilder for anything other than generating lists of entities with NTestDataBuilder 1.0 you should be abke to do a global find and replace against `using FizzWare.NBuilder;`.
66+
Assuming you aren't using NBuilder for anything other than generating lists of entities with NTestDataBuilder 1.0 you should be able to do a global find and replace against `using FizzWare.NBuilder;`.
5467

5568
If you uninstall the NBuilder package then you will need to remove the using statements for that library too.
5669

0 commit comments

Comments
 (0)