AttributeReleasePolicyService::applyAttributeReleasePolicies() - Code Metrics - Inspection of "Apply attribute release policy to attributes under..." - OpenConext/OpenConext-profile - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#70)

by A.

created 2016-10-26 15:21 UTC

applyAttributeReleasePolicies() B

↳ Parent: AttributeReleasePolicyService

Complexity

Conditions	8
Paths	5

Size

Total Lines	55
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	55
rs	7.4033
c	0
b	0
f	0
cc	8
eloc	32
nc	5
nop	2

How to fix Long Method

<?php

/**
 * Copyright 2016 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 OpenConext\EngineBlockApiClientBundle\Service;

use Assert\Assertion;
use OpenConext\EngineBlockApiClientBundle\Exception\InvalidResponseException;
use OpenConext\EngineBlockApiClientBundle\Http\JsonApiClient;
use OpenConext\Profile\Value\Consent;
use OpenConext\Profile\Value\ConsentList;
use OpenConext\Profile\Value\SpecifiedConsent;
use OpenConext\Profile\Value\SpecifiedConsentList;
use OpenConext\ProfileBundle\Attribute\AttributeSetWithFallbacks;
use stdClass;
use Surfnet\SamlBundle\SAML2\Attribute\Attribute;
use Surfnet\SamlBundle\SAML2\Attribute\AttributeDictionary;
use Surfnet\SamlBundle\SAML2\Attribute\AttributeSetInterface;

final class AttributeReleasePolicyService
{
    /**
     * @var JsonApiClient
     */
    private $jsonApiClient;

    /**
     * @var AttributeDictionary
     */
    private $attributeDictionary;

    public function __construct(JsonApiClient $jsonApiClient, AttributeDictionary $attributeDictionary)
    {
        $this->jsonApiClient = $jsonApiClient;
        $this->attributeDictionary = $attributeDictionary;
    }

    /**
     * @param ConsentList $consentList
     * @param AttributeSetInterface $attributeSet
     * @return SpecifiedConsentList
     */
    public function applyAttributeReleasePolicies(ConsentList $consentList, AttributeSetInterface $attributeSet)
    {
        $entityIds = $consentList->map(function (Consent $consent) {
            return $consent->getServiceProvider()->getEntity()->getEntityId()->getEntityId();
        });

        $mappedAttributes = [];
        foreach ($attributeSet as $attribute) {
            $mace = $attribute->getAttributeDefinition()->getUrnMace();
            $oid  = $attribute->getAttributeDefinition()->getUrnOid();

            if ($mace !== null) {
                $mappedAttributes[$mace] = $attribute->getValue();
            }

            if ($oid !== null) {
                $mappedAttributes[$oid] = $attribute->getValue();
            }
        }

        $response = $this->jsonApiClient->post([
            'entityIds'  => $entityIds,
            'attributes' => !empty($mappedAttributes) ? $mappedAttributes : new stdClass()
        ], '/arp');

        $specifiedConsents = $consentList->map(
            function (Consent $consent) use ($response) {
                $entityId = $consent->getServiceProvider()->getEntity()->getEntityId()->getEntityId();

                if (!isset($response[$entityId])) {
                    throw new InvalidResponseException(
                        sprintf(
                            'EntityID "%s" was not found in the ARP response (entityIDs: %s)',
                            $entityId,
                            join(', ', array_keys($response))
                        )
                    );
                }

                $attributes = [];
                foreach ($response[$entityId] as $attributeName => $attributeValue) {
                    $attributeDefinition = $this->attributeDictionary->findAttributeDefinitionByUrn($attributeName);

                    $attribute = new Attribute($attributeDefinition, $attributeValue);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                    if (!in_array($attribute, $attributes)) {
                        $attributes[] = $attribute;
                    }
                }

                return SpecifiedConsent::specifies($consent, AttributeSetWithFallbacks::create($attributes));
            }
        );

        return SpecifiedConsentList::createWith($specifiedConsents);
    }
}


