Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soyhuce/array-factory
https://github.com/soyhuce/array-factory
hacktoberfest
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/soyhuce/array-factory
- Owner: Soyhuce
- License: mit
- Created: 2022-09-20T12:31:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T00:20:28.000Z (9 months ago)
- Last Synced: 2024-11-24T20:50:11.007Z (about 2 months ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 65.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# This is array-factory package
[](https://packagist.org/packages/soyhuce/array-factory)
[](https://github.com/soyhuce/array-factory/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/soyhuce/array-factory/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://github.com/soyhuce/array-factory/actions?query=workflow%3APHPStan+branch%3Amain)
[](https://packagist.org/packages/soyhuce/array-factory)
When testing your application, you may need to write the same data structures (lists, collections, Etc.) to populate models or something else. These often duplicated in multiple test files.
A bit like Laravel's Factory classes, ArrayFactory permits to generate and reuse custom data structures and usable among your tests.
## Installation
You can install the package via composer:
```bash
composer require --dev soyhuce/array-factory
```
## Usage
#### Create a factory
```php
use Soyhuce\ArrayFactory;
$factory = new ArrayFactory(['foo' => 'bar']); // from an array
$factory = ArrayFactory::new(['foo' => 'bar']); // from static method new
$factory = ArrayFactory::new(fn () => ['foo' => 'bar']); // with a callable
$factory = ArrayFactory::new(fn () => ['foo' => faker()->word() ]); // using \Faker\Generator generation
```
#### Use it
```php
$factory->createOne();
// ['foo' => 'bar']
$factory->createMany(['foo' => 'qux'], ['foo' => 'bar'])
// [['foo' => 'qux'], ['foo' => 'bar']]
$factory->count(2)->asCollection();
// Illuminate\Support\Collection([ ['foo' => 'bar'], ['foo' => 'bar'] ])
```
#### Add states
You may need to define states and use it in a specific context.
```php
$factory = new ArrayFactory(
definition: ['foo' => 'bar'],
states: [
'qux' => ['foo' => 'qux'],
]
);
$factory->createOne();
// ['foo' => 'bar']
$factory->state('qux')->createOne();
// ['foo' => 'qux']
```
#### Add custom Collection
You can transform the array into a custom Collection.
```php
$factory = new ArrayFactory(
collection: FooCollection::class,
);
$foo = FooFactory::new()->asCollection();
```
You can also transform the array into a custom Data object by defining the Spatie\LaravelData\Data class.
#### Add custom \Spatie\LaravelData\Data
```php
$factory = new ArrayFactory(
data: FooData::class,
);
$factory = FooFactory::new()->asData();
```
It allows get many results as collection of datas
```php
$datas = $factory->manyAsDataCollection(['id' => 2], ['id' => 3]);
// Collection([FooData(id: 2), FooData(id: 3)])
```
### Create an extended class
```php
class FooFactory extends ArrayFactory
{
protected string $collection = FooCollection::class;
protected string $data = FooData::class;
public function definition(): array
{
return [
'id' => 1,
'activated' => true,
'message' => faker()->sentence(),
'value' => 0,
];
}
public function id(int $id): static
{
return $this->state(['id' => $id]);
}
public function activated(bool $activated = true): static
{
return $this->state(['activated' => $activated]);
}
}
```
Then, you can simply use it in your tests.
```php
$foo1 = FooFactory::new()->createOne();
// ['id' => 1, 'activated' => true, 'value' => 0]
$foo1 = FooFactory::new()->createOne(['value' => 1]]);
// ['id' => 1, 'activated' => true, 'value' => 1]
$foo2 = FooFactory::new()->id(2)->createOne();
// ['id' => 2, 'activated' => true, 'value' => 0]
$foo3 = FooFactory::new()->activated(false)->createOne();
// ['id' => 1, 'activated' => false, 'value' => 0]
```
## Testing
Runs tests.
```bash
composer test
```
Runs all pre-commit checks.
```bash
composer all
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Bastien Philippe](https://github.com/bastien-phi)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.