RimuTec.Faker 0.11.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package RimuTec.Faker --version 0.11.0
NuGet\Install-Package RimuTec.Faker -Version 0.11.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RimuTec.Faker" Version="0.11.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add RimuTec.Faker --version 0.11.0
#r "nuget: RimuTec.Faker, 0.11.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install RimuTec.Faker as a Cake Addin
#addin nuget:?package=RimuTec.Faker&version=0.11.0

// Install RimuTec.Faker as a Cake Tool
#tool nuget:?package=RimuTec.Faker&version=0.11.0

Faker

A C# port of the Ruby Faker gem https://github.com/stympy/faker. It uses the latest version of their yaml files.

RimuTec.Faker targets .NET Standard 2.0 (netstandard2.0) and .NET Framework 4.6.2 (net462).

Metric Status
Nuget NuGet Badge

Available Fake Data Generators

Because Ruby Faker has a large number of generators, we had to start with a small set of classes. Our aim is to add the remaining classes and method over time. If you have preferences please file suggestions as issues on Github (see below). Thank you!

Address

  • SecondaryAddress()
  • StreetAddress(bool includeSecondary = false)
  • StreetName()

Company

This class is on par with Ruby Faker.

Basic methods:

  • Bs()
  • Buzzword()
  • CatchPhrase()
  • DunsNumber()
  • Ein()
  • Industry()
  • Logo()
  • Name()
  • Profession()
  • Suffix()
  • Type()

Country specific methods:

  • AustralianBusinessNumber()
  • CzechOrganizationNumber()
  • FrenchSirenNumber()
  • FrenchSiretNumber()
  • NorwegianOrganizationNumber()
  • PolishRegisterOfNationalEconomy(int length = 9)
  • PolishTaxpayerIdentificationNumber()
  • SpanishOrganizationNumber()
  • SwedishOrganizationNumber()

Job

  • EmploymentType()
  • EducationLevel()
  • Field()
  • KeySkill()
  • Position()
  • Seniority()
  • Title()

Lorem

This class is on par with Ruby Faker.

  • Character()
  • Characters(int charCount = 255)
  • Multibyte()
  • Paragraph(int sentenceCount = 3, bool supplemental = false, int randomSentencesToAdd = 0)
  • ParagraphByChars(int chars = 256, bool supplemental = false)
  • Paragraphs(int paragraphCount = 3, bool supplemental = false)
  • Question(int wordCount = 4, bool supplemental = false, int randomWordsToAdd = 0)
  • Questions(int questionCount = 3, bool supplemental = false)
  • Sentence(int wordCount = 4, bool supplemental = false, int randomWordsToAdd = 0)
  • Sentences(int sentenceCount = 3, bool supplemental = false)
  • Word()
  • Words(int wordCount = 3, bool supplemental = false)

Name

This class is on par with Ruby Faker.

  • FirstName()
  • FullName() (equivalent to Ruby's Faker::Name.name)
  • Initials(int characterCount)
  • LastName()
  • MiddleName()
  • NameWithMiddle()
  • Prefix()
  • Suffix()

PhoneNumber

  • CellPhone()
  • LandLine(): Equivalent to Ruby Faker::PhoneNumber.phone_number

RandomNumber

  • Next()
  • Next(int maxValue)
  • Next(int minValue, int maxValue)
  • ResetSeed(int seed)

Usage

Installation

This library is available as NuGet package at https://www.nuget.org/packages/RimuTec.Faker

The source code and the library are available under a MIT license. This means you can use this libary and/or the source for free in your own projects, including closed-source and commercial projects. Terms and conditions are as per the MIT license in this project.

Generating Fake Data

  1. Install NuGet package. See https://www.nuget.org/packages/RimuTec.Faker for instructions
  2. Add using RimuTec.Faker; at the beginning of your C# source file (or the equivalent for your preferred .NET language)
  3. Generate fake data, e.g. var firstName = Name.NameWithMiddle();

In case of name clashes with other classes in your code base, use one of the following techniques in C# source files:

  1. use fully qualify names, e.g. var firstName = RimuTec.Faker.Name.NameWithMiddle();. Use this if there are only a couple of occurances.
  2. add using NameFaker = RimuTec.Faker.Name; at the beginning of the file and then var firstName = NameFaker.NameWithMiddle();. Use this option if you have many usages within the source file.

Release Notes

Release notes are available at https://github.com/RimuTec/Faker/blob/master/releasenotes.md

Reporting Issues

Although RimuTec.Faker has about 120 unit tests, that is no proof of absence of bugs. To help making this library more valuable for other users please report bugs at https://github.com/RimuTec/Faker/issues ideally including steps to reproduce. We also consider pull requests (PR). Thank you!

Support & Suggestions

If you have a support question please file an issue at https://github.com/RimuTec/Faker/issues. Thank you!

If you have a suggestion for improvement please file an issue as well. Thank you!

Credits

Thank you to all contributors of the following projects. Their work is much appreciated.

faker-cs

This project uses some code portions from faker-cs under a MIT license.

Ruby Faker gem

This project uses the yaml files from the Ruby Faker gem under a MIT license.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0 565 11/8/2023
2.0.0 1,053 9/24/2023
1.12.0 371 9/24/2023
1.11.0 12,971 12/30/2021
1.10.0 1,054 1/7/2021
1.9.0 981 12/19/2020
1.8.0 812 12/18/2020
1.7.0 742 12/13/2020
1.6.0 844 12/5/2020
1.5.0 943 5/17/2020
1.4.0 953 4/5/2020
1.3.0 853 3/28/2020
1.2.0 898 3/22/2020
1.1.0 879 3/22/2020
1.0.0 828 2/6/2020
0.44.0 871 2/6/2020
0.43.0 948 1/19/2020
0.42.0 892 1/19/2020
0.41.0 853 1/19/2020
0.40.0 1,878 8/5/2018
0.39.0 1,180 7/29/2018
0.38.0 1,166 7/27/2018
0.37.0 1,116 7/26/2018
0.36.0 1,176 7/25/2018
0.35.0 1,141 7/24/2018
0.34.0 1,114 7/23/2018
0.33.0 1,154 7/22/2018
0.32.0 1,169 7/17/2018
0.31.0 1,288 7/17/2018
0.30.0 1,276 7/15/2018
0.29.0 1,245 7/14/2018
0.28.0 1,272 7/13/2018
0.27.0 1,247 7/12/2018
0.26.0 1,296 7/11/2018
0.25.0 1,247 7/10/2018
0.24.0 1,246 7/9/2018
0.23.0 1,294 7/8/2018
0.22.0 1,130 7/7/2018
0.21.0 1,205 7/6/2018
0.20.0 1,194 7/5/2018
0.19.0 1,212 7/4/2018
0.18.0 1,219 7/4/2018
0.17.0 1,262 7/2/2018
0.16.0 1,279 7/1/2018
0.15.0 1,302 6/30/2018
0.14.0 1,255 6/29/2018
0.13.0 1,213 6/28/2018
0.12.0 1,273 6/27/2018
0.11.0 1,230 6/26/2018
0.10.0 1,224 6/25/2018
0.9.0 1,256 6/24/2018
0.8.0 1,279 6/23/2018
0.7.0 1,278 6/22/2018
0.6.0 1,379 6/21/2018
0.5.0 1,286 6/20/2018
0.4.0 1,205 6/20/2018
0.3.0 1,227 6/19/2018
0.2.0 1,288 6/19/2018
0.1.0 1,235 6/18/2018

Relase notes listing new features and other changes are available at https://github.com/RimuTec/Faker/blob/master/releasenotes.md