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
|
![logotype a happy-07](https://user-images.githubusercontent.com/36028424/40263395-4318481e-5b44-11e8-92e5-3dcc1ce169b3.png)
# Faker [![Build Status](https://travis-ci.org/stympy/faker.svg?branch=master)](https://travis-ci.org/stympy/faker) [![Gem Version](https://badge.fury.io/rb/faker.svg)](https://badge.fury.io/rb/faker) [![Test Coverage](https://api.codeclimate.com/v1/badges/ef54c7f9df86e965d64b/test_coverage)](https://codeclimate.com/github/stympy/faker/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/ef54c7f9df86e965d64b/maintainability)](https://codeclimate.com/github/stympy/faker/maintainability)
This gem is a port of Perl's Data::Faker library 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.
### NOTE
* While Faker generates data at random, returned values are not guaranteed to be unique by default.
You must explicity 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).
Contents
--------
- [Installing](#installing)
- [Usage](#usage)
- [Faker::Address](doc/address.md)
- [Faker::Ancient](doc/ancient.md)
- [Faker::App](doc/app.md)
- [Faker::Appliance](doc/appliance.md)
- [Faker::Artist](doc/artist.md)
- [Faker::AquaTeenHungerForce](doc/aqua_teen_hunger_force.md)
- [Faker::Avatar](doc/avatar.md)
- [Faker::BackToTheFuture](doc/back_to_the_future.md)
- [Faker::Bank](doc/bank.md)
- [Faker::Beer](doc/beer.md)
- [Faker::Bitcoin](doc/bitcoin.md)
- [Faker::BojackHorseman](doc/bojack_horseman.md)
- [Faker::Book](doc/book.md)
- [Faker::Boolean](doc/boolean.md)
- [Faker::BossaNova](doc/bossa_nova.md)
- [Faker::BreakingBad](doc/breaking_bad.md)
- [Faker::Business](doc/business.md)
- [Faker::Cannabis](doc/cannabis.md)
- [Faker::Cat](doc/cat.md)
- [Faker::ChuckNorris](doc/chuck_norris.md)
- [Faker::Code](doc/code.md)
- [Faker::Coffee](doc/coffee.md)
- [Faker::Color](doc/color.md)
- [Faker::Commerce](doc/commerce.md)
- [Faker::Community](doc/community.md)
- [Faker::Company](doc/company.md)
- [Faker::Compass](doc/compass.md)
- [Faker::Crypto](doc/crypto.md)
- [Faker::Currency](doc/currency.md)
- [Faker::Date](doc/date.md)
- [Faker::Demographic](doc/demographic.md)
- [Faker::Dessert](doc/dessert.md)
- [Faker::Device](doc/device.md)
- [Faker::Dog](doc/dog.md)
- [Faker::Dota](doc/dota.md)
- [Faker::DrWho](doc/dr_who.md)
- [Faker::DragonBall](doc/dragon_ball.md)
- [Faker::DumbAndDumber](doc/dumb_and_dumber.md)
- [Faker::Dune](doc/dune.md)
- [Faker::Educator](doc/educator.md)
- [Faker::ElderScrolls](doc/elder_scrolls.md)
- [Faker::ElectricalComponents](doc/electrical_components.md)
- [Faker::Esport](doc/esport.md)
- [Faker::Ethereum](doc/ethereum.md)
- [Faker::Fallout](doc/fallout.md)
- [Faker::FamilyGuy](doc/family_guy.md)
- [Faker::FamousLastWords](doc/famous_last_words.md)
- [Faker::File](doc/file.md)
- [Faker::Fillmurray](doc/fillmurray.md)
- [Faker::Finance](doc/finance.md)
- [Faker::Food](doc/food.md)
- [Faker::Football](doc/football.md)
- [Faker::Friends](doc/friends.md)
- [Faker::FunnyName](doc/funny_name.md)
- [Faker::GameOfThrones](doc/game_of_thrones.md)
- [Faker::Gender](doc/gender.md)
- [Faker::GreekPhilosophers](doc/greek_philosophers.md)
- [Faker::Hacker](doc/hacker.md)
- [Faker::HarryPotter](doc/harry_potter.md)
- [Faker::HeyArnold](doc/hey_arnold.md)
- [Faker::Hipster](doc/hipster.md)
- [Faker::HitchhikersGuideToTheGalaxy](doc/hitchhikers_guide_to_the_galaxy.md)
- [Faker::Hobbit](doc/hobbit.md)
- [Faker::HowIMetYourMother](doc/how_i_met_your_mother.md)
- [Faker::IDNumber](doc/id_number.md)
- [Faker::Internet](doc/internet.md)
- [Faker::Invoice](doc/invoice.md)
- [Faker::Job](doc/job.md)
- [Faker::Kpop](doc/kpop.md)
- [Faker::LeagueOfLegends](doc/league_of_legends.md)
- [Faker::Lebowski](doc/lebowski.md)
- [Faker::LordOfTheRings](doc/lord_of_the_rings.md)
- [Faker::Lorem](doc/lorem.md)
- [Faker::LoremFlickr](doc/lorem_flickr.md)
- [Faker::LoremPixel](doc/lorem_pixel.md)
- [Faker::Lovecraft](doc/lovecraft.md)
- [Faker::Markdown](doc/markdown.md)
- [Faker::Matz](doc/matz.md)
- [Faker::Measurement](doc/measurement.md)
- [Faker::MichaelScott](doc/michael_scott.md)
- [Faker::Military](doc/military.md)
- [Faker::MostInterestingManInTheWorld](doc/most_interesting_man_in_the_world.md)
- [Faker::Movie](doc/movie.md)
- [Faker::Music](doc/music.md)
- [Faker::Myst](doc/myst.md)
- [Faker::Name](doc/name.md)
- [Faker::Nation](doc/nation.md)
- [Faker::NatoPhoneticAlphabet](doc/nato_phonetic_alphabet.md)
- [Faker::NewGirl](doc/new_girl.md)
- [Faker::Number](doc/number.md)
- [Faker::Omniauth](doc/omniauth.md)
- [Faker::OnePiece](doc/one_piece.md)
- [Faker::Overwatch](doc/overwatch.md)
- [Faker::ParksAndRec](doc/parks_and_rec.md)
- [Faker::PhoneNumber](doc/phone_number.md)
- [Faker::Placeholdit](doc/placeholdit.md)
- [Faker::Pokemon](doc/pokemon.md)
- [Faker::PrincessBride](doc/princess_bride.md)
- [Faker::ProgrammingLanguage](doc/programming_language.md)
- [Faker::RickAndMorty](doc/rick_and_morty.md)
- [Faker::Robin](doc/robin.md)
- [Faker::RockBand](doc/rock_band.md)
- [Faker::RuPaul](doc/rupaul.md)
- [Faker::Science](doc/science.md)
- [Faker::Seinfeld](doc/seinfeld.md)
- [Faker::SiliconValley](doc/silicon_valley.md)
- [Faker::Simpsons](doc/simpsons.md)
- [Faker::SingularSiegler](doc/singular_siegler.md)
- [Faker::SlackEmoji](doc/slack_emoji.md)
- [Faker::Source](doc/source.md)
- [Faker::Space](doc/space.md)
- [Faker::StarTrek](doc/star_trek.md)
- [Faker::StarWars](doc/star_wars.md)
- [Faker::StrangerThings](doc/stranger_things.md)
- [Faker::String](doc/string.md)
- [Faker::Stripe](doc/stripe.md)
- [Faker::Superhero](doc/superhero.md)
- [Faker::SwordArtOnline](doc/sword_art_online.md)
- [Faker::Team](doc/team.md)
- [Faker::TheFreshPrinceOfBelAir](doc/the_fresh_prince_of_bel_air.md)
- [Faker::TheITCrowd](doc/the_it_crowd.md)
- [Faker::TheThickOfIt](doc/the_thick_of_it.md)
- [Faker::Time](doc/time.md)
- [Faker::TwinPeaks](doc/twin_peaks.md)
- [Faker::Twitter](doc/twitter.md)
- [Faker::Types](doc/types.md)
- [Faker::UmphreysMcgee](doc/umphreys_mcgee.md)
- [Faker::University](doc/university.md)
- [Faker::Vehicle](doc/vehicle.md)
- [Faker::VentureBros](doc/venture_bros.md)
- [Faker::VForVendetta](doc/v_for_vendetta.md)
- [Faker::Witcher](doc/witcher.md)
- [Faker::WorldCup](doc/world_cup.md)
- [Faker::WorldOfWarcraft](doc/world_of_warcraft.md)
- [Faker::Zelda](doc/zelda.md)
- [Customization](#customization)
- [Contributing](#contributing)
- [Contact](#contact)
- [License](#license)
## 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/stympy/faker.git', :branch => 'master'
```
## Usage
```ruby
require 'faker'
Faker::Name.name #=> "Christophe Bartell"
Faker::Internet.email #=> "kirsten.greenholt@corkeryfisher.info"
```
### 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
```
### 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"
```
## 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
Faker::Config.locale to the locale you want, and Faker will take care of the
rest.
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).
## License
This code is free to use under the terms of the MIT license.
|