YamlDefinitionLoaderFactory::buildDefinitionProvider() - Code Metrics - Inspection of "Adapting YamlDefinitionLoader to v0.2.0 of definit..." - thecodingmachine/yaml-definition-loader - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 1.0 ( 009bd5...0744ee )

by David

created 2015-12-03 15:56 UTC

buildDefinitionProvider() A

↳ Parent: YamlDefinitionLoaderFactory

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	14
rs	9.4286
cc	3
eloc	7
nc	3
nop	1

<?php

namespace TheCodingMachine\Definition;


use Assembly\ArrayDefinitionProvider;
use Interop\Container\Definition\DefinitionProviderInterface;
use Interop\Container\Definition\Factory\DefinitionProviderFactoryInterface;
use Puli\Discovery\Api\Discovery;

/**
 * A class in charge of creating the YamlDefinitionLoader.
 */
class YamlDefinitionLoaderFactory implements DefinitionProviderFactoryInterface
{

    /**
     * Creates a definition provider.
     *
     * @param Discovery $discovery
     *
     * @return DefinitionProviderInterface
     */
    public static function buildDefinitionProvider(Discovery $discovery)
    {
        $bindings = $discovery->findBindings('thecodingmachine/yaml_definitions');

        $definitionProviders = [];

        foreach ($bindings as $binding) {
            foreach ($binding->getResources() as $resource) {
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.
    }
}
                $definitionProviders[] = new YamlDefinitionLoader($resource->getPath());
            }
        }

        return self::mergeDefinitionProviders($definitionProviders);
    }

    /**
     * @param DefinitionProviderInterface[] $definitionProviders
     */
    private static function mergeDefinitionProviders(array $definitionProviders) {
        $definitions = [];
        foreach ($definitionProviders as $definitionProvider) {
            $definitions += $definitionProvider->getDefinitions();
        }
        return new ArrayDefinitionProvider($definitions);
    }
}


1			<?php
2
3			namespace TheCodingMachine\Definition;
4
5
6			use Assembly\ArrayDefinitionProvider;
7			use Interop\Container\Definition\DefinitionProviderInterface;
8			use Interop\Container\Definition\Factory\DefinitionProviderFactoryInterface;
9			use Puli\Discovery\Api\Discovery;
10
11			/**
12			* A class in charge of creating the YamlDefinitionLoader.
13			*/
14			class YamlDefinitionLoaderFactory implements DefinitionProviderFactoryInterface
15			{
16
17			/**
18			* Creates a definition provider.
19			*
20			* @param Discovery $discovery
21			*
22			* @return DefinitionProviderInterface
23			*/
24			public static function buildDefinitionProvider(Discovery $discovery)
25			{
26			$bindings = $discovery->findBindings('thecodingmachine/yaml_definitions');
27
28			$definitionProviders = [];
29
30			foreach ($bindings as $binding) {
31			foreach ($binding->getResources() as $resource) {
			0 ignored issues – show Bug introduced 2015-12-03 16:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Puli\Discovery\Api\Binding\Binding` as the method `getResources()` does only exist in the following implementations of said interface: `Puli\Discovery\Binding\ResourceBinding`. 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...
32			$definitionProviders[] = new YamlDefinitionLoader($resource->getPath());
33			}
34			}
35
36			return self::mergeDefinitionProviders($definitionProviders);
37			}
38
39			/**
40			* @param DefinitionProviderInterface[] $definitionProviders
41			*/
42			private static function mergeDefinitionProviders(array $definitionProviders) {
43			$definitions = [];
44			foreach ($definitionProviders as $definitionProvider) {
45			$definitions += $definitionProvider->getDefinitions();
46			}
47			return new ArrayDefinitionProvider($definitions);
48			}
49			}
50

thecodingmachine / yaml-definition-loader

Push — 1.0 ( 009bd5...0744ee )

buildDefinitionProvider() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like