ServiceCredentialsFactory - Code Metrics - Inspection of "Update service-to-credentials mapping" - zbox/UnifiedPush - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b6f376...58a2c7 )

by Alexander

created 2016-05-06 09:26 UTC

ServiceCredentialsFactory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
wmc	14
c	3
b	0
f	1
lcom	1
cbo	8
dl	0
loc	141
rs	10

7 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	setCredentialsPath()	5	1
A	setConfig()	5	1
A	loadServiceCredentialsConfig()	23	3
A	getInitializedServices()	4	1
A	getCredentialsByService()	21	3
B	getCredentialsDTOByServiceName()	22	4

<?php

/*
 * (c) Alexander Zhukov <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zbox\UnifiedPush\NotificationService;

use Zbox\UnifiedPush\Utils\ClientCredentials\CredentialsMapper;
use Zbox\UnifiedPush\Exception\InvalidArgumentException;
use Zbox\UnifiedPush\Exception\RuntimeException;
use Zbox\UnifiedPush\Exception\DomainException;
use Zbox\UnifiedPush\Utils\ClientCredentials\DTO\AuthToken;
use Zbox\UnifiedPush\Utils\ClientCredentials\DTO\NullCredentials;
use Zbox\UnifiedPush\Utils\ClientCredentials\DTO\SSLCertificate;

class ServiceCredentialsFactory
{
    /**
     * @var CredentialsMapper
     */
    protected $credentialsMapper;

    /**
     * @var string
     */
    protected $credentialsPath;

    /**
     * @var array
     */
    protected $config;

    /**
     * @param CredentialsMapper $credentialsMapper
     */
    public function __construct(CredentialsMapper $credentialsMapper)
    {
        $this->credentialsMapper = $credentialsMapper;
    }

    /**
     * @param string $credentialsPath
     * @return $this
     */
    public function setCredentialsPath($credentialsPath)
    {
        $this->credentialsPath = $credentialsPath;
        return $this;
    }

    /**
     * @param array $config
     * @return $this
     */
    public function setConfig(array $config)
    {
        $this->config = $config;
        return $this;
    }

    /**
     * Load sender`s notification services credentials
     *
     * @return $this
     * @throws DomainException
     */
    public function loadServiceCredentialsConfig()
    {
        $configPath = $this->credentialsPath;

        if (!file_exists($configPath)) {
            throw new InvalidArgumentException(
                sprintf(
                    "Credentials file '%s' doesn`t exists",
                    $configPath
                )
            );
        }

        $config = json_decode(file_get_contents($configPath), true);

        if (!is_array($config)) {
            throw new RuntimeException('Empty credentials config');
        }

        $this->config = $config;

        return $this;
    }

    /**
     * Returns the list of names of notification services
     *
     * @return array
     */
    public function getInitializedServices()
    {
        return array_keys($this->config);
    }

    /**
     * Returns credentials for notification service
     *
     * @param string $serviceName
     * @throws DomainException
     * @return array
     */
    public function getCredentialsByService($serviceName)
    {
        if (empty($this->config)) {
            $this->loadServiceCredentialsConfig();
        }

        if (!in_array($serviceName, $this->getInitializedServices())) {
            throw new DomainException(
                sprintf("Credentials for service '%s' was not initialized", $serviceName)
            );
        }

        return
            $this
                ->credentialsMapper
                ->mapCredentials(
                    $this->getCredentialsDTOByServiceName($serviceName),

                    $this->config[$serviceName]
                )
            ;
    }

    /**
     * @param string $serviceName
     * @return \Zbox\UnifiedPush\Utils\ClientCredentials\CredentialsInterface
     */
    private function getCredentialsDTOByServiceName($serviceName)
    {
        $credentialsType = NotificationServices::getCredentialsTypeByService($serviceName);

        switch ($credentialsType) {
            case NotificationServices::CREDENTIALS_CERTIFICATE:
                return new SSLCertificate();
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case NotificationServices::CREDENTIALS_AUTH_TOKEN:
                return new AuthToken();
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case NotificationServices::CREDENTIALS_NULL:
                return new NullCredentials();
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            default:
                throw new DomainException(sprintf("Unsupported credentials type '%s'", $credentialsType));
                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        }
    }
}


