Parser::parseComment() - Code Metrics - Inspection of "Implement translator and code comments" - raulferras/PHP-po-parser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/5.0.1 ( f078af...8bd6be )

by Raúl

created 2018-02-03 08:48 UTC

Parser::parseComment() B

↳ Parent: Parser

Complexity

Conditions	5
Paths	6

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	13
nc	6
nop	2

<?php

namespace Sepia\PoParser;

use Sepia\PoParser\Catalog\EntryFactory;
use Sepia\PoParser\Exception\ParseException;
use Sepia\PoParser\SourceHandler\FileSystem;
use Sepia\PoParser\SourceHandler\SourceHandler;
use Sepia\PoParser\SourceHandler\StringSource;

/**
 *    Copyright (c) 2012 Raúl Ferràs [email protected]
 *    All rights reserved.
 *
 *    Redistribution and use in source and binary forms, with or without
 *    modification, are permitted provided that the following conditions
 *    are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the name of copyright holders nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *    ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 *    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *    PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL COPYRIGHT HOLDERS OR CONTRIBUTORS
 *    BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *    POSSIBILITY OF SUCH DAMAGE.
 *
 * https://github.com/raulferras/PHP-po-parser
 *
 * Class to parse .po file and extract its strings.
 *
 * @version 5.0
 */
class Parser
{
    /** @var SourceHandler */
    protected $sourceHandler;

    /** @var int */
    protected $lineNumber;

    /** @var string */
    protected $property;

    /**
     * Reads and parses a string
     *
     * @param string $string po content
     *
     * @throws \Exception.
     * @return Parser
     */
    public static function parseString($string)
    {
        $parser = new Parser(new StringSource($string));
        $parser->parse();

        return $parser;
    }

    /**
     * Reads and parses a file
     *
     * @param string $filePath
     *
     * @throws \Exception.
     * @return Catalog
     */
    public static function parseFile($filePath)
    {
        $parser = new Parser(new FileSystem($filePath));

        return $parser->parse();
    }

    public function __construct(SourceHandler $sourceHandler)
    {
        $this->sourceHandler = $sourceHandler;
    }

    /**
     * Reads and parses strings of a .po file.
     *
     * @param SourceHandler . Optional
     *
     * @throws \Exception, \InvalidArgumentException, ParseException
     * @return Catalog
     */
    public function parse()
    {
        $catalog = new Catalog();
        $this->lineNumber = 0;
        $entry = array();
        $this->mode = null;     // current mode
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->property = null; // current property

        // Flags
        $headersFound = false;

        while (!$this->sourceHandler->ended()) {


            $line = trim($this->sourceHandler->getNextLine());

            if ($this->shouldIgnoreLine($line, $entry)) {
                $this->lineNumber++;
                continue;
            }

            if ($this->shouldCloseEntry($line, $entry)) {
                if (!$headersFound && $this->isHeader($entry)) {
                    $headersFound = true;
                    $catalog->addHeaders(array_filter(explode('\\n', $entry['msgstr'])));
                } else {
                    $catalog->addEntry(EntryFactory::createFromArray($entry));
                }

                $entry = array();
                $this->mode = null;
                $this->property = null;

                if (empty($line)) {
                    $this->lineNumber++;
                    continue;
                }
            }

            $firstChar = strlen($line) > 0 ? $line[0] : '';

            switch ($firstChar) {
                case '#':
                    $entry = $this->parseComment($line, $entry);
                    break;

                case 'm':
                    $entry = $this->parseProperty($line, $entry);
                    break;

                case '"':
                    $entry = $this->parseMultiline($line, $entry);
                    break;
            }

            $this->lineNumber++;
            continue;
        }
        $this->sourceHandler->close();

        // add final entry
        if (count($entry)) {
            $catalog->addEntry(EntryFactory::createFromArray($entry));
        }

        return $catalog;
    }

    protected function shouldIgnoreLine($line, array $entry)
    {
        return empty($line) && count($entry) === 0;
    }


    protected function shouldCloseEntry($line, array $entry)
    {
        $lineKey = '';

        return ($line === '' || ($lineKey === 'msgid' && isset($entry['msgid'])));
    }

