CsvDeserializationVisitor::visitArray() - Code Metrics - Inspection of "Add CSV format support" - egeloen/ivory-serializer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c17605...0959b6 )

by Eric

created 2016-09-27 23:17 UTC

CsvDeserializationVisitor::visitArray() A

↳ Parent: CsvDeserializationVisitor

Complexity

Conditions	2
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

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

<?php

/*
 * This file is part of the Ivory Serializer package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Ivory\Serializer\Visitor\Csv;

use Ivory\Serializer\Context\ContextInterface;
use Ivory\Serializer\Instantiator\InstantiatorInterface;
use Ivory\Serializer\Mapping\TypeMetadataInterface;
use Ivory\Serializer\Mutator\MutatorInterface;
use Ivory\Serializer\Visitor\AbstractDeserializationVisitor;

/**
 * @author GeLo <[email protected]>
 */
class CsvDeserializationVisitor extends AbstractDeserializationVisitor
{
    /**
     * @var string
     */
    private $delimiter;

    /**
     * @var string
     */
    private $enclosure;

    /**
     * @var string
     */
    private $escapeChar;

    /**
     * @var string
     */
    private $keySeparator;

    /**
     * @param InstantiatorInterface $instantiator
     * @param MutatorInterface      $mutator
     * @param string                $delimiter
     * @param string                $enclosure
     * @param string                $escapeChar
     * @param string                $keySeparator
     */
    public function __construct(

        InstantiatorInterface $instantiator,
        MutatorInterface $mutator,
        $delimiter = ',',
        $enclosure = '"',
        $escapeChar = '\\',
        $keySeparator = '.'
    ) {
        parent::__construct($instantiator, $mutator);

        $this->delimiter = $delimiter;
        $this->enclosure = $enclosure;
        $this->escapeChar = $escapeChar;
        $this->keySeparator = $keySeparator;
    }

    /**
     * {@inheritdoc}
     */
    public function visitArray($data, TypeMetadataInterface $type, ContextInterface $context)
    {
        return parent::visitArray($data === '[]' ? [] : $data, $type, $context);
    }

    /**
     * {@inheritdoc}
     */
    protected function decode($data)
    {
        $result = $first = [];
        $headers = null;

        $resource = fopen('php://temp', 'r+');
        fwrite($resource, $data);
        rewind($resource);

        while (($fields = fgetcsv($resource, 0, $this->delimiter, $this->enclosure, $this->escapeChar)) !== false) {
            if ($fields === [null]) {
                continue;
            }

            $fieldsCount = count($fields);

            if ($headers === null) {
                $first = $fields;
                $headersCount = $fieldsCount;

                $headers = array_map(function ($value) {
                    return explode($this->keySeparator, $value);
                }, $fields);

                continue;
            }

            if ($fieldsCount !== $headersCount) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                throw new \InvalidArgumentException('FIXME');
            }

            foreach ($fields as $key => $value) {
                $this->expand($headers[$key], $value, $result);
            }
        }

        fclose($resource);

        if (!empty($result)) {
            return $result;
        }

        if (empty($first)) {
            return;
        }

        $result = $first;

        if (count($result) === 1) {
            $result = reset($result);
        }

        return $result;
    }

    /**
     * @param string[] $paths
     * @param mixed    $data
     * @param mixed[]  $result
     */
    private function expand(array $paths, $data, array &$result)
    {
        $path = array_shift($paths);

        if (empty($paths)) {
            $result[$path] = $data !== '' ? $data : null;
        } else {
            if (!isset($result[$path])) {
                $result[$path] = [];
            }

            $this->expand($paths, $data, $result[$path]);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the Ivory Serializer package.
5			*
6			* (c) Eric GELOEN <[email protected]>
7			*
8			* For the full copyright and license information, please read the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Ivory\Serializer\Visitor\Csv;
13
14			use Ivory\Serializer\Context\ContextInterface;
15			use Ivory\Serializer\Instantiator\InstantiatorInterface;
16			use Ivory\Serializer\Mapping\TypeMetadataInterface;
17			use Ivory\Serializer\Mutator\MutatorInterface;
18			use Ivory\Serializer\Visitor\AbstractDeserializationVisitor;
19
20			/**
21			* @author GeLo <[email protected]>
22			*/
23			class CsvDeserializationVisitor extends AbstractDeserializationVisitor
24			{
25			/**
26			* @var string
27			*/
28			private $delimiter;
29
30			/**
31			* @var string
32			*/
33			private $enclosure;
34
35			/**
36			* @var string
37			*/
38			private $escapeChar;
39
40			/**
41			* @var string
42			*/
43			private $keySeparator;
44
45			/**
46			* @param InstantiatorInterface $instantiator
47			* @param MutatorInterface $mutator
48			* @param string $delimiter
49			* @param string $enclosure
50			* @param string $escapeChar
51			* @param string $keySeparator
52			*/
53	984	View Code Duplication	public function __construct(
			0 ignored issues – show Duplication introduced 2016-09-27 23:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
54			InstantiatorInterface $instantiator,
55			MutatorInterface $mutator,
56			$delimiter = ',',
57			$enclosure = '"',
58			$escapeChar = '\\',
59			$keySeparator = '.'
60			) {
61	984		parent::__construct($instantiator, $mutator);
62
63	984		$this->delimiter = $delimiter;
64	984		$this->enclosure = $enclosure;
65	984		$this->escapeChar = $escapeChar;
66	984		$this->keySeparator = $keySeparator;
67	984		}
68
69			/**
70			* {@inheritdoc}
71			*/
72	18		public function visitArray($data, TypeMetadataInterface $type, ContextInterface $context)
73			{
74	18		return parent::visitArray($data === '[]' ? [] : $data, $type, $context);
75			}
76
77			/**
78			* {@inheritdoc}
79			*/
80	99		protected function decode($data)
81			{
82	99		$result = $first = [];
83	99		$headers = null;
84
85	99		$resource = fopen('php://temp', 'r+');
86	99		fwrite($resource, $data);
87	99		rewind($resource);
88
89	99		while (($fields = fgetcsv($resource, 0, $this->delimiter, $this->enclosure, $this->escapeChar)) !== false) {
90	99		if ($fields === [null]) {
91	3		continue;
92			}
93
94	96		$fieldsCount = count($fields);
95
96	96		if ($headers === null) {
97	96		$first = $fields;
98	96		$headersCount = $fieldsCount;
99
100	96		$headers = array_map(function ($value) {
101	96		return explode($this->keySeparator, $value);
102	96		}, $fields);
103
104	96		continue;
105			}
106
107	75		if ($fieldsCount !== $headersCount) {
			0 ignored issues – show Bug introduced 2016-09-27 23:21 UTC by Report Bug Copy Issue Report The variable `$headersCount` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
108			throw new \InvalidArgumentException('FIXME');
109			}
110
111	75		foreach ($fields as $key => $value) {
112	75		$this->expand($headers[$key], $value, $result);
113	50		}
114	50		}
115
116	99		fclose($resource);
117
118	99		if (!empty($result)) {
119	75		return $result;
120			}
121
122	24		if (empty($first)) {
123	3		return;
124			}
125
126	21		$result = $first;
127
128	21		if (count($result) === 1) {
129	21		$result = reset($result);
130	14		}
131
132	21		return $result;
133			}
134
135			/**
136			* @param string[] $paths
137			* @param mixed $data
138			* @param mixed[] $result
139			*/
140	75		private function expand(array $paths, $data, array &$result)
141			{
142	75		$path = array_shift($paths);
143
144	75		if (empty($paths)) {
145	75		$result[$path] = $data !== '' ? $data : null;
146	50		} else {
147	12		if (!isset($result[$path])) {
148	12		$result[$path] = [];
149	8		}
150
151	12		$this->expand($paths, $data, $result[$path]);
152			}
153	75		}
154			}
155

egeloen / ivory-serializer

Push — master ( c17605...0959b6 )

CsvDeserializationVisitor::visitArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like