From 86eb37dd8bdd7ee645b9f86ba41689fcebc1f78e Mon Sep 17 00:00:00 2001 From: Rob Moore Date: Sun, 19 Apr 2015 22:26:36 +0800 Subject: [PATCH] Updated breaking changes for the rename to Dossier --- BREAKING_CHANGES.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index 25c149a..832cee6 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -1,8 +1,21 @@ -NTestDataBuilder Breaking Changes -================================= +Breaking Changes +================ -Version 2.0.0 -------------- +Breaking change from NTestDataBuilder -> TestStack.Dossier 1.0 +-------------------------------------------------------------- + +Namespace has changed from NTestDataBuilder to TestStack.Dossier. + +### Reason + +The project has been renamed. + +### Fix + +Do a global find and replace of `using NTestDataBuilder` with `using TestStack.Dossier`. + +Breaking change from NTestDataBuilder -> TestStack.Dossier 1.0 +-------------------------------------------------------------- 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. @@ -16,8 +29,8 @@ The old behaviour of throwing an exception if a value hasn't been specified is n 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. -Version 2.0.0 -------------- +Breaking change from NTestDataBuilder -> TestStack.Dossier 1.0 +-------------------------------------------------------------- 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. @@ -47,10 +60,10 @@ You also no longer need a custom extension method for the `BuildList` method so 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: ``` -using NTestDataBuilder.Lists; +using TestStack.Dossier.Lists; ``` -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;`. +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;`. If you uninstall the NBuilder package then you will need to remove the using statements for that library too.