    /**
     * Checks if entry is a header by
     *
     * @param array $entry
     *
     * @return bool
     */
    protected function isHeader(array $entry)
    {
        if (empty($entry) || !isset($entry['msgstr'])) {
            return false;
        }

        if (!isset($entry['msgid']) || !empty($entry['msgid'])) {
            return false;
        }

        $headerKeys = array(
            'Project-Id-Version:' => false,
            'Report-Msgid-Bugs-To:' => false,
            'POT-Creation-Date:' => false,
            'PO-Revision-Date:' => false,
            'Last-Translator:' => false,
            'Language-Team:' => false,
            'MIME-Version:' => false,
            'Content-Type:' => false,
            'Content-Transfer-Encoding:' => false,
            'Plural-Forms:' => false,
        );
        $count = count($headerKeys);
        $keys = array_keys($headerKeys);

        $headerItems = 0;
        $lines = explode("\\n", $entry['msgstr']);

        foreach ($lines as $str) {
            $tokens = explode(':', $str);
            $tokens[0] = trim($tokens[0], '"').':';

            if (in_array($tokens[0], $keys, true)) {
                $headerItems++;
                unset($headerKeys[$tokens[0]]);
                $keys = array_keys($headerKeys);
            }
        }

        return $headerItems === $count;
    }

    /**
     * @param string $line
     *
     * @return array
     */
    protected function getProperty($line)
    {
        $tokens = preg_split('/\s+/ ', $line, 2);

        return $tokens;
    }

    /**
     * @param string $line
     * @param array  $entry
     *
     * @return array
     * @throws ParseException
     */
    private function parseProperty($line, array $entry)
    {
        list($key, $value) = $this->getProperty($line);

        if (!isset($entry[$key])) {
            $entry[$key] = '';
        }

        switch (true) {
            case $key === 'msgctxt':
            case $key === 'msgid':
            case $key === 'msgid_plural':
            case $key === 'msgstr':
                $entry[$key] .= trim($value, '"');
                $this->property = $key;
                break;

            case strpos($key, 'msgstr[') !== false:
                $entry[$key] .= trim($value, '"');
                $this->property = $key;
                break;

            default:
                throw new ParseException(sprintf('Could not parse %s at line %d', $key, $this->lineNumber));
        }

        return $entry;
    }

    /**
     * @param string $line
     * @param array  $entry
     *
     * @return array
     * @throws ParseException
     */
    private function parseMultiline($line, $entry)
    {
        switch (true) {
            case $this->property === 'msgctxt':
            case $this->property === 'msgid':
            case $this->property === 'msgid_plural':
            case $this->property === 'msgstr':
            case strpos($this->property, 'msgstr[') !== false:
                $entry[$this->property] .= trim($line, '"');
                break;

            default:
                throw new ParseException(
                    sprintf('Error parsing property %s as multiline.', $this->property)
                );
        }

        return $entry;
    }

    /**
     * @param string $line
     * @param array  $entry
     *
     * @return array
     */
    private function parseComment($line, $entry)
    {
        $comment = trim(substr($line, 0, 2));

        switch ($comment) {
            case '#.':
                $entry['ccomment'] = !isset($entry['ccomment']) ? array() : $entry['ccomment'];
                $entry['ccomment'][] = trim(substr($line, 2));
                break;

            case '#':
            default:
                $entry['tcomment'] = !isset($entry['tcomment']) ? array() : $entry['tcomment'];
                $entry['tcomment'][] = trim(substr($line, 1));
                break;
        }

        return $entry;
    }
}


