CsvWriter::renderVersion() - Code Metrics - Inspection of "update tests" - browscap/browscap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1579)

by Thomas

created 2017-09-19 08:23 UTC

CsvWriter::renderVersion() A

↳ Parent: CsvWriter

Complexity

Conditions	4
Paths	5

Size

Total Lines	20
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	20
ccs	11
cts	11
cp	1
rs	9.2
c	0
b	0
f	0
cc	4
eloc	10
nc	5
nop	1
crap	4

<?php
/**
 * This file is part of the browscap package.
 *
 * Copyright (c) 1998-2017, Browser Capabilities Project
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types = 1);
namespace Browscap\Writer;

use Browscap\Data\DataCollection;
use Browscap\Filter\FilterInterface;
use Browscap\Formatter\FormatterInterface;
use Psr\Log\LoggerInterface;

/**
 * Class CsvWriter
 *
 * @category   Browscap
 *
 * @author     Thomas Müller <[email protected]>
 */
class CsvWriter implements WriterInterface
{
    /**
     * @var \Psr\Log\LoggerInterface
     */
    private $logger;

    /**
     * @var resource
     */
    private $file;

    /**
     * @var \Browscap\Formatter\FormatterInterface
     */
    private $formatter;

    /**
     * @var \Browscap\Filter\FilterInterface
     */
    private $filter;

    /**
     * @var bool
     */
    private $silent = false;

    /**
     * @var array
     */
    private $outputProperties = [];

    /**
     * @param string                   $file
     * @param \Psr\Log\LoggerInterface $logger
     */
    public function __construct(string $file, LoggerInterface $logger)
    {
        $this->logger = $logger;
        $this->file   = fopen($file, 'w');
    }

    /**
     * returns the Type of the writer
     *
     * @return string
     */
    public function getType() : string
    {
        return 'csv';
    }

    /**
     * closes the Writer and the written File
     */
    public function close() : void
    {
        fclose($this->file);
    }

    /**
     * @param \Browscap\Formatter\FormatterInterface $formatter
     */
    public function setFormatter(FormatterInterface $formatter) : void
    {
        $this->formatter = $formatter;
    }

    /**
     * @return \Browscap\Formatter\FormatterInterface
     */
    public function getFormatter() : FormatterInterface
    {
        return $this->formatter;
    }

    /**
     * @param \Browscap\Filter\FilterInterface $filter
     */
    public function setFilter(FilterInterface $filter) : void
    {
        $this->filter             = $filter;
        $this->outputProperties   = [];
    }

    /**
     * @return \Browscap\Filter\FilterInterface
     */
    public function getFilter() : FilterInterface
    {
        return $this->filter;
    }

    /**
     * @param bool $silent
     */
    public function setSilent(bool $silent) : void
    {
        $this->silent = $silent;
    }

    /**
     * @return bool
     */
    public function isSilent() : bool
    {
        return $this->silent;
    }

    /**
     * Generates a start sequence for the output file
     */
    public function fileStart() : void
    {
        // nothing to do here
    }

    /**
     * Generates a end sequence for the output file
     */
    public function fileEnd() : void
    {
        // nothing to do here
    }

    /**
     * Generate the header
     *
     * @param string[] $comments
     */
    public function renderHeader(array $comments = []) : void
    {
        // nothing to do here
    }

    /**
     * renders the version information
     *
     * @param string[] $versionData
     */
    public function renderVersion(array $versionData = []) : void
    {
        if ($this->isSilent()) {
            return;
        }

        $this->logger->debug('rendering version information');

        fwrite($this->file, '"GJK_Browscap_Version","GJK_Browscap_Version"' . PHP_EOL);

        if (!isset($versionData['version'])) {
            $versionData['version'] = '0';
        }

        if (!isset($versionData['released'])) {
            $versionData['released'] = '';
        }

        fwrite($this->file, '"' . $versionData['version'] . '","' . $versionData['released'] . '"' . PHP_EOL);
    }

