README

Your Random Data Source

Installation

composer require johnykvsky/dummygenerator --dev

About

DummyGenerator is dummy/fake data generator for PHP. It's a fork of Faker, heavily rewritten at core, but overall is same easy to use. In example:

$generator = DummyGenerator::create(); // all extensions are loaded
echo $generator->firstName();

Documentation

Full documentation is available in docs/index.md

But why...?

Faker died for our because of being hard to maintain as mentioned in sunsetting-faker. Faker 2.0 seems to be dead because of "death by committee" kind of stuff.

I needed simple dummy data generator for PHP 8.3, with modern architecture in mind. This is how DummyGenerator came to life.

Changes in compare to Faker

• required PHP >= 8.3
• PHPStan level 8 friendly
• PHPUnit tests for core and extensions (yep, some just check for not empty, but hey, it's random data)
• all mt_rand / array_rand replaced with \Random\Randomizer
• no static methods, only one magic method (__call() in generator)
• interfaces and dependency injection for everything (all core implementations can be replaced with different ones)
• implementations can be changed on the fly with withDefinition()
• language providers removed from core, that makes generator ~9.5Mb smaller
• changed Uuid, it supports v4 only, use uuid4()
• removed database providers (core is only for dummy data generation)
• removed HmlLorem
• removed File::filePath() since it was interacting with system, not only generating dummy data
• regexify has been removed from core as it is not used any more, it's available in dummyproviders if needed
• added Enum, to get random values from PHP enums
• added String, to generate random string from given pool (as text() is not that good for short lengths)
• added support for SystemClock, PSR-20 implementation of Clock, used in date/time generation
• added AnyDateTime, as alternative/replacement for DateTime extension (see docs for more info)
• some extensions have updated properties, i.e. list of available currencies

Worth noticing:

• DateTime extension now also supports DateTimeInterface for methods params (not only strings)
• boolean() supports also float values from range 0 to 1, i.e. ->boolean(0.001) for 0.1% chance

This package also fixes following problems with FakerPHP:

• __destruct() messing up with seed()
• bug with unique()->optional() causing massive memory usage
• not allowing combination of valid and unique (more about chaining in strategies)
• Factroy::create() sharing state with other instances
• and other various items, mostly fixed by with switching to \Random\Randomizer and making proper use of it

But most of all: this is written from scratch, no looking back at old Fake architecture. Core is just an organizer (knows nothing about extensions or clock), depends on Container, which holds everything:

• Strategy (Unique, Valid, Chance...)
• Extensions (Person, Address, Internet...)
• Calculators (Iban, Ean...)
• Randomizer (\Random\Randomizer, Xoshiro256StarStar engine for seed...`)
• Clock (PSR-20)
• Replacer

And all that can be replaced with your own implementation. Check overview for more info.

Languages

One of main points of DummyGenerator is to keep core language agnostic. This is why all languages has been removed from core.

However, core use general English language for generating data.

Person extension provides only ~15 names than can be used as first name, last name, part of email etc. If you want more, check dummyproviders to get full providers for en_US,en_GB and pl_PL. I have created them to show how to make them / convert from old Faker, to allow anyone to work on other languages.

Keep in mind:

• core will stay language agnostic with some small samples (i.e. mentioned names) in English
• I have no current plans to support any language
• I have no current plans to work on extending/improving existing language providers.
• if someone like to make a PR to improve/extend one of mentioned languages - I will gladly look at it.
• I will not accept PRs with other languages - but I will gladly link in this readme to repositories with them.

Why PHP >= 8.3

Because of introduced in PHP 8.3:

• Randomizer::getFloat()
• Randomizer::getBytesFromString()
• and not so important but nice: typed class constants

What is this fake / dummy data

When writing tests or populating test database you need to came up with various data, like first name, last name, some dates, maybe description, location coordinates and so on. When you deal with multi-language site and want to have it also multilanguage - you need to came up with every language names or address format.

All of that can be done by hand, but it's much easier to do $generator->firstName() and just don't care about what name it will be. Load provider and don't care about given locale names or phone formats.

Another use case - imagine you have description with 100 chars limit and want to test if it properly gives error when more is passed - instead of copying some text you can just use $generator->text(150) to get ~150 characters long text.

Last but not least - it make sure your tests will get random data on each run, not every single time same value. If your code is good and tests correct - then it should be no problem. If tests start failing from time to time - then what you think, where is the problem:

• with code
• with tests
• with random data, it should not be random

I leave answer to you. And yes, there might be cases when data should not be random, but usually it's not that case ;)

Other stuff

There are two Randomizer implementations available:

• default Randomizer
• additional XoshiroRandomizer, which supports seed - to be used in tests

There is script\ExtensionsDocs.php that can be used to generate list of available extensions and their methods (look at generate-spec.php)

Since PHPUnit is still missing --repeat, in repository phpunit-repeat you can find Linux shell script for running tests multiple times.

TODO

• cleanup tests