faker README

The project's README from github.com/faker-ruby/faker. As one markdown file: README.md.

Faker Gem Version Build Status Total Downloads Downloads

Generate (almost) realistic fake data for testing, demos, and populating your database during development.

Features

Note: The generated names, addresses, emails, phone numbers, and/or other data might return valid information. Please be careful when using faker in your tests.

For a complete list of the generators, see Generators.

Getting Started

Start by including faker in your Gemfile:

gem 'faker'

Then run bundle install.

Usage

require 'faker'

Faker::Name.name                      #=> "Christophe Bartell"
Faker::Internet.password              #=> "Vg5mSvY1UeRg7"
Faker::Internet.email                 #=> "[email protected]"
Faker::Address.full_address           #=> "5479 William Way, East Sonnyhaven, LA 63637"
Faker::Markdown.emphasis              #=> "Quo qui aperiam. Amet corrupti distinctio. Sit quia *dolor.*"
Faker::Lorem.paragraph                #=> "Recusandae minima consequatur. Expedita sequi blanditiis. Ut fuga et."
Faker::Alphanumeric.alpha(number: 10) #=> "zlvubkrwga"
Faker::ProgrammingLanguage.name       #=> "Ruby"

Table of Contents

Notes

Ensuring unique values

To ensure Faker generates unique values, prefix your method call with unique:

Faker::Name.unique.name # This will return a unique name every time it is called

If too many unique values are requested from a generator that has a limited number of potential values, a Faker::UniqueGenerator::RetryLimitExceeded exception may be raised. It is possible to clear the record of unique values that have been returned, for example between tests.

Faker::Name.unique.clear     # Clears used values for Faker::Name
Faker::UniqueGenerator.clear # Clears used values for all generators

You can also give some already-used values to the unique generator if you have collisions with the generated data (i.e., using FactoryBot with random and manually set values).

# Faker::<generator>.unique.exclude(method, arguments, list)

# Add 'azerty' and 'wxcvbn' to the string generator with 6 char length
Faker::Lorem.unique.exclude :string, [number: 6], %w[azerty wxcvbn]

Deterministic Random

Faker supports seeding of its pseudo-random number generator (PRNG) to provide deterministic output of repeated method calls.

Faker::Config.random = Random.new(42)
Faker::Lorem.word              #=> "velit"
Faker::Lorem.word              #=> "quisquam"

Faker::Config.random = Random.new(42)
Faker::Lorem.word              #=> "velit"
Faker::Lorem.word              #=> "quisquam"

Faker::Config.random = nil     # seeds the PRNG using default entropy sources
Faker::Config.random.seed      #=> 185180369676275068918401850258677722187
Faker::Lorem.word              #=> "ipsam"

Localization

You may want Faker to print information depending on your location in the world. To assist you in this, Faker uses the I18n gem to store strings and formats to represent the names and postal codes of the area of your choosing.

Just set the locale you want as shown below, and Faker will take care of the rest.

Faker::Config.locale = 'es'
# or
Faker::Config.locale = :es

To override Faker's locales, and set it on threaded server environments check out the locales README.

Minitest and Faker >= 2.22

To prevent Faker (version >= 2.22) from generating duplicate values when using Minitest, you might need to add the following to the test_helper.rb or rails_helper.rb file:

Faker::Config.random = Random.new

Generators

To see the full list, check out the GENERATORS document.

Contributing

Note: We are not accepting proposals for new generators and locales. The Contributing guide has a few notes about this decision.

Take a look at the Contributing document for instructions on setting up the repo on your machine, opening bug reports, understanding the codebase, and creating a good pull request.

There is a Discord channel to discuss anything regarding improvements or feature requests. This is not actively monitored by the current maintainers.

Thank you, contributors!

Versioning

Faker follows Semantic Versioning 2.0 as defined at https://semver.org.

Inspiration

Faker was inspired by Perl's Data::Faker library.

In the media

License

This code is free to use under the terms of the MIT license.

faker (faker-ruby/faker)

Searching Database…

11.9K ·GitHub
Faker
Что это такое?Faker — это библиотека на Ruby, которая генерирует правдоподобные поддельные данные (имена, адреса, email, номера телефонов и многое другое) для тестирования, демонстраций и наполнения баз данных.
Это отдельное приложение или библиотека, которую я добавляю в свой код?Это gem на Ruby, который вы добавляете в проект как зависимость, а не самостоятельное приложение.
Как добавить её в проект?Добавьте faker в ваш Gemfile и выполните 'bundle install', после чего вызывайте его методы-генераторы в своём коде.
Нужно ли что-то кроме Ruby и Bundler?Никакие дополнительные сервисы или API-ключи не нужны; внутри библиотека использует только gem I18n для работы с локалями.
Будут ли поддельные данные всегда уникальными или безопасными для использования?По умолчанию возвращаемые значения не гарантированно уникальны, а сгенерированные данные могут случайно совпасть с реальной информацией, поэтому при необходимости добавляйте к вызовам префикс 'unique' и будьте осторожны, используя их в тестах.
Можно ли сделать так, чтобы поддельные данные воспроизводились от запуска к запуску?Да, Faker поддерживает задание seed для своего генератора псевдослучайных чисел (PRNG), поэтому повторные вызовы дают одинаковый результат.
Может ли Faker генерировать данные на языках, отличных от английского?Да, поддерживается более 40 локалей: установив локаль I18n, можно генерировать правдоподобные имена, адреса и номера телефонов для разных регионов.
Какие категории поддельных данных может генерировать Faker?Библиотека охватывает данные для интернета (email, пароли, домены), даты и время, информацию о людях (имена, пол, должности), числа и строки, местоположения (адреса, почтовые индексы) и финансовые данные (реквизиты счетов, транзакции, криптоадреса).
Продолжают ли добавляться новые генераторы данных и локали?Нет, мейнтейнеры заявили, что не принимают предложения о новых генераторах и локалях.
What are similar projects?faker, faker, json-server, vibe-aso, Faker, msw, mockito, nock
Which topics is it in?fake, mock, localization, ruby, i18n, testing, database, library, developer-tools, mit, open-source
Creator
faker-ruby
Size
14.7 MB
Stars
11.9K
Updated
CommitOct 13Releasev3.8.0Apr 16
Age
17y
Commits · 90 Days