InstitutionAuthorizationProjector::applyUseRaaOptionChangedEvent() - Code Metrics - Inspection of "Some minore fixups after review" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/fine-grained-authoriza... ( 5fbefa )

unknown

created 2018-10-04 09:10 UTC

applyUseRaaOptionChangedEvent() A

↳ Parent: InstitutionAuthorizationProjector

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	1
nc	1
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\StepupMiddleware\ApiBundle\Configuration\Projector;

use Broadway\ReadModel\Projector;
use Surfnet\Stepup\Configuration\Event\InstitutionConfigurationRemovedEvent;
use Surfnet\Stepup\Configuration\Event\NewInstitutionConfigurationCreatedEvent;
use Surfnet\Stepup\Configuration\Event\SelectRaaOptionChangedEvent;
use Surfnet\Stepup\Configuration\Event\UseRaaOptionChangedEvent;
use Surfnet\Stepup\Configuration\Event\UseRaOptionChangedEvent;
use Surfnet\Stepup\Configuration\Value\Institution;
use Surfnet\Stepup\Identity\Collection\InstitutionCollection;
use Surfnet\Stepup\Identity\Event\InstitutionsAddedToWhitelistEvent;
use Surfnet\Stepup\Identity\Event\InstitutionsRemovedFromWhitelistEvent;
use Surfnet\Stepup\Identity\Event\WhitelistCreatedEvent;
use Surfnet\Stepup\Identity\Event\WhitelistReplacedEvent;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Repository\InstitutionAuthorizationRepository;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Repository\InstitutionConfigurationOptionsRepository;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
final class InstitutionAuthorizationProjector extends Projector
{
    /**
     * @var InstitutionAuthorizationRepository
     */
    private $institutionAuthorizationRepository;
    /**
     * @var InstitutionConfigurationOptionsRepository
     */
    private $institutionConfigurationOptionsRepository;

    public function __construct(
        InstitutionAuthorizationRepository $institutionAuthorizationRepository,
        InstitutionConfigurationOptionsRepository $institutionConfigurationOptionsRepository
    ) {
        $this->institutionAuthorizationRepository = $institutionAuthorizationRepository;
        $this->institutionConfigurationOptionsRepository = $institutionConfigurationOptionsRepository;
    }

