Class: Faker::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/faker.rb

Direct Known Subclasses

Address, Adjective, Alphanumeric, Ancient, App, Appliance, Artist, Avatar, Bank, Barcode, Beer, Faker::Blockchain::Aeternity, Faker::Blockchain::Bitcoin, Faker::Blockchain::Ethereum, Faker::Blockchain::Tezos, Blood, Book, Faker::Books::CultureSeries, Faker::Books::Dune, Faker::Books::Lovecraft, Faker::Books::TheKingkillerChronicle, Boolean, BossaNova, Business, Camera, Cannabis, ChileRut, ChuckNorris, Code, Coffee, Coin, Color, Commerce, Company, Compass, Computer, Construction, Cosmere, Creature::Animal, Creature::Bird, Creature::Cat, Creature::Dog, Creature::Horse, Crypto, CryptoCoin, Currency, Date, DcComics, Demographic, Dessert, Device, DrivingLicence, Drone, Educator, ElectricalComponents, Emotion, Esport, Fantasy::Tolkien, File, Finance, Food, FunnyName, Game, Games::ClashOfClans, Games::Control, Games::DnD, Games::Dota, Games::ElderScrolls, Games::Fallout, Games::FinalFantasyXIV, Games::HalfLife, Games::Heroes, Games::HeroesOfTheStorm, Games::LeagueOfLegends, Games::Minecraft, Games::Myst, Games::Overwatch, Games::Pokemon, Games::SonicTheHedgehog, Games::StreetFighter, Games::SuperMario, Games::SuperSmashBros, Games::Tarkov, Games::Touhou, Games::WarhammerFantasy, Games::Witcher, Games::WorldOfWarcraft, Games::Zelda, Gender, GreekPhilosophers, HTML, Hacker, Hipster, Hobby, House, IdNumber, IndustrySegments, Internet, Internet::HTTP, Invoice, JapaneseMedia::Conan, JapaneseMedia::CowboyBebop, JapaneseMedia::Doraemon, JapaneseMedia::DragonBall, JapaneseMedia::FullmetalAlchemistBrotherhood, JapaneseMedia::KamenRider, JapaneseMedia::Naruto, JapaneseMedia::OnePiece, JapaneseMedia::StudioGhibli, JapaneseMedia::SwordArtOnline, Job, Json, Kpop, Locations::Australia, Lorem, LoremFlickr, Markdown, Marketing, Measurement, Military, Mountain, Movie, Movies::Avatar, Movies::BackToTheFuture, Movies::Departed, Movies::Ghostbusters, Movies::Hackers, Movies::HarryPotter, Movies::HitchhikersGuideToTheGalaxy, Movies::Hobbit, Movies::HowToTrainYourDragon, Movies::Lebowski, Movies::LordOfTheRings, Movies::PrincessBride, Movies::StarWars, Movies::TheRoom, Movies::Tron, Movies::VForVendetta, Music, Music::GratefulDead, Music::Hiphop, Music::Opera, Music::PearlJam, Music::Phish, Music::Prince, Music::RockBand, Music::Rush, Music::SmashingPumpkins, Music::UmphreysMcgee, Name, Nation, NationalHealthService, NatoPhoneticAlphabet, Number, Omniauth, PhoneNumber, Placeholdit, ProgrammingLanguage, Quote, Quotes::Chiquito, Quotes::Rajnikanth, Quotes::Shakespeare, Relationship, Religion::Bible, Restaurant, Science, SlackEmoji, Source, SouthAfrica, Space, Sport, Sports::Basketball, Sports::Chess, Sports::Football, Sports::Mountaineering, Sports::Volleyball, Stripe, Subscription, Superhero, Tea, Team, Theater, Time, Travel::Airport, Travel::TrainStation, TvShows::AquaTeenHungerForce, TvShows::Archer, TvShows::BigBangTheory, TvShows::BojackHorseman, TvShows::BreakingBad, TvShows::BrooklynNineNine, TvShows::Buffy, TvShows::Community, TvShows::DrWho, TvShows::DumbAndDumber, TvShows::FamilyGuy, TvShows::FinalSpace, TvShows::Friends, TvShows::Futurama, TvShows::GameOfThrones, TvShows::HeyArnold, TvShows::HowIMetYourMother, TvShows::MichaelScott, TvShows::NewGirl, TvShows::ParksAndRec, TvShows::RickAndMorty, TvShows::RuPaul, TvShows::Seinfeld, TvShows::SiliconValley, TvShows::Simpsons, TvShows::SouthPark, TvShows::Spongebob, TvShows::StarTrek, TvShows::Stargate, TvShows::StrangerThings, TvShows::Suits, TvShows::Supernatural, TvShows::TheExpanse, TvShows::TheFreshPrinceOfBelAir, TvShows::TheITCrowd, TvShows::TheOffice, TvShows::TheThickOfIt, TvShows::TwinPeaks, TvShows::VentureBros, Twitter, Types, University, Vehicle, Verb, VulnerabilityIdentifier, WorldCup

