Skip to content

Commit 67a312d

Browse files
bchavezbchavez
committed
Examples to extend Bogus.
1 parent 21e7412 commit 67a312d

8 files changed

+173
-0
lines changed

‎Examples/Examples.sln

+14
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EFCoreSeedDb", "EFCoreSeedD
77
EndProject
88
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GettingStarted", "GettingStarted\GettingStarted.csproj", "{4B10A48D-F572-4984-8C61-8598E792436A}"
99
EndProject
10+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExtendingBogus", "ExtendingBogus\ExtendingBogus.csproj", "{44E22B4C-4280-4329-9A7E-3DEC7D487595}"
11+
EndProject
1012
Global
1113
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1214
Debug|Any CPU = Debug|Any CPU
@@ -41,6 +43,18 @@ Global
4143
{4B10A48D-F572-4984-8C61-8598E792436A}.Release|x64.Build.0 = Release|Any CPU
4244
{4B10A48D-F572-4984-8C61-8598E792436A}.Release|x86.ActiveCfg = Release|Any CPU
4345
{4B10A48D-F572-4984-8C61-8598E792436A}.Release|x86.Build.0 = Release|Any CPU
46+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
47+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Debug|Any CPU.Build.0 = Debug|Any CPU
48+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Debug|x64.ActiveCfg = Debug|Any CPU
49+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Debug|x64.Build.0 = Debug|Any CPU
50+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Debug|x86.ActiveCfg = Debug|Any CPU
51+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Debug|x86.Build.0 = Debug|Any CPU
52+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Release|Any CPU.ActiveCfg = Release|Any CPU
53+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Release|Any CPU.Build.0 = Release|Any CPU
54+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Release|x64.ActiveCfg = Release|Any CPU
55+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Release|x64.Build.0 = Release|Any CPU
56+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Release|x86.ActiveCfg = Release|Any CPU
57+
{44E22B4C-4280-4329-9A7E-3DEC7D487595}.Release|x86.Build.0 = Release|Any CPU
4458
EndGlobalSection
4559
GlobalSection(SolutionProperties) = preSolution
4660
HideSolutionNode = FALSE

‎Examples/ExtendingBogus/ExtendingBogus.csproj

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<OutputType>Exe</OutputType>
5+
<TargetFramework>netcoreapp3.1</TargetFramework>
6+
</PropertyGroup>
7+
8+
<ItemGroup>
9+
<PackageReference Include="Bogus" Version="33.0.2" />
10+
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
11+
</ItemGroup>
12+
13+
</Project>

‎Examples/ExtendingBogus/ExtensionsForAddress.cs

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
namespace ExtendingBogus
2+
{
3+
/// <summary>
4+
/// Augment the existing <seealso cref="Bogus.DataSets.Address"/> DataSet via C# extension method.
5+
/// </summary>
6+
public static class ExtensionsForAddress
7+
{
8+
private static readonly string[] CanadaDowntownTorontoPostalCodes =
9+
{
10+
"M5S", "M5B", "M5X", "M5V", "M4W", "M4X", "M4Y",
11+
"M5A", "M5C", "M5T", "M5E", "M5G", "M5H", "M5J",
12+
"M5K", "M5L", "M6G"
13+
};
14+
15+
public static string DowntownTorontoPostalCode(this Bogus.DataSets.Address address)
16+
{
17+
return address.Random.ArrayElement(CanadaDowntownTorontoPostalCodes);
18+
}
19+
}
20+
}

‎Examples/ExtendingBogus/ExtensionsForTesting.cs

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
using System;
2+
using Newtonsoft.Json;
3+
4+
namespace ExtendingBogus
5+
{
6+
public static class ExtensionsForTesting
7+
{
8+
public static void Dump(this object obj)
9+
{
10+
Console.WriteLine(obj.DumpString());
11+
}
12+
13+
public static string DumpString(this object obj)
14+
{
15+
return JsonConvert.SerializeObject(obj, Formatting.Indented);
16+
}
17+
}
18+
}