    public function applyNewInstitutionConfigurationCreatedEvent(NewInstitutionConfigurationCreatedEvent $event)
    {
        $this->setToDefaultIfNoConfigurationOptionsExist($event->institution);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function applyUseRaOptionChangedEvent(UseRaOptionChangedEvent $event)
    {
        $this->institutionAuthorizationRepository->saveInstitutionOption(
            $event->institution,
            $event->useRaOption
        );
    }

    public function applyUseRaaOptionChangedEvent(UseRaaOptionChangedEvent $event)
    {
        $this->institutionAuthorizationRepository->saveInstitutionOption(
            $event->institution,
            $event->useRaaOption
        );
    }

    public function applySelectRaaOptionChangedEvent(SelectRaaOptionChangedEvent $event)
    {
        $this->institutionAuthorizationRepository->saveInstitutionOption(
            $event->institution,
            $event->selectRaaOption
        );
    }

    public function applyInstitutionConfigurationRemovedEvent(InstitutionConfigurationRemovedEvent $event)
    {
        $this->institutionAuthorizationRepository->clearInstitutionOption(
            $event->institution
        );
    }

    protected function applyWhitelistCreatedEvent(WhitelistCreatedEvent $event)
    {
        $this->setToDefaultIfNoConfigurationOptionsExist($event->whitelistedInstitutions);
    }

    protected function applyWhitelistReplacedEvent(WhitelistReplacedEvent $event)
    {
        $this->setToDefaultIfNoConfigurationOptionsExist($event->whitelistedInstitutions);
    }

    protected function applyInstitutionsAddedToWhitelistEvent(InstitutionsAddedToWhitelistEvent $event)
    {
        $this->setToDefaultIfNoConfigurationOptionsExist($event->addedInstitutions);
    }

    protected function applyInstitutionsRemovedFromWhitelistEvent(InstitutionsRemovedFromWhitelistEvent $event)
    {
        $this->removeIfConfigurationOptionsDoNotExist($event->removedInstitutions);
    }

    /**
     * @param InstitutionCollection $institutionCollection
     * @throws \Doctrine\ORM\NoResultException
     * @throws \Doctrine\ORM\NonUniqueResultException
     * @throws \Doctrine\ORM\OptimisticLockException
     */
    private function setToDefaultIfNoConfigurationOptionsExist(InstitutionCollection $institutionCollection)

    {
        foreach ($institutionCollection as $institution) {
            $configurationInstitution = new Institution($institution->getInstitution());
            if (!$this->institutionConfigurationOptionsRepository->findConfigurationOptionsFor($configurationInstitution)) {
                $this->institutionAuthorizationRepository->setDefaultInstitutionOption($configurationInstitution);
            }
        }
    }

    /**
     * @param InstitutionCollection $institutionCollection
     * @throws \Doctrine\ORM\NoResultException
     * @throws \Doctrine\ORM\NonUniqueResultException
     * @throws \Doctrine\ORM\OptimisticLockException
     */
    private function removeIfConfigurationOptionsDoNotExist(InstitutionCollection $institutionCollection)

    {
        foreach ($institutionCollection as $institution) {
            $configurationInstitution = new Institution($institution->getInstitution());
            if (!$this->institutionConfigurationOptionsRepository->findConfigurationOptionsFor($configurationInstitution)) {
                $this->institutionAuthorizationRepository->clearInstitutionOption(
                    $configurationInstitution
                );
            }
        }
    }
}


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\StepupMiddleware\ApiBundle\Configuration\Projector;
20
21		use Broadway\ReadModel\Projector;
22		use Surfnet\Stepup\Configuration\Event\InstitutionConfigurationRemovedEvent;
23		use Surfnet\Stepup\Configuration\Event\NewInstitutionConfigurationCreatedEvent;
24		use Surfnet\Stepup\Configuration\Event\SelectRaaOptionChangedEvent;
25		use Surfnet\Stepup\Configuration\Event\UseRaaOptionChangedEvent;
26		use Surfnet\Stepup\Configuration\Event\UseRaOptionChangedEvent;
27		use Surfnet\Stepup\Configuration\Value\Institution;
28		use Surfnet\Stepup\Identity\Collection\InstitutionCollection;
29		use Surfnet\Stepup\Identity\Event\InstitutionsAddedToWhitelistEvent;
30		use Surfnet\Stepup\Identity\Event\InstitutionsRemovedFromWhitelistEvent;
31		use Surfnet\Stepup\Identity\Event\WhitelistCreatedEvent;
32		use Surfnet\Stepup\Identity\Event\WhitelistReplacedEvent;
33		use Surfnet\StepupMiddleware\ApiBundle\Configuration\Repository\InstitutionAuthorizationRepository;
34		use Surfnet\StepupMiddleware\ApiBundle\Configuration\Repository\InstitutionConfigurationOptionsRepository;
35
36		/**
37		* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
38		*/
39		final class InstitutionAuthorizationProjector extends Projector
40		{
41		/**
42		* @var InstitutionAuthorizationRepository
43		*/
44		private $institutionAuthorizationRepository;
45		/**
46		* @var InstitutionConfigurationOptionsRepository
47		*/
48		private $institutionConfigurationOptionsRepository;
49
50		public function __construct(
51		InstitutionAuthorizationRepository $institutionAuthorizationRepository,
52		InstitutionConfigurationOptionsRepository $institutionConfigurationOptionsRepository
53		) {
54		$this->institutionAuthorizationRepository = $institutionAuthorizationRepository;
55		$this->institutionConfigurationOptionsRepository = $institutionConfigurationOptionsRepository;
56		}
57
58		public function applyNewInstitutionConfigurationCreatedEvent(NewInstitutionConfigurationCreatedEvent $event)
59		{
60		$this->setToDefaultIfNoConfigurationOptionsExist($event->institution);
		0 ignored issues – show Documentation introduced 2018-10-03 07:49 UTC by Report Bug Copy Issue Report `$event->institution` is of type `object<Surfnet\Stepup\Co...tion\Value\Institution>`, but the function expects a `object<Surfnet\Stepup\Id...\InstitutionCollection>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
61		}
62
63		public function applyUseRaOptionChangedEvent(UseRaOptionChangedEvent $event)
64		{
65		$this->institutionAuthorizationRepository->saveInstitutionOption(
66		$event->institution,
67		$event->useRaOption
68		);
69		}
70
71		public function applyUseRaaOptionChangedEvent(UseRaaOptionChangedEvent $event)
72		{
73		$this->institutionAuthorizationRepository->saveInstitutionOption(
74		$event->institution,
75		$event->useRaaOption
76		);
77		}
78
79		public function applySelectRaaOptionChangedEvent(SelectRaaOptionChangedEvent $event)
80		{
81		$this->institutionAuthorizationRepository->saveInstitutionOption(
82		$event->institution,
83		$event->selectRaaOption
84		);
85		}
86
87		public function applyInstitutionConfigurationRemovedEvent(InstitutionConfigurationRemovedEvent $event)
88		{
89		$this->institutionAuthorizationRepository->clearInstitutionOption(
90		$event->institution
91		);
92		}
93
94		protected function applyWhitelistCreatedEvent(WhitelistCreatedEvent $event)
95		{
96		$this->setToDefaultIfNoConfigurationOptionsExist($event->whitelistedInstitutions);
97		}
98
99		protected function applyWhitelistReplacedEvent(WhitelistReplacedEvent $event)
100		{
101		$this->setToDefaultIfNoConfigurationOptionsExist($event->whitelistedInstitutions);
102		}
103
104		protected function applyInstitutionsAddedToWhitelistEvent(InstitutionsAddedToWhitelistEvent $event)
105		{
106		$this->setToDefaultIfNoConfigurationOptionsExist($event->addedInstitutions);
107		}
108
109		protected function applyInstitutionsRemovedFromWhitelistEvent(InstitutionsRemovedFromWhitelistEvent $event)
110		{
111		$this->removeIfConfigurationOptionsDoNotExist($event->removedInstitutions);
112		}
113
114		/**
115		* @param InstitutionCollection $institutionCollection
116		* @throws \Doctrine\ORM\NoResultException
117		* @throws \Doctrine\ORM\NonUniqueResultException
118		* @throws \Doctrine\ORM\OptimisticLockException
119		*/
120	View Code Duplication	private function setToDefaultIfNoConfigurationOptionsExist(InstitutionCollection $institutionCollection)
		0 ignored issues – show Duplication introduced 2018-10-02 15:42 UTC by Report Bug Copy Issue Report This method 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...
121		{
122		foreach ($institutionCollection as $institution) {
123		$configurationInstitution = new Institution($institution->getInstitution());
124		if (!$this->institutionConfigurationOptionsRepository->findConfigurationOptionsFor($configurationInstitution)) {
125		$this->institutionAuthorizationRepository->setDefaultInstitutionOption($configurationInstitution);
126		}
127		}
128		}
129
130		/**
131		* @param InstitutionCollection $institutionCollection
132		* @throws \Doctrine\ORM\NoResultException
133		* @throws \Doctrine\ORM\NonUniqueResultException
134		* @throws \Doctrine\ORM\OptimisticLockException
135		*/
136	View Code Duplication	private function removeIfConfigurationOptionsDoNotExist(InstitutionCollection $institutionCollection)
		0 ignored issues – show Duplication introduced 2018-10-02 15:42 UTC by Report Bug Copy Issue Report This method 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...
137		{
138		foreach ($institutionCollection as $institution) {
139		$configurationInstitution = new Institution($institution->getInstitution());
140		if (!$this->institutionConfigurationOptionsRepository->findConfigurationOptionsFor($configurationInstitution)) {
141		$this->institutionAuthorizationRepository->clearInstitutionOption(
142		$configurationInstitution
143		);
144		}
145		}
146		}
147		}
148

OpenConext / Stepup-Middleware

Push — feature/fine-grained-authoriza... ( 5fbefa )

applyUseRaaOptionChangedEvent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like