TwigFileExtractor - Code Metrics - Inspection of "Adding support for @Desc annotation (#63)" - php-translation/extractor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 04f40e...f278b5 )

by Tobias

created 2017-12-28 19:29 UTC

TwigFileExtractor A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

86.36%

Importance

Changes

Metric	Value
wmc	8
lcom	1
cbo	4
dl	0
loc	64
c	0
b	0
f	0
ccs	19
cts	22
cp	0.8636
rs	10

6 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	getType()	4	1
A	addVisitor()	4	1
A	getNodeVisitors()	4	1
A	getSourceLocations()	16	3
A	getName()	4	1

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Extractor\FileExtractor;

use Symfony\Component\Finder\SplFileInfo;
use Translation\Extractor\Model\SourceCollection;
use Translation\Extractor\Visitor\Visitor;

/**
 * @author Tobias Nyholm <[email protected]>
 */
final class TwigFileExtractor extends \Twig_Extension implements FileExtractor
{
    /**
     * @var Visitor[]|\Twig_NodeVisitorInterface[]
     */
    private $visitors = [];

    /**
     * @var \Twig_Environment
     */
    private $twig;

    /**
     * @param \Twig_Environment $twig
     */
    public function __construct(\Twig_Environment $twig)
    {
        $this->twig = $twig;
        $twig->addExtension($this);
    }

    public function getSourceLocations(SplFileInfo $file, SourceCollection $collection)
    {
        foreach ($this->visitors as $v) {
            $v->init($collection, $file);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        $path = $file->getRelativePath();

        if (class_exists('Twig_Source')) {
            // Twig 2.0
            $stream = $this->twig->tokenize(new \Twig_Source($file->getContents(), $file->getRelativePathname(), $path));
        } else {
            $stream = $this->twig->tokenize($file->getContents(), $path);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        $this->twig->parse($stream);
    }

    public function getType()
    {
        return 'twig';
    }

    /**
     * @param \Twig_NodeVisitorInterface $visitor
     */
    public function addVisitor(\Twig_NodeVisitorInterface $visitor)
    {
        $this->visitors[] = $visitor;
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeVisitors()
    {
        return $this->visitors;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function getName()
    {
        return 'php.translation';
    }
}


1		<?php
2
3		/*
4		* This file is part of the PHP Translation package.
5		*
6		* (c) PHP Translation team <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Translation\Extractor\FileExtractor;
13
14		use Symfony\Component\Finder\SplFileInfo;
15		use Translation\Extractor\Model\SourceCollection;
16		use Translation\Extractor\Visitor\Visitor;
17
18		/**
19		* @author Tobias Nyholm <[email protected]>
20		*/
21		final class TwigFileExtractor extends \Twig_Extension implements FileExtractor
22		{
23		/**
24		* @var Visitor[]\|\Twig_NodeVisitorInterface[]
25		*/
26		private $visitors = [];
27
28		/**
29		* @var \Twig_Environment
30		*/
31		private $twig;
32
33		/**
34		* @param \Twig_Environment $twig
35		*/
36	6	public function __construct(\Twig_Environment $twig)
37		{
38	6	$this->twig = $twig;
39	6	$twig->addExtension($this);
40	6	}
41
42	6	public function getSourceLocations(SplFileInfo $file, SourceCollection $collection)
43		{
44	6	foreach ($this->visitors as $v) {
45	6	$v->init($collection, $file);
		0 ignored issues – show Bug introduced 2016-12-05 09:59 UTC by Report Bug Copy Issue Report The method `init` does only exist in `Translation\Extractor\Visitor\Visitor`, but not in `Twig_NodeVisitorInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
46		}
47
48	6	$path = $file->getRelativePath();
49
50	6	if (class_exists('Twig_Source')) {
51		// Twig 2.0
52	6	$stream = $this->twig->tokenize(new \Twig_Source($file->getContents(), $file->getRelativePathname(), $path));
53		} else {
54		$stream = $this->twig->tokenize($file->getContents(), $path);
		0 ignored issues – show Documentation introduced 2017-01-07 09:55 UTC by Report Bug Copy Issue Report `$file->getContents()` is of type `string`, but the function expects a `object<Twig_Source>`. 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... Unused Code introduced 2017-01-07 09:55 UTC by Report Bug Copy Issue Report The call to `Twig_Environment::tokenize()` has too many arguments starting with `$path`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
55		}
56	6	$this->twig->parse($stream);
57	6	}
58
59	1	public function getType()
60		{
61	1	return 'twig';
62		}
63
64		/**
65		* @param \Twig_NodeVisitorInterface $visitor
66		*/
67	6	public function addVisitor(\Twig_NodeVisitorInterface $visitor)
68		{
69	6	$this->visitors[] = $visitor;
70	6	}
71
72		/**
73		* {@inheritdoc}
74		*/
75	6	public function getNodeVisitors()
76		{
77	6	return $this->visitors;
		0 ignored issues – show Best Practice introduced 2017-08-12 16:04 UTC by Report Bug Copy Issue Report The expression `return $this->visitors;` seems to be an `array`, but some of its elements' types (`Translation\Extractor\Visitor\Visitor`) are incompatible with the return type declared by the interface `Twig_ExtensionInterface::getNodeVisitors` of type `Twig_NodeVisitorInterface[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
78		}
79
80		public function getName()
81		{
82		return 'php.translation';
83		}
84		}
85

php-translation / extractor

Push — master ( 04f40e...f278b5 )

TwigFileExtractor A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like