fakedata

Library for producing fake data

https://github.com/psibi/fakedata#readme

Version on this page:0.8.0
LTS Haskell 22.37:1.0.3
Stackage Nightly 2023-12-26:1.0.3
Latest on Hackage:1.0.3

See all snapshots fakedata appears in

BSD-3-Clause licensed by Sibi Prabakaran
Maintained by [email protected]
This version can be pinned in stack with:fakedata-0.8.0@sha256:9755f429a449a58f67fd43e72f4f2f1115f5b97dbc8898b9adc354c1da8d7d04,21297

Module documentation for 0.8.0

Used by 1 package in lts-18.6(full list with versions):
hedgehog-fakedata

fakedata Hackage Stackage Nightly Stackage LTS Build Status

Table of Contents

fakedata

This library is a port of Ruby’s faker. It’s a library for producing fake data such as names, addressess and phone numbers. Note that it directly uses the source data from that library, so the quality of fake data is quite high!

Tutorial

Generating address

~/g/fakedata (master) $ stack ghci
λ> import Faker.Address
λ> address <- generate fullAddress
λ> address
"Apt. 298 340 Ike Mission, Goldnertown, FL 19488-9259"

Generating name

λ> fullName <- generate name
λ> fullName
"Sherryl Steuber"

Generate quotes from the movie Back to the Future

λ> import Faker.Movie.BackToTheFuture
λ> import Faker.Combinators
λ> qs <- generateNonDeterministic $ listOf 5 quotes
λ> qs
[ "Yes. Yes. I'm George. George McFly. I'm your density. I mean, your destiny."
, "Hello? Hello? Anybody home? Huh? Think, McFly. Think! I gotta have time to get them retyped. Do you realize what would happen if I hand in my reports in your handwriting? I'll get fired. You wouldn't want that to happen, would ya? Would ya?"
, "Lorraine. My density has brought me to you."
, "See you in about 30 years."
, "You really think I ought to swear?"
]

Combining Fake datas