1			<?php
2
3			namespace Sepia\PoParser;
4
5			use Sepia\PoParser\Catalog\EntryFactory;
6			use Sepia\PoParser\Exception\ParseException;
7			use Sepia\PoParser\SourceHandler\FileSystem;
8			use Sepia\PoParser\SourceHandler\SourceHandler;
9			use Sepia\PoParser\SourceHandler\StringSource;
10
11			/**
12			* Copyright (c) 2012 Raúl Ferràs [email protected]
13			* All rights reserved.
14			*
15			* Redistribution and use in source and binary forms, with or without
16			* modification, are permitted provided that the following conditions
17			* are met:
18			* 1. Redistributions of source code must retain the above copyright
19			* notice, this list of conditions and the following disclaimer.
20			* 2. Redistributions in binary form must reproduce the above copyright
21			* notice, this list of conditions and the following disclaimer in the
22			* documentation and/or other materials provided with the distribution.
23			* 3. Neither the name of copyright holders nor the names of its
24			* contributors may be used to endorse or promote products derived
25			* from this software without specific prior written permission.
26			*
27			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28			* ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29			* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30			* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS OR CONTRIBUTORS
31			* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32			* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33			* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34			* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35			* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36			* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37			* POSSIBILITY OF SUCH DAMAGE.
38			*
39			* https://github.com/raulferras/PHP-po-parser
40			*
41			* Class to parse .po file and extract its strings.
42			*
43			* @version 5.0
44			*/
45			class Parser
46			{
47			/** @var SourceHandler */
48			protected $sourceHandler;
49
50			/** @var int */
51			protected $lineNumber;
52
53			/** @var string */
54			protected $property;
55
56			/**
57			* Reads and parses a string
58			*
59			* @param string $string po content
60			*
61			* @throws \Exception.
62			* @return Parser
63			*/
64			public static function parseString($string)
65			{
66			$parser = new Parser(new StringSource($string));
67			$parser->parse();
68
69			return $parser;
70			}
71
72			/**
73			* Reads and parses a file
74			*
75			* @param string $filePath
76			*
77			* @throws \Exception.
78			* @return Catalog
79			*/
80			public static function parseFile($filePath)
81			{
82			$parser = new Parser(new FileSystem($filePath));
83
84			return $parser->parse();
85			}
86
87			public function __construct(SourceHandler $sourceHandler)
88			{
89			$this->sourceHandler = $sourceHandler;
90			}
91
92			/**
93			* Reads and parses strings of a .po file.
94			*
95			* @param SourceHandler . Optional
96			*
97			* @throws \Exception, \InvalidArgumentException, ParseException
98			* @return Catalog
99			*/
100			public function parse()
101			{
102			$catalog = new Catalog();
103			$this->lineNumber = 0;
104			$entry = array();
105			$this->mode = null; // current mode
			0 ignored issues – show Bug introduced 2018-02-03 00:47 UTC by Report Bug Copy Issue Report The property `mode` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
106			$this->property = null; // current property
107
108			// Flags
109			$headersFound = false;
110
111			while (!$this->sourceHandler->ended()) {
			0 ignored issues – show Coding Style introduced 2018-02-03 00:47 UTC by Report Bug Copy Issue Report Blank line found at start of control structure Loading history...
112
113			$line = trim($this->sourceHandler->getNextLine());
114
115			if ($this->shouldIgnoreLine($line, $entry)) {
116			$this->lineNumber++;
117			continue;
118			}
119
120			if ($this->shouldCloseEntry($line, $entry)) {
121			if (!$headersFound && $this->isHeader($entry)) {
122			$headersFound = true;
123			$catalog->addHeaders(array_filter(explode('\\n', $entry['msgstr'])));
124			} else {
125			$catalog->addEntry(EntryFactory::createFromArray($entry));
126			}
127
128			$entry = array();
129			$this->mode = null;
130			$this->property = null;
131
132			if (empty($line)) {
133			$this->lineNumber++;
134			continue;
135			}
136			}
137
138			$firstChar = strlen($line) > 0 ? $line[0] : '';
139
140			switch ($firstChar) {
141			case '#':
142			$entry = $this->parseComment($line, $entry);
143			break;
144
145			case 'm':
146			$entry = $this->parseProperty($line, $entry);
147			break;
148
149			case '"':
150			$entry = $this->parseMultiline($line, $entry);
151			break;
152			}
153
154			$this->lineNumber++;
155			continue;
156			}
157			$this->sourceHandler->close();
158
159			// add final entry
160			if (count($entry)) {
161			$catalog->addEntry(EntryFactory::createFromArray($entry));
162			}
163
164			return $catalog;
165			}
166
167			protected function shouldIgnoreLine($line, array $entry)
168			{
169			return empty($line) && count($entry) === 0;
170			}
171
172
173			protected function shouldCloseEntry($line, array $entry)
174			{
175			$lineKey = '';
176
177			return ($line === '' \|\| ($lineKey === 'msgid' && isset($entry['msgid'])));
178			}
179
180			/**
181			* Checks if entry is a header by
182			*
183			* @param array $entry
184			*
185			* @return bool
186			*/
187			protected function isHeader(array $entry)
188			{
189			if (empty($entry) \|\| !isset($entry['msgstr'])) {
190			return false;
191			}
192
193			if (!isset($entry['msgid']) \|\| !empty($entry['msgid'])) {
194			return false;
195			}
196
197			$headerKeys = array(
198			'Project-Id-Version:' => false,
199			'Report-Msgid-Bugs-To:' => false,
200			'POT-Creation-Date:' => false,
201			'PO-Revision-Date:' => false,
202			'Last-Translator:' => false,
203			'Language-Team:' => false,
204			'MIME-Version:' => false,
205			'Content-Type:' => false,
206			'Content-Transfer-Encoding:' => false,
207			'Plural-Forms:' => false,
208			);
209			$count = count($headerKeys);
210			$keys = array_keys($headerKeys);
211
212			$headerItems = 0;
213			$lines = explode("\\n", $entry['msgstr']);
214
215			foreach ($lines as $str) {
216			$tokens = explode(':', $str);
217			$tokens[0] = trim($tokens[0], '"').':';
218
219			if (in_array($tokens[0], $keys, true)) {
220			$headerItems++;
221			unset($headerKeys[$tokens[0]]);
222			$keys = array_keys($headerKeys);
223			}
224			}
225
226			return $headerItems === $count;
227			}
228
229			/**
230			* @param string $line
231			*
232			* @return array
233			*/
234			protected function getProperty($line)
235			{
236			$tokens = preg_split('/\s+/ ', $line, 2);
237
238			return $tokens;
239			}
240
241			/**
242			* @param string $line
243			* @param array $entry
244			*
245			* @return array
246			* @throws ParseException
247			*/
248			private function parseProperty($line, array $entry)
249			{
250			list($key, $value) = $this->getProperty($line);
251
252			if (!isset($entry[$key])) {
253			$entry[$key] = '';
254			}
255
256			switch (true) {
257			case $key === 'msgctxt':
258			case $key === 'msgid':
259			case $key === 'msgid_plural':
260			case $key === 'msgstr':
261			$entry[$key] .= trim($value, '"');
262			$this->property = $key;
263			break;
264
265			case strpos($key, 'msgstr[') !== false:
266			$entry[$key] .= trim($value, '"');
267			$this->property = $key;
268			break;
269
270			default:
271			throw new ParseException(sprintf('Could not parse %s at line %d', $key, $this->lineNumber));
272			}
273
274			return $entry;
275			}
276
277			/**
278			* @param string $line
279			* @param array $entry
280			*
281			* @return array
282			* @throws ParseException
283			*/
284			private function parseMultiline($line, $entry)
285			{
286			switch (true) {
287			case $this->property === 'msgctxt':
288			case $this->property === 'msgid':
289			case $this->property === 'msgid_plural':
290			case $this->property === 'msgstr':
291			case strpos($this->property, 'msgstr[') !== false:
292			$entry[$this->property] .= trim($line, '"');
293			break;
294
295			default:
296			throw new ParseException(
297			sprintf('Error parsing property %s as multiline.', $this->property)
298			);
299			}
300
301			return $entry;
302			}
303
304			/**
305			* @param string $line
306			* @param array $entry
307			*
308			* @return array
309			*/
310			private function parseComment($line, $entry)
311			{
312			$comment = trim(substr($line, 0, 2));
313
314			switch ($comment) {
315			case '#.':
316			$entry['ccomment'] = !isset($entry['ccomment']) ? array() : $entry['ccomment'];
317			$entry['ccomment'][] = trim(substr($line, 2));
318			break;
319
320			case '#':
321			default:
322			$entry['tcomment'] = !isset($entry['tcomment']) ? array() : $entry['tcomment'];
323			$entry['tcomment'][] = trim(substr($line, 1));
324			break;
325			}
326
327			return $entry;
328			}
329			}
330

raulferras / PHP-po-parser

Push — feature/5.0.1 ( f078af...8bd6be )

Parser::parseComment() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like