Reader::jsonPreserveOffset() - Code Metrics - Inspection of "Reader and ResultSet record offset preservation" - thephpleague/csv - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9d4407...627ff4 )

by ignace nyamagana

created 2017-08-01 10:21 UTC

Reader::jsonPreserveOffset() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	6
ccs	3
cts	3
cp	1
crap	1
rs	9.4285
c	0
b	0
f	0

<?php
/**
* This file is part of the League.csv library
*
* @license http://opensource.org/licenses/MIT
* @link https://github.com/thephpleague/csv/
* @version 9.0.0
* @package League.csv
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);

namespace League\Csv;

use BadMethodCallException;
use CallbackFilterIterator;
use Countable;
use Iterator;
use IteratorAggregate;
use JsonSerializable;
use League\Csv\Exception\RuntimeException;
use SplFileObject;

/**
 * A class to manage records selection from a CSV document
 *
 * @package League.csv
 * @since  3.0.0
 *
 * @method array fetchOne(int $nth_record = 0) Returns a single record from the CSV
 * @method Generator fetchColumn(string|int $column_index) Returns the next value from a single CSV record field
 * @method Generator fetchPairs(string|int $offset_index = 0, string|int $value_index = 1) Fetches the next key-value pairs from the CSV document
 */
class Reader extends AbstractCsv implements Countable, IteratorAggregate, JsonSerializable
{
    /**
     * CSV Document header offset
     *
     * @var int|null
     */
    protected $header_offset;

    /**
     * CSV Document Header record
     *
     * @var string[]
     */
    protected $header = [];

    /**
     * Records count
     *
     * @var int
     */
    protected $nb_records = -1;

    /**
     * @inheritdoc
     */
    protected $stream_filter_mode = STREAM_FILTER_READ;

    /**
     * Returns the record offset used as header
     *
     * If no CSV record is used this method MUST return null
     *
     * @return int|null
     */
    public function getHeaderOffset()
    {
        return $this->header_offset;
    }

    /**
     * Returns the CSV record header
     *
     * The returned header is represented as an array of string values
     *
     * @return string[]
     */
    public function getHeader(): array
    {
        if (null === $this->header_offset) {
            return $this->header;
        }

        if (!empty($this->header)) {
            return $this->header;
        }

        $this->header = $this->setHeader($this->header_offset);

        return $this->header;
    }

    /**
     * Determine the CSV record header
     *
     * @param int $offset
     *
     * @throws RuntimeException If the header offset is an integer
     *                          and the corresponding record is missing
     *                          or is an empty array
     *
     * @return string[]
     */
    protected function setHeader(int $offset): array
    {
        $this->document->setFlags(SplFileObject::READ_CSV | SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY);
        $this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
        $this->document->seek($offset);
        if (empty($header = $this->document->current())) {
            throw new RuntimeException(sprintf('The header record does not exist or is empty at offset: `%s`', $offset));
        }

        if (0 === $offset) {
            return $this->removeBOM($header, mb_strlen($this->getInputBOM()), $this->enclosure);
        }

        return $header;
    }

    /**
     * Strip the BOM sequence from a record
     *
     * @param string[] $record
     * @param int      $bom_length
     * @param string   $enclosure
     *
     * @return string[]
     */
    protected function removeBOM(array $record, int $bom_length, string $enclosure): array
    {
        if (0 == $bom_length) {
            return $record;
        }

        $record[0] = mb_substr($record[0], $bom_length);
        if ($enclosure == mb_substr($record[0], 0, 1) && $enclosure == mb_substr($record[0], -1, 1)) {
            $record[0] = mb_substr($record[0], 1, -1);
        }

        return $record;
    }

    /**
     * @inheritdoc
     */
    public function __call($method, array $arguments)
    {
        $whitelisted = ['fetchColumn' => 1, 'fetchPairs' => 1, 'fetchOne' => 1];
        if (isset($whitelisted[$method])) {
            return (new ResultSet($this->getRecords(), $this->getHeader()))->$method(...$arguments);
        }

        throw new BadMethodCallException(sprintf('%s::%s() method does not exist', __CLASS__, $method));
    }

    /**
     * @inheritdoc
     */
    public function count(): int
    {
        if (-1 === $this->nb_records) {
            $this->nb_records = iterator_count($this->getRecords());
        }

        return $this->nb_records;
    }

    /**
     * @inheritdoc
     */
    public function getIterator(): Iterator
    {
        return $this->getRecords();
    }

    /**
     * @inheritdoc
     */
    public function jsonSerialize(): array
    {
        return iterator_to_array($this->getRecords(), false);
    }

    /**
     * Returns the CSV records in an iterator object.
     *
     * Each CSV record is represented as a simple array of string or null values.
     *
     * If the CSV document has a header record then each record is combined
     * to each header record and the header record is removed from the iterator.
     *
     * If the CSV document is inconsistent. Missing record fields are
     * filled with null values while extra record fields are strip from
     * the returned object.
     *
     * @param string[] $header an optional header to use instead of the CSV document header
     *
     * @return Iterator
     */
    public function getRecords(array $header = []): Iterator
    {
        $header = $this->computeHeader($header);
        $normalized = function ($record): bool {
            return is_array($record) && $record != [null];
        };
        $bom = $this->getInputBOM();
        $this->document->setFlags(SplFileObject::READ_CSV | SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY);
        $this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);

        $records = $this->stripBOM(new CallbackFilterIterator($this->document, $normalized), $bom);
        if (null !== $this->header_offset) {
            $records = new CallbackFilterIterator($records, function (array $record, int $offset): bool {
                return $offset !== $this->header_offset;
            });
        }

        return $this->combineHeader($records, $header);
    }

    /**
     * Returns the header to be used for iteration
     *
     * @param string[] $header
     *
     * @throws RuntimeException If the header contains non unique column name
     *
     * @return string[]
     */
    protected function computeHeader(array $header)
    {
        if (empty($header)) {
            $header = $this->getHeader();
        }

        if ($header === array_unique(array_filter($header, 'is_string'))) {
            return $header;
        }

        throw new RuntimeException('The header record must be empty or a flat array with unique string values');
    }

    /**
     * Add the CSV header if present and valid
     *
     * @param Iterator $iterator
     * @param string[] $header
     *
     * @return Iterator
     */
    protected function combineHeader(Iterator $iterator, array $header): Iterator
    {
        if (empty($header)) {
            return $iterator;
        }

        $field_count = count($header);
        $mapper = function (array $record) use ($header, $field_count): array {
            if (count($record) != $field_count) {
                $record = array_slice(array_pad($record, $field_count, null), 0, $field_count);
            }

            return array_combine($header, $record);
        };

        return new MapIterator($iterator, $mapper);
    }

    /**
     * Strip the BOM sequence if present
     *
     * @param Iterator $iterator
     * @param string   $bom
     *
     * @return Iterator
     */
    protected function stripBOM(Iterator $iterator, string $bom): Iterator
    {
        if ('' === $bom) {
            return $iterator;
        }

        $bom_length = mb_strlen($bom);
        $mapper = function (array $record, int $index) use ($bom_length): array {
            if (0 != $index) {
                return $record;
            }

            return $this->removeBOM($record, $bom_length, $this->enclosure);
        };

        return new MapIterator($iterator, $mapper);
    }

    /**
     * Selects the record to be used as the CSV header
     *
     * Because of the header is represented as an array, to be valid
     * a header MUST contain only unique string value.
     *
     * @param int|null $offset the header record offset
     *
     * @return static
     */
    public function setHeaderOffset($offset): self
    {
        $this->filterNullableInteger($offset, 0, __METHOD__.'() expects the header offset index to be a positive integer or 0');
        if ($offset !== $this->header_offset) {
            $this->header_offset = $offset;
            $this->resetProperties();
        }

        return $this;
    }

    /**
     * @inheritdoc
     */
    protected function resetProperties()
    {
        $this->nb_records = -1;
        $this->header = [];
    }
}


1		<?php
2		/**
3		* This file is part of the League.csv library
4		*
5		* @license http://opensource.org/licenses/MIT
6		* @link https://github.com/thephpleague/csv/
7		* @version 9.0.0
8		* @package League.csv
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13		declare(strict_types=1);
14
15		namespace League\Csv;
16
17		use BadMethodCallException;
18		use CallbackFilterIterator;
19		use Countable;
20		use Iterator;
21		use IteratorAggregate;
22		use JsonSerializable;
23		use League\Csv\Exception\RuntimeException;
24		use SplFileObject;
25
26		/**
27		* A class to manage records selection from a CSV document
28		*
29		* @package League.csv
30		* @since 3.0.0
31		*
32		* @method array fetchOne(int $nth_record = 0) Returns a single record from the CSV
33		* @method Generator fetchColumn(string\|int $column_index) Returns the next value from a single CSV record field
34		* @method Generator fetchPairs(string\|int $offset_index = 0, string\|int $value_index = 1) Fetches the next key-value pairs from the CSV document
35		*/
36		class Reader extends AbstractCsv implements Countable, IteratorAggregate, JsonSerializable
37		{
38		/**
39		* CSV Document header offset
40		*
41		* @var int\|null
42		*/
43		protected $header_offset;
44
45		/**
46		* CSV Document Header record
47		*
48		* @var string[]
49		*/
50		protected $header = [];
51
52		/**
53		* Records count
54		*
55		* @var int
56		*/
57		protected $nb_records = -1;
58
59		/**
60		* @inheritdoc
61		*/
62		protected $stream_filter_mode = STREAM_FILTER_READ;
63
64		/**
65		* Returns the record offset used as header
66		*
67		* If no CSV record is used this method MUST return null
68		*
69		* @return int\|null
70		*/
71	10	public function getHeaderOffset()
72		{
73	10	return $this->header_offset;
74		}
75
76		/**
77		* Returns the CSV record header
78		*
79		* The returned header is represented as an array of string values
80		*
81		* @return string[]
82		*/
83	10	public function getHeader(): array
84		{
85	10	if (null === $this->header_offset) {
86	8	return $this->header;
87		}
88
89	4	if (!empty($this->header)) {
90	2	return $this->header;
91		}
92
93	4	$this->header = $this->setHeader($this->header_offset);
94
95	4	return $this->header;
96		}
97
98		/**
99		* Determine the CSV record header
100		*
101		* @param int $offset
102		*
103		* @throws RuntimeException If the header offset is an integer
104		* and the corresponding record is missing
105		* or is an empty array
106		*
107		* @return string[]
108		*/
109	6	protected function setHeader(int $offset): array
110		{
111	6	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
112	6	$this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
113	6	$this->document->seek($offset);
114	6	if (empty($header = $this->document->current())) {
115	2	throw new RuntimeException(sprintf('The header record does not exist or is empty at offset: `%s`', $offset));
116		}
117
118	4	if (0 === $offset) {
119	2	return $this->removeBOM($header, mb_strlen($this->getInputBOM()), $this->enclosure);
120		}
121
122	2	return $header;
123		}
124
125		/**
126		* Strip the BOM sequence from a record
127		*
128		* @param string[] $record
129		* @param int $bom_length
130		* @param string $enclosure
131		*
132		* @return string[]
133		*/
134	8	protected function removeBOM(array $record, int $bom_length, string $enclosure): array
135		{
136	8	if (0 == $bom_length) {
137	2	return $record;
138		}
139
140	6	$record[0] = mb_substr($record[0], $bom_length);
141	6	if ($enclosure == mb_substr($record[0], 0, 1) && $enclosure == mb_substr($record[0], -1, 1)) {
142	2	$record[0] = mb_substr($record[0], 1, -1);
143		}
144
145	6	return $record;
146		}
147
148		/**
149		* @inheritdoc
150		*/
151	6	public function __call($method, array $arguments)
152		{
153	6	$whitelisted = ['fetchColumn' => 1, 'fetchPairs' => 1, 'fetchOne' => 1];
154	6	if (isset($whitelisted[$method])) {
155	2	return (new ResultSet($this->getRecords(), $this->getHeader()))->$method(...$arguments);
156		}
157
158	4	throw new BadMethodCallException(sprintf('%s::%s() method does not exist', __CLASS__, $method));
159		}
160
161		/**
162		* @inheritdoc
163		*/
164	2	public function count(): int
165		{
166	2	if (-1 === $this->nb_records) {
167	2	$this->nb_records = iterator_count($this->getRecords());
168		}
169
170	2	return $this->nb_records;
171		}
172
173		/**
174		* @inheritdoc
175		*/
176	2	public function getIterator(): Iterator
177		{
178	2	return $this->getRecords();
179		}
180
181		/**
182		* @inheritdoc
183		*/
184	2	public function jsonSerialize(): array
185		{
186	2	return iterator_to_array($this->getRecords(), false);
187		}
188
189		/**
190		* Returns the CSV records in an iterator object.
191		*
192		* Each CSV record is represented as a simple array of string or null values.
193		*
194		* If the CSV document has a header record then each record is combined
195		* to each header record and the header record is removed from the iterator.
196		*
197		* If the CSV document is inconsistent. Missing record fields are
198		* filled with null values while extra record fields are strip from
199		* the returned object.
200		*
201		* @param string[] $header an optional header to use instead of the CSV document header
202		*
203		* @return Iterator
204		*/
205	12	public function getRecords(array $header = []): Iterator
206		{
207	12	$header = $this->computeHeader($header);
208		$normalized = function ($record): bool {
209	10	return is_array($record) && $record != [null];
210	10	};
211	10	$bom = $this->getInputBOM();
212	10	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
213	10	$this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
214
215	10	$records = $this->stripBOM(new CallbackFilterIterator($this->document, $normalized), $bom);
216	10	if (null !== $this->header_offset) {
217		$records = new CallbackFilterIterator($records, function (array $record, int $offset): bool {
218	4	return $offset !== $this->header_offset;
219	4	});
220		}
221
222	10	return $this->combineHeader($records, $header);
223		}
224
225		/**
226		* Returns the header to be used for iteration
227		*
228		* @param string[] $header
229		*
230		* @throws RuntimeException If the header contains non unique column name
231		*
232		* @return string[]
233		*/
234	16	protected function computeHeader(array $header)
235		{
236	16	if (empty($header)) {
237	14	$header = $this->getHeader();
238		}
239
240	16	if ($header === array_unique(array_filter($header, 'is_string'))) {
241	14	return $header;
242		}
243
244	2	throw new RuntimeException('The header record must be empty or a flat array with unique string values');
245		}
246
247		/**
248		* Add the CSV header if present and valid
249		*
250		* @param Iterator $iterator
251		* @param string[] $header
252		*
253		* @return Iterator
254		*/
255	20	protected function combineHeader(Iterator $iterator, array $header): Iterator
256		{
257	20	if (empty($header)) {
258	14	return $iterator;
259		}
260
261	8	$field_count = count($header);
262		$mapper = function (array $record) use ($header, $field_count): array {
263	8	if (count($record) != $field_count) {
264	4	$record = array_slice(array_pad($record, $field_count, null), 0, $field_count);
265		}
266
267	8	return array_combine($header, $record);
268	8	};
269
270	8	return new MapIterator($iterator, $mapper);
271		}
272
273		/**
274		* Strip the BOM sequence if present
275		*
276		* @param Iterator $iterator
277		* @param string $bom
278		*
279		* @return Iterator
280		*/
281	16	protected function stripBOM(Iterator $iterator, string $bom): Iterator
282		{
283	16	if ('' === $bom) {
284	10	return $iterator;
285		}
286
287	6	$bom_length = mb_strlen($bom);
288	6	$mapper = function (array $record, int $index) use ($bom_length): array {
289	6	if (0 != $index) {
290	2	return $record;
291		}
292
293	6	return $this->removeBOM($record, $bom_length, $this->enclosure);
294	6	};
295
296	6	return new MapIterator($iterator, $mapper);
297		}
298
299		/**
300		* Selects the record to be used as the CSV header
301		*
302		* Because of the header is represented as an array, to be valid
303		* a header MUST contain only unique string value.
304		*
305		* @param int\|null $offset the header record offset
306		*
307		* @return static
308		*/
309	10	public function setHeaderOffset($offset): self
310		{
311	10	$this->filterNullableInteger($offset, 0, __METHOD__.'() expects the header offset index to be a positive integer or 0');
312	10	if ($offset !== $this->header_offset) {
313	2	$this->header_offset = $offset;
314	2	$this->resetProperties();
315		}
316
317	10	return $this;
318		}
319
320		/**
321		* @inheritdoc
322		*/
323	8	protected function resetProperties()
324		{
325	8	$this->nb_records = -1;
326	8	$this->header = [];
327	8	}
328		}
329

thephpleague / csv

Push — master ( 9d4407...627ff4 )

Reader::jsonPreserveOffset() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like