InstitutionSet::__construct() - Code Metrics - Inspection of "Add the InstitutionSet value object" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/update-inst-conf-aggre... ( 8277a8...d31c76 )

by Michiel

created 2018-09-24 11:26 UTC

InstitutionSet::__construct() A

↳ Parent: InstitutionSet

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	9.536
c	0
b	0
f	0
cc	3
nc	2
nop	1

<?php

/**
 * Copyright 2018 SURFnet B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\Stepup\Configuration\Value;

use ArrayIterator;
use IteratorAggregate;
use JsonSerializable;
use Surfnet\Stepup\Exception\InvalidArgumentException;

final class InstitutionSet implements JsonSerializable, IteratorAggregate
{
    /**
     * @var array
     */
    private $institutionSet;

    /**
     * @param Institution[]
     */
    public function __construct(array $institutions)
    {
        // Verify only Institution value objects are collected in the set
        array_walk(
            $institutions,
            function ($institution, $key) use ($institutions) {
                if (!$institution instanceof Institution) {
                    throw InvalidArgumentException::invalidType(
                        Institution::class,
                        'institutions',
                        $institutions[$key]
                    );
                }
            }
        );

        // Normalize (lowercase) the institutions for the test on unique entries below.
        $institutionsLowerCased = array_map('strtolower', $institutions);
        if ($institutionsLowerCased !== array_unique($institutionsLowerCased)) {
            throw new InvalidArgumentException('Duplicate entries are not allowed in the InstitutionSet');
        }

        $this->institutionSet = $institutions;
    }

    public static function fromInstitutionConfig(array $institutions)
    {
        if (empty($institutions)) {
            return new self($institutions);
        }

        $set = [];
        foreach ($institutions as $institutionTitle) {
            $set[] = new Institution($institutionTitle);
        }

        return new self($set);
    }
    
    public function equals(InstitutionSet $other)
    {
        // Compare the institution values of the sets
        $currentValues = $this->toScalarArray();
        $otherValues = $other->toScalarArray();
        return $currentValues === $otherValues;
    }

    /**
     * Return an array of institution values represented by their string value
     */
    public function toScalarArray()
    {
        return array_map('strval', $this->toArray());
    }

    private function toArray()

    {
        return $this->getIterator()->getArrayCopy();
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.
    }
}
    }

    public function jsonSerialize()
    {
        return $this->institutionSet;
    }

    public function getIterator()
    {
        return new ArrayIterator($this->institutionSet);
    }
}


1			<?php
2
3			/**
4			* Copyright 2018 SURFnet B.V.
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\Stepup\Configuration\Value;
20
21			use ArrayIterator;
22			use IteratorAggregate;
23			use JsonSerializable;
24			use Surfnet\Stepup\Exception\InvalidArgumentException;
25
26			final class InstitutionSet implements JsonSerializable, IteratorAggregate
27			{
28			/**
29			* @var array
30			*/
31			private $institutionSet;
32
33			/**
34			* @param Institution[]
35			*/
36			public function __construct(array $institutions)
37			{
38			// Verify only Institution value objects are collected in the set
39			array_walk(
40			$institutions,
41			function ($institution, $key) use ($institutions) {
42			if (!$institution instanceof Institution) {
43			throw InvalidArgumentException::invalidType(
44			Institution::class,
45			'institutions',
46			$institutions[$key]
47			);
48			}
49			}
50			);
51
52			// Normalize (lowercase) the institutions for the test on unique entries below.
53			$institutionsLowerCased = array_map('strtolower', $institutions);
54			if ($institutionsLowerCased !== array_unique($institutionsLowerCased)) {
55			throw new InvalidArgumentException('Duplicate entries are not allowed in the InstitutionSet');
56			}
57
58			$this->institutionSet = $institutions;
59			}
60
61			public static function fromInstitutionConfig(array $institutions)
62			{
63			if (empty($institutions)) {
64			return new self($institutions);
65			}
66
67			$set = [];
68			foreach ($institutions as $institutionTitle) {
69			$set[] = new Institution($institutionTitle);
70			}
71
72			return new self($set);
73			}
74
75			public function equals(InstitutionSet $other)
76			{
77			// Compare the institution values of the sets
78			$currentValues = $this->toScalarArray();
79			$otherValues = $other->toScalarArray();
80			return $currentValues === $otherValues;
81			}
82
83			/**
84			* Return an array of institution values represented by their string value
85			*/
86			public function toScalarArray()
87			{
88			return array_map('strval', $this->toArray());
89			}
90
91			private function toArray()
			0 ignored issues – show Documentation introduced 2018-09-24 11:30 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
92			{
93			return $this->getIterator()->getArrayCopy();
			0 ignored issues – show Bug introduced 2018-09-24 11:24 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Traversable` as the method `getArrayCopy()` does only exist in the following implementations of said interface: `ArrayIterator`, `ArrayObject`, `DoctrineTest\Instantiato...tAsset\ArrayObjectAsset`, `DoctrineTest\Instantiato...lizableArrayObjectAsset`, `DoctrineTest\Instantiato...ceptionArrayObjectAsset`, `DoctrineTest\Instantiato...sset\WakeUpNoticesAsset`, `Issue523`, `RecursiveArrayIterator`, `Symfony\Component\Finder...rator\InnerNameIterator`, `Symfony\Component\Finder...rator\InnerSizeIterator`, `Symfony\Component\Finder...rator\InnerTypeIterator`, `Symfony\Component\Finder...or\MockFileListIterator`, `Symfony\Component\Form\E...r\ViolationPathIterator`, `Symfony\Component\Proper...ss\PropertyPathIterator`, `Symfony\Component\VarDum...\Caster\MyArrayIterator`, `Zend\Code\Annotation\AnnotationCollection`, `Zend\Code\Scanner\AnnotationScanner`. 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...
94			}
95
96			public function jsonSerialize()
97			{
98			return $this->institutionSet;
99			}
100
101			public function getIterator()
102			{
103			return new ArrayIterator($this->institutionSet);
104			}
105			}
106

OpenConext / Stepup-Middleware

Push — feature/update-inst-conf-aggre... ( 8277a8...d31c76 )

InstitutionSet::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like