Sunrise\Http\Message\Stream\LineStream

Complexity

Total Complexity

5

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getIterator()	0	12	4

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <afenric@gmail.com>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-message
 */

namespace Sunrise\Http\Message\Stream;

use IteratorAggregate;
use Sunrise\Http\Message\Exception\InvalidArgumentException;
use Sunrise\Http\Message\Exception\RuntimeException;
use Sunrise\Http\Message\Stream;
use Traversable;

use function fgets;
use function is_resource;
use function rtrim;

/**
 * @implements IteratorAggregate<int, string>
 *
 * @since 3.6.0
 */
final class LineStream extends Stream implements IteratorAggregate
{
    /**
     * @var mixed
     */
    private $resource;

    /**
     * @param mixed $resource
     *
     * @throws InvalidArgumentException
     */
    public function __construct($resource, bool $autoClose = true)
    {
        parent::__construct($resource, $autoClose);

        $this->resource = $resource;
    }

    /**
     * @inheritDoc
     */
    public function getIterator(): Traversable
    {
        if (!is_resource($this->resource)) {
            throw new RuntimeException('Stream has no resource');
        }

        if (!$this->isReadable()) {
            throw new RuntimeException('Stream is not readable');
        }

        while (($line = fgets($this->resource)) !== false) {
            yield rtrim($line);
        }
    }
}