README

PHP Nanobench

A simple and lightweight benchmarking tool for PHP.

Installation

composer require loophp/nanobench

Usage

<?php

declare(strict_types=1);

namespace App;

use loophp\nanobench\Benchmark;
use loophp\nanobench\Time\HrClock;
use loophp\nanobench\Time\Stopwatch;

include __DIR__ . '/vendor/autoload.php';

$callable = static function (int $secondsToWait): int {
    sleep($secondsToWait);

    return $secondsToWait ** 2;
};

$benchmark = new Benchmark(new Stopwatch(new HrClock()), $callable, 3);
$duration = $benchmark->run()->getDuration();

$duration->asNanosecond();
$duration->asMicrosecond();
$duration->asMillisecond();
$duration->asSecond();

$benchmark->getReturn(); // Return value of the callable that has been benchmarked

Documentation

API

The API is quite light and completely described in the Benchmark interface.

Code quality, tests and benchmarks

Every time changes are introduced into the library, Github run the tests.

The library has tests written with PHPSpec. Feel free to check them out in the spec directory. Run composer phpspec to trigger the tests.

Before each commit some inspections are executed with GrumPHP, run composer grumphp to check manually.

The quality of the tests is tested with Infection a PHP Mutation testing framework, run composer infection to try it.

Static analysers are also controlling the code. PHPStan and PSalm are enabled to their maximum level.

Contributing

Feel free to contribute by sending Github pull requests. I'm quite reactive :-)

If you can't contribute to the code, you can also sponsor me on Github or Paypal.

Changelog

See CHANGELOG.md for a changelog based on git commits.

For more detailed changelogs, please check the release changelogs.

loophp / nanobench

Maintainers

Details