Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cieslarmichal/faker-cxx
C++ Faker library for generating fake (but realistic) data.
https://github.com/cieslarmichal/faker-cxx
cpp cpp20 data-generation development-tools fake fake-data faker faker-cpp faker-generator faker-library test-data-generator
Last synced: about 2 months ago
JSON representation
C++ Faker library for generating fake (but realistic) data.
- Host: GitHub
- URL: https://github.com/cieslarmichal/faker-cxx
- Owner: cieslarmichal
- License: mit
- Created: 2023-06-24T19:56:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-09T12:20:14.000Z (5 months ago)
- Last Synced: 2024-04-10T00:53:25.122Z (5 months ago)
- Topics: cpp, cpp20, data-generation, development-tools, fake, fake-data, faker, faker-cpp, faker-generator, faker-library, test-data-generator
- Language: C++
- Homepage: https://cieslarmichal.github.io/faker-cxx/
- Size: 5.53 MB
- Stars: 190
- Watchers: 7
- Forks: 80
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-game-engine-dev - faker-cxx - C++20 Faker library for generating fake (but realistic) data for testing and development. (Libraries / C++)
- AwesomeCppGameDev - faker-cxx - C++20 Faker library for generating fake (but realistic) data for testing and development. (C++)
README
Faker C++
[](https://github.com/cieslarmichal/faker-cxx/actions/workflows/linux-clang-build.yml?query=branch%3Amain)
[](https://github.com/cieslarmichal/faker-cxx/actions/workflows/macos-clang-build.yml?query=branch%3Amain)
[](https://github.com/cieslarmichal/faker-cxx/actions/workflows/linux-gxx-build.yml?query=branch%3Amain)
[](https://github.com/cieslarmichal/faker-cxx/actions/workflows/windows-msvc-build.yml?query=branch%3Amain)
[](https://github.com/cieslarmichal/faker-cxx/actions/workflows/linux-bazel-build.yml?query=branch%3Amain)
[](https://codecov.io/github/cieslarmichal/faker-cxx)
[](https://conan.io/center/recipes/faker-cxx)
[](http://makeapullrequest.com)
[](https://discord.gg/h2ur8H6mK6)
## Table of Contents
- [Introduction](#introduction)
- [Key Features](#key-features)
- [📖 Usage and Documentation](#-usage-and-documentation)
- [💎 Modules](#-modules)
- [Consuming the library with CMake](#consuming-the-library-with-cmake)
- [⚒️ Compiler support](#-compiler-support)
- [Dependencies](#dependencies)
- [📦 Building the library with Conan](#-building-the-library-with-conan)
- [Installing the library with Conan](#installing-the-library-with-conan)
- [Building the library with Bazel](#building-the-library-with-bazel)
- [✨ Contributing](#-contributing)
- [📘 Credits](#-credits)
- [Examples](#examples)
- [📝 Changelog](#-changelog)
- [🔑 License](#-license)
## Introduction
Faker C++ is a C++ library inspired by the popular [Faker.js](https://github.com/faker-js/faker),
aimed at providing developers with a robust tool for generating fake (but realistic) data.
Whether you're building test suites, populating databases, or creating demos, Faker C++ has got you covered.
## Key Features
📚 Realistic Data Generation: Generate various types of data including names, addresses, emails, dates, and more.
🛠 Modular Design: Choose from a wide range of modules like Internet, Location, String, Date, and more to generate
specific types of data.
🚀 Easy Integration: Seamlessly integrate with CMake, and it supports major compilers like MSVC, GCC, Clang, and Apple
Clang.
## 📖 Usage and Documentation
To properly use Faker C++ you must first consume the Faker library (see Consuming Library with CMake).
Once that is done, you need to include the proper [header](https://cieslarmichal.github.io/faker-cxx/files.html) file
depending on the module you wish to generate data from or use general include file `faker-cxx/faker.h`.
All the docs can be found [here](https://cieslarmichal.github.io/faker-cxx/).
Below is an example of how to use Faker C++ in your code.
```cpp
#include
#include "faker-cxx/faker.h" // or include specific module
int main()
{
const auto id = faker::string::uuid();
const auto email = faker::internet::email();
const auto password = faker::internet::password();
const auto city = faker::location::city();
const auto streetAddress = faker::location::streetAddress();
const auto bornDate = faker::date::birthdateByYear(1970, 2000);
std::cout << id << std::endl; // 59990db5-3a5f-40bf-8af0-7834c29ee884
std::cout << email << std::endl; // [email protected]
std::cout << password << std::endl; // Mf+*[(_'lHfM.$v{
std::cout << city << std::endl; // Rochester
std::cout << streetAddress << std::endl; // 643 Ricardo Creek
std::cout << bornDate << std::endl; // 1973-12-03T11:07:02Z
return 0;
}
```
## 💎 Modules
- 🛩 Airline - aircraft types, airlines, airports, flight numbers
- 🐼 Animal - animal types and species
- 📖 Book - book title, genre, author, publisher, ISBN
- 🎨 Color - color names, rgb, hex, hcl
- 🛒 Commerce - commerce department, product name, sku, price
- 🏢 Company - company name, type, industry, catchphrase, buzz phrase
- 🖥️ Computer - type, manufacturer, model, CPU info, GPU info
- 🔐 Crypto - sha256, md5
- 💾 Database - column names, column types, database engines
- ℹ️ Datatype - booleans
- 📅 Date - past, future dates
- 🏦 Finance - currency, IBAN, BIC, account name, account number, pin, credit card numbers
- 🍝 Food - food category, vegetables, fruits, meats, dishes
- 📁 Git - branch names, commit messages, commit hash
- 👨💻 Hacker - hacker words
- ✋ Helper - random element from container
- 🌐 Internet - emails, usernames, passwords, IP, HTTP
- 🖼️ Image - images urls, github avatar urls, image dimensions
- 🌍 Location - countries, cities, zip codes, street addresses
- 📚 Lorem - lorem words, sentences, paragraphs
- 🏥 Medicine - conditions, medical tests, specialties
- 🎥 Movie - actors, actresses, genres, movie titles
- 🎶 Music - artists, song names, genres
- 🔢 Number - random integers, floating point numbers
- 🧑 Person - first, last names, job titles, hobby, genders, sex, nationality, language
- 📞 Phone - phone number, IMEI
- 🪴 Plant - plant type, trees, flowers
- ⚽ Sport - sport names, athletes, events
- 🔢 String - uuids, alphanumeric, numeric, hexadecimal
- 💻 System - file paths, file extensions, file names, directories, semantic version
- 🚗 Vehicle - vehicle types, makes, models, fuel types, license plates
- 🎮 Video game - title, genre, platform, studio
- 🌤️ Weather - temperature, pressure, humidity, weather description
- 💬 Word - sample words, nouns, verbs
## Consuming the library with CMake
1. Add faker to git submodules (execute in project root):
```
mkdir externals && cd externals
git submodule add https://github.com/cieslarmichal/faker-cxx.git
git submodule update --init --recursive
```
2. Link with library:
```cmake
set(BUILD_TESTING OFF)
add_subdirectory(externals/faker-cxx)
add_executable(main Main.cpp)
target_link_libraries(main faker-cxx)
```
## ⚒️ Compiler support
- [MSVC➚](https://en.wikipedia.org/wiki/Microsoft_Visual_Studio) version 143 or newer.
- [GCC➚](https://gcc.gnu.org/) version 12 or newer.
- [Clang➚](https://clang.llvm.org/) version 16 or newer.
- [Apple Clang➚](https://clang.llvm.org/) version 16 or newer.
## Dependencies
- GTest (set `BUILD_TESTING=OFF` CMake flag to disable this dependency)
- fmt (only for compilers that don't support std::format)
In order to use external dependencies installed in your system, you can set the `USE_SYSTEM_DEPENDENCIES` CMake flag
to `ON`.
## 📦 Building the library with [Conan](https://conan.io/)
The library can be built using Conan package manager to solve external dependencies.
To build the library with Conan, follow the steps below:
1. Install required dependencies:
```bash
conan install conanfile.txt --build=missing
```
2. Build the library:
```bash
cmake --preset=conan-release -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON
cmake --build --preset=conan-release
```
## Installing the library with [Conan](https://conan.io/)
You can install pre-built binaries for faker-cxx or build it from source using Conan. Use the following command:
```bash
conan install --requires="faker-cxx/[*]" --build=missing
```
The faker-cxx Conan recipe is kept up to date by Conan maintainers and community contributors.
If the version is out of date, please [create an issue or pull request](https://github.com/conan-io/conan-center-index)
on the ConanCenterIndex repository.
## Building the library with [Bazel](https://bazel.build/)
As alternative, this project can be built using [Bazel](https://bazel.build/). The dependencies are managed directly by
Bazel modules, downloading and building all external dependencies. Follow the steps below to build the project:
1. **Navigate to the project directory:**
```sh
cd /path/to/faker-cxx
```
2. **Build the project:**
```sh
bazel build //:faker-cxx
```
## ✨ Contributing
We would love it if you contributed to Faker C++! 🚀
Check our guides on how to build the project locally:
- [Clang++](./docs/guides/clang-compilation-guide.md)
- [Apple Clang++](./docs/guides/apple-clang-compilation-guide.md)
- [G++](./docs/guides/gcc-compilation-guide.md)
- [MSVC](./docs/guides/msvc-compilation-guide.md)
Please make sure to read the [Contributing Guide](https://github.com/cieslarmichal/faker-cxx/blob/main/CONTRIBUTING.md)
before making a pull request.
Additionally, we encourage you to join our [Discord Channel](https://discord.gg/h2ur8H6mK6) for contributors.
## 📘 Credits
Thanks to all the people who already contributed to Faker!
## Examples
This project offers examples to demonstrate how to use the Faker C++ library.
These examples can be found in the [examples](examples/README.md) folder of the project repository.
The examples showcase various modules of the library and provide code snippets that illustrate how to generate fake data
using Faker C++.
## 📝 Changelog
Detailed changes for each release are documented in the [release notes](CHANGELOG.md).
## 🔑 License
This project is under [MIT](LICENSE) license.