Skip to content

Commit 799b336

Browse files
committed
Added additional API items to breaking changes doc
1 parent b824b73 commit 799b336

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed

BREAKING_CHANGES.md

+25
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,31 @@
11
Breaking Changes
22
================
33

4+
Version 3.3
5+
-----------
6+
The classes inheriting from `FileDictionarySource` have been marked as obsolete and will be removed in version 4. Instead you should use the new `Words` class, passing in the name of a file dictionary (either one of the built-in ones or one that you create). All the built-in ones are listed in the FromDictionary class where the constants match the filename embedded into Dossier. So, for example, instead of using the `GeoCountrySource` class you would instead use `Words(FromDictionary.GeoCountry)`.
7+
8+
All of the file dictionaries have been added to the AnonymousValueFixture class as equivalence class extension methods. So, for example, in your builder class you can now call:
9+
10+
```c#
11+
Any.InternetURL();
12+
Any.LoremIpsum();
13+
Any.ColourName();
14+
```
15+
16+
Picking functionality has been added which allows you to select items from a list according to different strategies. Currently, two strategies have been added, `RandomItemFrom` and `RepeatingSequenceFrom`:
17+
18+
```c#
19+
var names = new Words(FromDictionary.PersonNameFirst).Data;
20+
var days = new List<string> {"Monday", "Tuesday", "Wednesday", "Thursday", "Friday"};
21+
var customers = Builder<Customer>
22+
.CreateListOfSize(15)
23+
.All()
24+
.Set(x => x.Name, Pick.RandomItemFrom(names).Next)
25+
.Set(x => x.Day, Pick.RepeatingSequenceFrom(days).Next)
26+
.BuildList();
27+
```
28+
429
Version 3.0
530
-----------
631

TestStack.Dossier/TestStack.Dossier.csproj

+1-3
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,7 @@
198198
<EmbeddedResource Include="DataSources\Dictionaries\Resources\PersonUsername.txt" />
199199
<EmbeddedResource Include="DataSources\Dictionaries\Resources\ShirtSize.txt" />
200200
</ItemGroup>
201-
<ItemGroup>
202-
<Folder Include="Picking\" />
203-
</ItemGroup>
201+
<ItemGroup />
204202
<ItemGroup />
205203
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
206204
<!-- To modify your build process, add your task inside one of the targets below and uncomment it.

0 commit comments

Comments
 (0)