Config::makeLazyInvokable() - Code Metrics - Inspection of "Improve Zend Service Manager compatibility" - northwoods/container - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#12)

by Woody

created 2018-03-27 14:37 UTC

Config::makeLazyInvokable() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2
crap	1

<?php
declare(strict_types=1);

namespace Northwoods\Container\Zend;

use ArrayObject;
use Auryn\Injector;
use Northwoods\Container\ContainerException;
use Northwoods\Container\InjectorConfig;
use Psr\Container\ContainerInterface;

class Config implements InjectorConfig
{
    /** @var array */
    private $config;

    /** @var bool */
    private $sharedByDefault = true;

    public function __construct(array $config)
    {
        $this->config = $config;
    }

    /**
     * Configure the injector using Zend Service Manager format
     */
    public function apply(Injector $injector): void
    {
        $dependencies = $this->config['dependencies'] ?? [];

        // Define the "config" service, accounting for the fact that Auryn
        // requires all returns are objects.
        $dependencies['services']['config'] = new ArrayObject($this->config, ArrayObject::ARRAY_AS_PROPS);

        $this->injectServices($injector, $dependencies);
        $this->injectFactories($injector, $dependencies);
        $this->injectInvokables($injector, $dependencies);
        $this->injectAliases($injector, $dependencies);
    }

    private function injectAliases(Injector $injector, array $dependencies): void

    {
        $aliases = $dependencies['aliases'] ?? [];
        foreach ($aliases as $alias => $target) {
            // Standard Auryn aliases do not work when chained. Work around by
            // lazily fetching the shared target from the container.
            $injector->share($alias)->share($target)->delegate($alias, $this->makeContainerGet($target));
        }
    }

    private function injectFactories(Injector $injector, array $dependencies): void
    {
        $factories = $dependencies['factories'] ?? [];
        foreach ($factories as $name => $factory) {
            $delegate = $this->makeFactory($injector, $name, $factory);
            if (isset($dependencies['delegators'][$name])) {

                $delegate = $this->makeDelegator(
                    $injector,
                    $name,
                    $delegate,
                    $dependencies['delegators'][$name]
                );
            }
            $injector->share($name)->delegate($name, $delegate);
        }
    }

    private function injectInvokables(Injector $injector, array $dependencies): void
    {
        $invokables = $dependencies['invokables'] ?? [];
        foreach ($invokables as $alias => $invokable) {
            if (is_string($alias) && $alias !== $invokable) {
                $injector->alias($alias, $invokable);
            }
            $delegate = $this->makeLazyInvokable($invokable, $invokable);
            if (isset($dependencies['delegators'][$invokable])) {

                $delegate = $this->makeDelegator(
                    $injector,
                    $invokable,
                    $delegate,
                    $dependencies['delegators'][$invokable]
                );
            }
            $injector->share($invokable)->delegate($invokable, $delegate);
        }
    }

    private function injectServices(Injector $injector, array $dependencies): void

    {
        $services = $dependencies['services'] ?? [];
        foreach ($services as $name => $service) {
            $injector->share($name)->delegate($name, $this->makeIdentity($service));
        }
    }