Constant Summary collapse

Numbers = 
Array(0..9)
ULetters = 
Array('A'..'Z')
LLetters = 
Array('a'..'z')
Letters = 
ULetters + LLetters
NOT_GIVEN = 
Object.new

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.flexible_key ⇒ Object (readonly)

Returns the value of attribute flexible_key.



49
50
51
 
# File 'lib/faker.rb', line 49

def flexible_key
  @flexible_key
end

Class Method Details

.bothify(string) ⇒ Object 



64
65
66
 
# File 'lib/faker.rb', line 64

def bothify(string)
  letterify(numerify(string))
end

.disable_enforce_available_locales ⇒ Object 



266
267
268
269
270
271
272
 
# File 'lib/faker.rb', line 266

def disable_enforce_available_locales
  old_enforce_available_locales = I18n.enforce_available_locales
  I18n.enforce_available_locales = false
  yield
ensure
  I18n.enforce_available_locales = old_enforce_available_locales
end

.fetch(key) ⇒ Object

Helper for the common approach of grabbing a translation with an array of values and selecting one of them.



108
109
110
111
112
113
114
115
 
# File 'lib/faker.rb', line 108

def fetch(key)
  fetched = sample(translate("faker.#{key}"))
  if fetched&.match(%r{^/}) && fetched.match(%r{/$}) # A regex
    regexify(fetched)
  else
    fetched
  end
end

.fetch_all(key) ⇒ Object

Helper for the common approach of grabbing a translation with an array of values and returning all of them.



119
120
121
122
123
124
125
126
127
 
# File 'lib/faker.rb', line 119

def fetch_all(key)
  fetched = translate("faker.#{key}")
  fetched = fetched.last if fetched.size <= 1
  if !fetched.respond_to?(:sample) && fetched.match(%r{^/}) && fetched.match(%r{/$}) # A regex
    regexify(fetched)
  else
    fetched
  end
end

.flexible(key) ⇒ Object 



189
190
191
 
# File 'lib/faker.rb', line 189

def flexible(key)
  @flexible_key = key
end

.generate(as_type, &block) ⇒ Object 



68
69
70
 
# File 'lib/faker.rb', line 68

def generate(as_type, &block)
  PositionalGenerator.new(as_type, &block).generate
end

.letterify(letter_string) ⇒ Object 



60
61
62
 
# File 'lib/faker.rb', line 60

def letterify(letter_string)
  letter_string.gsub('?') { sample(ULetters) }
end

.method_missing(mth, *args, &block) ⇒ Object

You can add whatever you want to the locale file, and it will get caught here. E.g., in your locale file, create a

name:
  girls_name: ["Alice", "Cheryl", "Tatiana"]

Then you can call Faker::Name.girls_name and it will act like #first_name



198
199
200
201
202
203
204
205
206
 
# File 'lib/faker.rb', line 198

def method_missing(mth, *args, &block)
  super unless flexible_key

  if (translation = translate("faker.#{flexible_key}.#{mth}"))
    sample(translation)
  else
    super
  end
end

.numerify(number_string, leading_zero: false) ⇒ Object

by default numerify results do not start with a zero



54
55
56
57
58
 
# File 'lib/faker.rb', line 54

def numerify(number_string, leading_zero: false)
  return number_string.gsub('#') { rand(10).to_s } if leading_zero

  number_string.sub('#') { rand(1..9).to_s }.gsub('#') { rand(10).to_s }
end

.parse(key) ⇒ Object

Load formatted strings from the locale, “parsing” them into method calls that can be used to generate a formatted translation: e.g., “#first_name #last_name”.



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
 
# File 'lib/faker.rb', line 132