    /**
     * renders the header for all divisions
     *
     * @param \Browscap\Data\DataCollection $collection
     */
    public function renderAllDivisionsHeader(DataCollection $collection) : void
    {
        $division = $collection->getDefaultProperties();
        $ua       = $division->getUserAgents();

        if (empty($ua[0]['properties']) || !is_array($ua[0]['properties'])) {
            return;
        }

        $defaultproperties = $ua[0]['properties'];
        $properties        = array_merge(
            ['PropertyName', 'MasterParent', 'LiteMode', 'Parent'],
            array_keys($defaultproperties)
        );

        $values = [];

        foreach ($properties as $property) {
            if (!isset($this->outputProperties[$property])) {

                $this->outputProperties[$property] = $this->filter->isOutputProperty($property, $this);
            }

            if (!$this->outputProperties[$property]) {
                continue;
            }

            $values[] = $this->formatter->formatPropertyName($property);
        }

        fwrite($this->file, implode(',', $values) . PHP_EOL);
    }

    /**
     * renders the header for a division
     *
     * @param string $division
     * @param string $parent
     */
    public function renderDivisionHeader(string $division, string $parent = 'DefaultProperties') : void
    {
        // nothing to do here
    }

    /**
     * renders the header for a section
     *
     * @param string $sectionName
     *
     * @return \Browscap\Writer\WriterInterface
     */
    public function renderSectionHeader(string $sectionName) : void
    {
        // nothing to do here
    }

    /**
     * renders all found useragents into a string
     *
     * @param (int|string|true)[]           $section
     * @param \Browscap\Data\DataCollection $collection
     * @param array[]                       $sections
     * @param string                        $sectionName
     *
     * @throws \InvalidArgumentException
     */
    public function renderSectionBody(array $section, DataCollection $collection, array $sections = [], string $sectionName = '') : void
    {
        if ($this->isSilent()) {
            return;
        }

        $division          = $collection->getDefaultProperties();
        $ua                = $division->getUserAgents();
        $defaultproperties = $ua[0]['properties'];
        $properties        = array_merge(
            ['PropertyName', 'MasterParent', 'LiteMode', 'Parent'],
            array_keys($defaultproperties)
        );

        $section['PropertyName'] = $sectionName;
        $section['MasterParent'] = $this->detectMasterParent($sectionName, $section);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        if (in_array($sectionName, ['DefaultProperties', '*'])) {
            $section['LiteMode'] = 'true';
        } else {
            $section['LiteMode'] = ((!isset($section['lite']) || !$section['lite']) ? 'false' : 'true');
        }

        $values = [];

        foreach ($properties as $property) {
            if (!isset($this->outputProperties[$property])) {

                $this->outputProperties[$property] = $this->filter->isOutputProperty($property, $this);
            }

            if (!$this->outputProperties[$property]) {
                continue;
            }

            if (isset($section[$property])) {
                $value = $section[$property];
            } else {
                $value = '';
            }

            $values[] = $this->formatter->formatPropertyValue($value, $property);
        }

        fwrite($this->file, implode(',', $values) . PHP_EOL);
    }

    /**
     * renders the footer for a section
     *
     * @param string $sectionName
     */
    public function renderSectionFooter(string $sectionName = '') : void
    {
        // nothing to do here
    }

    /**
     * renders the footer for a division
     */
    public function renderDivisionFooter() : void
    {
        // nothing to do here
    }

    /**
     * renders the footer for all divisions
     */
    public function renderAllDivisionsFooter() : void
    {
        // nothing to do here
    }

    /**
     * @param string   $key
     * @param string[] $properties
     *
     * @return string
     */
    private function detectMasterParent(string $key, array $properties) : string
    {
        $this->logger->debug('check if the element can be marked as "MasterParent"');

        if (in_array($key, ['DefaultProperties', '*'])
            || empty($properties['Parent'])
            || 'DefaultProperties' === $properties['Parent']
        ) {
            return 'true';
        }

        return 'false';
    }
}


