TranslatableExceptionsFileVisitor::visitTwigFile() - Code Metrics - Inspection of "EZP-26704: Updated english strings" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp26704-jms_translation_bundl... ( 8097b0...a61ca5 )

unknown

created 2016-11-29 23:19 UTC

TranslatableExceptionsFileVisitor::visitTwigFile() A

↳ Parent: TranslatableExceptionsFileVisitor

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	3
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\MVC\Symfony\Translation;

use JMS\TranslationBundle\Exception\RuntimeException;
use Doctrine\Common\Annotations\DocParser;
use JMS\TranslationBundle\Model\Message;
use JMS\TranslationBundle\Annotation\Meaning;
use JMS\TranslationBundle\Annotation\Desc;
use JMS\TranslationBundle\Annotation\Ignore;
use JMS\TranslationBundle\Translation\Extractor\FileVisitorInterface;
use JMS\TranslationBundle\Model\MessageCatalogue;
use JMS\TranslationBundle\Logger\LoggerAwareInterface;
use JMS\TranslationBundle\Translation\FileSourceFactory;
use PhpParser\Comment\Doc;
use PhpParser\Node;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor;
use PhpParser\Node\Scalar\String_;
use Psr\Log\LoggerInterface;

/**
 * Visits calls to some known translatable exceptions, into the repository_exceptions domain.
 */
class TranslatableExceptionsFileVisitor implements LoggerAwareInterface, FileVisitorInterface, NodeVisitor
{
    /**
     * @var FileSourceFactory
     */
    private $fileSourceFactory;

    /**
     * @var NodeTraverser
     */
    private $traverser;

    /**
     * @var MessageCatalogue
     */
    private $catalogue;

    /**
     * @var \SplFileInfo
     */
    private $file;

    /**
     * @var DocParser
     */
    private $docParser;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @var Node
     */
    private $previousNode;

    /**
     * @var string
     */
    protected $defaultDomain = 'repository_exceptions';

    /**
     * Methods and "domain" parameter offset to extract from PHP code
     *
     * @var array method => position of the "domain" parameter
     */
    protected $exceptionsToExtractFrom = array(
        'contentvalidationexception',
        'forbiddenexception'
    );

    /**
     * DefaultPhpFileExtractor constructor.
     * @param DocParser $docParser
     * @param FileSourceFactory $fileSourceFactory
     */
    public function __construct(DocParser $docParser, FileSourceFactory $fileSourceFactory)
    {
        $this->docParser = $docParser;
        $this->fileSourceFactory = $fileSourceFactory;
        $this->traverser = new NodeTraverser();
        $this->traverser->addVisitor($this);
    }

    /**
     * @param LoggerInterface $logger
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    /**
     * @param Node $node
     * @return void
     */
    public function enterNode(Node $node)
    {
        if (!$node instanceof Node\Stmt\Throw_
if ($x instanceof DoesNotExist) {
    // Do something.
}
            || !$node->expr instanceof Node\Expr\New_) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $this->previousNode = $node;

            return;
        }

        $exceptionClass = $node->expr->class->parts[0];
        if (!in_array(strtolower($exceptionClass), array_map('strtolower', $this->exceptionsToExtractFrom))) {
            $this->previousNode = $node;
            return;
        }

