InjectEntityDefinitionsPass::computeConfig() - Code Metrics - Inspection of "Merge branch 'blanksheet' into develop" - Innmind/Neo4jBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c28dd2...149d19 )

by Baptiste

created 2016-04-09 11:46 UTC

InjectEntityDefinitionsPass::computeConfig() B

↳ Parent: InjectEntityDefinitionsPass

Complexity

Conditions	5
Paths	12

Size

Total Lines	31
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	5

Metric	Value
dl	0
loc	31
ccs	17
cts	17
cp	1
rs	8.439
cc	5
eloc	19
nc	12
nop	1
crap	5

<?php
declare(strict_types = 1);

namespace Innmind\Neo4jBundle\DependencyInjection\Compiler;

use Innmind\Neo4jBundle\Exception\NoEntityDefinitionFoundException;
use Innmind\Filesystem\{
    Adapter\FilesystemAdapter,
    Exception\FileNotFoundException,
    DirectoryInterface
};
use Symfony\Component\DependencyInjection\{
    Compiler\CompilerPassInterface,
    ContainerBuilder
};
use Symfony\Component\Yaml\Yaml;

class InjectEntityDefinitionsPass implements CompilerPassInterface
{
    /**
     * {@inheritdoc}
     */
    public function process(ContainerBuilder $container)
    {
        $bundles = $container->getParameter('kernel.bundles');
        $configs = [];

        foreach ($bundles as $bundle => $class) {
            try {
                $configs[] = $this->computeConfig($class);
            } catch (NoEntityDefinitionFoundException $e) {
                //pass
            }
        }

        $container
            ->getDefinition('innmind_neo4j.metadata_builder')
            ->addMethodCall(
                'inject',
                [$configs]
            );
    }

    /**
     * Load the entity definitions for the given bundle
     *
     * @param string $class Bundle class FQCN
     *
     * @throws NoEntityDefinitionFoundException
     *
     * @return array
     */
    private function computeConfig(string $class): array
    {
        try {
            $refl = new \ReflectionClass($class);
            $dir = (new FilesystemAdapter(dirname($refl->getFileName())))
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.
    }
}
                ->get('Resources')
                ->get('config');

            if ($dir->has('neo4j.yml')) {
                return Yaml::parse((string) $dir->get('neo4j.yml')->content());
            }

            $dir = $dir->get('neo4j');
            $config = [];

            foreach ($dir as $file) {
                if ($file instanceof DirectoryInterface) {
                    continue;
                }

                $config = array_merge(
                    $config,
                    Yaml::parse((string) $file->content())
                );
            }

            return $config;
        } catch (FileNotFoundException $e) {
            throw new NoEntityDefinitionFoundException;
        }
    }
}


1		<?php
2		declare(strict_types = 1);
3
4		namespace Innmind\Neo4jBundle\DependencyInjection\Compiler;
5
6		use Innmind\Neo4jBundle\Exception\NoEntityDefinitionFoundException;
7		use Innmind\Filesystem\{
8		Adapter\FilesystemAdapter,
9		Exception\FileNotFoundException,
10		DirectoryInterface
11		};
12		use Symfony\Component\DependencyInjection\{
13		Compiler\CompilerPassInterface,
14		ContainerBuilder
15		};
16		use Symfony\Component\Yaml\Yaml;
17
18		class InjectEntityDefinitionsPass implements CompilerPassInterface
19		{
20		/**
21		* {@inheritdoc}
22		*/
23	2	public function process(ContainerBuilder $container)
24		{
25	2	$bundles = $container->getParameter('kernel.bundles');
26	2	$configs = [];
27
28	2	foreach ($bundles as $bundle => $class) {
29		try {
30	2	$configs[] = $this->computeConfig($class);
31	2	} catch (NoEntityDefinitionFoundException $e) {
32		//pass
33		}
34		}
35
36		$container
37	2	->getDefinition('innmind_neo4j.metadata_builder')
38	2	->addMethodCall(
39	2	'inject',
40	2	[$configs]
41		);
42	2	}
43
44		/**
45		* Load the entity definitions for the given bundle
46		*
47		* @param string $class Bundle class FQCN
48		*
49		* @throws NoEntityDefinitionFoundException
50		*
51		* @return array
52		*/
53	2	private function computeConfig(string $class): array
54		{
55		try {
56	2	$refl = new \ReflectionClass($class);
57	2	$dir = (new FilesystemAdapter(dirname($refl->getFileName())))
		0 ignored issues – show Bug introduced 2016-04-09 11:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Innmind\Filesystem\FileInterface` as the method `get()` does only exist in the following implementations of said interface: `Innmind\Filesystem\Directory`. 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...
58	2	->get('Resources')
59	2	->get('config');
60
61	2	if ($dir->has('neo4j.yml')) {
62	2	return Yaml::parse((string) $dir->get('neo4j.yml')->content());
63		}
64
65	2	$dir = $dir->get('neo4j');
66	2	$config = [];
67
68	2	foreach ($dir as $file) {
69	2	if ($file instanceof DirectoryInterface) {
70	2	continue;
71		}
72
73	2	$config = array_merge(
74		$config,
75	2	Yaml::parse((string) $file->content())
76		);
77		}
78
79	2	return $config;
80	2	} catch (FileNotFoundException $e) {
81	2	throw new NoEntityDefinitionFoundException;
82		}
83		}
84		}
85

Innmind / Neo4jBundle

Push — develop ( c28dd2...149d19 )

InjectEntityDefinitionsPass::computeConfig() B

Complexity

Size

Duplication

Code Coverage

Available Fixes

Duplication Side-by-Side

Filter issues like