README

PHP Test Kit Pack

Reduce testing boilerplate and make your PHP tests more elegant and maintainable 🚀

Installation • Features • Documentation • Contributing

💡 Motivation

Writing high-quality, readable tests can be time-consuming, especially without proper tooling. This package provides elegant solutions to common testing challenges, helping you write better tests with less boilerplate.

🚀 Installation

Install via Composer:

composer require grano22/test-kit --dev

📚 Documentation

🚧 Coming Soon! I work on comprehensive documentation.

In the meantime, you can:

• Check the examples below
• Browse the source code for implementation details
• Open an issue if you have questions

✨ Features

🎯 Operating on the array with an object navigation path

Remove Elements

Sometimes, in the test you need to strip something from an array (most likely dates that you don't control). It frequently creates a lot of boilerplate code in the private methods. Now you can use:

$structure = [
    'items' => [
        [ 'title' => 'First', 'description' => 'First description lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse ut venenatis arcu.' ],
        [ 'title' => 'Second', 'description' => 'Second description lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse ut venenatis arcu.' ]
    ]
];

ReferenceNode::traverseByNodePath(
    static fn(ReferenceNode $node) => $node->remove(),
    $structure,
    '.items[*].description'
);

Truncate Content

Too long meaningful description? Don't worry, you can truncate it for assertion.

$structure = [
    'items' => [
        [ 'title' => 'First', 'description' => 'First description lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse ut venenatis arcu.' ],
        [ 'title' => 'Second', 'description' => 'Second description lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse ut venenatis arcu.' ]
    ]
];

$mappedArray = ReferenceNode::mapByNodePath(
    static fn(ReferenceNode $node) => $node->trunc(18),
    $structure,
    '.items[*].description'
);

You can also replace some content.

$structure = [
    'items' => [
        [ 'title' => 'First', 'description' => 'First description.' ],
        [ 'title' => 'Second', 'description' => 'Second description.' ]
    ]
];

$mappedArray = ReferenceNode::mapByNodePath(
    static fn(ReferenceNode $node) => $node->modify(str_replace("description", "test", $node->getValue())),
    $structure,
    '.items[*].description'
);

🕵️ Test Doubles - CallSpy

Call spy is just a single test double (spy) to track your calls without using phpunit mocks.

use Grano22\TestKit\TestDoubles\CallSpy;
use PHPUnit\Framework\Assert;

$someClass = new class() extends Assert {
    use CallSpy;

    public function someMethod(): void
    {
        $this->trackEach();
    }
};

$someClass->setMaxExpectedCalls(2);
$someClass->someMethod();
$someClass->someMethod();
$someClass->someMethod();

// Will throw **AssertionFailedError**, because of Assert::fail

🏗️ DDD Tactical Patterns

Create a universal, in-memory repository in your kit/testDriver, use it in the unit test

class ExampleEntity
{
    public function __construct(public readonly string $id)
    {
    }
}

$repository = InMemoryRepository::createOfType(ExampleEntity::class);

$repository->add($entity);
$repository->add(new ExampleEntity('2'));

$foundEntity = $repository->findById('1');

🤝 Contributing

Contributions are welcome! Feel free to:

• 🐛 Report bugs
• 💡 Suggest features
• 🔧 Submit pull requests

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.