Skip to content

Latest commit

 

History

History
240 lines (177 loc) · 10.1 KB

README.md

File metadata and controls

240 lines (177 loc) · 10.1 KB
Raw
C++ Faker, a powerful tool for generating realistic and randomized fake data in C++ programming, enhancing data testing and development workflows

Faker C++

clang++ apple clang++ g++ msvc bazel codecov Conan Center PRs Welcome Chat on Discord

Table of Contents

Introduction

Faker C++ is a C++ library inspired by the popular Faker.js, 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 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.

Below is an example of how to use Faker C++ in your code.

#include <iostream>

#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:

    set(BUILD_TESTING OFF)

add_subdirectory(externals/faker-cxx)

add_executable(main Main.cpp)

target_link_libraries(main faker-cxx)

⚒️ Compiler support

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

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:

    conan install conanfile.txt --build=missing

  2. Build the library:

    cmake --preset=conan-release -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON
cmake --build --preset=conan-release

Installing the library with Conan

You can install pre-built binaries for faker-cxx or build it from source using Conan. Use the following command:

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 on the ConanCenterIndex repository.

Building the library with Bazel

As alternative, this project can be built using Bazel. 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:

    cd /path/to/faker-cxx

  2. Build the project:

    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:

Please make sure to read the Contributing Guide before making a pull request.

Additionally, we encourage you to join our Discord Channel 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 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.

🔑 License

This project is under MIT license.