        $node = $node->expr;
        $ignore = false;
        $desc = $meaning = null;
        if (null !== $docComment = $this->getDocCommentForNode($node)) {

            if ($docComment instanceof Doc) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                $docComment = $docComment->getText();
            }
            foreach ($this->docParser->parse($docComment, 'file '.$this->file.' near line '.$node->getLine()) as $annot) {
                if ($annot instanceof Ignore) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                    $ignore = true;
                } elseif ($annot instanceof Desc) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                    $desc = $annot->text;
                } elseif ($annot instanceof Meaning) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                    $meaning = $annot->text;
                }
            }
        }

        if (!$node->args[0]->value instanceof String_) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            if ($ignore) {
                return;
            }

            $message = sprintf('Can only extract the translation id from a scalar string, but got "%s". Please refactor your code to make it extractable, or add the doc comment /** @Ignore */ to this code element (in %s on line %d).', get_class($node->args[0]->value), $this->file, $node->args[0]->value->getLine());

            if ($this->logger) {
                $this->logger->error($message);
                return;
            }

            throw new RuntimeException($message);
        }

        $id = $node->args[0]->value->value;

        $message = new Message($id, $this->defaultDomain);
        $message->setDesc($desc);
        $message->setMeaning($meaning);
        $message->addSource($this->fileSourceFactory->create($this->file, $node->getLine()));
        $this->catalogue->add($message);
    }

    /**
     * @param \SplFileInfo $file
     * @param MessageCatalogue $catalogue
     * @param array $ast
     */
    public function visitPhpFile(\SplFileInfo $file, MessageCatalogue $catalogue, array $ast)
    {
        $this->file = $file;
        $this->catalogue = $catalogue;
        $this->traverser->traverse($ast);
    }

    /**
     * @param array $nodes
     * @return void
     */
    public function beforeTraverse(array $nodes)
    {
    }

    /**
     * @param Node $node
     * @return void
     */
    public function leaveNode(Node $node)
    {
    }

    /**
     * @param array $nodes
     * @return void
     */
    public function afterTraverse(array $nodes)
    {
    }

    /**
     * @param \SplFileInfo $file
     * @param MessageCatalogue $catalogue
     */
    public function visitFile(\SplFileInfo $file, MessageCatalogue $catalogue)
    {
    }

    /**
     * @param \SplFileInfo $file
     * @param MessageCatalogue $catalogue
     * @param \Twig_Node $ast
     */
    public function visitTwigFile(\SplFileInfo $file, MessageCatalogue $catalogue, \Twig_Node $ast)
    {
    }

    /**
     * @param Node $node
     * @return null|string
     */
    private function getDocCommentForNode(Node $node)
    {
        // check if there is a doc comment for the ID argument
        // ->trans(/** @Desc("FOO") */ 'my.id')
        if (null !== $comment = $node->args[0]->getDocComment()) {
            return $comment->getText();
        }

        // this may be placed somewhere up in the hierarchy,
        // -> /** @Desc("FOO") */ trans('my.id')
        // /** @Desc("FOO") */ ->trans('my.id')
        // /** @Desc("FOO") */ $translator->trans('my.id')
        if (null !== $comment = $node->getDocComment()) {
            return $comment->getText();
        } elseif (null !== $this->previousNode && $this->previousNode->getDocComment() !== null) {
            $comment = $this->previousNode->getDocComment();
            return is_object($comment) ? $comment->getText() : $comment;
        }

        return null;
    }
}


Push — ezp26704-jms_translation_bundl... ( 8097b0...a61ca5 )