{-#LANGUAGE RecordWildCards#-}

import Faker
import Faker.Name
import Faker.Address
import Data.Text

data Person = Person {
    personName :: Text,
    personAddress :: Text
} deriving (Show, Eq)

fakePerson :: Fake Person
fakePerson = do
    personName <- name
    personAddress <- fullAddress
    pure $ Person{..}

main :: IO ()
main = do
    person <- generate fakePerson
    print person

And on executing them:

$ stack name.hs
Person
  { personName = "Sherryl Steuber"
  , personAddress = "Apt. 298 340 Ike Mission, Goldnertown, FL 19488-9259"
  }

You would have noticed in the above output that the name and address are the same as generated before in the GHCi REPL. That’s because, by default all the generated data are deterministic. If you want a different set of output each time, you would have to modify the random generator output:

main :: IO ()
main = do
    gen <- newStdGen
    let settings = setRandomGen gen defaultFakerSettings
    person <- generateWithSettings settings fakePerson
    print person

And on executing the program, you will get a different output:

Person
  { personName = "Ned Effertz Sr."
  , personAddress = "Suite 158 1580 Schulist Mall, Schulistburgh, NY 15804-3392"
  }

The above program can be even minimized like this:

main :: IO ()
main = do
    let settings = setNonDeterministic defaultFakerSettings
    person <- generateWithSettings settings fakePerson
    print person

Or even better:

main :: IO ()
main = do
    person <- generateNonDeterministic fakePerson
    print person

Combinators

listOf

λ> import Faker.Address
λ> item <- generateNonDeterministic $ listOf 5 country
λ> item
["Ecuador","French Guiana","Faroe Islands","Canada","Armenia"]

oneOf

λ> item <- generate $ oneof [country, fullAddress]
λ> item
"Suite 599 599 Brakus Flat, South Mason, MT 59962-6876"

suchThat

λ> import qualified Faker.Address as AD
λ> item :: Text <- generate $ suchThat AD.country (\x -> (T.length x > 5))
λ> item
"Ecuador"
λ> item :: Text <- generate $ suchThat AD.country (\x -> (T.length x > 8))
λ> item
"French Guiana"

For seeing the full list of combinators, see the module documentation of Faker.Combinators.

Comparision with other libraries

There are two other libraries in the Hackage providing fake data:

The problem with both the above libraries is that the library covers only a very small amount of fake data source. I wanted to have an equivalent functionality with something like faker. Also, most of the combinators in this packages has been inspired (read as taken) from the fake library. Also, fakedata offers fairly good amount of support of different locales. Also since we rely on an external data source, we get free updates and high quality data source with little effort. Also, it’s easier to extend the library with it’s own data source if we want to do it that way.

Acknowledgments

Benjamin Curtis for his Ruby faker library from which the data source is taken from.

Icons made by Freepik from Flaticon.

Changes

Changelog for fakedata

0.8.0

Breaking changes

  • Behavior of Monad instances changed. Monad instance by default will not change the underlying StdGen by default. It will change only when you do setNonDeterministic for the settings. If you use functions like listOf with generate function then all the values would be the same:
λ> import Faker.Coffee
λ> qs <- generate $ listOf 5 blendName
λ> qs
["The Treat","The Treat","The Treat","The Treat","The Treat"]

Now instead you have to use generateNonDeterministic function:

λ> qs <- generateNonDeterministic $ listOf 5 blendName
λ> qs
["The Treat","Evening Cowboy","Veranda Forrester","Blue Choice","Veranda Cake"]
  • Faker.Dnd: Remove species and background function. Other new function introduced. See Module update section.
  • Faker.Game.HeroesOfTheStorm: Rename classes function to classNames

New modules introduced

  • Faker.TvShow.BigBangTheory
  • Faker.Barcode
  • Faker.DrivingLicense
  • Faker.Drone
  • Faker.TvShow.Futurama
  • Faker.Game.Minecraft
  • Faker.Music.Prince
  • Faker.Music.Rush
  • Faker.Game.StreetFighter
  • Faker.JapaneseMedia.StudioGhibli

Locale Improvements

  • en-GB: Faker.Address.postcode
  • nl: Faker.Address.postcode
  • ru: Faker.Company.name
  • de-AT: PhoneNumber.countryCode
  • de-CH: PhoneNumber.countryCode
  • de: PhoneNumber.countryCode
  • en-au-ocker: PhoneNumber.countryCode
  • en-IND: PhoneNumber.countryCode
  • en-MS: PhoneNumber.countryCode
  • en-NEP: PhoneNumber.countryCode
  • en-NZ: PhoneNumber.countryCode
  • en-SG: PhoneNumber.countryCode
  • es: Vehicle.licensePlate
  • fr-CA: PhoneNumber.cellPhoneFormat, PhoneNumber.countryCode
  • fr: PhoneNumber.countryCode, Compass.direction
  • id: PhoneNumber.countryCode
  • it: PhoneNumber.countryCode
  • ko: Color.name, Space.planet, Space.galaxy, Gender.binaryTypes
  • nb-NO: PhoneNumber.countryCode
  • pt: PhoneNumber.countryCode
  • ru: PhoneNumber.countryCode
  • sk: PhoneNumber.countryCode

Module updates

  • Faker.TvShow.AquaTeenHungerForce: quote
  • Faker.DND: cities, languages, meleeWeapons, monsters, races, rangedWeapons
  • Faker.TvShow.Simpsons: episodeTitles
  • Faker.Movie.StarWars: quotesKyloRen

Data Update

The following data sources which the libraries uses has been updated:

  • en/animal.yml
  • en/aqua_teen_hunger_force.yml
  • en-AU.yml
  • en/bank.yml
  • en-GB.yml
  • en-IND.yml
  • en/star_trek.yml
  • en-US.yml
  • fi-FI.yml
  • fr-CA.yml
  • fr-CH.yml
  • fr.yml
  • id.yml
  • it.yml

0.7.1

  • Add combinator for fakeBoundedEnum In Faker.Combinators
  • Improved Haddock documentation for Faker.Combinators

0.7.0

  • Add support for regex fake value generation. Useful for postcode functions for different locales.
  • Improve documentation of Faker.Combinators.
  • de-CH locale update: lastName function works now.
  • New function in Faker.Music.Phish module: albums, musicians
  • New function in Faker.Address: cityWithState
  • New function in Faker.Movie: title

Data Update

The following data sources which the libraries uses has been updated:

  • heroes_of_the_storm.yml
  • house.yml
  • name.yml
  • one_piece.yml

New modules introduced

  • Faker.Blood
  • Faker.Chiquito
  • Faker.Computer
  • Faker.Game.Control
  • Faker.Movie.Departed
  • Faker.Dnd
  • Faker.Music.PearlJam
  • Faker.Rajnikanth
  • Faker.Show
  • Faker.TvShow.Suits
  • Faker.WarhammerFantasy

Locale Improvements

  • en-AU:
    • Locale has updated which leads to working of newer functions: Faker.Name.prefix, Faker.University.name, Faker.Bank.name
  • en-CA: Faker.Address.postcode works now.
  • en-GB: formats field has been updated.
  • fr-CA: Faker.Address.postcode works now.
  • ko: Supports Faker.Commerce moudle now.

Breaking changes

  • Faker.Music.Phish module:
    • Rename song function to songs

0.6.1

  • Add Semigroup and Monoid instances to Fake
  • Doc fix: Remove broken links

0.6.0

  • Fix API for “ar” locale. Add test coverage.
  • Bug fixed in the following locales: ca, bg, da-DK, en-NEP, en-ZA, fr-CA, fr-CH, fr, hy, id, ja, pt, uk, zh-CN, zh-TW
  • New function to Address module: mailBox
  • Update in following data sources:
    • en/color.yml
    • en-NZ.yml
    • en/overwatch.yml
    • en/phone_number.yml
    • en/shakespeare.yml
    • fa.yml
    • pt-BR.yml
  • New function in Educator module: degree, courseName
  • New function in Gender module: shortBinaryTypes

Breaking changes

  • Educator module:
    • Rename tertiaryDegreeSubject to subject
    • Rename name function to schoolName
    • Rename tertiaryType function to tertiaryUniversityType.

0.5.0

  • Move remaining internal modules into other-module: Config, Faker.TH

0.4.0

  • Move Provider modules into other-modules. This makes the haddock much more readable.
  • Update to various en data sources: color.yml, super_smash_bros.
  • Fix name of FakerTvShow.DrWho module: villains (from villians).
  • New locale addition: en-TH, th
  • Modification of other locales: fr-CA, ja

0.3.1

  • Make it compatbile with ghc-8.8.1

0.3.0

  • Update fake data source
  • Improve performance and add test coverage
  • Fix various bugs
  • Add brands function to the module Faker.Cannabis

0.2.2

  • Add meepoQuote function to the module Faker.Game.Dota
  • Add Faker.Music.Opera module
  • Update fake data source

0.2.1

  • Fix bug in Book module

0.2.0

  • Add sicCode function in Company module
  • New Construction module
  • New Basketball module
  • New Horse module
  • New Finance module
  • Move Football under Sport module
  • Bug fixes in some file formats
  • Fix bugs in the Creature module
  • Add Development.md for new contributors

0.1.0.0

Initial version released