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

Completed

Push — master ( 775d39...3ffbf6 )

by ignace nyamagana

created 2017-04-28 08:05 UTC

Reader::supportsHeaderAsRecordKeys() A

↳ Parent: Reader

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 CallbackFilterIterator;
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
 *
 */
class Reader extends AbstractCsv implements IteratorAggregate
{
    /**
     * @inheritdoc
     */
    protected $stream_filter_mode = STREAM_FILTER_READ;

    /**
     * CSV Document header offset
     *
     * @var int|null
     */
    protected $header_offset;

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

    /**
     * Tell whether the header needs to be re-generated
     *
     * @var bool
     */
    protected $is_header_loaded = false;

    /**
     * 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 a CSV records collection
     *
     * @param Statement $stmt
     *
     * @return ResultSet
     */
    public function select(Statement $stmt): ResultSet
    {
        return $stmt->process($this);
    }

    /**
     * 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, 'The number of records to consider must be a valid positive integer');
        $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 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.
     *
     * @see Reader::getIterator()
     *
     * @throws RuntimeException If the header contains non unique column name
     *
     * @return Iterator
     */
    public function getRecords(): Iterator
    {
        return $this->getIterator();
    }

    /**
     * @inheritdoc
     */
    public function getIterator(): Iterator
    {
        $bom = $this->getInputBOM();
        if (!$this->supportsHeaderAsRecordKeys()) {
            throw new RuntimeException('The header record must be empty or a flat array with unique string values');
        }
        $this->document->setFlags(SplFileObject::READ_CSV | SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY);
        $this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
        $normalized = function ($record): bool {
            return is_array($record) && $record != [null];
        };

        $iterator = $this->combineHeader(new CallbackFilterIterator($this->document, $normalized));

        return $this->stripBOM($iterator, $bom);
    }

    /**
     * Returns wether the selected header can be combine to each record
     *
     * A valid header must be empty or contains unique string field names
     *
     * @return bool
     */
    public function supportsHeaderAsRecordKeys(): bool
    {
        $header = $this->getHeader();

        return empty($header) || $header === array_unique(array_filter($header, 'is_string'));
    }

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

        $this->is_header_loaded = true;
        $this->header = [];
        if (null !== $this->header_offset) {
            $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) {
            $header = $this->removeBOM($header, mb_strlen($this->getInputBOM()), $this->enclosure);
        }

        return $header;
    }

    /**
     * Add the CSV header if present and valid
     *
     * @param Iterator $iterator
     *
     * @return Iterator
     */
    protected function combineHeader(Iterator $iterator): Iterator
    {
        if (null === $this->header_offset) {
            return $iterator;
        }

        $iterator = new CallbackFilterIterator($iterator, function (array $record, int $offset): bool {
            return $offset != $this->header_offset;
        });

        $header = $this->getHeader();
        $header_count = count($header);
        $mapper = function (array $record) use ($header_count, $header): array {
            if ($header_count != count($record)) {
                $record = array_slice(array_pad($record, $header_count, null), 0, $header_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);
    }

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

    /**
     * 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, 'The header offset index must be a positive integer or 0');
        }

        if ($offset !== $this->header_offset) {
            $this->header_offset = $offset;
            $this->resetProperties();
        }

        return $this;
    }

    /**
     * @inheritdoc
     */
    protected function resetProperties()
    {
        return $this->is_header_loaded = false;
    }
}


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 CallbackFilterIterator;
18		use Iterator;
19		use IteratorAggregate;
20		use League\Csv\Exception\RuntimeException;
21		use LimitIterator;
22		use SplFileObject;
23
24		/**
25		* A class to manage records selection from a CSV document
26		*
27		* @package League.csv
28		* @since 3.0.0
29		*
30		*/
31		class Reader extends AbstractCsv implements IteratorAggregate
32		{
33		/**
34		* @inheritdoc
35		*/
36		protected $stream_filter_mode = STREAM_FILTER_READ;
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		* Tell whether the header needs to be re-generated
54		*
55		* @var bool
56		*/
57		protected $is_header_loaded = false;
58
59		/**
60		* Returns the record offset used as header
61		*
62		* If no CSV record is used this method MUST return null
63		*
64		* @return int\|null
65		*/
66	2	public function getHeaderOffset()
67		{
68	2	return $this->header_offset;
69		}
70
71		/**
72		* Returns a CSV records collection
73		*
74		* @param Statement $stmt
75		*
76		* @return ResultSet
77		*/
78	2	public function select(Statement $stmt): ResultSet
79		{
80	2	return $stmt->process($this);
81		}
82
83		/**
84		* Detect Delimiters occurences in the CSV
85		*
86		* Returns a associative array where each key represents
87		* a valid delimiter and each value the number of occurences
88		*
89		* @param string[] $delimiters the delimiters to consider
90		* @param int $nb_records Detection is made using $nb_records of the CSV
91		*
92		* @return array
93		*/
94	8	public function fetchDelimitersOccurrence(array $delimiters, int $nb_records = 1): array
95		{
96		$filter = function ($value): bool {
97	6	return 1 == strlen($value);
98	4	};
99
100	8	$nb_records = $this->filterMinRange($nb_records, 1, 'The number of records to consider must be a valid positive integer');
101	6	$delimiters = array_unique(array_filter($delimiters, $filter));
102		$reducer = function (array $res, string $delimiter) use ($nb_records): array {
103	6	$res[$delimiter] = $this->getCellCount($delimiter, $nb_records);
104
105	6	return $res;
106	6	};
107
108	6	$res = array_reduce($delimiters, $reducer, []);
109	6	arsort($res, SORT_NUMERIC);
110
111	6	return $res;
112		}
113
114		/**
115		* Returns the cell count for a specified delimiter
116		* and a specified number of records
117		*
118		* @param string $delimiter CSV delimiter
119		* @param int $nb_records CSV records to consider
120		*
121		* @return int
122		*/
123	6	protected function getCellCount(string $delimiter, int $nb_records): int
124		{
125		$filter = function ($record): bool {
126	6	return is_array($record) && count($record) > 1;
127	3	};
128
129	6	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
130	6	$this->document->setCsvControl($delimiter, $this->enclosure, $this->escape);
131	6	$iterator = new CallbackFilterIterator(new LimitIterator($this->document, 0, $nb_records), $filter);
132
133	6	return count(iterator_to_array($iterator, false), COUNT_RECURSIVE);
134		}
135
136		/**
137		* Returns the CSV records in an iterator object.
138		*
139		* Each CSV record is represented as a simple array of string or null values.
140		*
141		* If the CSV document has a header record then each record is combined
142		* to each header record and the header record is removed from the iterator.
143		*
144		* If the CSV document is inconsistent. Missing record fields are
145		* filled with null values while extra record fields are strip from
146		* the returned object.
147		*
148		* @see Reader::getIterator()
149		*
150		* @throws RuntimeException If the header contains non unique column name
151		*
152		* @return Iterator
153		*/
154	100	public function getRecords(): Iterator
155		{
156	100	return $this->getIterator();
157		}
158
159		/**
160		* @inheritdoc
161		*/
162	106	public function getIterator(): Iterator
163		{
164	106	$bom = $this->getInputBOM();
165	106	if (!$this->supportsHeaderAsRecordKeys()) {
166	2	throw new RuntimeException('The header record must be empty or a flat array with unique string values');
167		}
168	102	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
169	102	$this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
170		$normalized = function ($record): bool {
171	88	return is_array($record) && $record != [null];
172	51	};
173
174	102	$iterator = $this->combineHeader(new CallbackFilterIterator($this->document, $normalized));
175
176	102	return $this->stripBOM($iterator, $bom);
177		}
178
179		/**
180		* Returns wether the selected header can be combine to each record
181		*
182		* A valid header must be empty or contains unique string field names
183		*
184		* @return bool
185		*/
186	106	public function supportsHeaderAsRecordKeys(): bool
187		{
188	106	$header = $this->getHeader();
189
190	104	return empty($header) \|\| $header === array_unique(array_filter($header, 'is_string'));
191		}
192
193		/**
194		* Returns the CSV record header
195		*
196		* The returned header is represented as an array of string values
197		*
198		* @return string[]
199		*/
200	108	public function getHeader(): array
201		{
202	108	if ($this->is_header_loaded) {
203	102	return $this->header;
204		}
205
206	108	$this->is_header_loaded = true;
207	108	$this->header = [];
208	108	if (null !== $this->header_offset) {
209	36	$this->header = $this->setHeader($this->header_offset);
210		}
211
212	106	return $this->header;
213		}
214
215		/**
216		* Determine the CSV record header
217		*
218		* @param int $offset
219		*
220		* @throws RuntimeException If the header offset is an integer
221		* and the corresponding record is missing
222		* or is an empty array
223		*
224		* @return string[]
225		*/
226	36	protected function setHeader(int $offset): array
227		{
228	36	$this->document->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
229	36	$this->document->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
230	36	$this->document->seek($offset);
231	36	$header = $this->document->current();
232	36	if (empty($header)) {
233	2	throw new RuntimeException(sprintf('The header record does not exist or is empty at offset: `%s`', $offset));
234		}
235
236	34	if (0 === $offset) {
237	30	$header = $this->removeBOM($header, mb_strlen($this->getInputBOM()), $this->enclosure);
238		}
239
240	34	return $header;
241		}
242
243		/**
244		* Add the CSV header if present and valid
245		*
246		* @param Iterator $iterator
247		*
248		* @return Iterator
249		*/
250	102	protected function combineHeader(Iterator $iterator): Iterator
251		{
252	102	if (null === $this->header_offset) {
253	72	return $iterator;
254		}
255
256		$iterator = new CallbackFilterIterator($iterator, function (array $record, int $offset): bool {
257	22	return $offset != $this->header_offset;
258	30	});
259
260	30	$header = $this->getHeader();
261	30	$header_count = count($header);
262		$mapper = function (array $record) use ($header_count, $header): array {
263	22	if ($header_count != count($record)) {
264	2	$record = array_slice(array_pad($record, $header_count, null), 0, $header_count);
265		}
266
267	22	return array_combine($header, $record);
268	30	};
269
270	30	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	102	protected function stripBOM(Iterator $iterator, string $bom): Iterator
282		{
283	102	if ('' === $bom) {
284	82	return $iterator;
285		}
286
287	20	$bom_length = mb_strlen($bom);
288	20	$mapper = function (array $record, int $index) use ($bom_length): array {
289	20	if (0 != $index) {
290	18	return $record;
291		}
292
293	12	return $this->removeBOM($record, $bom_length, $this->enclosure);
294	20	};
295
296	20	return new MapIterator($iterator, $mapper);
297		}
298
299		/**
300		* Strip the BOM sequence from a record
301		*
302		* @param string[] $record
303		* @param int $bom_length
304		* @param string $enclosure
305		*
306		* @return string[]
307		*/
308	42	protected function removeBOM(array $record, int $bom_length, string $enclosure): array
309		{
310	42	if (0 == $bom_length) {
311	22	return $record;
312		}
313
314	20	$record[0] = mb_substr($record[0], $bom_length);
315	20	if ($enclosure == mb_substr($record[0], 0, 1) && $enclosure == mb_substr($record[0], -1, 1)) {
316	10	$record[0] = mb_substr($record[0], 1, -1);
317		}
318
319	20	return $record;
320		}
321
322		/**
323		* Selects the record to be used as the CSV header
324		*
325		* Because of the header is represented as an array, to be valid
326		* a header MUST contain only unique string value.
327		*
328		* @param int\|null $offset the header record offset
329		*
330		* @return static
331		*/
332	40	public function setHeaderOffset($offset): self
333		{
334	40	if (null !== $offset) {
335	36	$offset = $this->filterMinRange($offset, 0, 'The header offset index must be a positive integer or 0');
336		}
337
338	40	if ($offset !== $this->header_offset) {
339	36	$this->header_offset = $offset;
340	36	$this->resetProperties();
341		}
342
343	40	return $this;
344		}
345
346		/**
347		* @inheritdoc
348		*/
349	52	protected function resetProperties()
350		{
351	52	return $this->is_header_loaded = false;
352		}
353		}
354

thephpleague / csv

Push — master ( 775d39...3ffbf6 )

Reader::supportsHeaderAsRecordKeys() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like