Categorygithub.com/icrowley/fake
modulepackage
0.0.0-20240710202011-f797eb4a99c0
Repository: https://github.com/icrowley/fake.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
16
Dependents
181
Files
1.8k SLOC

# README

Build Status Godoc license

Fake

Fake is a fake data generator for Go (Golang), heavily inspired by the forgery and ffaker Ruby gems.

About

Most data and methods are ported from forgery/ffaker Ruby gems. For the list of available methods please look at https://godoc.org/github.com/icrowley/fake. Currently english and russian languages are available.

Fake embeds samples data files unless you call UseExternalData(true) in order to be able to work without external files dependencies when compiled, so, if you add new data files or make changes to existing ones don't forget to regenerate data.go file using github.com/mjibson/esc tool and esc -o data.go -pkg fake data command (or you can just use go generate command if you are using Go 1.4 or later).

Install

go get github.com/icrowley/fake

Import

import (
  "github.com/icrowley/fake"
)

Documentation

Documentation can be found at godoc:

https://godoc.org/github.com/icrowley/fake

Test

To run the project tests:

cd test
go test

Examples

name := fake.FirstName()
fullname := fake.FullName()
product := fake.Product()

Changing language:

err := fake.SetLang("ru")
if err != nil {
  panic(err)
}
password := fake.SimplePassword()

Using english fallback:

err := fake.SetLang("ru")
if err != nil {
  panic(err)
}
fake.EnFallback(true)
password := fake.Paragraph()

Using external data:

fake.UseExternalData(true)
password := fake.Paragraph()

Author

Dmitry Afanasyev, http://twitter.com/i_crowley [email protected]

Maintainers

Dmitry Moskowski https://github.com/corpix

# Functions

Brand generates brand name.
Character generates random character in the given language.
Characters generates from 1 to 5 characters in the given language.
CharactersN generates n random characters in the given language.
City generates random city.
Color generates color name.
Company generates company name.
Continent generates random continent.
Country generates random country.
CreditCardNum generated credit card number according to the card number rules.
CreditCardType returns one of the following credit values: VISA, MasterCard, American Express and Discover.
Currency generates currency name.
CurrencyCode generates currency code.
Day generates day of the month.
Digits returns from 1 to 5 digits as a string.
DigitsN returns n digits as a string.
Dir returns a http.Filesystem for the embedded assets on a given prefix dir.
DomainName generates random domain name.
DomainZone generates random domain zone.
EmailAddress generates email address.
EmailBody generates random email body.
EmailSubject generates random email subject.
EnFallback sets the flag that allows fake to fallback to englsh samples if the ones for the used languaged are not available.
FemaleFirstName generates female first name.
FemaleFullName generates female full name it can occasionally include prefix or suffix.
FemaleFullNameWithPrefix generates prefixed female full name if prefixes for the given language are available.
FemaleFullNameWithSuffix generates suffixed female full name if suffixes for the given language are available.
FemaleLastName generates female last name.
FemalePatronymic generates female patronymic.
FirstName generates first name.
FS returns a http.Filesystem for the embedded assets.
FSByte returns the named file from the embedded assets.
FSMustByte is the same as FSByte, but panics if name is not present.
FSMustString is the string version of FSMustByte.
FSString is the string version of FSByte.
FullName generates full name it can occasionally include prefix or suffix.
FullNameWithPrefix generates prefixed full name if prefixes for the given language are available.
FullNameWithSuffix generates suffixed full name if suffixes for the given language are available.
Gender generates random gender.
GenderAbbrev returns first downcased letter of the random gender.
GetLangs returns a slice of available languages.
HexColor generates hex color name.
HexColorShort generates short hex color name.
Industry generates industry name.
IPv4 generates IPv4 address.
IPv6 generates IPv6 address.
JobTitle generates job title.
Language generates random human language.
LastName generates last name.
Latitude generates latitude (from -90.0 to 90.0).
LatitudeDegrees generates latitude degrees (from -90 to 90).
LatitudeDirection generates latitude direction (N(orth) o S(outh)).
LatitudeMinutes generates latitude minutes (from 0 to 60).
LatitudeSeconds generates latitude seconds (from 0 to 60).
Longitude generates longitude (from -180 to 180).
LongitudeDegrees generates longitude degrees (from -180 to 180).
LongitudeDirection generates (W(est) or E(ast)).
LongitudeMinutes generates (from 0 to 60).
LongitudeSeconds generates (from 0 to 60).
MaleFirstName generates male first name.
MaleFullName generates male full name it can occasionally include prefix or suffix.
MaleFullNameWithPrefix generates prefixed male full name if prefixes for the given language are available.
MaleFullNameWithSuffix generates suffixed male full name if suffixes for the given language are available.
MaleLastName generates male last name.
MalePatronymic generates male patronymic.
Model generates model name that consists of letters and digits, optionally with a hyphen between them.
Month generates month name.
MonthNum generates month number (from 1 to 12).
MonthShort generates abbreviated month name.
Paragraph generates paragraph.
Paragraphs generates from 1 to 5 paragraphs.
ParagraphsN generates n paragraphs.
Password generates password with the length from atLeast to atMOst charachers, allow* parameters specify whether corresponding symbols can be used.
Patronymic generates patronymic.
Phone generates random phone number using one of the formats format specified in phone_format file.
Product generates product title as brand + product name.
ProductName generates product name.
Seed uses the provided seed value to initialize the internal PRNG to a deterministic state.
Sentence generates random sentence.
Sentences generates from 1 to 5 random sentences.
SentencesN generates n random sentences.
SetLang sets the language in which the data should be generated returns error if passed language is not available.
SimplePassword is a wrapper around Password, it generates password with the length from 6 to 12 symbols, with upper characters and numeric symbols allowed.
State generates random state.
StateAbbrev generates random state abbreviation.
Street generates random street name.
StreetAddress generates random street name along with building number.
Title generates from 2 to 5 titleized words.
TopLevelDomain generates random top level domain.
UseExternalData sets the flag that allows using of external files as data providers (fake uses embedded ones by default).
UserAgent generates a random user agent.
UserName generates user name in one of the following forms first name + last name, letter + last names or concatenation of from 1 to 3 lowercased words.
WeekDay generates name ot the week day.
WeekdayNum generates number of the day of the week.
WeekDayShort generates abbreviated name of the week day.
Word generates random word.
Words generates from 1 to 5 random words.
WordsN generates n random words.
Year generates year using the given boundaries.
Zip generates random zip code using one of the formats specifies in zip_format file.

# Variables

ErrNoLanguageFn is the error that indicates that given language is not available.
ErrNoSamplesFn is the error that indicates that there are no samples for the given language.