ResourceIteratorAggregate::getIterator() - Code Metrics - Inspection of "feat: Add `ResourceIteratorAggregate`." - loophp/iterators - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 076cfe...124d4b )

by Pol

created 2022-01-24 17:57 UTC

ResourceIteratorAggregate::getIterator() A

↳ Parent: ResourceIteratorAggregate

Complexity

Conditions	3
Paths	1

Size

Total Lines	20
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	9
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	20
ccs	10
cts	10
cp	1
crap	3
rs	9.9666

<?php

/**
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace loophp\iterators;

use Generator;
use InvalidArgumentException;
use IteratorAggregate;
use Traversable;

use function is_resource;

/**
 * @implements IteratorAggregate<int, string>
 */
final class ResourceIteratorAggregate implements IteratorAggregate
{
    private bool $closeResource;

    /**
     * @var resource
     */
    private $resource;

    /**
     * @param false|resource $resource
     */
    public function __construct($resource, bool $closeResource = false)
    {
        if (!is_resource($resource) || 'stream' !== get_resource_type($resource)) {
            throw new InvalidArgumentException('Invalid resource type.');
        }

        $this->resource = $resource;
        $this->closeResource = $closeResource;
    }

    public function getIterator(): Traversable
    {
        yield from new ClosureIteratorAggregate(
            /**
             * @param resource $resource
             *
             * @return Generator<int, string, mixed, void>
             */
            static function ($resource, bool $closeResource = false): Generator {
                try {
                    while (false !== $chunk = fgetc($resource)) {
                        yield $chunk;
                    }
                } finally {
                    if ($closeResource) {
                        fclose($resource);
                    }
                }
            },
            [$this->resource, $this->closeResource]
        );
    }
}


1		<?php
2
3		/**
4		* For the full copyright and license information, please view
5		* the LICENSE file that was distributed with this source code.
6		*/
7
8		declare(strict_types=1);
9
10		namespace loophp\iterators;
11
12		use Generator;
13		use InvalidArgumentException;
14		use IteratorAggregate;
15		use Traversable;
16
17		use function is_resource;
18
19		/**
20		* @implements IteratorAggregate<int, string>
21		*/
22		final class ResourceIteratorAggregate implements IteratorAggregate
23		{
24		private bool $closeResource;
25
26		/**
27		* @var resource
28		*/
29		private $resource;
30
31		/**
32		* @param false\|resource $resource
33		*/
34	5	public function __construct($resource, bool $closeResource = false)
35		{
36	5	if (!is_resource($resource) \|\| 'stream' !== get_resource_type($resource)) {
37	2	throw new InvalidArgumentException('Invalid resource type.');
38		}
39
40	3	$this->resource = $resource;
41	3	$this->closeResource = $closeResource;
42	3	}
43
44	3	public function getIterator(): Traversable
45		{
46	3	yield from new ClosureIteratorAggregate(
47		/**
48		* @param resource $resource
49		*
50		* @return Generator<int, string, mixed, void>
51		*/
52	3	static function ($resource, bool $closeResource = false): Generator {
53		try {
54	3	while (false !== $chunk = fgetc($resource)) {
55	3	yield $chunk;
56		}
57	3	} finally {
58	3	if ($closeResource) {
59	3	fclose($resource);
60		}
61		}
62	3	},
63	3	[$this->resource, $this->closeResource]
64		);
65	3	}
66		}
67

loophp / iterators

Push — main ( 076cfe...124d4b )

ResourceIteratorAggregate::getIterator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like