wmde / clock
Simple interface to get the current time without binding to global system resources. Includes test doubles!
Installs: 53 315
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 26
Forks: 1
Open Issues: 0
Requires
- php: >=5.6
Requires (Dev)
- mediawiki/mediawiki-codesniffer: ~18.0
- ockcyp/covers-validator: ~1.0
- phpstan/phpstan: ~0.9.2
- phpunit/phpunit: ~7.1
- slevomat/coding-standard: ~4.5
- squizlabs/php_codesniffer: ~3.2
This package is auto-updated.
Last update: 2024-10-28 13:35:19 UTC
README
A simple interface to get the current time without binding to global system resources plus trivial implementations that facilitate testing.
Clock Usage
function yourCode(Clock $clock) { $time = $clock->now(); // Returns DateTimeImmutable. No global access and easily testable }
Clock interface:
interface Clock { public function now(): \DateTimeImmutable; }
Provided implementations:
SystemClock
: Uses global system resourcesStubClock
: Returns value provided in the constructor. Useful in testsCollectionClock
: Returns specified values sequentially. Useful in testsIncrementingClock
: Returns an incremented starting time infinitely. Useful in tests
Installation
To use the Clock library in your project, simply add a dependency on wmde/clock
to your project's composer.json
file. Here is a minimal example of a composer.json
file that just defines a dependency on Clock 1.x:
{ "require": { "wmde/clock": "~1.0" } }
Development
For development you need to have Docker and Docker-compose installed. Local PHP and Composer are not needed.
sudo apt-get install docker docker-compose
Running Composer
To pull in the project dependencies via Composer, run:
make composer install
You can run other Composer commands via make run
, but at present this does not support argument flags.
If you need to execute such a command, you can do so in this format:
docker run --rm --interactive --tty --volume $PWD:/app -w /app\
--volume ~/.composer:/composer --user $(id -u):$(id -g) composer composer install --no-scripts
Where composer install --no-scripts
is the command being run.
Running the CI checks
To run all CI checks, which includes PHPUnit tests, PHPCS style checks and coverage tag validation, run:
make
Running the tests
To run just the PHPUnit tests run
make test
To run only a subset of PHPUnit tests or otherwise pass flags to PHPUnit, run
docker-compose run --rm app ./vendor/bin/phpunit --filter SomeClassNameOrFilter
Release notes
1.0.0 (2018-09-26)
Initial release with Clock
, SystemClock
, StubClock
, CollectionClock
and IncrementingClock