1			<?php
2
3			/*
4			* (c) Alexander Zhukov <[email protected]>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace Zbox\UnifiedPush\NotificationService;
11
12			use Zbox\UnifiedPush\Utils\ClientCredentials\CredentialsMapper;
13			use Zbox\UnifiedPush\Exception\InvalidArgumentException;
14			use Zbox\UnifiedPush\Exception\RuntimeException;
15			use Zbox\UnifiedPush\Exception\DomainException;
16			use Zbox\UnifiedPush\Utils\ClientCredentials\DTO\AuthToken;
17			use Zbox\UnifiedPush\Utils\ClientCredentials\DTO\NullCredentials;
18			use Zbox\UnifiedPush\Utils\ClientCredentials\DTO\SSLCertificate;
19
20			class ServiceCredentialsFactory
21			{
22			/**
23			* @var CredentialsMapper
24			*/
25			protected $credentialsMapper;
26
27			/**
28			* @var string
29			*/
30			protected $credentialsPath;
31
32			/**
33			* @var array
34			*/
35			protected $config;
36
37			/**
38			* @param CredentialsMapper $credentialsMapper
39			*/
40			public function __construct(CredentialsMapper $credentialsMapper)
41			{
42			$this->credentialsMapper = $credentialsMapper;
43			}
44
45			/**
46			* @param string $credentialsPath
47			* @return $this
48			*/
49			public function setCredentialsPath($credentialsPath)
50			{
51			$this->credentialsPath = $credentialsPath;
52			return $this;
53			}
54
55			/**
56			* @param array $config
57			* @return $this
58			*/
59			public function setConfig(array $config)
60			{
61			$this->config = $config;
62			return $this;
63			}
64
65			/**
66			* Load sender`s notification services credentials
67			*
68			* @return $this
69			* @throws DomainException
70			*/
71			public function loadServiceCredentialsConfig()
72			{
73			$configPath = $this->credentialsPath;
74
75			if (!file_exists($configPath)) {
76			throw new InvalidArgumentException(
77			sprintf(
78			"Credentials file '%s' doesn`t exists",
79			$configPath
80			)
81			);
82			}
83
84			$config = json_decode(file_get_contents($configPath), true);
85
86			if (!is_array($config)) {
87			throw new RuntimeException('Empty credentials config');
88			}
89
90			$this->config = $config;
91
92			return $this;
93			}
94
95			/**
96			* Returns the list of names of notification services
97			*
98			* @return array
99			*/
100			public function getInitializedServices()
101			{
102			return array_keys($this->config);
103			}
104
105			/**
106			* Returns credentials for notification service
107			*
108			* @param string $serviceName
109			* @throws DomainException
110			* @return array
111			*/
112			public function getCredentialsByService($serviceName)
113			{
114			if (empty($this->config)) {
115			$this->loadServiceCredentialsConfig();
116			}
117
118			if (!in_array($serviceName, $this->getInitializedServices())) {
119			throw new DomainException(
120			sprintf("Credentials for service '%s' was not initialized", $serviceName)
121			);
122			}
123
124			return
125			$this
126			->credentialsMapper
127			->mapCredentials(
128			$this->getCredentialsDTOByServiceName($serviceName),
			0 ignored issues – show Bug introduced 2016-05-06 09:29 UTC by Report Bug Copy Issue Report It seems like `$this->getCredentialsDTO...rviceName($serviceName)` targeting `Zbox\UnifiedPush\Notific...tialsDTOByServiceName()` can also be of type `null`; however, `Zbox\UnifiedPush\Utils\C...apper::mapCredentials()` does only seem to accept `object<Zbox\UnifiedPush\...s\CredentialsInterface>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
129			$this->config[$serviceName]
130			)
131			;
132			}
133
134			/**
135			* @param string $serviceName
136			* @return \Zbox\UnifiedPush\Utils\ClientCredentials\CredentialsInterface
137			*/
138			private function getCredentialsDTOByServiceName($serviceName)
139			{
140			$credentialsType = NotificationServices::getCredentialsTypeByService($serviceName);
141
142			switch ($credentialsType) {
143			case NotificationServices::CREDENTIALS_CERTIFICATE:
144			return new SSLCertificate();
145			break;
			0 ignored issues – show Unused Code introduced 2016-05-06 09:29 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
146
147			case NotificationServices::CREDENTIALS_AUTH_TOKEN:
148			return new AuthToken();
149			break;
			0 ignored issues – show Unused Code introduced 2016-05-06 09:29 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
150
151			case NotificationServices::CREDENTIALS_NULL:
152			return new NullCredentials();
153			break;
			0 ignored issues – show Unused Code introduced 2016-05-06 09:29 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
154
155			default:
156			throw new DomainException(sprintf("Unsupported credentials type '%s'", $credentialsType));
157			break;
			0 ignored issues – show Unused Code introduced 2016-05-06 09:29 UTC by Report Bug Copy Issue Report `break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
158			}
159			}
160			}
161

zbox / UnifiedPush

GitHub Access Token became invalid

Push — master ( b6f376...58a2c7 )

ServiceCredentialsFactory A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like