ChannelChangerFactory - Code Metrics - Inspection of "Added named services and Updated read me" - wshafer/psr11-monolog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Westin

created 2017-09-15 17:27 UTC

ChannelChangerFactory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

97.67%

Importance

Changes

Metric	Value
wmc	11
lcom	1
cbo	9
dl	0
loc	89
ccs	42
cts	43
cp	0.9767
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	__invoke()	12	1
A	getMainConfig()	5	1
A	getHandlerManager()	12	1
A	getFormatterManager()	11	1
A	getProcessorManager()	11	1
B	getConfigArray()	22	6

<?php

namespace WShafer\PSR11MonoLog;

use Psr\Container\ContainerInterface;
use WShafer\PSR11MonoLog\Config\MainConfig;
use WShafer\PSR11MonoLog\Formatter\FormatterMapper;
use WShafer\PSR11MonoLog\Handler\HandlerMapper;
use WShafer\PSR11MonoLog\Processor\ProcessorMapper;
use WShafer\PSR11MonoLog\Service\FormatterManager;
use WShafer\PSR11MonoLog\Service\HandlerManager;
use WShafer\PSR11MonoLog\Service\ProcessorManager;

class ChannelChangerFactory
{
    protected $config = null;

    protected $handlerManager = null;

    protected $processManager = null;

    protected $formatterManager = null;

    public function __invoke(ContainerInterface $container)
    {
        $config = $this->getMainConfig($container);
        $handlerManager = $this->getHandlerManager($container);
        $processorManager = $this->getProcessorManager($container);

        return new ChannelChanger(
            $config,
            $handlerManager,
            $processorManager
        );
    }

    public function getMainConfig(ContainerInterface $container)
    {
        $config = $this->getConfigArray($container);
        return new MainConfig($config);
    }

    protected function getConfigArray(ContainerInterface $container)
    {
        // Symfony config is parameters. //
        if (method_exists($container, 'getParameter')
            && method_exists($container, 'hasParameter')
            && $container->hasParameter('monolog')
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 ['monolog' => $container->getParameter('monolog')];
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.
    }
}
        }

        // Zend uses config key
        if ($container->has('config')) {
            return $container->get('config');
        }

        // Slim Config comes from "settings"
        if ($container->has('settings')) {
            return ['monolog' => $container->get('settings')['monolog']];
        }

        return [];
    }

    public function getHandlerManager(ContainerInterface $container)
    {
        $config = $this->getMainConfig($container);
        $this->handlerManager = new HandlerManager(
            $config,
            new HandlerMapper(),
            $container
        );

        $this->handlerManager->setFormatterManager($this->getFormatterManager($container));
        return $this->handlerManager;
    }

    public function getFormatterManager(ContainerInterface $container)
    {
        $config = $this->getMainConfig($container);
        $this->formatterManager = new FormatterManager(
            $config,
            new FormatterMapper(),
            $container
        );

        return $this->formatterManager;
    }

    public function getProcessorManager(ContainerInterface $container)
    {
        $config = $this->getMainConfig($container);
        $this->processManager = new ProcessorManager(
            $config,
            new ProcessorMapper(),
            $container
        );

        return $this->processManager;
    }
}


1		<?php
2
3		namespace WShafer\PSR11MonoLog;
4
5		use Psr\Container\ContainerInterface;
6		use WShafer\PSR11MonoLog\Config\MainConfig;
7		use WShafer\PSR11MonoLog\Formatter\FormatterMapper;
8		use WShafer\PSR11MonoLog\Handler\HandlerMapper;
9		use WShafer\PSR11MonoLog\Processor\ProcessorMapper;
10		use WShafer\PSR11MonoLog\Service\FormatterManager;
11		use WShafer\PSR11MonoLog\Service\HandlerManager;
12		use WShafer\PSR11MonoLog\Service\ProcessorManager;
13
14		class ChannelChangerFactory
15		{
16		protected $config = null;
17
18		protected $handlerManager = null;
19
20		protected $processManager = null;
21
22		protected $formatterManager = null;
23
24	1	public function __invoke(ContainerInterface $container)
25		{
26	1	$config = $this->getMainConfig($container);
27	1	$handlerManager = $this->getHandlerManager($container);
28	1	$processorManager = $this->getProcessorManager($container);
29
30	1	return new ChannelChanger(
31	1	$config,
32	1	$handlerManager,
33	1	$processorManager
34		);
35		}
36
37	7	public function getMainConfig(ContainerInterface $container)
38		{
39	7	$config = $this->getConfigArray($container);
40	7	return new MainConfig($config);
41		}
42
43	7	protected function getConfigArray(ContainerInterface $container)
44		{
45		// Symfony config is parameters. //
46	7	if (method_exists($container, 'getParameter')
47	7	&& method_exists($container, 'hasParameter')
48	7	&& $container->hasParameter('monolog')
		1 ignored issue – show Bug introduced 2017-07-25 17:16 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Container\ContainerInterface` as the method `hasParameter()` does only exist in the following implementations of said interface: `Container14\ProjectServiceContainer`, `ProjectServiceContainer`, `Symfony\Component\DependencyInjection\Container`, `Symfony\Component\Depend...ection\ContainerBuilder`, `Symfony\Component\Depend...tainers\CustomContainer`, `Symfony\Component\Depend...ProjectServiceContainer`, `Symfony\Component\Depend...ProjectServiceContainer`. 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...
49		) {
50	1	return ['monolog' => $container->getParameter('monolog')];
		1 ignored issue – show Bug introduced 2017-07-25 17:16 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Container\ContainerInterface` as the method `getParameter()` does only exist in the following implementations of said interface: `Container14\ProjectServiceContainer`, `ProjectServiceContainer`, `Symfony\Component\DependencyInjection\Container`, `Symfony\Component\Depend...ection\ContainerBuilder`, `Symfony\Component\Depend...tainers\CustomContainer`, `Symfony\Component\Depend...ProjectServiceContainer`, `Symfony\Component\Depend...ProjectServiceContainer`. 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...
51		}
52
53		// Zend uses config key
54	6	if ($container->has('config')) {
55	5	return $container->get('config');
56		}
57
58		// Slim Config comes from "settings"
59	1	if ($container->has('settings')) {
60	1	return ['monolog' => $container->get('settings')['monolog']];
61		}
62
63		return [];
64		}
65
66	2	public function getHandlerManager(ContainerInterface $container)
67		{
68	2	$config = $this->getMainConfig($container);
69	2	$this->handlerManager = new HandlerManager(
70	2	$config,
71	2	new HandlerMapper(),
72	2	$container
73		);
74
75	2	$this->handlerManager->setFormatterManager($this->getFormatterManager($container));
76	2	return $this->handlerManager;
77		}
78
79	3	public function getFormatterManager(ContainerInterface $container)
80		{
81	3	$config = $this->getMainConfig($container);
82	3	$this->formatterManager = new FormatterManager(
83	3	$config,
84	3	new FormatterMapper(),
85	3	$container
86		);
87
88	3	return $this->formatterManager;
89		}
90
91	2	public function getProcessorManager(ContainerInterface $container)
92		{
93	2	$config = $this->getMainConfig($container);
94	2	$this->processManager = new ProcessorManager(
95	2	$config,
96	2	new ProcessorMapper(),
97	2	$container
98		);
99
100	2	return $this->processManager;
101		}
102		}
103

wshafer / psr11-monolog

Pull Request — master (#4)

ChannelChangerFactory A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like