README.adoc
:toc: macro
:toc-title:
:toclevels: 2
:sectnums:
:sectnumlevels: 2
ifdef::env-github[]
++++
<p align="center">
<img src="./.github/logo.svg">
</p>
++++
endif::[]
ifndef::env-github[]
image:.github/logo.svg[Logo, align=center]
endif::[]
image:https://img.shields.io/packagist/v/richcongress/fixture-test[link="https://packagist.org/packages/richcongress/fixture-test",window="_blank"]
image:https://github.com/richcongress/fixture-test/workflows/Tests/badge.svg[link="https://github.com/richcongress/fixture-test/actions",window="_blank"]
image:https://coveralls.io/repos/github/richcongress/fixture-test/badge.svg?branch=master[link="https://coveralls.io/github/richcongress/fixture-test?branch=master",window="_blank"]
image:https://api.codeclimate.com/v1/badges/c19d8274f46d57faf7c4/maintainability[link="https://codeclimate.com/github/richcongress/fixture-test/maintainability",window="_blank"]
image:https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat[link="https://github.com/richcongress/test-suite/issues",window="_blank"]
image:https://img.shields.io/badge/license-MIT-blue.svg[link="LICENSE",window="_blank"]
image:https://img.shields.io/badge/PHP-7.3%2B-yellow[]
image:https://img.shields.io/badge/Symfony-4%2B-black[]
image:https://img.shields.io/badge/Symfony-5%2B-black[]
This library provides tools to generate quickly an object with its properties filled with random but meaningful values.
[discrete]
== Table of content
toc::[]
== Quick showcase
[source,php]
----
final class User
{
/** @var int */
private $id;
/** @var string */
private $username;
/** @var string */
private $password;
/** @var \DateTime */
private $dateAdd;
/** @var \DateTime */
private $dateUpdate;
/** @var string */
private $biography;
}
----
The `FixtureGenerator` can create an instance of this class:
[source,php]
----
$fixtureGenerator = new \RichCongress\FixtureTestBundle\Generator\FixtureGenerator();
$user = $fixtureGenerator->generate(User::class, [
'biography' => 'This was generated by the library',
]);
----
If we serialize the class in Json, it will give something like this:
[source,json]
----
{
// This is always null, we don't want the library to mess up with Doctrine
"id": null,
// This is a random username
"username": "john_doe",
// This is a random password
"password": "k&|X+a45*2[",
// This is a random date between -200 days and today
"dateAdd": "2019-12-03 11:07:02",
// Notice the dateUpdate is always after the dateAdd
"dateUpdate": "2020-03-04 18:57:41",
// This is a hard value given during the generation, so any property can be quickly overriden
"biography": "This was generated by the library"
}
----
== Installation
This version of the bundle requires Symfony 6.0+ and PHP 8.1+.
[source,bash]
----
composer require richcongress/fixture-test
----
=== Symfony
If you plan to use it with Symfony, please install the `richcongress/bundle-toolbox` before, and makes sure that the `RichCongressFixtureTestBundle` is in the `bundles.php`.
== Documentation
=== link:docs/Configuration.adoc[Configuration]
== Versioning
fixture-test follows link:https://semver.org/[semantic versioning^]. In short the scheme is MAJOR.MINOR.PATCH where
1. MAJOR is bumped when there is a breaking change,
2. MINOR is bumped when a new feature is added in a backward-compatible way,
3. PATCH is bumped when a bug is fixed in a backward-compatible way.
Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.
== Contributing
Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:
* link:https://github.com/richcongress/fixture-test/issues[Bug Reports^]: While we strive for quality software, bugs can happen, and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
* link:https://github.com/richcongress/fixture-test/issues[Feature Request^]: You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
* link:https://github.com/richcongress/fixture-test/pulls[Pull Request^]: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as link:https://help.github.com/articles/about-pull-requests/[documentation^] on pull requests. We use the link:https://help.github.com/articles/about-collaborative-development-models/["fork and pull model"^] were contributors push changes to their personal fork and then create pull requests to the main repository. Please make your pull requests against the `master` branch.
As a reminder, all contributors are expected to follow our link:./CODE_OF_CONDUCT.md[Code of Conduct].
== License
cookies-regulation-bundle is distributed under the terms of the MIT license.
See link:./LICENSE[LICENSE] for details.
== Hacking
You might use Docker and `docker-compose` to hack the project. Check out the following commands.
[source,bash]
----
# Start the project
docker-compose up -d
# Install dependencies
docker-compose exec application composer install
# Run tests
docker-compose exec application bin/phpunit
# Run a bash within the container
docker-compose exec application bash
----