krixon/domain-event

Domain event library.

0.3.0 2019-07-30 08:22 UTC

Requires

• php: >=7.2
• ext-intl: *
• krixon/datetime: ^0.1
• krixon/identity: ^0.1

Requires (Dev)

• doctrine/coding-standard: ^5.0
• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^8.0

MIT

• Karl Rixon
• Ben Gibson

README

A library for using domain events.

Installation

$ composer require krixon/domain-event

Development

Build Image and Run Container

Note: If your host machine's user does not have an ID of 1000, run the following command from the project root directory:

echo "DEV_UID=$(id -u)" > .env

This ensures that any files created in mounted directories have the correct permissions. It will also cause the host user's SSH keys and Composer cache to be used inside the container.

Build image:

$ docker-compose build

Install dependencies:

$ docker-compose run --rm library composer install

Run the tests

$ docker-compose run --rm library composer test

Coding Standard

This library uses a customised version of the Doctrine coding standard that must be followed at all times. If you're using PHPStorm you can make this easier by enabling the Code Sniffer inspection:

Navigate to Settings > Editor > Inspections and select PHP > Quality Tools > PHP Code Sniffer validation from the list. Enable the inspection. Set the severity to ERROR and check the show warning as checkbox with the option WEAK WARNING. Select the coding standard Custom and point the rule set path to the phpcs.xml.dist file at the root of the project.

To check conformance use:

$ docker-compose run --rm library composer cs

Testing

$ docker-compose run --rm library composer test

Change log

All notable changes are recorded in CHANGELOG.