SyntaxHelper - Code Metrics - Inspection of "Merge pull request #7 from tarsana/reading-args-in..." - tarsana/command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9573eb...833af1 )

by Amine

created 2017-09-08 01:18 UTC

SyntaxHelper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

Metric	Value
wmc	12
lcom	1
cbo	0
dl	0
loc	54
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	instance()	6	2
A	__construct()	1	1
A	type()	5	1
A	asString()	20	4
A	fields()	12	4

<?php namespace Tarsana\Command\Helpers;

use Tarsana\Syntax\Syntax;


class SyntaxHelper {

    protected static $instance;

    public static function instance() : SyntaxHelper
    {
        if (null === self::$instance)
            self::$instance = new SyntaxHelper;
        return self::$instance;
    }

    private function __construct() {}

    public function type(Syntax $syntax) : string
    {
        $class = explode("\\", get_class($syntax));
        return strtolower(substr(array_pop($class), 0, -6));
    }

    public function asString(Syntax $syntax) : string
    {
        $type = $this->type($syntax);
        if ($type == 'optional')
            return $this->asString($syntax->syntax());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        switch ($type) {
            case 'object':
                return implode(
                    $syntax->separator(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                    array_keys($syntax->fields())
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                );
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'array':
                $text = $this->asString($syntax->syntax());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                return "{$text}{$syntax->separator()}...";
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                return $type;
        }
    }

    public function fields(Syntax $syntax) : array
    {
        $type = $this->type($syntax);
        switch ($type) {
            case 'object':
                return $syntax->fields();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            case 'array':
            case 'optional':
                return $this->fields($syntax->syntax());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
        return [];
    }

}


1			<?php namespace Tarsana\Command\Helpers;
2
3			use Tarsana\Syntax\Syntax;
4
5
6			class SyntaxHelper {
7
8			protected static $instance;
9
10			public static function instance() : SyntaxHelper
11			{
12			if (null === self::$instance)
13			self::$instance = new SyntaxHelper;
14			return self::$instance;
15			}
16
17			private function __construct() {}
18
19			public function type(Syntax $syntax) : string
20			{
21			$class = explode("\\", get_class($syntax));
22			return strtolower(substr(array_pop($class), 0, -6));
23			}
24
25			public function asString(Syntax $syntax) : string
26			{
27			$type = $this->type($syntax);
28			if ($type == 'optional')
29			return $this->asString($syntax->syntax());
			0 ignored issues – show Bug introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tarsana\Syntax\Syntax` as the method `syntax()` does only exist in the following sub-classes of `Tarsana\Syntax\Syntax`: `Debugger`, `Tarsana\Syntax\ArraySyntax`, `Tarsana\Syntax\OptionalSyntax`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
30			switch ($type) {
31			case 'object':
32			return implode(
33			$syntax->separator(),
			0 ignored issues – show Bug introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tarsana\Syntax\Syntax` as the method `separator()` does only exist in the following sub-classes of `Tarsana\Syntax\Syntax`: `Tarsana\Syntax\ArraySyntax`, `Tarsana\Syntax\ObjectSyntax`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
34			array_keys($syntax->fields())
			0 ignored issues – show Bug introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tarsana\Syntax\Syntax` as the method `fields()` does only exist in the following sub-classes of `Tarsana\Syntax\Syntax`: `Tarsana\Syntax\ObjectSyntax`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
35			);
36			break;
			0 ignored issues – show Unused Code introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
37			case 'array':
38			$text = $this->asString($syntax->syntax());
			0 ignored issues – show Bug introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tarsana\Syntax\Syntax` as the method `syntax()` does only exist in the following sub-classes of `Tarsana\Syntax\Syntax`: `Debugger`, `Tarsana\Syntax\ArraySyntax`, `Tarsana\Syntax\OptionalSyntax`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
39			return "{$text}{$syntax->separator()}...";
			0 ignored issues – show Bug introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tarsana\Syntax\Syntax` as the method `separator()` does only exist in the following sub-classes of `Tarsana\Syntax\Syntax`: `Tarsana\Syntax\ArraySyntax`, `Tarsana\Syntax\ObjectSyntax`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
40			break;
			0 ignored issues – show Unused Code introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
41			default:
42			return $type;
43			}
44			}
45
46			public function fields(Syntax $syntax) : array
47			{
48			$type = $this->type($syntax);
49			switch ($type) {
50			case 'object':
51			return $syntax->fields();
			0 ignored issues – show Bug introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tarsana\Syntax\Syntax` as the method `fields()` does only exist in the following sub-classes of `Tarsana\Syntax\Syntax`: `Tarsana\Syntax\ObjectSyntax`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
52			case 'array':
53			case 'optional':
54			return $this->fields($syntax->syntax());
			0 ignored issues – show Bug introduced 2017-09-07 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tarsana\Syntax\Syntax` as the method `syntax()` does only exist in the following sub-classes of `Tarsana\Syntax\Syntax`: `Debugger`, `Tarsana\Syntax\ArraySyntax`, `Tarsana\Syntax\OptionalSyntax`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
55			}
56			return [];
57			}
58
59			}
60

tarsana / command

Push — master ( 9573eb...833af1 )

SyntaxHelper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like