WMDE\PsrLogTestDoubles\LogCalls

Complexity

Total Complexity

11

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	filter()	0	2	1
A	getIterator()	0	2	1
A	withoutContexts()	0	2	1
A	getMessages()	0	6	1
A	getFirstCall()	0	2	1
A	__construct()	0	2	1
A	getLastCall()	0	2	1
A	map()	0	8	2
A	getErrors()	0	2	1
A	count()	0	2	1

<?php

declare( strict_types = 1 );

namespace WMDE\PsrLogTestDoubles;

use Psr\Log\LogLevel;

/**
 * Immutable and ordered collection of LogCall objects
 *
 * @since 2.0
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class LogCalls implements \IteratorAggregate, \Countable {

	/**
	 * @var LogCall[]
	 */
	private array $calls;

	public function __construct( LogCall... $calls ) {
		$this->calls = $calls;
	}

	public function getIterator(): \ArrayIterator {
		return new \ArrayIterator( $this->calls );
	}

	/**
	 * @return string[]
	 */
	public function getMessages(): array {
		return array_map(
			function( LogCall $logCall ) {
				return $logCall->getMessage();
			},
			$this->calls
		);
	}

	public function getFirstCall(): ?LogCall {
		return $this->calls[0] ?? null;
	}

	/**
	 * @since 3.1
	 */
	public function getLastCall(): ?LogCall {
		return $this->calls[count( $this->calls ) - 1] ?? null;
	}

	/**
	 * @since 2.1
	 * @return int
	 */
	public function count(): int {
		return count( $this->calls );
	}

	/**
	 * @since 3.2
	 * @param callable(LogCall):bool $filter
	 * @return self
	 */
	public function filter( callable $filter ): self {
		return new self( ...array_filter( $this->calls, $filter ) );
	}

	/**
	 * Returns log calls with log level ERROR and above.
	 * @since 3.2
	 */
	public function getErrors(): self {
		return $this->filter( fn( LogCall $call ) => $call->isError() );
	}

	/**
	 * @since 3.2
	 * @param callable(LogCall):LogCall $map
	 * @return self
	 */
	public function map( callable $map ): self {
		$calls = [];

		foreach ( $this->calls as $call ) {
			$calls[] = $map( $call );
		}

		return new self( ...$calls );
	}

	/**
	 * Returns a copy of the log calls with their contexts removed.
	 * @since 3.2
	 */
	public function withoutContexts(): self {
		return $this->map( fn( LogCall $call ) => $call->withoutContext() );
	}

}