    private function makeDelegator(Injector $injector, string $name, callable $callback, array $delegators): callable
    {
        return /** @return object */ function () use ($injector, $name, $callback, $delegators) {
            foreach ($delegators as $delegator) {
                $container = $injector->make(ContainerInterface::class);
                $delegator = $this->makeInvokable($name, $delegator);
                $instance = $delegator($container, $name, $callback);
                $callback = $this->makeIdentity($instance);
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)
            }
            return $instance ?? $callback();
        };
    }

    private function makeContainerGet(string $name): callable
    {
        return /** @return object */ static function (ContainerInterface $container) use ($name) {
            return $container->get($name);
        };
    }

    /**
     * @param string|callable $factory
     */
    private function makeFactory(Injector $injector, string $name, $factory): callable
    {
        return /** @return object */ function () use ($injector, $name, $factory) {
            $container = $injector->make(ContainerInterface::class);
            $factory = $this->makeInvokable($name, $factory);
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)
            return $factory($container, $name);
        };
    }

    /**
     * @param object $object
     */
    private function makeIdentity($object): callable
    {
        return /** @return object */ static function () use ($object) {
            return $object;
        };
    }

    /**
     * @param string|callable $factory
     * @throws ContainerException if the factory cannot be made invokable
     */
    private function makeInvokable(string $name, $factory): callable
    {
        if (is_callable($factory)) {
            return $factory;
        }

        if (!class_exists($factory)) {
            throw ContainerException::expectedInvokable($name);
        }

        $factory = new $factory();

        if (is_callable($factory)) {
            return $factory;
        }

        throw ContainerException::expectedInvokable($name);
    }

    /**
     * @param string|callable $factory
     */
    private function makeLazyInvokable(string $name, $factory): callable
    {
        return /** @return callable */ function () use ($name, $factory) {
            return $this->makeInvokable($name, $factory);
        };
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Northwoods\Container\Zend;
5
6			use ArrayObject;
7			use Auryn\Injector;
8			use Northwoods\Container\ContainerException;
9			use Northwoods\Container\InjectorConfig;
10			use Psr\Container\ContainerInterface;
11
12			class Config implements InjectorConfig
13			{
14			/** @var array */
15			private $config;
16
17			/** @var bool */
18			private $sharedByDefault = true;
19
20	160		public function __construct(array $config)
21			{
22	160		$this->config = $config;
23	160		}
24
25			/**
26			* Configure the injector using Zend Service Manager format
27			*/
28	160		public function apply(Injector $injector): void
29			{
30	160		$dependencies = $this->config['dependencies'] ?? [];
31
32			// Define the "config" service, accounting for the fact that Auryn
33			// requires all returns are objects.
34	160		$dependencies['services']['config'] = new ArrayObject($this->config, ArrayObject::ARRAY_AS_PROPS);
35
36	160		$this->injectServices($injector, $dependencies);
37	160		$this->injectFactories($injector, $dependencies);
38	160		$this->injectInvokables($injector, $dependencies);
39	160		$this->injectAliases($injector, $dependencies);
40	160		}
41
42	160	View Code Duplication	private function injectAliases(Injector $injector, array $dependencies): void
			0 ignored issues – show Duplication introduced 2018-03-26 14:43 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...
43			{
44	160		$aliases = $dependencies['aliases'] ?? [];
45	160		foreach ($aliases as $alias => $target) {
46			// Standard Auryn aliases do not work when chained. Work around by
47			// lazily fetching the shared target from the container.
48	70		$injector->share($alias)->share($target)->delegate($alias, $this->makeContainerGet($target));
49			}
50	160		}
51
52	160		private function injectFactories(Injector $injector, array $dependencies): void
53			{
54	160		$factories = $dependencies['factories'] ?? [];
55	160		foreach ($factories as $name => $factory) {
56	110		$delegate = $this->makeFactory($injector, $name, $factory);
57	110	View Code Duplication	if (isset($dependencies['delegators'][$name])) {
			0 ignored issues – show Duplication introduced 2018-03-26 14:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
58	84		$delegate = $this->makeDelegator(
59	84		$injector,
60	84		$name,
61	84		$delegate,
62	84		$dependencies['delegators'][$name]
63			);
64			}
65	110		$injector->share($name)->delegate($name, $delegate);
66			}
67	160		}
68
69	160		private function injectInvokables(Injector $injector, array $dependencies): void
70			{
71	160		$invokables = $dependencies['invokables'] ?? [];
72	160		foreach ($invokables as $alias => $invokable) {
73	42		if (is_string($alias) && $alias !== $invokable) {
74	14		$injector->alias($alias, $invokable);
75			}
76	42		$delegate = $this->makeLazyInvokable($invokable, $invokable);
77	42	View Code Duplication	if (isset($dependencies['delegators'][$invokable])) {
			0 ignored issues – show Duplication introduced 2018-03-26 14:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
78	26		$delegate = $this->makeDelegator(
79	26		$injector,
80	26		$invokable,
81	26		$delegate,
82	26		$dependencies['delegators'][$invokable]
83			);
84			}
85	42		$injector->share($invokable)->delegate($invokable, $delegate);
86			}
87	160		}
88
89	160	View Code Duplication	private function injectServices(Injector $injector, array $dependencies): void
			0 ignored issues – show Duplication introduced 2018-03-26 14:43 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...
90			{
91	160		$services = $dependencies['services'] ?? [];
92	160		foreach ($services as $name => $service) {
93	160		$injector->share($name)->delegate($name, $this->makeIdentity($service));
94			}
95	160		}
96
97			private function makeDelegator(Injector $injector, string $name, callable $callback, array $delegators): callable
98			{
99	110		return /** @return object */ function () use ($injector, $name, $callback, $delegators) {
100	110		foreach ($delegators as $delegator) {
101	95		$container = $injector->make(ContainerInterface::class);
102	95		$delegator = $this->makeInvokable($name, $delegator);
103	50		$instance = $delegator($container, $name, $callback);
104	40		$callback = $this->makeIdentity($instance);
			0 ignored issues – show Bug introduced 2018-03-26 14:43 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$callback`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
105			}
106	55		return $instance ?? $callback();
107	110		};
108			}
109
110			private function makeContainerGet(string $name): callable
111			{
112	70		return /** @return object */ static function (ContainerInterface $container) use ($name) {
113	70		return $container->get($name);
114	70		};
115			}
116
117			/**
118			* @param string\|callable $factory
119			*/
120			private function makeFactory(Injector $injector, string $name, $factory): callable
121			{
122	110		return /** @return object */ function () use ($injector, $name, $factory) {
123	68		$container = $injector->make(ContainerInterface::class);
124	68		$factory = $this->makeInvokable($name, $factory);
			0 ignored issues – show Bug introduced 2018-03-27 14:13 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$factory`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
125	58		return $factory($container, $name);
126	110		};
127			}
128
129			/**
130			* @param object $object
131			*/
132			private function makeIdentity($object): callable
133			{
134	160		return /** @return object */ static function () use ($object) {
135	24		return $object;
136	160		};
137			}
138
139			/**
140			* @param string\|callable $factory
141			* @throws ContainerException if the factory cannot be made invokable
142			*/
143	152		private function makeInvokable(string $name, $factory): callable
144			{
145	152		if (is_callable($factory)) {
146	58		return $factory;
147			}
148
149	118		if (!class_exists($factory)) {
150	23		throw ContainerException::expectedInvokable($name);
151			}
152
153	99		$factory = new $factory();
154
155	81		if (is_callable($factory)) {
156	65		return $factory;
157			}
158
159	18		throw ContainerException::expectedInvokable($name);
160			}
161
162			/**
163			* @param string\|callable $factory
164			*/
165			private function makeLazyInvokable(string $name, $factory): callable
166			{
167	42		return /** @return callable */ function () use ($name, $factory) {
168	29		return $this->makeInvokable($name, $factory);
169	42		};
170			}
171			}
172

northwoods / container

Pull Request — master (#12)

Config::makeLazyInvokable() A

Complexity

Size

Duplication

Code Coverage

Importance

Change not visible in outer-scope

Change visible in outer-scope

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like