1			<?php
2
3			/**
4			* Copyright 2016 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 OpenConext\EngineBlockApiClientBundle\Service;
20
21			use Assert\Assertion;
22			use OpenConext\EngineBlockApiClientBundle\Exception\InvalidResponseException;
23			use OpenConext\EngineBlockApiClientBundle\Http\JsonApiClient;
24			use OpenConext\Profile\Value\Consent;
25			use OpenConext\Profile\Value\ConsentList;
26			use OpenConext\Profile\Value\SpecifiedConsent;
27			use OpenConext\Profile\Value\SpecifiedConsentList;
28			use OpenConext\ProfileBundle\Attribute\AttributeSetWithFallbacks;
29			use stdClass;
30			use Surfnet\SamlBundle\SAML2\Attribute\Attribute;
31			use Surfnet\SamlBundle\SAML2\Attribute\AttributeDictionary;
32			use Surfnet\SamlBundle\SAML2\Attribute\AttributeSetInterface;
33
34			final class AttributeReleasePolicyService
35			{
36			/**
37			* @var JsonApiClient
38			*/
39			private $jsonApiClient;
40
41			/**
42			* @var AttributeDictionary
43			*/
44			private $attributeDictionary;
45
46			public function __construct(JsonApiClient $jsonApiClient, AttributeDictionary $attributeDictionary)
47			{
48			$this->jsonApiClient = $jsonApiClient;
49			$this->attributeDictionary = $attributeDictionary;
50			}
51
52			/**
53			* @param ConsentList $consentList
54			* @param AttributeSetInterface $attributeSet
55			* @return SpecifiedConsentList
56			*/
57			public function applyAttributeReleasePolicies(ConsentList $consentList, AttributeSetInterface $attributeSet)
58			{
59			$entityIds = $consentList->map(function (Consent $consent) {
60			return $consent->getServiceProvider()->getEntity()->getEntityId()->getEntityId();
61			});
62
63			$mappedAttributes = [];
64			foreach ($attributeSet as $attribute) {
65			$mace = $attribute->getAttributeDefinition()->getUrnMace();
66			$oid = $attribute->getAttributeDefinition()->getUrnOid();
67
68			if ($mace !== null) {
69			$mappedAttributes[$mace] = $attribute->getValue();
70			}
71
72			if ($oid !== null) {
73			$mappedAttributes[$oid] = $attribute->getValue();
74			}
75			}
76
77			$response = $this->jsonApiClient->post([
78			'entityIds' => $entityIds,
79			'attributes' => !empty($mappedAttributes) ? $mappedAttributes : new stdClass()
80			], '/arp');
81
82			$specifiedConsents = $consentList->map(
83			function (Consent $consent) use ($response) {
84			$entityId = $consent->getServiceProvider()->getEntity()->getEntityId()->getEntityId();
85
86			if (!isset($response[$entityId])) {
87			throw new InvalidResponseException(
88			sprintf(
89			'EntityID "%s" was not found in the ARP response (entityIDs: %s)',
90			$entityId,
91			join(', ', array_keys($response))
92			)
93			);
94			}
95
96			$attributes = [];
97			foreach ($response[$entityId] as $attributeName => $attributeValue) {
98			$attributeDefinition = $this->attributeDictionary->findAttributeDefinitionByUrn($attributeName);
99
100			$attribute = new Attribute($attributeDefinition, $attributeValue);
			0 ignored issues – show Bug introduced 2016-10-26 15:25 UTC by Report Bug Copy Issue Report It seems like `$attributeDefinition` defined by `$this->attributeDictiona...onByUrn($attributeName)` on line `98` can be `null`; however, `Surfnet\SamlBundle\SAML2...ttribute::__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
101			if (!in_array($attribute, $attributes)) {
102			$attributes[] = $attribute;
103			}
104			}
105
106			return SpecifiedConsent::specifies($consent, AttributeSetWithFallbacks::create($attributes));
107			}
108			);
109
110			return SpecifiedConsentList::createWith($specifiedConsents);
111			}
112			}
113

OpenConext / OpenConext-profile

Pull Request — develop (#70)

applyAttributeReleasePolicies() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like