1			<?php
2			/**
3			* This file is part of the browscap package.
4			*
5			* Copyright (c) 1998-2017, Browser Capabilities Project
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			declare(strict_types = 1);
12			namespace Browscap\Writer;
13
14			use Browscap\Data\DataCollection;
15			use Browscap\Filter\FilterInterface;
16			use Browscap\Formatter\FormatterInterface;
17			use Psr\Log\LoggerInterface;
18
19			/**
20			* Class CsvWriter
21			*
22			* @category Browscap
23			*
24			* @author Thomas Müller <[email protected]>
25			*/
26			class CsvWriter implements WriterInterface
27			{
28			/**
29			* @var \Psr\Log\LoggerInterface
30			*/
31			private $logger;
32
33			/**
34			* @var resource
35			*/
36			private $file;
37
38			/**
39			* @var \Browscap\Formatter\FormatterInterface
40			*/
41			private $formatter;
42
43			/**
44			* @var \Browscap\Filter\FilterInterface
45			*/
46			private $filter;
47
48			/**
49			* @var bool
50			*/
51			private $silent = false;
52
53			/**
54			* @var array
55			*/
56			private $outputProperties = [];
57
58			/**
59			* @param string $file
60			* @param \Psr\Log\LoggerInterface $logger
61			*/
62	21		public function __construct(string $file, LoggerInterface $logger)
63			{
64	21		$this->logger = $logger;
65	21		$this->file = fopen($file, 'w');
66	21		}
67
68			/**
69			* returns the Type of the writer
70			*
71			* @return string
72			*/
73	1		public function getType() : string
74			{
75	1		return 'csv';
76			}
77
78			/**
79			* closes the Writer and the written File
80			*/
81	20		public function close() : void
82			{
83	20		fclose($this->file);
84	20		}
85
86			/**
87			* @param \Browscap\Formatter\FormatterInterface $formatter
88			*/
89	4		public function setFormatter(FormatterInterface $formatter) : void
90			{
91	4		$this->formatter = $formatter;
92	4		}
93
94			/**
95			* @return \Browscap\Formatter\FormatterInterface
96			*/
97	1		public function getFormatter() : FormatterInterface
98			{
99	1		return $this->formatter;
100			}
101
102			/**
103			* @param \Browscap\Filter\FilterInterface $filter
104			*/
105	4		public function setFilter(FilterInterface $filter) : void
106			{
107	4		$this->filter = $filter;
108	4		$this->outputProperties = [];
109	4		}
110
111			/**
112			* @return \Browscap\Filter\FilterInterface
113			*/
114	1		public function getFilter() : FilterInterface
115			{
116	1		return $this->filter;
117			}
118
119			/**
120			* @param bool $silent
121			*/
122	8		public function setSilent(bool $silent) : void
123			{
124	8		$this->silent = $silent;
125	8		}
126
127			/**
128			* @return bool
129			*/
130	7		public function isSilent() : bool
131			{
132	7		return $this->silent;
133			}
134
135			/**
136			* Generates a start sequence for the output file
137			*/
138	1		public function fileStart() : void
139			{
140			// nothing to do here
141	1		}
142
143			/**
144			* Generates a end sequence for the output file
145			*/
146	1		public function fileEnd() : void
147			{
148			// nothing to do here
149	1		}
150
151			/**
152			* Generate the header
153			*
154			* @param string[] $comments
155			*/
156	1		public function renderHeader(array $comments = []) : void
157			{
158			// nothing to do here
159	1		}
160
161			/**
162			* renders the version information
163			*
164			* @param string[] $versionData
165			*/
166	4		public function renderVersion(array $versionData = []) : void
167			{
168	4		if ($this->isSilent()) {
169	1		return;
170			}
171
172	3		$this->logger->debug('rendering version information');
173
174	3		fwrite($this->file, '"GJK_Browscap_Version","GJK_Browscap_Version"' . PHP_EOL);
175
176	3		if (!isset($versionData['version'])) {
177	1		$versionData['version'] = '0';
178			}
179
180	3		if (!isset($versionData['released'])) {
181	1		$versionData['released'] = '';
182			}
183
184	3		fwrite($this->file, '"' . $versionData['version'] . '","' . $versionData['released'] . '"' . PHP_EOL);
185	3		}
186
187			/**
188			* renders the header for all divisions
189			*
190			* @param \Browscap\Data\DataCollection $collection
191			*/
192	2		public function renderAllDivisionsHeader(DataCollection $collection) : void
193			{
194	2		$division = $collection->getDefaultProperties();
195	2		$ua = $division->getUserAgents();
196
197	2		if (empty($ua[0]['properties']) \|\| !is_array($ua[0]['properties'])) {
198	1		return;
199			}
200
201	1		$defaultproperties = $ua[0]['properties'];
202	1		$properties = array_merge(
203	1		['PropertyName', 'MasterParent', 'LiteMode', 'Parent'],
204	1		array_keys($defaultproperties)
205			);
206
207	1		$values = [];
208
209	1		foreach ($properties as $property) {
210	1	View Code Duplication	if (!isset($this->outputProperties[$property])) {
			0 ignored issues – show Duplication introduced 2016-05-29 07:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
211	1		$this->outputProperties[$property] = $this->filter->isOutputProperty($property, $this);
212			}
213
214	1		if (!$this->outputProperties[$property]) {
215			continue;
216			}
217
218	1		$values[] = $this->formatter->formatPropertyName($property);
219			}
220
221	1		fwrite($this->file, implode(',', $values) . PHP_EOL);
222	1		}
223
224			/**
225			* renders the header for a division
226			*
227			* @param string $division
228			* @param string $parent
229			*/
230	1		public function renderDivisionHeader(string $division, string $parent = 'DefaultProperties') : void
231			{
232			// nothing to do here
233	1		}
234
235			/**
236			* renders the header for a section
237			*
238			* @param string $sectionName
239			*
240			* @return \Browscap\Writer\WriterInterface
241			*/
242	1		public function renderSectionHeader(string $sectionName) : void
243			{
244			// nothing to do here
245	1		}
246
247			/**
248			* renders all found useragents into a string
249			*
250			* @param (int\|string\|true)[] $section
251			* @param \Browscap\Data\DataCollection $collection
252			* @param array[] $sections
253			* @param string $sectionName
254			*
255			* @throws \InvalidArgumentException
256			*/
257	2		public function renderSectionBody(array $section, DataCollection $collection, array $sections = [], string $sectionName = '') : void
258			{
259	2		if ($this->isSilent()) {
260	1		return;
261			}
262
263	1		$division = $collection->getDefaultProperties();
264	1		$ua = $division->getUserAgents();
265	1		$defaultproperties = $ua[0]['properties'];
266	1		$properties = array_merge(
267	1		['PropertyName', 'MasterParent', 'LiteMode', 'Parent'],
268	1		array_keys($defaultproperties)
269			);
270
271	1		$section['PropertyName'] = $sectionName;
272	1		$section['MasterParent'] = $this->detectMasterParent($sectionName, $section);
			0 ignored issues – show Documentation introduced 2017-09-14 21:34 UTC by Report Bug Copy Issue Report `$section` is of type `array<integer\|string,int...ropertyName":"string"}>`, but the function expects a `array<integer,string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
273
274	1		if (in_array($sectionName, ['DefaultProperties', '*'])) {
275			$section['LiteMode'] = 'true';
276			} else {
277	1		$section['LiteMode'] = ((!isset($section['lite']) \|\| !$section['lite']) ? 'false' : 'true');
278			}
279
280	1		$values = [];
281
282	1		foreach ($properties as $property) {
283	1	View Code Duplication	if (!isset($this->outputProperties[$property])) {
			0 ignored issues – show Duplication introduced 2015-11-22 15:21 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
284	1		$this->outputProperties[$property] = $this->filter->isOutputProperty($property, $this);
285			}
286
287	1		if (!$this->outputProperties[$property]) {
288			continue;
289			}
290
291	1		if (isset($section[$property])) {
292	1		$value = $section[$property];
293			} else {
294	1		$value = '';
295			}
296
297	1		$values[] = $this->formatter->formatPropertyValue($value, $property);
298			}
299
300	1		fwrite($this->file, implode(',', $values) . PHP_EOL);
301	1		}
302
303			/**
304			* renders the footer for a section
305			*
306			* @param string $sectionName
307			*/
308	1		public function renderSectionFooter(string $sectionName = '') : void
309			{
310			// nothing to do here
311	1		}
312
313			/**
314			* renders the footer for a division
315			*/
316	1		public function renderDivisionFooter() : void
317			{
318			// nothing to do here
319	1		}
320
321			/**
322			* renders the footer for all divisions
323			*/
324	1		public function renderAllDivisionsFooter() : void
325			{
326			// nothing to do here
327	1		}
328
329			/**
330			* @param string $key
331			* @param string[] $properties
332			*
333			* @return string
334			*/
335	1		private function detectMasterParent(string $key, array $properties) : string
336			{
337	1		$this->logger->debug('check if the element can be marked as "MasterParent"');
338
339	1		if (in_array($key, ['DefaultProperties', '*'])
340	1		\|\| empty($properties['Parent'])
341			\|\| 'DefaultProperties' === $properties['Parent']
342			) {
343	1		return 'true';
344			}
345
346			return 'false';
347			}
348			}
349

browscap / browscap

Pull Request — master (#1579)

CsvWriter::renderVersion() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like