fake

package module
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2022 License: MIT Imports: 9 Imported by: 1

README

Toolkit for fake data generation in Golang

This library aims at facilitating creating fake data.

Random data available:

  • Name
  • Postal address
  • Paragraph
  • Email address
  • User agent
  • Basic user (with name, email and ID)
  • IP address
  • Unique ID (UUID v4)
  • URL

Todo:

  • Add unit tests

Possible improvements:

  • Be able to only generate random IP addresses within a certain range
  • Be able to control paragraph length
  • Be able to generate locally consistent data (phone number / address / name / etc. from a given country)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EmailAddress added in v0.0.2

func EmailAddress(config *EmailAddressConfig) mail.Address

func FirstName added in v0.0.2

func FirstName(possibleNames []string) string

func HTTPUserAgent added in v0.0.4

func HTTPUserAgent(sampleUserAgents []string) string

func IPAddress added in v0.0.2

func IPAddress() net.IPAddr

func LastName added in v0.0.2

func LastName(possibleNames []string) string

func Name added in v0.0.2

func Name(possibleFirstNames, possibleLastNames []string) string

func Paragraph added in v0.0.2

func Paragraph(sampleParagraphs []string) string

func PostalAddress added in v0.0.2

func PostalAddress(addressGenerator geo.AddressGenerator) geo.Address

func PostalAddressString added in v0.0.2

func PostalAddressString(addressGenerator geo.AddressGenerator) string

func URL added in v0.0.2

func URL(hosts []string, pagePaths []string) *url.URL

Types

type BasicUser added in v0.0.3

type BasicUser struct {
	ID           string       `json:"id"`
	EmailAddress mail.Address `json:"email_address"`
	FirstName    string       `json:"first_name"`
	LastName     string       `json:"last_name"`
}

func User

func User(config *BasicUserConfig) BasicUser

type BasicUserConfig added in v0.0.3

type BasicUserConfig struct {
	PossibleFirstNames     []string
	PossibleLastNames      []string
	PossibleEmailProviders []string
	MinAge                 int
	MaxAge                 int
}

type EmailAddressConfig added in v0.0.2

type EmailAddressConfig struct {
	FirstNameList               []string
	LastNameList                []string
	EmailProviderDomainNameList []string
}

type FrenchAddressGenerator

type FrenchAddressGenerator struct {
	FrenchCities  []string
	FrenchStreets []string
	PostalCodes   []string
	StreetNumbers []string
	CountryName   string
	CountryCode   string
}

func (*FrenchAddressGenerator) Generate

func (frenchAddressGenerator *FrenchAddressGenerator) Generate() geo.Address

func (*FrenchAddressGenerator) String

func (frenchAddressGenerator *FrenchAddressGenerator) String() string

Directories

Path Synopsis
examples
internal
geo
pkg
sample
package sample provides real-world data samples
package sample provides real-world data samples

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL