CsvSerializationVisitor::flatten() - Code Metrics - Inspection of "[Type] Add exception support" - egeloen/ivory-serializer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f2b3c9...88814d )

by Eric

created 2017-01-30 22:59 UTC

CsvSerializationVisitor::flatten() B

↳ Parent: CsvSerializationVisitor

Complexity

Conditions	5
Paths	7

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	9
cts	9
cp	1
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	9
nc	7
nop	3
crap	5

<?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\Accessor\AccessorInterface;
use Ivory\Serializer\Context\ContextInterface;
use Ivory\Serializer\Mapping\TypeMetadataInterface;
use Ivory\Serializer\Visitor\AbstractSerializationVisitor;

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

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

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

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

    /**
     * @param AccessorInterface $accessor
     * @param string            $delimiter
     * @param string            $enclosure
     * @param string            $escapeChar
     * @param string            $keySeparator
     */
    public function __construct(
        AccessorInterface $accessor,
        $delimiter = ',',
        $enclosure = '"',
        $escapeChar = '\\',
        $keySeparator = '.'
    ) {
        parent::__construct($accessor);

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

    /**
     * {@inheritdoc}
     */
    public function visitArray($data, TypeMetadataInterface $type, ContextInterface $context)

    {
        if ($data === []) {
            return $this->visitData('[]', $type, $context);
        }

        return parent::visitArray($data, $type, $context);
    }

    /**
     * {@inheritdoc}
     */
    public function visitBoolean($data, TypeMetadataInterface $type, ContextInterface $context)
    {
        return $this->visitData($data ? 'true' : 'false', $type, $context);
    }

    /**
     * {@inheritdoc}
     */
    public function visitFloat($data, TypeMetadataInterface $type, ContextInterface $context)

    {
        $data = (string) $data;

        if (strpos($data, '.') === false) {
            $data .= '.0';
        }

        return $this->visitData($data, $type, $context);
    }

    /**
     * {@inheritdoc}
     */
    protected function encode($data)
    {
        $resource = fopen('php://temp,', 'w+');
        $headers = null;

        if (!is_array($data)) {
            $data = [[$data]];
        } elseif (!empty($data) && !$this->isIndexedArray($data)) {
            $data = [$data];
        }

        foreach ($data as $value) {
            $result = [];
            $this->flatten($value, $result);

            if ($headers === null) {
                if (!$this->isIndexedArray($result)) {
                    $headers = array_keys($result);
                    fputcsv($resource, $headers, $this->delimiter, $this->enclosure, $this->escapeChar);
                } else {
                    $headers = count($result);
                }
            } elseif (is_array($headers) && $headers !== array_keys($result)) {
                fclose($resource);

                throw new \InvalidArgumentException(sprintf(
                    'The input dimension is not equals for all entries (Expected: %d, got %d).',
                    count($headers),
                    count($result)
                ));
            } elseif ($headers !== count($result)) {
                fclose($resource);

                throw new \InvalidArgumentException(sprintf(
                    'The input dimension is not equals for all entries (Expected: %d, got %d).',
                    $headers,
                    count($result)
                ));
            }

            fputcsv($resource, $result, $this->delimiter, $this->enclosure, $this->escapeChar);
        }

        rewind($resource);
        $result = stream_get_contents($resource);
        fclose($resource);

        return $result;
    }

    /**
     * @param mixed[] $array
     * @param mixed[] $result
     * @param string  $parentKey
     */
    private function flatten(array $array, array &$result, $parentKey = '')
    {
        foreach ($array as $key => $value) {
            $key = $parentKey.$key;

            if ($value === []) {
                $value = null;
            }

            if (is_array($value)) {
                $this->flatten($value, $result, $key.$this->keySeparator);
            } else {
                $result[$key] = is_string($value) ? str_replace(PHP_EOL, '', $value) : $value;
            }
        }
    }

    /**
     * @param mixed[] $array
     *
     * @return bool
     */
    private function isIndexedArray(array $array)
    {
        return ctype_digit(implode('', array_keys($array)));
    }
}


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\Accessor\AccessorInterface;
15			use Ivory\Serializer\Context\ContextInterface;
16			use Ivory\Serializer\Mapping\TypeMetadataInterface;
17			use Ivory\Serializer\Visitor\AbstractSerializationVisitor;
18
19			/**
20			* @author GeLo <[email protected]>
21			*/
22			class CsvSerializationVisitor extends AbstractSerializationVisitor
23			{
24			/**
25			* @var string
26			*/
27			private $delimiter;
28
29			/**
30			* @var string
31			*/
32			private $enclosure;
33
34			/**
35			* @var string
36			*/
37			private $escapeChar;
38
39			/**
40			* @var string
41			*/
42			private $keySeparator;
43
44			/**
45			* @param AccessorInterface $accessor
46			* @param string $delimiter
47			* @param string $enclosure
48			* @param string $escapeChar
49			* @param string $keySeparator
50			*/
51	1376		public function __construct(
52			AccessorInterface $accessor,
53			$delimiter = ',',
54			$enclosure = '"',
55			$escapeChar = '\\',
56			$keySeparator = '.'
57			) {
58	1376		parent::__construct($accessor);
59
60	1376		$this->delimiter = $delimiter;
61	1376		$this->enclosure = $enclosure;
62	1376		$this->escapeChar = $escapeChar;
63	1376		$this->keySeparator = $keySeparator;
64	1376		}
65
66			/**
67			* {@inheritdoc}
68			*/
69	40	View Code Duplication	public function visitArray($data, TypeMetadataInterface $type, ContextInterface $context)
			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...
70			{
71	40		if ($data === []) {
72	28		return $this->visitData('[]', $type, $context);
73			}
74
75	24		return parent::visitArray($data, $type, $context);
76			}
77
78			/**
79			* {@inheritdoc}
80			*/
81	12		public function visitBoolean($data, TypeMetadataInterface $type, ContextInterface $context)
82			{
83	12		return $this->visitData($data ? 'true' : 'false', $type, $context);
84			}
85
86			/**
87			* {@inheritdoc}
88			*/
89	12	View Code Duplication	public function visitFloat($data, TypeMetadataInterface $type, ContextInterface $context)
			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...
90			{
91	12		$data = (string) $data;
92
93	12		if (strpos($data, '.') === false) {
94	12		$data .= '.0';
95	6		}
96
97	12		return $this->visitData($data, $type, $context);
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103	204		protected function encode($data)
104			{
105	204		$resource = fopen('php://temp,', 'w+');
106	204		$headers = null;
107
108	204		if (!is_array($data)) {
109	32		$data = [[$data]];
110	188		} elseif (!empty($data) && !$this->isIndexedArray($data)) {
111	168		$data = [$data];
112	84		}
113
114	204		foreach ($data as $value) {
115	200		$result = [];
116	200		$this->flatten($value, $result);
117
118	200		if ($headers === null) {
119	200		if (!$this->isIndexedArray($result)) {
120	168		$headers = array_keys($result);
121	168		fputcsv($resource, $headers, $this->delimiter, $this->enclosure, $this->escapeChar);
122	84		} else {
123	116		$headers = count($result);
124			}
125	100		} elseif (is_array($headers) && $headers !== array_keys($result)) {
126			fclose($resource);
127
128			throw new \InvalidArgumentException(sprintf(
129			'The input dimension is not equals for all entries (Expected: %d, got %d).',
130			count($headers),
131			count($result)
132			));
133			} elseif ($headers !== count($result)) {
134			fclose($resource);
135
136			throw new \InvalidArgumentException(sprintf(
137			'The input dimension is not equals for all entries (Expected: %d, got %d).',
138			$headers,
139	200		count($result)
140	102		));
141			}
142	204
143	204		fputcsv($resource, $result, $this->delimiter, $this->enclosure, $this->escapeChar);
144	204		}
145
146	204		rewind($resource);
147			$result = stream_get_contents($resource);
148			fclose($resource);
149
150			return $result;
151			}
152
153			/**
154	200		* @param mixed[] $array
155			* @param mixed[] $result
156	200		* @param string $parentKey
157	200		*/
158			private function flatten(array $array, array &$result, $parentKey = '')
159	200		{
160	8		foreach ($array as $key => $value) {
161	4		$key = $parentKey.$key;
162
163	200		if ($value === []) {
164	28		$value = null;
165	14		}
166	200
167			if (is_array($value)) {
168	100		$this->flatten($value, $result, $key.$this->keySeparator);
169	200		} else {
170			$result[$key] = is_string($value) ? str_replace(PHP_EOL, '', $value) : $value;
171			}
172			}
173			}
174
175			/**
176	200		* @param mixed[] $array
177			*
178	200		* @return bool
179			*/
180			private function isIndexedArray(array $array)
181			{
182			return ctype_digit(implode('', array_keys($array)));
183			}
184			}
185

egeloen / ivory-serializer

Push — master ( f2b3c9...88814d )

CsvSerializationVisitor::flatten() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like