Reader::supportsHeaderAsRecordKeys() - Code Metrics - Inspection of "Improve Reader:getRecords and RFC4180Field" - thephpleague/csv - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 78899c...34ee7e )

by ignace nyamagana

created 2017-06-19 09:09 UTC

Reader::supportsHeaderAsRecordKeys() A

↳ Parent: Reader::getHeader()

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	6
ccs	3
cts	3
cp	1
crap	2
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 League\Csv\Exception\RuntimeException;
use LimitIterator;
use SplFileObject;

/**
 * A class to manage records selection from a CSV document
 *
 * @package League.csv
 * @since  3.0.0
 *
 * @method array fetchAll() Returns a sequential array of all CSV records
 * @method array fetchOne(int $offset = 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, string|int $value_index) Fetches the next key-value pairs from the CSV document
 */
class Reader extends AbstractCsv implements Countable, IteratorAggregate
{
    /**
     * @inheritdoc
     */
    protected $stream_filter_mode = STREAM_FILTER_READ;

    /**
     * The value to pad if the record is less than header size.
     *
     * @var mixed
     */
    protected $record_padding_value;

    /**
     * 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;

    /**
     * Detect Delimiters occurences in the CSV
     *
     * Returns a associative array where each key represents
     * a valid delimiter and each value the number of occurences
     *
     * @param string[] $delimiters the delimiters to consider
     * @param int      $nb_records Detection is made using $nb_records of the CSV
     *
     * @return array
     */
    public function fetchDelimitersOccurrence(array $delimiters, int $nb_records = 1): array
    {
        $filter = function ($value): bool {
            return 1 == strlen($value);
        };

        $nb_records = $this->filterMinRange($nb_records, 1, __METHOD__.'() expects the number of records to consider to be a valid positive integer, %s given');
        $delimiters = array_unique(array_filter($delimiters, $filter));
        $reducer = function (array $res, string $delimiter) use ($nb_records): array {
            $res[$delimiter] = $this->getCellCount($delimiter, $nb_records);

            return $res;
        };

        $res = array_reduce($delimiters, $reducer, []);
        arsort($res, SORT_NUMERIC);

        return $res;
    }

    /**
     * Returns the cell count for a specified delimiter
     * and a specified number of records
     *
     * @param string $delimiter  CSV delimiter
     * @param int    $nb_records CSV records to consider
     *
     * @return int
     */
    protected function getCellCount(string $delimiter, int $nb_records): int
    {
        $filter = function ($record): bool {
            return is_array($record) && count($record) > 1;
        };

        $this->document->setFlags(SplFileObject::READ_CSV | SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY);
        $this->document->setCsvControl($delimiter, $this->enclosure, $this->escape);
        $iterator = new CallbackFilterIterator(new LimitIterator($this->document, 0, $nb_records), $filter);

        return count(iterator_to_array($iterator, false), COUNT_RECURSIVE);
    }

    /**
     * Returns the record padding value
     *
     * @return mixed
     */
    public function getRecordPaddingValue()
    {
        return $this->record_padding_value;
    }

    /**
     * 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)) {
            $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);
        $header = $this->document->current();
        if (empty($header)) {
            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, 'fetchAll' => 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();
    }

    /**
     * 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 array $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 array    $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, $this->record_padding_value), 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);
    }

    /**
     * Set the record padding value
     *
     * @param mixed $record_padding_value
     *
     * @return static
     */
    public function setRecordPaddingValue($record_padding_value): self
    {
        $this->record_padding_value = $record_padding_value;

        return $this;
    }

    /**
     * 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
    {
        if (null !== $offset) {
            $offset = $this->filterMinRange($offset, 0, __METHOD__.'() expects the header offset index to be a positive integer or 0, %s given');
        }

        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 League\Csv\Exception\RuntimeException;
23		use LimitIterator;
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 fetchAll() Returns a sequential array of all CSV records
33		* @method array fetchOne(int $offset = 0) Returns a single record from the CSV
34		* @method Generator fetchColumn(string\|int $column_index) Returns the next value from a single CSV record field
35		* @method Generator fetchPairs(string\|int $offset_index, string\|int $value_index) Fetches the next key-value pairs from the CSV document
36		*/
37		class Reader extends AbstractCsv implements Countable, IteratorAggregate
38		{
39		/**
40		* @inheritdoc
41		*/
42		protected $stream_filter_mode = STREAM_FILTER_READ;
43
44		/**
45		* The value to pad if the record is less than header size.
46		*
47		* @var mixed
48		*/
49		protected $record_padding_value;
50
51		/**
52		* CSV Document header offset
53		*
54		* @var int\|null
55		*/
56		protected $header_offset;
57
58		/**
59		* CSV Document Header record
60		*
61		* @var string[]
62		*/
63		protected $header = [];
64
65		/**
66		* Records count
67		*
68		* @var int
69		*/
70		protected $nb_records = -1;
71
72		/**
73		* Detect Delimiters occurences in the CSV
74		*
75		* Returns a associative array where each key represents
76		* a valid delimiter and each value the number of occurences
77		*
78		* @param string[] $delimiters the delimiters to consider
79		* @param int $nb_records Detection is made using $nb_records of the CSV
80		*
81		* @return array
82		*/
83	6	public function fetchDelimitersOccurrence(array $delimiters, int $nb_records = 1): array
84		{
85		$filter = function ($value): bool {
86	4	return 1 == strlen($value);
87	3	};
88
89	6	$nb_records = $this->filterMinRange($nb_records, 1, __METHOD__.'() expects the number of records to consider to be a valid positive integer, %s given');
90	4	$delimiters = array_unique(array_filter($delimiters, $filter));
91		$reducer = function (array $res, string $delimiter) use ($nb_records): array {
92	4	$res[$delimiter] = $this->getCellCount($delimiter, $nb_records);
93
94	4	return $res;
95	4	};
96
97	4	$res = array_reduce($delimiters, $reducer, []);
98	4	arsort($res, SORT_NUMERIC);
99
100	4	return $res;
101		}
102
103		/**
104		* Returns the cell count for a specified delimiter
105		* and a specified number of records
106		*
107		* @param string $delimiter CSV delimiter
108		* @param int $nb_records CSV records to consider
109		*
110		* @return int
111		*/
112	2	protected function getCellCount(string $delimiter, int $nb_records): int
113		{
114		$filter = function ($record): bool {
115	2	return is_array($record) && count($record) > 1;
116	1	};
117
118	2	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
119	2	$this->document->setCsvControl($delimiter, $this->enclosure, $this->escape);
120	2	$iterator = new CallbackFilterIterator(new LimitIterator($this->document, 0, $nb_records), $filter);
121
122	2	return count(iterator_to_array($iterator, false), COUNT_RECURSIVE);
123		}
124
125		/**
126		* Returns the record padding value
127		*
128		* @return mixed
129		*/
130	2	public function getRecordPaddingValue()
131		{
132	2	return $this->record_padding_value;
133		}
134
135		/**
136		* Returns the record offset used as header
137		*
138		* If no CSV record is used this method MUST return null
139		*
140		* @return int\|null
141		*/
142	2	public function getHeaderOffset()
143		{
144	2	return $this->header_offset;
145		}
146
147		/**
148		* Returns the CSV record header
149		*
150		* The returned header is represented as an array of string values
151		*
152		* @return string[]
153		*/
154	4	public function getHeader(): array
155		{
156	4	if (null === $this->header_offset) {
157	2	return $this->header;
158		}
159
160	4	if (empty($this->header)) {
161	4	$this->header = $this->setHeader($this->header_offset);
162		}
163
164	4	return $this->header;
165		}
166
167		/**
168		* Determine the CSV record header
169		*
170		* @param int $offset
171		*
172		* @throws RuntimeException If the header offset is an integer
173		* and the corresponding record is missing
174		* or is an empty array
175		*
176		* @return string[]
177		*/
178	6	protected function setHeader(int $offset): array
179		{
180	6	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
181	6	$this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
182	6	$this->document->seek($offset);
183	6	$header = $this->document->current();
184	6	if (empty($header)) {
185	2	throw new RuntimeException(sprintf('The header record does not exist or is empty at offset: `%s`', $offset));
186		}
187
188	4	if (0 === $offset) {
189	2	return $this->removeBOM($header, mb_strlen($this->getInputBOM()), $this->enclosure);
190		}
191
192	2	return $header;
193		}
194
195		/**
196		* Strip the BOM sequence from a record
197		*
198		* @param string[] $record
199		* @param int $bom_length
200		* @param string $enclosure
201		*
202		* @return string[]
203		*/
204	8	protected function removeBOM(array $record, int $bom_length, string $enclosure): array
205		{
206	8	if (0 == $bom_length) {
207	2	return $record;
208		}
209
210	6	$record[0] = mb_substr($record[0], $bom_length);
211	6	if ($enclosure == mb_substr($record[0], 0, 1) && $enclosure == mb_substr($record[0], -1, 1)) {
212	2	$record[0] = mb_substr($record[0], 1, -1);
213		}
214
215	6	return $record;
216		}
217
218		/**
219		* @inheritdoc
220		*/
221	6	public function __call($method, array $arguments)
222		{
223	6	$whitelisted = ['fetchColumn' => 1, 'fetchPairs' => 1, 'fetchOne' => 1, 'fetchAll' => 1];
224	6	if (isset($whitelisted[$method])) {
225	2	return (new ResultSet($this->getRecords(), $this->getHeader()))->$method(...$arguments);
226		}
227
228	4	throw new BadMethodCallException(sprintf('%s::%s() method does not exist', __CLASS__, $method));
229		}
230
231		/**
232		* @inheritdoc
233		*/
234	2	public function count(): int
235		{
236	2	if (-1 === $this->nb_records) {
237	2	$this->nb_records = iterator_count($this->getRecords());
238		}
239
240	2	return $this->nb_records;
241		}
242
243		/**
244		* @inheritdoc
245		*/
246	2	public function getIterator(): Iterator
247		{
248	2	return $this->getRecords();
249		}
250
251		/**
252		* Returns the CSV records in an iterator object.
253		*
254		* Each CSV record is represented as a simple array of string or null values.
255		*
256		* If the CSV document has a header record then each record is combined
257		* to each header record and the header record is removed from the iterator.
258		*
259		* If the CSV document is inconsistent. Missing record fields are
260		* filled with null values while extra record fields are strip from
261		* the returned object.
262		*
263		* @param array $header
264		*
265		* @return Iterator
266		*/
267	6	public function getRecords(array $header = []): Iterator
268		{
269	6	$header = $this->computeHeader($header);
270		$normalized = function ($record): bool {
271	4	return is_array($record) && $record != [null];
272	2	};
273	4	$bom = $this->getInputBOM();
274	4	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
275	4	$this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
276
277	4	$records = $this->stripBOM(new CallbackFilterIterator($this->document, $normalized), $bom);
278	4	if (null !== $this->header_offset) {
279		$records = new CallbackFilterIterator($records, function (array $record, int $offset): bool {
280	4	return $offset !== $this->header_offset;
281	4	});
282		}
283
284	4	return $this->combineHeader($records, $header);
285		}
286
287		/**
288		* Returns the header to be used for iteration
289		*
290		* @param string[] $header
291		*
292		* @throws RuntimeException If the header contains non unique column name
293		*
294		* @return string[]
295		*/
296	10	protected function computeHeader(array $header)
297		{
298	10	if (empty($header)) {
299	8	$header = $this->getHeader();
300		}
301
302	10	if ($header === array_unique(array_filter($header, 'is_string'))) {
303	8	return $header;
304		}
305
306	2	throw new RuntimeException('The header record must be empty or a flat array with unique string values');
307		}
308
309		/**
310		* Add the CSV header if present and valid
311		*
312		* @param Iterator $iterator
313		* @param array $header
314		*
315		* @return Iterator
316		*/
317	14	protected function combineHeader(Iterator $iterator, array $header): Iterator
318		{
319	14	if (empty($header)) {
320	8	return $iterator;
321		}
322
323	8	$field_count = count($header);
324		$mapper = function (array $record) use ($header, $field_count): array {
325	8	if (count($record) != $field_count) {
326	4	$record = array_slice(array_pad($record, $field_count, $this->record_padding_value), 0, $field_count);
327		}
328
329	8	return array_combine($header, $record);
330	8	};
331
332	8	return new MapIterator($iterator, $mapper);
333		}
334
335		/**
336		* Strip the BOM sequence if present
337		*
338		* @param Iterator $iterator
339		* @param string $bom
340		*
341		* @return Iterator
342		*/
343	10	protected function stripBOM(Iterator $iterator, string $bom): Iterator
344		{
345	10	if ('' === $bom) {
346	4	return $iterator;
347		}
348
349	6	$bom_length = mb_strlen($bom);
350	6	$mapper = function (array $record, int $index) use ($bom_length): array {
351	6	if (0 != $index) {
352	2	return $record;
353		}
354
355	6	return $this->removeBOM($record, $bom_length, $this->enclosure);
356	6	};
357
358	6	return new MapIterator($iterator, $mapper);
359		}
360
361		/**
362		* Set the record padding value
363		*
364		* @param mixed $record_padding_value
365		*
366		* @return static
367		*/
368	2	public function setRecordPaddingValue($record_padding_value): self
369		{
370	2	$this->record_padding_value = $record_padding_value;
371
372	2	return $this;
373		}
374
375		/**
376		* Selects the record to be used as the CSV header
377		*
378		* Because of the header is represented as an array, to be valid
379		* a header MUST contain only unique string value.
380		*
381		* @param int\|null $offset the header record offset
382		*
383		* @return static
384		*/
385	2	public function setHeaderOffset($offset): self
386		{
387	2	if (null !== $offset) {
388	2	$offset = $this->filterMinRange($offset, 0, __METHOD__.'() expects the header offset index to be a positive integer or 0, %s given');
389		}
390
391	2	if ($offset !== $this->header_offset) {
392	2	$this->header_offset = $offset;
393	2	$this->resetProperties();
394		}
395
396	2	return $this;
397		}
398
399		/**
400		* @inheritdoc
401		*/
402	2	protected function resetProperties()
403		{
404	2	$this->nb_records = -1;
405	2	$this->header = [];
406	2	}
407		}
408

thephpleague / csv

Push — master ( 78899c...34ee7e )

Reader::supportsHeaderAsRecordKeys() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like