def parse(key)
  fetched = fetch(key)
  parts = fetched.scan(/(\(?)#\{([A-Za-z]+\.)?([^}]+)\}([^#]+)?/).map do |prefix, kls, meth, etc|
    # If the token had a class Prefix (e.g., Name.first_name)
    # grab the constant, otherwise use self
    cls = kls ? Faker.const_get(kls.chop) : self

    # If an optional leading parentheses is not present, prefix.should == "", otherwise prefix.should == "("
    # In either case the information will be retained for reconstruction of the string.
    text = prefix

    # If the class has the method, call it, otherwise fetch the translation
    # (e.g., faker.phone_number.area_code)
    text += if cls.respond_to?(meth)
              cls.send(meth)
            else
              # Do just enough snake casing to convert PhoneNumber to phone_number
              key_path = cls.to_s.split('::').last.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
              fetch("#{key_path}.#{meth.downcase}")
            end

    # And tack on spaces, commas, etc. left over in the string
    text + etc.to_s
  end
  # If the fetched key couldn't be parsed, then fallback to numerify
  parts.any? ? parts.join : numerify(fetched)
end

.rand(max = nil) ⇒ Object 



256
257
258
259
260
261
262
263
264
 
# File 'lib/faker.rb', line 256

def rand(max = nil)
  if max.nil?
    Faker::Config.random.rand
  elsif max.is_a?(Range) || max.to_i.positive?
    Faker::Config.random.rand(max)
  else
    0
  end
end

.rand_in_range(from, to) ⇒ Object

Generates a random value between the interval



213
214
215
216
 
# File 'lib/faker.rb', line 213

def rand_in_range(from, to)
  from, to = to, from if to < from
  rand(from..to)
end

.regexify(reg) ⇒ Object

Given a regular expression, attempt to generate a string that would match it. This is a rather simple implementation, so don’t be shocked if it blows up on you in a spectacular fashion.

It does not handle ., *, unbounded ranges such as 1,, extensions such as (?=), character classes, some abbreviations for character classes, and nested parentheses.

I told you it was simple. :) It’s also probably dog-slow, so you shouldn’t use it.

It will take a regex like this:

/^[A-PR-UWYZ0-9][AEHMNPRTVXY0-9]?? 1,2[ABD-HJLN-UW-Z]2$/

and generate a string like this:

“U3V 3TP”



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/faker.rb', line 91

def regexify(reg)
  reg = reg.source if reg.respond_to?(:source) # Handle either a Regexp or a String that looks like a Regexp
  reg
    .gsub(%r{^/?\^?}, '').gsub(%r{\$?/?$}, '') # Ditch the anchors
    .gsub(/\{(\d+)\}/, '{\1,\1}').gsub('?', '{0,1}') # All {2} become {2,2} and ? become {0,1}
    .gsub(/(\[[^\]]+\])\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                # [12]{1,2} becomes [12] or [12][12]
    .gsub(/(\([^)]+\))\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                 # (12|34){1,2} becomes (12|34) or (12|34)(12|34)
    .gsub(/(\\?.)\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                      # A{1,2} becomes A or AA or \d{3} becomes \d\d\d
    .gsub(/\((.*?)\)/) { |match| sample(match.gsub(/[()]/, '').split('|')) } # (this|that) becomes 'this' or 'that'
    .gsub(/\[([^\]]+)\]/) { |match| match.gsub(/(\w-\w)/) { |range| sample(Array(Range.new(*range.split('-')))) } } # All A-Z inside of [] become C (or X, or whatever)
    .gsub(/\[([^\]]+)\]/) { |_match| sample(Regexp.last_match(1).chars) } # All [ABC] become B (or A or C)
    .gsub('\d') { |_match| sample(Numbers) }
    .gsub('\w') { |_match| sample(Letters) }
end

.resolve(value) ⇒ Object

If an array or range is passed, a random value will be selected. All other values are simply returned.



220
221
222
223
224
225
226
 
# File 'lib/faker.rb', line 220

def resolve(value)
  case value
  when Array then sample(value)
  when Range then rand value
  else value
  end
end

.respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:



208
209
210
 
# File 'lib/faker.rb', line 208

def respond_to_missing?(method_name, include_private = false)
  super
end

.sample(list, num = nil) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/faker.rb', line 236

def sample(list, num = nil)
  if list.respond_to?(:sample)
    if num
      list.sample(num, random: Faker::Config.random)
    else
      list.sample(random: Faker::Config.random)
    end
  else
    list
  end
end

.shuffle(list) ⇒ Object 



248
249
250
 
# File 'lib/faker.rb', line 248

def shuffle(list)
  list.shuffle(random: Faker::Config.random)
end

.shuffle!(list) ⇒ Object 



252
253
254
 
# File 'lib/faker.rb', line 252

def shuffle!(list)
  list.shuffle!(random: Faker::Config.random)
end

.translate(*args, **opts) ⇒ Object

Call I18n.translate with our configured locale if no locale is specified



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/faker.rb', line 162

def translate(*args, **opts)
  opts[:locale] ||= Faker::Config.locale
  opts[:raise] = true
  I18n.translate(*args, **opts)
rescue I18n::MissingTranslationData
  opts[:locale] = :en

  # Super-simple fallback -- fallback to en if the
  # translation was missing.  If the translation isn't
  # in en either, then it will raise again.
  disable_enforce_available_locales do
    I18n.translate(*args, **opts)
  end
end

.unique(max_retries = 10_000) ⇒ self

Return unique values from the generator every time.

Parameters:

  • max_retries (Integer) (defaults to: 10_000) —

    The max number of retries that should be done before giving up.

Returns:

  • (self) 


232
233
234
 
# File 'lib/faker.rb', line 232

def unique(max_retries = 10_000)
  @unique ||= UniqueGenerator.new(self, max_retries)
end

.with_locale(tmp_locale = nil, &block) ⇒ Object

Executes block with given locale set.



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/faker.rb', line 178

def with_locale(tmp_locale = nil, &block)
  current_locale = Faker::Config.own_locale
  Faker::Config.locale = tmp_locale

  disable_enforce_available_locales do
    I18n.with_locale(tmp_locale, &block)
  end
ensure
  Faker::Config.locale = current_locale
end