‎Examples/ExtendingBogus/FoodDataSet.cs

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
using Bogus;
2+
using Bogus.Premium;
3+
4+
namespace ExtendingBogus
5+
{
6+
/// <summary>
7+
/// The following shows how to create a dedicated DataSet accessible via C# extension method.
8+
/// </summary>
9+
public static class ExtensionsForFood
10+
{
11+
public static Food Food(this Faker faker)
12+
{
13+
return ContextHelper.GetOrSet(faker, () => new Food());
14+
}
15+
}
16+
17+
/// <summary>
18+
/// This DatSet can be created manually using `new Candy()`, or by fluent extension method via <seealso cref="ExtensionsForFood"/>.
19+
/// </summary>
20+
public class Food : DataSet
21+
{
22+
private static readonly string[] Candies =
23+
{
24+
"Hard candy", "Taffy", "Chocolate bar", "Stick candy",
25+
"Jelly bean", "Mint", "Cotton candy", "Lollipop"
26+
};
27+
28+
/// <summary>
29+
/// Returns some type of candy.
30+
/// </summary>
31+
public string Candy()
32+
{
33+
return this.Random.ArrayElement(Candies);
34+
}
35+
36+
private static readonly string[] Drinks = { "Soda", "Water", "Beer", "Wine", "Coffee", "Lemonade", "Milk" };
37+
public string Drink()
38+
{
39+
return this.Random.ArrayElement(Drinks);
40+
}
41+
}
42+
43+
}

‎Examples/ExtendingBogus/Program.cs

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
using Bogus;
2+
3+
namespace ExtendingBogus
4+
{
5+
class Program
6+
{
7+
static void Main(string[] args)
8+
{
9+
var userFaker = new Faker<User>()
10+
//Extend Bogus with a 'new' Food data set; see FoodDataSet.cs
11+
.RuleFor(p => p.FaveCandy, f => f.Food().Candy())
12+
.RuleFor(p => p.FaveDrink, f => f.Food().Drink())
13+
//Extend the existing Address data set with a custom C# extension method; see ExtensionsForAddress.cs
14+
.RuleFor(p => p.PostCode, f => f.Address.DowntownTorontoPostalCode());
15+
16+
var user = userFaker.Generate();
17+
user.Dump();
18+
}
19+
}
20+
21+
public class User
22+
{
23+
public string FaveDrink;
24+
public string FaveCandy;
25+
public string PostCode;
26+
}
27+
}

‎Examples/ExtendingBogus/README.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
[1]:https://github.com/bchavez/Bogus#the-great-c-example
2+
3+
## Getting Started with Bogus
4+
5+
#### Requirements
6+
* **.NET Core 3.1** or later
7+
8+
#### Description
9+
10+
The `ExtendingBogus` example shows how to extend **Bogus**' APIs in the following ways:
11+
12+
1. Using a custom C# extension method; see `ExtensionsForAddress.cs`.
13+
14+
Augmenting **Bogus**' APIs via C# extension is useful to make APIs cleaner and more suitable for your specific situation.
15+
16+
1. Using a custom data set; see `FoodDataSet.cs`.
17+
18+
Creating a custom data set is useful when categorizing many 'related' APIs together.
19+
20+
To run the example, perform the following commands *inside* this `ExtendingBogus` folder:
21+
22+
* `dotnet restore`
23+
* `dotnet build`
24+
* `dotnet run`
25+
26+
After the `dotnet` commands are successfully executed above, you should see some extended *custom* fake data printed to the console!
27+
28+
```
29+
> dotnet run
30+
```
31+
```json
32+
{
33+
"FaveDrink": "Soda",
34+
"FaveCandy": "Jelly bean",
35+
"PostCode": "M4W"
36+
}
37+
```

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ User Created! Id=0
155155
|:---------:| ----------- |
156156
| **C#** | [**Full working example of 'The Great C# Example'**](https://github.com/bchavez/Bogus/tree/master/Examples/GettingStarted) |
157157
| **C#** | [**Using Bogus and EF Core to a seed database**](https://github.com/bchavez/Bogus/tree/master/Examples/EFCoreSeedDb) |
158+
| **C#** | [**Extending Bogus with custom APIs and data**](https://github.com/bchavez/Bogus/tree/master/Examples/ExtendingBogus) |
158159
| **F#** | [**Using Bogus with F#**](#the-fabulous-f-examples) |
159160
| **VB.NET** | [**Using Bogus with VB.NET**](#the-very-basic-vbnet-example) |
160161

0 commit comments

Comments
 (0)