RuleDescriptionParser::makeDescription() - Code Metrics - Inspection of "Merge pull request #58 from fergthh/RuleDescriptio..." - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6aa3b5...49976f )

by Marcel

created 2016-07-07 08:17 UTC

RuleDescriptionParser::makeDescription() A

↳ Parent: RuleDescriptionParser

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	2
eloc	5
nc	2
nop	0

<?php

namespace Mpociot\ApiDoc\Parsers;

class RuleDescriptionParser
{
    private $rule;

    private $parameters = [];

    const DEFAULT_LOCALE = 'en';

    /**
     * @param null $rule
     */
    public function __construct($rule = null)
    {
        $this->rule = "apidoc::rules.{$rule}";
    }

    /**
     * @return array|string
     */
    public function getDescription()
    {
        return $this->ruleDescriptionExist() ? $this->makeDescription() : [];
    }

    /**
     * @param string|array $parameters
     *
     * @return $this
     */
    public function with($parameters)
    {
        is_array($parameters) ?
            $this->parameters += $parameters :
            $this->parameters[] = $parameters;

        return $this;
    }

    /**
     * @return bool
     */
    protected function ruleDescriptionExist()
    {
        return trans()->hasForLocale($this->rule) || trans()->hasForLocale($this->rule, self::DEFAULT_LOCALE);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 string
     */
    protected function makeDescription()
    {
        $description = trans()->hasForLocale($this->rule) ?
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
                            trans()->get($this->rule) :
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
                            trans()->get($this->rule, [], self::DEFAULT_LOCALE);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 $this->replaceAttributes($description);
    }

    /**
     * @param string $description$
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return string
     */
    protected function replaceAttributes($description)
    {
        foreach ($this->parameters as $parameter) {
            $description = preg_replace('/:attribute/', $parameter, $description, 1);
        }

        return $description;
    }

    /**
     * @param null $rule
     *
     * @return static
     */
    public static function parse($rule = null)
    {
        return new static($rule);
    }
}


1			<?php
2
3			namespace Mpociot\ApiDoc\Parsers;
4
5			class RuleDescriptionParser
6			{
7			private $rule;
8
9			private $parameters = [];
10
11			const DEFAULT_LOCALE = 'en';
12
13			/**
14			* @param null $rule
15			*/
16			public function __construct($rule = null)
17			{
18			$this->rule = "apidoc::rules.{$rule}";
19			}
20
21			/**
22			* @return array\|string
23			*/
24			public function getDescription()
25			{
26			return $this->ruleDescriptionExist() ? $this->makeDescription() : [];
27			}
28
29			/**
30			* @param string\|array $parameters
31			*
32			* @return $this
33			*/
34			public function with($parameters)
35			{
36			is_array($parameters) ?
37			$this->parameters += $parameters :
38			$this->parameters[] = $parameters;
39
40			return $this;
41			}
42
43			/**
44			* @return bool
45			*/
46			protected function ruleDescriptionExist()
47			{
48			return trans()->hasForLocale($this->rule) \|\| trans()->hasForLocale($this->rule, self::DEFAULT_LOCALE);
			0 ignored issues – show Bug introduced 2016-07-06 21:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Translation\TranslatorInterface` as the method `hasForLocale()` does only exist in the following implementations of said interface: `Illuminate\Translation\Translator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
49			}
50
51			/**
52			* @return string
53			*/
54			protected function makeDescription()
55			{
56			$description = trans()->hasForLocale($this->rule) ?
			0 ignored issues – show Bug introduced 2016-07-01 23:48 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Translation\TranslatorInterface` as the method `hasForLocale()` does only exist in the following implementations of said interface: `Illuminate\Translation\Translator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
57			trans()->get($this->rule) :
			0 ignored issues – show Bug introduced 2016-07-01 23:48 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Translation\TranslatorInterface` as the method `get()` does only exist in the following implementations of said interface: `Illuminate\Translation\Translator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
58			trans()->get($this->rule, [], self::DEFAULT_LOCALE);
			0 ignored issues – show Bug introduced 2016-07-01 23:48 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Translation\TranslatorInterface` as the method `get()` does only exist in the following implementations of said interface: `Illuminate\Translation\Translator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
59
60			return $this->replaceAttributes($description);
61			}
62
63			/**
64			* @param string $description$
			0 ignored issues – show Documentation introduced 2016-07-01 23:48 UTC by Report Bug Copy Issue Report There is no parameter named $description$ . Did you maybe mean `$description`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
65			*
66			* @return string
67			*/
68			protected function replaceAttributes($description)
69			{
70			foreach ($this->parameters as $parameter) {
71			$description = preg_replace('/:attribute/', $parameter, $description, 1);
72			}
73
74			return $description;
75			}
76
77			/**
78			* @param null $rule
79			*
80			* @return static
81			*/
82			public static function parse($rule = null)
83			{
84			return new static($rule);
85			}
86			}
87

mpociot / laravel-apidoc-generator

Push — master ( 6aa3b5...49976f )

RuleDescriptionParser::makeDescription() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like