1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
# Faker
[](https://github.com/faker-ruby/faker/actions?query=workflow%3ATests)
[](https://badge.fury.io/rb/faker)
[](https://inch-ci.org/github/faker-ruby/faker)
[](https://codeclimate.com/github/stympy/faker/test_coverage)
[](https://codeclimate.com/github/stympy/faker/maintainability)
[](https://dependabot.com/compatibility-score.html?dependency-name=faker&package-manager=bundler&version-scheme=semver)
This gem is a port of [Perl's Data::Faker library](https://metacpan.org/pod/Data::Faker) that generates fake data.
It comes in very handy for taking screenshots (taking screenshots for my
project, [Catch the Best](http://catchthebest.com/) was the original impetus
for the creation of this gem), having real-looking test data, and having your
database populated with more than one or two records while you're doing
development.
- [Faker](#faker)
- [NOTE](#note)
- [Installing](#installing)
- [Usage](#usage)
- [CLI](#cli)
- [Ensuring unique values](#ensuring-unique-values)
- [Deterministic Random](#deterministic-random)
- [Generators](#generators)
- [Default](#default)
- [Blockchain](#blockchain)
- [Books](#books)
- [Fantasy](#fantasy)
- [Creature](#creature)
- [Games](#games)
- [Japanese Media](#japanese-media)
- [Movies](#movies)
- [Music](#music)
- [Quotes](#quotes)
- [Sports](#sports)
- [Tv Shows](#tv-shows)
- [Customization](#customization)
- [Contributing](#contributing)
- [Contact](#contact)
- [License](#license)
### NOTE
* While Faker generates data at random, returned values are not guaranteed to be unique by default.
You must explicitly specify when you require unique values, see [details](#ensuring-unique-values).
Values also can be deterministic if you use the deterministic feature, see [details](#deterministic-random)
* This is the `master` branch of Faker and may contain changes that are not yet released.
Please refer the README of your version for the available methods.
List of all versions is [available here](https://github.com/stympy/faker/releases).
## Installing
```bash
gem install faker
```
Note: if you are getting a `uninitialized constant Faker::[some_class]` error, your version of the gem is behind the one documented here. To make sure that your gem is the one documented here, change the line in your Gemfile to:
```ruby
gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'master'
```
## Usage
```ruby
require 'faker'
Faker::Name.name #=> "Christophe Bartell"
Faker::Internet.email #=> "kirsten.greenholt@corkeryfisher.info"
```
### CLI
Instructions are available in the [faker-bot README](https://github.com/faker-ruby/faker-bot).
### Ensuring unique values
Prefix your method call with `unique`. For example:
```ruby
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.
```ruby
Faker::Name.unique.clear # Clears used values for Faker::Name
Faker::UniqueGenerator.clear # Clears used values for all generators
```
You also can 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).
```ruby
# Usage:
# 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.
```ruby
Faker::Config.random = Random.new(42)
Faker::Company.bs #=> "seize collaborative mindshare"
Faker::Company.bs #=> "engage strategic platforms"
Faker::Config.random = Random.new(42)
Faker::Company.bs #=> "seize collaborative mindshare"
Faker::Company.bs #=> "engage strategic platforms"
Faker::Config.random = nil # seeds the PRNG using default entropy sources
Faker::Config.random.seed #=> 185180369676275068918401850258677722187
Faker::Company.bs #=> "cultivate viral synergies"
```
## Generators
**NOTE: Some of the generators below aren't released yet. If you want to use them, change the line in your gemfile to:**
```ruby
gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'master'
```
### Default
- [Faker::Address](doc/default/address.md)
- [Faker::Alphanumeric](doc/default/alphanumeric.md)
- [Faker::Ancient](doc/default/ancient.md)
- [Faker::App](doc/default/app.md)
- [Faker::Appliance](doc/default/appliance.md)
- [Faker::Artist](doc/default/artist.md)
- [Faker::Avatar](doc/default/avatar.md)
- [Faker::Bank](doc/default/bank.md)
- [Faker::Barcode](doc/default/barcode.md)
- [Faker::Beer](doc/default/beer.md)
- [Faker::Blood](doc/default/blood.md)
- [Faker::Boolean](doc/default/boolean.md)
- [Faker::BossaNova](doc/default/bossa_nova.md)
- [Faker::Business](doc/default/business.md)
- [Faker::Camera](doc/default/camera.md)
- [Faker::Cannabis](doc/default/cannabis.md)
- [Faker::ChileRut](doc/default/chile_rut.md)
- [Faker::ChuckNorris](doc/default/chuck_norris.md)
- [Faker::Code](doc/default/code.md)
- [Faker::Coffee](doc/default/coffee.md)
- [Faker::Coin](doc/default/coin.md)
- [Faker::Color](doc/default/color.md)
- [Faker::Commerce](doc/default/commerce.md)
- [Faker::Company](doc/default/company.md)
- [Faker::Compass](doc/default/compass.md)
- [Faker::Computer](doc/default/computer.md)
- [Faker::Construction](doc/default/construction.md)
- [Faker::Cosmere](doc/default/cosmere.md)
- [Faker::Crypto](doc/default/crypto.md)
- [Faker::CryptoCoin](doc/default/crypto_coin.md)
- [Faker::Currency](doc/default/currency.md)
- [Faker::Date](doc/default/date.md)
- [Faker::DcComics](doc/default/dc_comics.md)
- [Faker::Demographic](doc/default/demographic.md)
- [Faker::Dessert](doc/default/dessert.md)
- [Faker::Device](doc/default/device.md)
- [Faker::DrivingLicence](doc/default/driving_licence.md)
- [Faker::Drone](doc/drone/drone.md)
- [Faker::Educator](doc/default/educator.md)
- [Faker::ElectricalComponents](doc/default/electrical_components.md)
- [Faker::Emotion](doc/default/emotion.md)
- [Faker::Esport](doc/default/esport.md)
- [Faker::File](doc/default/file.md)
- [Faker::Fillmurray](doc/default/fillmurray.md)
- [Faker::Finance](doc/default/finance.md)
- [Faker::Food](doc/default/food.md)
- [Faker::FunnyName](doc/default/funny_name.md)
- [Faker::Gender](doc/default/gender.md)
- [Faker::GreekPhilosophers](doc/default/greek_philosophers.md)
- [Faker::Hacker](doc/default/hacker.md)
- [Faker::Hipster](doc/default/hipster.md)
- [Faker::Hobby](doc/default/hobby.md)
- [Faker::House](doc/default/house.md)
- [Faker::IDNumber](doc/default/id_number.md)
- [Faker::IndustrySegments](doc/default/industry_segments.md)
- [Faker::Internet](doc/default/internet.md)
- [Faker::Invoice](doc/default/invoice.md)
- [Faker::Job](doc/default/job.md)
- [Faker::Json](doc/default/json.md)
- [Faker::Kpop](doc/default/kpop.md)
- [Faker::Lorem](doc/default/lorem.md)
- [Faker::LoremFlickr](doc/default/lorem_flickr.md)
- [Faker::LoremPixel](doc/default/lorem_pixel.md)
- [Faker::Markdown](doc/default/markdown.md)
- [Faker::Marketing](doc/default/marketing.md)
- [Faker::Measurement](doc/default/measurement.md)
- [Faker::Military](doc/default/military.md)
- [Faker::Mountain](doc/default/mountain.md)
- [Faker::Name](doc/default/name.md)
- [Faker::Nation](doc/default/nation.md)
- [Faker::NatoPhoneticAlphabet](doc/default/nato_phonetic_alphabet.md)
- [Faker::NationalHealthService](doc/default/national_health_service.md)
- [Faker::Number](doc/default/number.md)
- [Faker::Omniauth](doc/default/omniauth.md)
- [Faker::PhoneNumber](doc/default/phone_number.md)
- [Faker::Placeholdit](doc/default/placeholdit.md)
- [Faker::ProgrammingLanguage](doc/default/programming_language.md)
- [Faker::Relationship](doc/default/relationship.md)
- [Faker::Restaurant](doc/default/restaurant.md)
- [Faker::Science](doc/default/science.md)
- [Faker::SlackEmoji](doc/default/slack_emoji.md)
- [Faker::Source](doc/default/source.md)
- [Faker::SouthAfrica](doc/default/south_africa.md)
- [Faker::Space](doc/default/space.md)
- [Faker::String](doc/default/string.md)
- [Faker::Stripe](doc/default/stripe.md)
- [Faker::Subscription](doc/default/subscription.md)
- [Faker::Superhero](doc/default/superhero.md)
- [Faker::Tea](doc/default/tea.md)
- [Faker::Team](doc/default/team.md)
- [Faker::Time](doc/default/time.md)
- [Faker::Twitter](doc/default/twitter.md)
- [Faker::Types](doc/default/types.md)
- [Faker::University](doc/default/university.md)
- [Faker::Vehicle](doc/default/vehicle.md)
- [Faker::Verbs](doc/default/verbs.md)
- [Faker::WorldCup](doc/default/world_cup.md)
### Blockchain
- [Faker::Blockchain::Aeternity](doc/blockchain/aeternity.md)
- [Faker::Blockchain::Bitcoin](doc/blockchain/bitcoin.md)
- [Faker::Blockchain::Ethereum](doc/blockchain/ethereum.md)
- [Faker::Blockchain::Tezos](doc/blockchain/tezos.md)
### Books
- [Faker::Book](doc/books/book.md)
- [Faker::Books::CultureSeries](doc/books/culture_series.md)
- [Faker::Books::Dune](doc/books/dune.md)
- [Faker::Books::Lovecraft](doc/books/lovecraft.md)
- [Faker::Books::TheKingkillerChronicle](doc/books/the_kingkiller_chronicle.md)
### Fantasy
- [Faker::Fantasy::Tolkien](doc/fantasy/tolkien.md)
### Creature
- [Faker::Creature::Animal](doc/creature/animal.md)
- [Faker::Creature::Bird](doc/creature/bird.md)
- [Faker::Creature::Cat](doc/creature/cat.md)
- [Faker::Creature::Dog](doc/creature/dog.md)
- [Faker::Creature::Horse](doc/creature/horse.md)
### Games
- [Faker::Game](doc/games/game.md)
- [Faker::Games::ClashOfClans](doc/games/clash_of_clans.md)
- [Faker::Games::DnD](doc/games/dnd.md)
- [Faker::Games::Dota](doc/games/dota.md)
- [Faker::Games::ElderScrolls](doc/games/elder_scrolls.md)
- [Faker::Games::Fallout](doc/games/fallout.md)
- [Faker::Games::HalfLife](doc/games/half_life.md)
- [Faker::Games::Heroes](doc/games/heroes.md)
- [Faker::Games::HeroesOfTheStorm](doc/games/heroes_of_the_storm.md)
- [Faker::Games::LeagueOfLegends](doc/games/league_of_legends.md)
- [Faker::Games::Minecraft](doc/games/minecraft.md)
- [Faker::Games::Myst](doc/games/myst.md)
- [Faker::Games::Overwatch](doc/games/overwatch.md)
- [Faker::Games::Pokemon](doc/games/pokemon.md)
- [Faker::Games::SonicTheHedgehog](doc/games/sonic_the_hedgehog.md)
- [Faker::Games::StreetFighter](doc/games/street_fighter.md)
- [Faker::Games::SuperMario](doc/games/super_mario.md)
- [Faker::Games::SuperSmashBros](doc/games/super_smash_bros.md)
- [Faker::Games::Touhou](doc/games/touhou.md)
- [Faker::Games::WarhammerFantasy](doc/games/warhammer_fantasy.md)
- [Faker::Games::Witcher](doc/games/witcher.md)
- [Faker::Games::WorldOfWarcraft](doc/games/world_of_warcraft.md)
- [Faker::Games::Zelda](doc/games/zelda.md)
### Japanese Media
- [Faker::JapaneseMedia::DragonBall](doc/japanese_media/dragon_ball.md)
- [Faker::JapaneseMedia::OnePiece](doc/japanese_media/one_piece.md)
- [Faker::JapaneseMedia::StudioGhibli](doc/japanese_media/studio_ghibli.md)
- [Faker::JapaneseMedia::SwordArtOnline](doc/japanese_media/sword_art_online.md)
- [Faker::JapaneseMedia::Naruto](doc/japanese_media/naruto.md)
- [Faker::JapaneseMedia::Doraemon](doc/japanese_media/doraemon.md)
- [Faker::JapaneseMedia::Conan](doc/japanese_media/conan.md)
- [Faker::JapaneseMedia::FmaBrotherhood](doc/japanese_media/fullmetal_alchemist_brotherhood.md)
### Movies
- [Faker::Movie](doc/movies/movie.md)
- [Faker::Movies::BackToTheFuture](doc/movies/back_to_the_future.md)
- [Faker::Movies::Departed](doc/movies/departed.md)
- [Faker::Movies::Ghostbusters](doc/movies/ghostbusters.md)
- [Faker::Movies::HarryPotter](doc/movies/harry_potter.md)
- [Faker::Movies::HitchhikersGuideToTheGalaxy](doc/movies/hitchhikers_guide_to_the_galaxy.md)
- [Faker::Movies::Hobbit](doc/movies/hobbit.md)
- [Faker::Movies::HowToTrainYourDragon](doc/movies/how_to_train_your_dragon.md)
- [Faker::Movies::Lebowski](doc/movies/lebowski.md)
- [Faker::Movies::LordOfTheRings](doc/movies/lord_of_the_rings.md)
- [Faker::Movies::PrincessBride](doc/movies/princess_bride.md)
- [Faker::Movies::StarWars](doc/movies/star_wars.md)
- [Faker::Movies::TRON](doc/movies/tron.md)
- [Faker::Movies::VForVendetta](doc/movies/v_for_vendetta.md)
### Music
- [Faker::Music](doc/music/music.md)
- [Faker::Music::GratefulDead](doc/music/grateful_dead.md)
- [Faker::Music::Hiphop](doc/music/hiphop.md)
- [Faker::Music::Opera](doc/music/opera.md)
- [Faker::Music::PearlJam](doc/music/pearl_jam.md)
- [Faker::Music::Phish](doc/music/phish.md)
- [Faker::Music::Prince](doc/music/prince.md)
- [Faker::Music::RockBand](doc/music/rock_band.md)
- [Faker::Music::Rush](doc/music/rush.md)
- [Faker::Music::UmphreysMcgee](doc/music/umphreys_mcgee.md)
### Quotes
- [Faker::Quote](doc/quotes/quote.md)
- [Faker::Quotes::Chiquito](doc/quotes/chiquito.md)
- [Faker::Quotes::Rajnikanth](doc/quotes/rajnikanth.md)
- [Faker::Quotes::Shakespeare](doc/quotes/shakespeare.md)
### Sports
- [Faker::Sports::Basketball](doc/sports/basketball.md)
- [Faker::Sports::Football](doc/sports/football.md)
### Tv Shows
- [Faker::TvShows::AquaTeenHungerForce](doc/tv_shows/aqua_teen_hunger_force.md)
- [Faker::TvShows::BigBangTheory](doc/tv_shows/big_bang_theory.md)
- [Faker::TvShows::BojackHorseman](doc/tv_shows/bojack_horseman.md)
- [Faker::TvShows::BreakingBad](doc/tv_shows/breaking_bad.md)
- [Faker::TvShows::BrooklynNineNine](doc/tv_shows/brooklyn_nine_nine.md)
- [Faker::TvShows::Buffy](doc/tv_shows/buffy.md)
- [Faker::TvShows::Community](doc/tv_shows/community.md)
- [Faker::TvShows::DrWho](doc/tv_shows/dr_who.md)
- [Faker::TvShows::DumbAndDumber](doc/tv_shows/dumb_and_dumber.md)
- [Faker::TvShows::FamilyGuy](doc/tv_shows/family_guy.md)
- [Faker::TvShows::FinalSpace](doc/tv_shows/final_space.md)
- [Faker::TvShows::Friends](doc/tv_shows/friends.md)
- [Faker::TvShows::GameOfThrones](doc/tv_shows/game_of_thrones.md)
- [Faker::TvShows::HeyArnold](doc/tv_shows/hey_arnold.md)
- [Faker::TvShows::HowIMetYourMother](doc/tv_shows/how_i_met_your_mother.md)
- [Faker::TvShows::MichaelScott](doc/tv_shows/michael_scott.md)
- [Faker::TvShows::NewGirl](doc/tv_shows/new_girl.md)
- [Faker::TvShows::ParksAndRec](doc/tv_shows/parks_and_rec.md)
- [Faker::TvShows::RickAndMorty](doc/tv_shows/rick_and_morty.md)
- [Faker::TvShows::RuPaul](doc/tv_shows/rupaul.md)
- [Faker::TvShows::Seinfeld](doc/tv_shows/seinfeld.md)
- [Faker::TvShows::SiliconValley](doc/tv_shows/silicon_valley.md)
- [Faker::TvShows::Simpsons](doc/tv_shows/simpsons.md)
- [Faker::TvShows::SouthPark](doc/tv_shows/south_park.md)
- [Faker::TvShows::StarTrek](doc/tv_shows/star_trek.md)
- [Faker::TvShows::Stargate](doc/tv_shows/stargate.md)
- [Faker::TvShows::StrangerThings](doc/tv_shows/stranger_things.md)
- [Faker::TvShows::Suits](doc/tv_shows/suits.md)
- [Faker::TvShows::Supernatural](doc/tv_shows/supernatural.md)
- [Faker::TvShows::TheExpanse](doc/tv_shows/the_expanse.md)
- [Faker::TvShows::TheFreshPrinceOfBelAir](doc/tv_shows/the_fresh_prince_of_bel_air.md)
- [Faker::TvShows::TheITCrowd](doc/tv_shows/the_it_crowd.md)
- [Faker::TvShows::TheThickOfIt](doc/tv_shows/the_thick_of_it.md)
- [Faker::TvShows::TwinPeaks](doc/tv_shows/twin_peaks.md)
- [Faker::TvShows::VentureBros](doc/tv_shows/venture_bros.md)
## Customization
Since you may want to make addresses and other types of data look different
depending on where in the world you are (US postal codes vs. UK postal codes,
for example), Faker uses the I18n gem to store strings (like state names) and
formats (US postal codes are NNNNN while UK postal codes are AAN NAA),
allowing you to get different formats by switching locales.
Just set the locale you want as shown below, and Faker will take care of the rest.
```ruby
Faker::Config.locale = 'es'
# or
Faker::Config.locale = :es
```
If your locale doesn't already exist, create it in the `lib/locales` directory
and you can then override or add elements to suit your needs. See more about how to
use locales [here](lib/locales/README.md)
```yaml
en-au-ocker:
faker:
name:
# Existing faker field, new data
first_name:
- Charlotte
- Ava
- Chloe
- Emily
# New faker fields
ocker_first_name:
- Bazza
- Bluey
- Davo
- Johno
- Shano
- Shazza
region:
- South East Queensland
- Wide Bay Burnett
- Margaret River
- Port Pirie
- Gippsland
- Elizabeth
- Barossa
```
## Contributing
See [CONTRIBUTING.md](https://github.com/stympy/faker/blob/master/CONTRIBUTING.md).
## Contact
Comments and feedback are welcome. Send an email to Benjamin Curtis via the [google group](http://groups.google.com/group/ruby-faker).
You can also join our [discord channel](https://discord.gg/RMumTwB) to discuss anything regarding improvements or feature requests.
## License
This code is free to use under the terms of the MIT license.
|
