DescriptionProvider::getDescription() - Code Metrics - Inspection of "Improve building logic and AST" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c1a156...8cadde )

by Kirill

created 2018-08-20 02:33 UTC

DescriptionProvider::getDescription() A

↳ Parent: DescriptionProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	13
ccs	6
cts	6
cp	1
crap	2
rs	9.8333
c	0
b	0
f	0

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\SDL\Ast\Support;

use Railt\Parser\Ast\RuleInterface;
use Railt\SDL\Ast\Value\StringValueNode;

/**
 * Trait DescriptionProvider
 */
trait DescriptionProvider
{
    /**
     * @return null|string
     */
    public function getDescription(): ?string
    {
        $description = $this->first('Description', 1);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        if ($description instanceof RuleInterface) {
            /** @var StringValueNode $value */
            $value = $description->getChild(0);

            return $this->trim($value->toPrimitive());
        }

        return null;
    }

    /**
     * @param string $content
     * @return string
     */
    private function trim(string $content): string
    {
        $lines = \array_map(function(string $line): string {
            return \ltrim($line, '#');
        }, \explode("\n", $content));

        return \trim(\implode("\n", $lines), "\n\r");
    }
}


1		<?php
2		/**
3		* This file is part of Railt package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*/
8		declare(strict_types=1);
9
10		namespace Railt\SDL\Ast\Support;
11
12		use Railt\Parser\Ast\RuleInterface;
13		use Railt\SDL\Ast\Value\StringValueNode;
14
15		/**
16		* Trait DescriptionProvider
17		*/
18		trait DescriptionProvider
19		{
20		/**
21		* @return null\|string
22		*/
23	119	public function getDescription(): ?string
24		{
25	119	$description = $this->first('Description', 1);
		0 ignored issues – show Bug introduced 2018-08-03 15:25 UTC by Report Bug Copy Issue Report It seems like `first()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
26
27	119	if ($description instanceof RuleInterface) {
28		/** @var StringValueNode $value */
29	16	$value = $description->getChild(0);
30
31	16	return $this->trim($value->toPrimitive());
32		}
33
34	108	return null;
35		}
36
37		/**
38		* @param string $content
39		* @return string
40		*/
41		private function trim(string $content): string
42		{
43	16	$lines = \array_map(function(string $line): string {
44	16	return \ltrim($line, '#');
45	16	}, \explode("\n", $content));
46
47	16	return \trim(\implode("\n", $lines), "\n\r");
48		}
49		}
50

railt / sdl

Push — master ( c1a156...8cadde )

DescriptionProvider::getDescription() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like