README

Generate realistic test data.

Why?

I work with very data-intensive applications. Sometimes I need large quantities of test data for building test cases and seeding web services, databases, online forms, etc. I wrote this library to assist with this.

With a simple loop, I can generate a database representing 100,000 people to use in my development and testing.

Base data sources included in this library

US City/County/State/Zip Database
First/Last Names from US Census
Common U.S. Street Names

Mock Data Generation

Many different types of mock data can be generated with this library. From basic building blocks like numbers and dates to a Person with just about every attribute you need from a Date of Birth to Driver's License and Credit Card.

Data Realism

This library is designed to create very realistic-looking data.

If generating a person:
- If a state is specified:
  - The city will be a valid city in that state
  - The area code, zip, and county will be correct for that city
  - The SSN will be in a valid range for that state
- The email address will contain some portion of their name
- First/middle name will be appropriate for the selected gender
- For credit card numbers:
  - The prefix and length will match the type of card generated (MasterCard, Visa, etc.)

Usage

$generator = new joshmoody\Mock\Generator();

$person = $generator->getPerson('AR');
print_r($person);

Example output:

joshmoody\Mock\Entities\Person Object
(
    [guid] => d36fb161-39a8-ca74-9564-e5f903b6bad1
    [unique_hash] => f7382ef385fccc215ac1f4cd3f975ad63898556f
    [name] => joshmoody\Mock\Entities\FullName Object
        (
            [first] => Leonard
            [middle] => Gordon
            [last] => Roberts
            [gender] => M
        )

    [company] => Martin Auto
    [address] => joshmoody\Mock\Entities\Address Object
        (
            [line_1] => 6496 6th Street
            [line_2] =>
            [city] => Fort Smith
            [zip] => 72903
            [county] => Sebastian
            [state] => joshmoody\Mock\Entities\State Object
                (
                    [code] => AR
                    [name] => Arkansas
                )

        )

    [address2] => joshmoody\Mock\Entities\Address Object
        (
            [line_1] => 4126 Berkshire Drive
            [line_2] => Suite 3352
            [city] => Fort Smith
            [zip] => 72903
            [county] => Sebastian
            [state] => joshmoody\Mock\Entities\State Object
                (
                    [code] => AR
                    [name] => Arkansas
                )

        )

    [internet] => joshmoody\Mock\Entities\Internet Object
        (
            [domain] => martinauto.com
            [username] => lroberts
            [email] => leonard@yahoo.com
            [url] => http://www.martinauto.com
            [ip] => 201.254.71.153
        )

    [phone] => stdClass Object
        (
            [home] => 479-123-0338
            [mobile] => 479-761-9748
            [work] => 479-551-3998
        )

    [ssn] => 429836996
    [dln] => joshmoody\Mock\Entities\DriverLicense Object
        (
            [number] => 927684836
            [state] => AR
            [expiration] => 06/2017
        )

    [credit_card] => joshmoody\Mock\Entities\CreditCard Object
        (
            [type] => American Express
            [number] => 347716769562193
            [expiration] => 03/2015
        )

    [bank_account] => joshmoody\Mock\Entities\BankAccount Object
        (
            [type] => Checking
            [name] => First National
            [account] => 935060029
            [routing] => 075938878
        )

    [dob] => DateTime Object
        (
            [date] => 1994-05-13 03:56:44.000000
            [timezone_type] => 3
            [timezone] => UTC
        )
)

Each type of data element above may be generated independently.

Names

Get a full name (first, middle, last, gender).

Why is gender is included as a property of the name? In the U.S., first and middle names are usually closely associated with gender.

$name = $generator->getFullName();

/*
joshmoody\Mock\Entities\FullName Object
(
    [first] => Laurie
    [middle] => Joyce
    [last] => Wilson
    [gender] => F
)
*/

Or get parts of a name:

$first = $generator->getFirstName('M'); // M=Male, F=Female, null = random.
/*
string(8) "Clarence"
*/

$middle = $generator->getMiddleName('M'); // M=Male, F=Female, null = random.
/*
string(4) "Dale"
*/

$last = $generator->getLastName();
/*
string(6) "Rogers"
*/

Addresses

Get a full address with street, city, state, zip

$address = $generator->getAddress();

/*
joshmoody\Mock\Entities\Address Object
(
    [line_1] => 2835 Hamilton Street
    [line_2] => 
    [city] => Hyndman
    [zip] => 15545
    [county] => Bedford
    [state] => joshmoody\Mock\Entities\State Object
        (
            [code] => PA
            [name] => Pennsylvania
        )

)
*/

Or gets parts of an address:

$street = $generator->getStreet();
/*
string(15) "2162 9th Street"
*/	

$apartment = $generator->getApartment();
/*
string(9) "Apt. 6677"
*/

$city = $generator->getCity('AR');
/*
string(8) "Little Rock"
*/

$state = $generator->getState();
/*
joshmoody\Mock\Entities\State Object
(
    [code] => AR
    [name] => Arkansas
)
*/

$zip = $generator->getZip('AR');
/*
string(5) "72201"
*/

Phone Numbers

$phone = $generator->getPhone([$state_code = false, $zip = false, $include_toll_free = false]);
/*
string(12) "908-519-1084"
*/

Internet

$internet = $generator->getInternet([$person_name = null, $company = null]);
/*
joshmoody\Mock\Entities\Internet Object
(
    [domain] => martinez.us
    [username] => swilliams
    [email] => stacey.williams@gmail.com
    [url] => https://martinez.us
    [ip] => 157.116.10.90
)
*/

$domain = $generator->getDomain($domain = null);
/*
string(8) "dean.com"
*/

$username = $generator->getUsername([$person_name = null]);
/*
string(14) "pedro.thompson"
*/

$email = $generator->getEmail([$person_name = null, $domain = null]);
/*
string(20) "fred.harrison@me.com"
*/

$url = $generator->getUrl();
/*
string(19) "http://hernandez.us"
*/

$ip = $generator->getIp();
/*
string(13) "101.114.68.26"
*/

Random Data

In addition to realistic data generation, you can also use this library to easily pick a random value from an array.

$color = $generator->fromArray(['Red' , 'White', 'Blue']);
/*
string(3) "Red"
*/

Or get a boolean.

$bool = $generator->getBool(); // Returns bool(true) or bool(false);
/*
bool(false)
*/

Or get a string representation of a boolean. You define the return values for true/false

$yes_no = $generator->getBool('Yes', 'No'); // Returns string(Yes) or string(No)
/*
string(3) "Yes"
*/

$aye_nay = $generator->getBool('Aye', 'Nay'); // returns string(Aye) or string (Nay)
/*
 string(3) "Nay"
*/

Requirements

MySQL or SQlite
PHP >= 7.2 with SQlite PDO extension.

Installation

Installation of this package is easy with Composer. If you aren't familiar with the Composer Dependency Manager for PHP, you should read this first.

composer require joshmoody/mock-data

Zero Configuration Instructions

The package ships with a sqlite database containing all the data needed for generating random records.

$generator = new joshmoody\Mock\Generator();

Reloading Data

You can use the load script to regenerate the sqlite database at any time. This may be useful if modifying the source data to better fit your needs.

$ php bin/load.php

Acknowledgements

The geographic and demographic source data used in this library was derived from several places, including:

joshmoody / mock-data

Maintainers

Details