RelatedEntityList::__toString() - Code Metrics - Inspection of "change behavior towards null value treatment" - daikon-cqrs/entity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 819f30...8ceff2 )

by Thorsten

created 2017-07-27 01:29 UTC

RelatedEntityList::__toString() A

↳ Parent: RelatedEntityList

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	8
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	8
loc	8
ccs	0
cts	8
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0
crap	6

<?php

namespace Daikon\Entity\Entity;

use Daikon\DataStructure\TypedListTrait;
use Daikon\Entity\Assert\Assertion;
use Daikon\Entity\ValueObject\ValueObjectInterface;
use Daikon\Entity\ValueObject\ValueObjectListInterface;

final class RelatedEntityList implements ValueObjectListInterface

{
    use TypedListTrait;

    public static function makeEmpty(): self
    {
        return new static;
    }

    public static function wrap($entities): self
    {
        return new self($entities);
    }

    public static function fromNative($nativeValue): self
    {
        // @todo implement
    }

    public function toNative(): array
    {
        return $this->compositeVector->map(static function (ValueObjectInterface $entity): array {
            return $entity->toNative();
        })->toArray();
    }

    public function equals(ValueObjectInterface $otherList): bool
    {
        Assertion::isInstanceOf($otherList, static::class);
        if (count($this) !== count($otherList)) {
            return false;
        }
        foreach ($this as $pos => $value) {
            if (!$value->equals($otherList->get($pos))) {
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 false;
            }
        }
        return true;
    }

    public function __toString(): string
    {
        $parts = [];
        foreach ($this as $nestedEntity) {
            $parts[] = (string)$nestedEntity;
        }
        return implode(",\n", $parts);
    }

    public function diff(ValueObjectListInterface $otherList): ValueObjectListInterface
    {
        $differentEntities = [];
        /* @var TypedEntityInterface $entity */
        foreach ($this as $pos => $entity) {
            if (!$otherList->has($pos)) {
                $differentEntities[] = $entity;
                continue;
            }
            /* @var TypedEntityInterface $otherEntity */
            $otherEntity = $otherList->get($pos);
            $diff = $entity->getValueObjectMap()->diff($otherEntity->getValueObjectMap());
            if (!$diff->isEmpty()) {
                $differentEntities[] = $entity;
            }
        }
        return new static($differentEntities);
    }

    private function __construct(array $entities = [])
    {
        $this->init($entities, EntityRelationInterface::class);
    }
}


1		<?php
2
3		namespace Daikon\Entity\Entity;
4
5		use Daikon\DataStructure\TypedListTrait;
6		use Daikon\Entity\Assert\Assertion;
7		use Daikon\Entity\ValueObject\ValueObjectInterface;
8		use Daikon\Entity\ValueObject\ValueObjectListInterface;
9
10	View Code Duplication	final class RelatedEntityList implements ValueObjectListInterface
		0 ignored issues – show Duplication introduced 2017-07-27 01:32 UTC by Report Bug Copy Issue Report This class seems to be duplicated in 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...
11		{
12		use TypedListTrait;
13
14		public static function makeEmpty(): self
15		{
16		return new static;
17		}
18
19		public static function wrap($entities): self
20		{
21		return new self($entities);
22		}
23
24		public static function fromNative($nativeValue): self
25		{
26		// @todo implement
27		}
28
29		public function toNative(): array
30		{
31		return $this->compositeVector->map(static function (ValueObjectInterface $entity): array {
32		return $entity->toNative();
33		})->toArray();
34		}
35
36		public function equals(ValueObjectInterface $otherList): bool
37		{
38		Assertion::isInstanceOf($otherList, static::class);
39		if (count($this) !== count($otherList)) {
40		return false;
41		}
42		foreach ($this as $pos => $value) {
43		if (!$value->equals($otherList->get($pos))) {
		0 ignored issues – show Bug introduced 2017-07-27 01:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Daikon\Entity\ValueObject\ValueObjectInterface` as the method `get()` does only exist in the following implementations of said interface: `Daikon\Entity\Entity\NestedEntity`, `Daikon\Entity\Entity\NestedEntityList`, `Daikon\Entity\Entity\RelatedEntity`, `Daikon\Entity\Entity\RelatedEntityList`. 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...
44		return false;
45		}
46		}
47		return true;
48		}
49
50		public function __toString(): string
51		{
52		$parts = [];
53		foreach ($this as $nestedEntity) {
54		$parts[] = (string)$nestedEntity;
55		}
56		return implode(",\n", $parts);
57		}
58
59		public function diff(ValueObjectListInterface $otherList): ValueObjectListInterface
60		{
61		$differentEntities = [];
62		/* @var TypedEntityInterface $entity */
63		foreach ($this as $pos => $entity) {
64		if (!$otherList->has($pos)) {
65		$differentEntities[] = $entity;
66		continue;
67		}
68		/* @var TypedEntityInterface $otherEntity */
69		$otherEntity = $otherList->get($pos);
70		$diff = $entity->getValueObjectMap()->diff($otherEntity->getValueObjectMap());
71		if (!$diff->isEmpty()) {
72		$differentEntities[] = $entity;
73		}
74		}
75		return new static($differentEntities);
76		}
77
78		private function __construct(array $entities = [])
79		{
80		$this->init($entities, EntityRelationInterface::class);
81		}
82		}
83

daikon-cqrs / entity

Push — master ( 819f30...8ceff2 )

RelatedEntityList::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like