TranslatableExceptionsFileVisitor::visitTwigFile() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php
2		/**
3		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
4		* @license For full copyright and license information view LICENSE file distributed with this source code.
5		*/
6		namespace eZ\Publish\Core\MVC\Symfony\Translation;
7
8		use JMS\TranslationBundle\Exception\RuntimeException;
9		use Doctrine\Common\Annotations\DocParser;
10		use JMS\TranslationBundle\Model\Message;
11		use JMS\TranslationBundle\Annotation\Meaning;
12		use JMS\TranslationBundle\Annotation\Desc;
13		use JMS\TranslationBundle\Annotation\Ignore;
14		use JMS\TranslationBundle\Translation\Extractor\FileVisitorInterface;
15		use JMS\TranslationBundle\Model\MessageCatalogue;
16		use JMS\TranslationBundle\Logger\LoggerAwareInterface;
17		use JMS\TranslationBundle\Translation\FileSourceFactory;
18		use PhpParser\Comment\Doc;
19		use PhpParser\Node;
20		use PhpParser\NodeTraverser;
21		use PhpParser\NodeVisitor;
22		use PhpParser\Node\Scalar\String_;
23		use Psr\Log\LoggerInterface;
24
25		/**
26		* Visits calls to some known translatable exceptions, into the repository_exceptions domain.
27		*/
28		class TranslatableExceptionsFileVisitor implements LoggerAwareInterface, FileVisitorInterface, NodeVisitor
29		{
30		/**
31		* @var FileSourceFactory
32		*/
33		private $fileSourceFactory;
34
35		/**
36		* @var NodeTraverser
37		*/
38		private $traverser;
39
40		/**
41		* @var MessageCatalogue
42		*/
43		private $catalogue;
44
45		/**
46		* @var \SplFileInfo
47		*/
48		private $file;
49
50		/**
51		* @var DocParser
52		*/
53		private $docParser;
54
55		/**
56		* @var LoggerInterface
57		*/
58		private $logger;
59
60		/**
61		* @var Node
62		*/
63		private $previousNode;
64
65		/**
66		* @var string
67		*/
68		protected $defaultDomain = 'repository_exceptions';
69
70		/**
71		* Methods and "domain" parameter offset to extract from PHP code
72		*
73		* @var array method => position of the "domain" parameter
74		*/
75		protected $exceptionsToExtractFrom = array(
76		'contentvalidationexception',
77		'forbiddenexception'
78		);
79
80		/**
81		* DefaultPhpFileExtractor constructor.
82		* @param DocParser $docParser
83		* @param FileSourceFactory $fileSourceFactory
84		*/
85	View Code Duplication	public function __construct(DocParser $docParser, FileSourceFactory $fileSourceFactory)
86		{
87		$this->docParser = $docParser;
88		$this->fileSourceFactory = $fileSourceFactory;
89		$this->traverser = new NodeTraverser();
90		$this->traverser->addVisitor($this);
91		}
92
93		/**
94		* @param LoggerInterface $logger
95		*/
96		public function setLogger(LoggerInterface $logger)
97		{
98		$this->logger = $logger;
99		}
100
101		/**
102		* @param Node $node
103		* @return void
104		*/
105		public function enterNode(Node $node)
106		{
107		if (!$node instanceof Node\Stmt\Throw_
		0 ignored issues – show Bug introduced 2016-11-29 23:39 UTC by Report Bug Copy Issue Report The class `PhpParser\Node\Stmt\Throw_` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
108		\|\| !$node->expr instanceof Node\Expr\New_) {
		0 ignored issues – show Bug introduced 2016-11-29 23:39 UTC by Report Bug Copy Issue Report The class `PhpParser\Node\Expr\New_` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
109		$this->previousNode = $node;
110
111		return;
112		}
113
114		$exceptionClass = $node->expr->class->parts[0];
115		if (!in_array(strtolower($exceptionClass), array_map('strtolower', $this->exceptionsToExtractFrom))) {
116		$this->previousNode = $node;
117		return;
118		}
119
120		$node = $node->expr;
121		$ignore = false;
122		$desc = $meaning = null;
123	View Code Duplication	if (null !== $docComment = $this->getDocCommentForNode($node)) {
		0 ignored issues – show Duplication introduced 2016-11-29 23:39 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...
124		if ($docComment instanceof Doc) {
		0 ignored issues – show Bug introduced 2016-11-29 23:39 UTC by Report Bug Copy Issue Report The class `PhpParser\Comment\Doc` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
125		$docComment = $docComment->getText();
126		}
127		foreach ($this->docParser->parse($docComment, 'file '.$this->file.' near line '.$node->getLine()) as $annot) {
128		if ($annot instanceof Ignore) {
		0 ignored issues – show Bug introduced 2016-11-29 23:39 UTC by Report Bug Copy Issue Report The class `JMS\TranslationBundle\Annotation\Ignore` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
129		$ignore = true;
130		} elseif ($annot instanceof Desc) {
		0 ignored issues – show Bug introduced 2016-11-29 23:39 UTC by Report Bug Copy Issue Report The class `JMS\TranslationBundle\Annotation\Desc` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
131		$desc = $annot->text;
132		} elseif ($annot instanceof Meaning) {
		0 ignored issues – show Bug introduced 2016-11-29 23:39 UTC by Report Bug Copy Issue Report The class `JMS\TranslationBundle\Annotation\Meaning` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
133		$meaning = $annot->text;
134		}
135		}
136		}
137
138	View Code Duplication	if (!$node->args[0]->value instanceof String_) {
		0 ignored issues – show Bug introduced 2016-11-29 23:39 UTC by Report Bug Copy Issue Report The class `PhpParser\Node\Scalar\String_` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history... Duplication introduced 2016-11-29 23:39 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...
139		if ($ignore) {
140		return;
141		}
142
143		$message = sprintf('Can only extract the translation id from a scalar string, but got "%s". Please refactor your code to make it extractable, or add the doc comment /** @Ignore */ to this code element (in %s on line %d).', get_class($node->args[0]->value), $this->file, $node->args[0]->value->getLine());
144
145		if ($this->logger) {
146		$this->logger->error($message);
147		return;
148		}
149
150		throw new RuntimeException($message);
151		}
152
153		$id = $node->args[0]->value->value;
154
155		$message = new Message($id, $this->defaultDomain);
156		$message->setDesc($desc);
157		$message->setMeaning($meaning);
158		$message->addSource($this->fileSourceFactory->create($this->file, $node->getLine()));
159		$this->catalogue->add($message);
160		}
161
162		/**
163		* @param \SplFileInfo $file
164		* @param MessageCatalogue $catalogue
165		* @param array $ast
166		*/
167		public function visitPhpFile(\SplFileInfo $file, MessageCatalogue $catalogue, array $ast)
168		{
169		$this->file = $file;
170		$this->catalogue = $catalogue;
171		$this->traverser->traverse($ast);
172		}
173
174		/**
175		* @param array $nodes
176		* @return void
177		*/
178		public function beforeTraverse(array $nodes)
179		{
180		}
181
182		/**
183		* @param Node $node
184		* @return void
185		*/
186		public function leaveNode(Node $node)
187		{
188		}
189
190		/**
191		* @param array $nodes
192		* @return void
193		*/
194		public function afterTraverse(array $nodes)
195		{
196		}
197
198		/**
199		* @param \SplFileInfo $file
200		* @param MessageCatalogue $catalogue
201		*/
202		public function visitFile(\SplFileInfo $file, MessageCatalogue $catalogue)
203		{
204		}
205
206		/**
207		* @param \SplFileInfo $file
208		* @param MessageCatalogue $catalogue
209		* @param \Twig_Node $ast
210		*/
211		public function visitTwigFile(\SplFileInfo $file, MessageCatalogue $catalogue, \Twig_Node $ast)
212		{
213		}
214
215		/**
216		* @param Node $node
217		* @return null\|string
218		*/
219	View Code Duplication	private function getDocCommentForNode(Node $node)
220		{
221		// check if there is a doc comment for the ID argument
222		// ->trans(/** @Desc("FOO") */ 'my.id')
223		if (null !== $comment = $node->args[0]->getDocComment()) {
224		return $comment->getText();
225		}
226
227		// this may be placed somewhere up in the hierarchy,
228		// -> /** @Desc("FOO") */ trans('my.id')
229		// /** @Desc("FOO") */ ->trans('my.id')
230		// /** @Desc("FOO") */ $translator->trans('my.id')
231		if (null !== $comment = $node->getDocComment()) {
232		return $comment->getText();
233		} elseif (null !== $this->previousNode && $this->previousNode->getDocComment() !== null) {
234		$comment = $this->previousNode->getDocComment();
235		return is_object($comment) ? $comment->getText() : $comment;
236		}
237
238		return null;
239		}
240		}
241

ezsystems / ezpublish-kernel

Push — ezp26704-jms_translation_bundl... ( 8097b0...a61ca5 )

TranslatableExceptionsFileVisitor::visitTwigFile() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like